@zenpatient-org/honeybee-client
v2.0.3
Published
OpenAPI client for @zenpatient-org/honeybee-client
Downloads
1,770
Readme
honeybee client
This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:
Environment
- Node.js
- Webpack
- Browserify
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)
Building
To build and compile the typescript sources to javascript use:
npm install
npm run buildPublishing
First build the package then run npm publish
Consuming
navigate to the folder of your consuming project and run one of the following commands.
published:
npm install @zenpatient-org/[email protected] --saveunPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --saveDocumentation for API Endpoints
All URIs are relative to https://partners.honeybeehealth.com/v1
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AccountApi | getAccountInformation | GET /account | Get Account Information OrderActionsApi | getOrderActions | GET /order_actions | Get All Available Order Actions OrdersApi | cancelOrder | DELETE /orders/{order_number} | Cancel Order OrdersApi | createOrder | POST /orders | Create New Order OrdersApi | getOrder | GET /orders/{order_number} | Get Order OrdersApi | getOrders | GET /orders | Get All Orders OrdersApi | ordersOrderNumberPartnerOrderActionRequestsGet | GET /orders/{order_number}/partner_order_action_requests | Get Partner Order Action Requests on Order OrdersApi | ordersOrderNumberPartnerOrderActionRequestsPost | POST /orders/{order_number}/partner_order_action_requests | Submit New Partner Order Action Request OrdersApi | ordersOrderNumberReordersPost | POST /orders/{order_number}/reorders | Reorder a previously shipped order OrdersApi | ordersOrderNumberShippingAddressPut | PUT /orders/{order_number}/shipping_address | Put Order Shipping Address OrdersApi | updateOrder | PATCH /orders/{order_number} | Update Order PatientsApi | createPatientAddress | POST /patients/{patient_id}/shipping_address | Add Patient Address PatientsApi | createPatientIdentityDocument | POST /patients/{patient_id}/identity_documents | Create a new Identity Document for a Patient PatientsApi | deletePatientAddress | DELETE /patients/{patient_id}/shipping_address/{address_id} | Delete Patient Address PatientsApi | deletePatientIdentityDocument | DELETE /patients/{patient_id}/identity_documents/{document_id} | Delete an Identity Document for a Patient PatientsApi | getPatient | GET /patients/{patient_id} | Get Patient Info PatientsApi | getPatientIdentityDocument | GET /patients/{patient_id}/identity_documents/{document_id} | Get Patient Identity Documents By ID PatientsApi | getPatientIdentityDocuments | GET /patients/{patient_id}/identity_documents | Get All Patient Identity Documents PatientsApi | getPatientMedication | GET /patients/{patient_id}/rx/{rx_id} | Get Patient Prescription PatientsApi | getPatientRx | GET /patients/{patient_id}/rx | Get All Patient Prescriptions PatientsApi | patientsPatientIdPatientSafetyDelete | DELETE /patients/{patient_id}/patient_safety | Remove Patient Safety Data PatientsApi | patientsPatientIdPatientSafetyPost | POST /patients/{patient_id}/patient_safety | Add Patient Safety Data PatientsApi | updatePatient | PUT /patients/{patient_id} | Update Patient PatientsApi | updatePatientIdentityDocument | PATCH /patients/{patient_id}/identity_documents/{document_id} | Update an Identity Document for a Patient ProductsApi | getProducts | GET /products | Get All Products with Price Information RefundReasonsApi | getRefundReasons | GET /refund_reasons | Get All Available Refund Reasons ReplacementReasonsApi | getReplacementReasons | GET /replacement_reasons | Get All Available Replacement Reasons SandboxApi | simulateEvent | POST /simulate | Simulate Event ShippingMethodsApi | getShippingMethods | GET /shipping_methods | Get All Available Shipping Methods
Documentation For Models
- Account
- Account1
- Address
- Address1
- Address2
- Address3
- AddressRequest
- AddressSuggestion
- AddressSuggestionDetail
- AddressSuggestionDetailAddressComponentsInner
- AddressSuggestionStructuredFormatting
- AddressSuggestionTermsInner
- AddressValidate
- AddressValidateMatchedAddress
- AddressValidateOriginalAddress
- AddressValidateWarningMessagesInner
- ApiMedicationDispense
- ApiMedicationRequest
- ApiMedicationRequestWithDispenses
- ApiMedicationRequestWithDispensesAllOfMedicationDispenses
- BadRequestError
- Brand
- Brand1
- Brand2
- ClientApplication
- ConflictingRequestError
- ConflictingRequestError1
- ConflictingRequestError1Error
- CreateClientApplicationBody
- CreateClientApplicationResponse
- CreateOrder201Response
- CreateOrderRequest
- CreateOrderRequestAddress
- CreateOrderRequestItemsInner
- CreateOrderRequestPatient
- CreateOrderRequestShipping
- Error1
- Error1ErrorsInner
- Error1ErrorsInnerErrorDetailInner
- Error2
- Error2ErrorsInner
- ExistingPatient
- GetOrderActions200Response
- GetOrders200Response
- GetPatientIdentityDocuments200Response
- GetPatientRx200Response
- GetPatientRx200ResponseMedicationRequestsInner
- GetPatientRx200ResponseMedicationRequestsInnerAllOfMedicationDispensesInner
- GetRefundReasons200Response
- GetReplacementReasons200Response
- GetShippingMethods200Response
- IdentityDocument
- IdentityDocument1
- IdentityDocumentRequest
- IdentityDocumentRequest1
- MedicationDispense
- ModelError
- NewPatient
- Order
- Order1
- Order1Replace
- OrderAction
- OrderAction1
- OrderException
- OrderException1
- OrderExtended
- OrderExtended1
- OrderFee
- OrderFee1
- OrderItem
- OrderItem1
- OrderItem1ItemScansInner
- OrderStatus
- OrderStatusEvent
- OrderStatusEvent1
- OrderStatusEventResponse
- OrderStatusEventResponse1
- OrderWarnings
- OrderWarnings1
- OrderWarnings1AddressInner
- OrderWarnings1AddressInnerSuggestedAddress
- OrdersOrderNumberReordersPostRequest
- OrdersOrderNumberReordersPostRequestAddress
- OrdersOrderNumberReordersPostRequestItemsInner
- OrdersOrderNumberReordersPostRequestShipping
- Patient
- Patient1
- Patient2
- PatientSafety
- PatientUpdateBody
- PatientUpdateRequestBody
- PostRx
- PostRxMessage
- PostRxMessageBody
- PostRxMessageBodyNewRx
- PostRxMessageBodyNewRxMedicationPrescribed
- PostRxMessageBodyNewRxMedicationPrescribedDrugCoded
- PostRxMessageBodyNewRxMedicationPrescribedDrugCodedDrugDbCode
- PostRxMessageBodyNewRxMedicationPrescribedDrugCodedProductCode
- PostRxMessageBodyNewRxMedicationPrescribedQuantity
- PostRxMessageBodyNewRxMedicationPrescribedQuantityQuantityUnitOfMeasure
- PostRxMessageBodyNewRxMedicationPrescribedSig
- PostRxMessageBodyNewRxPatient
- PostRxMessageBodyNewRxPatientHumanPatient
- PostRxMessageBodyNewRxPatientHumanPatientAddress
- PostRxMessageBodyNewRxPatientHumanPatientCommunicationNumbers
- PostRxMessageBodyNewRxPatientHumanPatientCommunicationNumbersPrimaryTelephone
- PostRxMessageBodyNewRxPatientHumanPatientDateOfBirth
- PostRxMessageBodyNewRxPatientHumanPatientName
- PostRxMessageBodyNewRxPharmacy
- PostRxMessageBodyNewRxPharmacyCommunicationNumbers
- PostRxMessageBodyNewRxPharmacyIdentification
- PostRxMessageBodyNewRxPrescriber
- PostRxMessageBodyNewRxPrescriberNonVeterinarian
- PostRxMessageBodyNewRxPrescriberNonVeterinarianAddress
- PostRxMessageBodyNewRxPrescriberNonVeterinarianIdentification
- PostRxMessageBodyNewRxPrescriberNonVeterinarianPracticeLocation
- Product
- Product1
- Product1PricesInner
- PutOrderShippingAddress
- PutOrderShippingAddressAddress
- RefundReason
- RefundReason1
- ReplacementReason
- ReplacementReason1
- RxReceivedMedicationRequest
- RxUpdatedMedicationRequest
- RxUpdatedWebhook
- RxUpdatedWebhookAllOfMedicationDispenses
- Shipment
- Shipment1
- Shipment2
- ShipmentUpdate
- ShipmentUpdate1
- ShipmentUpdate2
- ShipmentUpdate3
- ShipmentUpdate4
- ShippingMethod
- ShippingMethod1
- ShippingMethod2
- ShippingMethodOptions
- ShippingMethodOptions1
- SimulateEvent
- SimulateEvent1
- SimulateEvent1Simulation
- SimulateEvent1SimulationMedicationRequestsInner
- UpdateOrderBody
- UpdateOrderBody1
- UpdateOrderBody1Address
- UpdateOrderBody1ItemsInner
- UpdateOrderBody1Shipping
- VerifyUserRequestBody
- Webhook
- WebhookEvent
- WebhookMedicationDispense
- WebhookMedicationRequestWithDispenses
- WebhookMedicationRequestWithDispensesAllOfMedicationDispenses
- WebhookMedicationRequestWithDispensesAllOfMedicationDispensesAllOfShipment
- WebhookRxReceivedMedicationRequest
- WebhookRxUpdatedMedicationDispense
- WebhookShipment
- WithAGCN
- WithAGCNPrescriber
- WithANDC
- WithASKU
- WithASKUPrescriber
- WithOnlyAPrescriptionID
Documentation For Authorization
Authentication schemes defined for the API:
OAuth2
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes: N/A
