{ "openapi": "3.0.1", "info": { "contact": {}, "description": "Standard HTTP Basic authentication (username & password).", "title": "Seminode API", "version": "1.0" }, "paths": { "/connections/graph/config": { "post": { "description": "Creates a new Microsoft Graph API configuration for email integration", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph.GraphConfigCreateRequest" } } }, "description": "Graph API configuration", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph.GraphConfig" } } }, "description": "Created configuration" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Bad request" }, "401": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Internal server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Create Graph API configuration", "tags": [ "GraphAPI" ], "x-internal": false, "x-codegen-request-body-name": "body" } }, "/connections/graph/config/{id}": { "put": { "description": "Updates an existing Microsoft Graph API configuration", "parameters": [ { "description": "Configuration ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graph.GraphConfigUpdateRequest" } } }, "description": "Update fields", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Success message" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Bad request" }, "401": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Configuration not found" }, "500": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Internal server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Update Graph API configuration", "tags": [ "GraphAPI" ], "x-internal": false, "x-codegen-request-body-name": "body" }, "delete": { "description": "Deletes a Microsoft Graph API configuration", "parameters": [ { "description": "Configuration ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Success message" }, "401": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Configuration not found" }, "500": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Internal server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Delete Graph API configuration", "tags": [ "GraphAPI" ], "x-internal": false } }, "/connections/graph/config/{id}/test": { "get": { "description": "Test a Microsoft Graph API configuration", "parameters": [ { "description": "Configuration ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Success message" }, "401": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Configuration not found" }, "500": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Internal server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Test Graph API configuration", "tags": [ "GraphAPI" ], "x-internal": false } }, "/inbox/notifications/{id}": { "patch": { "description": "Update an existing inbox notification for the authenticated company", "parameters": [ { "description": "Notification ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbox.UpdateNotificationRequest" } } }, "description": "Update data", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.DetailResponse" } } }, "description": "Notification updated successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Malformed request body" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Notification not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Internal server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "Update Inbox Notification", "tags": [ "Inbox" ], "x-internal": false, "x-codegen-request-body-name": "body" }, "delete": { "description": "Delete an inbox notification for the authenticated company", "parameters": [ { "description": "Notification ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.DetailResponse" } } }, "description": "Notification deleted successfully" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Notification not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Internal server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "Delete Inbox Notification", "tags": [ "Inbox" ], "x-internal": false } }, "/inbox/notifications/{id}/status": { "patch": { "description": "Update the status of an inbox notification for the authenticated company", "parameters": [ { "description": "Notification ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "New status (pending/closed)", "in": "query", "name": "status", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.DetailResponse" } } }, "description": "Notification status updated successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Missing or invalid status parameter" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Notification not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Internal server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "Update Inbox Notification Status", "tags": [ "Inbox" ], "x-internal": false } }, "/me/inbox/notifications": { "post": { "description": "Create a new inbox notification for the authenticated company", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbox.InboxNotification" } } }, "description": "Notification data", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbox.InboxNotification" } } }, "description": "Notification created successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Malformed request body" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Internal server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "Create Inbox Notification", "tags": [ "Inbox" ], "x-internal": false, "x-codegen-request-body-name": "body" }, "get": { "description": "Retrieve a list of inbox notifications for the authenticated company with optional filters", "parameters": [ { "description": "Filter by partner ID", "in": "query", "name": "partner_id", "schema": { "type": "string" } }, { "description": "Filter by email (partial match)", "in": "query", "name": "email", "schema": { "type": "string" } }, { "description": "Filter by status (pending/closed)", "in": "query", "name": "status", "schema": { "type": "string" } }, { "description": "Filter by message type (quote/response/message)", "in": "query", "name": "message_type", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/inbox.InboxNotification" }, "type": "array" } } }, "description": "Notifications retrieved successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Invalid filter parameters" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Internal server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "List Inbox Notifications", "tags": [ "Inbox" ], "x-internal": false } }, "/me/inbox/notifications/{id}": { "get": { "description": "Retrieve a specific inbox notification by ID for the authenticated company", "parameters": [ { "description": "Notification ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbox.InboxNotification" } } }, "description": "Notification retrieved successfully" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Notification not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Internal server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "Get Inbox Notification", "tags": [ "Inbox" ], "x-internal": false } }, "/listings/cleanse": { "post": { "description": "Validates headers, normalizes rows, converts currency, and stores the cleansed batch back in cache.", "parameters": [ { "description": "Attempt manufacturer name matching", "in": "query", "name": "mfr_match", "schema": { "type": "boolean" } }, { "description": "Convert unit prices to USD from this ISO-4217 code", "in": "query", "name": "currency_code", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bom.CleanseRequest" } } }, "description": "Batch-ID and final header order", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bom.CleanseResponse" } } }, "description": "cleansed rows preview" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "bad input or validation errors" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "batch ID not found in cache" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "server error while cleansing" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "LoginAuth": [] } ], "summary": "Cleanse a previously uploaded listings batch", "tags": [ "Listings" ], "x-internal": false, "x-codegen-request-body-name": "body" } }, "/listings/cleanse/edit": { "patch": { "description": "Takes a batch ID plus row indices to delete or replace, mutates the cached batch, and stores the result back with a fresh TTL.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bom.EditFileRequest" } } }, "description": "Rows to remove (RemoveIndices) or overwrite (EditIndices)", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "string" } } }, "description": "success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "invalid payload or missing batch ID" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "batch ID not found in cache" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "server error while editing batch" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "LoginAuth": [] } ], "summary": "Edit or remove rows in a cached listings batch", "tags": [ "Listings" ], "x-internal": false, "x-codegen-request-body-name": "body" } }, "/listings/delete": { "post": { "description": "Deletes one or more listings created by the calling user's company. If no node URLs are specified, all write-enabled nodes for the authenticated company are targeted.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listings.deleteListingsRequest" } } }, "description": "Listing IDs and optional node URLs", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.DetailResponse" } } }, "description": "Deletion event successfully sent" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Malformed request body" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Internal error retrieving nodes or keys" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "Delete Listings", "tags": [ "Listings" ], "x-internal": false, "x-codegen-request-body-name": "body" } }, "/listings/filter": { "post": { "description": "Filters and returns listings from the network using the posted filter payload. Designed for fine-grained, structured listing search. Criteria are ANDed together.", "parameters": [ { "description": "Maximum number of results to return (default: 50)", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "ID for forward pagination (get listings after this ID)", "in": "query", "name": "next_id", "schema": { "type": "string" } }, { "description": "ID for backward pagination (get listings before this ID)", "in": "query", "name": "before_id", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sevent.Filter" } } }, "description": "Listing filter payload", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/listings.Listing" }, "type": "array" } } }, "description": "filtered listings" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "invalid request body" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "internal error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "List Filtered Listings", "tags": [ "Listings" ], "x-internal": false, "x-codegen-request-body-name": "filter" } }, "/listings/search": { "get": { "description": "Performs a general text search over listings, returning matches for the given term. Optional result limit can be passed.", "parameters": [ { "description": "Search term (case-insensitive)", "in": "query", "name": "term", "required": true, "schema": { "type": "string" } }, { "description": "Max number of results to return (default: 250)", "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/listings.Listing" }, "type": "array" } } }, "description": "search results" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "missing or invalid search term" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "internal error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "Search listings with a text term", "tags": [ "Listings" ], "x-internal": false } }, "/listings/upload": { "post": { "description": "Accepts a CSV/XLS(X) file, normalizes headers, paginates rows, and returns a batch ID for later processing.", "parameters": [ { "description": "Listing type (`supply` or `demand`)", "in": "query", "name": "type", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/_listings_upload_post_request" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.APIResponse" } } }, "description": "parsed file preview and batch metadata" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "invalid parameters or unreadable file" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "file too large" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "server error while processing file" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "LoginAuth": [] } ], "summary": "Upload a BOM or listings file", "tags": [ "Listings" ], "x-internal": false } }, "/me/listings": { "get": { "description": "Retrieves listings authored by the current user's company, optionally filtered by batch ID.", "parameters": [ { "description": "Maximum number of listings to return (default 250)", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Batch ID to filter listings by", "in": "query", "name": "batch_id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/listings.Listing" }, "type": "array" } } }, "description": "OK" }, "500": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "Internal Server Error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "summary": "List Listings", "tags": [ "Listings" ], "x-internal": false } }, "/me/listings/batch": { "get": { "description": "Retrieves published listing batches for the authenticated user's company.", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/listings.ListingBatch" }, "type": "array" } } }, "description": "Successfully retrieved listing batches" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Internal server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "List Listing Batches", "tags": [ "Listings" ], "x-internal": false } }, "/me/listings/batch/{id}": { "delete": { "description": "Deletes Listings with given batch_id belonging to the authenticated user's company.", "parameters": [ { "description": "Batch ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.DetailResponse" } } }, "description": "successfully deleted batch" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "batch does not exist" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "user does not have permission" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "failed to delete batch" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "Delete Listing Batch", "tags": [ "Listings" ], "x-internal": false } }, "/me/listings/cleanse": { "get": { "description": "Fetches a paginated slice of listing content previously uploaded and stored under a batch ID.", "parameters": [ { "description": "Batch ID used to identify uploaded file", "in": "query", "name": "batch_id", "required": true, "schema": { "type": "string" } }, { "description": "Pagination index for slice of results", "in": "query", "name": "page", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Paginated listings content from cache" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Invalid batch ID or page parameter" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "No file found for given batch ID" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Unexpected server error while processing listings" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "Retrieve cleansed listings data by batch ID", "tags": [ "Listings" ], "x-internal": false } }, "/me/listings/publish": { "post": { "description": "Publish one or more listings created by the calling user's company. If no node URLs are specified, all write-enabled nodes for the authenticated company are targeted.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listings.publishListingsRequest" } } }, "description": "Listing IDs and optional node URLs", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.DetailResponse" } } }, "description": "Deletion event successfully sent" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Malformed request body" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Internal error retrieving nodes or keys" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "Publish Listings", "tags": [ "Listings" ], "x-internal": false, "x-codegen-request-body-name": "body" } }, "/connections/nodes": { "post": { "description": "Registers a new Node URL for the authenticated company's network.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nodeconn.PartialNodeConn" } } }, "description": "Node URL and optional metadata", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.DetailResponse" } } }, "description": "node connection created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "invalid input (bad JSON or URL)" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "server error while creating node" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "Create a Node Connection", "tags": [ "Node Connections" ], "x-internal": false, "x-codegen-request-body-name": "body" }, "get": { "description": "Returns all node connections for the caller's company.", "parameters": [ { "description": "true = only write-enabled nodes, false = only read-enabled nodes", "in": "query", "name": "writeable", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/nodeconn.NodeConnStatus" }, "type": "array" } } }, "description": "node URLs plus current connectivity/permission status" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "invalid query parameter" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "server error while retrieving nodes" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "List Node Connections", "tags": [ "Node Connections" ], "x-internal": false } }, "/connections/nodes/{id}": { "delete": { "description": "Removes a specific node connection owned by the caller's company.", "parameters": [ { "description": "Node ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.DetailResponse" } } }, "description": "node connection deleted" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "node connection not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "server error while deleting node" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "Delete a Node Connection", "tags": [ "Node Connections" ], "x-internal": false } }, "/nodes": { "post": { "description": "Admin-only. Provisions a new Node for the caller's company with read/write auth.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nodes.PartialNodeDeployment" } } }, "description": "Node deployment definition", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.DetailResponse" } } }, "description": "deployment created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "invalid input or duplicate name" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "caller not an admin" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "server error while creating node" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "Create a Node Deployment", "tags": [ "Node Deployments" ], "x-internal": false, "x-codegen-request-body-name": "body" }, "get": { "description": "Returns every Node deployed by the authenticated caller's company.", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/nodes.NodeDeploymentResponse" }, "type": "array" } } }, "description": "Nodes with URLs and metadata" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "List My Node Deployments", "tags": [ "Node Deployments" ], "x-internal": false } }, "/nodes/{id}": { "delete": { "description": "Deletes the specified Node after verifying caller permissions and remote node cleanup.", "parameters": [ { "description": "Node ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.DetailResponse" } } }, "description": "Node deleted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "cannot delete inbox Node" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "no permission" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Node not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "server or remote-node error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "Delete a Node", "tags": [ "Node Deployments" ], "x-internal": false } }, "/nodes/{id}/permissions": { "post": { "description": "Adds the specified public key to the deployment's permission list with read/write auth.", "parameters": [ { "description": "Node ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/permissions.Permission" } } }, "description": "Public key and permission flags", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.DetailResponse" } } }, "description": "permission created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "invalid input or public key" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "caller lacks deployment privileges" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "Create a Permission for a Node", "tags": [ "Node Permissions" ], "x-internal": false, "x-codegen-request-body-name": "body" }, "get": { "description": "Returns public keys that have access to the given Node.", "parameters": [ { "description": "Node ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/permissions.Permission" }, "type": "array" } } }, "description": "list of permissions" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "caller lacks deployment privileges" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "List Permissions for a Node", "tags": [ "Node Permissions" ], "x-internal": false }, "patch": { "description": "Replaces or edits an existing public-key permission for the Node.", "parameters": [ { "description": "Node ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/permissions.Permission" } } }, "description": "Updated permission object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.DetailResponse" } } }, "description": "permission updated" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "invalid input" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "caller lacks Node privileges" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "Update a Permission for a Node", "tags": [ "Node Permissions" ], "x-internal": false, "x-codegen-request-body-name": "body" } }, "/nodes/{id}/permissions/{public_key}": { "delete": { "description": "Deletes a specific public key from the Nodes's permission list.", "parameters": [ { "description": "Node ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Public key to remove", "in": "path", "name": "public_key", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.DetailResponse" } } }, "description": "permission removed" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "invalid public key" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "caller lacks deployment privileges" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "Delete a Permission for a Node", "tags": [ "Node Permissions" ], "x-internal": false } }, "/v1/companies/me/partners": { "post": { "description": "Creates a new partner for the company. Requires admin privileges.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partner.Partner" } } }, "description": " partner data", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partner.Partner" } } }, "description": " partner created successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "invalid request body" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "failed to create partner" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "LoginAuth": [] } ], "summary": "Create a new partner", "tags": [ "Partner" ], "x-internal": false, "x-codegen-request-body-name": "body" }, "get": { "description": "Returns all partners for the company. Requires member privileges.", "parameters": [ { "description": "Filter by partner type 'internal' or 'external'", "in": "query", "name": "type", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/partner.Partner" }, "type": "array" } } }, "description": "list of partners" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "failed to retrieve partners" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "LoginAuth": [] } ], "summary": "Get all partners", "tags": [ "Partner" ], "x-internal": false } }, "/v1/companies/me/partners/search": { "get": { "description": "Searches partners by name", "parameters": [ { "description": "Search query", "in": "query", "name": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/partner.Partner" }, "type": "array" } } }, "description": "list of partners matching the search criteria" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "failed to search partners" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "LoginAuth": [] } ], "summary": "Search partners", "tags": [ "Partner" ], "x-internal": false } }, "/v1/companies/me/partners/terms": { "get": { "description": "Retrieves all partner terms for the company. Requires admin privileges.", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "properties": {}, "type": "object" }, "type": "array" } } }, "description": "partner terms retrieved successfully" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "failed to fetch partner terms" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "LoginAuth": [] } ], "summary": "Get all partner terms", "tags": [ "Partner" ], "x-internal": false } }, "/v1/companies/me/partners/terms/{id}": { "put": { "description": "Updates partner terms by ID. Requires admin privileges.", "parameters": [ { "description": "Partner Terms ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Update data", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "partner terms updated successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "invalid request body or validation failed" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "partner terms not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "failed to update partner terms" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "LoginAuth": [] } ], "summary": "Update partner terms", "tags": [ "Partner" ], "x-internal": false, "x-codegen-request-body-name": "body" }, "delete": { "description": "Deletes partner terms by ID. Requires admin privileges.", "parameters": [ { "description": "Partner Terms ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.DetailResponse" } } }, "description": "partner terms deleted successfully" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "partner terms not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "failed to delete partner terms" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "LoginAuth": [] } ], "summary": "Delete partner terms", "tags": [ "Partner" ], "x-internal": false } }, "/v1/companies/me/partners/{id}/terms": { "post": { "description": "Creates new partner terms including addresses and payment information. Requires admin privileges.", "parameters": [ { "description": "Partner ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Terms creation data", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "partner terms created successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "invalid request body or validation failed" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "failed to create partner terms" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "LoginAuth": [] } ], "summary": "Create partner terms", "tags": [ "Partner" ], "x-internal": false, "x-codegen-request-body-name": "body" } }, "/v1/companies/me/partners/{partnerId}/terms": { "get": { "description": "Retrieves partner terms for a specific partner. Requires admin privileges.", "parameters": [ { "description": "Partner ID", "in": "path", "name": "partnerId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "partner terms retrieved successfully" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "partner terms not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "failed to fetch partner terms" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "LoginAuth": [] } ], "summary": "Get partner terms by partner ID", "tags": [ "Partner" ], "x-internal": false } }, "/v1/companies/me/partners/{public_key}": { "get": { "description": "Returns a specific partner by public key. Requires member privileges.", "parameters": [ { "description": "Partner Public Key", "in": "path", "name": "public_key", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partner.Partner" } } }, "description": " partner data" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": " partner not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "failed to retrieve partner" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "LoginAuth": [] } ], "summary": "Get partner by public key", "tags": [ "Partner" ], "x-internal": false } }, "/quote/responses/closed": { "get": { "description": "Lists quote responses closed for the caller's company. Closed quote responses are those either rejected, or accepted by both parties.", "parameters": [ { "description": "If true, returns shared/global quote responses instead of user-specific", "in": "query", "name": "shared", "schema": { "type": "boolean" } }, { "description": "Only responses authored by the caller", "in": "query", "name": "sent", "schema": { "type": "boolean" } }, { "description": "Only responses received by the caller", "in": "query", "name": "recieved", "schema": { "type": "boolean" } }, { "description": "Filter by accepted (true) or rejected (false)", "in": "query", "name": "accepted", "schema": { "type": "boolean" } }, { "description": "Max number of results to return (default 100)", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Only include events created after this timestamp (unix seconds)", "in": "query", "name": "since", "schema": { "type": "integer" } }, { "description": "Only include events created before this timestamp (unix seconds)", "in": "query", "name": "until", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/inbox.QuoteResponse" }, "type": "array" } } }, "description": "Filtered closed quote responses" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "List Closed Quote Responses", "tags": [ "Quote Responses" ], "x-internal": false } }, "/quotes/responses": { "post": { "description": "Replies to a quote or quote response with accept/reject terms.\nNote, the latest action on the quote/response must be initiated by the counterparty.\nYou cannot reject an already rejected event either.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbox.QuoteResponseRequest" } } }, "description": "Quote-response payload", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.DetailResponse" } } }, "description": "quote response sent" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "invalid payload or node URL" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "counter-party relay not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "server error while publishing" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "Send a Quote Response", "tags": [ "Quote Responses" ], "x-internal": false, "x-codegen-request-body-name": "body" } }, "/quotes/responses/pending": { "get": { "description": "Lists quote responses that are pending. Pending responses are threads that have only been accepted by one party.", "parameters": [ { "description": "Only quote responses authored by the caller", "in": "query", "name": "sent", "schema": { "type": "boolean" } }, { "description": "Only quote responses received by the caller", "in": "query", "name": "recieved", "schema": { "type": "boolean" } }, { "description": "If true, returns company-wide quote responses instead of user-specific. API keys will always return shared=true", "in": "query", "name": "shared", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/inbox.QuoteResponse" }, "type": "array" } } }, "description": "Pending quote responses" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "Server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "List Pending Quote Responses", "tags": [ "Quote Responses" ], "x-internal": false } }, "/inbox/listings/view": { "post": { "description": "Retrieves listings by their IDs for reference in quote threads.", "requestBody": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "Array of listing IDs", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "object" }, "type": "array" } } }, "description": "array of listings" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "invalid request body" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "Get Reference Listings", "tags": [ "Quotes" ], "x-internal": false, "x-codegen-request-body-name": "body" } }, "/quotes": { "post": { "description": "Sends a quote to the counter-party's inbox. Quotes must be in response to a Listing, or another Quote where you are not the author.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inbox.QuoteRequest" } } }, "description": "Quote payload", "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.DetailResponse" } } }, "description": "quote sent" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "invalid payload" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "listing or counter-party inbox not found" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "quote publish failed" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "Send a Quote", "tags": [ "Quotes" ], "x-internal": false, "x-codegen-request-body-name": "body" }, "get": { "description": "Returns the most recent quote per conversation for the callers company.\nA conversation is defined as a unique combination of Listing ID, and the unordered pair of author public key and recipient public key. Optional query `actioned` filters by quotes you *sent* (true) or *received* (false).", "parameters": [ { "description": "true = sent by me, false = received, omitted = both", "in": "query", "name": "actioned", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/inbox.Quote" }, "type": "array" } } }, "description": "list of quotes" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "List Latest Quotes", "tags": [ "Quotes" ], "x-internal": false } }, "/quotes/feed": { "get": { "description": "Lists quote events scoped to the user's listing subscriptions or globally shared (company-level) quotes if the `shared` flag is set.", "parameters": [ { "description": "If true, returns shared/global quotes instead of user-specific", "in": "query", "name": "shared", "schema": { "type": "boolean" } }, { "description": "Max number of events to return (default 100)", "in": "query", "name": "limit", "schema": { "type": "integer" } }, { "description": "Only include events created after this timestamp (unix seconds)", "in": "query", "name": "since", "schema": { "type": "integer" } }, { "description": "Only include events created before this timestamp (unix seconds)", "in": "query", "name": "until", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "object" }, "type": "array" } } }, "description": "filtered quote events" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "List Quote Feed", "tags": [ "Quotes" ], "x-internal": false } }, "/quotes/{id}/thread": { "get": { "description": "Retrieves the full message thread for a given quote (root event).", "parameters": [ { "description": "Root quote (event) ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Max events to return (default 8)", "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "object" }, "type": "array" } } }, "description": "thread messages" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "invalid id or params" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "thread not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "Get a quote thread", "tags": [ "Quotes" ], "x-internal": false } }, "/v1/inbox/thread/listing/{listing_id}": { "get": { "description": "Lists the message thread for a given listing ID.\nSuitable for any Message thread.", "parameters": [ { "description": "Listing ID", "in": "path", "name": "listing_id", "required": true, "schema": { "type": "string" } }, { "description": "Max events to return ", "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "object" }, "type": "array" } } }, "description": "thread messages in chronological order of type listing, quote, or response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "invalid id or params" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "thread not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "List Quoting Thread by Listing ID", "tags": [ "Quotes" ], "x-internal": false } }, "/v1/inbox/thread/{id}/listing/{listing_id}": { "get": { "description": "Lists the message thread for a given thread ID.\nSuitable for any Message thread.", "parameters": [ { "description": "Thread ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Listing ID", "in": "path", "name": "listing_id", "required": true, "schema": { "type": "string" } }, { "description": "Max events to return ", "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "object" }, "type": "array" } } }, "description": "thread messages in chronological order of type listing, quote, or response" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "invalid id or params" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "thread not found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } }, "description": "server error" }, "default": { "description": "unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/utils.ErrorResponse" } } } } }, "security": [ { "BearerAuth": [] }, { "LoginAuth": [] } ], "summary": "List Quoting Thread", "tags": [ "Quotes" ], "x-internal": false } } }, "components": { "schemas": { "auth.CreateMcpUserTokenRequest": { "properties": { "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "encrypted_access_token": { "type": "string" }, "encrypted_refresh_token": { "type": "string" }, "expires_at": { "description": "ISO 8601 format", "type": "string" }, "resource": { "type": "string" }, "server_name": { "type": "string" } }, "type": "object" }, "auth.McpSession": { "properties": { "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "last_accessed": { "type": "string" }, "session_data": { "type": "string" }, "session_id": { "description": "Primary Key", "type": "string" }, "user_id": { "type": "string" } }, "type": "object" }, "auth.McpUserToken": { "properties": { "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "created_at": { "type": "string" }, "encrypted_access_token": { "type": "string" }, "encrypted_refresh_token": { "type": "string" }, "expires_at": { "type": "string" }, "id": { "description": "Primary Key", "type": "string" }, "resource": { "type": "string" }, "server_name": { "type": "string" }, "updated_at": { "type": "string" }, "user_id": { "type": "string" } }, "type": "object" }, "auth.UpdateMcpUserTokenRequest": { "properties": { "encrypted_access_token": { "type": "string" }, "encrypted_refresh_token": { "description": "Optional, for refresh token rotation", "type": "string" }, "expires_at": { "description": "ISO 8601 format", "type": "string" }, "resource": { "type": "string" } }, "type": "object" }, "auth.apiKeyResponse": { "properties": { "key": { "type": "string" } }, "type": "object" }, "bom.AnalyticsOverview": { "properties": { "avg_unit_price": { "type": "number" }, "total_extended_value": { "type": "number" }, "total_rows": { "type": "integer" } }, "type": "object" }, "bom.AnalyticsResponse": { "properties": { "extended_value": { "items": { "$ref": "#/components/schemas/listings.ListingContent" }, "type": "array" }, "mfr_value": { "additionalProperties": { "$ref": "#/components/schemas/bom.MfrStats" }, "type": "object" }, "overview": { "$ref": "#/components/schemas/bom.AnalyticsOverview" }, "sort_column": { "type": "string" } }, "type": "object" }, "bom.CleanseRequest": { "properties": { "batch_id": { "type": "string" }, "dtag_headers": { "items": { "type": "string" }, "type": "array" }, "headers": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "bom.CleanseResponse": { "properties": { "dtag_error": { "type": "string" }, "header_errors": { "items": { "type": "string" }, "type": "array" }, "lines": { "items": { "$ref": "#/components/schemas/listings.ListingContent" }, "type": "array" }, "page_count": { "type": "integer" } }, "type": "object" }, "bom.EditFileRequest": { "properties": { "batch_id": { "type": "string" }, "edit_indices": { "items": { "$ref": "#/components/schemas/bom_EditFileRequest_edit_indices_inner" }, "type": "array" }, "remove_indices": { "items": { "type": "integer" }, "type": "array" } }, "type": "object" }, "bom.ExportRequest": { "properties": { "batch_id": { "type": "string" }, "headers": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "bom.MfrStats": { "properties": { "percent_total": { "type": "number" }, "total_value": { "type": "number" } }, "type": "object" }, "bom.PublishListingsRequest": { "properties": { "batch_id": { "type": "string" }, "file_name": { "type": "string" }, "urls": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "company.CompanyProfile": { "properties": { "description": { "type": "string" }, "display_name": { "type": "string" }, "external_id": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "profile_pic_url": { "type": "string" }, "public_key": { "type": "string" }, "require_mfa": { "type": "boolean" }, "sso_enabled": { "type": "boolean" }, "visibility": { "description": "'public' || 'unlisted' || 'private'", "type": "string" }, "website_url": { "type": "string" } }, "type": "object" }, "company.CompanySettings": { "properties": { "require_mfa": { "type": "boolean" }, "sso_enabled": { "type": "boolean" }, "visibility": { "description": "'public' || 'unlisted' || 'private'", "type": "string" } }, "type": "object" }, "company.PartialCompanyCreate": { "properties": { "company_name": { "type": "string" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "password": { "type": "string" }, "token": { "type": "string" } }, "type": "object" }, "company.updateSettingRequest": { "properties": { "require_mfa": { "type": "boolean" }, "visibility": { "type": "string" } }, "type": "object" }, "egest.EmailResponse": { "properties": { "failures": { "items": { "$ref": "#/components/schemas/egest.EmailResult" }, "type": "array" }, "message": { "type": "string" } }, "type": "object" }, "egest.EmailResult": { "properties": { "error": { "type": "string" }, "id": { "type": "string" }, "status": { "description": "\"success\", \"failed\"", "type": "string" } }, "type": "object" }, "egest.SendListingsAttachmentRequest": { "properties": { "emails": { "items": { "type": "string" }, "type": "array" }, "filter": { "$ref": "#/components/schemas/sevent.Filter" }, "message": { "type": "string" } }, "type": "object" }, "egest.SendListingsEmailRequest": { "properties": { "emails": { "items": { "type": "string" }, "type": "array" }, "listings": { "items": { "$ref": "#/components/schemas/listings.Listing" }, "type": "array" }, "message": { "type": "string" } }, "type": "object" }, "export.ExportEventsRequest": { "properties": { "filter": { "$ref": "#/components/schemas/sevent.Filter" }, "mapping_id": { "description": "Id of the Mapping you want to apply on export", "type": "string" }, "search": { "type": "string" }, "type": { "allOf": [ { "$ref": "#/components/schemas/mapping.MappingType" } ], "description": "Default 'listing'", "type": "object" } }, "type": "object" }, "graph.GraphConfig": { "properties": { "client_id": { "type": "string" }, "client_secret": { "description": "encrypted at rest", "type": "string" }, "company_id": { "type": "string" }, "created_at": { "type": "string" }, "enabled": { "type": "boolean" }, "id": { "type": "string" }, "monitored_inbox": { "description": "Email configuration", "type": "string" }, "tenant_id": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "graph.GraphConfigCreateRequest": { "properties": { "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "enabled": { "type": "boolean" }, "monitored_inbox": { "type": "string" }, "tenant_id": { "type": "string" } }, "type": "object" }, "graph.GraphConfigUpdateRequest": { "properties": { "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "enabled": { "type": "boolean" }, "monitored_inbox": { "type": "string" }, "tenant_id": { "type": "string" } }, "type": "object" }, "idp.AuthResponse": { "properties": { "detail": { "type": "string" }, "session_token": { "type": "string" }, "token": { "type": "string" } }, "type": "object" }, "idp.DiscoveryLoginRequest": { "properties": { "email": { "type": "string" } }, "type": "object" }, "idp.DiscoveryLoginResponse": { "properties": { "connections": { "items": { "$ref": "#/components/schemas/idp.SSOConnection" }, "type": "array" } }, "type": "object" }, "idp.OTPRequest": { "properties": { "email": { "type": "string" }, "otp": { "type": "string" }, "session_token": { "type": "string" } }, "required": [ "email", "otp", "session_token" ], "type": "object" }, "idp.PasswordResetComplete": { "properties": { "new_password": { "type": "string" }, "token": { "type": "string" } }, "required": [ "new_password", "token" ], "type": "object" }, "idp.PasswordResetRequest": { "properties": { "email": { "type": "string" } }, "required": [ "email" ], "type": "object" }, "idp.SSOConnection": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "idp.SSOLoginRequest": { "properties": { "code_verifier": { "type": "string" }, "sso_token": { "type": "string" } }, "required": [ "code_verifier", "sso_token" ], "type": "object" }, "idp.SSOUserCreateRequest": { "properties": { "company_id": { "type": "string" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "role": { "type": "string" } }, "type": "object" }, "idp.SessionResponse": { "properties": { "session_token": { "type": "string" } }, "type": "object" }, "inbox.InboxNotification": { "properties": { "company_id": { "type": "string" }, "created_at": { "type": "string" }, "data": { "description": "Marshalled JSON string", "items": { "type": "integer" }, "type": "array" }, "errors": { "additionalProperties": { "type": "string" }, "type": "object" }, "from_email": { "type": "string" }, "id": { "type": "string" }, "kind": { "description": "Used for parsing at runtime", "type": "integer" }, "partner_id": { "type": "string" }, "raw_body": { "type": "string" }, "reason": { "type": "string" }, "status": { "description": "Pending, dismissed, cleared", "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "inbox.PaymentTerm": { "properties": { "code": { "type": "string" }, "currency": { "type": "string" } }, "type": "object" }, "inbox.Quote": { "properties": { "content": { "$ref": "#/components/schemas/inbox.QuoteContent" }, "created_at": { "description": "TODO open, change to unix timestamp?", "type": "string" }, "id": { "type": "string" }, "kind": { "type": "integer" }, "public_key": { "type": "string" }, "recipient_public_key": { "type": "string" }, "reply_url": { "type": "string" }, "root_id": { "type": "string" }, "sig": { "type": "string" }, "tags": { "items": { "items": { "type": "string" }, "type": "array" }, "type": "array" }, "thread_id": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "inbox.QuoteAttributes": { "properties": { "condition": { "type": "string" }, "custom_attributes": { "additionalProperties": true, "type": "object" }, "date_code": { "type": "string" }, "packaging": { "type": "string" } }, "type": "object" }, "inbox.QuoteContent": { "properties": { "attributes": { "$ref": "#/components/schemas/inbox.QuoteAttributes" }, "company": { "description": "Set app layer", "type": "string" }, "contact": { "type": "string" }, "errors": { "additionalProperties": { "type": "string" }, "type": "object" }, "lead_time": { "description": "Slated for removal", "type": "integer" }, "lead_time_raw": { "description": "Slated For removal", "type": "string" }, "message": { "type": "string" }, "meta": { "additionalProperties": true, "type": "object" }, "qty": { "type": "integer" }, "schema_version": { "type": "string" }, "terms": { "$ref": "#/components/schemas/inbox.QuoteTerms" }, "timing": { "$ref": "#/components/schemas/inbox.QuoteTiming" }, "unit_price": { "type": "number" } }, "type": "object" }, "inbox.QuoteRequest": { "properties": { "content": { "$ref": "#/components/schemas/inbox.QuoteContent" }, "event_id": { "description": "Always included on requests", "type": "string" }, "event_url": { "type": "string" }, "listing": { "$ref": "#/components/schemas/listings.Listing" }, "public_key": { "description": "The author of the event we are replying to", "type": "string" }, "recipient_public_key": { "description": "The original recipient of the event we are replying to (me)", "type": "string" }, "reply_url": { "description": "Their reply url", "type": "string" }, "root_id": { "type": "string" }, "tags": { "items": { "items": { "type": "string" }, "type": "array" }, "type": "array" } }, "type": "object" }, "inbox.QuoteResponse": { "properties": { "content": { "$ref": "#/components/schemas/inbox.QuoteResponseContent" }, "created_at": { "description": "TODO open, change to unix timestamp?", "type": "string" }, "id": { "type": "string" }, "kind": { "type": "integer" }, "public_key": { "type": "string" }, "recipient_public_key": { "type": "string" }, "reply_url": { "type": "string" }, "root_id": { "type": "string" }, "sig": { "type": "string" }, "tags": { "items": { "items": { "type": "string" }, "type": "array" }, "type": "array" }, "thread_id": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "inbox.QuoteResponseContent": { "properties": { "company": { "type": "string" }, "contact": { "type": "string" }, "message": { "type": "string" }, "meta": { "additionalProperties": true, "type": "object" }, "quote": { "allOf": [ { "$ref": "#/components/schemas/inbox.Quote" } ], "description": "Quote Embedding", "type": "object" }, "reason": { "description": "For future use", "type": "string" }, "status": { "description": "\"accepted\" or \"rejected\"", "type": "string" } }, "type": "object" }, "inbox.QuoteResponseRequest": { "properties": { "content": { "$ref": "#/components/schemas/inbox.QuoteResponseContent" }, "event_id": { "description": "Always included on requests", "type": "string" }, "event_url": { "type": "string" }, "public_key": { "description": "The author of the event we are replying to", "type": "string" }, "recipient_public_key": { "description": "The original recipient of the event we are replying to (me)", "type": "string" }, "reply_url": { "description": "Their reply url", "type": "string" }, "root_id": { "type": "string" }, "tags": { "items": { "items": { "type": "string" }, "type": "array" }, "type": "array" } }, "type": "object" }, "inbox.QuoteTerms": { "properties": { "payment": { "$ref": "#/components/schemas/inbox.PaymentTerm" }, "shipping": { "$ref": "#/components/schemas/inbox.Shipping" } }, "type": "object" }, "inbox.QuoteTiming": { "properties": { "expiry": { "type": "integer" }, "lead_time": { "type": "string" }, "required_date": { "type": "integer" } }, "type": "object" }, "inbox.QuotesAnalyticsResponse": { "properties": { "average_quote_price": { "type": "number" }, "latest_quote_date": { "type": "string" }, "listing_price": { "type": "number" }, "part_number": { "type": "string" }, "price_disparity_pct": { "description": "(avg_quote - list) / list * 100", "type": "number" }, "quote_count": { "type": "integer" }, "total_quoted_volume": { "type": "integer" } }, "type": "object" }, "inbox.Shipping": { "properties": { "incoterm": { "type": "string" }, "place": { "type": "string" } }, "type": "object" }, "inbox.UpdateNotificationRequest": { "properties": { "content": { "items": { "type": "integer" }, "type": "array" }, "partner_id": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "listings.Cursor": { "properties": { "before_id": { "type": "string" }, "next_id": { "type": "string" }, "total_pages": { "type": "integer" } }, "type": "object" }, "listings.FeedResponse": { "properties": { "cursor": { "$ref": "#/components/schemas/listings.Cursor" }, "not_responded": { "items": { "$ref": "#/components/schemas/listings.Listing" }, "type": "array" }, "responded": { "items": { "$ref": "#/components/schemas/listings.Listing" }, "type": "array" } }, "type": "object" }, "listings.Listing": { "properties": { "content": { "$ref": "#/components/schemas/listings.ListingContent" }, "created_at": { "description": "TODO open, change to unix timestamp?", "type": "string" }, "id": { "type": "string" }, "kind": { "type": "integer" }, "public_key": { "type": "string" }, "recipient_public_key": { "type": "string" }, "reply_url": { "type": "string" }, "root_id": { "type": "string" }, "sig": { "type": "string" }, "tags": { "items": { "items": { "type": "string" }, "type": "array" }, "type": "array" }, "thread_id": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "listings.ListingAttributes": { "properties": { "coo": { "type": "string" }, "currency": { "type": "string" }, "custom": { "additionalProperties": true, "description": "user-defined", "type": "object" }, "date_code": { "type": "string" }, "description": { "type": "string" }, "eccn": { "type": "string" }, "lot_no": { "type": "string" }, "moq": { "type": "integer" }, "mpq": { "type": "integer" }, "packaging": { "type": "string" } }, "type": "object" }, "listings.ListingBatch": { "properties": { "batch_count": { "description": "Number of Listings Published", "type": "integer" }, "batch_id": { "description": "Batch ID", "type": "string" }, "company_id": { "type": "string" }, "created_at": { "type": "string" }, "headers_norm": { "items": { "type": "string" }, "type": "array" }, "headers_raw": { "items": { "type": "string" }, "type": "array" }, "name": { "description": "File Name", "type": "string" }, "publish_public_key": { "description": "Publisher Public Key", "type": "string" }, "publish_urls": { "description": "Node URL's batch was published to", "items": { "type": "string" }, "type": "array" }, "upload_public_key": { "type": "string" } }, "type": "object" }, "listings.ListingContact": { "properties": { "methods": { "items": { "type": "string" }, "type": "array" }, "reply_url": { "type": "string" } }, "type": "object" }, "listings.ListingContent": { "properties": { "attributes": { "allOf": [ { "$ref": "#/components/schemas/listings.ListingAttributes" } ], "description": "Meta Attribibutes", "type": "object" }, "batch_id": { "description": "Batch ID (Optional)", "type": "string" }, "company": { "description": "Default: Publish Company Name", "type": "string" }, "contact": { "$ref": "#/components/schemas/listings.ListingContact" }, "encrypted": { "$ref": "#/components/schemas/listings.SecureField" }, "errors": { "additionalProperties": { "type": "string" }, "description": "Error field for parsing", "type": "object" }, "image_url": { "type": "string" }, "internal_no": { "description": "Internal Number (Optional)", "type": "string" }, "material_no": { "description": "Mandatory upload fields", "type": "string" }, "mfr": { "description": "Manufacturer (Required)", "type": "string" }, "qty": { "description": "Quantity (Required)", "type": "integer" }, "timing": { "allOf": [ { "$ref": "#/components/schemas/listings.ListingTiming" } ], "description": "Timing (Optional)", "type": "object" }, "type": { "description": "\"supply\" or \"demand\"", "type": "string" }, "unit_price": { "description": "Unit Price (Required)", "type": "number" } }, "type": "object" }, "listings.ListingTiming": { "properties": { "expiry": { "type": "integer" }, "lead_time": { "type": "string" }, "lead_time_int": { "type": "integer" }, "required_date": { "type": "integer" } }, "type": "object" }, "listings.SecureField": { "properties": { "ciphertext": { "type": "string" }, "payload": { "additionalProperties": true, "type": "object" } }, "type": "object" }, "listings.deleteListingsRequest": { "properties": { "ids": { "items": { "type": "string" }, "type": "array" }, "urls": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "listings.publishListingsRequest": { "properties": { "listings": { "items": { "$ref": "#/components/schemas/listings.ListingContent" }, "type": "array" }, "urls": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "loadtest.LoadTestConfig": { "properties": { "batch_size": { "description": "Events per write batch", "type": "integer" }, "filters": { "description": "Predefined NSCS test filters", "items": { "$ref": "#/components/schemas/sevent.Filter" }, "type": "array" }, "read_throughput_per_sec": { "description": "Target reads per second", "type": "integer" }, "read_write_ratio": { "description": "25:1 ratio for NSCS protocol", "type": "integer" }, "relay_urls": { "description": "NSCS relay URLs (inbox relays)", "items": { "type": "string" }, "type": "array" }, "reply_url": { "description": "Reply URL for test events", "type": "string" }, "test_duration_seconds": { "description": "Duration to run test", "type": "integer" }, "test_event_count": { "description": "Number of test events to generate", "type": "integer" }, "user_public_key": { "description": "Test data generation parameters", "type": "string" }, "vendor_name": { "description": "Vendor name for test events", "type": "string" } }, "type": "object" }, "loadtest.LoadTestResults": { "properties": { "cpu_usage_percent": { "type": "number" }, "duration": { "$ref": "#/components/schemas/time.Duration" }, "end_time": { "type": "string" }, "error_count": { "type": "integer" }, "memory_usage_mb": { "type": "number" }, "read_latency_ms": { "items": { "type": "number" }, "type": "array" }, "read_throughput_per_sec": { "type": "number" }, "start_time": { "type": "string" }, "total_reads": { "type": "integer" }, "total_writes": { "type": "integer" }, "write_latency_ms": { "items": { "type": "number" }, "type": "array" }, "write_throughput_per_sec": { "type": "number" } }, "type": "object" }, "mapping.Application": { "enum": [ "listings_export", "listings_import" ], "type": "string", "x-enum-varnames": [ "ApplicationListingsExport", "ApplicationListingsImport" ] }, "mapping.CompanyMapping": { "properties": { "applications": { "items": { "$ref": "#/components/schemas/mapping.Application" }, "type": "array" }, "company_id": { "type": "string" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "fields": { "items": { "$ref": "#/components/schemas/mapping.FieldMapping" }, "type": "array" }, "id": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/mapping.MappingMetadata" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/mapping.MappingType" }, "updated_at": { "type": "string" } }, "type": "object" }, "mapping.FieldMapping": { "properties": { "aliases": { "items": { "type": "string" }, "type": "array" }, "required": { "type": "boolean" }, "source": { "type": "string" }, "target": { "type": "string" } }, "type": "object" }, "mapping.Mapping": { "properties": { "applications": { "items": { "$ref": "#/components/schemas/mapping.Application" }, "type": "array" }, "description": { "type": "string" }, "fields": { "items": { "$ref": "#/components/schemas/mapping.FieldMapping" }, "type": "array" }, "id": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/mapping.MappingMetadata" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/mapping.MappingType" } }, "type": "object" }, "mapping.MappingMetadata": { "properties": { "normalization": { "$ref": "#/components/schemas/mapping.NormalizationMetadata" } }, "type": "object" }, "mapping.MappingType": { "enum": [ "listing", "quote", "response" ], "type": "string", "x-enum-varnames": [ "TypeListing", "TypeQuote", "TypeResponse" ] }, "mapping.NormalizationMetadata": { "properties": { "applied_to": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" }, "strategy": { "type": "string" } }, "type": "object" }, "nodeconn.NodeConnStatus": { "properties": { "id": { "description": "Node Connection ID", "type": "string" }, "message": { "description": "Message recieved by the Node if the connection failed", "type": "string" }, "name": { "description": "Node Connection Name", "type": "string" }, "read": { "description": "Non-authoritative check if you have read permissions", "type": "string" }, "status": { "description": "Node Connection Status, true or false", "type": "boolean" }, "url": { "description": "Node Connection URL 'wss://node.domain.com/node'", "type": "string" }, "write": { "description": "Non-authoritative check if you have write permissions", "type": "string" } }, "type": "object" }, "nodeconn.PartialNodeConn": { "properties": { "name": { "description": "Node Connection Name", "type": "string" }, "url": { "description": "Node URL 'wss://node.domain.com/node'", "type": "string" }, "writeable": { "description": "writebale = true for posting, writeable = false for querying", "type": "boolean" } }, "type": "object" }, "nodes.NodeDeployment": { "properties": { "company_id": { "type": "string" }, "contact": { "type": "string" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "discoverable": { "type": "boolean" }, "expires_at": { "type": "string" }, "id": { "type": "string" }, "is_active": { "type": "boolean" }, "max_event_count": { "type": "integer" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "owner_public_key": { "type": "string" }, "read_auth": { "type": "boolean" }, "updated_at": { "type": "string" }, "write_auth": { "type": "boolean" } }, "type": "object" }, "nodes.NodeDeploymentProfile": { "properties": { "company_name": { "type": "string" }, "contact": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "read_auth": { "type": "boolean" }, "url": { "type": "string" }, "write_auth": { "type": "boolean" } }, "type": "object" }, "nodes.NodeDeploymentResponse": { "properties": { "deployment": { "$ref": "#/components/schemas/nodes.NodeDeployment" }, "url": { "type": "string" } }, "type": "object" }, "nodes.PartialNodeDeployment": { "properties": { "contact": { "type": "string" }, "description": { "type": "string" }, "discoverable": { "type": "boolean" }, "name": { "type": "string" }, "read_auth": { "type": "boolean" }, "write_auth": { "type": "boolean" } }, "type": "object" }, "nodes.updateNodeDeploymentRequest": { "properties": { "contact": { "type": "string" }, "description": { "type": "string" }, "discoverable": { "type": "boolean" }, "read_auth": { "type": "boolean" }, "write_auth": { "type": "boolean" } }, "type": "object" }, "partner.ExternalPartnerUpdate": { "properties": { "contact": { "type": "string" }, "emails": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "partner.Partner": { "properties": { "company_id": { "type": "string" }, "company_name": { "type": "string" }, "contact": { "type": "string" }, "created_at": { "type": "string" }, "domain": { "description": "External Partner Fields", "type": "string" }, "emails": { "items": { "type": "string" }, "type": "array" }, "id": { "type": "string" }, "public_key": { "type": "string" }, "reference_company_id": { "description": "For Internal partners", "type": "string" }, "status": { "type": "string" }, "type": { "description": "\"external\" - distinguishes from internal partners", "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "permissions.PartialPermissionsRequest": { "properties": { "message": { "type": "string" } }, "type": "object" }, "permissions.Permission": { "properties": { "manage": { "type": "boolean" }, "public_key": { "type": "string" }, "read": { "type": "boolean" }, "write": { "type": "boolean" } }, "type": "object" }, "permissions.PermissionsRequest": { "properties": { "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "id": { "type": "string" }, "message": { "type": "string" }, "node_id": { "type": "string" }, "recipient_company_id": { "type": "string" }, "recipient_company_name": { "type": "string" }, "recipient_status": { "type": "string" }, "request_status": { "type": "string" }, "requested_public_key": { "type": "string" }, "sender_company_id": { "type": "string" }, "sender_name": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "permissions.UpdateRecipientPermissionRequest": { "properties": { "read": { "type": "boolean" }, "status": { "type": "string" }, "write": { "type": "boolean" } }, "type": "object" }, "permissions.permissionsRequestResponse": { "properties": { "received": { "items": { "$ref": "#/components/schemas/permissions.PermissionsRequest" }, "type": "array" }, "sent": { "items": { "$ref": "#/components/schemas/permissions.PermissionsRequest" }, "type": "array" } }, "type": "object" }, "refdata.CreateRecordSetFromFileRequest": { "properties": { "headerMappings": { "additionalProperties": { "type": "string" }, "type": "object" }, "recordSetID": { "type": "string" } }, "type": "object" }, "refdata.RecordMergeResponse": { "properties": { "errors": { "items": { "type": "string" }, "type": "array" }, "matches": { "items": { "$ref": "#/components/schemas/refdata.RecordSetMatch" }, "type": "array" } }, "type": "object" }, "refdata.RecordRow": { "properties": { "id": { "type": "string" }, "record_set_id": { "type": "string" }, "values_array": { "items": { "type": "string" }, "type": "array" }, "values_map": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object" }, "refdata.RecordSet": { "properties": { "column_names": { "items": { "type": "string" }, "type": "array" }, "created_at": { "type": "string" }, "id": { "type": "string" }, "mappings": { "additionalProperties": { "type": "string" }, "description": "Maps a ColumnName key -> listing key", "type": "object" }, "metadata": { "additionalProperties": { "type": "string" }, "description": "e.g. table name, file path, version", "type": "object" }, "name": { "type": "string" }, "source": { "description": "e.g. \"excel\", \"postgres\", \"api\"", "type": "string" } }, "type": "object" }, "refdata.RecordSetMatch": { "properties": { "record_set_id": { "type": "string" }, "record_set_name": { "type": "string" }, "row_matches": { "items": { "$ref": "#/components/schemas/refdata.RowMatch" }, "type": "array" }, "source": { "type": "string" } }, "type": "object" }, "refdata.RowMatch": { "properties": { "absolute_match_path": { "type": "string" }, "match_key": { "type": "string" }, "match_value": { "type": "string" }, "row_id": { "type": "string" }, "values": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object" }, "refdata.UpdateMappingsRequest": { "properties": { "mappings": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object" }, "sevent.Filter": { "properties": { "authors": { "description": "Listing Authors's to filter on", "items": { "type": "string" }, "type": "array" }, "ids": { "description": "Listing ID's to filter on", "items": { "type": "string" }, "type": "array" }, "kinds": { "items": { "type": "integer" }, "type": "array" }, "limit": { "type": "integer" }, "search": { "type": "string" }, "since": { "description": "Listings after UNIX timestamp", "type": "integer" }, "tags": { "$ref": "#/components/schemas/sevent.Tags" }, "until": { "description": "Listings before UNIX timestamp", "type": "integer" }, "urls": { "description": "Targeted URL's to query", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "sevent.Tags": { "properties": { "addresses": { "items": { "type": "string" }, "type": "array" }, "batch_id": { "type": "string" }, "company": { "description": "Publishing organization name e.g. \"seminode electronics\"", "type": "string" }, "event_id": { "type": "string" }, "finalized": { "type": "string" }, "internal_nos": { "items": { "type": "string" }, "type": "array" }, "material_nos": { "description": "Listing Material Numbers", "items": { "type": "string" }, "type": "array" }, "mfr": { "description": "Listing Manufacturers", "type": "string" }, "recipient": { "type": "string" }, "status": { "description": "Quote Tags", "type": "string" }, "thread_id": { "type": "string" }, "type": { "description": "'supply' or 'demand'", "type": "string" } }, "type": "object" }, "subscription.ListingSubscription": { "properties": { "company_id": { "type": "string" }, "filter": { "$ref": "#/components/schemas/sevent.Filter" }, "id": { "type": "string" }, "user_id": { "type": "string" } }, "type": "object" }, "subscriptions.AllocationLimits": { "properties": { "num_node_connections": { "type": "integer" }, "num_node_deployments": { "type": "integer" } }, "type": "object" }, "subscriptions.CompanySubscription": { "properties": { "active": { "$ref": "#/components/schemas/subscriptions.SubscriptionStatus" }, "auto_renew": { "description": "Indicates if the subscription will renew automatically", "type": "boolean" }, "company_id": { "type": "string" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "overages": { "additionalProperties": { "format": "float64", "type": "number" }, "type": "object" }, "plan": { "type": "string" }, "quantity": { "type": "integer" }, "updated_at": { "type": "string" } }, "type": "object" }, "subscriptions.FeatureLimits": { "properties": { "num_api_daily_events": { "type": "integer" }, "num_api_reqs": { "type": "integer" }, "num_cleanse_lines": { "type": "integer" }, "num_file_size_mb": { "type": "number" }, "num_post_lines": { "type": "integer" } }, "type": "object" }, "subscriptions.SubscriptionPlan": { "properties": { "allocations": { "$ref": "#/components/schemas/subscriptions.AllocationLimits" }, "description": { "type": "string" }, "features": { "$ref": "#/components/schemas/subscriptions.FeatureLimits" }, "lookup_key": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "price_per_month": { "type": "number" }, "tools": { "$ref": "#/components/schemas/subscriptions.Tools" }, "trial_period_months": { "type": "integer" } }, "type": "object" }, "subscriptions.SubscriptionStatus": { "enum": [ "active", "inactive" ], "type": "string", "x-enum-varnames": [ "SubscriptionStatusActive", "SubscriptionStatusInctive" ] }, "subscriptions.Tools": { "properties": { "tool_ai_network_search": { "type": "boolean" }, "tool_network_match": { "type": "boolean" }, "tool_tariff_tracker": { "type": "boolean" } }, "type": "object" }, "subscriptions.subscriptionResponse": { "properties": { "plan": { "$ref": "#/components/schemas/subscriptions.SubscriptionPlan" }, "subscription": { "$ref": "#/components/schemas/subscriptions.CompanySubscription" } }, "type": "object" }, "time.Duration": { "enum": [ -9223372036854775808, 9223372036854775807, 1, 1000, 1000000, 1000000000, 60000000000, 3600000000000 ], "format": "int64", "type": "integer", "x-enum-varnames": [ "minDuration", "maxDuration", "Nanosecond", "Microsecond", "Millisecond", "Second", "Minute", "Hour" ] }, "usage.AllocationUsage": { "properties": { "num_listings": { "type": "integer" }, "num_node_connections": { "type": "integer" }, "num_node_deployments": { "type": "integer" }, "num_seats": { "type": "integer" } }, "type": "object" }, "usage.FeatureUsage": { "properties": { "num_api_events": { "type": "integer" }, "num_api_reqs": { "description": "DEP", "type": "integer" }, "num_cleanse_lines": { "type": "integer" }, "num_file_cleanse": { "type": "integer" }, "num_file_size_mb": { "type": "number" }, "num_file_size_mb_total": { "description": "DEP", "type": "number" }, "num_match_lines": { "description": "DEP", "type": "integer" }, "num_post_lines": { "type": "integer" } }, "type": "object" }, "usage.Usage": { "properties": { "allocations": { "$ref": "#/components/schemas/usage.AllocationUsage" }, "company_id": { "type": "string" }, "features": { "$ref": "#/components/schemas/usage.FeatureUsage" } }, "type": "object" }, "usage.aiChatUsageRequest": { "properties": { "tokens_in": { "type": "integer" }, "tokens_out": { "type": "integer" }, "total_tokens": { "type": "integer" } }, "type": "object" }, "user.CompanyUserProfile": { "properties": { "company_id": { "type": "string" }, "company_name": { "type": "string" }, "company_public_key": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "string" }, "meta": { "additionalProperties": true, "type": "object" }, "name": { "type": "string" }, "public_key": { "type": "string" }, "role": { "type": "string" } }, "type": "object" }, "user.UserCreateRequest": { "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "password": { "type": "string" }, "token": { "type": "string" } }, "type": "object" }, "user.UserLogin": { "properties": { "email": { "type": "string" }, "password": { "type": "string" } }, "type": "object" }, "utils.APIResponse": { "properties": { "data": { "type": "object" }, "errors": { "items": { "type": "string" }, "type": "array" }, "meta": { "type": "object" } }, "type": "object" }, "utils.DetailResponse": { "properties": { "detail": { "type": "string" } }, "type": "object" }, "utils.ErrorResponse": { "properties": { "error": { "type": "string" } }, "type": "object" }, "_companies_me_profile_picture_post_request": { "properties": { "file": { "description": "Profile picture file (JPEG/PNG, max 5MB)", "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" }, "_listings_reference_data_upload_post_request": { "properties": { "file": { "description": "CSV or Excel file", "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" }, "_listings_upload_post_request": { "properties": { "file": { "description": "CSV or Excel file (d10 MB by default)", "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" }, "_users__id__role_patch_request": { "properties": { "role": { "description": "New role (e.g., admin | manager | member)", "type": "string" } }, "required": [ "role" ], "type": "object" }, "bom_EditFileRequest_edit_indices_inner": { "properties": { "index": { "type": "integer" }, "new": { "$ref": "#/components/schemas/listings.ListingContent" } }, "type": "object" } }, "securitySchemes": { "BearerAuth": { "description": "Format: \"Bearer <access_token>\"", "in": "header", "name": "Authorization", "type": "apiKey" }, "LoginAuth": { "scheme": "basic", "type": "http" } } }, "servers": [ { "url": "https://api.seminode.com/v1" } ], "tags": [] }