Python SDK methods for Communications operations
Method | HTTP request | Description |
---|---|---|
accept_quote | PUT /communications/quotes//accept | Accept Quote |
confirm_quote | PUT /communications/quotes//confirm | Confirm Quote |
create_quote | POST /communications/quotes | Create Quote |
create_rfq | POST /communications/rfqs | Create RFQ |
delete_quote | DELETE /communications/quotes/ | Delete Quote |
delete_rfq | DELETE /communications/rfqs/ | Delete RFQ |
get_communications_id | GET /communications/id | Get Communications ID |
get_quote | GET /communications/quotes/ | Get Quote |
get_quotes | GET /communications/quotes | Get Quotes |
get_rfq | GET /communications/rfqs/ | Get RFQ |
get_rfqs | GET /communications/rfqs | Get RFQs |
accept_quote(quote_id, accept_quote_request)Accept Quote Accept a quote. This will require the quoter to confirm
Name | Type | Description | Notes |
---|---|---|---|
quote_id | str | Quote ID | |
accept_quote_request | AcceptQuoteRequest |
Status code | Description |
---|---|
204 | Quote accepted successfully |
400 | Bad request - invalid input |
401 | Unauthorized - authentication required |
404 | Resource not found |
500 | Internal server error |
confirm_quote(quote_id)Confirm Quote Confirm a quote. This will start a timer for order execution
Name | Type | Description | Notes |
---|---|---|---|
quote_id | str | Quote ID |
Status code | Description |
---|---|
204 | Quote confirmed successfully |
401 | Unauthorized - authentication required |
404 | Resource not found |
500 | Internal server error |
CreateQuoteResponse create_quote(create_quote_request)Create Quote Create a quote in response to an RFQ
Name | Type | Description | Notes |
---|---|---|---|
create_quote_request | CreateQuoteRequest |
Status code | Description |
---|---|
201 | Quote created successfully |
400 | Bad request - invalid input |
401 | Unauthorized - authentication required |
500 | Internal server error |
CreateRFQResponse create_rfq(create_rfq_request)Create RFQ Create a new RFQ
Name | Type | Description | Notes |
---|---|---|---|
create_rfq_request | CreateRFQRequest |
Status code | Description |
---|---|
201 | RFQ created successfully |
400 | Bad request - invalid input |
401 | Unauthorized - authentication required |
500 | Internal server error |
delete_quote(quote_id)Delete Quote Delete a quote, which means it can no longer be accepted
Name | Type | Description | Notes |
---|---|---|---|
quote_id | str | Quote ID |
Status code | Description |
---|---|
204 | Quote deleted successfully |
401 | Unauthorized - authentication required |
404 | Resource not found |
500 | Internal server error |
delete_rfq(rfq_id)Delete RFQ Delete an RFQ by ID
Name | Type | Description | Notes |
---|---|---|---|
rfq_id | str | RFQ ID |
Status code | Description |
---|---|
204 | RFQ deleted successfully |
401 | Unauthorized - authentication required |
404 | Resource not found |
500 | Internal server error |
GetCommunicationsIDResponse get_communications_id()Get Communications ID Get the communications ID of the logged-in user
Status code | Description |
---|---|
200 | Communications ID retrieved successfully |
401 | Unauthorized - authentication required |
500 | Internal server error |
GetQuoteResponse get_quote(quote_id)Get Quote Get a particular quote by ID
Name | Type | Description | Notes |
---|---|---|---|
quote_id | str | Quote ID |
Status code | Description |
---|---|
200 | Quote retrieved successfully |
401 | Unauthorized - authentication required |
404 | Resource not found |
500 | Internal server error |
GetQuotesResponse get_quotes()Get Quotes Retrieve all quotes
Status code | Description |
---|---|
200 | Quotes retrieved successfully |
401 | Unauthorized - authentication required |
500 | Internal server error |
GetRFQResponse get_rfq(rfq_id)Get RFQ Get a single RFQ by ID
Name | Type | Description | Notes |
---|---|---|---|
rfq_id | str | RFQ ID |
Status code | Description |
---|---|
200 | RFQ retrieved successfully |
401 | Unauthorized - authentication required |
404 | Resource not found |
500 | Internal server error |
GetRFQsResponse get_rfqs()Get RFQs Retrieve all RFQs
Status code | Description |
---|---|
200 | RFQs retrieved successfully |
401 | Unauthorized - authentication required |
500 | Internal server error |