Models

The Body_process_inbound_email_sendgrid_integrations_onboarding_post object

{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.12.9"},"components":{"schemas":{"Body_process_inbound_email_sendgrid_integrations_onboarding_post":{"properties":{"to":{"type":"string","title":"To"},"from":{"type":"string","title":"From"},"subject":{"type":"string","title":"Subject","default":""},"text":{"type":"string","title":"Text","default":""},"html":{"type":"string","title":"Html","default":""}},"type":"object","required":["to","from"],"title":"Body_process_inbound_email_sendgrid_integrations_onboarding_post"}}}}

The CallActivityCreate object

{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.12.9"},"components":{"schemas":{"CallActivityCreate":{"properties":{"number":{"type":"string","minLength":3,"title":"Number"},"direction":{"type":"string","enum":["inbound","outbound"],"title":"Direction"},"started_at":{"type":"string","format":"date-time","title":"Started At"},"talked_seconds":{"type":"integer","minimum":0,"title":"Talked Seconds","description":"Seconds SPOKEN. A missed call lasts 0."},"sip_status":{"anyOf":[{"type":"integer","maximum":699,"minimum":100},{"type":"null"}],"title":"Sip Status"},"sip_callid":{"type":"string","minLength":1,"title":"Sip Callid","description":"The Call-ID from jambonz CDR. Also the idempotency key."},"call_outcome":{"type":"string","enum":["answered","unanswered"],"title":"Call Outcome"},"call_type":{"type":"string","enum":["cold","follow_up","other"],"title":"Call Type","default":"other"},"notes":{"type":"string","title":"Notes","default":""},"contact_point_id":{"type":"string","minLength":1,"title":"Contact Point Id"},"links":{"items":{"$ref":"#/components/schemas/CallActivityLink"},"type":"array","title":"Links","default":[]}},"type":"object","required":["number","direction","started_at","talked_seconds","sip_callid","call_outcome","contact_point_id"],"title":"CallActivityCreate","description":"A finished call, as the extension's engine reports it (`FinishedCall`)."},"CallActivityLink":{"properties":{"target_type":{"type":"string","enum":["account","venue","contact","contact_point","lead"],"title":"Target Type"},"target_id":{"type":"string","title":"Target Id"}},"type":"object","required":["target_type","target_id"],"title":"CallActivityLink"}}}}

The CallActivityLink object

{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.12.9"},"components":{"schemas":{"CallActivityLink":{"properties":{"target_type":{"type":"string","enum":["account","venue","contact","contact_point","lead"],"title":"Target Type"},"target_id":{"type":"string","title":"Target Id"}},"type":"object","required":["target_type","target_id"],"title":"CallActivityLink"}}}}

The CallActivityUpdate object

{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.12.9"},"components":{"schemas":{"CallActivityUpdate":{"properties":{"call_type":{"anyOf":[{"type":"string","enum":["cold","follow_up","other"]},{"type":"null"}],"title":"Call Type"},"call_outcome":{"anyOf":[{"type":"string","enum":["answered","unanswered"]},{"type":"null"}],"title":"Call Outcome"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes"}},"type":"object","title":"CallActivityUpdate","description":"What the salesperson adjusts on save: the type, the outcome and the notes."}}}}

The ConfirmPaymentRequest object

{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.12.9"},"components":{"schemas":{"ConfirmPaymentRequest":{"properties":{"bookingReference":{"type":"string","title":"Bookingreference"},"bookingToken":{"type":"string","title":"Bookingtoken"},"paymentMethodId":{"type":"string","title":"Paymentmethodid"},"intentType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Intenttype"},"paymentIntentId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Paymentintentid"}},"type":"object","required":["bookingReference","bookingToken","paymentMethodId"],"title":"ConfirmPaymentRequest","description":"Payload sent by web-app's /pay/resdiary page (camelCase)."}}}}

The ConfirmPaymentResponse object

{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.12.9"},"components":{"schemas":{"ConfirmPaymentResponse":{"properties":{"status":{"type":"string","title":"Status"},"bookingStatus":{"type":"string","title":"Bookingstatus"},"bookingReference":{"type":"string","title":"Bookingreference"}},"type":"object","required":["status","bookingStatus","bookingReference"],"title":"ConfirmPaymentResponse"}}}}

The CreateTokenRequest object

{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.12.9"},"components":{"schemas":{"CreateTokenRequest":{"properties":{"client_id":{"type":"string","title":"Client Id"},"client_secret":{"type":"string","title":"Client Secret"},"grant_type":{"type":"string","title":"Grant Type"},"code":{"type":"string","title":"Code"}},"type":"object","required":["client_id","client_secret","grant_type","code"],"title":"CreateTokenRequest"}}}}

The CreateWhatsappMessageRequest object

{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.12.9"},"components":{"schemas":{"CreateWhatsappMessageRequest":{"properties":{"customer_id":{"type":"string","title":"Customer Id"},"destination_phone":{"type":"string","pattern":"^\\+\\d{5,15}$","title":"Destination Phone","description":"Phone number in E164 format"},"message_type":{"type":"string","enum":["booking_created","booking_cancelled","booking_updated"],"title":"Message Type"},"booking_data":{"additionalProperties":true,"type":"object","title":"Booking Data"}},"type":"object","required":["customer_id","destination_phone","message_type","booking_data"],"title":"CreateWhatsappMessageRequest"}}}}

The HTTPValidationError object

{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.12.9"},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}

The InboundEmailResponse object

{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.12.9"},"components":{"schemas":{"InboundEmailResponse":{"properties":{"status":{"type":"string","title":"Status"},"request_id":{"type":"string","title":"Request Id"},"integration_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Integration Ids"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"type":"object","required":["status","request_id"],"title":"InboundEmailResponse"}}}}

The IncomingCallData object

{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.12.9"},"components":{"schemas":{"IncomingCallData":{"properties":{"contactPhone":{"type":"string","title":"Contactphone","description":"Phone number in E164 format"},"queue":{"anyOf":[{"type":"string"},{"type":"integer"}],"title":"Queue"},"mainPhone":{"type":"string","title":"Mainphone","description":"Phone number in E164 format"}},"type":"object","required":["contactPhone","queue","mainPhone"],"title":"IncomingCallData"}}}}

The MessageDataResponse object

{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.12.9"},"components":{"schemas":{"MessageDataResponse":{"properties":{"id":{"type":"string","title":"Id"},"status":{"$ref":"#/components/schemas/WhatsAppMessageStatus"},"created":{"type":"string","format":"date-time","title":"Created"}},"type":"object","required":["id","status","created"],"title":"MessageDataResponse"},"WhatsAppMessageStatus":{"type":"string","enum":["deleted","delivered","failed","read","sent","warning","created"],"title":"WhatsAppMessageStatus","description":"Delivery status of a WhatsApp message.\n\n`CREATED` has been added by us to mark locally-created messages with no\nfeedback status from WhatsApp yet."}}}}

The NewMessageResponse object

{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.12.9"},"components":{"schemas":{"NewMessageResponse":{"properties":{"message_id":{"type":"string","title":"Message Id"}},"type":"object","required":["message_id"],"title":"NewMessageResponse"}}}}

The RevokeTokenRequest object

{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.12.9"},"components":{"schemas":{"RevokeTokenRequest":{"properties":{"client_id":{"type":"string","title":"Client Id"},"client_secret":{"type":"string","title":"Client Secret"},"token":{"type":"string","title":"Token"}},"type":"object","required":["client_id","client_secret","token"],"title":"RevokeTokenRequest"}}}}

The ValidationError object

{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.12.9"},"components":{"schemas":{"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}

The WhatsAppMessageStatus object

{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.12.9"},"components":{"schemas":{"WhatsAppMessageStatus":{"type":"string","enum":["deleted","delivered","failed","read","sent","warning","created"],"title":"WhatsAppMessageStatus","description":"Delivery status of a WhatsApp message.\n\n`CREATED` has been added by us to mark locally-created messages with no\nfeedback status from WhatsApp yet."}}}}