{"openapi":"3.0.0","paths":{"/warehouse/{id}":{"get":{"operationId":"getOneBaseWarehouseControllerWarehouse","summary":"Retrieve a single Warehouse","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Warehouse"}}}}},"tags":["Warehouses"],"security":[{"bearer":[]}]},"patch":{"operationId":"updateOneBaseWarehouseControllerWarehouse","summary":"Update a single Warehouse","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWarehouseDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Warehouses"],"security":[{"bearer":[]}]}},"/warehouse":{"get":{"operationId":"getManyBaseWarehouseControllerWarehouse","summary":"Retrieve multiple Warehouses","parameters":[{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"s","description":"Adds search condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#search\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"string"}},{"name":"filter","description":"Adds filter condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#filter\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"or","description":"Adds OR condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#or\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"sort","description":"Adds sort by field. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#sort\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"limit","description":"Limit amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#limit\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"offset","description":"Offset amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#offset\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page portion of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#page\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginatedDto"},{"properties":{"entity":{"type":"string","example":"Warehouse"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Warehouse"}}}}]}}}}},"tags":["Warehouses"],"security":[{"bearer":[]}]},"post":{"operationId":"createOneBaseWarehouseControllerWarehouse","summary":"Create a single Warehouse","description":"**This is a billable event.** Creating a new warehouse implies additional subscription costs. Please reach out to your CSA for more information.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWarehouseDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"Get create one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Warehouse"}}}}},"tags":["Warehouses"],"security":[{"bearer":[]}]}},"/warehouse/{id}/custom-forms":{"patch":{"operationId":"WarehouseController_updateLoadTypesCustomForms","summary":"Update custom forms for load types","description":"Updates existing custom forms' names and their associations with load types. \n    \n    This endpoint allows you to:\n    - Modify the display name of custom forms\n    - Change which load types trigger these forms\n    - Update form visibility settings\n    \n    For Delete a loadtype custom form, please refer to custom-forms/flow endpoint sending the flowId to delete all related flows/forms.\n    Note: To modify the fields within forms, use the '/custom-forms/form-field' endpoint.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLoadTypesCustomFormsDto"}}}},"responses":{"200":{"description":"Custom forms successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/"}}}}},"tags":["Warehouses","Custom Forms - Triggers"],"security":[{"bearer":[]}]},"post":{"operationId":"WarehouseController_createLoadTypesCustomForms","summary":"Create custom forms for load types","description":"This endpoint creates custom forms that are triggered when appointments are booked with specific load types.\n    \n    The system will generate three forms:\n    - One for the Warehouse App\n    - One for the Carrier App\n    - One for all platforms, including API integrations\n    \n    Initially, forms are created without fields. After creation, you must configure the form fields using the '/custom-forms/form-field' endpoint.\n    \n    For complete form management, refer to the Custom Forms section, starting with the '/custom-forms/trigger' endpoint.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLoadTypesCustomFormsDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/"}}}},"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Warehouses","Custom Forms - Triggers"],"security":[{"bearer":[]}]}},"/warehouse/{id}/get-hours-of-operation":{"post":{"operationId":"WarehouseController_getHOOPs","summary":"Get open hours for set of docks in the warehouse","description":"This endpoint will return an array of docks and their computed open hours taking into consideration\n    closed days and the warehouse hours. <br /><br />\n    If dockIds are supplied, then it will filter the returned array down to those docks. <br /><br />\n    This will always return a full weeks worth of hours around the start/end dates provided.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetHoursOfOperationDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DockHoursOfOperation"}}}}}},"tags":["Warehouses"],"security":[{"bearer":[]}]}},"/user/invite":{"post":{"operationId":"UserController_invite","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InviteDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Users"],"security":[{"bearer":[]}]}},"/user/{id}":{"get":{"operationId":"getOneBaseUserControllerUser","summary":"Retrieve a single User","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}}},"tags":["Users"],"security":[{"bearer":[]}]},"delete":{"operationId":"deleteOneBaseUserControllerUser","summary":"Delete a single User","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}}},"tags":["Users"],"security":[{"bearer":[]}]},"patch":{"operationId":"updateOneBaseUserControllerUser","summary":"Update a single User","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}}},"tags":["Users"],"security":[{"bearer":[]}]}},"/user":{"get":{"operationId":"getManyBaseUserControllerUser","summary":"Retrieve multiple Users","parameters":[{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"s","description":"Adds search condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#search\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"string"}},{"name":"filter","description":"Adds filter condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#filter\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"or","description":"Adds OR condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#or\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"sort","description":"Adds sort by field. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#sort\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"limit","description":"Limit amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#limit\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"offset","description":"Offset amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#offset\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page portion of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#page\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginatedDto"},{"properties":{"entity":{"type":"string","example":"User"},"data":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}]}}}}},"tags":["Users"],"security":[{"bearer":[]}]}},"/user/email-available/{email}":{"get":{"operationId":"UserController_isEmailAvailable","parameters":[{"name":"email","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"boolean"}}}}},"tags":["Users"],"security":[{"bearer":[]}]}},"/user/change-password":{"post":{"operationId":"UserController_changePassword","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangePasswordDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Users"],"security":[{"bearer":[]}]}},"/user/accept-tc":{"post":{"operationId":"UserController_acceptTC","parameters":[],"responses":{"200":{"description":""},"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Users"],"security":[{"bearer":[]}]}},"/carrier":{"get":{"operationId":"getManyBaseCarrierControllerUser","summary":"Retrieve multiple Users","parameters":[{"name":"onlyIncludeFavorites","required":false,"in":"query","description":"Filters returned carriers to only include \"Favorite\" carriers.","schema":{"type":"boolean"}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"s","description":"Adds search condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#search\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"string"}},{"name":"filter","description":"Adds filter condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#filter\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"or","description":"Adds OR condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#or\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"sort","description":"Adds sort by field. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#sort\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"limit","description":"Limit amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#limit\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"offset","description":"Offset amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#offset\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page portion of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#page\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginatedDto"},{"properties":{"entity":{"type":"string","example":"User"},"data":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}]}}}}},"tags":["Carrier Users"],"security":[{"bearer":[]}]},"post":{"operationId":"createOneBaseCarrierControllerUser","summary":"Create a single User","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCarrierDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginatedDto"},{"properties":{"entity":{"type":"string","example":"User"},"data":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}]}}}},"201":{"description":"Get create one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}}},"tags":["Carrier Users"],"security":[{"bearer":[]}]}},"/carrier/booked":{"get":{"operationId":"CarrierController_getManyBooked","parameters":[],"responses":{"200":{"description":""}},"tags":["Carrier Users"],"security":[{"bearer":[]}]}},"/carrier/{id}/org-carrier-settings":{"get":{"operationId":"CarrierController_getOrgCarrierSettingsOrg","summary":"","deprecated":true,"parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgCarrierSettingsDto"}}}}},"tags":["Carrier Users"],"security":[{"bearer":[]}]},"patch":{"operationId":"CarrierController_updateOrgCarrierSettings","summary":"","deprecated":true,"parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgCarrierSettingsDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgCarrierSettingsDto"}}}}},"tags":["Carrier Users"],"security":[{"bearer":[]}]}},"/carrier/preview":{"post":{"operationId":"CarrierController_getCarrierPreviewToken","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPreviewAsCarrierResponseDto"}}}}},"tags":["Carrier Users"],"security":[{"bearer":[]}]}},"/carrier/{id}":{"get":{"operationId":"getOneBaseCarrierControllerUser","summary":"Retrieve a single User","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}}},"tags":["Carrier Users"],"security":[{"bearer":[]}]}},"/org/{id}":{"get":{"operationId":"getOneBaseOrgControllerOrg","summary":"Retrieve a single Org","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Org"}}}}},"tags":["Orgs"],"security":[{"bearer":[]}]},"patch":{"operationId":"updateOneBaseOrgControllerOrg","summary":"Update a single Org","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrgDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Orgs"],"security":[{"bearer":[]}]}},"/org/{orgId}/report-search":{"post":{"operationId":"OrgController_createReportSearch","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReportSearchDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Orgs"],"security":[{"bearer":[]}]},"get":{"operationId":"OrgController_getAllReportSearches","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportSearchResponseDto"}}}}},"tags":["Orgs"],"security":[{"bearer":[]}]}},"/org/{orgId}/report-search/{reportSearchKey}":{"patch":{"operationId":"OrgController_updateReportSearch","parameters":[{"name":"reportSearchKey","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReportSearchDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Orgs"],"security":[{"bearer":[]}]},"delete":{"operationId":"OrgController_deleteReportSearch","parameters":[{"name":"reportSearchKey","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Orgs"],"security":[{"bearer":[]}]}},"/org/{orgId}/favorite-carriers":{"patch":{"operationId":"OrgController_updateFavoriteCarriers","parameters":[{"name":"orgId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Orgs"],"security":[{"bearer":[]}]}},"/org/{id}/custom-tags":{"patch":{"operationId":"OrgController_updateCustomTags","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCustomTagsDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Orgs"],"security":[{"bearer":[]}]}},"/company":{"get":{"operationId":"getManyBaseCompanyControllerCompany","summary":"Retrieve multiple Companies","parameters":[{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"s","description":"Adds search condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#search\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"string"}},{"name":"filter","description":"Adds filter condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#filter\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"or","description":"Adds OR condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#or\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"sort","description":"Adds sort by field. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#sort\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"limit","description":"Limit amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#limit\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"offset","description":"Offset amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#offset\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page portion of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#page\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginatedDto"},{"properties":{"entity":{"type":"string","example":"Company"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Company"}}}}]}}}}},"tags":["Carrier Companies"],"security":[{"bearer":[]}]},"post":{"operationId":"createOneBaseCompanyControllerCompany","summary":"Create a single Company","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCompanyDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"Get create one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}}},"tags":["Carrier Companies"],"security":[{"bearer":[]}]}},"/company/{id}":{"get":{"operationId":"getOneBaseCompanyControllerCompany","summary":"Retrieve a single Company","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"Get one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}}},"tags":["Carrier Companies"],"security":[{"bearer":[]}]}},"/auth/login":{"post":{"operationId":"AuthController_login","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginDto"}}}},"responses":{"200":{"description":"Successful login","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginResponseDto"}}}}},"tags":["Authentication"]}},"/auth/refresh":{"get":{"operationId":"AuthController_refresh","parameters":[],"responses":{"200":{"description":"Refreshed token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginResponseDto"}}}}},"tags":["Authentication"],"security":[{"bearer":[]}]}},"/auth/profile":{"get":{"operationId":"AuthController_getProfile","parameters":[],"responses":{"200":{"description":"Current authenticated user profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthProfileResponseDto"}}}}},"tags":["Authentication"],"security":[{"bearer":[]}]}},"/auth/me":{"get":{"operationId":"AuthController_getProfile","parameters":[],"responses":{"200":{"description":"Current authenticated user profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthProfileResponseDto"}}}}},"tags":["Authentication"],"security":[{"bearer":[]}]}},"/dock":{"post":{"operationId":"createOneBaseDockControllerDock","summary":"Create a single Dock","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDockDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"Get create one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dock"}}}},"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dock"}}}}},"tags":["Docks"],"security":[{"bearer":[]}]},"get":{"operationId":"getManyBaseDockControllerDock","summary":"Retrieve multiple Docks","parameters":[{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"s","description":"Adds search condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#search\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"string"}},{"name":"filter","description":"Adds filter condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#filter\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"or","description":"Adds OR condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#or\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"sort","description":"Adds sort by field. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#sort\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"limit","description":"Limit amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#limit\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"offset","description":"Offset amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#offset\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page portion of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#page\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginatedDto"},{"properties":{"entity":{"type":"string","example":"Dock"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Dock"}}}}]}}}}},"tags":["Docks"],"security":[{"bearer":[]}]}},"/dock/{id}":{"patch":{"operationId":"updateOneBaseDockControllerDock","summary":"Update a single Dock","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDockDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dock"}}}}},"tags":["Docks"],"security":[{"bearer":[]}]},"delete":{"operationId":"deleteOneBaseDockControllerDock","summary":"Delete a single Dock","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteDockDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dock"}}}},"204":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Docks"],"security":[{"bearer":[]}]},"get":{"operationId":"getOneBaseDockControllerDock","summary":"Retrieve a single Dock","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CrudOperationDto"},{"properties":{"entity":{"type":"string","example":"Dock"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Dock"}}}}]}}}}},"tags":["Docks"],"security":[{"bearer":[]}]}},"/dock/sort":{"post":{"operationId":"DockController_updateSort","summary":"Save the sort order of an array of docks","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DockSortDto"}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CrudOperationDto"},{"properties":{"entity":{"type":"string","example":"Dock"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DockSortResponseDto"}}}}]}}}}},"tags":["Docks"],"security":[{"bearer":[]}]}},"/dock/{id}/compute-availability":{"post":{"operationId":"DockController_availability","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailabilityDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailabilityResponseDto"}}}}},"tags":["Docks"],"security":[{"bearer":[]}]}},"/dock/{id}/get-availability":{"post":{"operationId":"DockController_availability","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailabilityDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailabilityResponseDto"}}}}},"tags":["Docks"],"security":[{"bearer":[]}]}},"/dock/compute-open-dates":{"post":{"operationId":"DockController_openDates","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenDatesDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenDatesResponseDto"}}}}},"tags":["Docks"],"security":[{"bearer":[]}]}},"/dock/{id}/capacity":{"post":{"operationId":"DockController_createCapacityChildDock","summary":"Creates a child \"Capacity Dock\" linked to this Dock","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CrudOperationDto"},{"properties":{"entity":{"type":"string","example":"Dock"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Dock"}}}}]}}}}},"tags":["Docks"],"security":[{"bearer":[]}]}},"/dock/{id}/capacity/{childId}":{"delete":{"operationId":"DockController_unlinkCapacityDock","summary":"Unlinks a child \"Capacity Dock\" from its parent Dock","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"childId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginatedDto"},{"properties":{"entity":{"type":"string","example":"Dock"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Dock"}}}}]}}}}},"tags":["Docks"],"security":[{"bearer":[]}]}},"/loadtype":{"post":{"operationId":"createOneBaseLoadTypeControllerLoadType","summary":"Create a single LoadType","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLoadTypeDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"Get create one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoadType"}}}}},"tags":["Load Types"],"security":[{"bearer":[]}]},"get":{"operationId":"getManyBaseLoadTypeControllerLoadType","summary":"Retrieve multiple LoadTypes","parameters":[{"name":"warehouseId","required":false,"in":"query","description":"When set, returns Loadtypes that can be used at this Warehouse.","schema":{"type":"string"}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"s","description":"Adds search condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#search\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"string"}},{"name":"filter","description":"Adds filter condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#filter\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"or","description":"Adds OR condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#or\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"sort","description":"Adds sort by field. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#sort\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"limit","description":"Limit amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#limit\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"offset","description":"Offset amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#offset\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page portion of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#page\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginatedDto"},{"properties":{"entity":{"type":"string","example":"LoadType"},"data":{"type":"array","items":{"$ref":"#/components/schemas/LoadType"}}}}]}}}}},"tags":["Load Types"],"security":[{"bearer":[]}]}},"/loadtype/{id}":{"delete":{"operationId":"deleteOneBaseLoadTypeControllerLoadType","summary":"Delete a single LoadType","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Load Types"],"security":[{"bearer":[]}]},"get":{"operationId":"getOneBaseLoadTypeControllerLoadType","summary":"Retrieve a single LoadType","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoadType"}}}}},"tags":["Load Types"],"security":[{"bearer":[]}]},"patch":{"operationId":"updateOneBaseLoadTypeControllerLoadType","summary":"Update a single LoadType","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLoadTypeDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Load Types"],"security":[{"bearer":[]}]}},"/loadtype/{id}/get-availability":{"post":{"operationId":"LoadTypeController_availability","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"forceAsCarrier","required":false,"in":"query","description":"When passing this argument as true, the availability will consider the availability for a carrier user, default = false","schema":{"example":"true","type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailabilityFromLoadTypeDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AvailabilityResponseDto"}}}}}},"tags":["Load Types"],"security":[{"bearer":[]}]}},"/loadtype/{id}/appointment-count":{"get":{"operationId":"LoadTypeController_getAppointmentCount","summary":"Returns the appointment count grouped by warehouse","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AppointmentCountResponseDto"}}}}}},"tags":["Load Types"],"security":[{"bearer":[]}]}},"/loadtype-group":{"post":{"operationId":"LoadTypeGroupController_createLoadTypeGroup","summary":"Create a new load type group","description":"Creates a load type group, which is a collection of load types that can be managed together for unit limiting purposes. Load type groups allow you to apply the same unit limits to multiple load types simultaneously, simplifying capacity management.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLoadTypeGroupDto"}}}},"responses":{"200":{"description":"Load type group successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseLoadTypeGroupDto"}}}},"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Load Type Groups","Unit Limiter"],"security":[{"bearer":[]}]},"get":{"operationId":"LoadTypeGroupController_getLoadTypeGroups","summary":"Retrieve load type groups","description":"Fetches all load type groups for a specific warehouse. Returns a list of groups with their associated load types, useful for displaying configuration options or managing unit limits.","parameters":[{"name":"tags","required":false,"in":"query","schema":{"nullable":true,"type":"array","items":{"type":"string"}}},{"name":"loadTypeGroupIds","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"warehouseId","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"List of load type groups for the specified warehouse","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResponseLoadTypeGroupDto"}}}}}},"tags":["Load Type Groups","Unit Limiter"],"security":[{"bearer":[]}]}},"/loadtype-group/{id}":{"patch":{"operationId":"LoadTypeGroupController_updateLoadTypeGroup","summary":"Update an existing load type group","description":"Updates the name or load type membership of an existing load type group. This allows you to modify which load types are included in the group without recreating it.","parameters":[{"name":"id","required":true,"in":"path","description":"The unique identifier of the load type group to update","schema":{"format":"uuid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLoadTypeGroupDto"}}}},"responses":{"200":{"description":"Load type group successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseLoadTypeGroupDto"}}}}},"tags":["Load Type Groups","Unit Limiter"],"security":[{"bearer":[]}]},"delete":{"operationId":"LoadTypeGroupController_deleteLoadTypeGroup","summary":"Delete a load type group","description":"Deletes a load type group. This removes the group itself but does not affect the individual load types that were part of the group. Any unit limits referencing this group will need to be reconfigured.","parameters":[{"name":"id","required":true,"in":"path","description":"The unique identifier of the load type group to delete","schema":{"format":"uuid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteLoadTypeGroupDto"}}}},"responses":{"200":{"description":"Load type group successfully deleted","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true}}}}}}},"tags":["Load Type Groups","Unit Limiter"],"security":[{"bearer":[]}]}},"/unit-limit/configuration":{"post":{"operationId":"UnitLimitController_setUpConfiguration","summary":"Create or update unit limit configuration","description":"Configures unit limits for a warehouse based on grouping criteria (warehouse, dock, load type, or load type group). Unit limits control how many appointment or handling units (pallets, etc.) can be scheduled within specific time periods. This helps manage warehouse capacity and prevent overbooking.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnitLimitConfigurationWriteDTO"}}}},"responses":{"200":{"description":"Unit limit configuration successfully created or updated","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"}}}}}},"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Unit Limiter"],"security":[{"bearer":[]}]},"get":{"operationId":"UnitLimitController_getConfiguration","summary":"Retrieve unit limit configurations","description":"Fetches unit limit configurations based on specified filters such as warehouse, grouper type (dock, load type, or load type group), and unit type. Returns all matching configurations for the authenticated user's organization.","parameters":[{"name":"tags","required":false,"in":"query","schema":{"nullable":true,"type":"array","items":{"type":"string"}}},{"name":"warehouseId","required":true,"in":"query","schema":{"type":"string"}},{"name":"unitGrouperId","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"List of unit limit configurations matching the query parameters","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UnitLimit"}}}}}},"tags":["Unit Limiter"],"security":[{"bearer":[]}]}},"/unit-limit/count":{"get":{"operationId":"UnitLimitController_getCount","summary":"Get unit limit counts for specific configurations","description":"Retrieves actual unit counts for specified unit limit configurations within a date range. This shows how many units have been scheduled against each limit, helping track capacity utilization.","parameters":[{"name":"tags","required":false,"in":"query","schema":{"nullable":true,"type":"array","items":{"type":"string"}}},{"name":"unitLimitIds","required":true,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"countedDateStart","required":true,"in":"query","schema":{"type":"string"}},{"name":"countedDateEnd","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"List of unit counts for the requested unit limits and date range","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UnitLimitCount"}}}}}},"tags":["Unit Limiter"],"security":[{"bearer":[]}]}},"/unit-limit/validate":{"post":{"operationId":"UnitLimitController_validateUnitLimit","summary":"Validate if scheduling at a given time would breach unit limits","description":"Checks whether creating an appointment with the specified warehouse, dock, load type, and time interval would violate any configured unit limits. Returns an array of results for each day in the interval.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnitLimitValidateDTO"}}}},"responses":{"200":{"description":"Unit limits validation results for each day in the requested interval","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"valid":{"type":"boolean","example":true},"message":{"type":"string","example":"Unit limits validation passed"},"date":{"type":"string","example":"2025-11-05"}}}}}}}},"tags":["Unit Limiter"],"security":[{"bearer":[]}]}},"/custom-forms/flow":{"post":{"operationId":"createOneBaseFlowControllerFlow","summary":"Create a single Flow","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFlowDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flow"}}}}},"tags":["Custom Forms - Flows"],"security":[{"bearer":[]}]},"get":{"operationId":"getManyBaseFlowControllerFlow","summary":"Retrieve multiple Flows","parameters":[{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"s","description":"Adds search condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#search\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"string"}},{"name":"filter","description":"Adds filter condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#filter\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"or","description":"Adds OR condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#or\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"sort","description":"Adds sort by field. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#sort\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"limit","description":"Limit amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#limit\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"offset","description":"Offset amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#offset\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page portion of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#page\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"Get paginated response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManyFlowResponseDto"}}}}},"tags":["Custom Forms - Flows"],"security":[{"bearer":[]}]}},"/custom-forms/flow/{id}":{"patch":{"operationId":"updateOneBaseFlowControllerFlow","summary":"Update a single Flow","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFlowDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flow"}}}}},"tags":["Custom Forms - Flows"],"security":[{"bearer":[]}]},"get":{"operationId":"getOneBaseFlowControllerFlow","summary":"Retrieve a single Flow","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"Get one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flow"}}}}},"tags":["Custom Forms - Flows"],"security":[{"bearer":[]}]},"delete":{"operationId":"deleteOneBaseFlowControllerFlow","summary":"Delete a single Flow","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Delete one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Flow"}}}}},"tags":["Custom Forms - Flows"],"security":[{"bearer":[]}]}},"/custom-forms/form":{"post":{"operationId":"createOneBaseFormControllerForm","summary":"Create a single Form","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFormDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Form"}}}}},"tags":["Custom Forms - Forms"],"security":[{"bearer":[]}]},"get":{"operationId":"getManyBaseFormControllerForm","summary":"Retrieve multiple Forms","parameters":[{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"s","description":"Adds search condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#search\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"string"}},{"name":"filter","description":"Adds filter condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#filter\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"or","description":"Adds OR condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#or\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"sort","description":"Adds sort by field. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#sort\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"limit","description":"Limit amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#limit\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"offset","description":"Offset amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#offset\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page portion of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#page\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"Get paginated response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManyFormResponseDto"}}}}},"tags":["Custom Forms - Forms"],"security":[{"bearer":[]}]}},"/custom-forms/form/{id}":{"patch":{"operationId":"updateOneBaseFormControllerForm","summary":"Update a single Form","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFormDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Form"}}}}},"tags":["Custom Forms - Forms"],"security":[{"bearer":[]}]},"get":{"operationId":"getOneBaseFormControllerForm","summary":"Retrieve a single Form","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"Get one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Form"}}}}},"tags":["Custom Forms - Forms"],"security":[{"bearer":[]}]},"delete":{"operationId":"deleteOneBaseFormControllerForm","summary":"Delete a single Form","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Delete one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Form"}}}}},"tags":["Custom Forms - Forms"],"security":[{"bearer":[]}]}},"/custom-forms/form/sort/{id}":{"patch":{"operationId":"FormController_sortFormFields","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SortFormFieldDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array"}}}}},"tags":["Custom Forms - Forms"],"security":[{"bearer":[]}]}},"/custom-forms/field":{"post":{"operationId":"createOneBaseFieldControllerField","summary":"Create a single Field","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFieldDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Field"}}}}},"tags":["Custom Forms - Fields"],"security":[{"bearer":[]}]},"get":{"operationId":"getManyBaseFieldControllerField","summary":"Retrieve multiple Fields","parameters":[{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"s","description":"Adds search condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#search\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"string"}},{"name":"filter","description":"Adds filter condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#filter\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"or","description":"Adds OR condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#or\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"sort","description":"Adds sort by field. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#sort\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"limit","description":"Limit amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#limit\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"offset","description":"Offset amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#offset\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page portion of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#page\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"Get paginated response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManyFieldResponseDto"}}}}},"tags":["Custom Forms - Fields"],"security":[{"bearer":[]}]}},"/custom-forms/field/{id}":{"patch":{"operationId":"updateOneBaseFieldControllerField","summary":"Update a single Field","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFieldDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Field"}}}}},"tags":["Custom Forms - Fields"],"security":[{"bearer":[]}]},"get":{"operationId":"getOneBaseFieldControllerField","summary":"Retrieve a single Field","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"Get one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Field"}}}}},"tags":["Custom Forms - Fields"],"security":[{"bearer":[]}]},"delete":{"operationId":"deleteOneBaseFieldControllerField","summary":"Delete a single Field","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Delete one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Field"}}}}},"tags":["Custom Forms - Fields"],"security":[{"bearer":[]}]}},"/custom-forms/form-field":{"post":{"operationId":"createOneBaseFormFieldControllerFormField","summary":"Create a single FormField","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFormFieldDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormField"}}}}},"tags":["Custom Forms - Form Fields"],"security":[{"bearer":[]}]},"get":{"operationId":"getManyBaseFormFieldControllerFormField","summary":"Retrieve multiple FormFields","parameters":[{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"s","description":"Adds search condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#search\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"string"}},{"name":"filter","description":"Adds filter condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#filter\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"or","description":"Adds OR condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#or\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"sort","description":"Adds sort by field. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#sort\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"limit","description":"Limit amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#limit\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"offset","description":"Offset amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#offset\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page portion of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#page\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"Get paginated response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManyFormFieldResponseDto"}}}}},"tags":["Custom Forms - Form Fields"],"security":[{"bearer":[]}]}},"/custom-forms/form-field/{id}":{"patch":{"operationId":"updateOneBaseFormFieldControllerFormField","summary":"Update a single FormField","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFormFieldDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormField"}}}}},"tags":["Custom Forms - Form Fields"],"security":[{"bearer":[]}]},"get":{"operationId":"getOneBaseFormFieldControllerFormField","summary":"Retrieve a single FormField","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"Get one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormField"}}}}},"tags":["Custom Forms - Form Fields"],"security":[{"bearer":[]}]},"delete":{"operationId":"deleteOneBaseFormFieldControllerFormField","summary":"Delete a single FormField","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Delete one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormField"}}}}},"tags":["Custom Forms - Form Fields"],"security":[{"bearer":[]}]}},"/custom-forms/trigger":{"post":{"operationId":"createOneBaseTriggerControllerTrigger","summary":"Create a single Trigger","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTriggerDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trigger"}}}}},"tags":["Custom Forms - Triggers"],"security":[{"bearer":[]}]},"get":{"operationId":"getManyBaseTriggerControllerTrigger","summary":"Retrieve multiple Triggers","parameters":[{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"s","description":"Adds search condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#search\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"string"}},{"name":"filter","description":"Adds filter condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#filter\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"or","description":"Adds OR condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#or\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"sort","description":"Adds sort by field. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#sort\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"limit","description":"Limit amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#limit\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"offset","description":"Offset amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#offset\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page portion of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#page\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"Get paginated response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManyTriggerResponseDto"}}}}},"tags":["Custom Forms - Triggers"],"security":[{"bearer":[]}]}},"/custom-forms/trigger/{id}":{"patch":{"operationId":"updateOneBaseTriggerControllerTrigger","summary":"Update a single Trigger","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTriggerDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trigger"}}}}},"tags":["Custom Forms - Triggers"],"security":[{"bearer":[]}]},"delete":{"operationId":"deleteOneBaseTriggerControllerTrigger","summary":"Delete a single Trigger","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trigger"}}}}},"tags":["Custom Forms - Triggers"],"security":[{"bearer":[]}]},"get":{"operationId":"getOneBaseTriggerControllerTrigger","summary":"Retrieve a single Trigger","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"Get one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trigger"}}}}},"tags":["Custom Forms - Triggers"],"security":[{"bearer":[]}]}},"/custom-forms/form-data/bulk":{"post":{"operationId":"createManyBaseCustomFormDataControllerCustomFormData","summary":"Create multiple CustomFormData","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateManyCustomFormDataDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFormData"}}}}},"tags":["Custom Forms - Data"],"security":[{"bearer":[]}]}},"/custom-forms/form-data/{id}":{"patch":{"operationId":"updateOneBaseCustomFormDataControllerCustomFormData","summary":"Update a single CustomFormData","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCustomFormDataDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFormData"}}}}},"tags":["Custom Forms - Data"],"security":[{"bearer":[]}]},"get":{"operationId":"getOneBaseCustomFormDataControllerCustomFormData","summary":"Retrieve a single CustomFormData","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"Get one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFormData"}}}}},"tags":["Custom Forms - Data"],"security":[{"bearer":[]}]},"delete":{"operationId":"deleteOneBaseCustomFormDataControllerCustomFormData","summary":"Delete a single CustomFormData","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Delete one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFormData"}}}}},"tags":["Custom Forms - Data"],"security":[{"bearer":[]}]}},"/custom-forms/form-data":{"post":{"operationId":"createOneBaseCustomFormDataControllerCustomFormData","summary":"Create a single CustomFormData","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSingleCustomFormDataDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFormData"}}}}},"tags":["Custom Forms - Data"],"security":[{"bearer":[]}]},"get":{"operationId":"getManyBaseCustomFormDataControllerCustomFormData","summary":"Retrieve multiple CustomFormData","parameters":[{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"s","description":"Adds search condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#search\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"string"}},{"name":"filter","description":"Adds filter condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#filter\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"or","description":"Adds OR condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#or\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"sort","description":"Adds sort by field. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#sort\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"limit","description":"Limit amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#limit\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"offset","description":"Offset amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#offset\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page portion of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#page\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"Get paginated response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManyCustomFormDataResponseDto"}}}}},"tags":["Custom Forms - Data"],"security":[{"bearer":[]}]}},"/warehouse-group/{id}":{"get":{"operationId":"getOneBaseWarehouseGroupControllerWarehouseGroup","summary":"Retrieve a single WarehouseGroup","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WarehouseGroup"}}}}},"tags":["Warehouse Groups"],"security":[{"bearer":[]}]},"delete":{"operationId":"deleteOneBaseWarehouseGroupControllerWarehouseGroup","summary":"Delete a single WarehouseGroup","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Warehouse Groups"],"security":[{"bearer":[]}]},"patch":{"operationId":"updateOneBaseWarehouseGroupControllerWarehouseGroup","summary":"Update a single WarehouseGroup","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWarehouseGroupDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WarehouseGroup"}}}}},"tags":["Warehouse Groups"],"security":[{"bearer":[]}]}},"/warehouse-group":{"get":{"operationId":"getManyBaseWarehouseGroupControllerWarehouseGroup","summary":"Retrieve multiple WarehouseGroups","parameters":[{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"s","description":"Adds search condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#search\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"string"}},{"name":"filter","description":"Adds filter condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#filter\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"or","description":"Adds OR condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#or\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"sort","description":"Adds sort by field. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#sort\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"limit","description":"Limit amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#limit\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"offset","description":"Offset amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#offset\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page portion of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#page\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WarehouseGroup"}}}}},"tags":["Warehouse Groups"],"security":[{"bearer":[]}]},"post":{"operationId":"createOneBaseWarehouseGroupControllerWarehouseGroup","summary":"Create a single WarehouseGroup","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWarehouseGroupDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WarehouseGroup"}}}},"201":{"description":"Get create one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WarehouseGroup"}}}}},"tags":["Warehouse Groups"],"security":[{"bearer":[]}]}},"/appointment":{"get":{"operationId":"getManyBaseAppointmentControllerAppointment","summary":"Retrieve multiple Appointments","parameters":[{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"s","description":"Adds search condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#search\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"string"}},{"name":"filter","description":"Adds filter condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#filter\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"or","description":"Adds OR condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#or\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"sort","description":"Adds sort by field. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#sort\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"limit","description":"Limit amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#limit\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"offset","description":"Offset amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#offset\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page portion of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#page\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginatedDto"},{"properties":{"entity":{"type":"string","example":"AppointmentListItemDto"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AppointmentListItemDto"}}}}]}}}}},"tags":["Appointments"],"security":[{"bearer":[]}]},"post":{"operationId":"createOneBaseAppointmentControllerAppointment","summary":"Create a single Appointment","parameters":[{"name":"bypassCustomFieldsValidation","required":true,"in":"query","schema":{"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAppointmentDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"","content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AppointmentListItemDto"},"entity":{"type":"string","example":"Appointment"},"action":{"type":"string","example":"create"}}}}}}},"tags":["Appointments"],"security":[{"bearer":[]}]}},"/appointment/{id}":{"get":{"operationId":"getOneBaseAppointmentControllerAppointment","summary":"Retrieve a single Appointment","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AppointmentListItemDto"},"entity":{"type":"string","example":"Appointment"},"action":{"type":"string","example":"read"}}}}}}},"tags":["Appointments"],"security":[{"bearer":[]}]},"delete":{"operationId":"deleteOneBaseAppointmentControllerAppointment","summary":"Delete a single Appointment","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAppointmentDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AppointmentListItemDto"},"entity":{"type":"string","example":"Appointment"},"action":{"type":"string","example":"delete"}}}}}}},"tags":["Appointments"],"security":[{"bearer":[]}]},"patch":{"operationId":"updateOneBaseAppointmentControllerAppointment","summary":"Update a single Appointment","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAppointmentDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AppointmentListItemDto"},"entity":{"type":"string","example":"Appointment"},"action":{"type":"string","example":"update"}}}}}}},"tags":["Appointments"],"security":[{"bearer":[]}]}},"/appointment/public/{id}":{"get":{"operationId":"AppointmentController_getPublicAppointmentDetails","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentListItemDto"}}}}},"tags":["Appointments"]}},"/appointment/{id}/set-eta":{"patch":{"operationId":"AppointmentController_setEta","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EtaDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AppointmentListItemDto"},"entity":{"type":"string","example":"Appointment"},"action":{"type":"string","example":"update"}}}}}}},"tags":["Appointments"],"security":[{"bearer":[]}]}},"/appointment/{id}/undo-latest-status":{"patch":{"operationId":"AppointmentController_undoLatestStatus","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AppointmentListItemDto"},"entity":{"type":"string","example":"Appointment"},"action":{"type":"string","example":"update"}}}}}}},"tags":["Appointments"],"security":[{"bearer":[]}]}},"/appointment/reserve":{"post":{"operationId":"AppointmentController_createReserve","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReserveDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AppointmentListItemDto"},"entity":{"type":"string","example":"Appointment"},"action":{"type":"string","example":"create"}}}}}},"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Appointments"],"security":[{"bearer":[]}]}},"/appointment/{id}/recurring":{"post":{"operationId":"AppointmentController_createRecurringAppointments","summary":"Creates a Recurring Appointment Series based on this appointment","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRecurringAppointmentsDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/RecurringAppointmentCreateResponse"},"entity":{"type":"string","example":"Appointment"},"action":{"type":"string","example":"create"}}}}}}},"tags":["Appointments"],"security":[{"bearer":[]}]},"delete":{"operationId":"AppointmentController_deleteRecurringAppointments","summary":"Deletes this appointment and all following appointments in the recurring series, except the original appointment used to create this series.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AppointmentListItemDto"},"entity":{"type":"string","example":"Appointment"},"action":{"type":"string","example":"delete"}}}}}}},"tags":["Appointments"],"security":[{"bearer":[]}]}},"/appointment/email-notification-html/{emailKey}":{"get":{"operationId":"AppointmentController_getAppointmentNotificationEmailHtml","parameters":[{"name":"emailKey","required":true,"in":"path","schema":{"type":"string"}},{"name":"warehouseId","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentNotificationEmailHtmlResponseDto"}}}}},"tags":["Appointments"],"security":[{"bearer":[]}]}},"/appointment/{id}/tag":{"post":{"operationId":"AppointmentController_addAppointmentTag","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAppointmentTagDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AppointmentListItemDto"},"entity":{"type":"string","example":"Appointment"},"action":{"type":"string","example":"update"}}}}}},"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Appointments"],"security":[{"bearer":[]}]},"delete":{"operationId":"AppointmentController_removeAppointmentTag","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAppointmentTagDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/AppointmentListItemDto"},"entity":{"type":"string","example":"Appointment"},"action":{"type":"string","example":"update"}}}}}}},"tags":["Appointments"],"security":[{"bearer":[]}]}},"/asset-visit":{"post":{"operationId":"createOneBaseAssetVisitControllerAssetVisit","summary":"Create a single AssetVisit","parameters":[{"name":"assetContainerId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAssetVisitDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetVisit"}}}},"201":{"description":"Get create one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetVisit"}}}}},"tags":["Asset Visit"],"security":[{"bearer":[]}]},"get":{"operationId":"getManyBaseAssetVisitControllerAssetVisit","summary":"Retrieve multiple AssetVisits","parameters":[{"name":"excludeStatuses","required":false,"in":"query","description":"Event types to exclude. Asset visits with any event matching these types will be filtered out.","schema":{"type":"array","items":{"type":"string","enum":["NotArrived","Arrived","Docked","Departed","Canceled","Attached","Detached","Appointment Linked","Appointment Unlinked"]}}},{"name":"assetContainerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"s","description":"Adds search condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#search\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"string"}},{"name":"filter","description":"Adds filter condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#filter\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"or","description":"Adds OR condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#or\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"sort","description":"Adds sort by field. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#sort\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"limit","description":"Limit amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#limit\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"offset","description":"Offset amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#offset\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page portion of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#page\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginatedDto"},{"properties":{"entity":{"type":"string","example":"AssetVisit"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AssetVisit"}}}}]}}}}},"tags":["Asset Visit"],"security":[{"bearer":[]}]}},"/asset-visit/{id}":{"patch":{"operationId":"updateOneBaseAssetVisitControllerAssetVisit","summary":"Update a single AssetVisit","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"assetContainerId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAssetVisitDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetVisit"}}}}},"tags":["Asset Visit"],"security":[{"bearer":[]}]},"get":{"operationId":"getOneBaseAssetVisitControllerAssetVisit","summary":"Retrieve a single AssetVisit","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"assetContainerId","required":true,"in":"path","schema":{"type":"string"}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetVisit"}}}}},"tags":["Asset Visit"],"security":[{"bearer":[]}]},"delete":{"operationId":"deleteOneBaseAssetVisitControllerAssetVisit","summary":"Delete a single AssetVisit","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"assetContainerId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Asset Visit"],"security":[{"bearer":[]}]}},"/asset-visit/event":{"post":{"operationId":"AssetVisitController_createAssetVisitEvent","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAssetVisitEventDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetVisit"}}}},"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Asset Visit"],"security":[{"bearer":[]}]}},"/asset-visit/{id}/yard-events":{"get":{"operationId":"AssetVisitController_getAssetVisitEvents","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Asset Visit"],"security":[{"bearer":[]}]}},"/asset-visit/{id}/arrival-container":{"get":{"operationId":"AssetVisitController_getArrivalAssetContainerForVisit","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssetContainer"}}}}}},"tags":["Asset Visit"],"security":[{"bearer":[]}]}},"/asset-visit/{id}/check-in-acknowledgment":{"patch":{"operationId":"AssetVisitController_updateCheckInAcknowledgment","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAssetVisitAcknowledgmentDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetVisit"}}}}},"tags":["Asset Visit"],"security":[{"bearer":[]}]}},"/asset-visit/{id}/attach/{assetContainerId}":{"post":{"operationId":"AssetVisitController_attachContainer","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"assetContainerId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Asset Visit"],"security":[{"bearer":[]}]}},"/asset-visit/{id}/detach/{assetContainerId}":{"post":{"operationId":"AssetVisitController_detachContainer","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"assetContainerId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Asset Visit"],"security":[{"bearer":[]}]}},"/asset-visit/link-unplanned-checkin-to-appointment":{"post":{"operationId":"AssetVisitController_linkUnplannedCheckinToAppointment","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkUnplannedCheckinToAppointmentDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Asset Visit"],"security":[{"bearer":[]}]}},"/asset-visit/unlink-checkin-from-appointment":{"post":{"operationId":"AssetVisitController_unlinkCheckinFromAppointment","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnlinkAssetFromAppointmentDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Asset Visit"],"security":[{"bearer":[]}]}},"/asset-container/{id}":{"get":{"operationId":"getOneBaseAssetContainerControllerAssetContainer","summary":"Retrieve a single AssetContainer","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetContainer"}}}}},"tags":["Asset Container"],"security":[{"bearer":[]}]},"patch":{"operationId":"updateOneBaseAssetContainerControllerAssetContainer","summary":"Update a single AssetContainer","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAssetContainerDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetContainer"}}}}},"tags":["Asset Container"],"security":[{"bearer":[]}]},"delete":{"operationId":"deleteOneBaseAssetContainerControllerAssetContainer","summary":"Delete a single AssetContainer","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Delete one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetContainer"}}}}},"tags":["Asset Container"],"security":[{"bearer":[]}]}},"/asset-container":{"get":{"operationId":"getManyBaseAssetContainerControllerAssetContainer","summary":"Retrieve multiple AssetContainers","parameters":[{"name":"excludeStatuses","required":false,"in":"query","description":"Event types to exclude. Asset containers with any event matching these types will be filtered out.","schema":{"type":"array","items":{"type":"string","enum":["Arrived","Loading","Loading Complete","Unloading","Unloading Complete","Ready for Pickup","Departed","Inoperable"]}}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"s","description":"Adds search condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#search\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"string"}},{"name":"filter","description":"Adds filter condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#filter\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"or","description":"Adds OR condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#or\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"sort","description":"Adds sort by field. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#sort\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"limit","description":"Limit amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#limit\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"offset","description":"Offset amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#offset\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page portion of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#page\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginatedDto"},{"properties":{"entity":{"type":"string","example":"AssetContainer"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AssetContainer"}}}}]}}}}},"tags":["Asset Container"],"security":[{"bearer":[]}]},"post":{"operationId":"createOneBaseAssetContainerControllerAssetContainer","summary":"Create a single AssetContainer","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAssetContainerDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetContainer"}}}},"201":{"description":"Get create one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetContainer"}}}}},"tags":["Asset Container"],"security":[{"bearer":[]}]}},"/asset-container/{id}/event":{"get":{"operationId":"AssetContainerController_getEvents","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetContainerEvent"}}}}},"tags":["Asset Container"],"security":[{"bearer":[]}]}},"/asset-container/{id}/yard-events":{"get":{"operationId":"AssetContainerController_getYardEvents","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetContainerEvent"}}}}},"tags":["Asset Container"],"security":[{"bearer":[]}]}},"/asset-container/event":{"post":{"operationId":"AssetContainerController_createEvent","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAssetContainerEventDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetContainerEvent"}}}},"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Asset Container"],"security":[{"bearer":[]}]}},"/document/{id}/download":{"get":{"operationId":"DocumentController_download","summary":"Download a file using its ID","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Binary file content","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}},"tags":["Documents"],"security":[{"bearer":[]}]}},"/storage":{"post":{"operationId":"StorageController_saveFile","parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageDto"}}}},"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Storage"],"security":[{"bearer":[]}]}},"/storage/files":{"post":{"operationId":"StorageController_saveFiles","parameters":[],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"files":{"type":"array","items":{"type":"string","format":"binary"}}}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StorageDto"}}}}},"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Storage"],"security":[{"bearer":[]}]}},"/yard/spot":{"get":{"operationId":"getManyBaseSpotControllerSpot","summary":"Retrieve multiple Spots","parameters":[{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"s","description":"Adds search condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#search\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"string"}},{"name":"filter","description":"Adds filter condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#filter\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"or","description":"Adds OR condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#or\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"sort","description":"Adds sort by field. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#sort\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"limit","description":"Limit amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#limit\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"offset","description":"Offset amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#offset\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page portion of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#page\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSpotDto"}}}}},"tags":["YMS - Spot"],"security":[{"bearer":[]}]},"post":{"operationId":"createOneBaseSpotControllerSpot","summary":"Create a single Spot","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSpotDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Spot"}}}}},"tags":["YMS - Spot"],"security":[{"bearer":[]}]}},"/yard/spot/generate":{"post":{"operationId":"SpotController_generate","summary":"Generate multiple spots","description":"Generates multiple spots in the yard","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSpotManyDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Spot"}}}}},"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["YMS - Spot"],"security":[{"bearer":[]}]}},"/yard/spot/{id}":{"patch":{"operationId":"updateOneBaseSpotControllerSpot","summary":"Update a single Spot","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSpotDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Spot"}}}}},"tags":["YMS - Spot"],"security":[{"bearer":[]}]},"delete":{"operationId":"deleteOneBaseSpotControllerSpot","summary":"Delete a single Spot","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteResult"}}}}},"tags":["YMS - Spot"],"security":[{"bearer":[]}]},"get":{"operationId":"getOneBaseSpotControllerSpot","summary":"Retrieve a single Spot","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"Get one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Spot"}}}}},"tags":["YMS - Spot"],"security":[{"bearer":[]}]}},"/yard/spot/delete/bulk":{"post":{"operationId":"SpotController_bulkDelete","summary":"Bulk delete spots","description":"Deletes multiple spots in the yard","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteSpotManyDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteResult"}}}},"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["YMS - Spot"],"security":[{"bearer":[]}]}},"/yard/spot/{id}/close":{"patch":{"operationId":"SpotController_closeSpot","summary":"Close a spot","description":"Closes a spot in the yard blocking spot assignments","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSpotStatusDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Spot"}}}}},"tags":["YMS - Spot"],"security":[{"bearer":[]}]}},"/yard/spot/{id}/open":{"patch":{"operationId":"SpotController_openSpot","summary":"Open a spot","description":"Opens a spot in the yard for spot assignment","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSpotStatusDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Spot"}}}}},"tags":["YMS - Spot"],"security":[{"bearer":[]}]}},"/yard/spot/{id}/toggle-reserve":{"patch":{"operationId":"SpotController_toggleReserveSpot","summary":"Toggle spot reserve","description":"Either create or remove a spotReserve entry for such spot","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToggleSpotReserveDto"}}}},"responses":{"200":{"description":""}},"tags":["YMS - Spot"],"security":[{"bearer":[]}]}},"/yard/spot/{id}/events":{"get":{"operationId":"SpotController_getSpotEvents","summary":"Get spot events","description":"Retrieves all events associated with a specific spot in the yard","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SpotEvent"}}}}}},"tags":["YMS - Spot"],"security":[{"bearer":[]}]}},"/yard/spot-area":{"post":{"operationId":"createOneBaseSpotAreaControllerSpotArea","summary":"Create a single SpotArea","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSpotAreaDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotArea"}}}}},"tags":["YMS - Spot Area"],"security":[{"bearer":[]}]},"get":{"operationId":"getManyBaseSpotAreaControllerSpotArea","summary":"Retrieve multiple SpotAreas","parameters":[{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"s","description":"Adds search condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#search\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"string"}},{"name":"filter","description":"Adds filter condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#filter\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"or","description":"Adds OR condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#or\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"sort","description":"Adds sort by field. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#sort\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"limit","description":"Limit amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#limit\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"offset","description":"Offset amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#offset\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page portion of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#page\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"Get paginated response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManySpotAreaResponseDto"}}}}},"tags":["YMS - Spot Area"],"security":[{"bearer":[]}]}},"/yard/spot-area/{id}":{"patch":{"operationId":"updateOneBaseSpotAreaControllerSpotArea","summary":"Update a single SpotArea","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSpotAreaDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotArea"}}}}},"tags":["YMS - Spot Area"],"security":[{"bearer":[]}]},"delete":{"operationId":"deleteOneBaseSpotAreaControllerSpotArea","summary":"Delete a single SpotArea","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotArea"}}}}},"tags":["YMS - Spot Area"],"security":[{"bearer":[]}]},"get":{"operationId":"getOneBaseSpotAreaControllerSpotArea","summary":"Retrieve a single SpotArea","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"Get one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotArea"}}}}},"tags":["YMS - Spot Area"],"security":[{"bearer":[]}]}},"/yard/spot-assignment":{"post":{"operationId":"createOneBaseSpotAssignmentControllerSpotAssignment","summary":"Create a single SpotAssignment","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSpotAssignmentDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotAssignment"}}}}},"tags":["YMS - Spot Assignment"],"security":[{"bearer":[]}]},"get":{"operationId":"getManyBaseSpotAssignmentControllerSpotAssignment","summary":"Retrieve multiple SpotAssignments","parameters":[{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"s","description":"Adds search condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#search\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"string"}},{"name":"filter","description":"Adds filter condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#filter\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"or","description":"Adds OR condition. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#or\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"sort","description":"Adds sort by field. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#sort\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"limit","description":"Limit amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#limit\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"offset","description":"Offset amount of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#offset\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"page","description":"Page portion of resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#page\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer"}},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"Get paginated response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManySpotAssignmentResponseDto"}}}}},"tags":["YMS - Spot Assignment"],"security":[{"bearer":[]}]}},"/yard/spot-assignment/{id}":{"patch":{"operationId":"updateOneBaseSpotAssignmentControllerSpotAssignment","summary":"Update a single SpotAssignment","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSpotAssignmentDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotAssignment"}}}}},"tags":["YMS - Spot Assignment"],"security":[{"bearer":[]}]},"delete":{"operationId":"deleteOneBaseSpotAssignmentControllerSpotAssignment","summary":"Delete a single SpotAssignment","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotAssignment"}}}}},"tags":["YMS - Spot Assignment"],"security":[{"bearer":[]}]},"get":{"operationId":"getOneBaseSpotAssignmentControllerSpotAssignment","summary":"Retrieve a single SpotAssignment","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"fields","description":"Selects resource fields. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#select\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":false},{"name":"join","description":"Adds relational resources. <a href=\"https://github.com/nestjsx/crud/wiki/Requests#join\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"cache","description":"Reset cache (if was enabled). <a href=\"https://github.com/nestjsx/crud/wiki/Requests#cache\" target=\"_blank\">Docs</a>","required":false,"in":"query","schema":{"type":"integer","minimum":0,"maximum":1}}],"responses":{"200":{"description":"Get one base response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotAssignment"}}}}},"tags":["YMS - Spot Assignment"],"security":[{"bearer":[]}]}},"/yard/spot-assignment/{id}/depart":{"patch":{"operationId":"SpotAssignmentController_depart","summary":"Depart a spot assignment","description":"Depart a the contents of a spot assignment from the waiting list, adding a event type DEPARTED to each item inside the spot assignment","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepartSpotAssignmentDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotAssignment"}}}}},"tags":["YMS - Spot Assignment"],"security":[{"bearer":[]}]}},"/yard/spot-assignment/{id}/reassign":{"patch":{"operationId":"SpotAssignmentController_reassignSpot","summary":"Reassign a spot assignment","description":"Reassign a the contents of a spot assignment to a new spot dynamically","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReassignSpotDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotAssignment"}}}}},"tags":["YMS - Spot Assignment"],"security":[{"bearer":[]}]}},"/yard/view/spot-grid":{"get":{"operationId":"YardViewController_getSpotGrid","summary":"Get lean spot grid data optimized for grid view rendering","parameters":[{"name":"warehouseId","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotGridResponseDto"}}}}},"tags":["YMS - Yard View"],"security":[{"bearer":[]}]}},"/yard/view/waiting-assets":{"get":{"operationId":"YardViewController_getWaitingAssets","summary":"Get asset visits and containers waiting for spot assignment","parameters":[{"name":"warehouseId","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/YardViewWaitingQueueResponseDto"}}}}},"tags":["YMS - Yard View"],"security":[{"bearer":[]}]}},"/yard/view/list-rows":{"get":{"operationId":"YardViewController_getListViewRows","summary":"Get flattened list view rows (one row per container or truckless visit)","parameters":[{"name":"warehouseId","required":true,"in":"query","schema":{"type":"string"}},{"name":"includeWaiting","required":false,"in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListViewResponseDto"}}}}},"tags":["YMS - Yard View"],"security":[{"bearer":[]}]}},"/yard/view/spot-detail":{"get":{"operationId":"YardViewController_getSpotDetail","summary":"Get full spot detail for drawer: spot, task, assignment, and when applicable arrival/same-appointment containers","parameters":[{"name":"spotId","required":true,"in":"query","schema":{"type":"string"}},{"name":"warehouseId","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpotDetailResponseDto"}}}}},"tags":["YMS - Yard View"],"security":[{"bearer":[]}]}},"/saml/config":{"get":{"operationId":"SamlController_getConfig","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["SAML"],"security":[{"bearer":[]}]},"patch":{"operationId":"SamlController_updateConfig","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSamlConfigDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["SAML"],"security":[{"bearer":[]}]},"delete":{"operationId":"SamlController_resetConfig","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["SAML"],"security":[{"bearer":[]}]}},"/saml/metadata-url":{"get":{"operationId":"SamlController_getSpMetadataUrl","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["SAML"],"security":[{"bearer":[]}]}},"/saml/ac/{orgId}":{"post":{"operationId":"SamlController_samlAssertionConsumer","parameters":[],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["SAML"]}},"/saml/login/{orgId}":{"get":{"operationId":"SamlController_samlLogin","parameters":[],"responses":{"200":{"description":""}},"tags":["SAML"]}},"/saml/metadata/{orgId}":{"get":{"operationId":"SamlController_getSpMetadata","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["SAML"]}},"/gates/{warehouseId}":{"get":{"operationId":"GatesController_listGatesByWarehouse","parameters":[{"name":"warehouseId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatesByWarehouseDto"}}}}},"tags":["Gates"],"security":[{"bearer":[]}]}},"/observations":{"get":{"operationId":"ObservationController_getObservations","parameters":[{"name":"startDate","required":false,"in":"query","schema":{"format":"date-time","type":"string"}},{"name":"endDate","required":false,"in":"query","schema":{"format":"date-time","type":"string"}},{"name":"gateId","required":false,"in":"query","schema":{"type":"string"}},{"name":"warehouseId","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VehicleObservation"}}}}}},"tags":["Observations"],"security":[{"bearer":[]}]}},"/observations/{id}":{"get":{"operationId":"ObservationController_getObservation","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleObservation"}}}}},"tags":["Observations"],"security":[{"bearer":[]}]}},"/observations/{id}/asset-visit":{"post":{"operationId":"ObservationController_createAssetVisit","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObservationCreateAssetVisitDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObservationCreateAssetVisitResponse"}}}},"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Observations"],"security":[{"bearer":[]}]}},"/audit-log/{objectId}":{"get":{"operationId":"AuditLogController_search","parameters":[{"name":"objectId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AuditLog"}}}}}},"tags":["Audit Log"],"security":[{"bearer":[]}]}},"/settings-metadata/{entityType}":{"get":{"operationId":"SettingsMetadataController_getAll","parameters":[{"name":"entityType","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Settings Metadata"],"security":[{"bearer":[]}]}},"/settings-metadata/{entityType}/{settingKey}":{"get":{"operationId":"SettingsMetadataController_getOne","parameters":[{"name":"entityType","required":true,"in":"path","schema":{"type":"string"}},{"name":"settingKey","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Settings Metadata"],"security":[{"bearer":[]}]}},"/settings-metadata/validate/{entityType}":{"post":{"operationId":"SettingsMetadataController_validateSetting","parameters":[{"name":"entityType","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Settings Metadata"],"security":[{"bearer":[]}]}},"/metrics/appointment-volume/load-type":{"get":{"operationId":"MetricsController_getLoadTypeVolume","summary":"Appointment volume by load type and week day","parameters":[{"name":"warehouseIds","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"toDate","required":false,"in":"query","schema":{"type":"string"}},{"name":"fromDate","required":false,"in":"query","schema":{"type":"string"}},{"name":"warehouseId","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsAppointmentVolumeByLoadTypeResponse"}}}}},"tags":["Metrics"],"security":[{"bearer":[]},{"bearer":[]}]}},"/metrics/appointment-volume/time-of-day":{"get":{"operationId":"MetricsController_getTimeOfDayVolume","summary":"Appointment volume by time of day","parameters":[{"name":"warehouseIds","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"toDate","required":false,"in":"query","schema":{"type":"string"}},{"name":"fromDate","required":false,"in":"query","schema":{"type":"string"}},{"name":"warehouseId","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsAppointmentVolumeByTimeOfDayResponse"}}}}},"tags":["Metrics"],"security":[{"bearer":[]},{"bearer":[]}]}},"/metrics/appointment-volume/date":{"get":{"operationId":"MetricsController_getDateVolume","summary":"Appointment volume by date","parameters":[{"name":"warehouseIds","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"toDate","required":false,"in":"query","schema":{"type":"string"}},{"name":"fromDate","required":false,"in":"query","schema":{"type":"string"}},{"name":"warehouseId","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsAppointmentVolumeByDateResponse"}}}}},"tags":["Metrics"],"security":[{"bearer":[]},{"bearer":[]}]}},"/metrics/appointment-volume/carrier":{"get":{"operationId":"MetricsController_getCarrierVolume","summary":"Appointment volume by carrier","parameters":[{"name":"warehouseIds","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"toDate","required":false,"in":"query","schema":{"type":"string"}},{"name":"fromDate","required":false,"in":"query","schema":{"type":"string"}},{"name":"warehouseId","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsAppointmentVolumeByCarrierResponse"}}}}},"tags":["Metrics"],"security":[{"bearer":[]},{"bearer":[]}]}},"/metrics/appointment-volume/average-duration-by-load-type":{"get":{"operationId":"MetricsController_getAverageDurationByLoadType","summary":"Appointment duration average by load type","parameters":[{"name":"warehouseIds","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"toDate","required":false,"in":"query","schema":{"type":"string"}},{"name":"fromDate","required":false,"in":"query","schema":{"type":"string"}},{"name":"warehouseId","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsAverageDurationByLoadTypeResponse"}}}}},"tags":["Metrics"],"security":[{"bearer":[]},{"bearer":[]}]}},"/metrics/appointment-volume/day-of-week":{"get":{"operationId":"MetricsController_getDayOfWeekVolume","summary":"Appointment duration average by dock and day of week","parameters":[{"name":"warehouseIds","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"toDate","required":false,"in":"query","schema":{"type":"string"}},{"name":"fromDate","required":false,"in":"query","schema":{"type":"string"}},{"name":"warehouseId","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsAppointmentVolumeByDayOfWeekResponse"}}}}},"tags":["Metrics"],"security":[{"bearer":[]},{"bearer":[]}]}},"/metrics/appointment-volume/status":{"get":{"operationId":"MetricsController_getStatusVolume","summary":"Appointment duration average by status","parameters":[{"name":"warehouseIds","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"toDate","required":false,"in":"query","schema":{"type":"string"}},{"name":"fromDate","required":false,"in":"query","schema":{"type":"string"}},{"name":"warehouseId","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsAppointmentVolumeByStatusResponse"}}}}},"tags":["Metrics"],"security":[{"bearer":[]},{"bearer":[]}]}},"/metrics/appointment-volume/status-by-dock":{"get":{"operationId":"MetricsController_getStatusByDockVolume","summary":"Appointment duration average by dock and status","parameters":[{"name":"warehouseIds","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"toDate","required":false,"in":"query","schema":{"type":"string"}},{"name":"fromDate","required":false,"in":"query","schema":{"type":"string"}},{"name":"warehouseId","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsAppointmentVolumeByStatusByDockResponse"}}}}},"tags":["Metrics"],"security":[{"bearer":[]},{"bearer":[]}]}},"/metrics/appointments/status-times":{"post":{"operationId":"MetricsController_getStatusTimes","summary":"The average time spent in each appointment status","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentMetricsDto"}}}},"responses":{"201":{"description":""}},"tags":["Metrics"],"security":[{"bearer":[]},{"bearer":[]}]}},"/metrics/appointments/excel":{"post":{"operationId":"MetricsController_getExcelReport","summary":"Retrieve file link with the appointment list that matches the criteria described in the request body, ","description":"The link will point to an XLSX file external to Nova","parameters":[{"name":"emailCCs","required":true,"in":"query","schema":{"type":"array","items":{"type":"string"}}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentMetricsListDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Metrics"],"security":[{"bearer":[]},{"bearer":[]}]}},"/metrics/yard/excel":{"post":{"operationId":"MetricsController_getYardExcelReport","summary":"Retrieve file link with the yard data list that matches the criteria described in the request body","description":"The link will point to an XLSX file external to Nova","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/YardExportDataDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"tags":["Metrics"],"security":[{"bearer":[]},{"bearer":[]}]}},"/metrics/warehouse/capacity-usage":{"post":{"operationId":"MetricsController_getWarehouseCapacityUsage","summary":"Retrieve warehouse dock capacity usage information per warehouse","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentMetricsCapacityDto"}}}},"responses":{"201":{"description":""}},"tags":["Metrics"],"security":[{"bearer":[]},{"bearer":[]}]}},"/metrics/warehouse":{"post":{"operationId":"MetricsController_getWarehouseMetrics","summary":"Retrieve warehouse insights","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WarehouseMetricsDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsCarrierStatusPercentageResponse"}}}},"201":{"description":""}},"tags":["Metrics"],"security":[{"bearer":[]},{"bearer":[]}]}},"/metrics/carrier/status-percentages":{"get":{"operationId":"MetricsController_getCarrierStatusPercentages","summary":"Retrieve carrier insights data with each status percentage","parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsCarrierStatusPercentageResponse"}}}}},"tags":["Metrics"],"security":[{"bearer":[]},{"bearer":[]}]}},"/metrics/dock/dwell-time":{"get":{"operationId":"MetricsController_getDockDwellTime","summary":"Retrieve dock metrics of dwell time by day of week","parameters":[{"name":"fromDate","required":false,"in":"query","description":"From date to filter","schema":{}},{"name":"toDate","required":false,"in":"query","description":"To date to filter","schema":{}},{"name":"warehouseId","required":false,"in":"query","description":"Warehouse ID to filter","schema":{}},{"name":"dockId","required":false,"in":"query","description":"Dock ID to filter","schema":{}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsDockDwellTimeResponse"}}}}},"tags":["Metrics"],"security":[{"bearer":[]},{"bearer":[]}]}},"/metrics/counts/appointment-count-for-docks":{"get":{"operationId":"MetricsController_getAppointmentCountForDocks","summary":"Appointment count per dock","parameters":[{"name":"dockIds","required":true,"in":"query","description":"Dock IDs array","schema":{}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsCountsAppointmentCountForDocksResponse"}}}}},"tags":["Metrics"],"security":[{"bearer":[]},{"bearer":[]}]}},"/metrics/counts/appointment-count-for-carrier":{"get":{"operationId":"MetricsController_getAppointmentCountForCarrier","summary":"Appointment count per carrier","parameters":[{"name":"carrierId","required":true,"in":"query","description":"Carrier ID","schema":{}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsCountsAppointmentCountForCarrierResponse"}}}}},"tags":["Metrics"],"security":[{"bearer":[]},{"bearer":[]}]}},"/metrics/counts/appointment-count-for-carrier/status":{"get":{"operationId":"MetricsController_getAppointmentCountByStatusForCarrier","summary":"Appointment count by status for current carrier","parameters":[],"responses":{"200":{"description":""}},"tags":["Metrics"],"security":[{"bearer":[]},{"bearer":[]}]}},"/metrics/counts/reserve-count-for-user":{"get":{"operationId":"MetricsController_getReserveCountForUser","summary":"Reserve count for user","parameters":[{"name":"userId","required":false,"in":"query","description":"User ID","schema":{}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsCountsReserveCountForUserResponse"}}}}},"tags":["Metrics"],"security":[{"bearer":[]},{"bearer":[]}]}},"/metrics/loadtype/first-avail-appt":{"post":{"operationId":"MetricsController_getFirstAvailAppts","summary":"Finds the next available appointment time for each dock and loadtype, starting from the current date and time onward","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoadTypeMetricsDto"}}}},"responses":{"201":{"description":""}},"tags":["Metrics"],"security":[{"bearer":[]},{"bearer":[]}]}},"/metrics-v2/appointments":{"post":{"operationId":"MetricsV2Controller_getAppointmentsList","summary":"Retrieve an appointment list that matches the criteria described in the request body","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentMetricsListV2Dto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetricsAppointmentListResponse"}}}}},"tags":["Metrics"],"security":[{"bearer":[]},{"bearer":[]}]}},"/bol":{"post":{"operationId":"BolController_create","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBolRequestDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBolResponseDto"}}}}},"tags":["BOL"],"security":[{"bearer":[]}]}},"/bol/{bolId}":{"get":{"operationId":"BolController_get","parameters":[{"name":"bolId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBolResponseDto"}}}}},"tags":["BOL"],"security":[{"bearer":[]}]}}},"info":{"title":"Opendock Nova API Documentation","description":"","version":"v4.134.1 - cb3b5f6\n","contact":{}},"tags":[{"name":"Custom Forms - Forms","description":"Forms are collections of form fields that represent a complete data entry interface. Each Form belongs to a Flow and captures related data points in a structured way. Forms provide the user interface for data collection."},{"name":"Custom Forms - Fields","description":"Fields are global definitions that specify fundamental attributes like data type (text, number, dropdown, etc.), validation rules, and base properties. Fields are organization-wide resources that can be instantiated as Form Fields across multiple Forms."},{"name":"Custom Forms - Form Fields","description":"Form Fields are instances of global Field definitions within a specific Form. While Fields define the data type and general properties, Form Fields customize these instances with form-specific attributes like required status, custom labels, and validation rules."},{"name":"Custom Forms - Flows","description":"Flows define the sequence and logic of form presentation. Each Flow must have a primary \"fromForm\" and may optionally include a secondary \"formTo\" that appears after the first form is completed. Flows connect Triggers to the actual Forms that collect data."},{"name":"Custom Forms - Triggers","description":"Triggers are event listeners that activate on specific API or UI events. Each Trigger is associated with exactly one Flow. When a Trigger fires, it initiates its associated Flow, which in turn presents one or two Forms sequentially."},{"name":"Custom Forms - Data","description":"Data entities store the actual values submitted through Forms. Each form submission creates multiple Data records - one for each Form Field with a value. These records maintain the relationship between the entity (like an appointment), the form field, and the submitted value."}],"servers":[{"url":"https://neutron.opendock.com","description":"Production Server"},{"url":"https://neutron.staging.opendock.com","description":"Staging Server"}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"VersionDto":{"type":"object","properties":{"major":{"type":"number","example":2},"minor":{"type":"number","example":2},"patch":{"type":"number","example":1},"commit":{"type":"string","example":"77af713"}},"required":["major","minor","patch","commit"]},"AppEnvironmentDto":{"type":"object","properties":{"S3_BUCKET":{"type":"string","example":"bucket-name"},"S3_BASE":{"type":"string","example":"s3base.name"},"S3_DOWNLOAD_URL":{"type":"string","example":"files.opendock.com"}}},"GetManyWarehouseResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Warehouse"}},"count":{"type":"number"},"total":{"type":"number"},"page":{"type":"number"},"pageCount":{"type":"number"}},"required":["data","count","total","page","pageCount"]},"ClockSpan":{"type":"object","properties":{"end":{"type":"string","example":"18:00"},"start":{"type":"string","example":"06:00"}},"required":["end","start"]},"TimeInterval":{"type":"object","properties":{"end":{"format":"date-time","type":"string"},"start":{"format":"date-time","type":"string"}},"required":["end","start"]},"ScheduleDto":{"type":"object","properties":{"sunday":{"type":"array","items":{"$ref":"#/components/schemas/ClockSpan"}},"monday":{"type":"array","items":{"$ref":"#/components/schemas/ClockSpan"}},"tuesday":{"type":"array","items":{"$ref":"#/components/schemas/ClockSpan"}},"wednesday":{"type":"array","items":{"$ref":"#/components/schemas/ClockSpan"}},"thursday":{"type":"array","items":{"$ref":"#/components/schemas/ClockSpan"}},"friday":{"type":"array","items":{"$ref":"#/components/schemas/ClockSpan"}},"saturday":{"type":"array","items":{"$ref":"#/components/schemas/ClockSpan"}},"version":{"type":"number","example":1},"closedIntervals":{"type":"array","items":{"$ref":"#/components/schemas/TimeInterval"}}},"required":["sunday","monday","tuesday","wednesday","thursday","friday","saturday","version","closedIntervals"]},"CustomFieldTemplateDto":{"type":"object","properties":{"type":{"type":"string","enum":["str","bigstr","date","bool","doc","multidoc","int","email","phone","dropdown","dropdownmultiselect","combobox","timestamp","action"]},"label":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"order":{"type":"number"},"value":{"type":"object"},"required":{"type":"boolean"},"requiredForWarehouse":{"type":"boolean"},"requiredForCarrier":{"type":"boolean"},"dropDownValues":{"type":"array","items":{"type":"string"}},"hiddenFromCarrier":{"type":"boolean"},"placeholder":{"type":"string"},"minLengthOrValue":{"type":"number"},"maxLengthOrValue":{"type":"number"}},"required":["type","label","name"]},"Warehouse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"schedule":{"$ref":"#/components/schemas/ScheduleDto"},"country":{"type":"string","minLength":3,"maxLength":3},"timezone":{"type":"string","minLength":3,"maxLength":40},"docks":{"type":"Dock"},"loadTypes":{"type":"LoadType"},"org":{"type":"Warehouse"},"orgId":{"type":"string"},"contactName":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"},"notes":{"type":"string"},"instructions":{"type":"string"},"customApptFieldsTemplate":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldTemplateDto"}},"refNumberValidationVersion":{"type":"string","enum":["V1","V2"]},"refNumberValidationUrl":{"type":"string"},"refNumberValidationPasscode":{"type":"string"},"settings":{"type":"object"},"allowCarrierScheduling":{"type":"boolean"},"geolocation":{"type":"object"},"ccEmails":{"type":"array","items":{"type":"string"}},"amenities":{"type":"array","example":["Lumper services","Drivers restroom","Overnight parking","Free Wi-Fi"],"items":{"type":"string","enum":["Lumper services","Drivers restroom","Overnight parking","Free Wi-Fi"]}},"ppeRequirements":{"type":"array","example":["Face Mask","Safety Glasses","Hard Hat","Safety Boots","Gloves","High Visibility Vest","Long Pants","Long Sleeves","No Smoking","Hair and Beard Net"],"items":{"type":"string","enum":["Face Mask","Safety Glasses","Hard Hat","Safety Boots","Gloves","High Visibility Vest","Long Pants","Long Sleeves","No Smoking","Hair and Beard Net"]}},"intervalTrimForCarriers":{"type":"number","minimum":0,"maximum":30},"customBookingUrl":{"type":"string"},"name":{"type":"string","minLength":1,"maxLength":100},"facilityNumber":{"type":"string","minLength":1,"maxLength":100},"street":{"type":"string","minLength":1,"maxLength":100},"city":{"type":"string","minLength":1,"maxLength":100},"state":{"type":"string","minLength":1,"maxLength":100},"zip":{"type":"string","minLength":1,"maxLength":100},"assetVisits":{"type":"array","items":{"type":"object"}},"assetContainers":{"type":"array","items":{"type":"object"}},"warehouseGroups":{"type":"array","items":{"type":"object"}},"warehouseFeatures":{"type":"array","items":{"type":"object"}},"triggers":{"type":"array","items":{"type":"object"}},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","schedule","amenities","ppeRequirements","name","street","city","state","zip","lastChangedBy","isActive","tags"]},"PaginatedDto":{"type":"object","properties":{"count":{"type":"number","example":2},"total":{"type":"number","example":2},"page":{"type":"number","example":1},"pageCount":{"type":"number","example":1},"action":{"type":"string","example":"read"},"entity":{"type":"string","example":"Appointment"},"data":{"type":"array","items":{"type":"string"}}},"required":["count","total","page","pageCount","action","entity","data"]},"CreateWarehouseDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"name":{"type":"string","minLength":1,"maxLength":100},"facilityNumber":{"type":"string","minLength":1,"maxLength":100},"country":{"type":"string","minLength":3,"maxLength":3},"timezone":{"type":"string","minLength":3,"maxLength":40},"schedule":{"$ref":"#/components/schemas/ScheduleDto"},"contactName":{"type":"string","nullable":true},"phone":{"type":"string"},"email":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"instructions":{"type":"string","nullable":true},"customApptFieldsTemplate":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldTemplateDto"}},"refNumberValidationVersion":{"type":"string","enum":["V1","V2"]},"refNumberValidationUrl":{"type":"string"},"refNumberValidationPasscode":{"type":"string"},"settings":{"type":"object"},"allowCarrierScheduling":{"type":"boolean"},"ccEmails":{"type":"array","items":{"type":"string"}},"amenities":{"type":"array","example":["Lumper services","Drivers restroom","Overnight parking","Free Wi-Fi"],"items":{"type":"string","enum":["Lumper services","Drivers restroom","Overnight parking","Free Wi-Fi"]}},"ppeRequirements":{"type":"array","example":["Face Mask","Safety Glasses","Hard Hat","Safety Boots","Gloves","High Visibility Vest","Long Pants","Long Sleeves","No Smoking","Hair and Beard Net"],"items":{"type":"string","enum":["Face Mask","Safety Glasses","Hard Hat","Safety Boots","Gloves","High Visibility Vest","Long Pants","Long Sleeves","No Smoking","Hair and Beard Net"]}},"intervalTrimForCarriers":{"type":"number","minimum":0,"maximum":30},"customBookingUrl":{"type":"string"},"street":{"type":"string","minLength":1,"maxLength":100},"city":{"type":"string","minLength":1,"maxLength":100},"state":{"type":"string","minLength":1,"maxLength":100},"zip":{"type":"string","minLength":1,"maxLength":100}},"required":["name","street","city","state","zip"]},"UpdateWarehouseDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"name":{"type":"string","minLength":1,"maxLength":100},"facilityNumber":{"type":"string","minLength":1,"maxLength":100},"country":{"type":"string","minLength":3,"maxLength":3},"timezone":{"type":"string","minLength":3,"maxLength":40},"schedule":{"$ref":"#/components/schemas/ScheduleDto"},"contactName":{"type":"string","nullable":true},"phone":{"type":"string"},"email":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"instructions":{"type":"string","nullable":true},"customApptFieldsTemplate":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldTemplateDto"}},"refNumberValidationVersion":{"type":"string","enum":["V1","V2"]},"refNumberValidationUrl":{"type":"string"},"refNumberValidationPasscode":{"type":"string"},"settings":{"type":"object"},"allowCarrierScheduling":{"type":"boolean"},"ccEmails":{"type":"array","items":{"type":"string"}},"amenities":{"type":"array","example":["Lumper services","Drivers restroom","Overnight parking","Free Wi-Fi"],"items":{"type":"string","enum":["Lumper services","Drivers restroom","Overnight parking","Free Wi-Fi"]}},"ppeRequirements":{"type":"array","example":["Face Mask","Safety Glasses","Hard Hat","Safety Boots","Gloves","High Visibility Vest","Long Pants","Long Sleeves","No Smoking","Hair and Beard Net"],"items":{"type":"string","enum":["Face Mask","Safety Glasses","Hard Hat","Safety Boots","Gloves","High Visibility Vest","Long Pants","Long Sleeves","No Smoking","Hair and Beard Net"]}},"intervalTrimForCarriers":{"type":"number","minimum":0,"maximum":30},"customBookingUrl":{"type":"string"},"street":{"type":"string","minLength":1,"maxLength":100},"city":{"type":"string","minLength":1,"maxLength":100},"state":{"type":"string","minLength":1,"maxLength":100},"zip":{"type":"string","minLength":1,"maxLength":100}}},"UpdateLoadTypesCustomFormsDto":{"type":"object","properties":{"parentCode":{"type":"string","description":"The parent code of the form, used to group forms together, generated by the API, cannot be changed!","example":"acfb1234-5678-90ab-cdef-1234567890ab","readOnly":true},"loadTypeIds":{"type":"array","items":{"required":false,"description":"The list of load type ids that this form will be used for","example":["a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5"],"type":"array","items":{"type":"string"}}},"formName":{"type":"string","description":"The name of the form","example":"Load Type Form"}},"required":["parentCode","loadTypeIds"]},"CreateLoadTypesCustomFormsDto":{"type":"object","properties":{"loadTypeIds":{"type":"array","items":{"required":true,"description":"The list of load type ids that this form will be used for","example":["a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5"],"type":"array","items":{"type":"string"}}},"formName":{"type":"string","description":"The name of the form","example":"Load Type Form"},"formDescription":{"type":"string","description":"Extra description of the form","example":"This form is used to collect information about the load type"}},"required":["loadTypeIds","formName"]},"GetHoursOfOperationDto":{"type":"object","properties":{"start":{"format":"date-time","type":"string","example":"2026-04-03T20:21:50.216Z"},"end":{"format":"date-time","type":"string","example":"2026-04-03T20:21:50.216Z"},"dockIds":{"type":"array","items":{"type":"string"}}},"required":["start","end"]},"DockHoursOfOperation":{"type":"object","properties":{"openIntervals":{"type":"array","items":{"$ref":"#/components/schemas/TimeInterval"}},"dockId":{"type":"string"}},"required":["openIntervals","dockId"]},"InviteDto":{"type":"object","properties":{"email":{"type":"string"},"role":{"type":"object"},"firstName":{"type":"string","minLength":1,"maxLength":100},"lastName":{"type":"string","minLength":1,"maxLength":100},"password":{"type":"string"},"warehouseAccessList":{"type":"array","items":{"type":"string"}}},"required":["email","role","firstName","lastName"]},"GetManyUserResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"count":{"type":"number"},"total":{"type":"number"},"page":{"type":"number"},"pageCount":{"type":"number"}},"required":["data","count","total","page","pageCount"]},"GetManyAppointmentResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Appointment"}},"count":{"type":"number"},"total":{"type":"number"},"page":{"type":"number"},"pageCount":{"type":"number"}},"required":["data","count","total","page","pageCount"]},"Appointment":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"type":{"type":"string","enum":["Standard","Reserve"]},"status":{"type":"string","enum":["NoShow","Cancelled","Requested","Scheduled","Arrived","InProgress","Completed"]},"user":{"$ref":"#/components/schemas/User"},"userId":{"type":"object"},"loadType":{"type":"LoadType"},"loadTypeId":{"type":"string"},"dock":{"type":"Dock"},"org":{"type":"Org"},"orgId":{"type":"string"},"end":{"format":"date-time","type":"string"},"eta":{"format":"date-time","type":"string"},"refNumber":{"type":"string"},"refNumbers":{"type":"array","items":{"type":"string"}},"customFields":{"type":"array","items":{"type":"object"}},"notes":{"type":"object"},"ccEmails":{"type":"array","items":{"type":"string"}},"recurringParentId":{"type":"string"},"recurringParent":{"$ref":"#/components/schemas/Appointment"},"recurringChildren":{"$ref":"#/components/schemas/Appointment"},"recurringPattern":{"type":"object"},"reschedules":{"type":"array","items":{"type":"object"}},"muteNotifications":{"type":"boolean"},"isCheckedInByCarrier":{"type":"boolean"},"statusTimeline":{"type":"object"},"dockId":{"type":"string"},"start":{"format":"date-time","type":"string"},"confirmationNumber":{"type":"number"},"assetVisit":{"type":"object"},"metadata":{"type":"object"},"pickupAssetContainers":{"type":"array","items":{"type":"object"}},"dropAssetContainers":{"type":"array","items":{"type":"object"}},"units":{"type":"object"},"searchableCustomFields":{"type":"object"},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","dockId","start","confirmationNumber","lastChangedBy","isActive","tags"]},"User":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"role":{"type":"string","enum":["role_god","role_internal","role_owner","role_admin","role_operator","role_attendant","role_spectator","role_yard_driver","role_carrier_admin","role_carrier","role_base"]},"appointments":{"type":"array","items":{"$ref":"#/components/schemas/Appointment"}},"company":{"type":"Company"},"orgCarrierSettings":{"type":"array","items":{"type":"OrgCarrierSettings"}},"org":{"type":"Org"},"warehouseAccessList":{"type":"UUID"},"tcConfirmedAt":{"format":"date-time","type":"string"},"email":{"type":"string"},"firstName":{"type":"string","minLength":1,"maxLength":100},"lastName":{"type":"string","minLength":1,"maxLength":100},"phone":{"type":"string"},"extension":{"type":"string","minLength":1,"maxLength":6},"isEmailVerified":{"type":"boolean"},"companyId":{"type":"string"},"orgId":{"type":"string"},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","email","firstName","lastName","isEmailVerified","lastChangedBy","isActive","tags"]},"GetManyOrgCarrierSettingsResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OrgCarrierSettings"}},"count":{"type":"number"},"total":{"type":"number"},"page":{"type":"number"},"pageCount":{"type":"number"}},"required":["data","count","total","page","pageCount"]},"GetManyOrgResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Org"}},"count":{"type":"number"},"total":{"type":"number"},"page":{"type":"number"},"pageCount":{"type":"number"}},"required":["data","count","total","page","pageCount"]},"Org":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"warehouses":{"type":"array","items":{"$ref":"#/components/schemas/Warehouse"}},"reportSearches":{"type":"object"},"customTags":{"type":"array","items":{"type":"object"}},"samlConfig":{"type":"object"},"orgType":{"type":"string","enum":["Trial","Test","Client"]},"expiresAt":{"format":"date-time","type":"string"},"name":{"type":"string","minLength":1,"maxLength":100},"isDataWallEnabled":{"type":"boolean"},"users":{"type":"array","items":{"type":"object"}},"settings":{"type":"object"},"favoriteCarrierIds":{"type":"array","items":{"type":"string"}},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","name","isDataWallEnabled","users","favoriteCarrierIds","lastChangedBy","isActive","tags"]},"OrgCarrierSettings":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"org":{"$ref":"#/components/schemas/Org"},"orgId":{"type":"string"},"user":{"$ref":"#/components/schemas/User"},"userId":{"type":"string"},"favoriteWarehouseIds":{"type":"array","items":{"type":"string"}},"emailCCs":{"type":"array","items":{"type":"string"}},"favoriteWarehouses":{"type":"array","items":{"type":"object"}},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","lastChangedBy","isActive","tags"]},"UpdateUserDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"email":{"type":"string"},"firstName":{"type":"string","minLength":1,"maxLength":100},"lastName":{"type":"string","minLength":1,"maxLength":100},"phone":{"type":"string"},"role":{"type":"string","enum":["role_god","role_internal","role_owner","role_admin","role_operator","role_attendant","role_spectator","role_yard_driver","role_carrier_admin","role_carrier","role_base"]},"orgCarrierSettings":{"type":"array","items":{"$ref":"#/components/schemas/OrgCarrierSettings"}},"orgId":{"type":"string"},"warehouseAccessList":{"type":"UUID"},"extension":{"type":"string","minLength":1,"maxLength":6}}},"ChangePasswordDto":{"type":"object","properties":{"currentPassword":{"type":"string"},"newPassword":{"type":"string"},"newPasswordConfirm":{"type":"string"}},"required":["currentPassword","newPassword"]},"CreateCarrierDto":{"type":"object","properties":{"phone":{"type":"string"},"orgCarrierSettings":{"type":"object"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"firstName":{"type":"string","minLength":1,"maxLength":100},"lastName":{"type":"string","minLength":1,"maxLength":100},"email":{"type":"string"},"companyId":{"type":"string"}},"required":["firstName","lastName","email","companyId"]},"OrgCarrierSettingsDto":{"type":"object","properties":{"emailCCs":{"type":"array","items":{"type":"string"}},"orgId":{"type":"string"},"userId":{"type":"string"},"favoriteWarehouseIds":{"type":"array","items":{"type":"string"}}},"required":["emailCCs"]},"GetPreviewAsCarrierResponseDto":{"type":"object","properties":{"access_token":{"type":"string"}},"required":["access_token"]},"AddCarrierFavoriteWarehouseDto":{"type":"object","properties":{"warehouseId":{"type":"string"}},"required":["warehouseId"]},"RemoveCarrierFavoriteWarehouseDto":{"type":"object","properties":{"warehouseId":{"type":"string"}},"required":["warehouseId"]},"UpdateOrgDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"name":{"type":"string"},"settings":{"type":"object"},"favoriteCarrierIds":{"type":"array","items":{"type":"string"}}}},"CreateReportSearchDto":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":100},"createdAt":{"format":"date-time","type":"string"},"toDate":{"format":"date-time","type":"string"},"fromDate":{"format":"date-time","type":"string"},"dateField":{"type":"object"},"definedRange":{"type":"object"},"statuses":{"type":"array","items":{"type":"object"}},"exportFields":{"type":"string","enum":["CONFIRMATION_NUMBER","APPOINTMENT_ID","APPOINTMENT_DATE","APPOINTMENT_TIME","APPOINTMENT_TIMEZONE","APPOINTMENT_TYPE","SCHEDULED_DURATION","STATUS","ARRIVAL_DATE","ARRIVAL_TIME","DEPARTURE_DATE","DEPARTURE_TIME","DWELL_TIME","ON_TIME","IN_PROGRESS_DATE","IN_PROGRESS_TIME","WAIT_TIME","PROCESSING_TIME","WAREHOUSE","DOCK","LOAD_TYPE","LOAD_TYPE_DIRECTION","RESCHEDULE_COUNT","REFERENCE_NUMBER","HANDLING_UNITS","CREATED_BY","CREATOR_TYPE","CREATION_DATE","LAST_UPDATED_BY","LAST_UPDATE_DATE","LAST_UPDATE_TIME","CARRIER_COMPANY","CONTACT_NAME","CONTACT_EMAIL","CONTACT_PHONE","NOTES","TAGS","CUSTOM_FIELDS","EXTERNAL_VALIDATION_STATUS","EXTERNAL_VALIDATION_ERROR_MESSAGE","CheckOut","CheckInAdditionalAssetDetails","InboundClaim","OutboundClaim","BookLoadType","AssetContainerDetails","AppointmentCompleted"]},"warehouseIds":{"type":"array","items":{"type":"string"}},"dockIds":{"type":"array","items":{"type":"string"}},"loadTypeIds":{"type":"array","items":{"type":"string"}},"appointmentCreatorTypes":{"type":"array","items":{"type":"object"}},"carrierIds":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"appointmentTypes":{"type":"array","items":{"type":"object"}},"allCarriers":{"type":"boolean"}},"required":["title","toDate","fromDate","dateField","definedRange","exportFields"]},"UpdateReportSearchDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string"},"toDate":{"format":"date-time","type":"string"},"fromDate":{"format":"date-time","type":"string"},"dateField":{"type":"object"},"definedRange":{"type":"object"},"statuses":{"type":"array","items":{"type":"object"}},"exportFields":{"type":"string","enum":["CONFIRMATION_NUMBER","APPOINTMENT_ID","APPOINTMENT_DATE","APPOINTMENT_TIME","APPOINTMENT_TIMEZONE","APPOINTMENT_TYPE","SCHEDULED_DURATION","STATUS","ARRIVAL_DATE","ARRIVAL_TIME","DEPARTURE_DATE","DEPARTURE_TIME","DWELL_TIME","ON_TIME","IN_PROGRESS_DATE","IN_PROGRESS_TIME","WAIT_TIME","PROCESSING_TIME","WAREHOUSE","DOCK","LOAD_TYPE","LOAD_TYPE_DIRECTION","RESCHEDULE_COUNT","REFERENCE_NUMBER","HANDLING_UNITS","CREATED_BY","CREATOR_TYPE","CREATION_DATE","LAST_UPDATED_BY","LAST_UPDATE_DATE","LAST_UPDATE_TIME","CARRIER_COMPANY","CONTACT_NAME","CONTACT_EMAIL","CONTACT_PHONE","NOTES","TAGS","CUSTOM_FIELDS","EXTERNAL_VALIDATION_STATUS","EXTERNAL_VALIDATION_ERROR_MESSAGE","CheckOut","CheckInAdditionalAssetDetails","InboundClaim","OutboundClaim","BookLoadType","AssetContainerDetails","AppointmentCompleted"]},"warehouseIds":{"type":"array","items":{"type":"string"}},"dockIds":{"type":"array","items":{"type":"string"}},"loadTypeIds":{"type":"array","items":{"type":"string"}},"appointmentCreatorTypes":{"type":"array","items":{"type":"object"}},"carrierIds":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"appointmentTypes":{"type":"array","items":{"type":"object"}},"allCarriers":{"type":"boolean"}},"required":["toDate","fromDate","dateField","definedRange","exportFields"]},"ReportSearchFiltersDto":{"type":"object","properties":{"definedRange":{"type":"string","enum":["today","wtd","mtd","ytd"]},"dateField":{"type":"string","enum":["Appointment Date","Creation Date"]},"statuses":{"type":"array","items":{"type":"string","enum":["NoShow","Cancelled","Requested","Scheduled","Arrived","InProgress","Completed"]}},"exportFields":{"type":"array","items":{"type":"string","enum":["CONFIRMATION_NUMBER","APPOINTMENT_ID","APPOINTMENT_DATE","APPOINTMENT_TIME","APPOINTMENT_TIMEZONE","APPOINTMENT_TYPE","SCHEDULED_DURATION","STATUS","ARRIVAL_DATE","ARRIVAL_TIME","DEPARTURE_DATE","DEPARTURE_TIME","DWELL_TIME","ON_TIME","IN_PROGRESS_DATE","IN_PROGRESS_TIME","WAIT_TIME","PROCESSING_TIME","WAREHOUSE","DOCK","LOAD_TYPE","LOAD_TYPE_DIRECTION","RESCHEDULE_COUNT","REFERENCE_NUMBER","HANDLING_UNITS","CREATED_BY","CREATOR_TYPE","CREATION_DATE","LAST_UPDATED_BY","LAST_UPDATE_DATE","LAST_UPDATE_TIME","CARRIER_COMPANY","CONTACT_NAME","CONTACT_EMAIL","CONTACT_PHONE","NOTES","TAGS","CUSTOM_FIELDS","EXTERNAL_VALIDATION_STATUS","EXTERNAL_VALIDATION_ERROR_MESSAGE","CheckOut","CheckInAdditionalAssetDetails","InboundClaim","OutboundClaim","BookLoadType","AssetContainerDetails","AppointmentCompleted"]}},"dockIds":{"type":"array","items":{"type":"string"}},"loadTypeIds":{"type":"array","items":{"type":"string"}},"appointmentCreatorTypes":{"type":"array","items":{"type":"string","enum":["Warehouse User","Carrier"]}},"carrierIds":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"appointmentTypes":{"type":"array","items":{"type":"string","enum":["Standard","Reserve"]}},"toDate":{"format":"date-time","type":"string"},"fromDate":{"format":"date-time","type":"string"},"warehouseIds":{"type":"array","items":{"type":"string"}},"allCarriers":{"type":"boolean"}},"required":["definedRange","dateField","statuses","exportFields","toDate","fromDate","warehouseIds","allCarriers"]},"ReportSearchResponseDto":{"type":"object","properties":{"createdAt":{"format":"date-time","type":"string"},"title":{"type":"string"},"filters":{"$ref":"#/components/schemas/ReportSearchFiltersDto"}},"required":["createdAt","title","filters"]},"UpdateCustomTagsDto":{"type":"object","properties":{"customTags":{"type":"array","items":{"type":"object"}}}},"GetManyCompanyResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Company"}},"count":{"type":"number"},"total":{"type":"number"},"page":{"type":"number"},"pageCount":{"type":"number"}},"required":["data","count","total","page","pageCount"]},"Company":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"name":{"type":"string","minLength":1,"maxLength":100},"scac":{"type":"string","minLength":2,"maxLength":4},"mc":{"type":"string","minLength":3,"maxLength":12},"usdot":{"type":"string","minLength":2,"maxLength":8},"type":{"type":"object"},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","name","scac","mc","usdot","type","lastChangedBy","isActive","tags"]},"CreateCompanyDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"scac":{"type":"string"},"mc":{"type":"string"},"usdot":{"type":"string"},"type":{"type":"string","enum":["type_broker","type_carrier","type_carrier_broker","type_forwarder"]},"name":{"type":"string"}},"required":["name"]},"LoginDto":{"type":"object","properties":{"email":{"type":"string","example":"user@example.com","description":"User email address"},"password":{"type":"string","example":"P@ssw0rd!","description":"User password"}},"required":["email","password"]},"LoginResponseDto":{"type":"object","properties":{"access_token":{"type":"string","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...","description":"JWT access token"},"expires_in":{"type":"number","example":3600,"description":"Token expiration time in seconds"}},"required":["access_token","expires_in"]},"AuthProfileResponseDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"867cef72-a49d-42f1-a605-f49c5fbc7ae4"},"createDateTime":{"type":"string","format":"date-time","example":"2024-07-09T20:14:00.475Z"},"createdBy":{"type":"string","format":"uuid","example":"867cef72-a49d-42f1-a605-f49c5fbc7ae4"},"lastChangedDateTime":{"type":"string","format":"date-time","example":"2026-02-27T14:33:00.461Z"},"lastChangedBy":{"type":"string","format":"uuid","example":"867cef72-a49d-42f1-a605-f49c5fbc7ae4"},"isActive":{"type":"boolean","example":true},"tags":{"nullable":true,"example":null,"type":"array","items":{"type":"string"}},"email":{"type":"string","example":"user@example.com"},"firstName":{"type":"string","example":"Cave"},"lastName":{"type":"string","example":"Johnson"},"phone":{"type":"string","nullable":true,"example":null},"extension":{"type":"string","nullable":true,"example":null},"isEmailVerified":{"type":"boolean","example":true},"role":{"type":"string","enum":["role_god","role_internal","role_owner","role_admin","role_operator","role_attendant","role_spectator","role_yard_driver","role_carrier_admin","role_carrier","role_base"],"example":"role_owner"},"companyId":{"type":"string","nullable":true,"format":"uuid","example":null},"orgId":{"type":"string","nullable":true,"format":"uuid","example":"7e77fbe1-9517-44ce-b08b-5a18b478b79f"},"warehouseAccessList":{"nullable":true,"example":null,"type":"array","items":{"type":"string"}},"invalidLoginAttempts":{"type":"number","nullable":true,"example":null},"tcConfirmedAt":{"type":"string","nullable":true,"format":"date-time","example":"2024-07-09T20:14:20.814Z"},"lastLoginAt":{"type":"string","nullable":true,"format":"date-time","example":"2026-02-27T14:33:00.459Z"},"passwordResetRequired":{"type":"boolean","example":false},"passwordResetEmailSentAt":{"type":"string","nullable":true,"format":"date-time","example":null},"orgIsActive":{"type":"boolean","example":true},"orgName":{"type":"string","example":"My Organization"},"orgCreateDateTime":{"type":"string","format":"date-time","example":"2024-07-09T20:14:43.349Z"},"orgType":{"type":"string","example":"Client"}},"required":["id","createDateTime","createdBy","lastChangedDateTime","isActive","email","firstName","lastName","isEmailVerified","role"]},"CreateDockDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"doorNumber":{"type":"string","minLength":1,"maxLength":100},"instructions":{"type":"string"},"minCarrierLeadTime_hr":{"type":"number","minimum":1,"maximum":1000},"minCarrierLeadTimeForUpdates_hr":{"type":"number","minimum":0,"maximum":1000},"maxCarrierLeadTime_hr":{"type":"number","minimum":1,"maximum":8760},"ccEmails":{"type":"array","items":{"type":"string"}},"allowCarrierScheduling":{"type":"boolean"},"allowOverBooking":{"type":"boolean"},"sortOrder":{"type":"number"},"settings":{"type":"object"},"schedule":{"$ref":"#/components/schemas/ScheduleDto"},"name":{"type":"string"},"warehouseId":{"type":"string"},"loadTypeIds":{"type":"array","items":{"type":"string"}}},"required":["name","warehouseId","loadTypeIds"]},"GetManyDockResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Dock"}},"count":{"type":"number"},"total":{"type":"number"},"page":{"type":"number"},"pageCount":{"type":"number"}},"required":["data","count","total","page","pageCount"]},"Dock":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"schedule":{"$ref":"#/components/schemas/ScheduleDto"},"org":{"$ref":"#/components/schemas/Org"},"orgId":{"type":"string"},"loadTypeIds":{"example":["Inbound-Dry-FTL","Outbound-Refridge-LTL"],"type":"array","items":{"type":"string"}},"instructions":{"type":"string"},"minCarrierLeadTime_hr":{"type":"number","minimum":1,"maximum":1000},"minCarrierLeadTimeForUpdates_hr":{"type":"number","minimum":0,"maximum":1000},"maxCarrierLeadTime_hr":{"type":"number","minimum":1,"maximum":8760},"ccEmails":{"type":"array","items":{"type":"string"}},"allowCarrierScheduling":{"type":"boolean"},"allowOverBooking":{"type":"boolean"},"capacityParent":{"$ref":"#/components/schemas/Dock"},"capacityChildren":{"$ref":"#/components/schemas/Dock"},"capacityParentId":{"type":"string"},"sortOrder":{"type":"number"},"name":{"type":"string","minLength":1,"maxLength":100},"warehouse":{"type":"object"},"warehouseId":{"type":"string"},"appointments":{"type":"array","items":{"type":"object"}},"doorNumber":{"type":"string","minLength":1,"maxLength":100},"settings":{"type":"object"},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","schedule","loadTypeIds","name","warehouse","warehouseId","appointments","lastChangedBy","isActive","tags"]},"UpdateDockDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"doorNumber":{"type":"string","minLength":1,"maxLength":100},"instructions":{"type":"string"},"minCarrierLeadTime_hr":{"type":"number","minimum":1,"maximum":1000},"minCarrierLeadTimeForUpdates_hr":{"type":"number","minimum":0,"maximum":1000},"maxCarrierLeadTime_hr":{"type":"number","minimum":1,"maximum":8760},"ccEmails":{"type":"array","items":{"type":"string"}},"allowCarrierScheduling":{"type":"boolean"},"allowOverBooking":{"type":"boolean"},"sortOrder":{"type":"number"},"settings":{"type":"object"},"schedule":{"$ref":"#/components/schemas/ScheduleDto"},"name":{"type":"string"},"warehouseId":{"type":"string"},"loadTypeIds":{"type":"array","items":{"type":"string"}}}},"CrudOperationDto":{"type":"object","properties":{"action":{"type":"string","example":"read"},"entity":{"type":"string","example":"Appointment"},"data":{"type":"array","items":{"type":"string"}}},"required":["action","entity","data"]},"DockSortResponseDto":{"type":"object","properties":{"generatedMaps":{"type":"array","items":{"type":"object"}},"raw":{"type":"array","items":{"type":"object"}},"affected":{"type":"number","example":1}},"required":["generatedMaps","raw","affected"]},"DockSortDto":{"type":"object","properties":{"id":{"type":"string"},"sortOrder":{"type":"number"}},"required":["id","sortOrder"]},"DeleteDockDto":{"type":"object","properties":{"hardDelete":{"type":"boolean","default":false}}},"AvailabilityDto":{"type":"object","properties":{"start":{"format":"date-time","type":"string","example":"2026-04-03T20:21:50.216Z"},"end":{"format":"date-time","type":"string","example":"2026-04-03T20:21:50.216Z"},"excludeApptId":{"type":"string"}},"required":["start","end"]},"TimeIntervalDto":{"type":"object","properties":{"start":{"format":"date-time","type":"string","example":"2026-04-03T20:21:50.216Z"},"end":{"format":"date-time","type":"string","example":"2026-04-03T20:21:50.216Z"}},"required":["start","end"]},"AvailabilityResponseDto":{"type":"object","properties":{"dock":{"type":"object","properties":{"id":{"required":true,"type":"string"}}},"request":{"$ref":"#/components/schemas/AvailabilityDto"},"availability":{"type":"array","items":{"$ref":"#/components/schemas/TimeIntervalDto"}},"startTimes":{"type":"array","items":{"format":"date-time","type":"string"}}},"required":["dock","request","availability"]},"OpenDatesDto":{"type":"object","properties":{"start":{"format":"date-time","type":"string","example":"2026-04-03T20:21:50.216Z"},"end":{"format":"date-time","type":"string","example":"2026-04-03T20:21:50.216Z"},"dockIds":{"type":"array","items":{"type":"string"}}},"required":["start","end"]},"OpenDatesResponseDto":{"type":"object","properties":{"openDates":{"example":["2023-02-01","2023-02-02","2023-02-03"],"type":"array","items":{"type":"string"}}},"required":["openDates"]},"CreateLoadTypeDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"orgId":{"type":"string"},"warehouseId":{"type":"string"},"direction":{"type":"string","enum":["Inbound","Outbound","Inbound/Outbound"]},"operation":{"type":"string","enum":["Live","Drop","Other"]},"equipmentType":{"type":"string","enum":["Dry Van","Flatbed","Reefer","Other"]},"transportationMode":{"type":"string","enum":["FTL","PTL","Other"]},"allowCarrierScheduling":{"type":"boolean"},"description":{"type":"string","nullable":true},"settings":{"type":"object"},"schedule":{"$ref":"#/components/schemas/ScheduleDto"},"name":{"type":"string","minLength":1,"maxLength":100},"duration_min":{"type":"number","minimum":1,"maximum":1440}},"required":["direction","name","duration_min"]},"GetManyLoadTypeResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LoadType"}},"count":{"type":"number"},"total":{"type":"number"},"page":{"type":"number"},"pageCount":{"type":"number"}},"required":["data","count","total","page","pageCount"]},"LoadType":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"org":{"$ref":"#/components/schemas/LoadType"},"orgId":{"type":"string"},"direction":{"type":"string","enum":["Inbound","Outbound","Inbound/Outbound"]},"operation":{"type":"string","enum":["Live","Drop","Other"]},"equipmentType":{"type":"string","enum":["Dry Van","Flatbed","Reefer","Other"]},"transportationMode":{"type":"string","enum":["FTL","PTL","Other"]},"allowCarrierScheduling":{"type":"boolean"},"description":{"type":"string"},"settings":{"type":"object"},"schedule":{"$ref":"#/components/schemas/ScheduleDto"},"name":{"type":"string","minLength":1,"maxLength":100},"duration_min":{"type":"number","minimum":1,"maximum":1440},"warehouse":{"type":"object"},"warehouseId":{"type":"string"},"loadTypeGroups":{"type":"object"},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","name","duration_min","warehouse","warehouseId","loadTypeGroups","lastChangedBy","isActive","tags"]},"AvailabilityFromLoadTypeDto":{"type":"object","properties":{"start":{"format":"date-time","type":"string","example":"2026-04-03T20:21:50.216Z"},"end":{"format":"date-time","type":"string","example":"2026-04-03T20:21:50.216Z"},"excludeApptId":{"type":"string"},"warehouseId":{"type":"string"},"includeStartTimes":{"type":"object","default":false}},"required":["start","end","warehouseId","includeStartTimes"]},"UpdateLoadTypeDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"orgId":{"type":"string"},"warehouseId":{"type":"string"},"direction":{"type":"string","enum":["Inbound","Outbound","Inbound/Outbound"]},"operation":{"type":"string","enum":["Live","Drop","Other"]},"equipmentType":{"type":"string","enum":["Dry Van","Flatbed","Reefer","Other"]},"transportationMode":{"type":"string","enum":["FTL","PTL","Other"]},"allowCarrierScheduling":{"type":"boolean"},"description":{"type":"string","nullable":true},"settings":{"type":"object"},"schedule":{"$ref":"#/components/schemas/ScheduleDto"},"name":{"type":"string","minLength":1,"maxLength":100},"duration_min":{"type":"number","minimum":1,"maximum":1440}}},"AppointmentCountResponseDto":{"type":"object","properties":{"warehouseId":{"type":"string"},"warehouseName":{"type":"string"},"count":{"type":"number"}},"required":["warehouseId","warehouseName","count"]},"CreateLoadTypeGroupDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"name":{"type":"string","minLength":1,"maxLength":100},"warehouseId":{"type":"string"},"loadTypeIds":{"type":"array","items":{"type":"string"}}},"required":["name","warehouseId"]},"ResponseLoadTypeGroupDto":{"type":"object","properties":{"createDateTime":{"format":"date-time","type":"string"},"createdBy":{"type":"string","nullable":true},"lastChangedDateTime":{"format":"date-time","type":"string"},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["createDateTime","createdBy","lastChangedDateTime","lastChangedBy","isActive","tags"]},"UpdateLoadTypeGroupDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"name":{"type":"string","minLength":1,"maxLength":100},"warehouseId":{"type":"string"},"loadTypeIds":{"type":"array","items":{"type":"string"}}},"required":["warehouseId"]},"DeleteLoadTypeGroupDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}}}},"UnitLimitConfigurationWriteDTO":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"warehouseId":{"type":"string"},"name":{"type":"string"},"unitGrouperType":{"type":"object"},"unitGrouperId":{"type":"string"},"unitType":{"type":"object"},"mondayLimit":{"type":"object"},"tuesdayLimit":{"type":"object"},"wednesdayLimit":{"type":"object"},"thursdayLimit":{"type":"object"},"fridayLimit":{"type":"object"},"saturdayLimit":{"type":"object"},"sundayLimit":{"type":"object"},"dailyLimit":{"type":"object","default":null},"weeklyLimit":{"type":"object","default":null},"januaryLimit":{"type":"object"},"februaryLimit":{"type":"object"},"marchLimit":{"type":"object"},"aprilLimit":{"type":"object"},"mayLimit":{"type":"object"},"juneLimit":{"type":"object"},"julyLimit":{"type":"object"},"augustLimit":{"type":"object"},"septemberLimit":{"type":"object"},"octoberLimit":{"type":"object"},"novemberLimit":{"type":"object"},"decemberLimit":{"type":"object"},"monthlyLimit":{"type":"object","default":null}},"required":["warehouseId","unitGrouperType","unitGrouperId","unitType","mondayLimit","tuesdayLimit","wednesdayLimit","thursdayLimit","fridayLimit","saturdayLimit","sundayLimit","dailyLimit","weeklyLimit","januaryLimit","februaryLimit","marchLimit","aprilLimit","mayLimit","juneLimit","julyLimit","augustLimit","septemberLimit","octoberLimit","novemberLimit","decemberLimit","monthlyLimit"]},"UnitLimit":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"unitGrouperType":{"type":"object"},"unitGrouperId":{"type":"string"},"org":{"type":"object"},"orgId":{"type":"string"},"warehouse":{"type":"object"},"warehouseId":{"type":"string"},"name":{"type":"string"},"mondayLimit":{"type":"object","default":null},"tuesdayLimit":{"type":"object","default":null},"wednesdayLimit":{"type":"object","default":null},"thursdayLimit":{"type":"object","default":null},"fridayLimit":{"type":"object","default":null},"saturdayLimit":{"type":"object","default":null},"sundayLimit":{"type":"object","default":null},"januaryLimit":{"type":"object","default":null},"februaryLimit":{"type":"object","default":null},"marchLimit":{"type":"object","default":null},"aprilLimit":{"type":"object","default":null},"mayLimit":{"type":"object","default":null},"juneLimit":{"type":"object","default":null},"julyLimit":{"type":"object","default":null},"augustLimit":{"type":"object","default":null},"septemberLimit":{"type":"object","default":null},"octoberLimit":{"type":"object","default":null},"novemberLimit":{"type":"object","default":null},"decemberLimit":{"type":"object","default":null},"dailyLimit":{"type":"object","default":null},"weeklyLimit":{"type":"object","default":null},"monthlyLimit":{"type":"object","default":null},"unitType":{"type":"object"},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","unitGrouperType","unitGrouperId","org","orgId","warehouse","warehouseId","name","mondayLimit","tuesdayLimit","wednesdayLimit","thursdayLimit","fridayLimit","saturdayLimit","sundayLimit","januaryLimit","februaryLimit","marchLimit","aprilLimit","mayLimit","juneLimit","julyLimit","augustLimit","septemberLimit","octoberLimit","novemberLimit","decemberLimit","dailyLimit","weeklyLimit","monthlyLimit","unitType","lastChangedBy","isActive","tags"]},"UnitLimitCount":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"unitLimitId":{"type":"string"},"unitLimit":{"type":"object"},"countedDate":{"format":"date-time","type":"string"},"dailyLimitSnapshot":{"type":"number"},"unitCount":{"type":"number"},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","unitLimitId","unitLimit","countedDate","dailyLimitSnapshot","unitCount","lastChangedBy","isActive","tags"]},"UnitLimitValidateDTO":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"warehouseId":{"type":"string","description":"The warehouse of the unit limit configuration","example":"550e8400-e29b-41d4-a716-446655440000"},"dockId":{"type":"string","description":"The dock of the unit limit configuration","example":"550e8400-e29b-41d4-a716-446655440001"},"loadTypeId":{"type":"string","description":"The load type of the unit limit configuration","example":"550e8400-e29b-41d4-a716-446655440002"},"start":{"type":"string","description":"Start date of the unit limit validation period","example":"2025-11-01"},"end":{"type":"string","description":"End date of the unit limit validation period (must be within 5 days of start date)","example":"2025-11-04"},"requestedUnits":{"type":"number","description":"Number of units requested within the specified date range","example":10}},"required":["warehouseId","dockId","loadTypeId","start","end"]},"CreateFlowDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"name":{"type":"string"},"description":{"type":"string"},"formFromId":{"type":"string"},"warehouseId":{"type":"string"}},"required":["name","formFromId","warehouseId"]},"GetManyFlowResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Flow"}},"count":{"type":"number"},"total":{"type":"number"},"page":{"type":"number"},"pageCount":{"type":"number"}},"required":["data","count","total","page","pageCount"]},"TriggerOperatorsEnum":{"type":"string","description":"The operator that will be used to compare the value of the field to determine whether to show the second form \"FormTo\" or not","enum":[">","<",">=","<=","=","<>"]},"Flow":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"parentCode":{"type":"string","description":"The parent code of the flow, used to group flows together, generated by the API","example":"acfb1234-5678-90ab-cdef-1234567890ab"},"entityTags":{"description":"The tags that will be applied to the corresponding entity that triggered this flow, added to the tags field for the entity stated at dataEntityName field of the trigger table","example":["tag1","tag2"],"type":"array","items":{"type":"string"}},"tagFromFormFieldId":{"type":"string","description":"When set, the value of the submitted form field will be added as a tag, same as the entityTags field, but this will be the value of the field, not the tag itself","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5"},"formFromId":{"type":"string","description":"The ID of the first form of this flow, used to load the form","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5"},"formToId":{"type":"string","description":"The ID of the second form of this flow, used to load the form sequence, it is optional","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5"},"conditionOperator":{"$ref":"#/components/schemas/TriggerOperatorsEnum"},"conditionValue":{"type":"string","description":"The value that will be used to compare the value of the field to determine whether to show the second form \"FormTo\" or not","example":"value"},"conditionFormFieldId":{"type":"string","description":"The field that will be used to compare the value of the field to determine whether to show the second form \"FormTo\" or not","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5"},"name":{"type":"string"},"description":{"type":"string"},"tagFromFormField":{"type":"object"},"formFrom":{"type":"object"},"formTo":{"type":"object"},"conditionFormField":{"type":"object"},"triggers":{"type":"array","items":{"type":"object"}},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","formFromId","name","formFrom","triggers","lastChangedBy","isActive","tags"]},"UpdateFlowDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"name":{"type":"string"},"description":{"type":"string"},"formFromId":{"type":"string"}}},"CreateFormDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"name":{"type":"string"},"description":{"type":"string"},"warehouseId":{"type":"string"}},"required":["name","warehouseId"]},"GetManyFormResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Form"}},"count":{"type":"number"},"total":{"type":"number"},"page":{"type":"number"},"pageCount":{"type":"number"}},"required":["data","count","total","page","pageCount"]},"Form":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"name":{"type":"string","description":"The name of the form","example":"Customer Feedback Form"},"description":{"type":"string","description":"Extra description for the form","example":"This form is used to collect customer feedback"},"formFields":{"type":"array","items":{"type":"object"}},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","name","formFields","lastChangedBy","isActive","tags"]},"UpdateFormDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"name":{"type":"string"},"description":{"type":"string"}}},"SortFormFieldDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"formFieldIds":{"type":"array","items":{"type":"string"}}},"required":["formFieldIds"]},"CustomFieldType":{"type":"string","description":"The type of the field used at the moment of the data submission, used to render the field in the UI and validate the data on the API level","enum":["str","bigstr","date","bool","doc","multidoc","int","email","phone","dropdown","dropdownmultiselect","combobox","timestamp","action"]},"FieldExtraFields":{"type":"object","properties":{}},"CreateFieldDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"label":{"type":"string"},"type":{"$ref":"#/components/schemas/CustomFieldType"},"description":{"type":"string"},"placeholder":{"type":"string"},"extraFields":{"example":{"dropDownValues":["Option 1","Option 2","Option 3"],"minLengthOrValue":1,"maxLengthOrValue":10},"allOf":[{"$ref":"#/components/schemas/FieldExtraFields"}]},"formId":{"type":"string"}},"required":["label","type"]},"GetManyFieldResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Field"}},"count":{"type":"number"},"total":{"type":"number"},"page":{"type":"number"},"pageCount":{"type":"number"}},"required":["data","count","total","page","pageCount"]},"Field":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"label":{"type":"string","description":"The label of the field, it can be overriden when instantiated by a FormField entity","example":"First Name"},"description":{"type":"string","description":"The helper text for the particular field","example":"Enter your first name"},"placeholder":{"type":"string","description":"The placeholder for the particular field","example":"John Doe"},"type":{"$ref":"#/components/schemas/CustomFieldType"},"extraFields":{"description":"Extra fields for the field, used to render the field in the UI, such as Dropdown options and number validation rules","example":{"dropDownValues":["Option 1","Option 2","Option 3"],"minLengthOrValue":1,"maxLengthOrValue":10},"allOf":[{"$ref":"#/components/schemas/FieldExtraFields"}]},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","label","type","lastChangedBy","isActive","tags"]},"UpdateFieldDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"label":{"type":"string"},"type":{"$ref":"#/components/schemas/CustomFieldType"},"description":{"type":"string"},"placeholder":{"type":"string"},"extraFields":{"example":{"dropdownOptions":["Option 1","Option 2"],"maxLengthOrValue":100,"minLengthOrValue":1},"allOf":[{"$ref":"#/components/schemas/FieldExtraFields"}]},"formId":{"type":"string"}}},"CreateFormFieldDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"order":{"type":"number","description":"The order of the field in the form","example":1},"formId":{"type":"string"},"fieldId":{"type":"string"},"required":{"type":"boolean"},"overrideLabel":{"type":"string","description":"The label of the field for this form instance, overrides the field label","example":"Last Name"}},"required":["order","formId","fieldId"]},"GetManyFormFieldResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FormField"}},"count":{"type":"number"},"total":{"type":"number"},"page":{"type":"number"},"pageCount":{"type":"number"}},"required":["data","count","total","page","pageCount"]},"FormField":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"order":{"type":"number","description":"The order of the field in the form, must be unique per form","example":1},"required":{"type":"boolean","description":"Whether the field is required or not","example":true},"overrideLabel":{"type":"string","description":"The label of the field for this form instance, overrides the field label","example":"Last Name"},"formId":{"type":"string","description":"The ID of the form that this field belongs to","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5"},"fieldId":{"type":"string","description":"The ID of the field that this form field is based on","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5"},"form":{"type":"object"},"field":{"type":"object"},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","order","formId","fieldId","form","field","lastChangedBy","isActive","tags"]},"UpdateFormFieldDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"order":{"type":"integer"},"fieldId":{"type":"string"},"overrideLabel":{"type":"string"},"required":{"type":"boolean"}}},"AppsEnum":{"type":"string","description":"The app that this trigger will be activated, based on the source of the request","enum":["api","warehouse","carrier","driver","all"]},"CustomFormFlowCategoryEnum":{"type":"string","description":"The event category that this trigger will be activated on","enum":["appointmentStatusCompleted","appointmentStatusArrived","appointmentCreated","assetVisitCreated","manualTrigger"]},"CustomFormsFeatures":{"type":"string","description":"The feature that this trigger is related, used to group triggers by feature","enum":["check-out","check-in","check-in additional asset details","asset container details","Inbound Claim","Outbound Claim","Book Load Type","appointment-completed"]},"CustomFormFlowEntitiesEnum":{"type":"string","description":"The entity name that qualifies the objectId this trigger will be activated","enum":["loadtype","dock","warehouse"]},"CreateTriggerDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"app":{"$ref":"#/components/schemas/AppsEnum"},"category":{"$ref":"#/components/schemas/CustomFormFlowCategoryEnum"},"flowId":{"type":"object","description":"The ID of the Flow that will be loaded when this trigger is executed","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5"},"objectId":{"type":"string","description":"The ID of the object that this trigger belongs to, the type is dependent on the entityName","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5"},"feature":{"$ref":"#/components/schemas/CustomFormsFeatures"},"entityName":{"$ref":"#/components/schemas/CustomFormFlowEntitiesEnum"},"orgId":{"type":"string"}},"required":["app","category","objectId","entityName"]},"GetManyTriggerResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Trigger"}},"count":{"type":"number"},"total":{"type":"number"},"page":{"type":"number"},"pageCount":{"type":"number"}},"required":["data","count","total","page","pageCount"]},"CustomFormDataEntitiesEnum":{"type":"string","description":"The entity name of the object that this data belongs to","enum":["appointment","assetvisit","assetcontainer"]},"Trigger":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"app":{"$ref":"#/components/schemas/AppsEnum"},"category":{"$ref":"#/components/schemas/CustomFormFlowCategoryEnum"},"feature":{"$ref":"#/components/schemas/CustomFormsFeatures"},"flowId":{"type":"object","description":"The ID of the flow that this trigger will load, Flow has one or two Forms","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5"},"objectId":{"type":"string","description":"The ID of the object that this trigger will be activated on events","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5"},"entityName":{"$ref":"#/components/schemas/CustomFormFlowEntitiesEnum"},"dataEntityName":{"$ref":"#/components/schemas/CustomFormDataEntitiesEnum"},"flow":{"type":"object"},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","app","category","objectId","entityName","dataEntityName","lastChangedBy","isActive","tags"]},"UpdateTriggerDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"app":{"$ref":"#/components/schemas/AppsEnum"},"category":{"$ref":"#/components/schemas/CustomFormFlowCategoryEnum"},"flowId":{"type":"object"},"objectId":{"type":"string"},"entityName":{"$ref":"#/components/schemas/CustomFormFlowEntitiesEnum"},"updateRelatedTriggers":{"type":"boolean","default":false,"description":"If true, it will update the related triggers of the flow, with the same flow.parentCode"}}},"CreateCustomFormDataDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"objectId":{"type":"string","description":"The ID of the object that this data belongs to, the type is dependent on the entityName","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5"},"entityName":{"$ref":"#/components/schemas/CustomFormDataEntitiesEnum"},"value":{"type":"object","description":"The value of the field, stored as string, but it gets validated as the field type by the API","example":"John Doe"},"formFieldId":{"type":"string","description":"The ID of the form field that this data refers to","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5"},"triggerId":{"type":"string","description":"The ID of the trigger that this data refers to","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5"}},"required":["objectId","entityName","value","formFieldId","triggerId"]},"CreateManyCustomFormDataDto":{"type":"object","properties":{"bulk":{"type":"array","items":{"$ref":"#/components/schemas/CustomFormData"}}},"required":["bulk"]},"GetManyCustomFormDataResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomFormData"}},"count":{"type":"number"},"total":{"type":"number"},"page":{"type":"number"},"pageCount":{"type":"number"}},"required":["data","count","total","page","pageCount"]},"CustomFormData":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"objectId":{"type":"string","description":"The ID of the object that this data belongs to, the type is dependent on the entityName","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5"},"entityName":{"$ref":"#/components/schemas/CustomFormDataEntitiesEnum"},"label":{"type":"string","description":"The label of the field used at the moment of the data submission","example":"First Name"},"value":{"type":"object","description":"The value of this field, entered by the user, store as string, but validated as the Field type","example":"John Doe"},"type":{"$ref":"#/components/schemas/CustomFieldType"},"formFieldId":{"type":"object","description":"The ID of the FormField that this data refers to","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5"},"triggerId":{"type":"object","description":"The ID of the Trigger that this data refers to","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5"},"warehouseId":{"type":"object","description":"The ID of the Warehouse that this data refers to","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5"},"formField":{"type":"object"},"trigger":{"type":"object"},"warehouse":{"type":"object"},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","objectId","entityName","label","value","type","formFieldId","triggerId","warehouseId","formField","trigger","warehouse","lastChangedBy","isActive","tags"]},"UpdateCustomFormDataDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"value":{"type":"string"}}},"CreateSingleCustomFormDataDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"objectId":{"type":"string","description":"The ID of the object that this data belongs to, the type is dependent on the entityName","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5"},"entityName":{"$ref":"#/components/schemas/CustomFormDataEntitiesEnum"},"value":{"type":"object","description":"The value of the field, stored as string, but it gets validated as the field type by the API","example":"John Doe"},"formFieldId":{"type":"string","description":"The ID of the form field that this data refers to","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5"},"triggerId":{"type":"string","description":"The ID of the trigger that this data refers to","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5"}},"required":["objectId","entityName","value","formFieldId","triggerId"]},"GetManyWarehouseGroupResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WarehouseGroup"}},"count":{"type":"number"},"total":{"type":"number"},"page":{"type":"number"},"pageCount":{"type":"number"}},"required":["data","count","total","page","pageCount"]},"WarehouseGroup":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"name":{"type":"string"},"warehouses":{"type":"array","items":{"type":"object"}},"orgId":{"type":"string"},"org":{"type":"object"},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","name","orgId","org","lastChangedBy","isActive","tags"]},"CreateWarehouseGroupDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"name":{"type":"string","minLength":1,"maxLength":100},"warehouseIds":{"type":"array","items":{"type":"string"}}},"required":["name"]},"UpdateWarehouseGroupDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"name":{"type":"string","minLength":1,"maxLength":100},"warehouseIds":{"type":"array","items":{"type":"string"}}}},"StatusTimelineDto":{"type":"object","properties":{"NoShow":{"type":"string","nullable":true,"format":"date-time","example":null},"Arrived":{"type":"string","nullable":true,"format":"date-time","example":null},"Cancelled":{"type":"string","nullable":true,"format":"date-time","example":null},"Completed":{"type":"string","nullable":true,"format":"date-time","example":null},"Requested":{"type":"string","nullable":true,"format":"date-time","example":"2026-03-18T18:14:00.000Z"},"Scheduled":{"type":"string","nullable":true,"format":"date-time","example":null},"InProgress":{"type":"string","nullable":true,"format":"date-time","example":null}}},"CustomFieldDto":{"type":"object","properties":{"name":{"type":"string","example":"emailDispatcher"},"type":{"type":"string","example":"email"},"label":{"type":"string","example":"Dispatcher"},"description":{"type":"string","example":"Dispatcher's email address"},"placeholder":{"type":"string","example":"xpto@example.com"},"dropDownValues":{"example":[],"type":"array","items":{"type":"string"}},"hiddenFromCarrier":{"type":"boolean","example":false},"requiredForCarrier":{"type":"boolean","example":false},"requiredForWarehouse":{"type":"boolean","example":false},"value":{"type":"object","description":"Field value — type depends on the custom field type"}},"required":["name","type","label"]},"AppointmentMetadataDto":{"type":"object","properties":{"unitLimitBreached":{"type":"boolean","example":false},"externalValidationFailed":{"type":"boolean","example":false},"externalValidationErrorMessage":{"type":"string","nullable":true,"example":null},"unitLimitOverrideReason":{"type":"string","nullable":true,"example":null},"clonedFromId":{"type":"string","nullable":true,"format":"uuid","example":null}}},"AppointmentListItemDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"25523508-e358-4161-8907-5bfba673ce94"},"createDateTime":{"type":"string","format":"date-time","example":"2026-03-18T18:14:51.766Z"},"createdBy":{"type":"string","format":"uuid","example":"c798fcb0-e072-46af-92cf-dec899b68973"},"lastChangedDateTime":{"type":"string","format":"date-time","example":"2026-03-18T18:14:59.545Z"},"lastChangedBy":{"type":"string","format":"uuid","example":"c798fcb0-e072-46af-92cf-dec899b68973"},"isActive":{"type":"boolean","example":true},"tags":{"nullable":true,"example":[],"type":"array","items":{"type":"string"}},"type":{"type":"string","enum":["Standard","Reserve"],"example":"Standard"},"status":{"type":"string","enum":["NoShow","Cancelled","Requested","Scheduled","Arrived","InProgress","Completed"],"example":"Requested"},"statusTimeline":{"$ref":"#/components/schemas/StatusTimelineDto"},"userId":{"type":"string","nullable":true,"format":"uuid","example":"c798fcb0-e072-46af-92cf-dec899b68973"},"loadTypeId":{"type":"string","format":"uuid","example":"e4fbeabd-a501-4f3b-bc11-7f034110e925"},"dockId":{"type":"string","format":"uuid","example":"c9fbc7d2-f9c3-483c-84b4-1215682af6a3"},"orgId":{"type":"string","format":"uuid","example":"7e77fbe1-9517-44ce-b08b-5a18b478b79f"},"start":{"type":"string","format":"date-time","example":"2026-03-19T18:30:00.000Z"},"end":{"type":"string","format":"date-time","example":"2026-03-19T19:30:00.000Z"},"eta":{"type":"string","nullable":true,"format":"date-time","example":null},"refNumber":{"type":"string","example":"APT-41313"},"refNumbers":{"example":["APT-41313"],"type":"array","items":{"type":"string"}},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldDto"}},"notes":{"type":"string","nullable":true,"example":""},"ccEmails":{"example":[],"type":"array","items":{"type":"string"}},"recurringParentId":{"type":"string","nullable":true,"format":"uuid","example":null},"recurringPattern":{"type":"object","nullable":true,"example":null},"reschedules":{"nullable":true,"example":null,"type":"array","items":{"type":"object"}},"confirmationNumber":{"type":"string","example":"137510"},"muteNotifications":{"type":"boolean","example":false},"isCheckedInByCarrier":{"type":"boolean","example":false},"metadata":{"$ref":"#/components/schemas/AppointmentMetadataDto"},"units":{"type":"number","nullable":true,"example":12},"searchableCustomFields":{"type":"string","nullable":true,"example":null},"recurringParent":{"type":"object","nullable":true,"example":null},"recurringChildren":{"nullable":true,"description":"Child appointments in a recurring series (only present when relation is loaded)","type":"array","items":{"type":"object"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","isActive","type","status","loadTypeId","dockId","orgId","start","end","confirmationNumber","muteNotifications","isCheckedInByCarrier"]},"CreateAppointmentDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"status":{"type":"string","enum":["NoShow","Cancelled","Requested","Scheduled","Arrived","InProgress","Completed"]},"userId":{"type":"object"},"loadTypeId":{"type":"string"},"dockId":{"type":"string"},"start":{"format":"date-time","type":"string"},"end":{"format":"date-time","type":"string"},"refNumbers":{"type":"array","items":{"type":"string"}},"refNumber":{"type":"string"},"customFields":{"type":"array","items":{"type":"object"}},"notes":{"type":"string"},"ccEmails":{"type":"array","items":{"type":"string"}},"muteNotifications":{"type":"boolean"},"metadata":{"type":"object"},"units":{"type":"object","minimum":0}},"required":["loadTypeId","dockId","start"]},"DeleteAppointmentDto":{"type":"object","properties":{"hardDelete":{"type":"boolean","default":false}}},"UpdateAppointmentDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"status":{"type":"string","enum":["NoShow","Cancelled","Requested","Scheduled","Arrived","InProgress","Completed"]},"userId":{"type":"object"},"loadTypeId":{"type":"string"},"dockId":{"type":"string"},"start":{"format":"date-time","type":"string"},"end":{"format":"date-time","type":"string"},"refNumbers":{"type":"array","items":{"type":"string"}},"refNumber":{"type":"string"},"customFields":{"type":"array","items":{"type":"object"}},"notes":{"type":"string"},"ccEmails":{"type":"array","items":{"type":"string"}},"muteNotifications":{"type":"boolean"},"metadata":{"type":"object"},"units":{"type":"object","minimum":0},"type":{"type":"string","enum":["Standard","Reserve"]},"statusTimeline":{"type":"object"},"isCheckedInByCarrier":{"type":"boolean"}}},"EtaDto":{"type":"object","properties":{"eta":{"format":"date-time","type":"string","example":"2026-03-19T18:30:00.000Z","description":"Estimated time of arrival"},"reason":{"type":"string","maxLength":255,"example":"on time","description":"Reason for the ETA update (required for carriers)"}},"required":["eta"]},"CreateReserveDto":{"type":"object","properties":{"dockId":{"type":"string","format":"uuid","example":"c9fbc7d2-f9c3-483c-84b4-1215682af6a3"},"start":{"format":"date-time","type":"string","example":"2026-03-23T05:00:00.000Z"},"notes":{"type":"string","example":"Reserved"},"duration_min":{"type":"number","default":30,"minimum":1,"maximum":1440,"example":30,"description":"Duration in minutes (default: 30)"}},"required":["dockId","start"]},"RecurringAppointmentCreateSuccess":{"type":"object","properties":{"appointmentId":{"type":"string","format":"uuid","example":"3ca0e68f-8fc4-4e5d-b08a-b5ffefe2ebce"},"start":{"format":"date-time","type":"string","example":"2026-03-30T05:30:00.000Z"}},"required":["appointmentId","start"]},"RecurringAppointmentCreateFailure":{"type":"object","properties":{"start":{"format":"date-time","type":"string","example":"2026-04-20T05:30:00.000Z"},"reason":{"type":"string","example":"Appointment does not fit into combined Dock and Warehouse availability"}},"required":["start","reason"]},"RecurringAppointmentCreateResponse":{"type":"object","properties":{"successes":{"type":"array","items":{"$ref":"#/components/schemas/RecurringAppointmentCreateSuccess"}},"failures":{"type":"array","items":{"$ref":"#/components/schemas/RecurringAppointmentCreateFailure"}}},"required":["successes","failures"]},"CreateRecurringAppointmentsDto":{"type":"object","properties":{"numWeeks":{"type":"number","maximum":105,"minimum":1,"example":3,"description":"Number of weeks to repeat pattern"},"weekDays":{"type":"array","example":["Monday"],"items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}},"copyFields":{"type":"array","example":["customFields"],"description":"Copy appointment fields to the series. Copying refNumber will not work if unique ref number setting is on","items":{"type":"string","enum":["refNumber","customFields","notes","tags"]}},"startingStatus":{"type":"string","default":"Scheduled","enum":["Scheduled","Requested"],"example":"Requested","description":"Starting status for recurring children. Defaults to Scheduled"}},"required":["numWeeks","weekDays"]},"AppointmentNotificationEmailHtmlResponseDto":{"type":"object","properties":{"bodyHtml":{"type":"string","example":"<html lang=\"en-US\"><body>Html Block Example</body></html>"},"subject":{"type":"string","example":"Appointment details have changed"}},"required":["bodyHtml","subject"]},"AddAppointmentTagDto":{"type":"object","properties":{"tag":{"type":"string","example":"Damaged"}},"required":["tag"]},"AssetVisitType":{"type":"string","description":"The type of the asset visit","enum":["LiveUnload","LiveLoad","Live","Drop","PickUp","DropHook","Unknown"]},"AssetContainerDetailsDto":{"type":"object","properties":{"containerCode":{"type":"string"},"containerType":{"type":"object"}},"required":["containerType"]},"CreateAssetVisitDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"warehouseId":{"type":"string","format":"uuid"},"appointmentId":{"type":"string","format":"uuid"},"licensePlate":{"type":"object"},"dotNumber":{"type":"object"},"companyId":{"type":"string","format":"uuid"},"phone":{"type":"string","description":"Driver Phone number in E.164 format"},"useWhatsApp":{"type":"boolean","description":"Whether to communicate via WhatsApp"},"isPlanned":{"type":"boolean"},"companyHint":{"type":"string","description":"Company name"},"visitType":{"$ref":"#/components/schemas/AssetVisitType"},"driverNotes":{"type":"string","description":"Driver notes for check-in"},"driverAppointmentIdentifier":{"type":"string","description":"Appointment identifier entered by the driver for check-in"},"hasArrived":{"type":"boolean"},"assetContainerDetails":{"type":"array","items":{"$ref":"#/components/schemas/AssetContainerDetailsDto"}}},"required":["warehouseId"]},"GetManyAssetVisitResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AssetVisit"}},"count":{"type":"number"},"total":{"type":"number"},"page":{"type":"number"},"pageCount":{"type":"number"}},"required":["data","count","total","page","pageCount"]},"AssetVisit":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"orgId":{"type":"string","format":"uuid"},"warehouseId":{"type":"string","format":"uuid","description":"The id of the warehouse","example":"a0e4b1c2-3d4e-5f6g-7h8i-9j0k1l2m3n4o"},"appointmentId":{"type":"string","format":"uuid","description":"The id of the appointment","example":"a0e4b1c2-3d4e-5f6g-7h8i-9j0k1l2m3n4o"},"secondaryAppointmentId":{"type":"string","format":"uuid","description":"The id of the secondary appointment","example":"b1e4b1c2-3d4e-5f6g-7h8i-9j0k1l2m3n4p"},"companyId":{"type":"string","format":"uuid","description":"The id of the company","example":"a0e4b1c2-3d4e-5f6g-7h8i-9j0k1l2m3n4o"},"phone":{"type":"string","description":"The phone number of the driver","example":"+14155552671"},"isPlanned":{"type":"boolean","description":"Indicates if the visit has an appointment or not","example":false},"companyHint":{"type":"string","description":"A free-text to indicate the company name when there is no appointment","example":"Super Company CO."},"driverNotes":{"type":"string","description":"Notes typed by the driver when checking in","example":"My truck is broken, please help me"},"driverAppointmentIdentifier":{"type":"string","description":"Appointment identification typed by the driver when checking in","example":"PO48593"},"visitType":{"example":"Live","$ref":"#/components/schemas/AssetVisitType"},"checkInAcknowledged":{"type":"boolean","description":"Whether the check-in was acknowledged by the warehouse or not","example":false},"org":{"type":"object"},"warehouse":{"type":"object"},"appointment":{"type":"object","nullable":true},"secondaryAppointment":{"type":"object","nullable":true},"licensePlate":{"type":"object"},"dotNumber":{"type":"object"},"company":{"type":"object"},"messageThread":{"type":"object"},"assetVisitEvents":{"type":"array","items":{"type":"object"}},"spotAssignments":{"type":"array","items":{"type":"object"}},"assetContainers":{"type":"array","items":{"type":"object"}},"vehicleObservations":{"type":"array","items":{"type":"object"}},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","orgId","warehouseId","isPlanned","org","warehouse","assetVisitEvents","lastChangedBy","isActive","tags"]},"UpdateAssetVisitDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"appointmentId":{"type":"string","format":"uuid"},"companyId":{"type":"object","format":"uuid"},"licensePlate":{"type":"string"},"dotNumber":{"type":"string"},"companyHint":{"type":"string","maxLength":128,"description":"Free-text carrier name when no companyId is selected"},"visitType":{"$ref":"#/components/schemas/AssetVisitType"},"phone":{"type":"string"},"isPlanned":{"type":"boolean"}}},"CreateAssetVisitEventDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"eventType":{"type":"object"},"assetVisitId":{"type":"string"},"assetContainerId":{"type":"string"},"spotId":{"type":"string"}},"required":["eventType","assetVisitId"]},"GetManyAssetContainerResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AssetContainer"}},"count":{"type":"number"},"total":{"type":"number"},"page":{"type":"number"},"pageCount":{"type":"number"}},"required":["data","count","total","page","pageCount"]},"AssetContainerType":{"type":"string","description":"The type of the asset container","enum":["Trailer","Container","Oversized","Chassis","Reefer","Other"]},"AssetContainerState":{"type":"string","description":"The state of the asset container","enum":["Full","Empty","Partially Loaded"]},"AssetContainer":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"type":{"$ref":"#/components/schemas/AssetContainerType"},"state":{"$ref":"#/components/schemas/AssetContainerState"},"code":{"type":"string","description":"The code of the asset container","example":"AC001"},"notes":{"type":"string","description":"Extra data about the asset container","example":"Asset container for storing goods"},"assetVisitId":{"type":"string","format":"uuid","description":"The id of the asset visit","example":"a0e4b1c2-3d4e-5f6g-7h8i-9j0k1l2m3n4o"},"orgId":{"type":"string","format":"uuid"},"warehouseId":{"type":"string","format":"uuid","description":"The id of the warehouse","example":"a0e4b1c2-3d4e-5f6g-7h8i-9j0k1l2m3n4o"},"pickupAppointmentId":{"type":"string","format":"uuid","description":"The id of the pickup appointment","example":"a0e4b1c2-3d4e-5f6g-7h8i-9j0k1l2m3n4o"},"dropAppointmentId":{"type":"string","format":"uuid","description":"The id of the drop appointment","example":"a0e4b1c2-3d4e-5f6g-7h8i-9j0k1l2m3n4o"},"companyId":{"type":"string","format":"uuid","description":"The id of the company that owns the asset container","example":"a0e4b1c2-3d4e-5f6g-7h8i-9j0k1l2m3n4o"},"assetVisit":{"type":"object"},"org":{"type":"object"},"warehouse":{"type":"object"},"pickupAppointment":{"type":"object"},"dropAppointment":{"type":"object"},"company":{"type":"object"},"assetVisitEvents":{"type":"array","items":{"type":"object"}},"assetContainerEvents":{"type":"array","items":{"type":"object"}},"spotAssignments":{"type":"array","items":{"type":"object"}},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","type","code","orgId","warehouseId","org","warehouse","lastChangedBy","isActive","tags"]},"UpdateAssetVisitAcknowledgmentDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"checkInAcknowledged":{"type":"boolean"}},"required":["checkInAcknowledged"]},"LinkUnplannedCheckinToAppointmentDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"appointmentId":{"type":"string"},"assetVisitId":{"type":"string"},"companyId":{"type":"string","deprecated":true,"description":"Deprecated: company is resolved from the appointment user on the server. Optional for legacy clients only."},"isPlanned":{"type":"boolean"}},"required":["appointmentId","assetVisitId"]},"UnlinkAssetFromAppointmentDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"appointmentId":{"type":"string"},"assetVisitId":{"type":"string"}},"required":["appointmentId","assetVisitId"]},"CreateAssetContainerDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"assetVisitId":{"type":"string","format":"uuid"},"code":{"type":"string","minLength":1,"maxLength":100},"notes":{"type":"string","maxLength":1024},"type":{"$ref":"#/components/schemas/AssetContainerType"},"warehouseId":{"type":"string","format":"uuid"},"dropAppointmentId":{"type":"string","format":"uuid"},"pickupAppointmentId":{"type":"string","format":"uuid"},"state":{"$ref":"#/components/schemas/AssetContainerState"},"companyId":{"type":"string","format":"uuid"}},"required":["code","type","warehouseId"]},"UpdateAssetContainerDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"assetVisitId":{"type":"string","format":"uuid"},"code":{"type":"string","minLength":1,"maxLength":100},"notes":{"type":"string","maxLength":1024},"type":{"$ref":"#/components/schemas/AssetContainerType"},"dropAppointmentId":{"type":"string","format":"uuid"},"pickupAppointmentId":{"type":"string","format":"uuid"},"state":{"$ref":"#/components/schemas/AssetContainerState"},"companyId":{"type":"string","format":"uuid"}}},"AssetContainerEventType":{"type":"string","description":"The type of the event","enum":["Arrived","Loading","Loading Complete","Unloading","Unloading Complete","Ready for Pickup","Departed","Inoperable"]},"AssetContainerEvent":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"orgId":{"type":"string","format":"uuid"},"createDateTime":{"type":"string","description":"The date and time when the event was created","format":"date-time"},"createdBy":{"type":"string","nullable":true,"format":"uuid","description":"The id of the user who created the event"},"assetContainerId":{"type":"string","format":"uuid","description":"The id of the asset container"},"assetVisitId":{"type":"object","format":"uuid","description":"The id of the asset visit attached (truck)"},"eventType":{"$ref":"#/components/schemas/AssetContainerEventType"},"org":{"type":"object"},"assetContainer":{"type":"object"},"assetVisit":{"type":"object"}},"required":["id","orgId","createDateTime","assetContainerId","eventType","org","assetContainer"]},"CreateAssetContainerEventDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"eventType":{"type":"string","enum":["Arrived","Loading","Loading Complete","Unloading","Unloading Complete","Ready for Pickup","Departed","Inoperable"]},"assetContainerId":{"type":"string","format":"uuid","description":"The id of the asset container"},"assetVisitId":{"type":"string","format":"uuid","description":"The id of the asset visit which this entity is attached to"}},"required":["eventType","assetContainerId"]},"DocumentListDto":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object"}},"meta":{"type":"object"}},"required":["items","meta"]},"StorageDto":{"type":"object","properties":{"url":{"type":"string","example":"https://opendock-neutron-staging.s3.amazonaws.com/storage/328a170a-6dc6-4e79-afeb-c2b5e436eee4/d285b6b549/file.pdf"},"key":{"type":"string","example":"storage/328a170a-6dc6-4e79-afeb-c2b5e436eee4/d285b6b549/file.pdf"}},"required":["url","key"]},"GetManySpotAssignmentResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SpotAssignment"}},"count":{"type":"number"},"total":{"type":"number"},"page":{"type":"number"},"pageCount":{"type":"number"}},"required":["data","count","total","page","pageCount"]},"SpotAssignment":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"spotId":{"type":"string","format":"uuid","description":"The id of the spot","example":"a0e4b1c2-3d4e-5f6g-7h8i-9j0k1l2m3n4o"},"assetVisitId":{"type":"object","format":"uuid","description":"The id of the asset visit","example":"a0e4b1c2-3d4e-5f6g-7h8i-9j0k1l2m3n4o"},"assetContainerId":{"type":"object","format":"uuid","description":"The id of the asset container","example":"a0e4b1c2-3d4e-5f6g-7h8i-9j0k1l2m3n4o"},"observation":{"type":"string","description":"Extra data for the spot assignment","example":"Spot assignment for truck 4"},"spot":{"type":"object"},"assetVisit":{"type":"object"},"assetContainer":{"type":"object"},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","spotId","spot","lastChangedBy","isActive","tags"]},"SpotItemDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"format":"uuid"},"createDateTime":{"type":"string","readOnly":true,"format":"date-time"},"createdBy":{"type":"string","readOnly":true,"format":"uuid"},"lastChangedDateTime":{"type":"string","readOnly":true,"format":"date-time"},"lastChangedBy":{"type":"string","readOnly":true,"format":"uuid"},"isActive":{"type":"boolean","readOnly":true},"tags":{"type":"array","readOnly":true,"example":["external","waiting"]},"orgId":{"type":"string","readOnly":true,"format":"uuid"},"warehouseId":{"type":"string","readOnly":true,"format":"uuid"},"code":{"type":"string","readOnly":true,"example":"G300"},"type":{"type":"string","readOnly":true,"enum":["parking","docking"],"example":"parking"},"spotAreaId":{"type":"string","readOnly":true,"format":"uuid"},"observation":{"type":"string","nullable":true,"readOnly":true,"example":"This is a spot observation."},"spotAssignments":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/SpotAssignment"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","lastChangedBy","isActive","tags","orgId","warehouseId","code","type","observation","spotAssignments"]},"ListSpotDto":{"type":"object","properties":{"entity":{"type":"string","readOnly":true,"enum":["Spot"]},"action":{"type":"string","readOnly":true,"enum":["read"]},"data":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/SpotItemDto"}}},"required":["entity","action","data"]},"SpotType":{"type":"string","description":"The type of the spot","enum":["parking","docking"]},"CreateSpotDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"code":{"type":"string","minLength":1,"maxLength":5},"type":{"$ref":"#/components/schemas/SpotType"},"spotAreaId":{"type":"string","format":"uuid"},"observation":{"type":"string"}},"required":["code","type","spotAreaId"]},"GetManySpotResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Spot"}},"count":{"type":"number"},"total":{"type":"number"},"page":{"type":"number"},"pageCount":{"type":"number"}},"required":["data","count","total","page","pageCount"]},"Spot":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"code":{"type":"string","description":"The code of the spot","example":"SP001"},"type":{"$ref":"#/components/schemas/SpotType"},"spotAreaId":{"type":"string","format":"uuid","description":"The id of the spot area","example":"a0e4b1c2-3d4e-5f6g-7h8i-9j0k1l2m3n4o"},"observation":{"type":"string","description":"The observation of the spot","example":"Large spot for trucks"},"spotArea":{"type":"object"},"spotAssignments":{"type":"array","items":{"type":"object"}},"spotEvents":{"type":"array","items":{"type":"object"}},"spotReserves":{"type":"array","items":{"type":"object"}},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","code","type","spotAreaId","spotArea","spotAssignments","spotEvents","spotReserves","lastChangedBy","isActive","tags"]},"CreateSpotManyDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"numberOfSpots":{"type":"number","minimum":1,"maximum":300},"startFromNumber":{"type":"number","minimum":1,"maximum":9000},"leadingChar":{"type":"string","maxLength":1},"type":{"$ref":"#/components/schemas/SpotType"},"spotAreaId":{"type":"string","format":"uuid"}},"required":["numberOfSpots","startFromNumber","type","spotAreaId"]},"UpdateSpotDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"code":{"type":"string","minLength":1,"maxLength":5},"type":{"$ref":"#/components/schemas/SpotType"},"spotAreaId":{"type":"string","format":"uuid"},"observation":{"type":"string","maxLength":1024}}},"DeleteResult":{"type":"object","properties":{}},"DeleteSpotManyDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"spotIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["spotIds"]},"UpdateSpotStatusDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"observation":{"type":"string"}},"required":["reason"]},"SpotReserveEntityEnum":{"type":"string","description":"The entity type for the reserve action","enum":["YardTask"]},"ToggleSpotReserveDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"objectId":{"type":"string","format":"uuid"},"entityName":{"$ref":"#/components/schemas/SpotReserveEntityEnum"},"validUntil":{"type":"string","format":"date-time"},"observation":{"type":"string","maxLength":1024,"description":"Optional observation for the spot reserve action"}}},"SpotEventTypeEnum":{"type":"string","description":"The type of the event","enum":["assignment","release","reserve","release_reserve","close","open","other"]},"SpotEvent":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"spotId":{"type":"string","format":"uuid","description":"The id of the spot","example":"a0e4b1c2-3d4e-5f6g-7h8i-9j0k1l2m3n4o"},"eventType":{"$ref":"#/components/schemas/SpotEventTypeEnum"},"reason":{"type":"string","description":"The reason for the event","example":"Spot is occupied"},"observation":{"type":"string","description":"The observation of the event","example":"Spot is occupied by a truck"},"assetContainerId":{"type":"string","description":"The ID of the asset container associated with this event","example":"a0e4b1c2-3d4e-5f6g-7h8i-9j0k1l2m3n4o"},"assetVisitId":{"type":"string","description":"The ID of the asset visit associated with this event","example":"a0e4b1c2-3d4e-5f6g-7h8i-9j0k1l2m3n4o"},"spot":{"type":"object"},"assetContainer":{"type":"object"},"assetVisit":{"type":"object"},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","spotId","eventType","spot","lastChangedBy","isActive","tags"]},"CreateSpotAreaDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"name":{"type":"string","minLength":1,"maxLength":255},"observation":{"type":"string"},"warehouseId":{"type":"string","format":"uuid"}},"required":["name","warehouseId"]},"GetManySpotAreaResponseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SpotArea"}},"count":{"type":"number"},"total":{"type":"number"},"page":{"type":"number"},"pageCount":{"type":"number"}},"required":["data","count","total","page","pageCount"]},"SpotArea":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"name":{"type":"string","description":"The name of the spot area","example":"Spot Area 1"},"spots":{"type":"array","items":{"type":"object"}},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","name","spots","lastChangedBy","isActive","tags"]},"UpdateSpotAreaDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"name":{"type":"string","minLength":1,"maxLength":255}}},"CreateSpotAssignmentDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"assetVisitId":{"type":"string","format":"uuid"},"assetContainerId":{"type":"string","format":"uuid"},"spotId":{"type":"string","format":"uuid"},"observation":{"type":"string"}},"required":["spotId"]},"UpdateSpotAssignmentDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"observation":{"type":"string"},"assetVisitId":{"type":"string","format":"uuid"},"assetContainerId":{"type":"string","format":"uuid"}}},"DepartTypeEnum":{"type":"string","enum":["All","AssetVisit","AssetContainer"]},"DepartSpotAssignmentDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"departType":{"$ref":"#/components/schemas/DepartTypeEnum"}},"required":["departType"]},"ReassignSpotDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"spotId":{"type":"string","format":"uuid"},"reason":{"type":"string"},"observation":{"type":"string"},"moveContainer":{"type":"boolean","description":"When set to true, it moves only the asset container"}},"required":["spotId"]},"YardViewSpotRefDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"string","description":"Spot code (display / yard label)"}},"required":["id","code"]},"YardViewSpotAreaRefDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"]},"YardViewSpotReserveRefDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"isActive":{"type":"boolean"},"entityName":{"type":"object","description":"SpotReserveEntityEnum"},"objectId":{"type":"object","format":"uuid"},"validUntil":{"type":"string","format":"date-time"}},"required":["id","isActive"]},"YardViewCompanyRefDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"]},"YardViewDockRefDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"]},"YardViewLoadTypeRefDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"direction":{"type":"string","enum":["Inbound","Outbound","Inbound/Outbound"]}},"required":["id","name","direction"]},"YardViewAppointmentRefDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"type":"object","description":"Appointment status"},"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"},"refNumber":{"type":"object"},"refNumbers":{"description":"All reference numbers on the appointment","type":"array","items":{"type":"string"}},"confirmationNumber":{"type":"object"},"dock":{"$ref":"#/components/schemas/YardViewDockRefDto"},"loadType":{"$ref":"#/components/schemas/YardViewLoadTypeRefDto"}},"required":["id","refNumbers"]},"SpotGridAssignmentDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"assetContainerId":{"type":"object","format":"uuid"},"assetVisitId":{"type":"object","format":"uuid"},"visitType":{"type":"string","enum":["LiveUnload","LiveLoad","Live","Drop","PickUp","DropHook","Unknown"]},"company":{"description":"Company from visit or container","allOf":[{"$ref":"#/components/schemas/YardViewCompanyRefDto"}]},"companyHint":{"type":"object","description":"Fallback company hint on the asset visit"},"code":{"type":"object","description":"Asset container code"},"containerCodes":{"description":"Codes of hooked containers (for tooltip Hooked Asset ID)","default":[],"type":"array","items":{"type":"string"}},"containerType":{"type":"string","enum":["Trailer","Container","Oversized","Chassis","Reefer","Other"]},"containerState":{"type":"string","enum":["Full","Empty","Partially Loaded"]},"createDateTime":{"type":"string","format":"date-time"},"containerCount":{"type":"number","description":"Number of containers on this visit"},"latestContainerEventType":{"type":"string","enum":["Arrived","Loading","Loading Complete","Unloading","Unloading Complete","Ready for Pickup","Departed","Inoperable"]},"hasPickupAppointment":{"type":"boolean","description":"Whether the assigned container has a pickup appointment"},"appointment":{"$ref":"#/components/schemas/YardViewAppointmentRefDto"},"parkedAt":{"type":"string","description":"When the visit was docked/parked (for tooltip Parked at)","format":"date-time"},"containerOwnerCompany":{"description":"Container owner","allOf":[{"$ref":"#/components/schemas/YardViewCompanyRefDto"}]},"pickupCarrierCompany":{"description":"Pickup carrier","allOf":[{"$ref":"#/components/schemas/YardViewCompanyRefDto"}]},"dropoffCarrierCompany":{"description":"Drop carrier","allOf":[{"$ref":"#/components/schemas/YardViewCompanyRefDto"}]}},"required":["id","containerCodes","containerCount","hasPickupAppointment"]},"YardViewOpenMoveTaskRefDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"refNum":{"type":"object","description":"Display ref number (e.g. Tasks #123)"}},"required":["id"]},"SpotGridItemDto":{"type":"object","properties":{"spot":{"$ref":"#/components/schemas/YardViewSpotRefDto"},"spotArea":{"$ref":"#/components/schemas/YardViewSpotAreaRefDto"},"type":{"type":"string","description":"SpotType enum"},"isActive":{"type":"boolean","description":"Spot open vs closed. With `assignment`, UI can derive move-task lock: !isActive && Boolean(assignment.assetContainerId) (see @nova/core isSpotLocked)."},"spotReserves":{"description":"Active reserves for this spot (BFF loads active only). UI: isSpotReserved = spotReserves.length > 0; cache invalidation on reserve ids.","type":"array","items":{"$ref":"#/components/schemas/YardViewSpotReserveRefDto"}},"assignment":{"$ref":"#/components/schemas/SpotGridAssignmentDto"},"openMoveTask":{"description":"Active move task when tied to this spot (reserve or assigned container).","allOf":[{"$ref":"#/components/schemas/YardViewOpenMoveTaskRefDto"}]}},"required":["spot","spotArea","type","isActive","spotReserves"]},"SpotGridAreaDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"spots":{"type":"array","items":{"$ref":"#/components/schemas/SpotGridItemDto"}}},"required":["id","name","spots"]},"SpotGridResponseDto":{"type":"object","properties":{"areas":{"type":"array","items":{"$ref":"#/components/schemas/SpotGridAreaDto"}}},"required":["areas"]},"YardViewWaitingQueueResponseDto":{"type":"object","properties":{"assets":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/YardViewWaitingVisitRowDto"},{"$ref":"#/components/schemas/YardViewWaitingContainerRowDto"}],"discriminator":{"propertyName":"isContainer"}}}},"required":["assets"]},"ListViewAssetContainerDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"object","description":"Container code / trailer number"},"type":{"type":"string","enum":["Trailer","Container","Oversized","Chassis","Reefer","Other"]},"state":{"type":"string","enum":["Full","Empty","Partially Loaded"]},"status":{"type":"string","enum":["Arrived","Loading","Loading Complete","Unloading","Unloading Complete","Ready for Pickup","Departed","Inoperable"]},"ownerCompany":{"description":"Container owner","allOf":[{"$ref":"#/components/schemas/YardViewCompanyRefDto"}]}},"required":["id"]},"ListViewAssetVisitDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"company":{"$ref":"#/components/schemas/YardViewCompanyRefDto"},"phone":{"type":"object"},"visitType":{"type":"string","enum":["LiveUnload","LiveLoad","Live","Drop","PickUp","DropHook","Unknown"]},"arrivedAt":{"type":"string","format":"date-time"}},"required":["id"]},"ListViewAppointmentDto":{"type":"object","properties":{"identifier":{"type":"object"},"refNumber":{"type":"object"},"confirmationNumber":{"type":"object"},"isPlanned":{"type":"boolean"}},"required":["isPlanned"]},"CustomFormDataItemDto":{"type":"object","properties":{"objectId":{"type":"string","format":"uuid"},"formFieldId":{"type":"object","format":"uuid"},"label":{"type":"string"},"value":{"type":"object"},"type":{"type":"string","enum":["str","bigstr","date","bool","doc","multidoc","int","email","phone","dropdown","dropdownmultiselect","combobox","timestamp","action"]}},"required":["objectId","label","type"]},"ListViewRowDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Container ID, or visit ID when visit has no containers"},"isWaiting":{"type":"boolean","description":"Whether this asset is waiting for assignment vs parked on a spot"},"spot":{"$ref":"#/components/schemas/YardViewSpotRefDto"},"spotArea":{"$ref":"#/components/schemas/YardViewSpotAreaRefDto"},"spotReserves":{"description":"Active spot reserves when row is parked on a spot (empty when waiting). Same shape as spot-grid; derive reserved as length > 0.","type":"array","items":{"$ref":"#/components/schemas/YardViewSpotReserveRefDto"}},"assetArrivedAt":{"type":"string","format":"date-time"},"assetContainer":{"$ref":"#/components/schemas/ListViewAssetContainerDto"},"assetVisit":{"$ref":"#/components/schemas/ListViewAssetVisitDto"},"appointment":{"$ref":"#/components/schemas/ListViewAppointmentDto"},"dropAppointmentCompany":{"description":"Company that dropped this container","allOf":[{"$ref":"#/components/schemas/YardViewCompanyRefDto"}]},"pickupAppointmentCompany":{"description":"Company scheduled to pick up this container","allOf":[{"$ref":"#/components/schemas/YardViewCompanyRefDto"}]},"openMoveTask":{"$ref":"#/components/schemas/YardViewOpenMoveTaskRefDto"},"customFormData":{"description":"Custom form data entries for this container","type":"array","items":{"$ref":"#/components/schemas/CustomFormDataItemDto"}}},"required":["id","isWaiting","spotReserves","customFormData"]},"ListViewResponseDto":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/ListViewRowDto"}}},"required":["rows"]},"YardViewSpotDetailAssetContainerItemDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"code":{"type":"object"},"type":{"type":"string","enum":["Trailer","Container","Oversized","Chassis","Reefer","Other"]},"pickupAppointmentId":{"type":"object","format":"uuid"},"dropAppointmentId":{"type":"object","format":"uuid"}},"required":["id"]},"SpotDetailResponseDto":{"type":"object","properties":{"spot":{"type":"object","description":"Full spot for drawer: core fields, spotReserves, spotAssignments[0] with visit/container"},"openMoveTask":{"description":"Active move task for this spot when present (same shape as spot-grid / list-rows)","allOf":[{"$ref":"#/components/schemas/YardViewOpenMoveTaskRefDto"}]},"arrivalContainers":{"description":"When assignment has assetVisit without appointment (unplanned)","type":"array","items":{"$ref":"#/components/schemas/YardViewSpotDetailAssetContainerItemDto"}},"containersWithSamePickupAppointment":{"description":"Containers with same pickup appointment as the visit","type":"array","items":{"$ref":"#/components/schemas/YardViewSpotDetailAssetContainerItemDto"}},"containersWithSameDropAppointment":{"description":"Containers with same drop appointment as the visit","type":"array","items":{"$ref":"#/components/schemas/YardViewSpotDetailAssetContainerItemDto"}}},"required":["spot"]},"UpdateSamlConfigDto":{"type":"object","properties":{"idpMetadataUrl":{"type":"string"},"logoutRedirectUrl":{"type":"string"},"enabled":{"type":"boolean"},"forbidPasswordLogins":{"type":"boolean"}}},"SiteDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"]},"GateDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"site":{"$ref":"#/components/schemas/SiteDto"}},"required":["id","name","site"]},"GatesByWarehouseDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GateDto"}}},"required":["data"]},"VehicleObservation":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"createDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was created","example":"2023-10-01T12:00:00Z","readOnly":true},"createdBy":{"type":"string","nullable":true,"description":"The ID of the user who created the record","example":"a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5","readOnly":true},"lastChangedDateTime":{"format":"date-time","type":"string","description":"The date and time when the record was last changed","example":"2023-10-01T12:00:00Z","readOnly":true},"gateId":{"type":"string"},"gate":{"type":"object"},"direction":{"type":"object"},"images":{"type":"array","items":{"type":"string"}},"licensePlate":{"type":"object"},"dotNumber":{"type":"object"},"number":{"type":"string"},"carrierName":{"type":"string"},"damage":{"type":"object"},"fuelType":{"type":"object"},"vehicleClass":{"type":"object"},"detectedAt":{"format":"date-time","type":"string"},"assetVisit":{"type":"object"},"assetVisitId":{"type":"string"},"assetObservations":{"type":"array","items":{"type":"object"}},"orgId":{"type":"string"},"org":{"type":"object"},"lastChangedBy":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"tags":{"nullable":true,"type":"array","items":{"type":"string"}}},"required":["id","createDateTime","createdBy","lastChangedDateTime","gateId","gate","direction","images","detectedAt","orgId","org","lastChangedBy","isActive","tags"]},"ObservationCreateAssetVisitAssetDetails":{"type":"object","properties":{"companyHint":{"type":"string"},"phone":{"type":"string"},"assetVisitType":{"type":"object"}},"required":["companyHint"]},"ObservationCreateAssetVisitDto":{"type":"object","properties":{"tags":{"nullable":true,"type":"array","items":{"type":"string"}},"assetDetails":{"$ref":"#/components/schemas/ObservationCreateAssetVisitAssetDetails"},"assetContainerDetails":{"type":"array","items":{"type":"object"}}},"required":["assetDetails"]},"ObservationCreateAssetVisitResponse":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"AuditLog":{"type":"object","properties":{"id":{"type":"number"},"tableName":{"type":"string"},"objectId":{"type":"string"},"orgId":{"type":"string"},"application":{"type":"string"},"changedBy":{"type":"string"},"actionTimestamp":{"format":"date-time","type":"string"},"action":{"type":"string","enum":["INSERT","UPDATE","DELETE"]},"changedFields":{"type":"object"},"changedByUser":{"type":"object"}},"required":["id","tableName","objectId","orgId","application","changedBy","actionTimestamp","action","changedFields","changedByUser"]},"MetricsAppointmentVolumeByLoadTypeResponse":{"type":"object","properties":{"data":{"type":"object","example":{"MyLoadType":{"sunday":0,"monday":3,"tuesday":2,"wednesday":5,"thursday":7,"friday":5,"saturday":0},"AnotherLoadType":{"sunday":0,"monday":2,"tuesday":3,"wednesday":2,"thursday":5,"friday":4,"saturday":0}}}},"required":["data"]},"MetricsAppointmentVolumeByTimeOfDayResponse":{"type":"object","properties":{"data":{"type":"object","example":{"8":"1","9":"1","10":"2","11":"2","13":"4","14":"4","15":"3","16":"3"}}},"required":["data"]},"MetricsAppointmentVolumeByDateResponse":{"type":"object","properties":{"data":{"type":"object","example":{"05/16/2023":"1","05/30/2023":"1","06/02/2023":"1","06/09/2023":"2"}}},"required":["data"]},"MetricsAppointmentVolumeByCarrierResponse":{"type":"object","properties":{"data":{"type":"object","example":{"Raphael":"5","Josh":"7","Mike":"3"}}},"required":["data"]},"MetricsAverageDurationByLoadTypeResponse":{"type":"object","properties":{"data":{"type":"object","example":{"MyLoadType":36,"AnotherLoadType":20}}},"required":["data"]},"MetricsAppointmentVolumeByDayOfWeekResponse":{"type":"object","properties":{"data":{"type":"object","example":{"MyDock":{"sunday":0,"monday":6,"tuesday":2,"wednesday":3,"thursday":7,"friday":3,"saturday":0},"AlternativeDock":{"sunday":0,"monday":2,"tuesday":2,"wednesday":1,"thursday":3,"friday":2,"saturday":0}}}},"required":["data"]},"MetricsAppointmentVolumeByStatusResponse":{"type":"object","properties":{"data":{"type":"object","example":{"Scheduled":"6","Arrived":"2","Completed":"5","NoShow":"1","Cancelled":"0"}}},"required":["data"]},"MetricsAppointmentVolumeByStatusByDockResponse":{"type":"object","properties":{"data":{"type":"object","example":{"MyDock":{"Scheduled":"6","Arrived":"2","Completed":"5","NoShow":"1","Cancelled":"0"},"AlternativeDock":{"Scheduled":"1","Arrived":"2","Completed":"2","NoShow":"1","Cancelled":"0"}}}},"required":["data"]},"AppointmentMetricsDto":{"type":"object","properties":{"warehouseIds":{"type":"array","items":{"type":"string"}},"toDate":{"type":"string"},"fromDate":{"type":"string"},"warehouseId":{"type":"string"}}},"AppointmentMetricsListDto":{"type":"object","properties":{"limit":{"type":"number"},"dockIds":{"type":"array","items":{"type":"string"}},"loadTypeIds":{"type":"array","items":{"type":"string"}},"carrierIds":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"dateField":{"type":"object"},"appointmentTypes":{"type":"array","items":{"type":"object"}},"allCarriers":{"type":"boolean"},"exportFields":{"type":"array","items":{"type":"object"}},"skipCustomFields":{"type":"boolean"},"warehouseIds":{"type":"array","items":{"type":"string"}},"statuses":{"type":"array","items":{"type":"string"}},"appointmentCreatorTypes":{"type":"array","items":{"type":"object"}},"toDate":{"type":"string"},"fromDate":{"type":"string"},"warehouseId":{"type":"string"}}},"YardExportDataDto":{"type":"object","properties":{"startDate":{"type":"string"},"endDate":{"type":"string"},"warehouseId":{"type":"string"},"fields":{"default":[],"type":"array","items":{"type":"object"}},"filterBy":{"type":"string","enum":["arrival","departure"]}},"required":["startDate","endDate","warehouseId","fields","filterBy"]},"AppointmentMetricsCapacityDto":{"type":"object","properties":{"dockIds":{"type":"array","items":{"type":"string"}},"warehouseIds":{"type":"array","items":{"type":"string"}},"toDate":{"type":"string"},"fromDate":{"type":"string"},"warehouseId":{"type":"string"}},"required":["warehouseIds"]},"WarehouseMetricsDto":{"type":"object","properties":{"warehouseIds":{"type":"array","items":{"type":"string"}},"groupBy":{"type":"object","default":"warehouse"},"toDate":{"type":"string"},"fromDate":{"type":"string"},"warehouseId":{"type":"string"}},"required":["warehouseIds","groupBy"]},"MetricsCarrierStatusPercentageResponse":{"type":"object","properties":{"data":{"type":"object","example":{"list":[{"id":"2968b3b1-ffe0-4005-8114-7c584e0893f6","name":"Carrier 1","scac":"99M","appointmentIds":["6eae2369-9c29-4f23-b091-24d831112b9f","c66fef39-66ea-4249-8c67-23ecf6710ba3"],"totalAppointments":"2","totalLateAppointments":"0","totalOnTimeAppointments":"1","totalNoShowAppointments":"0","totalRescheduledAppointments":"0","totalCancelledAppointments":"1","onTimePct":"50.0","latePct":"0.0","noShowPct":"0.0","rescheduledPct":"0.0","cancelPct":"50.0","avgCancelLeadTimeInMinutes":"-149.2320333333333333"},{"id":"3c36909b-1a09-462f-99e1-a9152b3306d0","name":"Carrier2","scac":"98M","appointmentIds":["0a5cc02a-fdda-4645-8b7c-3097ec6b5a16","27de0365-b6fc-4cdc-a586-a2a3a1b3036b","29b270d5-4148-4a0b-9439-30fd9a7329ac","315e19d0-574d-4f55-8728-c4c3fba71c1c","89c390b7-9e78-4852-b67d-db4250a27256","a8fa27d4-f441-4f5c-8dc5-9c1e1dd213f1"],"totalAppointments":"11","totalLateAppointments":"5","totalOnTimeAppointments":"0","totalNoShowAppointments":"2","totalRescheduledAppointments":"1","totalCancelledAppointments":"0","onTimePct":"0.0","latePct":"45.5","noShowPct":"18.2","rescheduledPct":"9.1","cancelPct":"0.0","avgCancelLeadTimeInMinutes":null}],"total":{"totalCarriers":2,"totalAppointments":13,"avgAppointmentsPerCarrier":6,"totalOnTimeAppointments":1,"totalLateAppointments":5,"totalNoShowAppointments":2,"totalRescheduledAppointments":1,"totalCancelledAppointments":1,"onTimePct":"7.7","latePct":"38.5","cancelPct":"7.7","noShowPct":"15.4","rescheduledPct":"7.7","avgCancelLeadTimeInMinutes":-75}}}},"required":["data"]},"MetricsDockDwellTimeResponse":{"type":"object","properties":{"data":{"type":"object","example":{"day":{"Dock2":{"Tuesday":45,"Friday":30},"MyDock":{"Monday":30,"Tuesday":45}},"all":{"Dock2":45,"MyDock":45}}}},"required":["data"]},"MetricsCountsAppointmentCountForDocksResponse":{"type":"object","properties":{"data":{"type":"object","example":[{"dock_id":"c09e393a-0916-444a-a1a8-4e605a07618e","count":72}]}},"required":["data"]},"MetricsCountsAppointmentCountForCarrierResponse":{"type":"object","properties":{"data":{"type":"object","example":[{"org_name":"My carrier org name","appointmentCount":45}]}},"required":["data"]},"MetricsCountsReserveCountForUserResponse":{"type":"object","properties":{"data":{"type":"object","example":{"reserveCount":3}}},"required":["data"]},"LoadTypeMetricsDto":{"type":"object","properties":{"warehouseId":{"type":"string"},"loadtypeIds":{"type":"array","items":{"type":"string"}}},"required":["warehouseId","loadtypeIds"]},"AppointmentMetricsListV2Dto":{"type":"object","properties":{"dockIds":{"type":"array","items":{"type":"string"}},"loadTypeIds":{"type":"array","items":{"type":"string"}},"carrierIds":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"dateField":{"type":"object"},"appointmentTypes":{"type":"array","items":{"type":"object"}},"allCarriers":{"type":"boolean"},"exportFields":{"type":"array","items":{"type":"object"}},"skipCustomFields":{"type":"boolean"},"warehouseIds":{"type":"array","items":{"type":"string"}},"statuses":{"type":"array","items":{"type":"string"}},"page":{"type":"number"},"pageSize":{"type":"number"},"appointmentCreatorTypes":{"type":"array","items":{"type":"object"}},"toDate":{"type":"string"},"fromDate":{"type":"string"},"warehouseId":{"type":"string"}},"required":["page","pageSize"]},"MetricsAppointmentListData":{"type":"object","properties":{"data":{"type":"array","items":{"type":"Appointment"}}},"required":["data"]},"MetricsAppointmentListResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MetricsAppointmentListData"}},"required":["data"]},"CreateBolRequestDto":{"type":"object","properties":{"appointmentId":{"type":"string","format":"uuid"},"documentUrl":{"type":"string"}},"required":["appointmentId","documentUrl"]},"CreateBolResponseDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"}},"required":["id"]},"GetBolResponseDto":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"originalDoc":{"type":"object","properties":{"originalDocId":{"type":"string","format":"uuid"},"externalKey":{"type":"string"}}},"signedDoc":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"externalKey":{"type":"string"}}}},"required":["id","originalDoc","signedDoc"]}}}}