From 0dfbbd660849ab138c3b9e51d2922c4dca47874d Mon Sep 17 00:00:00 2001 From: Sergey Kovalskiy Date: Tue, 11 Mar 2025 18:09:00 +0200 Subject: [PATCH 01/20] chore: update schema and openapi generator --- .github/workflows/python.yml | 10 +- CHANGELOG.md | 7 + Makefile | 19 +- README.md | 5 + poetry.lock | 671 ++- pyproject.toml | 32 +- pywaybiller/client.py | 28 +- pywaybiller/docs/BlankEnum.md | 10 + pywaybiller/docs/DestinationsApi.md | 98 +- .../docs/DestinationsList200Response.md | 31 - .../docs/DestinationsList403Response.md | 29 + pywaybiller/docs/EmploymentsApi.md | 126 +- .../docs/EmploymentsList200Response.md | 31 - .../docs/EmploymentsRetrieve404Response.md | 29 + pywaybiller/docs/ExtAPIDestination.md | 35 - pywaybiller/docs/ExtAPIHoldingBase.md | 32 - .../docs/ExtAPIHoldingBasePreviousOwner.md | 30 - pywaybiller/docs/ExtAPIHoldingBaseRead.md | 32 - pywaybiller/docs/ExtAPIOriginAssortment.md | 29 - pywaybiller/docs/ExtAPIOriginList.md | 33 - pywaybiller/docs/ExternalAPIDestination.md | 36 + .../docs/ExternalAPIDestinationRawData.md | 29 + pywaybiller/docs/ExternalAPIEmployment.md | 25 +- pywaybiller/docs/ExternalAPIHoldingBase.md | 32 + .../ExternalAPIHoldingBasePreviousOwner.md | 31 + ...ernalAPIHoldingBasePreviousOwnerRequest.md | 31 + .../docs/ExternalAPIHoldingBaseRead.md | 32 + .../docs/ExternalAPIHoldingBaseRequest.md | 32 + .../docs/ExternalAPILoaderActionLog.md | 35 +- .../docs/ExternalAPILoaderActionLogComment.md | 13 +- .../docs/ExternalAPILoaderActionLogRawData.md | 22 +- pywaybiller/docs/ExternalAPIOrder.md | 19 +- pywaybiller/docs/ExternalAPIOrderCreate.md | 19 +- .../docs/ExternalAPIOrderCreateRequest.md | 47 + pywaybiller/docs/ExternalAPIOrderList.md | 23 +- pywaybiller/docs/ExternalAPIOrderOrigin.md | 6 +- .../docs/ExternalAPIOrderOriginRequest.md | 35 + .../ExternalAPIOrderOriginsAssortments.md | 8 +- ...ternalAPIOrderOriginsAssortmentsRequest.md | 29 + pywaybiller/docs/ExternalAPIOrderRawData.md | 26 +- .../ExternalAPIOrderTransportCompanies.md | 6 +- ...ternalAPIOrderTransportCompaniesRequest.md | 30 + pywaybiller/docs/ExternalAPIOrderUpdate.md | 9 +- .../docs/ExternalAPIOrderUpdateRequest.md | 46 + pywaybiller/docs/ExternalAPIOrderVehicles.md | 6 +- .../docs/ExternalAPIOrderVehiclesRequest.md | 31 + .../docs/ExternalAPIOriginAssortment.md | 17 +- .../docs/ExternalAPIOriginAssortmentRaw.md | 33 - .../ExternalAPIOriginAssortmentRawData.md | 33 + .../ExternalAPIOriginAssortmentRequest.md | 30 + ...iginRead.md => ExternalAPIOriginCreate.md} | 31 +- .../docs/ExternalAPIOriginCreateRequest.md | 51 + ...riginCreateWaybillCreatedEmailsLanguage.md | 28 + pywaybiller/docs/ExternalAPIOriginList.md | 34 + pywaybiller/docs/ExternalAPIOriginRawData.md | 30 + ...iginCreate.md => ExternalAPIOriginRead.md} | 31 +- ...inUpdate.md => ExternalAPIOriginUpdate.md} | 31 +- .../docs/ExternalAPIOriginUpdateRequest.md | 50 + .../docs/ExternalAPIPartialOrderUpdate.md | 5 +- .../ExternalAPIPartialOrderUpdateRequest.md | 30 + pywaybiller/docs/ExternalAPIRawSerializer.md | 28 - pywaybiller/docs/ExternalAPITransportOrder.md | 19 +- .../docs/ExternalAPITransportOrderCancel.md | 5 +- .../ExternalAPITransportOrderCancelRequest.md | 30 + .../docs/ExternalAPITransportOrderList.md | 11 +- .../docs/ExternalAPITransportOrderRawData.md | 21 +- .../ExternalAPITransportOrderRawDataList.md | 15 +- .../docs/ExternalAPITransportOrderRequest.md | 69 + .../docs/ExternalAPITransportOrderRow.md | 5 +- .../ExternalAPITransportOrderRowRawData.md | 7 +- .../ExternalAPITransportOrderRowRequest.md | 31 + .../docs/ExternalAPITransportOrderUpdate.md | 5 +- .../ExternalAPITransportOrderUpdateRequest.md | 47 + pywaybiller/docs/ExternalAPIVehicle.md | 17 +- .../docs/ExternalAPIVehicleLocationData.md | 23 +- .../ExternalAPIVehicleLocationDataRawData.md | 14 +- ...cationDataVehicleLocationDataInnerValue.md | 28 + pywaybiller/docs/ExternalAPIWaybillAccept.md | 5 +- .../docs/ExternalAPIWaybillAcceptRequest.md | 31 + .../docs/ExternalAPIWaybillAcceptedAmounts.md | 5 +- ...xternalAPIWaybillAcceptedAmountsRequest.md | 29 + pywaybiller/docs/ExternalAPIWaybillCancel.md | 5 +- .../docs/ExternalAPIWaybillCancelRequest.md | 30 + ...md => ExternalAPIWaybillCommentRequest.md} | 17 +- pywaybiller/docs/ExternalAPIWaybillCreate.md | 50 +- .../docs/ExternalAPIWaybillCreateRequest.md | 65 + .../ExternalAPIWaybillDispatchedAmounts.md | 5 +- ...ernalAPIWaybillDispatchedAmountsRequest.md | 29 + .../docs/ExternalAPIWaybillFinishDrive.md | 28 - .../ExternalAPIWaybillFinishDriveRequest.md | 29 + .../docs/ExternalAPIWaybillHoldingRight.md | 30 + .../ExternalAPIWaybillHoldingRightRequest.md | 30 + pywaybiller/docs/ExternalAPIWaybillList.md | 55 +- pywaybiller/docs/ExternalAPIWaybillRawData.md | 20 +- .../docs/ExternalAPIWaybillRawDataList.md | 10 +- pywaybiller/docs/ExternalAPIWaybillRefuse.md | 5 +- .../docs/ExternalAPIWaybillRefuseRequest.md | 30 + .../docs/ExternalAPIWaybillRetrieve.md | 87 +- pywaybiller/docs/ExternalAPIWaybillRow.md | 17 +- .../ExternalAPIWaybillRowAcceptedAmount.md | 11 +- ...ernalAPIWaybillRowAcceptedAmountRequest.md | 33 + .../ExternalAPIWaybillRowDispatchedAmount.md | 10 +- ...nalAPIWaybillRowDispatchedAmountRequest.md | 32 + pywaybiller/docs/ExternalAPIWaybillRowList.md | 17 +- .../docs/ExternalAPIWaybillRowRawData.md | 12 +- .../docs/ExternalAPIWaybillRowRequest.md | 35 + .../docs/ExternalAPIWaybillStartDrive.md | 5 +- .../ExternalAPIWaybillStartDriveRequest.md | 31 + .../docs/ExternalAPIWaybillVehicleLocation.md | 11 +- pywaybiller/docs/GeoLocation.md | 9 +- pywaybiller/docs/GeoLocationRequest.md | 31 + pywaybiller/docs/LanguageEnum.md | 25 + pywaybiller/docs/LoaderActionLogsApi.md | 74 +- .../docs/LoaderActionLogsList200Response.md | 31 - pywaybiller/docs/OrdersApi.md | 189 +- pywaybiller/docs/OrdersList200Response.md | 31 - pywaybiller/docs/OriginAssortmentsApi.md | 187 +- .../docs/OriginAssortmentsList200Response.md | 31 - pywaybiller/docs/OriginsApi.md | 205 +- pywaybiller/docs/OriginsList200Response.md | 31 - .../PaginatedExternalAPIDestinationList.md | 32 + .../PaginatedExternalAPIEmploymentList.md | 32 + ...PaginatedExternalAPILoaderActionLogList.md | 32 + .../docs/PaginatedExternalAPIOrderListList.md | 32 + ...aginatedExternalAPIOriginAssortmentList.md | 32 + .../PaginatedExternalAPIOriginListList.md | 32 + ...inatedExternalAPITransportOrderListList.md | 32 + .../docs/PaginatedExternalAPIVehicleList.md | 32 + ...natedExternalAPIVehicleLocationDataList.md | 32 + .../PaginatedExternalAPIWaybillListList.md | 32 + pywaybiller/docs/RoleEnum.md | 23 + pywaybiller/docs/TransportOrderStatusEnum.md | 23 + pywaybiller/docs/TransportOrdersApi.md | 217 +- .../docs/TransportOrdersList200Response.md | 31 - pywaybiller/docs/TypeEnum.md | 23 + pywaybiller/docs/VehicleLocationDataApi.md | 152 +- .../VehicleLocationDataList200Response.md | 31 - pywaybiller/docs/VehiclesApi.md | 120 +- pywaybiller/docs/VehiclesList200Response.md | 31 - pywaybiller/docs/WaybillStatusEnum.md | 19 + pywaybiller/docs/WaybillsApi.md | 649 ++- pywaybiller/docs/WaybillsList200Response.md | 31 - ...llsUpdateCustomFieldsUpdateRequestValue.md | 28 + .../openapi/patches/schema-fixes.patch | 254 +- pywaybiller/openapi/update_schema.sh | 2 +- pywaybiller/openapi_client/__init__.py | 213 +- .../openapi_client/api/destinations_api.py | 838 +-- .../openapi_client/api/employments_api.py | 642 ++- .../api/loader_action_logs_api.py | 636 ++- pywaybiller/openapi_client/api/orders_api.py | 1840 +++--- .../api/origin_assortments_api.py | 1533 +++-- pywaybiller/openapi_client/api/origins_api.py | 1914 ++++--- .../api/transport_orders_api.py | 2319 +++++--- .../api/vehicle_location_data_api.py | 1804 ++++-- .../openapi_client/api/vehicles_api.py | 638 ++- .../openapi_client/api/waybills_api.py | 4971 +++++++++++------ pywaybiller/openapi_client/api_client.py | 573 +- pywaybiller/openapi_client/api_response.py | 32 +- pywaybiller/openapi_client/configuration.py | 234 +- pywaybiller/openapi_client/exceptions.py | 113 +- pywaybiller/openapi_client/models/__init__.py | 213 +- .../openapi_client/models/blank_enum.py | 35 + .../models/destinations_list200_response.py | 99 - .../models/destinations_list403_response.py | 84 + .../models/employments_list200_response.py | 102 - .../employments_retrieve404_response.py | 84 + .../models/ext_api_destination.py | 114 - .../models/ext_api_holding_base.py | 109 - .../ext_api_holding_base_previous_owner.py | 74 - .../models/ext_api_holding_base_read.py | 93 - .../models/ext_api_origin_assortment.py | 72 - .../models/ext_api_origin_create.py | 278 - .../models/ext_api_origin_list.py | 94 - .../models/ext_api_origin_read.py | 280 - .../models/ext_api_origin_update.py | 272 - .../models/external_api_destination.py | 156 + .../external_api_destination_raw_data.py | 87 + .../models/external_api_employment.py | 168 +- .../models/external_api_holding_base.py | 115 + ...xternal_api_holding_base_previous_owner.py | 90 + ...api_holding_base_previous_owner_request.py | 90 + .../models/external_api_holding_base_read.py | 114 + .../external_api_holding_base_request.py | 115 + .../models/external_api_loader_action_log.py | 217 +- .../external_api_loader_action_log_comment.py | 95 +- ...external_api_loader_action_log_raw_data.py | 150 +- .../models/external_api_order.py | 222 +- .../models/external_api_order_create.py | 222 +- .../external_api_order_create_request.py | 273 + .../models/external_api_order_list.py | 141 +- .../models/external_api_order_origin.py | 91 +- .../external_api_order_origin_request.py | 120 + .../external_api_order_origins_assortments.py | 80 +- ...l_api_order_origins_assortments_request.py | 86 + .../models/external_api_order_raw_data.py | 125 +- .../external_api_order_transport_companies.py | 80 +- ...l_api_order_transport_companies_request.py | 97 + .../models/external_api_order_update.py | 183 +- .../external_api_order_update_request.py | 273 + .../models/external_api_order_vehicles.py | 87 +- .../external_api_order_vehicles_request.py | 100 + .../models/external_api_origin_assortment.py | 145 +- .../external_api_origin_assortment_raw.py | 78 - ...external_api_origin_assortment_raw_data.py | 129 + .../external_api_origin_assortment_request.py | 85 + .../models/external_api_origin_create.py | 299 + .../external_api_origin_create_request.py | 301 + ..._create_waybill_created_emails_language.py | 168 + .../models/external_api_origin_list.py | 124 + .../models/external_api_origin_raw_data.py | 97 + .../models/external_api_origin_read.py | 299 + .../models/external_api_origin_update.py | 293 + .../external_api_origin_update_request.py | 295 + .../external_api_partial_order_update.py | 94 +- ...ternal_api_partial_order_update_request.py | 127 + .../models/external_api_raw_serializer.py | 73 - .../models/external_api_transport_order.py | 287 +- .../external_api_transport_order_cancel.py | 68 +- ...rnal_api_transport_order_cancel_request.py | 88 + .../external_api_transport_order_list.py | 90 +- .../external_api_transport_order_raw_data.py | 117 +- ...ernal_api_transport_order_raw_data_list.py | 114 +- .../external_api_transport_order_request.py | 368 ++ .../external_api_transport_order_row.py | 84 +- ...ternal_api_transport_order_row_raw_data.py | 79 +- ...xternal_api_transport_order_row_request.py | 99 + .../external_api_transport_order_update.py | 99 +- ...rnal_api_transport_order_update_request.py | 169 + .../models/external_api_vehicle.py | 111 +- .../external_api_vehicle_location_data.py | 136 +- ...rnal_api_vehicle_location_data_raw_data.py | 106 +- ..._data_vehicle_location_data_inner_value.py | 174 + .../models/external_api_waybill_accept.py | 89 +- .../external_api_waybill_accept_request.py | 117 + .../external_api_waybill_accepted_amounts.py | 76 +- ...al_api_waybill_accepted_amounts_request.py | 104 + .../models/external_api_waybill_cancel.py | 71 +- .../external_api_waybill_cancel_request.py | 92 + .../models/external_api_waybill_comment.py | 77 - .../external_api_waybill_comment_request.py | 92 + .../models/external_api_waybill_create.py | 384 +- .../external_api_waybill_create_request.py | 383 ++ ...external_api_waybill_dispatched_amounts.py | 76 +- ..._api_waybill_dispatched_amounts_request.py | 104 + .../external_api_waybill_finish_drive.py | 70 - ...ternal_api_waybill_finish_drive_request.py | 84 + .../external_api_waybill_holding_right.py | 92 + ...ernal_api_waybill_holding_right_request.py | 92 + .../models/external_api_waybill_list.py | 241 +- .../models/external_api_waybill_raw_data.py | 124 +- .../external_api_waybill_raw_data_list.py | 82 +- .../models/external_api_waybill_refuse.py | 71 +- .../external_api_waybill_refuse_request.py | 92 + .../models/external_api_waybill_retrieve.py | 436 +- .../models/external_api_waybill_row.py | 173 +- ...xternal_api_waybill_row_accepted_amount.py | 141 +- ...api_waybill_row_accepted_amount_request.py | 148 + ...ernal_api_waybill_row_dispatched_amount.py | 135 +- ...i_waybill_row_dispatched_amount_request.py | 142 + .../models/external_api_waybill_row_list.py | 162 +- .../external_api_waybill_row_raw_data.py | 90 +- .../external_api_waybill_row_request.py | 134 + .../external_api_waybill_start_drive.py | 72 +- ...xternal_api_waybill_start_drive_request.py | 98 + .../external_api_waybill_vehicle_location.py | 85 +- .../openapi_client/models/geo_location.py | 81 +- .../models/geo_location_request.py | 90 + .../openapi_client/models/language_enum.py | 42 + .../loader_action_logs_list200_response.py | 102 - .../models/orders_list200_response.py | 102 - .../origin_assortments_list200_response.py | 102 - .../models/origins_list200_response.py | 99 - ...paginated_external_api_destination_list.py | 123 + .../paginated_external_api_employment_list.py | 123 + ...ted_external_api_loader_action_log_list.py | 124 + .../paginated_external_api_order_list_list.py | 123 + ...ted_external_api_origin_assortment_list.py | 124 + ...paginated_external_api_origin_list_list.py | 123 + ..._external_api_transport_order_list_list.py | 124 + .../paginated_external_api_vehicle_list.py | 121 + ...external_api_vehicle_location_data_list.py | 124 + ...aginated_external_api_waybill_list_list.py | 123 + .../openapi_client/models/role_enum.py | 41 + .../models/transport_order_status_enum.py | 41 + .../transport_orders_list200_response.py | 102 - .../openapi_client/models/type_enum.py | 41 + .../vehicle_location_data_list200_response.py | 102 - .../models/vehicles_list200_response.py | 99 - .../models/waybill_status_enum.py | 39 + .../models/waybills_list200_response.py | 102 - ...date_custom_fields_update_request_value.py | 176 + pywaybiller/openapi_client/rest.py | 328 +- tests/manual_test_api.py | 76 + tests/manual_test_json_dump.py | 6 +- tests/test_utility_methods.py | 2 +- tox.ini | 16 +- 296 files changed, 28866 insertions(+), 13651 deletions(-) create mode 100644 pywaybiller/docs/BlankEnum.md delete mode 100644 pywaybiller/docs/DestinationsList200Response.md create mode 100644 pywaybiller/docs/DestinationsList403Response.md delete mode 100644 pywaybiller/docs/EmploymentsList200Response.md create mode 100644 pywaybiller/docs/EmploymentsRetrieve404Response.md delete mode 100644 pywaybiller/docs/ExtAPIDestination.md delete mode 100644 pywaybiller/docs/ExtAPIHoldingBase.md delete mode 100644 pywaybiller/docs/ExtAPIHoldingBasePreviousOwner.md delete mode 100644 pywaybiller/docs/ExtAPIHoldingBaseRead.md delete mode 100644 pywaybiller/docs/ExtAPIOriginAssortment.md delete mode 100644 pywaybiller/docs/ExtAPIOriginList.md create mode 100644 pywaybiller/docs/ExternalAPIDestination.md create mode 100644 pywaybiller/docs/ExternalAPIDestinationRawData.md create mode 100644 pywaybiller/docs/ExternalAPIHoldingBase.md create mode 100644 pywaybiller/docs/ExternalAPIHoldingBasePreviousOwner.md create mode 100644 pywaybiller/docs/ExternalAPIHoldingBasePreviousOwnerRequest.md create mode 100644 pywaybiller/docs/ExternalAPIHoldingBaseRead.md create mode 100644 pywaybiller/docs/ExternalAPIHoldingBaseRequest.md create mode 100644 pywaybiller/docs/ExternalAPIOrderCreateRequest.md create mode 100644 pywaybiller/docs/ExternalAPIOrderOriginRequest.md create mode 100644 pywaybiller/docs/ExternalAPIOrderOriginsAssortmentsRequest.md create mode 100644 pywaybiller/docs/ExternalAPIOrderTransportCompaniesRequest.md create mode 100644 pywaybiller/docs/ExternalAPIOrderUpdateRequest.md create mode 100644 pywaybiller/docs/ExternalAPIOrderVehiclesRequest.md delete mode 100644 pywaybiller/docs/ExternalAPIOriginAssortmentRaw.md create mode 100644 pywaybiller/docs/ExternalAPIOriginAssortmentRawData.md create mode 100644 pywaybiller/docs/ExternalAPIOriginAssortmentRequest.md rename pywaybiller/docs/{ExtAPIOriginRead.md => ExternalAPIOriginCreate.md} (55%) create mode 100644 pywaybiller/docs/ExternalAPIOriginCreateRequest.md create mode 100644 pywaybiller/docs/ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md create mode 100644 pywaybiller/docs/ExternalAPIOriginList.md create mode 100644 pywaybiller/docs/ExternalAPIOriginRawData.md rename pywaybiller/docs/{ExtAPIOriginCreate.md => ExternalAPIOriginRead.md} (55%) rename pywaybiller/docs/{ExtAPIOriginUpdate.md => ExternalAPIOriginUpdate.md} (53%) create mode 100644 pywaybiller/docs/ExternalAPIOriginUpdateRequest.md create mode 100644 pywaybiller/docs/ExternalAPIPartialOrderUpdateRequest.md delete mode 100644 pywaybiller/docs/ExternalAPIRawSerializer.md create mode 100644 pywaybiller/docs/ExternalAPITransportOrderCancelRequest.md create mode 100644 pywaybiller/docs/ExternalAPITransportOrderRequest.md create mode 100644 pywaybiller/docs/ExternalAPITransportOrderRowRequest.md create mode 100644 pywaybiller/docs/ExternalAPITransportOrderUpdateRequest.md create mode 100644 pywaybiller/docs/ExternalAPIVehicleLocationDataVehicleLocationDataInnerValue.md create mode 100644 pywaybiller/docs/ExternalAPIWaybillAcceptRequest.md create mode 100644 pywaybiller/docs/ExternalAPIWaybillAcceptedAmountsRequest.md create mode 100644 pywaybiller/docs/ExternalAPIWaybillCancelRequest.md rename pywaybiller/docs/{ExternalAPIWaybillComment.md => ExternalAPIWaybillCommentRequest.md} (50%) create mode 100644 pywaybiller/docs/ExternalAPIWaybillCreateRequest.md create mode 100644 pywaybiller/docs/ExternalAPIWaybillDispatchedAmountsRequest.md delete mode 100644 pywaybiller/docs/ExternalAPIWaybillFinishDrive.md create mode 100644 pywaybiller/docs/ExternalAPIWaybillFinishDriveRequest.md create mode 100644 pywaybiller/docs/ExternalAPIWaybillHoldingRight.md create mode 100644 pywaybiller/docs/ExternalAPIWaybillHoldingRightRequest.md create mode 100644 pywaybiller/docs/ExternalAPIWaybillRefuseRequest.md create mode 100644 pywaybiller/docs/ExternalAPIWaybillRowAcceptedAmountRequest.md create mode 100644 pywaybiller/docs/ExternalAPIWaybillRowDispatchedAmountRequest.md create mode 100644 pywaybiller/docs/ExternalAPIWaybillRowRequest.md create mode 100644 pywaybiller/docs/ExternalAPIWaybillStartDriveRequest.md create mode 100644 pywaybiller/docs/GeoLocationRequest.md create mode 100644 pywaybiller/docs/LanguageEnum.md delete mode 100644 pywaybiller/docs/LoaderActionLogsList200Response.md delete mode 100644 pywaybiller/docs/OrdersList200Response.md delete mode 100644 pywaybiller/docs/OriginAssortmentsList200Response.md delete mode 100644 pywaybiller/docs/OriginsList200Response.md create mode 100644 pywaybiller/docs/PaginatedExternalAPIDestinationList.md create mode 100644 pywaybiller/docs/PaginatedExternalAPIEmploymentList.md create mode 100644 pywaybiller/docs/PaginatedExternalAPILoaderActionLogList.md create mode 100644 pywaybiller/docs/PaginatedExternalAPIOrderListList.md create mode 100644 pywaybiller/docs/PaginatedExternalAPIOriginAssortmentList.md create mode 100644 pywaybiller/docs/PaginatedExternalAPIOriginListList.md create mode 100644 pywaybiller/docs/PaginatedExternalAPITransportOrderListList.md create mode 100644 pywaybiller/docs/PaginatedExternalAPIVehicleList.md create mode 100644 pywaybiller/docs/PaginatedExternalAPIVehicleLocationDataList.md create mode 100644 pywaybiller/docs/PaginatedExternalAPIWaybillListList.md create mode 100644 pywaybiller/docs/RoleEnum.md create mode 100644 pywaybiller/docs/TransportOrderStatusEnum.md delete mode 100644 pywaybiller/docs/TransportOrdersList200Response.md create mode 100644 pywaybiller/docs/TypeEnum.md delete mode 100644 pywaybiller/docs/VehicleLocationDataList200Response.md delete mode 100644 pywaybiller/docs/VehiclesList200Response.md create mode 100644 pywaybiller/docs/WaybillStatusEnum.md delete mode 100644 pywaybiller/docs/WaybillsList200Response.md create mode 100644 pywaybiller/docs/WaybillsUpdateCustomFieldsUpdateRequestValue.md create mode 100644 pywaybiller/openapi_client/models/blank_enum.py delete mode 100644 pywaybiller/openapi_client/models/destinations_list200_response.py create mode 100644 pywaybiller/openapi_client/models/destinations_list403_response.py delete mode 100644 pywaybiller/openapi_client/models/employments_list200_response.py create mode 100644 pywaybiller/openapi_client/models/employments_retrieve404_response.py delete mode 100644 pywaybiller/openapi_client/models/ext_api_destination.py delete mode 100644 pywaybiller/openapi_client/models/ext_api_holding_base.py delete mode 100644 pywaybiller/openapi_client/models/ext_api_holding_base_previous_owner.py delete mode 100644 pywaybiller/openapi_client/models/ext_api_holding_base_read.py delete mode 100644 pywaybiller/openapi_client/models/ext_api_origin_assortment.py delete mode 100644 pywaybiller/openapi_client/models/ext_api_origin_create.py delete mode 100644 pywaybiller/openapi_client/models/ext_api_origin_list.py delete mode 100644 pywaybiller/openapi_client/models/ext_api_origin_read.py delete mode 100644 pywaybiller/openapi_client/models/ext_api_origin_update.py create mode 100644 pywaybiller/openapi_client/models/external_api_destination.py create mode 100644 pywaybiller/openapi_client/models/external_api_destination_raw_data.py create mode 100644 pywaybiller/openapi_client/models/external_api_holding_base.py create mode 100644 pywaybiller/openapi_client/models/external_api_holding_base_previous_owner.py create mode 100644 pywaybiller/openapi_client/models/external_api_holding_base_previous_owner_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_holding_base_read.py create mode 100644 pywaybiller/openapi_client/models/external_api_holding_base_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_order_create_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_order_origin_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_order_origins_assortments_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_order_transport_companies_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_order_update_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_order_vehicles_request.py delete mode 100644 pywaybiller/openapi_client/models/external_api_origin_assortment_raw.py create mode 100644 pywaybiller/openapi_client/models/external_api_origin_assortment_raw_data.py create mode 100644 pywaybiller/openapi_client/models/external_api_origin_assortment_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_origin_create.py create mode 100644 pywaybiller/openapi_client/models/external_api_origin_create_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_origin_create_waybill_created_emails_language.py create mode 100644 pywaybiller/openapi_client/models/external_api_origin_list.py create mode 100644 pywaybiller/openapi_client/models/external_api_origin_raw_data.py create mode 100644 pywaybiller/openapi_client/models/external_api_origin_read.py create mode 100644 pywaybiller/openapi_client/models/external_api_origin_update.py create mode 100644 pywaybiller/openapi_client/models/external_api_origin_update_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_partial_order_update_request.py delete mode 100644 pywaybiller/openapi_client/models/external_api_raw_serializer.py create mode 100644 pywaybiller/openapi_client/models/external_api_transport_order_cancel_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_transport_order_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_transport_order_row_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_transport_order_update_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_vehicle_location_data_vehicle_location_data_inner_value.py create mode 100644 pywaybiller/openapi_client/models/external_api_waybill_accept_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_waybill_accepted_amounts_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_waybill_cancel_request.py delete mode 100644 pywaybiller/openapi_client/models/external_api_waybill_comment.py create mode 100644 pywaybiller/openapi_client/models/external_api_waybill_comment_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_waybill_create_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_waybill_dispatched_amounts_request.py delete mode 100644 pywaybiller/openapi_client/models/external_api_waybill_finish_drive.py create mode 100644 pywaybiller/openapi_client/models/external_api_waybill_finish_drive_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_waybill_holding_right.py create mode 100644 pywaybiller/openapi_client/models/external_api_waybill_holding_right_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_waybill_refuse_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_waybill_row_accepted_amount_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_waybill_row_dispatched_amount_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_waybill_row_request.py create mode 100644 pywaybiller/openapi_client/models/external_api_waybill_start_drive_request.py create mode 100644 pywaybiller/openapi_client/models/geo_location_request.py create mode 100644 pywaybiller/openapi_client/models/language_enum.py delete mode 100644 pywaybiller/openapi_client/models/loader_action_logs_list200_response.py delete mode 100644 pywaybiller/openapi_client/models/orders_list200_response.py delete mode 100644 pywaybiller/openapi_client/models/origin_assortments_list200_response.py delete mode 100644 pywaybiller/openapi_client/models/origins_list200_response.py create mode 100644 pywaybiller/openapi_client/models/paginated_external_api_destination_list.py create mode 100644 pywaybiller/openapi_client/models/paginated_external_api_employment_list.py create mode 100644 pywaybiller/openapi_client/models/paginated_external_api_loader_action_log_list.py create mode 100644 pywaybiller/openapi_client/models/paginated_external_api_order_list_list.py create mode 100644 pywaybiller/openapi_client/models/paginated_external_api_origin_assortment_list.py create mode 100644 pywaybiller/openapi_client/models/paginated_external_api_origin_list_list.py create mode 100644 pywaybiller/openapi_client/models/paginated_external_api_transport_order_list_list.py create mode 100644 pywaybiller/openapi_client/models/paginated_external_api_vehicle_list.py create mode 100644 pywaybiller/openapi_client/models/paginated_external_api_vehicle_location_data_list.py create mode 100644 pywaybiller/openapi_client/models/paginated_external_api_waybill_list_list.py create mode 100644 pywaybiller/openapi_client/models/role_enum.py create mode 100644 pywaybiller/openapi_client/models/transport_order_status_enum.py delete mode 100644 pywaybiller/openapi_client/models/transport_orders_list200_response.py create mode 100644 pywaybiller/openapi_client/models/type_enum.py delete mode 100644 pywaybiller/openapi_client/models/vehicle_location_data_list200_response.py delete mode 100644 pywaybiller/openapi_client/models/vehicles_list200_response.py create mode 100644 pywaybiller/openapi_client/models/waybill_status_enum.py delete mode 100644 pywaybiller/openapi_client/models/waybills_list200_response.py create mode 100644 pywaybiller/openapi_client/models/waybills_update_custom_fields_update_request_value.py create mode 100644 tests/manual_test_api.py diff --git a/.github/workflows/python.yml b/.github/workflows/python.yml index 9808bab..864de49 100644 --- a/.github/workflows/python.yml +++ b/.github/workflows/python.yml @@ -13,7 +13,7 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] + python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"] steps: - uses: actions/checkout@v3 @@ -26,12 +26,10 @@ jobs: python -m pip install --upgrade pip pip install poetry poetry install - - name: Lint with flake8 + - name: Lint with ruff run: | - # stop the build if there are Python syntax errors or undefined names - poetry run flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics - # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide - poetry run flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics + poetry run ruff check --select I pywaybiller --exclude pywaybiller/openapi_client + poetry run ruff check pywaybiller --exclude pywaybiller/openapi_client - name: Test with pytest run: | poetry run pytest diff --git a/CHANGELOG.md b/CHANGELOG.md index 9f05525..98871e7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog +## Version 0.2.0 + +* **Breaking** Use new Waybiller schema - some classes get renamed because of this change +* **Breaking** Drop support for Python 3.8 +* Update to use newer openapi generator (pydantic 2) +* Ensure read-only fields are serialized correctly when saving data locally + ## Version 0.1.0 * Generate initial version of the client diff --git a/Makefile b/Makefile index dbc3913..a7dbf92 100644 --- a/Makefile +++ b/Makefile @@ -1,26 +1,28 @@ -OPENAPI_GENERATOR_VERSION ?= v7.0.1 +OPENAPI_GENERATOR_VERSION ?= v7.12.0 API_HOST ?= app.waybiller.com .PHONY: lint: - poetry run flake8 --select=E9,F63,F7,F82 pywaybiller + poetry run ruff check --select I pywaybiller --exclude pywaybiller/openapi_client + poetry run ruff check pywaybiller --exclude pywaybiller/openapi_client .PHONY: fmt: - poetry run black pywaybiller - poetry run black test + poetry run ruff check --select I pywaybiller --fix --exclude pywaybiller/openapi_client + poetry run ruff check pywaybiller --fix --exclude pywaybiller/openapi_client + poetry run ruff format pywaybiller --exclude pywaybiller/openapi_client .PHONY: -test: ## run tests quickly with the default Python +test: # run tests quickly with the default Python poetry run pytest .PHONY: -test-all: ## run tests on every Python version with tox +test-all: # run tests on every Python version with tox tox .PHONY: openapi-fetch: - curl https://$(API_HOST)/api/swagger/?format=openapi | poetry run python -c "import json; import sys; print(json.dumps(json.load(sys.stdin), indent=2))" > ./pywaybiller/openapi/waybiller_schema.json + curl https://$(API_HOST)/api/schema/ | poetry run python -c "import json; import sys; print(json.dumps(json.load(sys.stdin), indent=2))" > ./pywaybiller/openapi/waybiller_schema.json .PHONY: openapi-patch: openapi-fetch @@ -40,7 +42,8 @@ openapi-build: cp -r .openapi/openapi_client pywaybiller/openapi_client cp -r .openapi/docs pywaybiller/docs rm -rf .openapi - poetry run black pywaybiller + poetry run ruff check --select I pywaybiller/openapi_client --fix + poetry run ruff format pywaybiller/openapi_client .PHONY: openapi: openapi-apply-patch openapi-build diff --git a/README.md b/README.md index 6aeb26c..379ce9b 100644 --- a/README.md +++ b/README.md @@ -116,6 +116,11 @@ make docker-manage cmd="external_api_export --view waybill --endpoint list" > /t poetry run python tests/manual_test_json_dump.py --filename /tmp/waybills-list.json --skip-lines 1 --model ExternalAPIWaybillList ``` +To perform the manual test by direct API calls, use `manual_test_api.py`: +```shell +poetry run python tests/manual_test_api.py --model ExternalAPIWaybillList --api-key 'SECRET' +``` + Note that you probably need to separately test list and detail endpoints, as schema is different. This needs to be repeated for all endpoints you want to check. Currently, only waybill list and retrieve endpoints are diff --git a/poetry.lock b/poetry.lock index ae934e4..bbac7f9 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,68 +1,27 @@ -# This file is automatically @generated by Poetry 1.6.1 and should not be changed by hand. +# This file is automatically @generated by Poetry 2.0.0 and should not be changed by hand. [[package]] -name = "aenum" -version = "3.1.15" -description = "Advanced Enumerations (compatible with Python's stdlib Enum), NamedTuples, and NamedConstants" -optional = false -python-versions = "*" -files = [ - {file = "aenum-3.1.15-py2-none-any.whl", hash = "sha256:27b1710b9d084de6e2e695dab78fe9f269de924b51ae2850170ee7e1ca6288a5"}, - {file = "aenum-3.1.15-py3-none-any.whl", hash = "sha256:e0dfaeea4c2bd362144b87377e2c61d91958c5ed0b4daf89cb6f45ae23af6288"}, - {file = "aenum-3.1.15.tar.gz", hash = "sha256:8cbd76cd18c4f870ff39b24284d3ea028fbe8731a58df3aa581e434c575b9559"}, -] - -[[package]] -name = "black" -version = "23.11.0" -description = "The uncompromising code formatter." +name = "annotated-types" +version = "0.7.0" +description = "Reusable constraint types to use with typing.Annotated" optional = false python-versions = ">=3.8" +groups = ["main"] files = [ - {file = "black-23.11.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:dbea0bb8575c6b6303cc65017b46351dc5953eea5c0a59d7b7e3a2d2f433a911"}, - {file = "black-23.11.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:412f56bab20ac85927f3a959230331de5614aecda1ede14b373083f62ec24e6f"}, - {file = "black-23.11.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d136ef5b418c81660ad847efe0e55c58c8208b77a57a28a503a5f345ccf01394"}, - {file = "black-23.11.0-cp310-cp310-win_amd64.whl", hash = "sha256:6c1cac07e64433f646a9a838cdc00c9768b3c362805afc3fce341af0e6a9ae9f"}, - {file = "black-23.11.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:cf57719e581cfd48c4efe28543fea3d139c6b6f1238b3f0102a9c73992cbb479"}, - {file = "black-23.11.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:698c1e0d5c43354ec5d6f4d914d0d553a9ada56c85415700b81dc90125aac244"}, - {file = "black-23.11.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:760415ccc20f9e8747084169110ef75d545f3b0932ee21368f63ac0fee86b221"}, - {file = "black-23.11.0-cp311-cp311-win_amd64.whl", hash = "sha256:58e5f4d08a205b11800332920e285bd25e1a75c54953e05502052738fe16b3b5"}, - {file = "black-23.11.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:45aa1d4675964946e53ab81aeec7a37613c1cb71647b5394779e6efb79d6d187"}, - {file = "black-23.11.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:4c44b7211a3a0570cc097e81135faa5f261264f4dfaa22bd5ee2875a4e773bd6"}, - {file = "black-23.11.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2a9acad1451632021ee0d146c8765782a0c3846e0e0ea46659d7c4f89d9b212b"}, - {file = "black-23.11.0-cp38-cp38-win_amd64.whl", hash = "sha256:fc7f6a44d52747e65a02558e1d807c82df1d66ffa80a601862040a43ec2e3142"}, - {file = "black-23.11.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:7f622b6822f02bfaf2a5cd31fdb7cd86fcf33dab6ced5185c35f5db98260b055"}, - {file = "black-23.11.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:250d7e60f323fcfc8ea6c800d5eba12f7967400eb6c2d21ae85ad31c204fb1f4"}, - {file = "black-23.11.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5133f5507007ba08d8b7b263c7aa0f931af5ba88a29beacc4b2dc23fcefe9c06"}, - {file = "black-23.11.0-cp39-cp39-win_amd64.whl", hash = "sha256:421f3e44aa67138ab1b9bfbc22ee3780b22fa5b291e4db8ab7eee95200726b07"}, - {file = "black-23.11.0-py3-none-any.whl", hash = "sha256:54caaa703227c6e0c87b76326d0862184729a69b73d3b7305b6288e1d830067e"}, - {file = "black-23.11.0.tar.gz", hash = "sha256:4c68855825ff432d197229846f971bc4d6666ce90492e5b02013bcaca4d9ab05"}, + {file = "annotated_types-0.7.0-py3-none-any.whl", hash = "sha256:1f02e8b43a8fbbc3f3e0d4f0f4bfc8131bcb4eebe8849b8e5c773f3a1c582a53"}, + {file = "annotated_types-0.7.0.tar.gz", hash = "sha256:aff07c09a53a08bc8cfccb9c85b05f1aa9a2a6f23728d790723543408344ce89"}, ] -[package.dependencies] -click = ">=8.0.0" -mypy-extensions = ">=0.4.3" -packaging = ">=22.0" -pathspec = ">=0.9.0" -platformdirs = ">=2" -tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""} -typing-extensions = {version = ">=4.0.1", markers = "python_version < \"3.11\""} - -[package.extras] -colorama = ["colorama (>=0.4.3)"] -d = ["aiohttp (>=3.7.4)"] -jupyter = ["ipython (>=7.8.0)", "tokenize-rt (>=3.2.0)"] -uvloop = ["uvloop (>=0.15.2)"] - [[package]] name = "cachetools" -version = "5.3.2" +version = "5.5.2" description = "Extensible memoizing collections and decorators" optional = false python-versions = ">=3.7" +groups = ["dev"] files = [ - {file = "cachetools-5.3.2-py3-none-any.whl", hash = "sha256:861f35a13a451f94e301ce2bec7cac63e881232ccce7ed67fab9b5df4d3beaa1"}, - {file = "cachetools-5.3.2.tar.gz", hash = "sha256:086ee420196f7b2ab9ca2db2520aca326318b68fe5ba8bc4d49cca91add450f2"}, + {file = "cachetools-5.5.2-py3-none-any.whl", hash = "sha256:d26a22bcc62eb95c3beabd9f1ee5e820d3d2704fe2967cbe350e20c8ffcd3f0a"}, + {file = "cachetools-5.5.2.tar.gz", hash = "sha256:1a661caa9175d26759571b2e19580f9d6393969e5dfca11fdb1f947a23e640d4"}, ] [[package]] @@ -71,31 +30,19 @@ version = "5.2.0" description = "Universal encoding detector for Python 3" optional = false python-versions = ">=3.7" +groups = ["dev"] files = [ {file = "chardet-5.2.0-py3-none-any.whl", hash = "sha256:e1cf59446890a00105fe7b7912492ea04b6e6f06d4b742b2c788469e34c82970"}, {file = "chardet-5.2.0.tar.gz", hash = "sha256:1b3b6ff479a8c414bc3fa2c0852995695c4a026dcd6d0633b2dd092ca39c1cf7"}, ] -[[package]] -name = "click" -version = "8.1.7" -description = "Composable command line interface toolkit" -optional = false -python-versions = ">=3.7" -files = [ - {file = "click-8.1.7-py3-none-any.whl", hash = "sha256:ae74fb96c20a0277a1d615f1e4d73c8414f5a98db8b799a7931d1582f3390c28"}, - {file = "click-8.1.7.tar.gz", hash = "sha256:ca9853ad459e787e2192211578cc907e7594e294c7ccc834310722b41b9ca6de"}, -] - -[package.dependencies] -colorama = {version = "*", markers = "platform_system == \"Windows\""} - [[package]] name = "colorama" version = "0.4.6" description = "Cross-platform colored terminal text." optional = false python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7" +groups = ["dev"] files = [ {file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"}, {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"}, @@ -103,24 +50,27 @@ files = [ [[package]] name = "distlib" -version = "0.3.7" +version = "0.3.9" description = "Distribution utilities" optional = false python-versions = "*" +groups = ["dev"] files = [ - {file = "distlib-0.3.7-py2.py3-none-any.whl", hash = "sha256:2e24928bc811348f0feb63014e97aaae3037f2cf48712d51ae61df7fd6075057"}, - {file = "distlib-0.3.7.tar.gz", hash = "sha256:9dafe54b34a028eafd95039d5e5d4851a13734540f1331060d31c9916e7147a8"}, + {file = "distlib-0.3.9-py2.py3-none-any.whl", hash = "sha256:47f8c22fd27c27e25a65601af709b38e4f0a45ea4fc2e710f65755fa8caaaf87"}, + {file = "distlib-0.3.9.tar.gz", hash = "sha256:a60f20dea646b8a33f3e7772f74dc0b2d0772d2837ee1342a00645c81edf9403"}, ] [[package]] name = "exceptiongroup" -version = "1.2.0" +version = "1.2.2" description = "Backport of PEP 654 (exception groups)" optional = false python-versions = ">=3.7" +groups = ["dev"] +markers = "python_version < \"3.11\"" files = [ - {file = "exceptiongroup-1.2.0-py3-none-any.whl", hash = "sha256:4bfd3996ac73b41e9b9628b04e079f193850720ea5945fc96a08633c66912f14"}, - {file = "exceptiongroup-1.2.0.tar.gz", hash = "sha256:91f5c769735f051a4290d52edd0858999b57e5876e9f85937691bd4c9fa3ed68"}, + {file = "exceptiongroup-1.2.2-py3-none-any.whl", hash = "sha256:3111b9d131c238bec2f8f516e123e14ba243563fb135d3fe885990585aa7795b"}, + {file = "exceptiongroup-1.2.2.tar.gz", hash = "sha256:47c2edf7c6738fafb49fd34290706d1a1a2f4d1c6df275526b62cbb4aa5393cc"}, ] [package.extras] @@ -128,35 +78,20 @@ test = ["pytest (>=6)"] [[package]] name = "filelock" -version = "3.13.1" +version = "3.16.1" description = "A platform independent file lock." optional = false python-versions = ">=3.8" +groups = ["dev"] files = [ - {file = "filelock-3.13.1-py3-none-any.whl", hash = "sha256:57dbda9b35157b05fb3e58ee91448612eb674172fab98ee235ccb0b5bee19a1c"}, - {file = "filelock-3.13.1.tar.gz", hash = "sha256:521f5f56c50f8426f5e03ad3b281b490a87ef15bc6c526f168290f0c7148d44e"}, + {file = "filelock-3.16.1-py3-none-any.whl", hash = "sha256:2082e5703d51fbf98ea75855d9d5527e33d8ff23099bec374a134febee6946b0"}, + {file = "filelock-3.16.1.tar.gz", hash = "sha256:c249fbfcd5db47e5e2d6d62198e565475ee65e4831e2561c8e313fa7eb961435"}, ] [package.extras] -docs = ["furo (>=2023.9.10)", "sphinx (>=7.2.6)", "sphinx-autodoc-typehints (>=1.24)"] -testing = ["covdefaults (>=2.3)", "coverage (>=7.3.2)", "diff-cover (>=8)", "pytest (>=7.4.3)", "pytest-cov (>=4.1)", "pytest-mock (>=3.12)", "pytest-timeout (>=2.2)"] -typing = ["typing-extensions (>=4.8)"] - -[[package]] -name = "flake8" -version = "5.0.4" -description = "the modular source code checker: pep8 pyflakes and co" -optional = false -python-versions = ">=3.6.1" -files = [ - {file = "flake8-5.0.4-py2.py3-none-any.whl", hash = "sha256:7a1cf6b73744f5806ab95e526f6f0d8c01c66d7bbe349562d22dfca20610b248"}, - {file = "flake8-5.0.4.tar.gz", hash = "sha256:6fbe320aad8d6b95cec8b8e47bc933004678dc63095be98528b7bdd2a9f510db"}, -] - -[package.dependencies] -mccabe = ">=0.7.0,<0.8.0" -pycodestyle = ">=2.9.0,<2.10.0" -pyflakes = ">=2.5.0,<2.6.0" +docs = ["furo (>=2024.8.6)", "sphinx (>=8.0.2)", "sphinx-autodoc-typehints (>=2.4.1)"] +testing = ["covdefaults (>=2.3)", "coverage (>=7.6.1)", "diff-cover (>=9.2)", "pytest (>=8.3.3)", "pytest-asyncio (>=0.24)", "pytest-cov (>=5)", "pytest-mock (>=3.14)", "pytest-timeout (>=2.3.1)", "virtualenv (>=20.26.4)"] +typing = ["typing-extensions (>=4.12.2)"] [[package]] name = "iniconfig" @@ -164,6 +99,7 @@ version = "2.0.0" description = "brain-dead simple config-ini parsing" optional = false python-versions = ">=3.7" +groups = ["dev"] files = [ {file = "iniconfig-2.0.0-py3-none-any.whl", hash = "sha256:b6a85871a79d2e3b22d2d1b94ac2824226a63c6b741c88f7ae975f18b6778374"}, {file = "iniconfig-2.0.0.tar.gz", hash = "sha256:2d91e135bf72d31a410b17c16da610a82cb55f6b0477d1a902134b24a455b8b3"}, @@ -171,13 +107,14 @@ files = [ [[package]] name = "json-stream" -version = "2.3.2" +version = "2.3.3" description = "Streaming JSON encoder and decoder" optional = false python-versions = "<4,>=3.5" +groups = ["dev"] files = [ - {file = "json-stream-2.3.2.tar.gz", hash = "sha256:b8b450ea8e8e3c239e9e7e38d12fed934e77a353c14b297f8ee345a5ceb25b91"}, - {file = "json_stream-2.3.2-py3-none-any.whl", hash = "sha256:236b8e08e2761b209816452a3527355e757913d833e6802b68a034a13b8bd3ac"}, + {file = "json_stream-2.3.3-py3-none-any.whl", hash = "sha256:65f08c5031d7df145c6fe89e434b718c1574b2bb84b8a0eea974de90916a089d"}, + {file = "json_stream-2.3.3.tar.gz", hash = "sha256:894444c68c331174926763e224fb34b7ed3f90749d1c165afd0f5930207534c4"}, ] [package.dependencies] @@ -189,248 +126,295 @@ requests = ["requests"] [[package]] name = "json-stream-rs-tokenizer" -version = "0.4.25" +version = "0.4.27" description = "A faster tokenizer for the json-stream Python library" optional = false -python-versions = ">=3.7,<4" +python-versions = "<4,>=3.7" +groups = ["dev"] files = [ - {file = "json-stream-rs-tokenizer-0.4.25.tar.gz", hash = "sha256:6382f2f71a2ef17cef1cc85165d770a3e09360fe211576824a14089f7cb0e422"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:1dc6c02532843750e4a006e84b9418efdf3a503c9dd2dea98b0814fa2e4dbc2b"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:62d275ceee82a68c3630099bfc98785fd7908df7f55db18ec025bc36bef2277d"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a20ad9b23d08ce8679913d27590d49388950bd44f0219447c3bc7e39f3988676"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5c33f2c07c3960c28b29d12fc61675ccaffa910008943f7532dec4e29a9f71d3"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:fd9e6961a76bb34ae43d49e170074a6b0dedb6db70f455b34b91db737feaa63e"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:d74b79d645173c60958722ed14025cecc9799d9e94f060749095f5fe3716aba7"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp310-cp310-win32.whl", hash = "sha256:b2982d1f5e5c56cb5510815c68737f1574a1b0216b9692a0ec4176cce8529b9e"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp310-cp310-win_amd64.whl", hash = "sha256:f1b460e4941fc1b3c40034b2b859595914103e2689f7195e951a41c4dcd3f7f5"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:ab8cadc72d50d51fedaa212b999ea07d6aa6c61dbf819e2743730f4fb1859c88"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:5c1929ad3c08d6ffc8f5bdd981256e38a4f3ec7a23372f3169ecb904b7925f81"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ef674b7cf85b5918ba8a6d028b2557818450e1d7a3c2c7c48a11e84d549d36cf"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a9014c576134437db1e6f525a6503bd180a1d5de08edaca58ee3526f0faccd4e"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:fd5ae65bf19b02c0e0d0814d78af75ef7e83bacc7e3c575544667f1fabda96cd"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:778f42ee54528a2b7c433d6da4c52ffbccd85ddb27ae0e038e3c024289cea915"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp311-cp311-win32.whl", hash = "sha256:c4ef87dc0cb0f8a755de3d3253f328eef22c156db6abba6d446c7921336d4337"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp311-cp311-win_amd64.whl", hash = "sha256:ca42ee5b7e534938826058249f9330bc10f02b6554a845edfd525da37d2f16e1"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:61d38c1e348a5958f195193e7e6d95858dc009895ef0009f4303e8d9a0223744"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ca8518ba5e5fba8da438a8e33a5dd8d87ac0651d74158d287030ef9b9e56cb0d"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:cee037e98a1f7bdac531b2d26aab77173fd0ae8600c8d06ecd053fa6947cdae8"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f93ad9b24746e44f7c121b93c4abc75933241bb0182e4a8ef4e13fd4a30c7c5d"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:31025ca031a6c8fb970193e049e1146fef2b4c71ac29ee9c503e5992d827d019"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp37-cp37m-win32.whl", hash = "sha256:9e0a74a1d9afedcf6dd20c3b3e44ca8162e44fb8ddbaffda74b0b9561e68a08e"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp37-cp37m-win_amd64.whl", hash = "sha256:d1947c8d5aa26a6b73e01e0420b3936a731df516ce7413b3dcaadb1085a9ef57"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:293d8e8cac006fae6bf8676d0c2440c5f3921763420bd2a4deacfd8153289700"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:e6b9ef224a5d82416135a082977013f8e3b64269756801fbcbfa7d2303fb5b47"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:395b897b88f1b7d6cd91046f53ed8d61e921cc585c2dbd29711fb0846cca42ca"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d93db339a6cd51879b211c87d4918176a6520db577ecfb181bacacd3a4eda59f"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c2c0b9521041195aa91bfa66ac8043cc881517ec5a13192add6b90e1c7cb6ac0"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:12a8cc62b158df1f950bad577c0e600e1291a99f5d7e8b38c360185495e53db2"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp38-cp38-win32.whl", hash = "sha256:5d871ef12fcb9d5c2a979cc9b0a210d94619fc06817c352e938bb8bde8a3db1a"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp38-cp38-win_amd64.whl", hash = "sha256:a91c65cc13e4d125e4e85d40092e0473e346e0b4885451e23e68083111a4c6ba"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:d3fb6d66640af7593ae5873a600ed38e6081bb5286e668228caebe71b9d1a922"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:f8820fc0f72e183e642374c6484223b6218dedacd8d99cb4b69755ce75c68614"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:cf24f2ac79425af04c203620f61f6a9e7f8512051ef24614c1551b7e6401b291"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:673a46d2fde818650f7955d1ed857a784b62c53e2f02a57ecb2566eeb84bc1dc"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:5b9a412936481417c1a42b681c1664166ccb5b9128093eb05ebb4f2be7ae57ef"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:288a013d10081fb2e917db848d0a161b87dadd7922c5372e3b60e5506cd172a0"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp39-cp39-win32.whl", hash = "sha256:feda842ccce2a10ed90f3ffc087681ab6a731bb80ed3a52dbe0c01e41db02929"}, - {file = "json_stream_rs_tokenizer-0.4.25-cp39-cp39-win_amd64.whl", hash = "sha256:1beb4fddcdf9fdd787d502532ceedeb3ce60a59ab1c8b19e0a3fd63367ab9e3c"}, - {file = "json_stream_rs_tokenizer-0.4.25-pp37-pypy37_pp73-macosx_10_9_x86_64.whl", hash = "sha256:eaef5abd7fdf496bf00a2d9310d60c52d982ea6fd079578f2f8c969a0c65413e"}, - {file = "json_stream_rs_tokenizer-0.4.25-pp37-pypy37_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:643f50bb351f4c81488d98b50499ce4d30f767a15a47a1baf80a990e6331836e"}, - {file = "json_stream_rs_tokenizer-0.4.25-pp37-pypy37_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:05df3f38088ec79f8ac5b154f73a55b51e2869f0b8b68f82e807779e30f29110"}, - {file = "json_stream_rs_tokenizer-0.4.25-pp37-pypy37_pp73-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e6e73e84a38252edfb3f80c9bc1247639530f21108786982c5156475da884756"}, - {file = "json_stream_rs_tokenizer-0.4.25-pp37-pypy37_pp73-win_amd64.whl", hash = "sha256:8f886d294dd13bf07e66808823c38d3d1c55221c4f24b4e5ce6bc30addfa387b"}, - {file = "json_stream_rs_tokenizer-0.4.25-pp38-pypy38_pp73-macosx_10_9_x86_64.whl", hash = "sha256:4f863b65d557b9ce0edbe633cb7a37a6af1670d1e1a3d17638ed3ab8971fb6ae"}, - {file = "json_stream_rs_tokenizer-0.4.25-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e2059224a321ac2ef9585130ee1d766d3294054fe7db4554075d3975762a19cb"}, - {file = "json_stream_rs_tokenizer-0.4.25-pp38-pypy38_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fae3b89882013e3c01aa0c579de683d1fc2d81a0ba573f9b196213afba67d763"}, - {file = "json_stream_rs_tokenizer-0.4.25-pp38-pypy38_pp73-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ac36c8018abefe6b31dee9d2b27edea74747fbe3dd517da618a6ceead89f63fc"}, - {file = "json_stream_rs_tokenizer-0.4.25-pp38-pypy38_pp73-win_amd64.whl", hash = "sha256:86e11b136f2e58147f3ec3fb0d0148eb7ebb67c52074766a13583af4ab060e72"}, - {file = "json_stream_rs_tokenizer-0.4.25-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:ee2d5b7f31aaf897467765eb8cdd863715654d37af0c3a38d3e9cd4a67161eb1"}, - {file = "json_stream_rs_tokenizer-0.4.25-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c8266fbe792c34102525b4b152edd122a03f3501af139f75a670ed187ea793c0"}, - {file = "json_stream_rs_tokenizer-0.4.25-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:907d1f5bed0d721a2ac1eb30d58d4117d55267059e17e055abe2b3e58e7517a4"}, - {file = "json_stream_rs_tokenizer-0.4.25-pp39-pypy39_pp73-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7568a7df0514e5fa356055dfdf5a035d118b3b82228104e7a484b4ddf7f94442"}, - {file = "json_stream_rs_tokenizer-0.4.25-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:5be0c4d185d63d1d25c820117b1081336cc1db8dad620266e0973fe2f47768b4"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:3d7ba1286cfd21e40d5e760d3243fed297ac96f399a7b0a023359493c88cc063"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:6732b85154f8839c4d5bb72d1ac754d208cf68c4c561e11ea50215c54768732d"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:aece97e3eec9b461d536b2a48730a7470300e959d9be15440d368cbd1622e5d4"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b810e58f4a60c82a135307ac4fafaeff217c5f415735e0621c01daac17928006"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:19411b947aa971bea5dbc31e658fcd05e3105487baca846a8263766c05c9ef28"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:8ae6ec41d5950d6ae30b520d9cdb2fa25b3c74ad128c624c943fc6c8f4c3c679"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp310-cp310-win32.whl", hash = "sha256:c9ab6db6590d01b887295fef3649b7b10a63ffdc9e1a61465919396560aaa5c0"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp310-cp310-win_amd64.whl", hash = "sha256:5a93ea03d507ddae7f30f6ed848fc40f6a74287d3bedcd972feafb58246f9300"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:54c9299ffc49bf9ad28243a1de8054f84d3ecc596cf9dc546879d34b7a647040"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:f228f9be80b3bcebd6f9315d444865207d3ee529bd6f5bbbdce214e45b4c345a"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e131332c33ae9c1e0080e82d4effad3f199957b7776a411d9d32ca154a25ad1f"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3f1d2fcfd410ab11da02760418d4f666be7b1fa7b8fefdad5b89f6c7a6ad2534"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:53971a6be4a3dc297c6b25f7da94d7d26724cdd39eced34242941c6d7b417f69"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:7a58affc3a30a1d6d0f47ec8e7bc9c6974282d8a805955dffc69b5f41706de14"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp311-cp311-win32.whl", hash = "sha256:8ccd75c480afa1f149b009c02dd0bd2561b92382d8dbfb1fb630d75baa517f9a"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp311-cp311-win_amd64.whl", hash = "sha256:c5146105d07886448e0994e74b9063d0476a486cd5cd64cf0de1edd16da2ecba"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:36d832c9e6cbde17ff6077a11244010a9abfc2829c3a1484f8deb60f7df49f2b"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:aed527ed830b40e41ed121432e0d938367af57aec5c78bd84f043da1dd3a93b4"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b7d8c983c9d61925960a3d5967ae5d88d556abb7e7bddb4e77dc910eee5323f1"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c115e4decb5c00266e7df98163bc27db2d1675f94fc4efc66bc1a30cf47ddbc3"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:68a39fca288c69c93cde1eca4f4ce406006dd7fb82f45f35ec03294a60df57ed"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:52738f5943ae46faf0aa9a6e9c255a862f851048e9381e03a77c9813d954506c"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp312-cp312-win32.whl", hash = "sha256:032443bcce5ff0d01d83118f12d73ae2719c87d6a3ae69d4e4e286c1b2eaf89a"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp312-cp312-win_amd64.whl", hash = "sha256:f6de65c96f9c89c3b1fd0017e1da7780b1a1f90e0cded56bfec6d27b797b216f"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp37-cp37m-macosx_10_12_x86_64.whl", hash = "sha256:2f44364ae4b5e436d3ce747fff87a23d727bf6e588e9362cb3baafb393eb8686"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b1f5d0b3edab41c4c81d837f516af78ed2788529e20c543500178b9277715aaf"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5195a148e9f48ae124fc145b67c1e5d7b94b99e3ad93bd40f313791fa406559f"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d75ecbbbbeeadb85c7f8925150082642f028b175b497576ceb942c7c35708ac1"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:dbe20cc5f4b470b9f96fb3883af7e496e1240254f14b60c89363653969d9234b"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp37-cp37m-win32.whl", hash = "sha256:ac2fbd27df2f2b12060adad87ea4ca8ade83911384d5550ebb36c65bd669bf8c"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp37-cp37m-win_amd64.whl", hash = "sha256:7270aaf5d1ea12eed2999cf5c1c0e8d104eb4567344f92d72fe49beb151a5a8a"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp38-cp38-macosx_10_12_x86_64.whl", hash = "sha256:e292cf982bc6e2d08b530d7def911e10241def91abbb7c588df8a31c104b1023"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:53fc7c349aee5b9607e1e407e6ae1c3c777a90dbf983c5ed940ab263a240f931"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b29a5da95daad2754d94ad9b651af1a9344e6f53de69362d42171e52c4e1b4a9"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bf5feada788eed35522193b9f8407ef94ea20f57b66dcac7b2f64ea5a0ce4665"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a84b3c818dc441e099925c6cb92f50e69752463b87773138c3f183437273a0a0"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:b2423e7e9d7905699a8f94a21c1efa75123b625324649b9d0ea6d5ff733c44e3"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp38-cp38-win32.whl", hash = "sha256:7c88a7eb589e30d153d647b86870a4fbfc51d4b401b8cca387322f3f8df0d5bb"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp38-cp38-win_amd64.whl", hash = "sha256:65d9d3ba922044b87932570db22cde64c9c94094330189d8d5f6dddb7e6617b9"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp39-cp39-macosx_10_12_x86_64.whl", hash = "sha256:abfd978e12603889ba63b777eaf3bd4be7ed0763798ab180d2d26a00777b7b70"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:5534ccd989fa095b6516031d299633f160f15bad1438897adffcdb7d454abc8d"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3f2aeef6be44cf3d1044686d2fb74c5bc258de4f329770bef561753f16d2bb31"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b9ea6d9ef5b975b5d14750dff20bad114d2f2e363de8a28ad65a0802e59af0ea"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:97d187f2b8d53e2a3d746906b22008fc3278a5c52406bda9dd0f619815d41771"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:72edb7950dad7d7a549c54953680c6d6ed11cd2cdc4deb245d70a70922624226"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp39-cp39-win32.whl", hash = "sha256:2414d4e203a3645344954a00dbda321f2a9dbe1461c0a0837f3991377290891c"}, + {file = "json_stream_rs_tokenizer-0.4.27-cp39-cp39-win_amd64.whl", hash = "sha256:d1273178fe559c5fd5532ed928a4a826081b483804f37c7b5bcd9ed2b974571d"}, + {file = "json_stream_rs_tokenizer-0.4.27-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:1141b3630c47b7bd06c65cf75c4333c43a3f9239dcd316be3ad236865407fc6a"}, + {file = "json_stream_rs_tokenizer-0.4.27-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ce7782d854469c0d618af6d3b8c4ad72880a813e826a808cbbc6ee17973c6d6d"}, + {file = "json_stream_rs_tokenizer-0.4.27-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fad046fdf59f6bf164d7bea12bb124b9f6c5ed4873408c8bc657b329656a090d"}, + {file = "json_stream_rs_tokenizer-0.4.27-pp310-pypy310_pp73-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:83d421ab371901d2ca1d8c4645b764dd7bb72acfa1232cebb10d84fb68b4dba3"}, + {file = "json_stream_rs_tokenizer-0.4.27-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:d5cbaf3c9c03e69b9491ce1f36c1a26c7297304870b2b619649826c622e1c8d5"}, + {file = "json_stream_rs_tokenizer-0.4.27-pp37-pypy37_pp73-macosx_10_12_x86_64.whl", hash = "sha256:200fe73cd74ba8ecc2d7b0610026833fb687ed8ca9dc2d62ff3b91a92cd5031d"}, + {file = "json_stream_rs_tokenizer-0.4.27-pp37-pypy37_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0b65a63a564eb6f893a5e2d7db6bb7692f6b0d10f64d0bc035a5ba241ac06a1f"}, + {file = "json_stream_rs_tokenizer-0.4.27-pp37-pypy37_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bd107745de8a163f535b07e5db6e0d23d3bf764efc20b4ab89f1f5c843ae015f"}, + {file = "json_stream_rs_tokenizer-0.4.27-pp37-pypy37_pp73-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:5968705904c4b0033248defb90c9063f04d3dc160de5027724883200a3a0303e"}, + {file = "json_stream_rs_tokenizer-0.4.27-pp37-pypy37_pp73-win_amd64.whl", hash = "sha256:05a68b06b7ac026435af3600d4dd6732f337f946155190b05efeb0f58469110e"}, + {file = "json_stream_rs_tokenizer-0.4.27-pp38-pypy38_pp73-macosx_10_12_x86_64.whl", hash = "sha256:61b29047feaf92444009a3298a79b1637a31fe00a20b30033b83051061b686f1"}, + {file = "json_stream_rs_tokenizer-0.4.27-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5fe5273e4abc64f8a70f9dbdbb1438c004f129c5370e9746bcf76e7e9bc603c7"}, + {file = "json_stream_rs_tokenizer-0.4.27-pp38-pypy38_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6179fa11091e756cda28bc3550c6d2c131e196b9abf48858bb17aa481d4f957e"}, + {file = "json_stream_rs_tokenizer-0.4.27-pp38-pypy38_pp73-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:59b91f108745114e7d91b860f46a41e940dfd35ec86f354f050015a8b8bb44ef"}, + {file = "json_stream_rs_tokenizer-0.4.27-pp38-pypy38_pp73-win_amd64.whl", hash = "sha256:6e1d25661feb3c38c459e0bcd72d99ff17fe357d0e845c2a774a7518506de695"}, + {file = "json_stream_rs_tokenizer-0.4.27-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:d5b40e047521ebf00600551226abcb1e917022181f1472ea47bffcbf5b0b1101"}, + {file = "json_stream_rs_tokenizer-0.4.27-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6e926055ab7be6d864f1f8cdc13e43ece1f802d5040912d910a6c912051aa599"}, + {file = "json_stream_rs_tokenizer-0.4.27-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:06c64404586bf49e6f782a1f5768f579fe4906d892f252d7d55d8d22360c4f0b"}, + {file = "json_stream_rs_tokenizer-0.4.27-pp39-pypy39_pp73-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f04c20485daef5b93ed33093a808eab08b9d0ead005eede96e3f972b3ae028c6"}, + {file = "json_stream_rs_tokenizer-0.4.27-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:02834ed71f2e27b11e3cc8bb37f80dcf86f00f6b69c02bc508af32be04c79e72"}, + {file = "json_stream_rs_tokenizer-0.4.27.tar.gz", hash = "sha256:8c947c72966cc9b0076e0967077defae18c49a0600974c2829d48264240e2f72"}, ] [package.extras] benchmark = ["contexttimer (>=0.3,<0.4)", "json-stream-to-standard-types (>=0.1,<0.2)", "si-prefix (>=1.2,<2)", "tqdm (>=4.64,<5)", "typer (>=0.6,<0.7)"] test = ["json-stream (==2.3.2)", "json-stream-rs-tokenizer[benchmark]", "pytest (>7.1,<8)"] -[[package]] -name = "mccabe" -version = "0.7.0" -description = "McCabe checker, plugin for flake8" -optional = false -python-versions = ">=3.6" -files = [ - {file = "mccabe-0.7.0-py2.py3-none-any.whl", hash = "sha256:6c2d30ab6be0e4a46919781807b4f0d834ebdd6c6e3dca0bda5a15f863427b6e"}, - {file = "mccabe-0.7.0.tar.gz", hash = "sha256:348e0240c33b60bbdf4e523192ef919f28cb2c3d7d5c7794f74009290f236325"}, -] - -[[package]] -name = "mypy-extensions" -version = "1.0.0" -description = "Type system extensions for programs checked with the mypy type checker." -optional = false -python-versions = ">=3.5" -files = [ - {file = "mypy_extensions-1.0.0-py3-none-any.whl", hash = "sha256:4392f6c0eb8a5668a69e23d168ffa70f0be9ccfd32b5cc2d26a34ae5b844552d"}, - {file = "mypy_extensions-1.0.0.tar.gz", hash = "sha256:75dbf8955dc00442a438fc4d0666508a9a97b6bd41aa2f0ffe9d2f2725af0782"}, -] - [[package]] name = "packaging" -version = "23.2" +version = "24.2" description = "Core utilities for Python packages" optional = false -python-versions = ">=3.7" -files = [ - {file = "packaging-23.2-py3-none-any.whl", hash = "sha256:8c491190033a9af7e1d931d0b5dacc2ef47509b34dd0de67ed209b5203fc88c7"}, - {file = "packaging-23.2.tar.gz", hash = "sha256:048fb0e9405036518eaaf48a55953c750c11e1a1b68e0dd1a9d62ed0c092cfc5"}, -] - -[[package]] -name = "pathspec" -version = "0.11.2" -description = "Utility library for gitignore style pattern matching of file paths." -optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" +groups = ["dev"] files = [ - {file = "pathspec-0.11.2-py3-none-any.whl", hash = "sha256:1d6ed233af05e679efb96b1851550ea95bbb64b7c490b0f5aa52996c11e92a20"}, - {file = "pathspec-0.11.2.tar.gz", hash = "sha256:e0d8d0ac2f12da61956eb2306b69f9469b42f4deb0f3cb6ed47b9cce9996ced3"}, + {file = "packaging-24.2-py3-none-any.whl", hash = "sha256:09abb1bccd265c01f4a3aa3f7a7db064b36514d2cba19a2f694fe6150451a759"}, + {file = "packaging-24.2.tar.gz", hash = "sha256:c228a6dc5e932d346bc5739379109d49e8853dd8223571c7c5b55260edc0b97f"}, ] [[package]] name = "platformdirs" -version = "4.1.0" -description = "A small Python package for determining appropriate platform-specific dirs, e.g. a \"user data dir\"." +version = "4.3.6" +description = "A small Python package for determining appropriate platform-specific dirs, e.g. a `user data dir`." optional = false python-versions = ">=3.8" +groups = ["dev"] files = [ - {file = "platformdirs-4.1.0-py3-none-any.whl", hash = "sha256:11c8f37bcca40db96d8144522d925583bdb7a31f7b0e37e3ed4318400a8e2380"}, - {file = "platformdirs-4.1.0.tar.gz", hash = "sha256:906d548203468492d432bcb294d4bc2fff751bf84971fbb2c10918cc206ee420"}, + {file = "platformdirs-4.3.6-py3-none-any.whl", hash = "sha256:73e575e1408ab8103900836b97580d5307456908a03e92031bab39e4554cc3fb"}, + {file = "platformdirs-4.3.6.tar.gz", hash = "sha256:357fb2acbc885b0419afd3ce3ed34564c13c9b95c89360cd9563f73aa5e2b907"}, ] [package.extras] -docs = ["furo (>=2023.7.26)", "proselint (>=0.13)", "sphinx (>=7.1.1)", "sphinx-autodoc-typehints (>=1.24)"] -test = ["appdirs (==1.4.4)", "covdefaults (>=2.3)", "pytest (>=7.4)", "pytest-cov (>=4.1)", "pytest-mock (>=3.11.1)"] +docs = ["furo (>=2024.8.6)", "proselint (>=0.14)", "sphinx (>=8.0.2)", "sphinx-autodoc-typehints (>=2.4)"] +test = ["appdirs (==1.4.4)", "covdefaults (>=2.3)", "pytest (>=8.3.2)", "pytest-cov (>=5)", "pytest-mock (>=3.14)"] +type = ["mypy (>=1.11.2)"] [[package]] name = "pluggy" -version = "1.3.0" +version = "1.5.0" description = "plugin and hook calling mechanisms for python" optional = false python-versions = ">=3.8" +groups = ["dev"] files = [ - {file = "pluggy-1.3.0-py3-none-any.whl", hash = "sha256:d89c696a773f8bd377d18e5ecda92b7a3793cbe66c87060a6fb58c7b6e1061f7"}, - {file = "pluggy-1.3.0.tar.gz", hash = "sha256:cf61ae8f126ac6f7c451172cf30e3e43d3ca77615509771b3a984a0730651e12"}, + {file = "pluggy-1.5.0-py3-none-any.whl", hash = "sha256:44e1ad92c8ca002de6377e165f3e0f1be63266ab4d554740532335b9d75ea669"}, + {file = "pluggy-1.5.0.tar.gz", hash = "sha256:2cffa88e94fdc978c4c574f15f9e59b7f4201d439195c3715ca9e2486f1d0cf1"}, ] [package.extras] dev = ["pre-commit", "tox"] testing = ["pytest", "pytest-benchmark"] -[[package]] -name = "pycodestyle" -version = "2.9.1" -description = "Python style guide checker" -optional = false -python-versions = ">=3.6" -files = [ - {file = "pycodestyle-2.9.1-py2.py3-none-any.whl", hash = "sha256:d1735fc58b418fd7c5f658d28d943854f8a849b01a5d0a1e6f3f3fdd0166804b"}, - {file = "pycodestyle-2.9.1.tar.gz", hash = "sha256:2c9607871d58c76354b697b42f5d57e1ada7d261c261efac224b664affdc5785"}, -] - [[package]] name = "pydantic" -version = "1.10.13" -description = "Data validation and settings management using python type hints" +version = "2.10.6" +description = "Data validation using Python type hints" optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" +groups = ["main"] files = [ - {file = "pydantic-1.10.13-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:efff03cc7a4f29d9009d1c96ceb1e7a70a65cfe86e89d34e4a5f2ab1e5693737"}, - {file = "pydantic-1.10.13-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:3ecea2b9d80e5333303eeb77e180b90e95eea8f765d08c3d278cd56b00345d01"}, - {file = "pydantic-1.10.13-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1740068fd8e2ef6eb27a20e5651df000978edce6da6803c2bef0bc74540f9548"}, - {file = "pydantic-1.10.13-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:84bafe2e60b5e78bc64a2941b4c071a4b7404c5c907f5f5a99b0139781e69ed8"}, - {file = "pydantic-1.10.13-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:bc0898c12f8e9c97f6cd44c0ed70d55749eaf783716896960b4ecce2edfd2d69"}, - {file = "pydantic-1.10.13-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:654db58ae399fe6434e55325a2c3e959836bd17a6f6a0b6ca8107ea0571d2e17"}, - {file = "pydantic-1.10.13-cp310-cp310-win_amd64.whl", hash = "sha256:75ac15385a3534d887a99c713aa3da88a30fbd6204a5cd0dc4dab3d770b9bd2f"}, - {file = "pydantic-1.10.13-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:c553f6a156deb868ba38a23cf0df886c63492e9257f60a79c0fd8e7173537653"}, - {file = "pydantic-1.10.13-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:5e08865bc6464df8c7d61439ef4439829e3ab62ab1669cddea8dd00cd74b9ffe"}, - {file = "pydantic-1.10.13-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e31647d85a2013d926ce60b84f9dd5300d44535a9941fe825dc349ae1f760df9"}, - {file = "pydantic-1.10.13-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:210ce042e8f6f7c01168b2d84d4c9eb2b009fe7bf572c2266e235edf14bacd80"}, - {file = "pydantic-1.10.13-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:8ae5dd6b721459bfa30805f4c25880e0dd78fc5b5879f9f7a692196ddcb5a580"}, - {file = "pydantic-1.10.13-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:f8e81fc5fb17dae698f52bdd1c4f18b6ca674d7068242b2aff075f588301bbb0"}, - {file = "pydantic-1.10.13-cp311-cp311-win_amd64.whl", hash = "sha256:61d9dce220447fb74f45e73d7ff3b530e25db30192ad8d425166d43c5deb6df0"}, - {file = "pydantic-1.10.13-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:4b03e42ec20286f052490423682016fd80fda830d8e4119f8ab13ec7464c0132"}, - {file = "pydantic-1.10.13-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f59ef915cac80275245824e9d771ee939133be38215555e9dc90c6cb148aaeb5"}, - {file = "pydantic-1.10.13-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:5a1f9f747851338933942db7af7b6ee8268568ef2ed86c4185c6ef4402e80ba8"}, - {file = "pydantic-1.10.13-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:97cce3ae7341f7620a0ba5ef6cf043975cd9d2b81f3aa5f4ea37928269bc1b87"}, - {file = "pydantic-1.10.13-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:854223752ba81e3abf663d685f105c64150873cc6f5d0c01d3e3220bcff7d36f"}, - {file = "pydantic-1.10.13-cp37-cp37m-win_amd64.whl", hash = "sha256:b97c1fac8c49be29486df85968682b0afa77e1b809aff74b83081cc115e52f33"}, - {file = "pydantic-1.10.13-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:c958d053453a1c4b1c2062b05cd42d9d5c8eb67537b8d5a7e3c3032943ecd261"}, - {file = "pydantic-1.10.13-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:4c5370a7edaac06daee3af1c8b1192e305bc102abcbf2a92374b5bc793818599"}, - {file = "pydantic-1.10.13-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7d6f6e7305244bddb4414ba7094ce910560c907bdfa3501e9db1a7fd7eaea127"}, - {file = "pydantic-1.10.13-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d3a3c792a58e1622667a2837512099eac62490cdfd63bd407993aaf200a4cf1f"}, - {file = "pydantic-1.10.13-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:c636925f38b8db208e09d344c7aa4f29a86bb9947495dd6b6d376ad10334fb78"}, - {file = "pydantic-1.10.13-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:678bcf5591b63cc917100dc50ab6caebe597ac67e8c9ccb75e698f66038ea953"}, - {file = "pydantic-1.10.13-cp38-cp38-win_amd64.whl", hash = "sha256:6cf25c1a65c27923a17b3da28a0bdb99f62ee04230c931d83e888012851f4e7f"}, - {file = "pydantic-1.10.13-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:8ef467901d7a41fa0ca6db9ae3ec0021e3f657ce2c208e98cd511f3161c762c6"}, - {file = "pydantic-1.10.13-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:968ac42970f57b8344ee08837b62f6ee6f53c33f603547a55571c954a4225691"}, - {file = "pydantic-1.10.13-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9849f031cf8a2f0a928fe885e5a04b08006d6d41876b8bbd2fc68a18f9f2e3fd"}, - {file = "pydantic-1.10.13-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:56e3ff861c3b9c6857579de282ce8baabf443f42ffba355bf070770ed63e11e1"}, - {file = "pydantic-1.10.13-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:9f00790179497767aae6bcdc36355792c79e7bbb20b145ff449700eb076c5f96"}, - {file = "pydantic-1.10.13-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:75b297827b59bc229cac1a23a2f7a4ac0031068e5be0ce385be1462e7e17a35d"}, - {file = "pydantic-1.10.13-cp39-cp39-win_amd64.whl", hash = "sha256:e70ca129d2053fb8b728ee7d1af8e553a928d7e301a311094b8a0501adc8763d"}, - {file = "pydantic-1.10.13-py3-none-any.whl", hash = "sha256:b87326822e71bd5f313e7d3bfdc77ac3247035ac10b0c0618bd99dcf95b1e687"}, - {file = "pydantic-1.10.13.tar.gz", hash = "sha256:32c8b48dcd3b2ac4e78b0ba4af3a2c2eb6048cb75202f0ea7b34feb740efc340"}, + {file = "pydantic-2.10.6-py3-none-any.whl", hash = "sha256:427d664bf0b8a2b34ff5dd0f5a18df00591adcee7198fbd71981054cef37b584"}, + {file = "pydantic-2.10.6.tar.gz", hash = "sha256:ca5daa827cce33de7a42be142548b0096bf05a7e7b365aebfa5f8eeec7128236"}, ] [package.dependencies] -typing-extensions = ">=4.2.0" +annotated-types = ">=0.6.0" +pydantic-core = "2.27.2" +typing-extensions = ">=4.12.2" [package.extras] -dotenv = ["python-dotenv (>=0.10.4)"] -email = ["email-validator (>=1.0.3)"] +email = ["email-validator (>=2.0.0)"] +timezone = ["tzdata"] [[package]] -name = "pyflakes" -version = "2.5.0" -description = "passive checker of Python programs" +name = "pydantic-core" +version = "2.27.2" +description = "Core functionality for Pydantic validation and serialization" optional = false -python-versions = ">=3.6" +python-versions = ">=3.8" +groups = ["main"] files = [ - {file = "pyflakes-2.5.0-py2.py3-none-any.whl", hash = "sha256:4579f67d887f804e67edb544428f264b7b24f435b263c4614f384135cea553d2"}, - {file = "pyflakes-2.5.0.tar.gz", hash = "sha256:491feb020dca48ccc562a8c0cbe8df07ee13078df59813b83959cbdada312ea3"}, + {file = "pydantic_core-2.27.2-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:2d367ca20b2f14095a8f4fa1210f5a7b78b8a20009ecced6b12818f455b1e9fa"}, + {file = "pydantic_core-2.27.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:491a2b73db93fab69731eaee494f320faa4e093dbed776be1a829c2eb222c34c"}, + {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7969e133a6f183be60e9f6f56bfae753585680f3b7307a8e555a948d443cc05a"}, + {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:3de9961f2a346257caf0aa508a4da705467f53778e9ef6fe744c038119737ef5"}, + {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e2bb4d3e5873c37bb3dd58714d4cd0b0e6238cebc4177ac8fe878f8b3aa8e74c"}, + {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:280d219beebb0752699480fe8f1dc61ab6615c2046d76b7ab7ee38858de0a4e7"}, + {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:47956ae78b6422cbd46f772f1746799cbb862de838fd8d1fbd34a82e05b0983a"}, + {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:14d4a5c49d2f009d62a2a7140d3064f686d17a5d1a268bc641954ba181880236"}, + {file = "pydantic_core-2.27.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:337b443af21d488716f8d0b6164de833e788aa6bd7e3a39c005febc1284f4962"}, + {file = "pydantic_core-2.27.2-cp310-cp310-musllinux_1_1_armv7l.whl", hash = "sha256:03d0f86ea3184a12f41a2d23f7ccb79cdb5a18e06993f8a45baa8dfec746f0e9"}, + {file = "pydantic_core-2.27.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:7041c36f5680c6e0f08d922aed302e98b3745d97fe1589db0a3eebf6624523af"}, + {file = "pydantic_core-2.27.2-cp310-cp310-win32.whl", hash = "sha256:50a68f3e3819077be2c98110c1f9dcb3817e93f267ba80a2c05bb4f8799e2ff4"}, + {file = "pydantic_core-2.27.2-cp310-cp310-win_amd64.whl", hash = "sha256:e0fd26b16394ead34a424eecf8a31a1f5137094cabe84a1bcb10fa6ba39d3d31"}, + {file = "pydantic_core-2.27.2-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:8e10c99ef58cfdf2a66fc15d66b16c4a04f62bca39db589ae8cba08bc55331bc"}, + {file = "pydantic_core-2.27.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:26f32e0adf166a84d0cb63be85c562ca8a6fa8de28e5f0d92250c6b7e9e2aff7"}, + {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8c19d1ea0673cd13cc2f872f6c9ab42acc4e4f492a7ca9d3795ce2b112dd7e15"}, + {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:5e68c4446fe0810e959cdff46ab0a41ce2f2c86d227d96dc3847af0ba7def306"}, + {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d9640b0059ff4f14d1f37321b94061c6db164fbe49b334b31643e0528d100d99"}, + {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:40d02e7d45c9f8af700f3452f329ead92da4c5f4317ca9b896de7ce7199ea459"}, + {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1c1fd185014191700554795c99b347d64f2bb637966c4cfc16998a0ca700d048"}, + {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:d81d2068e1c1228a565af076598f9e7451712700b673de8f502f0334f281387d"}, + {file = "pydantic_core-2.27.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:1a4207639fb02ec2dbb76227d7c751a20b1a6b4bc52850568e52260cae64ca3b"}, + {file = "pydantic_core-2.27.2-cp311-cp311-musllinux_1_1_armv7l.whl", hash = "sha256:3de3ce3c9ddc8bbd88f6e0e304dea0e66d843ec9de1b0042b0911c1663ffd474"}, + {file = "pydantic_core-2.27.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:30c5f68ded0c36466acede341551106821043e9afaad516adfb6e8fa80a4e6a6"}, + {file = "pydantic_core-2.27.2-cp311-cp311-win32.whl", hash = "sha256:c70c26d2c99f78b125a3459f8afe1aed4d9687c24fd677c6a4436bc042e50d6c"}, + {file = "pydantic_core-2.27.2-cp311-cp311-win_amd64.whl", hash = "sha256:08e125dbdc505fa69ca7d9c499639ab6407cfa909214d500897d02afb816e7cc"}, + {file = "pydantic_core-2.27.2-cp311-cp311-win_arm64.whl", hash = "sha256:26f0d68d4b235a2bae0c3fc585c585b4ecc51382db0e3ba402a22cbc440915e4"}, + {file = "pydantic_core-2.27.2-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:9e0c8cfefa0ef83b4da9588448b6d8d2a2bf1a53c3f1ae5fca39eb3061e2f0b0"}, + {file = "pydantic_core-2.27.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:83097677b8e3bd7eaa6775720ec8e0405f1575015a463285a92bfdfe254529ef"}, + {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:172fce187655fece0c90d90a678424b013f8fbb0ca8b036ac266749c09438cb7"}, + {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:519f29f5213271eeeeb3093f662ba2fd512b91c5f188f3bb7b27bc5973816934"}, + {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:05e3a55d124407fffba0dd6b0c0cd056d10e983ceb4e5dbd10dda135c31071d6"}, + {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:9c3ed807c7b91de05e63930188f19e921d1fe90de6b4f5cd43ee7fcc3525cb8c"}, + {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6fb4aadc0b9a0c063206846d603b92030eb6f03069151a625667f982887153e2"}, + {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:28ccb213807e037460326424ceb8b5245acb88f32f3d2777427476e1b32c48c4"}, + {file = "pydantic_core-2.27.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:de3cd1899e2c279b140adde9357c4495ed9d47131b4a4eaff9052f23398076b3"}, + {file = "pydantic_core-2.27.2-cp312-cp312-musllinux_1_1_armv7l.whl", hash = "sha256:220f892729375e2d736b97d0e51466252ad84c51857d4d15f5e9692f9ef12be4"}, + {file = "pydantic_core-2.27.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:a0fcd29cd6b4e74fe8ddd2c90330fd8edf2e30cb52acda47f06dd615ae72da57"}, + {file = "pydantic_core-2.27.2-cp312-cp312-win32.whl", hash = "sha256:1e2cb691ed9834cd6a8be61228471d0a503731abfb42f82458ff27be7b2186fc"}, + {file = "pydantic_core-2.27.2-cp312-cp312-win_amd64.whl", hash = "sha256:cc3f1a99a4f4f9dd1de4fe0312c114e740b5ddead65bb4102884b384c15d8bc9"}, + {file = "pydantic_core-2.27.2-cp312-cp312-win_arm64.whl", hash = "sha256:3911ac9284cd8a1792d3cb26a2da18f3ca26c6908cc434a18f730dc0db7bfa3b"}, + {file = "pydantic_core-2.27.2-cp313-cp313-macosx_10_12_x86_64.whl", hash = "sha256:7d14bd329640e63852364c306f4d23eb744e0f8193148d4044dd3dacdaacbd8b"}, + {file = "pydantic_core-2.27.2-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:82f91663004eb8ed30ff478d77c4d1179b3563df6cdb15c0817cd1cdaf34d154"}, + {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:71b24c7d61131bb83df10cc7e687433609963a944ccf45190cfc21e0887b08c9"}, + {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:fa8e459d4954f608fa26116118bb67f56b93b209c39b008277ace29937453dc9"}, + {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ce8918cbebc8da707ba805b7fd0b382816858728ae7fe19a942080c24e5b7cd1"}, + {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:eda3f5c2a021bbc5d976107bb302e0131351c2ba54343f8a496dc8783d3d3a6a"}, + {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bd8086fa684c4775c27f03f062cbb9eaa6e17f064307e86b21b9e0abc9c0f02e"}, + {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:8d9b3388db186ba0c099a6d20f0604a44eabdeef1777ddd94786cdae158729e4"}, + {file = "pydantic_core-2.27.2-cp313-cp313-musllinux_1_1_aarch64.whl", hash = "sha256:7a66efda2387de898c8f38c0cf7f14fca0b51a8ef0b24bfea5849f1b3c95af27"}, + {file = "pydantic_core-2.27.2-cp313-cp313-musllinux_1_1_armv7l.whl", hash = "sha256:18a101c168e4e092ab40dbc2503bdc0f62010e95d292b27827871dc85450d7ee"}, + {file = "pydantic_core-2.27.2-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:ba5dd002f88b78a4215ed2f8ddbdf85e8513382820ba15ad5ad8955ce0ca19a1"}, + {file = "pydantic_core-2.27.2-cp313-cp313-win32.whl", hash = "sha256:1ebaf1d0481914d004a573394f4be3a7616334be70261007e47c2a6fe7e50130"}, + {file = "pydantic_core-2.27.2-cp313-cp313-win_amd64.whl", hash = "sha256:953101387ecf2f5652883208769a79e48db18c6df442568a0b5ccd8c2723abee"}, + {file = "pydantic_core-2.27.2-cp313-cp313-win_arm64.whl", hash = "sha256:ac4dbfd1691affb8f48c2c13241a2e3b60ff23247cbcf981759c768b6633cf8b"}, + {file = "pydantic_core-2.27.2-cp38-cp38-macosx_10_12_x86_64.whl", hash = "sha256:d3e8d504bdd3f10835468f29008d72fc8359d95c9c415ce6e767203db6127506"}, + {file = "pydantic_core-2.27.2-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:521eb9b7f036c9b6187f0b47318ab0d7ca14bd87f776240b90b21c1f4f149320"}, + {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:85210c4d99a0114f5a9481b44560d7d1e35e32cc5634c656bc48e590b669b145"}, + {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:d716e2e30c6f140d7560ef1538953a5cd1a87264c737643d481f2779fc247fe1"}, + {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:f66d89ba397d92f840f8654756196d93804278457b5fbede59598a1f9f90b228"}, + {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:669e193c1c576a58f132e3158f9dfa9662969edb1a250c54d8fa52590045f046"}, + {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9fdbe7629b996647b99c01b37f11170a57ae675375b14b8c13b8518b8320ced5"}, + {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:d262606bf386a5ba0b0af3b97f37c83d7011439e3dc1a9298f21efb292e42f1a"}, + {file = "pydantic_core-2.27.2-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:cabb9bcb7e0d97f74df8646f34fc76fbf793b7f6dc2438517d7a9e50eee4f14d"}, + {file = "pydantic_core-2.27.2-cp38-cp38-musllinux_1_1_armv7l.whl", hash = "sha256:d2d63f1215638d28221f664596b1ccb3944f6e25dd18cd3b86b0a4c408d5ebb9"}, + {file = "pydantic_core-2.27.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:bca101c00bff0adb45a833f8451b9105d9df18accb8743b08107d7ada14bd7da"}, + {file = "pydantic_core-2.27.2-cp38-cp38-win32.whl", hash = "sha256:f6f8e111843bbb0dee4cb6594cdc73e79b3329b526037ec242a3e49012495b3b"}, + {file = "pydantic_core-2.27.2-cp38-cp38-win_amd64.whl", hash = "sha256:fd1aea04935a508f62e0d0ef1f5ae968774a32afc306fb8545e06f5ff5cdf3ad"}, + {file = "pydantic_core-2.27.2-cp39-cp39-macosx_10_12_x86_64.whl", hash = "sha256:c10eb4f1659290b523af58fa7cffb452a61ad6ae5613404519aee4bfbf1df993"}, + {file = "pydantic_core-2.27.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:ef592d4bad47296fb11f96cd7dc898b92e795032b4894dfb4076cfccd43a9308"}, + {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c61709a844acc6bf0b7dce7daae75195a10aac96a596ea1b776996414791ede4"}, + {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:42c5f762659e47fdb7b16956c71598292f60a03aa92f8b6351504359dbdba6cf"}, + {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:4c9775e339e42e79ec99c441d9730fccf07414af63eac2f0e48e08fd38a64d76"}, + {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:57762139821c31847cfb2df63c12f725788bd9f04bc2fb392790959b8f70f118"}, + {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0d1e85068e818c73e048fe28cfc769040bb1f475524f4745a5dc621f75ac7630"}, + {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:097830ed52fd9e427942ff3b9bc17fab52913b2f50f2880dc4a5611446606a54"}, + {file = "pydantic_core-2.27.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:044a50963a614ecfae59bb1eaf7ea7efc4bc62f49ed594e18fa1e5d953c40e9f"}, + {file = "pydantic_core-2.27.2-cp39-cp39-musllinux_1_1_armv7l.whl", hash = "sha256:4e0b4220ba5b40d727c7f879eac379b822eee5d8fff418e9d3381ee45b3b0362"}, + {file = "pydantic_core-2.27.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:5e4f4bb20d75e9325cc9696c6802657b58bc1dbbe3022f32cc2b2b632c3fbb96"}, + {file = "pydantic_core-2.27.2-cp39-cp39-win32.whl", hash = "sha256:cca63613e90d001b9f2f9a9ceb276c308bfa2a43fafb75c8031c4f66039e8c6e"}, + {file = "pydantic_core-2.27.2-cp39-cp39-win_amd64.whl", hash = "sha256:77d1bca19b0f7021b3a982e6f903dcd5b2b06076def36a652e3907f596e29f67"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:2bf14caea37e91198329b828eae1618c068dfb8ef17bb33287a7ad4b61ac314e"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:b0cb791f5b45307caae8810c2023a184c74605ec3bcbb67d13846c28ff731ff8"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:688d3fd9fcb71f41c4c015c023d12a79d1c4c0732ec9eb35d96e3388a120dcf3"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3d591580c34f4d731592f0e9fe40f9cc1b430d297eecc70b962e93c5c668f15f"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:82f986faf4e644ffc189a7f1aafc86e46ef70372bb153e7001e8afccc6e54133"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:bec317a27290e2537f922639cafd54990551725fc844249e64c523301d0822fc"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-musllinux_1_1_armv7l.whl", hash = "sha256:0296abcb83a797db256b773f45773da397da75a08f5fcaef41f2044adec05f50"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:0d75070718e369e452075a6017fbf187f788e17ed67a3abd47fa934d001863d9"}, + {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:7e17b560be3c98a8e3aa66ce828bdebb9e9ac6ad5466fba92eb74c4c95cb1151"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:c33939a82924da9ed65dab5a65d427205a73181d8098e79b6b426bdf8ad4e656"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:00bad2484fa6bda1e216e7345a798bd37c68fb2d97558edd584942aa41b7d278"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c817e2b40aba42bac6f457498dacabc568c3b7a986fc9ba7c8d9d260b71485fb"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:251136cdad0cb722e93732cb45ca5299fb56e1344a833640bf93b2803f8d1bfd"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:d2088237af596f0a524d3afc39ab3b036e8adb054ee57cbb1dcf8e09da5b29cc"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:d4041c0b966a84b4ae7a09832eb691a35aec90910cd2dbe7a208de59be77965b"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-musllinux_1_1_armv7l.whl", hash = "sha256:8083d4e875ebe0b864ffef72a4304827015cff328a1be6e22cc850753bfb122b"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:f141ee28a0ad2123b6611b6ceff018039df17f32ada8b534e6aa039545a3efb2"}, + {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:7d0c8399fcc1848491f00e0314bd59fb34a9c008761bcb422a057670c3f65e35"}, + {file = "pydantic_core-2.27.2.tar.gz", hash = "sha256:eb026e5a4c1fee05726072337ff51d1efb6f59090b7da90d30ea58625b1ffb39"}, ] +[package.dependencies] +typing-extensions = ">=4.6.0,<4.7.0 || >4.7.0" + [[package]] name = "pyproject-api" -version = "1.6.1" +version = "1.8.0" description = "API to interact with the python pyproject.toml based projects" optional = false python-versions = ">=3.8" +groups = ["dev"] files = [ - {file = "pyproject_api-1.6.1-py3-none-any.whl", hash = "sha256:4c0116d60476b0786c88692cf4e325a9814965e2469c5998b830bba16b183675"}, - {file = "pyproject_api-1.6.1.tar.gz", hash = "sha256:1817dc018adc0d1ff9ca1ed8c60e1623d5aaca40814b953af14a9cf9a5cae538"}, + {file = "pyproject_api-1.8.0-py3-none-any.whl", hash = "sha256:3d7d347a047afe796fd5d1885b1e391ba29be7169bd2f102fcd378f04273d228"}, + {file = "pyproject_api-1.8.0.tar.gz", hash = "sha256:77b8049f2feb5d33eefcc21b57f1e279636277a8ac8ad6b5871037b243778496"}, ] [package.dependencies] -packaging = ">=23.1" +packaging = ">=24.1" tomli = {version = ">=2.0.1", markers = "python_version < \"3.11\""} [package.extras] -docs = ["furo (>=2023.8.19)", "sphinx (<7.2)", "sphinx-autodoc-typehints (>=1.24)"] -testing = ["covdefaults (>=2.3)", "pytest (>=7.4)", "pytest-cov (>=4.1)", "pytest-mock (>=3.11.1)", "setuptools (>=68.1.2)", "wheel (>=0.41.2)"] +docs = ["furo (>=2024.8.6)", "sphinx-autodoc-typehints (>=2.4.1)"] +testing = ["covdefaults (>=2.3)", "pytest (>=8.3.3)", "pytest-cov (>=5)", "pytest-mock (>=3.14)", "setuptools (>=75.1)"] [[package]] name = "pytest" -version = "7.4.3" +version = "8.3.5" description = "pytest: simple powerful testing with Python" optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" +groups = ["dev"] files = [ - {file = "pytest-7.4.3-py3-none-any.whl", hash = "sha256:0d009c083ea859a71b76adf7c1d502e4bc170b80a8ef002da5806527b9591fac"}, - {file = "pytest-7.4.3.tar.gz", hash = "sha256:d989d136982de4e3b29dabcc838ad581c64e8ed52c11fbe86ddebd9da0818cd5"}, + {file = "pytest-8.3.5-py3-none-any.whl", hash = "sha256:c69214aa47deac29fad6c2a4f590b9c4a9fdb16a403176fe154b79c0b4d4d820"}, + {file = "pytest-8.3.5.tar.gz", hash = "sha256:f4efe70cc14e511565ac476b57c279e12a855b11f48f212af1080ef2263d3845"}, ] [package.dependencies] @@ -438,111 +422,178 @@ colorama = {version = "*", markers = "sys_platform == \"win32\""} exceptiongroup = {version = ">=1.0.0rc8", markers = "python_version < \"3.11\""} iniconfig = "*" packaging = "*" -pluggy = ">=0.12,<2.0" -tomli = {version = ">=1.0.0", markers = "python_version < \"3.11\""} +pluggy = ">=1.5,<2" +tomli = {version = ">=1", markers = "python_version < \"3.11\""} [package.extras] -testing = ["argcomplete", "attrs (>=19.2.0)", "hypothesis (>=3.56)", "mock", "nose", "pygments (>=2.7.2)", "requests", "setuptools", "xmlschema"] +dev = ["argcomplete", "attrs (>=19.2)", "hypothesis (>=3.56)", "mock", "pygments (>=2.7.2)", "requests", "setuptools", "xmlschema"] [[package]] name = "python-dateutil" -version = "2.8.2" +version = "2.9.0.post0" description = "Extensions to the standard Python datetime module" optional = false python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7" +groups = ["main"] files = [ - {file = "python-dateutil-2.8.2.tar.gz", hash = "sha256:0123cacc1627ae19ddf3c27a5de5bd67ee4586fbdd6440d9748f8abb483d3e86"}, - {file = "python_dateutil-2.8.2-py2.py3-none-any.whl", hash = "sha256:961d03dc3453ebbc59dbdea9e4e11c5651520a876d0f4db161e8674aae935da9"}, + {file = "python-dateutil-2.9.0.post0.tar.gz", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3"}, + {file = "python_dateutil-2.9.0.post0-py2.py3-none-any.whl", hash = "sha256:a8b2bc7bffae282281c8140a97d3aa9c14da0b136dfe83f850eea9a5f7470427"}, ] [package.dependencies] six = ">=1.5" +[[package]] +name = "ruff" +version = "0.9.10" +description = "An extremely fast Python linter and code formatter, written in Rust." +optional = false +python-versions = ">=3.7" +groups = ["dev"] +files = [ + {file = "ruff-0.9.10-py3-none-linux_armv6l.whl", hash = "sha256:eb4d25532cfd9fe461acc83498361ec2e2252795b4f40b17e80692814329e42d"}, + {file = "ruff-0.9.10-py3-none-macosx_10_12_x86_64.whl", hash = "sha256:188a6638dab1aa9bb6228a7302387b2c9954e455fb25d6b4470cb0641d16759d"}, + {file = "ruff-0.9.10-py3-none-macosx_11_0_arm64.whl", hash = "sha256:5284dcac6b9dbc2fcb71fdfc26a217b2ca4ede6ccd57476f52a587451ebe450d"}, + {file = "ruff-0.9.10-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:47678f39fa2a3da62724851107f438c8229a3470f533894b5568a39b40029c0c"}, + {file = "ruff-0.9.10-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:99713a6e2766b7a17147b309e8c915b32b07a25c9efd12ada79f217c9c778b3e"}, + {file = "ruff-0.9.10-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:524ee184d92f7c7304aa568e2db20f50c32d1d0caa235d8ddf10497566ea1a12"}, + {file = "ruff-0.9.10-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:df92aeac30af821f9acf819fc01b4afc3dfb829d2782884f8739fb52a8119a16"}, + {file = "ruff-0.9.10-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:de42e4edc296f520bb84954eb992a07a0ec5a02fecb834498415908469854a52"}, + {file = "ruff-0.9.10-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:d257f95b65806104b6b1ffca0ea53f4ef98454036df65b1eda3693534813ecd1"}, + {file = "ruff-0.9.10-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b60dec7201c0b10d6d11be00e8f2dbb6f40ef1828ee75ed739923799513db24c"}, + {file = "ruff-0.9.10-py3-none-musllinux_1_2_aarch64.whl", hash = "sha256:d838b60007da7a39c046fcdd317293d10b845001f38bcb55ba766c3875b01e43"}, + {file = "ruff-0.9.10-py3-none-musllinux_1_2_armv7l.whl", hash = "sha256:ccaf903108b899beb8e09a63ffae5869057ab649c1e9231c05ae354ebc62066c"}, + {file = "ruff-0.9.10-py3-none-musllinux_1_2_i686.whl", hash = "sha256:f9567d135265d46e59d62dc60c0bfad10e9a6822e231f5b24032dba5a55be6b5"}, + {file = "ruff-0.9.10-py3-none-musllinux_1_2_x86_64.whl", hash = "sha256:5f202f0d93738c28a89f8ed9eaba01b7be339e5d8d642c994347eaa81c6d75b8"}, + {file = "ruff-0.9.10-py3-none-win32.whl", hash = "sha256:bfb834e87c916521ce46b1788fbb8484966e5113c02df216680102e9eb960029"}, + {file = "ruff-0.9.10-py3-none-win_amd64.whl", hash = "sha256:f2160eeef3031bf4b17df74e307d4c5fb689a6f3a26a2de3f7ef4044e3c484f1"}, + {file = "ruff-0.9.10-py3-none-win_arm64.whl", hash = "sha256:5fd804c0327a5e5ea26615550e706942f348b197d5475ff34c19733aee4b2e69"}, + {file = "ruff-0.9.10.tar.gz", hash = "sha256:9bacb735d7bada9cfb0f2c227d3658fc443d90a727b47f206fb33f52f3c0eac7"}, +] + [[package]] name = "six" -version = "1.16.0" +version = "1.17.0" description = "Python 2 and 3 compatibility utilities" optional = false -python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*" +python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7" +groups = ["main"] files = [ - {file = "six-1.16.0-py2.py3-none-any.whl", hash = "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254"}, - {file = "six-1.16.0.tar.gz", hash = "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926"}, + {file = "six-1.17.0-py2.py3-none-any.whl", hash = "sha256:4721f391ed90541fddacab5acf947aa0d3dc7d27b2e1e8eda2be8970586c3274"}, + {file = "six-1.17.0.tar.gz", hash = "sha256:ff70335d468e7eb6ec65b95b99d3a2836546063f63acc5171de367e834932a81"}, ] [[package]] name = "tomli" -version = "2.0.1" +version = "2.2.1" description = "A lil' TOML parser" optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" +groups = ["dev"] +markers = "python_version < \"3.11\"" files = [ - {file = "tomli-2.0.1-py3-none-any.whl", hash = "sha256:939de3e7a6161af0c887ef91b7d41a53e7c5a1ca976325f429cb46ea9bc30ecc"}, - {file = "tomli-2.0.1.tar.gz", hash = "sha256:de526c12914f0c550d15924c62d72abc48d6fe7364aa87328337a31007fe8a4f"}, + {file = "tomli-2.2.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:678e4fa69e4575eb77d103de3df8a895e1591b48e740211bd1067378c69e8249"}, + {file = "tomli-2.2.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:023aa114dd824ade0100497eb2318602af309e5a55595f76b626d6d9f3b7b0a6"}, + {file = "tomli-2.2.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ece47d672db52ac607a3d9599a9d48dcb2f2f735c6c2d1f34130085bb12b112a"}, + {file = "tomli-2.2.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6972ca9c9cc9f0acaa56a8ca1ff51e7af152a9f87fb64623e31d5c83700080ee"}, + {file = "tomli-2.2.1-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c954d2250168d28797dd4e3ac5cf812a406cd5a92674ee4c8f123c889786aa8e"}, + {file = "tomli-2.2.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:8dd28b3e155b80f4d54beb40a441d366adcfe740969820caf156c019fb5c7ec4"}, + {file = "tomli-2.2.1-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:e59e304978767a54663af13c07b3d1af22ddee3bb2fb0618ca1593e4f593a106"}, + {file = "tomli-2.2.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:33580bccab0338d00994d7f16f4c4ec25b776af3ffaac1ed74e0b3fc95e885a8"}, + {file = "tomli-2.2.1-cp311-cp311-win32.whl", hash = "sha256:465af0e0875402f1d226519c9904f37254b3045fc5084697cefb9bdde1ff99ff"}, + {file = "tomli-2.2.1-cp311-cp311-win_amd64.whl", hash = "sha256:2d0f2fdd22b02c6d81637a3c95f8cd77f995846af7414c5c4b8d0545afa1bc4b"}, + {file = "tomli-2.2.1-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:4a8f6e44de52d5e6c657c9fe83b562f5f4256d8ebbfe4ff922c495620a7f6cea"}, + {file = "tomli-2.2.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:8d57ca8095a641b8237d5b079147646153d22552f1c637fd3ba7f4b0b29167a8"}, + {file = "tomli-2.2.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4e340144ad7ae1533cb897d406382b4b6fede8890a03738ff1683af800d54192"}, + {file = "tomli-2.2.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:db2b95f9de79181805df90bedc5a5ab4c165e6ec3fe99f970d0e302f384ad222"}, + {file = "tomli-2.2.1-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:40741994320b232529c802f8bc86da4e1aa9f413db394617b9a256ae0f9a7f77"}, + {file = "tomli-2.2.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:400e720fe168c0f8521520190686ef8ef033fb19fc493da09779e592861b78c6"}, + {file = "tomli-2.2.1-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:02abe224de6ae62c19f090f68da4e27b10af2b93213d36cf44e6e1c5abd19fdd"}, + {file = "tomli-2.2.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:b82ebccc8c8a36f2094e969560a1b836758481f3dc360ce9a3277c65f374285e"}, + {file = "tomli-2.2.1-cp312-cp312-win32.whl", hash = "sha256:889f80ef92701b9dbb224e49ec87c645ce5df3fa2cc548664eb8a25e03127a98"}, + {file = "tomli-2.2.1-cp312-cp312-win_amd64.whl", hash = "sha256:7fc04e92e1d624a4a63c76474610238576942d6b8950a2d7f908a340494e67e4"}, + {file = "tomli-2.2.1-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:f4039b9cbc3048b2416cc57ab3bda989a6fcf9b36cf8937f01a6e731b64f80d7"}, + {file = "tomli-2.2.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:286f0ca2ffeeb5b9bd4fcc8d6c330534323ec51b2f52da063b11c502da16f30c"}, + {file = "tomli-2.2.1-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a92ef1a44547e894e2a17d24e7557a5e85a9e1d0048b0b5e7541f76c5032cb13"}, + {file = "tomli-2.2.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9316dc65bed1684c9a98ee68759ceaed29d229e985297003e494aa825ebb0281"}, + {file = "tomli-2.2.1-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e85e99945e688e32d5a35c1ff38ed0b3f41f43fad8df0bdf79f72b2ba7bc5272"}, + {file = "tomli-2.2.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:ac065718db92ca818f8d6141b5f66369833d4a80a9d74435a268c52bdfa73140"}, + {file = "tomli-2.2.1-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:d920f33822747519673ee656a4b6ac33e382eca9d331c87770faa3eef562aeb2"}, + {file = "tomli-2.2.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:a198f10c4d1b1375d7687bc25294306e551bf1abfa4eace6650070a5c1ae2744"}, + {file = "tomli-2.2.1-cp313-cp313-win32.whl", hash = "sha256:d3f5614314d758649ab2ab3a62d4f2004c825922f9e370b29416484086b264ec"}, + {file = "tomli-2.2.1-cp313-cp313-win_amd64.whl", hash = "sha256:a38aa0308e754b0e3c67e344754dff64999ff9b513e691d0e786265c93583c69"}, + {file = "tomli-2.2.1-py3-none-any.whl", hash = "sha256:cb55c73c5f4408779d0cf3eef9f762b9c9f147a77de7b258bef0a5628adc85cc"}, + {file = "tomli-2.2.1.tar.gz", hash = "sha256:cd45e1dc79c835ce60f7404ec8119f2eb06d38b1deba146f07ced3bbc44505ff"}, ] [[package]] name = "tox" -version = "4.11.4" +version = "4.24.2" description = "tox is a generic virtualenv management and test command line tool" optional = false python-versions = ">=3.8" +groups = ["dev"] files = [ - {file = "tox-4.11.4-py3-none-any.whl", hash = "sha256:2adb83d68f27116812b69aa36676a8d6a52249cb0d173649de0e7d0c2e3e7229"}, - {file = "tox-4.11.4.tar.gz", hash = "sha256:73a7240778fabf305aeb05ab8ea26e575e042ab5a18d71d0ed13e343a51d6ce1"}, + {file = "tox-4.24.2-py3-none-any.whl", hash = "sha256:92e8290e76ad4e15748860a205865696409a2d014eedeb796a34a0f3b5e7336e"}, + {file = "tox-4.24.2.tar.gz", hash = "sha256:d5948b350f76fae436d6545a5e87c2b676ab7a0d7d88c1308651245eadbe8aea"}, ] [package.dependencies] -cachetools = ">=5.3.1" +cachetools = ">=5.5.1" chardet = ">=5.2" colorama = ">=0.4.6" -filelock = ">=3.12.3" -packaging = ">=23.1" -platformdirs = ">=3.10" -pluggy = ">=1.3" -pyproject-api = ">=1.6.1" -tomli = {version = ">=2.0.1", markers = "python_version < \"3.11\""} -virtualenv = ">=20.24.3" +filelock = ">=3.16.1" +packaging = ">=24.2" +platformdirs = ">=4.3.6" +pluggy = ">=1.5" +pyproject-api = ">=1.8" +tomli = {version = ">=2.2.1", markers = "python_version < \"3.11\""} +typing-extensions = {version = ">=4.12.2", markers = "python_version < \"3.11\""} +virtualenv = ">=20.29.1" [package.extras] -docs = ["furo (>=2023.8.19)", "sphinx (>=7.2.4)", "sphinx-argparse-cli (>=1.11.1)", "sphinx-autodoc-typehints (>=1.24)", "sphinx-copybutton (>=0.5.2)", "sphinx-inline-tabs (>=2023.4.21)", "sphinxcontrib-towncrier (>=0.2.1a0)", "towncrier (>=23.6)"] -testing = ["build[virtualenv] (>=0.10)", "covdefaults (>=2.3)", "detect-test-pollution (>=1.1.1)", "devpi-process (>=1)", "diff-cover (>=7.7)", "distlib (>=0.3.7)", "flaky (>=3.7)", "hatch-vcs (>=0.3)", "hatchling (>=1.18)", "psutil (>=5.9.5)", "pytest (>=7.4)", "pytest-cov (>=4.1)", "pytest-mock (>=3.11.1)", "pytest-xdist (>=3.3.1)", "re-assert (>=1.1)", "time-machine (>=2.12)", "wheel (>=0.41.2)"] +test = ["devpi-process (>=1.0.2)", "pytest (>=8.3.4)", "pytest-mock (>=3.14)"] [[package]] name = "typing-extensions" -version = "4.8.0" +version = "4.12.2" description = "Backported and Experimental Type Hints for Python 3.8+" optional = false python-versions = ">=3.8" +groups = ["main", "dev"] files = [ - {file = "typing_extensions-4.8.0-py3-none-any.whl", hash = "sha256:8f92fc8806f9a6b641eaa5318da32b44d401efaac0f6678c9bc448ba3605faa0"}, - {file = "typing_extensions-4.8.0.tar.gz", hash = "sha256:df8e4339e9cb77357558cbdbceca33c303714cf861d1eef15e1070055ae8b7ef"}, + {file = "typing_extensions-4.12.2-py3-none-any.whl", hash = "sha256:04e5ca0351e0f3f85c6853954072df659d0d13fac324d0072316b67d7794700d"}, + {file = "typing_extensions-4.12.2.tar.gz", hash = "sha256:1a7ead55c7e559dd4dee8856e3a88b41225abfe1ce8df57b7c13915fe121ffb8"}, ] [[package]] name = "urllib3" -version = "2.1.0" +version = "2.2.3" description = "HTTP library with thread-safe connection pooling, file post, and more." optional = false python-versions = ">=3.8" +groups = ["main"] files = [ - {file = "urllib3-2.1.0-py3-none-any.whl", hash = "sha256:55901e917a5896a349ff771be919f8bd99aff50b79fe58fec595eb37bbc56bb3"}, - {file = "urllib3-2.1.0.tar.gz", hash = "sha256:df7aa8afb0148fa78488e7899b2c59b5f4ffcfa82e6c54ccb9dd37c1d7b52d54"}, + {file = "urllib3-2.2.3-py3-none-any.whl", hash = "sha256:ca899ca043dcb1bafa3e262d73aa25c465bfb49e0bd9dd5d59f1d0acba2f8fac"}, + {file = "urllib3-2.2.3.tar.gz", hash = "sha256:e7d814a81dad81e6caf2ec9fdedb284ecc9c73076b62654547cc64ccdcae26e9"}, ] [package.extras] brotli = ["brotli (>=1.0.9)", "brotlicffi (>=0.8.0)"] +h2 = ["h2 (>=4,<5)"] socks = ["pysocks (>=1.5.6,!=1.5.7,<2.0)"] zstd = ["zstandard (>=0.18.0)"] [[package]] name = "virtualenv" -version = "20.25.0" +version = "20.29.3" description = "Virtual Python Environment builder" optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" +groups = ["dev"] files = [ - {file = "virtualenv-20.25.0-py3-none-any.whl", hash = "sha256:4238949c5ffe6876362d9c0180fc6c3a824a7b12b80604eeb8085f2ed7460de3"}, - {file = "virtualenv-20.25.0.tar.gz", hash = "sha256:bf51c0d9c7dd63ea8e44086fa1e4fb1093a31e963b86959257378aef020e1f1b"}, + {file = "virtualenv-20.29.3-py3-none-any.whl", hash = "sha256:3e3d00f5807e83b234dfb6122bf37cfadf4be216c53a49ac059d02414f819170"}, + {file = "virtualenv-20.29.3.tar.gz", hash = "sha256:95e39403fcf3940ac45bc717597dba16110b74506131845d9b687d5e73d947ac"}, ] [package.dependencies] @@ -551,10 +602,10 @@ filelock = ">=3.12.2,<4" platformdirs = ">=3.9.1,<5" [package.extras] -docs = ["furo (>=2023.7.26)", "proselint (>=0.13)", "sphinx (>=7.1.2)", "sphinx-argparse (>=0.4)", "sphinxcontrib-towncrier (>=0.2.1a0)", "towncrier (>=23.6)"] +docs = ["furo (>=2023.7.26)", "proselint (>=0.13)", "sphinx (>=7.1.2,!=7.3)", "sphinx-argparse (>=0.4)", "sphinxcontrib-towncrier (>=0.2.1a0)", "towncrier (>=23.6)"] test = ["covdefaults (>=2.3)", "coverage (>=7.2.7)", "coverage-enable-subprocess (>=1)", "flaky (>=3.7)", "packaging (>=23.1)", "pytest (>=7.4)", "pytest-env (>=0.8.2)", "pytest-freezer (>=0.4.8)", "pytest-mock (>=3.11.1)", "pytest-randomly (>=3.12)", "pytest-timeout (>=2.1)", "setuptools (>=68)", "time-machine (>=2.10)"] [metadata] -lock-version = "2.0" -python-versions = "^3.8" -content-hash = "ab4bef7cb7b55749ab8c2b9a4e76fba72924b4b2808dc9b83dc7a2c80c8f0a77" +lock-version = "2.1" +python-versions = ">=3.9,<4" +content-hash = "eb1a4c8731d484453543f593d2cb3682b2c71cf0cadd328cdd0663e7f36e98f0" diff --git a/pyproject.toml b/pyproject.toml index a6c299d..984cacc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,31 +1,27 @@ -[tool.poetry] +[project] name = "pywaybiller" -version = "0.1.0" +version = "0.2.0" description = "Python client for waybiller.com external API" -authors = ["Thorgate "] +authors = [{name = "Thorgate Digital", email = "software@thorgate.eu" }] license = "MIT License" readme = "README.md" repository = "https://github.com/thorgate/pywaybiller.git" keywords = ["OpenAPI", "OpenAPI-Generator", "pywaybiller"] include = ["pywaybiller/py.typed"] - -[tool.poetry.dependencies] -python = "^3.8" - -urllib3 = ">= 1.25.3" -python-dateutil = ">=2.8.2" -pydantic = "^1.10.5, <2" -aenum = ">=3.1.11" +requires-python = ">=3.9,<4" +dependencies = [ + "urllib3 (>= 1.25.3,< 3.0.0)", + "python-dateutil (>=2.8.2)", + "pydantic (>=2)", + "typing-extensions (>=4.7.1)" +] [tool.poetry.group.dev.dependencies] -pytest = ">=7.2.1" -tox = ">=3.9.0" -flake8 = ">=4.0.0" -black = "^23.10.1" -json-stream = "^2.3.2" +ruff = "*" +pytest = "*" +tox = "*" +json-stream = "*" [build-system] requires = ["poetry-core"] build-backend = "poetry.core.masonry.api" - - diff --git a/pywaybiller/client.py b/pywaybiller/client.py index a80adf4..7d19a21 100644 --- a/pywaybiller/client.py +++ b/pywaybiller/client.py @@ -1,12 +1,17 @@ # -*- coding: utf-8 -*- """Main module.""" -import threading + +import contextvars + +from pydantic import BaseModel from . import apis from .openapi_client.api_client import ApiClient from .openapi_client.configuration import Configuration +full_serialization = contextvars.ContextVar("full_serialization", default=False) + class ExtendedApiClient(ApiClient): @classmethod @@ -21,6 +26,23 @@ def deserialize_data(cls, response_data, response_type): """ return response_type.from_dict(response_data) + def sanitize_for_serialization(self, obj): + if hasattr(obj, "actual_instance"): + return self.sanitize_for_serialization(obj.actual_instance) + + if full_serialization.get() and isinstance(obj, BaseModel): + return super().sanitize_for_serialization(obj.__dict__) + + return super().sanitize_for_serialization(obj) + + def serialize_fully(self, obj): + token = full_serialization.set(True) + try: + result = self.sanitize_for_serialization(obj) + finally: + full_serialization.reset(token) + return result + class WaybillerClient: """API client class for Waybiller. @@ -32,7 +54,7 @@ class WaybillerClient: openapi_client_class = ExtendedApiClient def __init__(self, api_key: str, host: str = None): - configuration = Configuration(api_key={"API key": api_key}) + configuration = Configuration(api_key={"ApiKeyAuth": api_key}) if host is not None: configuration.host = host self.openapi_client = self.openapi_client_class(configuration) @@ -54,4 +76,4 @@ def deserialize_data(cls, response_data, response_type): @classmethod def sanitize_for_serialization(cls, api_model): - return cls.openapi_client_class().sanitize_for_serialization(api_model) + return cls.openapi_client_class().serialize_fully(api_model) diff --git a/pywaybiller/docs/BlankEnum.md b/pywaybiller/docs/BlankEnum.md new file mode 100644 index 0000000..569c661 --- /dev/null +++ b/pywaybiller/docs/BlankEnum.md @@ -0,0 +1,10 @@ +# BlankEnum + + +## Enum + +* `EMPTY` (value: `''`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/DestinationsApi.md b/pywaybiller/docs/DestinationsApi.md index 865d530..4ffc166 100644 --- a/pywaybiller/docs/DestinationsApi.md +++ b/pywaybiller/docs/DestinationsApi.md @@ -1,34 +1,33 @@ # openapi_client.DestinationsApi -All URIs are relative to *https://app.waybiller.com/external-api* +All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- -[**destinations_list**](DestinationsApi.md#destinations_list) | **GET** /destinations/ | Querying of destinations +[**destinations_list**](DestinationsApi.md#destinations_list) | **GET** /external-api/destinations/ | Querying destinations # **destinations_list** -> DestinationsList200Response destinations_list(name=name, name__iexact=name__iexact, name__contains=name__contains, name__icontains=name__icontains, location__address=location__address, location__address__iexact=location__address__iexact, location__address__contains=location__address__contains, location__address__icontains=location__address__icontains, company__reg_code=company__reg_code, company__reg_code__iexact=company__reg_code__iexact, company__reg_code__contains=company__reg_code__contains, company__reg_code__icontains=company__reg_code__icontains, limit=limit, offset=offset, explicitly_viewable=explicitly_viewable) +> PaginatedExternalAPIDestinationList destinations_list(company__reg_code=company__reg_code, company__reg_code__contains=company__reg_code__contains, company__reg_code__icontains=company__reg_code__icontains, company__reg_code__iexact=company__reg_code__iexact, explicitly_viewable=explicitly_viewable, limit=limit, location__address=location__address, location__address__contains=location__address__contains, location__address__icontains=location__address__icontains, location__address__iexact=location__address__iexact, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, offset=offset) -Querying of destinations +Querying destinations -Returns all destinations associated with your company, according to the specified filters. +Returns all destinations associated with your company according to the specified filters ### Example -* Api Key Authentication (API key): +* Api Key Authentication (ApiKeyAuth): + ```python -import time -import os import openapi_client -from openapi_client.models.destinations_list200_response import DestinationsList200Response +from openapi_client.models.paginated_external_api_destination_list import PaginatedExternalAPIDestinationList from openapi_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to https://app.waybiller.com/external-api +# Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = openapi_client.Configuration( - host = "https://app.waybiller.com/external-api" + host = "http://localhost" ) # The client must configure the authentication and authorization parameters @@ -36,35 +35,35 @@ configuration = openapi_client.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: API key -configuration.api_key['API key'] = os.environ["API_KEY"] +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['API key'] = 'Bearer' +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' # Enter a context with an instance of the API client with openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = openapi_client.DestinationsApi(api_client) - name = 'name_example' # str | Filters destinations with specified name (case sensitive). (optional) - name__iexact = 'name__iexact_example' # str | Filters destinations with specified name (case insensitive). (optional) - name__contains = 'name__contains_example' # str | Filters destinations of which names contain this keyword (case sensitive). (optional) - name__icontains = 'name__icontains_example' # str | Filters destinations of which names contain this keyword (case insensitive). (optional) - location__address = 'location__address_example' # str | Filters destinations with specified address (case sensitive). (optional) - location__address__iexact = 'location__address__iexact_example' # str | Filters destinations with specified address (case insensitive). (optional) - location__address__contains = 'location__address__contains_example' # str | Filters destinations of which addresses contain this keyword (case sensitive). (optional) - location__address__icontains = 'location__address__icontains_example' # str | Filters destinations of which addresses contain this keyword (case insensitive). (optional) - company__reg_code = 'company__reg_code_example' # str | Filters destinations belonging to the company with the specified register code (case sensitive). (optional) - company__reg_code__iexact = 'company__reg_code__iexact_example' # str | Filters destinations belonging to the company with the specified register code (case insensitive). (optional) - company__reg_code__contains = 'company__reg_code__contains_example' # str | Filters destinations belonging to the company of which register codes contain this keyword (case sensitive). (optional) - company__reg_code__icontains = 'company__reg_code__icontains_example' # str | Filters destinations belonging to the company of which register codes contain this keyword (case insensitive). (optional) - limit = 56 # int | Number of results to return per page. (optional) - offset = 56 # int | The initial index from which to return the results. (optional) - explicitly_viewable = True # bool | Filters destinations that belong to your company or where your company was added as a partner. (optional) + company__reg_code = 'company__reg_code_example' # str | Filters destinations that belong to the company with the specified registration code (case-sensitive) (optional) + company__reg_code__contains = 'company__reg_code__contains_example' # str | Filters destinations that belong to companies whose registration codes contain this keyword (case-sensitive) (optional) + company__reg_code__icontains = 'company__reg_code__icontains_example' # str | Filters destinations that belong to companies whose registration codes contain this keyword (case-insensitive) (optional) + company__reg_code__iexact = 'company__reg_code__iexact_example' # str | Filters destinations that belong to the company with the specified registration code (case-insensitive) (optional) + explicitly_viewable = True # bool | Filters destinations that belong to your company or where your company was added as a partner (optional) + limit = 30 # int | Maximum number of objects to return per page (optional) (default to 30) + location__address = 'location__address_example' # str | Filters destinations with the specified address (case-sensitive) (optional) + location__address__contains = 'location__address__contains_example' # str | Filters destinations whose addresses contain this keyword (case-sensitive) (optional) + location__address__icontains = 'location__address__icontains_example' # str | Filters destinations whose addresses contain this keyword (case-insensitive) (optional) + location__address__iexact = 'location__address__iexact_example' # str | Filters destinations with the specified address (case-insensitive) (optional) + name = 'name_example' # str | Filters destinations with the specified name (case-sensitive) (optional) + name__contains = 'name__contains_example' # str | Filters destinations whose names contain this keyword (case-sensitive) (optional) + name__icontains = 'name__icontains_example' # str | Filters destinations whose names contain this keyword (case-insensitive) (optional) + name__iexact = 'name__iexact_example' # str | Filters destinations with the specified name (case-insensitive) (optional) + offset = 0 # int | The initial index from which to return the results (optional) (default to 0) try: - # Querying of destinations - api_response = api_instance.destinations_list(name=name, name__iexact=name__iexact, name__contains=name__contains, name__icontains=name__icontains, location__address=location__address, location__address__iexact=location__address__iexact, location__address__contains=location__address__contains, location__address__icontains=location__address__icontains, company__reg_code=company__reg_code, company__reg_code__iexact=company__reg_code__iexact, company__reg_code__contains=company__reg_code__contains, company__reg_code__icontains=company__reg_code__icontains, limit=limit, offset=offset, explicitly_viewable=explicitly_viewable) + # Querying destinations + api_response = api_instance.destinations_list(company__reg_code=company__reg_code, company__reg_code__contains=company__reg_code__contains, company__reg_code__icontains=company__reg_code__icontains, company__reg_code__iexact=company__reg_code__iexact, explicitly_viewable=explicitly_viewable, limit=limit, location__address=location__address, location__address__contains=location__address__contains, location__address__icontains=location__address__icontains, location__address__iexact=location__address__iexact, name=name, name__contains=name__contains, name__icontains=name__icontains, name__iexact=name__iexact, offset=offset) print("The response of DestinationsApi->destinations_list:\n") pprint(api_response) except Exception as e: @@ -75,31 +74,32 @@ with openapi_client.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **name** | **str**| Filters destinations with specified name (case sensitive). | [optional] - **name__iexact** | **str**| Filters destinations with specified name (case insensitive). | [optional] - **name__contains** | **str**| Filters destinations of which names contain this keyword (case sensitive). | [optional] - **name__icontains** | **str**| Filters destinations of which names contain this keyword (case insensitive). | [optional] - **location__address** | **str**| Filters destinations with specified address (case sensitive). | [optional] - **location__address__iexact** | **str**| Filters destinations with specified address (case insensitive). | [optional] - **location__address__contains** | **str**| Filters destinations of which addresses contain this keyword (case sensitive). | [optional] - **location__address__icontains** | **str**| Filters destinations of which addresses contain this keyword (case insensitive). | [optional] - **company__reg_code** | **str**| Filters destinations belonging to the company with the specified register code (case sensitive). | [optional] - **company__reg_code__iexact** | **str**| Filters destinations belonging to the company with the specified register code (case insensitive). | [optional] - **company__reg_code__contains** | **str**| Filters destinations belonging to the company of which register codes contain this keyword (case sensitive). | [optional] - **company__reg_code__icontains** | **str**| Filters destinations belonging to the company of which register codes contain this keyword (case insensitive). | [optional] - **limit** | **int**| Number of results to return per page. | [optional] - **offset** | **int**| The initial index from which to return the results. | [optional] - **explicitly_viewable** | **bool**| Filters destinations that belong to your company or where your company was added as a partner. | [optional] + **company__reg_code** | **str**| Filters destinations that belong to the company with the specified registration code (case-sensitive) | [optional] + **company__reg_code__contains** | **str**| Filters destinations that belong to companies whose registration codes contain this keyword (case-sensitive) | [optional] + **company__reg_code__icontains** | **str**| Filters destinations that belong to companies whose registration codes contain this keyword (case-insensitive) | [optional] + **company__reg_code__iexact** | **str**| Filters destinations that belong to the company with the specified registration code (case-insensitive) | [optional] + **explicitly_viewable** | **bool**| Filters destinations that belong to your company or where your company was added as a partner | [optional] + **limit** | **int**| Maximum number of objects to return per page | [optional] [default to 30] + **location__address** | **str**| Filters destinations with the specified address (case-sensitive) | [optional] + **location__address__contains** | **str**| Filters destinations whose addresses contain this keyword (case-sensitive) | [optional] + **location__address__icontains** | **str**| Filters destinations whose addresses contain this keyword (case-insensitive) | [optional] + **location__address__iexact** | **str**| Filters destinations with the specified address (case-insensitive) | [optional] + **name** | **str**| Filters destinations with the specified name (case-sensitive) | [optional] + **name__contains** | **str**| Filters destinations whose names contain this keyword (case-sensitive) | [optional] + **name__icontains** | **str**| Filters destinations whose names contain this keyword (case-insensitive) | [optional] + **name__iexact** | **str**| Filters destinations with the specified name (case-insensitive) | [optional] + **offset** | **int**| The initial index from which to return the results | [optional] [default to 0] ### Return type -[**DestinationsList200Response**](DestinationsList200Response.md) +[**PaginatedExternalAPIDestinationList**](PaginatedExternalAPIDestinationList.md) ### Authorization -[API key](../README.md#API key) +[ApiKeyAuth](../README.md#ApiKeyAuth) ### HTTP request headers @@ -107,9 +107,11 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | +**403** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/DestinationsList200Response.md b/pywaybiller/docs/DestinationsList200Response.md deleted file mode 100644 index e2f5975..0000000 --- a/pywaybiller/docs/DestinationsList200Response.md +++ /dev/null @@ -1,31 +0,0 @@ -# DestinationsList200Response - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**count** | **int** | | -**next** | **str** | | [optional] -**previous** | **str** | | [optional] -**results** | [**List[ExtAPIDestination]**](ExtAPIDestination.md) | | - -## Example - -```python -from openapi_client.models.destinations_list200_response import DestinationsList200Response - -# TODO update the JSON string below -json = "{}" -# create an instance of DestinationsList200Response from a JSON string -destinations_list200_response_instance = DestinationsList200Response.from_json(json) -# print the JSON string representation of the object -print DestinationsList200Response.to_json() - -# convert the object into a dict -destinations_list200_response_dict = destinations_list200_response_instance.to_dict() -# create an instance of DestinationsList200Response from a dict -destinations_list200_response_form_dict = destinations_list200_response.from_dict(destinations_list200_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/pywaybiller/docs/DestinationsList403Response.md b/pywaybiller/docs/DestinationsList403Response.md new file mode 100644 index 0000000..577b306 --- /dev/null +++ b/pywaybiller/docs/DestinationsList403Response.md @@ -0,0 +1,29 @@ +# DestinationsList403Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detail** | **str** | Provided API key is not correct or expired | [optional] + +## Example + +```python +from openapi_client.models.destinations_list403_response import DestinationsList403Response + +# TODO update the JSON string below +json = "{}" +# create an instance of DestinationsList403Response from a JSON string +destinations_list403_response_instance = DestinationsList403Response.from_json(json) +# print the JSON string representation of the object +print(DestinationsList403Response.to_json()) + +# convert the object into a dict +destinations_list403_response_dict = destinations_list403_response_instance.to_dict() +# create an instance of DestinationsList403Response from a dict +destinations_list403_response_from_dict = DestinationsList403Response.from_dict(destinations_list403_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/EmploymentsApi.md b/pywaybiller/docs/EmploymentsApi.md index e99f471..3bc7391 100644 --- a/pywaybiller/docs/EmploymentsApi.md +++ b/pywaybiller/docs/EmploymentsApi.md @@ -1,34 +1,34 @@ # openapi_client.EmploymentsApi -All URIs are relative to *https://app.waybiller.com/external-api* +All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- -[**employments_list**](EmploymentsApi.md#employments_list) | **GET** /employments/ | Querying of employments +[**employments_list**](EmploymentsApi.md#employments_list) | **GET** /external-api/employments/ | Querying employments +[**employments_retrieve**](EmploymentsApi.md#employments_retrieve) | **GET** /external-api/employments/{id}/ | Querying a single employment # **employments_list** -> EmploymentsList200Response employments_list(limit=limit, offset=offset) +> PaginatedExternalAPIEmploymentList employments_list(limit=limit, offset=offset) -Querying of employments +Querying employments -Returns all employments associated with your company. +Returns all employments associated with your company ### Example -* Api Key Authentication (API key): +* Api Key Authentication (ApiKeyAuth): + ```python -import time -import os import openapi_client -from openapi_client.models.employments_list200_response import EmploymentsList200Response +from openapi_client.models.paginated_external_api_employment_list import PaginatedExternalAPIEmploymentList from openapi_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to https://app.waybiller.com/external-api +# Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = openapi_client.Configuration( - host = "https://app.waybiller.com/external-api" + host = "http://localhost" ) # The client must configure the authentication and authorization parameters @@ -36,21 +36,21 @@ configuration = openapi_client.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: API key -configuration.api_key['API key'] = os.environ["API_KEY"] +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['API key'] = 'Bearer' +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' # Enter a context with an instance of the API client with openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = openapi_client.EmploymentsApi(api_client) - limit = 56 # int | Number of results to return per page. (optional) - offset = 56 # int | The initial index from which to return the results. (optional) + limit = 30 # int | Maximum number of objects to return per page (optional) (default to 30) + offset = 0 # int | The initial index from which to return the results (optional) (default to 0) try: - # Querying of employments + # Querying employments api_response = api_instance.employments_list(limit=limit, offset=offset) print("The response of EmploymentsApi->employments_list:\n") pprint(api_response) @@ -62,18 +62,19 @@ with openapi_client.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **limit** | **int**| Number of results to return per page. | [optional] - **offset** | **int**| The initial index from which to return the results. | [optional] + **limit** | **int**| Maximum number of objects to return per page | [optional] [default to 30] + **offset** | **int**| The initial index from which to return the results | [optional] [default to 0] ### Return type -[**EmploymentsList200Response**](EmploymentsList200Response.md) +[**PaginatedExternalAPIEmploymentList**](PaginatedExternalAPIEmploymentList.md) ### Authorization -[API key](../README.md#API key) +[ApiKeyAuth](../README.md#ApiKeyAuth) ### HTTP request headers @@ -81,9 +82,92 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | | - | +**403** | | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **employments_retrieve** +> ExternalAPIEmployment employments_retrieve(id) + +Querying a single employment + +Returns an employment instance + +### Example + +* Api Key Authentication (ApiKeyAuth): + +```python +import openapi_client +from openapi_client.models.external_api_employment import ExternalAPIEmployment +from openapi_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = openapi_client.Configuration( + host = "http://localhost" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' + +# Enter a context with an instance of the API client +with openapi_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = openapi_client.EmploymentsApi(api_client) + id = 56 # int | A unique integer value identifying this employment. + + try: + # Querying a single employment + api_response = api_instance.employments_retrieve(id) + print("The response of EmploymentsApi->employments_retrieve:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling EmploymentsApi->employments_retrieve: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **int**| A unique integer value identifying this employment. | + +### Return type + +[**ExternalAPIEmployment**](ExternalAPIEmployment.md) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | +**403** | | - | +**404** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/EmploymentsList200Response.md b/pywaybiller/docs/EmploymentsList200Response.md deleted file mode 100644 index 3386aff..0000000 --- a/pywaybiller/docs/EmploymentsList200Response.md +++ /dev/null @@ -1,31 +0,0 @@ -# EmploymentsList200Response - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**count** | **int** | | -**next** | **str** | | [optional] -**previous** | **str** | | [optional] -**results** | [**List[ExternalAPIEmployment]**](ExternalAPIEmployment.md) | | - -## Example - -```python -from openapi_client.models.employments_list200_response import EmploymentsList200Response - -# TODO update the JSON string below -json = "{}" -# create an instance of EmploymentsList200Response from a JSON string -employments_list200_response_instance = EmploymentsList200Response.from_json(json) -# print the JSON string representation of the object -print EmploymentsList200Response.to_json() - -# convert the object into a dict -employments_list200_response_dict = employments_list200_response_instance.to_dict() -# create an instance of EmploymentsList200Response from a dict -employments_list200_response_form_dict = employments_list200_response.from_dict(employments_list200_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/pywaybiller/docs/EmploymentsRetrieve404Response.md b/pywaybiller/docs/EmploymentsRetrieve404Response.md new file mode 100644 index 0000000..ca3063f --- /dev/null +++ b/pywaybiller/docs/EmploymentsRetrieve404Response.md @@ -0,0 +1,29 @@ +# EmploymentsRetrieve404Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detail** | **str** | No instance matches the given query. | [optional] + +## Example + +```python +from openapi_client.models.employments_retrieve404_response import EmploymentsRetrieve404Response + +# TODO update the JSON string below +json = "{}" +# create an instance of EmploymentsRetrieve404Response from a JSON string +employments_retrieve404_response_instance = EmploymentsRetrieve404Response.from_json(json) +# print the JSON string representation of the object +print(EmploymentsRetrieve404Response.to_json()) + +# convert the object into a dict +employments_retrieve404_response_dict = employments_retrieve404_response_instance.to_dict() +# create an instance of EmploymentsRetrieve404Response from a dict +employments_retrieve404_response_from_dict = EmploymentsRetrieve404Response.from_dict(employments_retrieve404_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExtAPIDestination.md b/pywaybiller/docs/ExtAPIDestination.md deleted file mode 100644 index 49b34ff..0000000 --- a/pywaybiller/docs/ExtAPIDestination.md +++ /dev/null @@ -1,35 +0,0 @@ -# ExtAPIDestination - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | | -**name** | **str** | | -**address** | **str** | | -**latitude** | **float** | | -**longitude** | **float** | | -**raw_data** | [**ExternalAPIRawSerializer**](ExternalAPIRawSerializer.md) | | [optional] -**owner_name** | **str** | | [optional] [readonly] -**owner_reg_code** | **str** | | [optional] [readonly] - -## Example - -```python -from openapi_client.models.ext_api_destination import ExtAPIDestination - -# TODO update the JSON string below -json = "{}" -# create an instance of ExtAPIDestination from a JSON string -ext_api_destination_instance = ExtAPIDestination.from_json(json) -# print the JSON string representation of the object -print ExtAPIDestination.to_json() - -# convert the object into a dict -ext_api_destination_dict = ext_api_destination_instance.to_dict() -# create an instance of ExtAPIDestination from a dict -ext_api_destination_form_dict = ext_api_destination.from_dict(ext_api_destination_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/pywaybiller/docs/ExtAPIHoldingBase.md b/pywaybiller/docs/ExtAPIHoldingBase.md deleted file mode 100644 index 74d7afa..0000000 --- a/pywaybiller/docs/ExtAPIHoldingBase.md +++ /dev/null @@ -1,32 +0,0 @@ -# ExtAPIHoldingBase - -Holding base data is provided as is, in internal WB format. It may change at any time without warning and may have a different schema for old and new origins - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**contract_number** | **str** | | [optional] -**contract_date** | **str** | | [optional] -**previous_owner** | [**ExtAPIHoldingBasePreviousOwner**](ExtAPIHoldingBasePreviousOwner.md) | | [optional] - -## Example - -```python -from openapi_client.models.ext_api_holding_base import ExtAPIHoldingBase - -# TODO update the JSON string below -json = "{}" -# create an instance of ExtAPIHoldingBase from a JSON string -ext_api_holding_base_instance = ExtAPIHoldingBase.from_json(json) -# print the JSON string representation of the object -print ExtAPIHoldingBase.to_json() - -# convert the object into a dict -ext_api_holding_base_dict = ext_api_holding_base_instance.to_dict() -# create an instance of ExtAPIHoldingBase from a dict -ext_api_holding_base_form_dict = ext_api_holding_base.from_dict(ext_api_holding_base_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/pywaybiller/docs/ExtAPIHoldingBasePreviousOwner.md b/pywaybiller/docs/ExtAPIHoldingBasePreviousOwner.md deleted file mode 100644 index 540cd17..0000000 --- a/pywaybiller/docs/ExtAPIHoldingBasePreviousOwner.md +++ /dev/null @@ -1,30 +0,0 @@ -# ExtAPIHoldingBasePreviousOwner - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**code** | **str** | | -**address** | **str** | | - -## Example - -```python -from openapi_client.models.ext_api_holding_base_previous_owner import ExtAPIHoldingBasePreviousOwner - -# TODO update the JSON string below -json = "{}" -# create an instance of ExtAPIHoldingBasePreviousOwner from a JSON string -ext_api_holding_base_previous_owner_instance = ExtAPIHoldingBasePreviousOwner.from_json(json) -# print the JSON string representation of the object -print ExtAPIHoldingBasePreviousOwner.to_json() - -# convert the object into a dict -ext_api_holding_base_previous_owner_dict = ext_api_holding_base_previous_owner_instance.to_dict() -# create an instance of ExtAPIHoldingBasePreviousOwner from a dict -ext_api_holding_base_previous_owner_form_dict = ext_api_holding_base_previous_owner.from_dict(ext_api_holding_base_previous_owner_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/pywaybiller/docs/ExtAPIHoldingBaseRead.md b/pywaybiller/docs/ExtAPIHoldingBaseRead.md deleted file mode 100644 index 7babec5..0000000 --- a/pywaybiller/docs/ExtAPIHoldingBaseRead.md +++ /dev/null @@ -1,32 +0,0 @@ -# ExtAPIHoldingBaseRead - -Holding base data is provided as is, in internal WB format. It may change at any time without warning and may have a different schema for old and new origins - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | [optional] -**contract_number** | **str** | | [optional] -**contract_date** | **str** | | [optional] -**previous_owner** | [**ExtAPIHoldingBasePreviousOwner**](ExtAPIHoldingBasePreviousOwner.md) | | [optional] - -## Example - -```python -from openapi_client.models.ext_api_holding_base_read import ExtAPIHoldingBaseRead - -# TODO update the JSON string below -json = "{}" -# create an instance of ExtAPIHoldingBaseRead from a JSON string -ext_api_holding_base_read_instance = ExtAPIHoldingBaseRead.from_json(json) -# print the JSON string representation of the object -print ExtAPIHoldingBaseRead.to_json() - -# convert the object into a dict -ext_api_holding_base_read_dict = ext_api_holding_base_read_instance.to_dict() -# create an instance of ExtAPIHoldingBaseRead from a dict -ext_api_holding_base_read_form_dict = ext_api_holding_base_read.from_dict(ext_api_holding_base_read_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/pywaybiller/docs/ExtAPIOriginAssortment.md b/pywaybiller/docs/ExtAPIOriginAssortment.md deleted file mode 100644 index 22a2f2c..0000000 --- a/pywaybiller/docs/ExtAPIOriginAssortment.md +++ /dev/null @@ -1,29 +0,0 @@ -# ExtAPIOriginAssortment - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **int** | Assortment ID | -**subsets** | **List[int]** | List of subset IDs | [optional] - -## Example - -```python -from openapi_client.models.ext_api_origin_assortment import ExtAPIOriginAssortment - -# TODO update the JSON string below -json = "{}" -# create an instance of ExtAPIOriginAssortment from a JSON string -ext_api_origin_assortment_instance = ExtAPIOriginAssortment.from_json(json) -# print the JSON string representation of the object -print ExtAPIOriginAssortment.to_json() - -# convert the object into a dict -ext_api_origin_assortment_dict = ext_api_origin_assortment_instance.to_dict() -# create an instance of ExtAPIOriginAssortment from a dict -ext_api_origin_assortment_form_dict = ext_api_origin_assortment.from_dict(ext_api_origin_assortment_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/pywaybiller/docs/ExtAPIOriginList.md b/pywaybiller/docs/ExtAPIOriginList.md deleted file mode 100644 index eb8cf1c..0000000 --- a/pywaybiller/docs/ExtAPIOriginList.md +++ /dev/null @@ -1,33 +0,0 @@ -# ExtAPIOriginList - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | | -**name** | **str** | | -**address** | **str** | | -**latitude** | **float** | | -**longitude** | **float** | | -**raw_data** | [**ExternalAPIRawSerializer**](ExternalAPIRawSerializer.md) | | [optional] - -## Example - -```python -from openapi_client.models.ext_api_origin_list import ExtAPIOriginList - -# TODO update the JSON string below -json = "{}" -# create an instance of ExtAPIOriginList from a JSON string -ext_api_origin_list_instance = ExtAPIOriginList.from_json(json) -# print the JSON string representation of the object -print ExtAPIOriginList.to_json() - -# convert the object into a dict -ext_api_origin_list_dict = ext_api_origin_list_instance.to_dict() -# create an instance of ExtAPIOriginList from a dict -ext_api_origin_list_form_dict = ext_api_origin_list.from_dict(ext_api_origin_list_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/pywaybiller/docs/ExternalAPIDestination.md b/pywaybiller/docs/ExternalAPIDestination.md new file mode 100644 index 0000000..cd94a2d --- /dev/null +++ b/pywaybiller/docs/ExternalAPIDestination.md @@ -0,0 +1,36 @@ +# ExternalAPIDestination + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the destination in your system | [readonly] +**name** | **str** | Name of the destination | [readonly] +**address** | **str** | Physical address of the destination | [readonly] +**latitude** | **float** | Latitude coordinate of the destination's location (People also put X coordinate of Lambert-EST here) | [readonly] +**longitude** | **float** | Longitude coordinate of the destination's location (People also put Y coordinate of Lambert-EST here) | [readonly] +**owner_name** | **str** | Name of the destination's owner company | [readonly] +**owner_reg_code** | **str** | Registration code of the destination's owner company | [readonly] +**raw_data** | [**ExternalAPIDestinationRawData**](ExternalAPIDestinationRawData.md) | The IDs of the Waybiller internal objects | [readonly] + +## Example + +```python +from openapi_client.models.external_api_destination import ExternalAPIDestination + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIDestination from a JSON string +external_api_destination_instance = ExternalAPIDestination.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIDestination.to_json()) + +# convert the object into a dict +external_api_destination_dict = external_api_destination_instance.to_dict() +# create an instance of ExternalAPIDestination from a dict +external_api_destination_from_dict = ExternalAPIDestination.from_dict(external_api_destination_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIDestinationRawData.md b/pywaybiller/docs/ExternalAPIDestinationRawData.md new file mode 100644 index 0000000..f37caeb --- /dev/null +++ b/pywaybiller/docs/ExternalAPIDestinationRawData.md @@ -0,0 +1,29 @@ +# ExternalAPIDestinationRawData + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | Destination ID | [readonly] + +## Example + +```python +from openapi_client.models.external_api_destination_raw_data import ExternalAPIDestinationRawData + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIDestinationRawData from a JSON string +external_api_destination_raw_data_instance = ExternalAPIDestinationRawData.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIDestinationRawData.to_json()) + +# convert the object into a dict +external_api_destination_raw_data_dict = external_api_destination_raw_data_instance.to_dict() +# create an instance of ExternalAPIDestinationRawData from a dict +external_api_destination_raw_data_from_dict = ExternalAPIDestinationRawData.from_dict(external_api_destination_raw_data_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIEmployment.md b/pywaybiller/docs/ExternalAPIEmployment.md index 6ef0a13..4ac3a9c 100644 --- a/pywaybiller/docs/ExternalAPIEmployment.md +++ b/pywaybiller/docs/ExternalAPIEmployment.md @@ -2,18 +2,19 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | | [optional] [readonly] -**name** | **str** | | -**email** | **str** | | -**user_id** | **str** | | -**role** | **str** | | [optional] [readonly] -**obsolete** | **bool** | | [optional] [readonly] -**company_name** | **str** | | -**company_reg_code** | **str** | | -**subcontractor_company_name** | **str** | | -**subcontractor_company_reg_code** | **str** | | +**id** | **int** | Unique identifier of the employment | [readonly] +**name** | **str** | Full name of the employee | [readonly] +**email** | **str** | Email address of the employee | [readonly] +**user_id** | **str** | Unique identifier of the employee's user account in Waybiller | [readonly] +**role** | [**RoleEnum**](RoleEnum.md) | User's role within the company * `manager` - Manager * `project_manager` - Project Manager * `object_manager` - Object Manager * `dispatcher` - Dispatcher * `driver` - Driver * `acceptor` - Acceptor * `loader_operator` - Loader operator | [readonly] +**obsolete** | **bool** | Whether the employment has been deactivated | [readonly] [default to False] +**company_name** | **str** | Name of the employing company | [readonly] +**company_reg_code** | **str** | Registration code of the employing company | [readonly] +**subcontractor_company_name** | **str** | Name of the subcontractor company, if applicable | [readonly] +**subcontractor_company_reg_code** | **str** | Registration code of the subcontractor company, if applicable | [readonly] ## Example @@ -25,12 +26,12 @@ json = "{}" # create an instance of ExternalAPIEmployment from a JSON string external_api_employment_instance = ExternalAPIEmployment.from_json(json) # print the JSON string representation of the object -print ExternalAPIEmployment.to_json() +print(ExternalAPIEmployment.to_json()) # convert the object into a dict external_api_employment_dict = external_api_employment_instance.to_dict() # create an instance of ExternalAPIEmployment from a dict -external_api_employment_form_dict = external_api_employment.from_dict(external_api_employment_dict) +external_api_employment_from_dict = ExternalAPIEmployment.from_dict(external_api_employment_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIHoldingBase.md b/pywaybiller/docs/ExternalAPIHoldingBase.md new file mode 100644 index 0000000..c1c6cda --- /dev/null +++ b/pywaybiller/docs/ExternalAPIHoldingBase.md @@ -0,0 +1,32 @@ +# ExternalAPIHoldingBase + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**TypeEnum**](TypeEnum.md) | | +**contract_number** | **str** | | [optional] +**contract_date** | **str** | | [optional] +**previous_owner** | [**ExternalAPIHoldingBasePreviousOwner**](ExternalAPIHoldingBasePreviousOwner.md) | | [optional] + +## Example + +```python +from openapi_client.models.external_api_holding_base import ExternalAPIHoldingBase + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIHoldingBase from a JSON string +external_api_holding_base_instance = ExternalAPIHoldingBase.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIHoldingBase.to_json()) + +# convert the object into a dict +external_api_holding_base_dict = external_api_holding_base_instance.to_dict() +# create an instance of ExternalAPIHoldingBase from a dict +external_api_holding_base_from_dict = ExternalAPIHoldingBase.from_dict(external_api_holding_base_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIHoldingBasePreviousOwner.md b/pywaybiller/docs/ExternalAPIHoldingBasePreviousOwner.md new file mode 100644 index 0000000..44e2f9b --- /dev/null +++ b/pywaybiller/docs/ExternalAPIHoldingBasePreviousOwner.md @@ -0,0 +1,31 @@ +# ExternalAPIHoldingBasePreviousOwner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**code** | **str** | | +**address** | **str** | | + +## Example + +```python +from openapi_client.models.external_api_holding_base_previous_owner import ExternalAPIHoldingBasePreviousOwner + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIHoldingBasePreviousOwner from a JSON string +external_api_holding_base_previous_owner_instance = ExternalAPIHoldingBasePreviousOwner.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIHoldingBasePreviousOwner.to_json()) + +# convert the object into a dict +external_api_holding_base_previous_owner_dict = external_api_holding_base_previous_owner_instance.to_dict() +# create an instance of ExternalAPIHoldingBasePreviousOwner from a dict +external_api_holding_base_previous_owner_from_dict = ExternalAPIHoldingBasePreviousOwner.from_dict(external_api_holding_base_previous_owner_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIHoldingBasePreviousOwnerRequest.md b/pywaybiller/docs/ExternalAPIHoldingBasePreviousOwnerRequest.md new file mode 100644 index 0000000..2a38ee3 --- /dev/null +++ b/pywaybiller/docs/ExternalAPIHoldingBasePreviousOwnerRequest.md @@ -0,0 +1,31 @@ +# ExternalAPIHoldingBasePreviousOwnerRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**code** | **str** | | +**address** | **str** | | + +## Example + +```python +from openapi_client.models.external_api_holding_base_previous_owner_request import ExternalAPIHoldingBasePreviousOwnerRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIHoldingBasePreviousOwnerRequest from a JSON string +external_api_holding_base_previous_owner_request_instance = ExternalAPIHoldingBasePreviousOwnerRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIHoldingBasePreviousOwnerRequest.to_json()) + +# convert the object into a dict +external_api_holding_base_previous_owner_request_dict = external_api_holding_base_previous_owner_request_instance.to_dict() +# create an instance of ExternalAPIHoldingBasePreviousOwnerRequest from a dict +external_api_holding_base_previous_owner_request_from_dict = ExternalAPIHoldingBasePreviousOwnerRequest.from_dict(external_api_holding_base_previous_owner_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIHoldingBaseRead.md b/pywaybiller/docs/ExternalAPIHoldingBaseRead.md new file mode 100644 index 0000000..009377c --- /dev/null +++ b/pywaybiller/docs/ExternalAPIHoldingBaseRead.md @@ -0,0 +1,32 @@ +# ExternalAPIHoldingBaseRead + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | | [optional] +**contract_number** | **str** | | [optional] +**contract_date** | **str** | | [optional] +**previous_owner** | [**ExternalAPIHoldingBasePreviousOwner**](ExternalAPIHoldingBasePreviousOwner.md) | | [optional] + +## Example + +```python +from openapi_client.models.external_api_holding_base_read import ExternalAPIHoldingBaseRead + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIHoldingBaseRead from a JSON string +external_api_holding_base_read_instance = ExternalAPIHoldingBaseRead.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIHoldingBaseRead.to_json()) + +# convert the object into a dict +external_api_holding_base_read_dict = external_api_holding_base_read_instance.to_dict() +# create an instance of ExternalAPIHoldingBaseRead from a dict +external_api_holding_base_read_from_dict = ExternalAPIHoldingBaseRead.from_dict(external_api_holding_base_read_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIHoldingBaseRequest.md b/pywaybiller/docs/ExternalAPIHoldingBaseRequest.md new file mode 100644 index 0000000..8008324 --- /dev/null +++ b/pywaybiller/docs/ExternalAPIHoldingBaseRequest.md @@ -0,0 +1,32 @@ +# ExternalAPIHoldingBaseRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**TypeEnum**](TypeEnum.md) | | +**contract_number** | **str** | | [optional] +**contract_date** | **str** | | [optional] +**previous_owner** | [**ExternalAPIHoldingBasePreviousOwnerRequest**](ExternalAPIHoldingBasePreviousOwnerRequest.md) | | [optional] + +## Example + +```python +from openapi_client.models.external_api_holding_base_request import ExternalAPIHoldingBaseRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIHoldingBaseRequest from a JSON string +external_api_holding_base_request_instance = ExternalAPIHoldingBaseRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIHoldingBaseRequest.to_json()) + +# convert the object into a dict +external_api_holding_base_request_dict = external_api_holding_base_request_instance.to_dict() +# create an instance of ExternalAPIHoldingBaseRequest from a dict +external_api_holding_base_request_from_dict = ExternalAPIHoldingBaseRequest.from_dict(external_api_holding_base_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPILoaderActionLog.md b/pywaybiller/docs/ExternalAPILoaderActionLog.md index 92e2835..04c5dea 100644 --- a/pywaybiller/docs/ExternalAPILoaderActionLog.md +++ b/pywaybiller/docs/ExternalAPILoaderActionLog.md @@ -2,23 +2,24 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**log_timestamp** | **datetime** | | [optional] [readonly] -**log_description** | **str** | | [optional] [readonly] -**loader_operator_user_name** | **str** | | [optional] [readonly] -**action_name** | **str** | | [optional] [readonly] -**origin_name** | **str** | | [optional] [readonly] -**order_number** | **str** | | [optional] [readonly] -**vehicle_reg_number** | **str** | | [optional] [readonly] -**trailer_reg_number** | **str** | | [optional] [readonly] -**waybill_number** | **str** | | [optional] [readonly] -**loader_unit_name** | **str** | | [optional] [readonly] -**assortment_name** | **str** | | [optional] [readonly] -**subset_name** | **str** | | [optional] [readonly] -**weight** | **str** | | [optional] [readonly] -**log_comments** | [**List[ExternalAPILoaderActionLogComment]**](ExternalAPILoaderActionLogComment.md) | | [optional] [readonly] -**raw_data** | [**ExternalAPILoaderActionLogRawData**](ExternalAPILoaderActionLogRawData.md) | | [optional] +**log_timestamp** | **datetime** | Exact date and time when the loading action was recorded (Format: `YYYY-MM-DDThh:mm:ss.ffffff+hh:mm`) | [readonly] +**log_description** | **str** | Detailed description of the loading action and its associated context | [readonly] +**loader_operator_user_name** | **str** | The full name of the loader operator | [readonly] +**action_name** | **str** | Name of the loader action that was performed | [readonly] +**origin_name** | **str** | Name of the origin where the loading action was performed | [readonly] +**order_number** | **str** | Number of the order associated with the action, if applicable | [readonly] +**vehicle_reg_number** | **str** | Registration number of the vehicle associated with the action, if applicable | [readonly] +**trailer_reg_number** | **str** | Registration number of the attached trailer, if applicable | [readonly] +**waybill_number** | **str** | Number of the waybill associated with the action, if applicable | [readonly] +**loader_unit_name** | **str** | Identification or name of the loading equipment that was used | [readonly] +**assortment_name** | **str** | Name of the assortment associated with the action | [readonly] +**subset_name** | **str** | Name of the subset associated with the action | [readonly] +**weight** | **str** | Weight that was loaded or unloaded (e.g., `\"12.345\"`) | [readonly] +**log_comments** | [**List[ExternalAPILoaderActionLogComment]**](ExternalAPILoaderActionLogComment.md) | List of all comments added to this action | [readonly] +**raw_data** | [**ExternalAPILoaderActionLogRawData**](ExternalAPILoaderActionLogRawData.md) | The IDs of the Waybiller internal objects | [readonly] ## Example @@ -30,12 +31,12 @@ json = "{}" # create an instance of ExternalAPILoaderActionLog from a JSON string external_api_loader_action_log_instance = ExternalAPILoaderActionLog.from_json(json) # print the JSON string representation of the object -print ExternalAPILoaderActionLog.to_json() +print(ExternalAPILoaderActionLog.to_json()) # convert the object into a dict external_api_loader_action_log_dict = external_api_loader_action_log_instance.to_dict() # create an instance of ExternalAPILoaderActionLog from a dict -external_api_loader_action_log_form_dict = external_api_loader_action_log.from_dict(external_api_loader_action_log_dict) +external_api_loader_action_log_from_dict = ExternalAPILoaderActionLog.from_dict(external_api_loader_action_log_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPILoaderActionLogComment.md b/pywaybiller/docs/ExternalAPILoaderActionLogComment.md index b98edfc..9492224 100644 --- a/pywaybiller/docs/ExternalAPILoaderActionLogComment.md +++ b/pywaybiller/docs/ExternalAPILoaderActionLogComment.md @@ -2,12 +2,13 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**author_name** | **str** | | -**author_company_name** | **str** | | -**comment** | **str** | | -**created_timestamp** | **datetime** | | [optional] [readonly] +**author_name** | **str** | Full name of the person who wrote the comment | [readonly] +**author_company_name** | **str** | Company that the comment author represents | [readonly] +**comment** | **str** | Full text content of the comment with no length restriction | [readonly] +**created_timestamp** | **datetime** | Date and time when the comment was submitted (Format: `YYYY-MM-DDThh:mm:ss.ffffff+hh:mm`) | [readonly] ## Example @@ -19,12 +20,12 @@ json = "{}" # create an instance of ExternalAPILoaderActionLogComment from a JSON string external_api_loader_action_log_comment_instance = ExternalAPILoaderActionLogComment.from_json(json) # print the JSON string representation of the object -print ExternalAPILoaderActionLogComment.to_json() +print(ExternalAPILoaderActionLogComment.to_json()) # convert the object into a dict external_api_loader_action_log_comment_dict = external_api_loader_action_log_comment_instance.to_dict() # create an instance of ExternalAPILoaderActionLogComment from a dict -external_api_loader_action_log_comment_form_dict = external_api_loader_action_log_comment.from_dict(external_api_loader_action_log_comment_dict) +external_api_loader_action_log_comment_from_dict = ExternalAPILoaderActionLogComment.from_dict(external_api_loader_action_log_comment_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPILoaderActionLogRawData.md b/pywaybiller/docs/ExternalAPILoaderActionLogRawData.md index 1f826b3..963584e 100644 --- a/pywaybiller/docs/ExternalAPILoaderActionLogRawData.md +++ b/pywaybiller/docs/ExternalAPILoaderActionLogRawData.md @@ -1,18 +1,18 @@ # ExternalAPILoaderActionLogRawData -The IDs of the Waybiller internal objects. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**log_id** | **int** | The ID of the log. | -**loader_operator_user_id** | **int** | The ID of the loader operator user. | -**origin_id** | **int** | The ID of the origin. | -**order_id** | **int** | The ID of the order. | -**vehicle_id** | **int** | The ID of the vehicle. | -**loader_unit_id** | **int** | The ID of the loader unit. | -**assortment_id** | **int** | The ID of the assortment. | -**subset_id** | **int** | The ID of the subset. | +**log_id** | **int** | Unique identifier of the loader action log | [readonly] +**loader_operator_user_id** | **int** | Unique identifier of the user operating the loader | [readonly] +**origin_id** | **int** | Unique identifier of the origin where the action was performed | [readonly] +**order_id** | **int** | Unique identifier of the associated order, if applicable | [readonly] +**vehicle_id** | **int** | Unique identifier of the vehicle involved in the action, if applicable | [readonly] +**loader_unit_id** | **int** | Unique identifier of the used loader unit | [readonly] +**assortment_id** | **int** | Unique identifier of the loaded assortment, if applicable | [readonly] +**subset_id** | **int** | Unique identifier of the assortment subset, if applicable | [readonly] ## Example @@ -24,12 +24,12 @@ json = "{}" # create an instance of ExternalAPILoaderActionLogRawData from a JSON string external_api_loader_action_log_raw_data_instance = ExternalAPILoaderActionLogRawData.from_json(json) # print the JSON string representation of the object -print ExternalAPILoaderActionLogRawData.to_json() +print(ExternalAPILoaderActionLogRawData.to_json()) # convert the object into a dict external_api_loader_action_log_raw_data_dict = external_api_loader_action_log_raw_data_instance.to_dict() # create an instance of ExternalAPILoaderActionLogRawData from a dict -external_api_loader_action_log_raw_data_form_dict = external_api_loader_action_log_raw_data.from_dict(external_api_loader_action_log_raw_data_dict) +external_api_loader_action_log_raw_data_from_dict = ExternalAPILoaderActionLogRawData.from_dict(external_api_loader_action_log_raw_data_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIOrder.md b/pywaybiller/docs/ExternalAPIOrder.md index d673891..64ebe36 100644 --- a/pywaybiller/docs/ExternalAPIOrder.md +++ b/pywaybiller/docs/ExternalAPIOrder.md @@ -2,15 +2,16 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**number** | **str** | Order number. | [optional] [readonly] -**status** | **str** | The status of the order. | [optional] [readonly] +**number** | **str** | Order number. | [readonly] +**status** | **str** | The status of the order. | [readonly] **order_id** | **str** | Order id (in your system). | -**order_raw_id** | **str** | Order raw id. | [optional] [readonly] +**order_raw_id** | **str** | Order raw id. | [readonly] **period** | **List[date]** | The date range when the order is active. | -**owner_raw_id** | **str** | Raw id of the owner company. | [optional] [readonly] -**owner_company_name** | **str** | Name of the company who owns the order. | [optional] [readonly] +**owner_raw_id** | **str** | Raw id of the owner company. | [readonly] +**owner_company_name** | **str** | Name of the company who owns the order. | [readonly] **client_id** | **str** | The company id (in your system) for whom the order is created for. | [optional] **client_company_reg_code** | **str** | The company reg code for whom the order is created for. Used as raw id to match the company, if it exists. | [optional] **client_company_name** | **str** | Name of the company for whom the order is created for. | [optional] @@ -21,14 +22,14 @@ Name | Type | Description | Notes **destination_latitude** | **float** | Destination location - latitude. | [optional] **destination_longitude** | **float** | Destination location - longitude. | [optional] **origins** | [**List[ExternalAPIOrderOrigin]**](ExternalAPIOrderOrigin.md) | The origins for which the order is created for. | [optional] -**total_allowed_amount** | **decimal.Decimal** | Total allowed amount in tonnes. | [optional] +**total_allowed_amount** | **decimal.Decimal** | Total allowed amount. | [optional] **rows** | [**List[ExternalAPIOrderOriginsAssortments]**](ExternalAPIOrderOriginsAssortments.md) | Origin's assortments. | [optional] **transportation_companies** | [**List[ExternalAPIOrderTransportCompanies]**](ExternalAPIOrderTransportCompanies.md) | The transportation companies the client is using for transporting assortments from origins to destination. | [optional] **client_can_edit_transportation_values** | **bool** | Client can edit transportation values. | [optional] **vehicles** | [**List[ExternalAPIOrderVehicles]**](ExternalAPIOrderVehicles.md) | The vehicles that the transportation companies are allowed to use for this order. | [optional] **extra_information** | **str** | Extra information. | [optional] **user_id** | **int** | User who created this order. | -**raw_data** | [**ExternalAPIOrderRawData**](ExternalAPIOrderRawData.md) | | [optional] +**raw_data** | [**ExternalAPIOrderRawData**](ExternalAPIOrderRawData.md) | The IDs of the Waybiller internal objects | [readonly] ## Example @@ -40,12 +41,12 @@ json = "{}" # create an instance of ExternalAPIOrder from a JSON string external_api_order_instance = ExternalAPIOrder.from_json(json) # print the JSON string representation of the object -print ExternalAPIOrder.to_json() +print(ExternalAPIOrder.to_json()) # convert the object into a dict external_api_order_dict = external_api_order_instance.to_dict() # create an instance of ExternalAPIOrder from a dict -external_api_order_form_dict = external_api_order.from_dict(external_api_order_dict) +external_api_order_from_dict = ExternalAPIOrder.from_dict(external_api_order_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIOrderCreate.md b/pywaybiller/docs/ExternalAPIOrderCreate.md index a5be8ee..baa3996 100644 --- a/pywaybiller/docs/ExternalAPIOrderCreate.md +++ b/pywaybiller/docs/ExternalAPIOrderCreate.md @@ -2,15 +2,16 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**number** | **str** | Order number. | [optional] [readonly] -**status** | **str** | The status of the order. | [optional] [readonly] +**number** | **str** | Order number. | [readonly] +**status** | **str** | The status of the order. | [readonly] **order_id** | **str** | Order id (in your system). | -**order_raw_id** | **str** | Order raw id. | [optional] [readonly] +**order_raw_id** | **str** | Order raw id. | [readonly] **period** | **List[date]** | The date range when the order is active. | -**owner_raw_id** | **str** | Raw id of the owner company. | [optional] [readonly] -**owner_company_name** | **str** | Name of the company who owns the order. | [optional] [readonly] +**owner_raw_id** | **str** | Raw id of the owner company. | [readonly] +**owner_company_name** | **str** | Name of the company who owns the order. | [readonly] **client_id** | **str** | The company id (in your system) for whom the order is created for. | [optional] **client_company_reg_code** | **str** | The company reg code for whom the order is created for. Used as raw id to match the company, if it exists. | [optional] **client_company_name** | **str** | Name of the company for whom the order is created for. | [optional] @@ -21,14 +22,14 @@ Name | Type | Description | Notes **destination_latitude** | **float** | Destination location - latitude. | [optional] **destination_longitude** | **float** | Destination location - longitude. | [optional] **origins** | [**List[ExternalAPIOrderOrigin]**](ExternalAPIOrderOrigin.md) | The origins for which the order is created for. | [optional] -**total_allowed_amount** | **decimal.Decimal** | Total allowed amount in tonnes. | [optional] +**total_allowed_amount** | **decimal.Decimal** | Total allowed amount. | [optional] **rows** | [**List[ExternalAPIOrderOriginsAssortments]**](ExternalAPIOrderOriginsAssortments.md) | Origin's assortments. | [optional] **transportation_companies** | [**List[ExternalAPIOrderTransportCompanies]**](ExternalAPIOrderTransportCompanies.md) | The transportation companies the client is using for transporting assortments from origins to destination. | [optional] **client_can_edit_transportation_values** | **bool** | Client can edit transportation values. | [optional] **vehicles** | [**List[ExternalAPIOrderVehicles]**](ExternalAPIOrderVehicles.md) | The vehicles that the transportation companies are allowed to use for this order. | [optional] **extra_information** | **str** | Extra information. | [optional] **user_id** | **int** | User who created this order. | -**raw_data** | [**ExternalAPIOrderRawData**](ExternalAPIOrderRawData.md) | | [optional] +**raw_data** | [**ExternalAPIOrderRawData**](ExternalAPIOrderRawData.md) | The IDs of the Waybiller internal objects | [readonly] ## Example @@ -40,12 +41,12 @@ json = "{}" # create an instance of ExternalAPIOrderCreate from a JSON string external_api_order_create_instance = ExternalAPIOrderCreate.from_json(json) # print the JSON string representation of the object -print ExternalAPIOrderCreate.to_json() +print(ExternalAPIOrderCreate.to_json()) # convert the object into a dict external_api_order_create_dict = external_api_order_create_instance.to_dict() # create an instance of ExternalAPIOrderCreate from a dict -external_api_order_create_form_dict = external_api_order_create.from_dict(external_api_order_create_dict) +external_api_order_create_from_dict = ExternalAPIOrderCreate.from_dict(external_api_order_create_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIOrderCreateRequest.md b/pywaybiller/docs/ExternalAPIOrderCreateRequest.md new file mode 100644 index 0000000..26d4074 --- /dev/null +++ b/pywaybiller/docs/ExternalAPIOrderCreateRequest.md @@ -0,0 +1,47 @@ +# ExternalAPIOrderCreateRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**order_id** | **str** | Order id (in your system). | +**period** | **List[date]** | The date range when the order is active. | +**client_id** | **str** | The company id (in your system) for whom the order is created for. | [optional] +**client_company_reg_code** | **str** | The company reg code for whom the order is created for. Used as raw id to match the company, if it exists. | [optional] +**client_company_name** | **str** | Name of the company for whom the order is created for. | [optional] +**destination_raw_id** | **str** | Destination raw id. | [optional] +**destination_id** | **int** | Destination id (in your system). | [optional] +**destination_name** | **str** | Destination name. | [optional] +**destination_address** | **str** | Destination address. | [optional] +**destination_latitude** | **float** | Destination location - latitude. | [optional] +**destination_longitude** | **float** | Destination location - longitude. | [optional] +**origins** | [**List[ExternalAPIOrderOriginRequest]**](ExternalAPIOrderOriginRequest.md) | The origins for which the order is created for. | [optional] +**total_allowed_amount** | **decimal.Decimal** | Total allowed amount. | [optional] +**rows** | [**List[ExternalAPIOrderOriginsAssortmentsRequest]**](ExternalAPIOrderOriginsAssortmentsRequest.md) | Origin's assortments. | [optional] +**transportation_companies** | [**List[ExternalAPIOrderTransportCompaniesRequest]**](ExternalAPIOrderTransportCompaniesRequest.md) | The transportation companies the client is using for transporting assortments from origins to destination. | [optional] +**client_can_edit_transportation_values** | **bool** | Client can edit transportation values. | [optional] +**vehicles** | [**List[ExternalAPIOrderVehiclesRequest]**](ExternalAPIOrderVehiclesRequest.md) | The vehicles that the transportation companies are allowed to use for this order. | [optional] +**extra_information** | **str** | Extra information. | [optional] +**user_id** | **int** | User who created this order. | + +## Example + +```python +from openapi_client.models.external_api_order_create_request import ExternalAPIOrderCreateRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIOrderCreateRequest from a JSON string +external_api_order_create_request_instance = ExternalAPIOrderCreateRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIOrderCreateRequest.to_json()) + +# convert the object into a dict +external_api_order_create_request_dict = external_api_order_create_request_instance.to_dict() +# create an instance of ExternalAPIOrderCreateRequest from a dict +external_api_order_create_request_from_dict = ExternalAPIOrderCreateRequest.from_dict(external_api_order_create_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIOrderList.md b/pywaybiller/docs/ExternalAPIOrderList.md index 56354d8..37b3d9b 100644 --- a/pywaybiller/docs/ExternalAPIOrderList.md +++ b/pywaybiller/docs/ExternalAPIOrderList.md @@ -2,18 +2,19 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**order_id** | **str** | Order id. | [optional] [readonly] -**number** | **str** | Order number. | [optional] [readonly] -**status** | **str** | The status of the order. | [optional] [readonly] +**order_id** | **str** | Order id. | [readonly] +**number** | **str** | Order number. | [readonly] +**status** | **str** | The status of the order. | [readonly] **period** | **List[date]** | The date range when the order is active. | -**origins** | [**List[ExternalAPIOrderOrigin]**](ExternalAPIOrderOrigin.md) | The origins for which the order is created for. | [optional] [readonly] -**owner_company_name** | **str** | Name of the company who owns the order. | [optional] [readonly] -**client_company_name** | **str** | Name of the company for whom the order is created for. | [optional] [readonly] -**destination_name** | **str** | Destination name. | [optional] [readonly] -**total_allowed_amount** | **decimal.Decimal** | Total allowed amount in tonnes. | [optional] [readonly] -**raw_data** | [**ExternalAPIOrderRawData**](ExternalAPIOrderRawData.md) | | [optional] +**origins** | [**List[ExternalAPIOrderOrigin]**](ExternalAPIOrderOrigin.md) | The origins for which the order is created for. | [readonly] +**owner_company_name** | **str** | Name of the company who owns the order. | [readonly] +**client_company_name** | **str** | Name of the company for whom the order is created for. | [readonly] +**destination_name** | **str** | Destination name. | [readonly] +**total_allowed_amount** | **decimal.Decimal** | Total allowed amount. | [readonly] +**raw_data** | [**ExternalAPIOrderRawData**](ExternalAPIOrderRawData.md) | The IDs of the Waybiller internal objects | [readonly] ## Example @@ -25,12 +26,12 @@ json = "{}" # create an instance of ExternalAPIOrderList from a JSON string external_api_order_list_instance = ExternalAPIOrderList.from_json(json) # print the JSON string representation of the object -print ExternalAPIOrderList.to_json() +print(ExternalAPIOrderList.to_json()) # convert the object into a dict external_api_order_list_dict = external_api_order_list_instance.to_dict() # create an instance of ExternalAPIOrderList from a dict -external_api_order_list_form_dict = external_api_order_list.from_dict(external_api_order_list_dict) +external_api_order_list_from_dict = ExternalAPIOrderList.from_dict(external_api_order_list_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIOrderOrigin.md b/pywaybiller/docs/ExternalAPIOrderOrigin.md index 2bf074a..40155f1 100644 --- a/pywaybiller/docs/ExternalAPIOrderOrigin.md +++ b/pywaybiller/docs/ExternalAPIOrderOrigin.md @@ -1,8 +1,8 @@ # ExternalAPIOrderOrigin -The origins for which the order is created for. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **origin_raw_id** | **str** | Origin raw id. | [optional] @@ -23,12 +23,12 @@ json = "{}" # create an instance of ExternalAPIOrderOrigin from a JSON string external_api_order_origin_instance = ExternalAPIOrderOrigin.from_json(json) # print the JSON string representation of the object -print ExternalAPIOrderOrigin.to_json() +print(ExternalAPIOrderOrigin.to_json()) # convert the object into a dict external_api_order_origin_dict = external_api_order_origin_instance.to_dict() # create an instance of ExternalAPIOrderOrigin from a dict -external_api_order_origin_form_dict = external_api_order_origin.from_dict(external_api_order_origin_dict) +external_api_order_origin_from_dict = ExternalAPIOrderOrigin.from_dict(external_api_order_origin_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIOrderOriginRequest.md b/pywaybiller/docs/ExternalAPIOrderOriginRequest.md new file mode 100644 index 0000000..d5f299d --- /dev/null +++ b/pywaybiller/docs/ExternalAPIOrderOriginRequest.md @@ -0,0 +1,35 @@ +# ExternalAPIOrderOriginRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**origin_raw_id** | **str** | Origin raw id. | [optional] +**origin_name** | **str** | Origin name. | [optional] +**origin_address** | **str** | Origin address. | [optional] +**origin_latitude** | **float** | Origin location - latitude. | [optional] +**origin_longitude** | **float** | Origin location - longitude. | [optional] +**shipper_company_name** | **str** | Origin company name. | [optional] +**shipper_company_reg_code** | **str** | Origin company reg code. | [optional] + +## Example + +```python +from openapi_client.models.external_api_order_origin_request import ExternalAPIOrderOriginRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIOrderOriginRequest from a JSON string +external_api_order_origin_request_instance = ExternalAPIOrderOriginRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIOrderOriginRequest.to_json()) + +# convert the object into a dict +external_api_order_origin_request_dict = external_api_order_origin_request_instance.to_dict() +# create an instance of ExternalAPIOrderOriginRequest from a dict +external_api_order_origin_request_from_dict = ExternalAPIOrderOriginRequest.from_dict(external_api_order_origin_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIOrderOriginsAssortments.md b/pywaybiller/docs/ExternalAPIOrderOriginsAssortments.md index 2aa4d66..0b0f7b3 100644 --- a/pywaybiller/docs/ExternalAPIOrderOriginsAssortments.md +++ b/pywaybiller/docs/ExternalAPIOrderOriginsAssortments.md @@ -1,12 +1,12 @@ # ExternalAPIOrderOriginsAssortments -Origin's assortments. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **origin_assortment_raw_id** | **str** | Origin assortment raw id. | [optional] -**assortment_name** | **str** | Origin assortment name with subset value (if exists). | [optional] [readonly] +**assortment_name** | **str** | Origin assortment name with subset value (if exists). | [readonly] ## Example @@ -18,12 +18,12 @@ json = "{}" # create an instance of ExternalAPIOrderOriginsAssortments from a JSON string external_api_order_origins_assortments_instance = ExternalAPIOrderOriginsAssortments.from_json(json) # print the JSON string representation of the object -print ExternalAPIOrderOriginsAssortments.to_json() +print(ExternalAPIOrderOriginsAssortments.to_json()) # convert the object into a dict external_api_order_origins_assortments_dict = external_api_order_origins_assortments_instance.to_dict() # create an instance of ExternalAPIOrderOriginsAssortments from a dict -external_api_order_origins_assortments_form_dict = external_api_order_origins_assortments.from_dict(external_api_order_origins_assortments_dict) +external_api_order_origins_assortments_from_dict = ExternalAPIOrderOriginsAssortments.from_dict(external_api_order_origins_assortments_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIOrderOriginsAssortmentsRequest.md b/pywaybiller/docs/ExternalAPIOrderOriginsAssortmentsRequest.md new file mode 100644 index 0000000..b5e70ee --- /dev/null +++ b/pywaybiller/docs/ExternalAPIOrderOriginsAssortmentsRequest.md @@ -0,0 +1,29 @@ +# ExternalAPIOrderOriginsAssortmentsRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**origin_assortment_raw_id** | **str** | Origin assortment raw id. | [optional] + +## Example + +```python +from openapi_client.models.external_api_order_origins_assortments_request import ExternalAPIOrderOriginsAssortmentsRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIOrderOriginsAssortmentsRequest from a JSON string +external_api_order_origins_assortments_request_instance = ExternalAPIOrderOriginsAssortmentsRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIOrderOriginsAssortmentsRequest.to_json()) + +# convert the object into a dict +external_api_order_origins_assortments_request_dict = external_api_order_origins_assortments_request_instance.to_dict() +# create an instance of ExternalAPIOrderOriginsAssortmentsRequest from a dict +external_api_order_origins_assortments_request_from_dict = ExternalAPIOrderOriginsAssortmentsRequest.from_dict(external_api_order_origins_assortments_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIOrderRawData.md b/pywaybiller/docs/ExternalAPIOrderRawData.md index 6f68107..cc49307 100644 --- a/pywaybiller/docs/ExternalAPIOrderRawData.md +++ b/pywaybiller/docs/ExternalAPIOrderRawData.md @@ -1,20 +1,20 @@ # ExternalAPIOrderRawData -Raw values in Waybiller. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**order_id** | **int** | Order raw id. | -**number** | **str** | Order number. | -**status** | **int** | The number representing the status of the order. 1 - Mustand, 2 - Aktiivne, 3 - Mitteaktiivne, 4 - Arhiveeritud | -**origins** | **List[int]** | Lähtekohad, mille jaoks see tellimus loodud on. | [optional] [readonly] -**owner_company_id** | **str** | Owner company raw id. | -**client_id** | **str** | Client company raw id. | -**origins_assortment** | **List[int]** | The assortment that can be grabbed by an order's executor. | [optional] [readonly] -**transportation_companies** | **List[int]** | Veofirmad, mida tellimuse klient kasutab vedude jaoks lähtekohtadest sihtkohta. | [optional] [readonly] -**vehicles** | **List[int]** | Veokid, kes võivad selle tellimuse alusel vedusid teostada. | [optional] [readonly] -**destination** | **int** | Sihtkoht, kuhu selle tellimuse alusel on võimalik vedusid teostada. | [optional] [readonly] +**order_id** | **int** | Order raw id. | [readonly] +**number** | **str** | Order number. | [readonly] +**status** | **int** | The number representing the status of the order. 1 - Mustand, 2 - Aktiivne, 3 - Mitteaktiivne, 4 - Arhiveeritud | [readonly] +**origins** | **List[int]** | The origins for which the order is created for. | [readonly] +**owner_company_id** | **str** | Owner company raw id. | [readonly] +**client_id** | **str** | Client company raw id. | [readonly] +**origins_assortment** | **List[int]** | The assortment that can be grabbed by an order's executor. | [readonly] +**transportation_companies** | **List[int]** | The transportation companies the `client` is using for transporting assortments from `origins`to `destination` | [readonly] +**vehicles** | **List[int]** | The vehicles that the `transportation_companies` are allowed to use for this order. | [readonly] +**destination** | **int** | The destination to where is order allows transporting assortments. | [readonly] ## Example @@ -26,12 +26,12 @@ json = "{}" # create an instance of ExternalAPIOrderRawData from a JSON string external_api_order_raw_data_instance = ExternalAPIOrderRawData.from_json(json) # print the JSON string representation of the object -print ExternalAPIOrderRawData.to_json() +print(ExternalAPIOrderRawData.to_json()) # convert the object into a dict external_api_order_raw_data_dict = external_api_order_raw_data_instance.to_dict() # create an instance of ExternalAPIOrderRawData from a dict -external_api_order_raw_data_form_dict = external_api_order_raw_data.from_dict(external_api_order_raw_data_dict) +external_api_order_raw_data_from_dict = ExternalAPIOrderRawData.from_dict(external_api_order_raw_data_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIOrderTransportCompanies.md b/pywaybiller/docs/ExternalAPIOrderTransportCompanies.md index 360d856..dd5253d 100644 --- a/pywaybiller/docs/ExternalAPIOrderTransportCompanies.md +++ b/pywaybiller/docs/ExternalAPIOrderTransportCompanies.md @@ -1,8 +1,8 @@ # ExternalAPIOrderTransportCompanies -The transportation companies the client is using for transporting assortments from origins to destination. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **transportation_company_name** | **str** | Transportation company name. | [optional] @@ -18,12 +18,12 @@ json = "{}" # create an instance of ExternalAPIOrderTransportCompanies from a JSON string external_api_order_transport_companies_instance = ExternalAPIOrderTransportCompanies.from_json(json) # print the JSON string representation of the object -print ExternalAPIOrderTransportCompanies.to_json() +print(ExternalAPIOrderTransportCompanies.to_json()) # convert the object into a dict external_api_order_transport_companies_dict = external_api_order_transport_companies_instance.to_dict() # create an instance of ExternalAPIOrderTransportCompanies from a dict -external_api_order_transport_companies_form_dict = external_api_order_transport_companies.from_dict(external_api_order_transport_companies_dict) +external_api_order_transport_companies_from_dict = ExternalAPIOrderTransportCompanies.from_dict(external_api_order_transport_companies_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIOrderTransportCompaniesRequest.md b/pywaybiller/docs/ExternalAPIOrderTransportCompaniesRequest.md new file mode 100644 index 0000000..7a6be5f --- /dev/null +++ b/pywaybiller/docs/ExternalAPIOrderTransportCompaniesRequest.md @@ -0,0 +1,30 @@ +# ExternalAPIOrderTransportCompaniesRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**transportation_company_name** | **str** | Transportation company name. | [optional] +**transportation_company_reg_code** | **str** | Transportation company reg code. | [optional] + +## Example + +```python +from openapi_client.models.external_api_order_transport_companies_request import ExternalAPIOrderTransportCompaniesRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIOrderTransportCompaniesRequest from a JSON string +external_api_order_transport_companies_request_instance = ExternalAPIOrderTransportCompaniesRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIOrderTransportCompaniesRequest.to_json()) + +# convert the object into a dict +external_api_order_transport_companies_request_dict = external_api_order_transport_companies_request_instance.to_dict() +# create an instance of ExternalAPIOrderTransportCompaniesRequest from a dict +external_api_order_transport_companies_request_from_dict = ExternalAPIOrderTransportCompaniesRequest.from_dict(external_api_order_transport_companies_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIOrderUpdate.md b/pywaybiller/docs/ExternalAPIOrderUpdate.md index 8e06fef..a6776b1 100644 --- a/pywaybiller/docs/ExternalAPIOrderUpdate.md +++ b/pywaybiller/docs/ExternalAPIOrderUpdate.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **period** | **List[date]** | The date range when the order is active. | [optional] @@ -16,11 +17,11 @@ Name | Type | Description | Notes **destination_longitude** | **float** | Destination location - longitude. | [optional] **origins** | [**List[ExternalAPIOrderOrigin]**](ExternalAPIOrderOrigin.md) | The origins for which the order is created for. | [optional] **rows** | [**List[ExternalAPIOrderOriginsAssortments]**](ExternalAPIOrderOriginsAssortments.md) | Origin's assortments. | [optional] -**total_allowed_amount** | **decimal.Decimal** | Total allowed amount in tonnes. | [optional] +**total_allowed_amount** | **decimal.Decimal** | Total allowed amount. | [optional] **transportation_companies** | [**List[ExternalAPIOrderTransportCompanies]**](ExternalAPIOrderTransportCompanies.md) | The transportation companies the client is using for transporting assortments from origins to destination. | [optional] **vehicles** | [**List[ExternalAPIOrderVehicles]**](ExternalAPIOrderVehicles.md) | The vehicles that the transportation companies are allowed to use for this order. | [optional] **client_can_edit_transportation_values** | **bool** | Client can edit transportation values. | [optional] -**cancel_transport_orders_on_allowed_amount_exceeding** | **bool** | Tühista alustamata veotellimused ja ära luba luua uusi veotellimusi, kui tellimuse kogus on ületatud. | [optional] +**cancel_transport_orders_on_allowed_amount_exceeding** | **bool** | Cancel transport orders and do not allow to create new transport orders if the order amount has been exceeded. | [optional] **extra_information** | **str** | Extra information. | [optional] ## Example @@ -33,12 +34,12 @@ json = "{}" # create an instance of ExternalAPIOrderUpdate from a JSON string external_api_order_update_instance = ExternalAPIOrderUpdate.from_json(json) # print the JSON string representation of the object -print ExternalAPIOrderUpdate.to_json() +print(ExternalAPIOrderUpdate.to_json()) # convert the object into a dict external_api_order_update_dict = external_api_order_update_instance.to_dict() # create an instance of ExternalAPIOrderUpdate from a dict -external_api_order_update_form_dict = external_api_order_update.from_dict(external_api_order_update_dict) +external_api_order_update_from_dict = ExternalAPIOrderUpdate.from_dict(external_api_order_update_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIOrderUpdateRequest.md b/pywaybiller/docs/ExternalAPIOrderUpdateRequest.md new file mode 100644 index 0000000..e561468 --- /dev/null +++ b/pywaybiller/docs/ExternalAPIOrderUpdateRequest.md @@ -0,0 +1,46 @@ +# ExternalAPIOrderUpdateRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**period** | **List[date]** | The date range when the order is active. | [optional] +**client_id** | **str** | The company id (in your system) for whom the order is created for. | [optional] +**client_company_reg_code** | **str** | The company reg code for whom the order is created for. Used as raw id to match the company, if it exists. | [optional] +**client_company_name** | **str** | Name of the company for whom the order is created for. | [optional] +**destination_raw_id** | **str** | Destination raw id. | [optional] +**destination_id** | **int** | Destination id (in your system). | [optional] +**destination_name** | **str** | Destination name. | [optional] +**destination_address** | **str** | Destination address. | [optional] +**destination_latitude** | **float** | Destination location - latitude. | [optional] +**destination_longitude** | **float** | Destination location - longitude. | [optional] +**origins** | [**List[ExternalAPIOrderOriginRequest]**](ExternalAPIOrderOriginRequest.md) | The origins for which the order is created for. | [optional] +**rows** | [**List[ExternalAPIOrderOriginsAssortmentsRequest]**](ExternalAPIOrderOriginsAssortmentsRequest.md) | Origin's assortments. | [optional] +**total_allowed_amount** | **decimal.Decimal** | Total allowed amount. | [optional] +**transportation_companies** | [**List[ExternalAPIOrderTransportCompaniesRequest]**](ExternalAPIOrderTransportCompaniesRequest.md) | The transportation companies the client is using for transporting assortments from origins to destination. | [optional] +**vehicles** | [**List[ExternalAPIOrderVehiclesRequest]**](ExternalAPIOrderVehiclesRequest.md) | The vehicles that the transportation companies are allowed to use for this order. | [optional] +**client_can_edit_transportation_values** | **bool** | Client can edit transportation values. | [optional] +**cancel_transport_orders_on_allowed_amount_exceeding** | **bool** | Cancel transport orders and do not allow to create new transport orders if the order amount has been exceeded. | [optional] +**extra_information** | **str** | Extra information. | [optional] + +## Example + +```python +from openapi_client.models.external_api_order_update_request import ExternalAPIOrderUpdateRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIOrderUpdateRequest from a JSON string +external_api_order_update_request_instance = ExternalAPIOrderUpdateRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIOrderUpdateRequest.to_json()) + +# convert the object into a dict +external_api_order_update_request_dict = external_api_order_update_request_instance.to_dict() +# create an instance of ExternalAPIOrderUpdateRequest from a dict +external_api_order_update_request_from_dict = ExternalAPIOrderUpdateRequest.from_dict(external_api_order_update_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIOrderVehicles.md b/pywaybiller/docs/ExternalAPIOrderVehicles.md index fcfcc66..59cdf1f 100644 --- a/pywaybiller/docs/ExternalAPIOrderVehicles.md +++ b/pywaybiller/docs/ExternalAPIOrderVehicles.md @@ -1,8 +1,8 @@ # ExternalAPIOrderVehicles -The vehicles that the transportation companies are allowed to use for this order. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **truck_reg_number** | **str** | Truck reg number. | [optional] @@ -19,12 +19,12 @@ json = "{}" # create an instance of ExternalAPIOrderVehicles from a JSON string external_api_order_vehicles_instance = ExternalAPIOrderVehicles.from_json(json) # print the JSON string representation of the object -print ExternalAPIOrderVehicles.to_json() +print(ExternalAPIOrderVehicles.to_json()) # convert the object into a dict external_api_order_vehicles_dict = external_api_order_vehicles_instance.to_dict() # create an instance of ExternalAPIOrderVehicles from a dict -external_api_order_vehicles_form_dict = external_api_order_vehicles.from_dict(external_api_order_vehicles_dict) +external_api_order_vehicles_from_dict = ExternalAPIOrderVehicles.from_dict(external_api_order_vehicles_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIOrderVehiclesRequest.md b/pywaybiller/docs/ExternalAPIOrderVehiclesRequest.md new file mode 100644 index 0000000..f783ce6 --- /dev/null +++ b/pywaybiller/docs/ExternalAPIOrderVehiclesRequest.md @@ -0,0 +1,31 @@ +# ExternalAPIOrderVehiclesRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**truck_reg_number** | **str** | Truck reg number. | [optional] +**trailer_reg_number** | **str** | Trailer reg number. | [optional] +**company_reg_code** | **str** | Company reg code that owns the truck. | [optional] + +## Example + +```python +from openapi_client.models.external_api_order_vehicles_request import ExternalAPIOrderVehiclesRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIOrderVehiclesRequest from a JSON string +external_api_order_vehicles_request_instance = ExternalAPIOrderVehiclesRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIOrderVehiclesRequest.to_json()) + +# convert the object into a dict +external_api_order_vehicles_request_dict = external_api_order_vehicles_request_instance.to_dict() +# create an instance of ExternalAPIOrderVehiclesRequest from a dict +external_api_order_vehicles_request_from_dict = ExternalAPIOrderVehiclesRequest.from_dict(external_api_order_vehicles_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIOriginAssortment.md b/pywaybiller/docs/ExternalAPIOriginAssortment.md index 2467acc..bd28a1a 100644 --- a/pywaybiller/docs/ExternalAPIOriginAssortment.md +++ b/pywaybiller/docs/ExternalAPIOriginAssortment.md @@ -2,14 +2,15 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | Origin assortment id. | -**origin** | **str** | Origin name. | [optional] -**assortment** | **str** | Assortment name. | [optional] -**subset_type** | **str** | Subset type. | [optional] -**subset** | **str** | Subset value. | [optional] -**raw_data** | [**ExternalAPIOriginAssortmentRaw**](ExternalAPIOriginAssortmentRaw.md) | | +**id** | **int** | Unique identifier of the origin-assortment relationship | [readonly] +**origin** | **str** | Name of the origin where the assortment is available | [readonly] +**assortment** | **str** | Name of the assortment | [readonly] +**subset_type** | **str** | Type of the assortment subset | [readonly] +**subset** | **str** | Specific value within the subset type | [readonly] +**raw_data** | [**ExternalAPIOriginAssortmentRawData**](ExternalAPIOriginAssortmentRawData.md) | The IDs of the Waybiller internal objects | [readonly] ## Example @@ -21,12 +22,12 @@ json = "{}" # create an instance of ExternalAPIOriginAssortment from a JSON string external_api_origin_assortment_instance = ExternalAPIOriginAssortment.from_json(json) # print the JSON string representation of the object -print ExternalAPIOriginAssortment.to_json() +print(ExternalAPIOriginAssortment.to_json()) # convert the object into a dict external_api_origin_assortment_dict = external_api_origin_assortment_instance.to_dict() # create an instance of ExternalAPIOriginAssortment from a dict -external_api_origin_assortment_form_dict = external_api_origin_assortment.from_dict(external_api_origin_assortment_dict) +external_api_origin_assortment_from_dict = ExternalAPIOriginAssortment.from_dict(external_api_origin_assortment_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIOriginAssortmentRaw.md b/pywaybiller/docs/ExternalAPIOriginAssortmentRaw.md deleted file mode 100644 index c8da64d..0000000 --- a/pywaybiller/docs/ExternalAPIOriginAssortmentRaw.md +++ /dev/null @@ -1,33 +0,0 @@ -# ExternalAPIOriginAssortmentRaw - -Raw values (ID-s) in Waybiller. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **int** | Origin assortment ID. | -**origin_id** | **int** | Origin ID. | -**assortment_id** | **int** | Assortment ID. | -**subset_type_id** | **int** | Subset type ID. | -**subset_id** | **int** | Subset ID. | - -## Example - -```python -from openapi_client.models.external_api_origin_assortment_raw import ExternalAPIOriginAssortmentRaw - -# TODO update the JSON string below -json = "{}" -# create an instance of ExternalAPIOriginAssortmentRaw from a JSON string -external_api_origin_assortment_raw_instance = ExternalAPIOriginAssortmentRaw.from_json(json) -# print the JSON string representation of the object -print ExternalAPIOriginAssortmentRaw.to_json() - -# convert the object into a dict -external_api_origin_assortment_raw_dict = external_api_origin_assortment_raw_instance.to_dict() -# create an instance of ExternalAPIOriginAssortmentRaw from a dict -external_api_origin_assortment_raw_form_dict = external_api_origin_assortment_raw.from_dict(external_api_origin_assortment_raw_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/pywaybiller/docs/ExternalAPIOriginAssortmentRawData.md b/pywaybiller/docs/ExternalAPIOriginAssortmentRawData.md new file mode 100644 index 0000000..5c79acf --- /dev/null +++ b/pywaybiller/docs/ExternalAPIOriginAssortmentRawData.md @@ -0,0 +1,33 @@ +# ExternalAPIOriginAssortmentRawData + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | Unique identifier of the origin-assortment relationship | [readonly] +**origin_id** | **int** | Unique identifier of the origin | [readonly] +**assortment_id** | **int** | Unique identifier of the assortment | [readonly] +**subset_type_id** | **int** | Unique identifier of the subset type that categorizes the assortment | [readonly] +**subset_id** | **int** | Unique identifier of the assortment subset | [readonly] + +## Example + +```python +from openapi_client.models.external_api_origin_assortment_raw_data import ExternalAPIOriginAssortmentRawData + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIOriginAssortmentRawData from a JSON string +external_api_origin_assortment_raw_data_instance = ExternalAPIOriginAssortmentRawData.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIOriginAssortmentRawData.to_json()) + +# convert the object into a dict +external_api_origin_assortment_raw_data_dict = external_api_origin_assortment_raw_data_instance.to_dict() +# create an instance of ExternalAPIOriginAssortmentRawData from a dict +external_api_origin_assortment_raw_data_from_dict = ExternalAPIOriginAssortmentRawData.from_dict(external_api_origin_assortment_raw_data_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIOriginAssortmentRequest.md b/pywaybiller/docs/ExternalAPIOriginAssortmentRequest.md new file mode 100644 index 0000000..7715edd --- /dev/null +++ b/pywaybiller/docs/ExternalAPIOriginAssortmentRequest.md @@ -0,0 +1,30 @@ +# ExternalAPIOriginAssortmentRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | Assortment ID | +**subsets** | **List[int]** | List of subset IDs | [optional] [default to []] + +## Example + +```python +from openapi_client.models.external_api_origin_assortment_request import ExternalAPIOriginAssortmentRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIOriginAssortmentRequest from a JSON string +external_api_origin_assortment_request_instance = ExternalAPIOriginAssortmentRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIOriginAssortmentRequest.to_json()) + +# convert the object into a dict +external_api_origin_assortment_request_dict = external_api_origin_assortment_request_instance.to_dict() +# create an instance of ExternalAPIOriginAssortmentRequest from a dict +external_api_origin_assortment_request_from_dict = ExternalAPIOriginAssortmentRequest.from_dict(external_api_origin_assortment_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExtAPIOriginRead.md b/pywaybiller/docs/ExternalAPIOriginCreate.md similarity index 55% rename from pywaybiller/docs/ExtAPIOriginRead.md rename to pywaybiller/docs/ExternalAPIOriginCreate.md index 993c673..e262d3f 100644 --- a/pywaybiller/docs/ExtAPIOriginRead.md +++ b/pywaybiller/docs/ExternalAPIOriginCreate.md @@ -1,17 +1,18 @@ -# ExtAPIOriginRead +# ExternalAPIOriginCreate ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | | [optional] [readonly] +**id** | **int** | | [readonly] **name** | **str** | | **location** | [**GeoLocation**](GeoLocation.md) | | -**assortments** | [**List[ExtAPIOriginAssortment]**](ExtAPIOriginAssortment.md) | | +**assortments** | [**List[ExternalAPIOriginAssortment]**](ExternalAPIOriginAssortment.md) | | **partner_companies** | **List[str]** | List of registry codes of partner companies. | [optional] **public** | **bool** | | [optional] [default to False] **active** | **bool** | | [optional] [default to True] -**holding_base** | [**ExtAPIHoldingBaseRead**](ExtAPIHoldingBaseRead.md) | | [optional] +**holding_base** | [**ExternalAPIHoldingBase**](ExternalAPIHoldingBase.md) | Holding base data is provided as is, in internal WB format. It may change at any time without warning and may have a different schema for old and new origins | [optional] **cadaster_number** | **str** | Cadaster number of the Origin in free form. Required if holding base is sent. | [optional] **extra_information** | **str** | | [optional] **representative_name** | **str** | | [optional] @@ -19,9 +20,11 @@ Name | Type | Description | Notes **waybill_created_emails** | **List[str]** | E-mail addresses, where you want to receive notification when waybill is created. | [optional] **waybill_accepted_emails** | **List[str]** | E-mail addresses, where you want to receive notification when waybill is accepted. | [optional] **waybill_reached_destination_emails** | **List[str]** | E-mail addresses, where you want to receive notification when waybill has arrived at destination. | [optional] -**waybill_created_emails_language** | **str** | | [optional] [default to ''] -**waybill_accepted_emails_language** | **str** | | [optional] [default to ''] -**waybill_reached_destination_emails_language** | **str** | | [optional] [default to ''] +**transport_order_created_emails** | **List[str]** | E-mail addresses, where you want to receive notification when transport order is created. | [optional] +**waybill_created_emails_language** | [**ExternalAPIOriginCreateWaybillCreatedEmailsLanguage**](ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md) | | [optional] +**waybill_accepted_emails_language** | [**ExternalAPIOriginCreateWaybillCreatedEmailsLanguage**](ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md) | | [optional] +**waybill_reached_destination_emails_language** | [**ExternalAPIOriginCreateWaybillCreatedEmailsLanguage**](ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md) | | [optional] +**transport_order_created_emails_language** | [**ExternalAPIOriginCreateWaybillCreatedEmailsLanguage**](ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md) | | [optional] **feature_single_transport_order_per_truck** | **bool** | Managers are not allowed to create transport orders for a vehicle if there is an active transport order for the vehicle from this origin | [optional] [default to False] **feature_waybill_dispatched_amounts_changing_disabled** | **bool** | Drivers and receivers are not allowed to change dispatched amounts for waybills from this origin | [optional] [default to False] **feature_waybill_destination_changing_disabled_for_drivers** | **bool** | Drivers are not allowed to change the destination of waybills from this origin | [optional] [default to False] @@ -30,19 +33,19 @@ Name | Type | Description | Notes ## Example ```python -from openapi_client.models.ext_api_origin_read import ExtAPIOriginRead +from openapi_client.models.external_api_origin_create import ExternalAPIOriginCreate # TODO update the JSON string below json = "{}" -# create an instance of ExtAPIOriginRead from a JSON string -ext_api_origin_read_instance = ExtAPIOriginRead.from_json(json) +# create an instance of ExternalAPIOriginCreate from a JSON string +external_api_origin_create_instance = ExternalAPIOriginCreate.from_json(json) # print the JSON string representation of the object -print ExtAPIOriginRead.to_json() +print(ExternalAPIOriginCreate.to_json()) # convert the object into a dict -ext_api_origin_read_dict = ext_api_origin_read_instance.to_dict() -# create an instance of ExtAPIOriginRead from a dict -ext_api_origin_read_form_dict = ext_api_origin_read.from_dict(ext_api_origin_read_dict) +external_api_origin_create_dict = external_api_origin_create_instance.to_dict() +# create an instance of ExternalAPIOriginCreate from a dict +external_api_origin_create_from_dict = ExternalAPIOriginCreate.from_dict(external_api_origin_create_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIOriginCreateRequest.md b/pywaybiller/docs/ExternalAPIOriginCreateRequest.md new file mode 100644 index 0000000..9ce3b8c --- /dev/null +++ b/pywaybiller/docs/ExternalAPIOriginCreateRequest.md @@ -0,0 +1,51 @@ +# ExternalAPIOriginCreateRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**location** | [**GeoLocationRequest**](GeoLocationRequest.md) | | +**assortments** | [**List[ExternalAPIOriginAssortmentRequest]**](ExternalAPIOriginAssortmentRequest.md) | | +**partner_companies** | **List[str]** | List of registry codes of partner companies. | [optional] +**public** | **bool** | | [optional] [default to False] +**active** | **bool** | | [optional] [default to True] +**holding_base** | [**ExternalAPIHoldingBaseRequest**](ExternalAPIHoldingBaseRequest.md) | Holding base data is provided as is, in internal WB format. It may change at any time without warning and may have a different schema for old and new origins | [optional] +**cadaster_number** | **str** | Cadaster number of the Origin in free form. Required if holding base is sent. | [optional] +**extra_information** | **str** | | [optional] +**representative_name** | **str** | | [optional] +**representative_phone** | **str** | | [optional] +**waybill_created_emails** | **List[str]** | E-mail addresses, where you want to receive notification when waybill is created. | [optional] +**waybill_accepted_emails** | **List[str]** | E-mail addresses, where you want to receive notification when waybill is accepted. | [optional] +**waybill_reached_destination_emails** | **List[str]** | E-mail addresses, where you want to receive notification when waybill has arrived at destination. | [optional] +**transport_order_created_emails** | **List[str]** | E-mail addresses, where you want to receive notification when transport order is created. | [optional] +**waybill_created_emails_language** | [**ExternalAPIOriginCreateWaybillCreatedEmailsLanguage**](ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md) | | [optional] +**waybill_accepted_emails_language** | [**ExternalAPIOriginCreateWaybillCreatedEmailsLanguage**](ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md) | | [optional] +**waybill_reached_destination_emails_language** | [**ExternalAPIOriginCreateWaybillCreatedEmailsLanguage**](ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md) | | [optional] +**transport_order_created_emails_language** | [**ExternalAPIOriginCreateWaybillCreatedEmailsLanguage**](ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md) | | [optional] +**feature_single_transport_order_per_truck** | **bool** | Managers are not allowed to create transport orders for a vehicle if there is an active transport order for the vehicle from this origin | [optional] [default to False] +**feature_waybill_dispatched_amounts_changing_disabled** | **bool** | Drivers and receivers are not allowed to change dispatched amounts for waybills from this origin | [optional] [default to False] +**feature_waybill_destination_changing_disabled_for_drivers** | **bool** | Drivers are not allowed to change the destination of waybills from this origin | [optional] [default to False] +**company** | **str** | Registry code of the owner company. By default, API KEY company is used. Note, origin company can not be changed | [optional] + +## Example + +```python +from openapi_client.models.external_api_origin_create_request import ExternalAPIOriginCreateRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIOriginCreateRequest from a JSON string +external_api_origin_create_request_instance = ExternalAPIOriginCreateRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIOriginCreateRequest.to_json()) + +# convert the object into a dict +external_api_origin_create_request_dict = external_api_origin_create_request_instance.to_dict() +# create an instance of ExternalAPIOriginCreateRequest from a dict +external_api_origin_create_request_from_dict = ExternalAPIOriginCreateRequest.from_dict(external_api_origin_create_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md b/pywaybiller/docs/ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md new file mode 100644 index 0000000..fb05897 --- /dev/null +++ b/pywaybiller/docs/ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md @@ -0,0 +1,28 @@ +# ExternalAPIOriginCreateWaybillCreatedEmailsLanguage + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```python +from openapi_client.models.external_api_origin_create_waybill_created_emails_language import ExternalAPIOriginCreateWaybillCreatedEmailsLanguage + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIOriginCreateWaybillCreatedEmailsLanguage from a JSON string +external_api_origin_create_waybill_created_emails_language_instance = ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.to_json()) + +# convert the object into a dict +external_api_origin_create_waybill_created_emails_language_dict = external_api_origin_create_waybill_created_emails_language_instance.to_dict() +# create an instance of ExternalAPIOriginCreateWaybillCreatedEmailsLanguage from a dict +external_api_origin_create_waybill_created_emails_language_from_dict = ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.from_dict(external_api_origin_create_waybill_created_emails_language_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIOriginList.md b/pywaybiller/docs/ExternalAPIOriginList.md new file mode 100644 index 0000000..530ead2 --- /dev/null +++ b/pywaybiller/docs/ExternalAPIOriginList.md @@ -0,0 +1,34 @@ +# ExternalAPIOriginList + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | +**name** | **str** | | +**address** | **str** | | +**latitude** | **float** | | +**longitude** | **float** | | +**raw_data** | [**ExternalAPIOriginRawData**](ExternalAPIOriginRawData.md) | The IDs of the Waybiller internal objects | [readonly] + +## Example + +```python +from openapi_client.models.external_api_origin_list import ExternalAPIOriginList + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIOriginList from a JSON string +external_api_origin_list_instance = ExternalAPIOriginList.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIOriginList.to_json()) + +# convert the object into a dict +external_api_origin_list_dict = external_api_origin_list_instance.to_dict() +# create an instance of ExternalAPIOriginList from a dict +external_api_origin_list_from_dict = ExternalAPIOriginList.from_dict(external_api_origin_list_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIOriginRawData.md b/pywaybiller/docs/ExternalAPIOriginRawData.md new file mode 100644 index 0000000..c9361c5 --- /dev/null +++ b/pywaybiller/docs/ExternalAPIOriginRawData.md @@ -0,0 +1,30 @@ +# ExternalAPIOriginRawData + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | | [readonly] +**only_origin_owner_can_create_waybills** | **bool** | | [readonly] + +## Example + +```python +from openapi_client.models.external_api_origin_raw_data import ExternalAPIOriginRawData + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIOriginRawData from a JSON string +external_api_origin_raw_data_instance = ExternalAPIOriginRawData.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIOriginRawData.to_json()) + +# convert the object into a dict +external_api_origin_raw_data_dict = external_api_origin_raw_data_instance.to_dict() +# create an instance of ExternalAPIOriginRawData from a dict +external_api_origin_raw_data_from_dict = ExternalAPIOriginRawData.from_dict(external_api_origin_raw_data_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExtAPIOriginCreate.md b/pywaybiller/docs/ExternalAPIOriginRead.md similarity index 55% rename from pywaybiller/docs/ExtAPIOriginCreate.md rename to pywaybiller/docs/ExternalAPIOriginRead.md index e9d5d91..1cabf00 100644 --- a/pywaybiller/docs/ExtAPIOriginCreate.md +++ b/pywaybiller/docs/ExternalAPIOriginRead.md @@ -1,17 +1,18 @@ -# ExtAPIOriginCreate +# ExternalAPIOriginRead ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | | [optional] [readonly] +**id** | **int** | | [readonly] **name** | **str** | | **location** | [**GeoLocation**](GeoLocation.md) | | -**assortments** | [**List[ExtAPIOriginAssortment]**](ExtAPIOriginAssortment.md) | | +**assortments** | [**List[ExternalAPIOriginAssortment]**](ExternalAPIOriginAssortment.md) | | **partner_companies** | **List[str]** | List of registry codes of partner companies. | [optional] **public** | **bool** | | [optional] [default to False] **active** | **bool** | | [optional] [default to True] -**holding_base** | [**ExtAPIHoldingBase**](ExtAPIHoldingBase.md) | | [optional] +**holding_base** | [**ExternalAPIHoldingBaseRead**](ExternalAPIHoldingBaseRead.md) | Holding base data is provided as is, in internal WB format. It may change at any time without warning and may have a different schema for old and new origins | [optional] **cadaster_number** | **str** | Cadaster number of the Origin in free form. Required if holding base is sent. | [optional] **extra_information** | **str** | | [optional] **representative_name** | **str** | | [optional] @@ -19,9 +20,11 @@ Name | Type | Description | Notes **waybill_created_emails** | **List[str]** | E-mail addresses, where you want to receive notification when waybill is created. | [optional] **waybill_accepted_emails** | **List[str]** | E-mail addresses, where you want to receive notification when waybill is accepted. | [optional] **waybill_reached_destination_emails** | **List[str]** | E-mail addresses, where you want to receive notification when waybill has arrived at destination. | [optional] -**waybill_created_emails_language** | **str** | | [optional] [default to ''] -**waybill_accepted_emails_language** | **str** | | [optional] [default to ''] -**waybill_reached_destination_emails_language** | **str** | | [optional] [default to ''] +**transport_order_created_emails** | **List[str]** | E-mail addresses, where you want to receive notification when transport order is created. | [optional] +**waybill_created_emails_language** | [**ExternalAPIOriginCreateWaybillCreatedEmailsLanguage**](ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md) | | [optional] +**waybill_accepted_emails_language** | [**ExternalAPIOriginCreateWaybillCreatedEmailsLanguage**](ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md) | | [optional] +**waybill_reached_destination_emails_language** | [**ExternalAPIOriginCreateWaybillCreatedEmailsLanguage**](ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md) | | [optional] +**transport_order_created_emails_language** | [**ExternalAPIOriginCreateWaybillCreatedEmailsLanguage**](ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md) | | [optional] **feature_single_transport_order_per_truck** | **bool** | Managers are not allowed to create transport orders for a vehicle if there is an active transport order for the vehicle from this origin | [optional] [default to False] **feature_waybill_dispatched_amounts_changing_disabled** | **bool** | Drivers and receivers are not allowed to change dispatched amounts for waybills from this origin | [optional] [default to False] **feature_waybill_destination_changing_disabled_for_drivers** | **bool** | Drivers are not allowed to change the destination of waybills from this origin | [optional] [default to False] @@ -30,19 +33,19 @@ Name | Type | Description | Notes ## Example ```python -from openapi_client.models.ext_api_origin_create import ExtAPIOriginCreate +from openapi_client.models.external_api_origin_read import ExternalAPIOriginRead # TODO update the JSON string below json = "{}" -# create an instance of ExtAPIOriginCreate from a JSON string -ext_api_origin_create_instance = ExtAPIOriginCreate.from_json(json) +# create an instance of ExternalAPIOriginRead from a JSON string +external_api_origin_read_instance = ExternalAPIOriginRead.from_json(json) # print the JSON string representation of the object -print ExtAPIOriginCreate.to_json() +print(ExternalAPIOriginRead.to_json()) # convert the object into a dict -ext_api_origin_create_dict = ext_api_origin_create_instance.to_dict() -# create an instance of ExtAPIOriginCreate from a dict -ext_api_origin_create_form_dict = ext_api_origin_create.from_dict(ext_api_origin_create_dict) +external_api_origin_read_dict = external_api_origin_read_instance.to_dict() +# create an instance of ExternalAPIOriginRead from a dict +external_api_origin_read_from_dict = ExternalAPIOriginRead.from_dict(external_api_origin_read_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExtAPIOriginUpdate.md b/pywaybiller/docs/ExternalAPIOriginUpdate.md similarity index 53% rename from pywaybiller/docs/ExtAPIOriginUpdate.md rename to pywaybiller/docs/ExternalAPIOriginUpdate.md index d241edc..a32500f 100644 --- a/pywaybiller/docs/ExtAPIOriginUpdate.md +++ b/pywaybiller/docs/ExternalAPIOriginUpdate.md @@ -1,17 +1,18 @@ -# ExtAPIOriginUpdate +# ExternalAPIOriginUpdate ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | | [optional] [readonly] +**id** | **int** | | [readonly] **name** | **str** | | [optional] **location** | [**GeoLocation**](GeoLocation.md) | | [optional] -**assortments** | [**List[ExtAPIOriginAssortment]**](ExtAPIOriginAssortment.md) | | [optional] +**assortments** | [**List[ExternalAPIOriginAssortment]**](ExternalAPIOriginAssortment.md) | | [optional] **partner_companies** | **List[str]** | List of registry codes of partner companies. | [optional] **public** | **bool** | | [optional] [default to False] **active** | **bool** | | [optional] [default to True] -**holding_base** | [**ExtAPIHoldingBase**](ExtAPIHoldingBase.md) | | [optional] +**holding_base** | [**ExternalAPIHoldingBase**](ExternalAPIHoldingBase.md) | Holding base data is provided as is, in internal WB format. It may change at any time without warning and may have a different schema for old and new origins | [optional] **cadaster_number** | **str** | Cadaster number of the Origin in free form. Required if holding base is sent. | [optional] **extra_information** | **str** | | [optional] **representative_name** | **str** | | [optional] @@ -19,9 +20,11 @@ Name | Type | Description | Notes **waybill_created_emails** | **List[str]** | E-mail addresses, where you want to receive notification when waybill is created. | [optional] **waybill_accepted_emails** | **List[str]** | E-mail addresses, where you want to receive notification when waybill is accepted. | [optional] **waybill_reached_destination_emails** | **List[str]** | E-mail addresses, where you want to receive notification when waybill has arrived at destination. | [optional] -**waybill_created_emails_language** | **str** | | [optional] [default to ''] -**waybill_accepted_emails_language** | **str** | | [optional] [default to ''] -**waybill_reached_destination_emails_language** | **str** | | [optional] [default to ''] +**transport_order_created_emails** | **List[str]** | E-mail addresses, where you want to receive notification when transport order is created. | [optional] +**waybill_created_emails_language** | [**ExternalAPIOriginCreateWaybillCreatedEmailsLanguage**](ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md) | | [optional] +**waybill_accepted_emails_language** | [**ExternalAPIOriginCreateWaybillCreatedEmailsLanguage**](ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md) | | [optional] +**waybill_reached_destination_emails_language** | [**ExternalAPIOriginCreateWaybillCreatedEmailsLanguage**](ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md) | | [optional] +**transport_order_created_emails_language** | [**ExternalAPIOriginCreateWaybillCreatedEmailsLanguage**](ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md) | | [optional] **feature_single_transport_order_per_truck** | **bool** | Managers are not allowed to create transport orders for a vehicle if there is an active transport order for the vehicle from this origin | [optional] [default to False] **feature_waybill_dispatched_amounts_changing_disabled** | **bool** | Drivers and receivers are not allowed to change dispatched amounts for waybills from this origin | [optional] [default to False] **feature_waybill_destination_changing_disabled_for_drivers** | **bool** | Drivers are not allowed to change the destination of waybills from this origin | [optional] [default to False] @@ -29,19 +32,19 @@ Name | Type | Description | Notes ## Example ```python -from openapi_client.models.ext_api_origin_update import ExtAPIOriginUpdate +from openapi_client.models.external_api_origin_update import ExternalAPIOriginUpdate # TODO update the JSON string below json = "{}" -# create an instance of ExtAPIOriginUpdate from a JSON string -ext_api_origin_update_instance = ExtAPIOriginUpdate.from_json(json) +# create an instance of ExternalAPIOriginUpdate from a JSON string +external_api_origin_update_instance = ExternalAPIOriginUpdate.from_json(json) # print the JSON string representation of the object -print ExtAPIOriginUpdate.to_json() +print(ExternalAPIOriginUpdate.to_json()) # convert the object into a dict -ext_api_origin_update_dict = ext_api_origin_update_instance.to_dict() -# create an instance of ExtAPIOriginUpdate from a dict -ext_api_origin_update_form_dict = ext_api_origin_update.from_dict(ext_api_origin_update_dict) +external_api_origin_update_dict = external_api_origin_update_instance.to_dict() +# create an instance of ExternalAPIOriginUpdate from a dict +external_api_origin_update_from_dict = ExternalAPIOriginUpdate.from_dict(external_api_origin_update_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIOriginUpdateRequest.md b/pywaybiller/docs/ExternalAPIOriginUpdateRequest.md new file mode 100644 index 0000000..145f678 --- /dev/null +++ b/pywaybiller/docs/ExternalAPIOriginUpdateRequest.md @@ -0,0 +1,50 @@ +# ExternalAPIOriginUpdateRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | [optional] +**location** | [**GeoLocationRequest**](GeoLocationRequest.md) | | [optional] +**assortments** | [**List[ExternalAPIOriginAssortmentRequest]**](ExternalAPIOriginAssortmentRequest.md) | | [optional] +**partner_companies** | **List[str]** | List of registry codes of partner companies. | [optional] +**public** | **bool** | | [optional] [default to False] +**active** | **bool** | | [optional] [default to True] +**holding_base** | [**ExternalAPIHoldingBaseRequest**](ExternalAPIHoldingBaseRequest.md) | Holding base data is provided as is, in internal WB format. It may change at any time without warning and may have a different schema for old and new origins | [optional] +**cadaster_number** | **str** | Cadaster number of the Origin in free form. Required if holding base is sent. | [optional] +**extra_information** | **str** | | [optional] +**representative_name** | **str** | | [optional] +**representative_phone** | **str** | | [optional] +**waybill_created_emails** | **List[str]** | E-mail addresses, where you want to receive notification when waybill is created. | [optional] +**waybill_accepted_emails** | **List[str]** | E-mail addresses, where you want to receive notification when waybill is accepted. | [optional] +**waybill_reached_destination_emails** | **List[str]** | E-mail addresses, where you want to receive notification when waybill has arrived at destination. | [optional] +**transport_order_created_emails** | **List[str]** | E-mail addresses, where you want to receive notification when transport order is created. | [optional] +**waybill_created_emails_language** | [**ExternalAPIOriginCreateWaybillCreatedEmailsLanguage**](ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md) | | [optional] +**waybill_accepted_emails_language** | [**ExternalAPIOriginCreateWaybillCreatedEmailsLanguage**](ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md) | | [optional] +**waybill_reached_destination_emails_language** | [**ExternalAPIOriginCreateWaybillCreatedEmailsLanguage**](ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md) | | [optional] +**transport_order_created_emails_language** | [**ExternalAPIOriginCreateWaybillCreatedEmailsLanguage**](ExternalAPIOriginCreateWaybillCreatedEmailsLanguage.md) | | [optional] +**feature_single_transport_order_per_truck** | **bool** | Managers are not allowed to create transport orders for a vehicle if there is an active transport order for the vehicle from this origin | [optional] [default to False] +**feature_waybill_dispatched_amounts_changing_disabled** | **bool** | Drivers and receivers are not allowed to change dispatched amounts for waybills from this origin | [optional] [default to False] +**feature_waybill_destination_changing_disabled_for_drivers** | **bool** | Drivers are not allowed to change the destination of waybills from this origin | [optional] [default to False] + +## Example + +```python +from openapi_client.models.external_api_origin_update_request import ExternalAPIOriginUpdateRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIOriginUpdateRequest from a JSON string +external_api_origin_update_request_instance = ExternalAPIOriginUpdateRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIOriginUpdateRequest.to_json()) + +# convert the object into a dict +external_api_origin_update_request_dict = external_api_origin_update_request_instance.to_dict() +# create an instance of ExternalAPIOriginUpdateRequest from a dict +external_api_origin_update_request_from_dict = ExternalAPIOriginUpdateRequest.from_dict(external_api_origin_update_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIPartialOrderUpdate.md b/pywaybiller/docs/ExternalAPIPartialOrderUpdate.md index d29939a..d26f26b 100644 --- a/pywaybiller/docs/ExternalAPIPartialOrderUpdate.md +++ b/pywaybiller/docs/ExternalAPIPartialOrderUpdate.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **transportation_companies** | [**List[ExternalAPIOrderTransportCompanies]**](ExternalAPIOrderTransportCompanies.md) | The transportation companies the client is using for transporting assortments from origins to destination. | [optional] @@ -17,12 +18,12 @@ json = "{}" # create an instance of ExternalAPIPartialOrderUpdate from a JSON string external_api_partial_order_update_instance = ExternalAPIPartialOrderUpdate.from_json(json) # print the JSON string representation of the object -print ExternalAPIPartialOrderUpdate.to_json() +print(ExternalAPIPartialOrderUpdate.to_json()) # convert the object into a dict external_api_partial_order_update_dict = external_api_partial_order_update_instance.to_dict() # create an instance of ExternalAPIPartialOrderUpdate from a dict -external_api_partial_order_update_form_dict = external_api_partial_order_update.from_dict(external_api_partial_order_update_dict) +external_api_partial_order_update_from_dict = ExternalAPIPartialOrderUpdate.from_dict(external_api_partial_order_update_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIPartialOrderUpdateRequest.md b/pywaybiller/docs/ExternalAPIPartialOrderUpdateRequest.md new file mode 100644 index 0000000..e3b281e --- /dev/null +++ b/pywaybiller/docs/ExternalAPIPartialOrderUpdateRequest.md @@ -0,0 +1,30 @@ +# ExternalAPIPartialOrderUpdateRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**transportation_companies** | [**List[ExternalAPIOrderTransportCompaniesRequest]**](ExternalAPIOrderTransportCompaniesRequest.md) | The transportation companies the client is using for transporting assortments from origins to destination. | [optional] +**vehicles** | [**List[ExternalAPIOrderVehiclesRequest]**](ExternalAPIOrderVehiclesRequest.md) | The vehicles that the transportation companies are allowed to use for this order. | [optional] + +## Example + +```python +from openapi_client.models.external_api_partial_order_update_request import ExternalAPIPartialOrderUpdateRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIPartialOrderUpdateRequest from a JSON string +external_api_partial_order_update_request_instance = ExternalAPIPartialOrderUpdateRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIPartialOrderUpdateRequest.to_json()) + +# convert the object into a dict +external_api_partial_order_update_request_dict = external_api_partial_order_update_request_instance.to_dict() +# create an instance of ExternalAPIPartialOrderUpdateRequest from a dict +external_api_partial_order_update_request_from_dict = ExternalAPIPartialOrderUpdateRequest.from_dict(external_api_partial_order_update_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIRawSerializer.md b/pywaybiller/docs/ExternalAPIRawSerializer.md deleted file mode 100644 index 571f5c8..0000000 --- a/pywaybiller/docs/ExternalAPIRawSerializer.md +++ /dev/null @@ -1,28 +0,0 @@ -# ExternalAPIRawSerializer - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **int** | | [optional] [readonly] - -## Example - -```python -from openapi_client.models.external_api_raw_serializer import ExternalAPIRawSerializer - -# TODO update the JSON string below -json = "{}" -# create an instance of ExternalAPIRawSerializer from a JSON string -external_api_raw_serializer_instance = ExternalAPIRawSerializer.from_json(json) -# print the JSON string representation of the object -print ExternalAPIRawSerializer.to_json() - -# convert the object into a dict -external_api_raw_serializer_dict = external_api_raw_serializer_instance.to_dict() -# create an instance of ExternalAPIRawSerializer from a dict -external_api_raw_serializer_form_dict = external_api_raw_serializer.from_dict(external_api_raw_serializer_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/pywaybiller/docs/ExternalAPITransportOrder.md b/pywaybiller/docs/ExternalAPITransportOrder.md index 4a180c0..b9dca09 100644 --- a/pywaybiller/docs/ExternalAPITransportOrder.md +++ b/pywaybiller/docs/ExternalAPITransportOrder.md @@ -2,13 +2,14 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **transport_order_id** | **str** | | **order_raw_id** | **str** | | [optional] **order_id** | **str** | | [optional] -**number** | **str** | | [optional] [readonly] -**status** | **str** | | [optional] [readonly] +**number** | **str** | | [readonly] +**status** | [**TransportOrderStatusEnum**](TransportOrderStatusEnum.md) | | [readonly] **rows** | [**List[ExternalAPITransportOrderRow]**](ExternalAPITransportOrderRow.md) | | **organizer_user_id** | **int** | | **destination_raw_id** | **str** | | [optional] @@ -17,8 +18,10 @@ Name | Type | Description | Notes **destination_address** | **str** | | [optional] **destination_latitude** | **float** | | [optional] **destination_longitude** | **float** | | [optional] +**destination_waybill_created_emails** | **List[str]** | | [optional] **destination_waybill_reached_destination_emails** | **List[str]** | | [optional] **destination_waybill_accepted_emails** | **List[str]** | | [optional] +**destination_transport_order_created_emails** | **List[str]** | | [optional] **receiver_company_name** | **str** | | [optional] **receiver_company_reg_code** | **str** | | [optional] **origin_raw_id** | **str** | | [optional] @@ -27,8 +30,10 @@ Name | Type | Description | Notes **origin_address** | **str** | | [optional] **origin_latitude** | **float** | | [optional] **origin_longitude** | **float** | | [optional] +**origin_waybill_created_emails** | **List[str]** | | [optional] **origin_waybill_reached_destination_emails** | **List[str]** | | [optional] **origin_waybill_accepted_emails** | **List[str]** | | [optional] +**origin_transport_order_created_emails** | **List[str]** | | [optional] **shipper_company_name** | **str** | | [optional] **shipper_company_reg_code** | **str** | | [optional] **transportation_company_name** | **str** | | [optional] @@ -42,9 +47,9 @@ Name | Type | Description | Notes **transport_date** | **date** | | **transport_time** | **str** | | [optional] **additional_info** | **str** | | [optional] -**waybills_ids** | **List[int]** | | [optional] [readonly] -**waybill_pdf_urls** | **str** | | [optional] [readonly] -**raw_data** | [**ExternalAPITransportOrderRawData**](ExternalAPITransportOrderRawData.md) | | [optional] +**waybills_ids** | **List[int]** | | [readonly] +**waybill_pdf_urls** | **List[str]** | | [readonly] +**raw_data** | [**ExternalAPITransportOrderRawData**](ExternalAPITransportOrderRawData.md) | The IDs of the Waybiller internal objects | [readonly] **pallets_number** | **int** | | [optional] ## Example @@ -57,12 +62,12 @@ json = "{}" # create an instance of ExternalAPITransportOrder from a JSON string external_api_transport_order_instance = ExternalAPITransportOrder.from_json(json) # print the JSON string representation of the object -print ExternalAPITransportOrder.to_json() +print(ExternalAPITransportOrder.to_json()) # convert the object into a dict external_api_transport_order_dict = external_api_transport_order_instance.to_dict() # create an instance of ExternalAPITransportOrder from a dict -external_api_transport_order_form_dict = external_api_transport_order.from_dict(external_api_transport_order_dict) +external_api_transport_order_from_dict = ExternalAPITransportOrder.from_dict(external_api_transport_order_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPITransportOrderCancel.md b/pywaybiller/docs/ExternalAPITransportOrderCancel.md index 508bb15..7db9d73 100644 --- a/pywaybiller/docs/ExternalAPITransportOrderCancel.md +++ b/pywaybiller/docs/ExternalAPITransportOrderCancel.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **cancelling_reason** | **str** | | @@ -17,12 +18,12 @@ json = "{}" # create an instance of ExternalAPITransportOrderCancel from a JSON string external_api_transport_order_cancel_instance = ExternalAPITransportOrderCancel.from_json(json) # print the JSON string representation of the object -print ExternalAPITransportOrderCancel.to_json() +print(ExternalAPITransportOrderCancel.to_json()) # convert the object into a dict external_api_transport_order_cancel_dict = external_api_transport_order_cancel_instance.to_dict() # create an instance of ExternalAPITransportOrderCancel from a dict -external_api_transport_order_cancel_form_dict = external_api_transport_order_cancel.from_dict(external_api_transport_order_cancel_dict) +external_api_transport_order_cancel_from_dict = ExternalAPITransportOrderCancel.from_dict(external_api_transport_order_cancel_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPITransportOrderCancelRequest.md b/pywaybiller/docs/ExternalAPITransportOrderCancelRequest.md new file mode 100644 index 0000000..40106cb --- /dev/null +++ b/pywaybiller/docs/ExternalAPITransportOrderCancelRequest.md @@ -0,0 +1,30 @@ +# ExternalAPITransportOrderCancelRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cancelling_reason** | **str** | | +**cancelled_by_user_id** | **int** | | + +## Example + +```python +from openapi_client.models.external_api_transport_order_cancel_request import ExternalAPITransportOrderCancelRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPITransportOrderCancelRequest from a JSON string +external_api_transport_order_cancel_request_instance = ExternalAPITransportOrderCancelRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPITransportOrderCancelRequest.to_json()) + +# convert the object into a dict +external_api_transport_order_cancel_request_dict = external_api_transport_order_cancel_request_instance.to_dict() +# create an instance of ExternalAPITransportOrderCancelRequest from a dict +external_api_transport_order_cancel_request_from_dict = ExternalAPITransportOrderCancelRequest.from_dict(external_api_transport_order_cancel_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPITransportOrderList.md b/pywaybiller/docs/ExternalAPITransportOrderList.md index e727308..0e752fb 100644 --- a/pywaybiller/docs/ExternalAPITransportOrderList.md +++ b/pywaybiller/docs/ExternalAPITransportOrderList.md @@ -2,11 +2,12 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**transport_order_id** | **str** | | [optional] [readonly] -**waybills_ids** | **List[int]** | | [optional] [readonly] -**raw_data** | [**ExternalAPITransportOrderRawDataList**](ExternalAPITransportOrderRawDataList.md) | | [optional] +**transport_order_id** | **str** | | [readonly] +**waybills_ids** | **List[int]** | | [readonly] +**raw_data** | [**ExternalAPITransportOrderRawDataList**](ExternalAPITransportOrderRawDataList.md) | The IDs of the Waybiller internal objects | [readonly] ## Example @@ -18,12 +19,12 @@ json = "{}" # create an instance of ExternalAPITransportOrderList from a JSON string external_api_transport_order_list_instance = ExternalAPITransportOrderList.from_json(json) # print the JSON string representation of the object -print ExternalAPITransportOrderList.to_json() +print(ExternalAPITransportOrderList.to_json()) # convert the object into a dict external_api_transport_order_list_dict = external_api_transport_order_list_instance.to_dict() # create an instance of ExternalAPITransportOrderList from a dict -external_api_transport_order_list_form_dict = external_api_transport_order_list.from_dict(external_api_transport_order_list_dict) +external_api_transport_order_list_from_dict = ExternalAPITransportOrderList.from_dict(external_api_transport_order_list_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPITransportOrderRawData.md b/pywaybiller/docs/ExternalAPITransportOrderRawData.md index 57101b8..4fa83e3 100644 --- a/pywaybiller/docs/ExternalAPITransportOrderRawData.md +++ b/pywaybiller/docs/ExternalAPITransportOrderRawData.md @@ -2,16 +2,17 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**transport_order_id** | **int** | | -**order_id** | **str** | | [optional] [readonly] -**rows** | [**List[ExternalAPITransportOrderRowRawData]**](ExternalAPITransportOrderRowRawData.md) | | -**destination_id** | **str** | | [optional] [readonly] -**origin_id** | **str** | | [optional] [readonly] -**organizer_user_id** | **str** | | [optional] [readonly] -**entity_code** | **str** | | [optional] [readonly] -**waybills_ids** | **List[int]** | | +**transport_order_id** | **int** | | [readonly] +**order_id** | **int** | Order which was used for creating | [readonly] +**rows** | [**List[ExternalAPITransportOrderRowRawData]**](ExternalAPITransportOrderRowRawData.md) | | [readonly] +**destination_id** | **int** | | [readonly] +**origin_id** | **int** | | [readonly] +**organizer_user_id** | **int** | | [readonly] +**entity_code** | **str** | | [readonly] +**waybills_ids** | **List[int]** | | [readonly] ## Example @@ -23,12 +24,12 @@ json = "{}" # create an instance of ExternalAPITransportOrderRawData from a JSON string external_api_transport_order_raw_data_instance = ExternalAPITransportOrderRawData.from_json(json) # print the JSON string representation of the object -print ExternalAPITransportOrderRawData.to_json() +print(ExternalAPITransportOrderRawData.to_json()) # convert the object into a dict external_api_transport_order_raw_data_dict = external_api_transport_order_raw_data_instance.to_dict() # create an instance of ExternalAPITransportOrderRawData from a dict -external_api_transport_order_raw_data_form_dict = external_api_transport_order_raw_data.from_dict(external_api_transport_order_raw_data_dict) +external_api_transport_order_raw_data_from_dict = ExternalAPITransportOrderRawData.from_dict(external_api_transport_order_raw_data_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPITransportOrderRawDataList.md b/pywaybiller/docs/ExternalAPITransportOrderRawDataList.md index 5993183..736c15f 100644 --- a/pywaybiller/docs/ExternalAPITransportOrderRawDataList.md +++ b/pywaybiller/docs/ExternalAPITransportOrderRawDataList.md @@ -2,13 +2,14 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**transport_order_id** | **int** | | -**status** | **str** | | [optional] [readonly] -**number** | **str** | | [optional] [readonly] -**entity_code** | **str** | | [optional] [readonly] -**waybills_ids** | **List[int]** | | +**transport_order_id** | **int** | | [readonly] +**status** | [**TransportOrderStatusEnum**](TransportOrderStatusEnum.md) | | [readonly] +**number** | **str** | | [readonly] +**entity_code** | **str** | | [readonly] +**waybills_ids** | **List[int]** | | [readonly] ## Example @@ -20,12 +21,12 @@ json = "{}" # create an instance of ExternalAPITransportOrderRawDataList from a JSON string external_api_transport_order_raw_data_list_instance = ExternalAPITransportOrderRawDataList.from_json(json) # print the JSON string representation of the object -print ExternalAPITransportOrderRawDataList.to_json() +print(ExternalAPITransportOrderRawDataList.to_json()) # convert the object into a dict external_api_transport_order_raw_data_list_dict = external_api_transport_order_raw_data_list_instance.to_dict() # create an instance of ExternalAPITransportOrderRawDataList from a dict -external_api_transport_order_raw_data_list_form_dict = external_api_transport_order_raw_data_list.from_dict(external_api_transport_order_raw_data_list_dict) +external_api_transport_order_raw_data_list_from_dict = ExternalAPITransportOrderRawDataList.from_dict(external_api_transport_order_raw_data_list_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPITransportOrderRequest.md b/pywaybiller/docs/ExternalAPITransportOrderRequest.md new file mode 100644 index 0000000..94d0115 --- /dev/null +++ b/pywaybiller/docs/ExternalAPITransportOrderRequest.md @@ -0,0 +1,69 @@ +# ExternalAPITransportOrderRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**transport_order_id** | **str** | | +**order_raw_id** | **str** | | [optional] +**order_id** | **str** | | [optional] +**rows** | [**List[ExternalAPITransportOrderRowRequest]**](ExternalAPITransportOrderRowRequest.md) | | +**organizer_user_id** | **int** | | +**destination_raw_id** | **str** | | [optional] +**destination_id** | **int** | | [optional] +**destination_name** | **str** | | [optional] +**destination_address** | **str** | | [optional] +**destination_latitude** | **float** | | [optional] +**destination_longitude** | **float** | | [optional] +**destination_waybill_created_emails** | **List[str]** | | [optional] +**destination_waybill_reached_destination_emails** | **List[str]** | | [optional] +**destination_waybill_accepted_emails** | **List[str]** | | [optional] +**destination_transport_order_created_emails** | **List[str]** | | [optional] +**receiver_company_name** | **str** | | [optional] +**receiver_company_reg_code** | **str** | | [optional] +**origin_raw_id** | **str** | | [optional] +**origin_id** | **int** | | [optional] +**origin_name** | **str** | | [optional] +**origin_address** | **str** | | [optional] +**origin_latitude** | **float** | | [optional] +**origin_longitude** | **float** | | [optional] +**origin_waybill_created_emails** | **List[str]** | | [optional] +**origin_waybill_reached_destination_emails** | **List[str]** | | [optional] +**origin_waybill_accepted_emails** | **List[str]** | | [optional] +**origin_transport_order_created_emails** | **List[str]** | | [optional] +**shipper_company_name** | **str** | | [optional] +**shipper_company_reg_code** | **str** | | [optional] +**transportation_company_name** | **str** | | [optional] +**transportation_company_reg_code** | **str** | | [optional] +**truck_reg_number** | **str** | | [optional] +**trailer_reg_number** | **str** | | [optional] +**driver_email** | **str** | | [optional] +**driver_personal_code** | **str** | | [optional] +**driver_name** | **str** | | [optional] +**driver_phone** | **str** | | [optional] [default to ''] +**transport_date** | **date** | | +**transport_time** | **str** | | [optional] +**additional_info** | **str** | | [optional] +**pallets_number** | **int** | | [optional] + +## Example + +```python +from openapi_client.models.external_api_transport_order_request import ExternalAPITransportOrderRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPITransportOrderRequest from a JSON string +external_api_transport_order_request_instance = ExternalAPITransportOrderRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPITransportOrderRequest.to_json()) + +# convert the object into a dict +external_api_transport_order_request_dict = external_api_transport_order_request_instance.to_dict() +# create an instance of ExternalAPITransportOrderRequest from a dict +external_api_transport_order_request_from_dict = ExternalAPITransportOrderRequest.from_dict(external_api_transport_order_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPITransportOrderRow.md b/pywaybiller/docs/ExternalAPITransportOrderRow.md index 7f372ee..217af29 100644 --- a/pywaybiller/docs/ExternalAPITransportOrderRow.md +++ b/pywaybiller/docs/ExternalAPITransportOrderRow.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **assortment_id** | **int** | | @@ -18,12 +19,12 @@ json = "{}" # create an instance of ExternalAPITransportOrderRow from a JSON string external_api_transport_order_row_instance = ExternalAPITransportOrderRow.from_json(json) # print the JSON string representation of the object -print ExternalAPITransportOrderRow.to_json() +print(ExternalAPITransportOrderRow.to_json()) # convert the object into a dict external_api_transport_order_row_dict = external_api_transport_order_row_instance.to_dict() # create an instance of ExternalAPITransportOrderRow from a dict -external_api_transport_order_row_form_dict = external_api_transport_order_row.from_dict(external_api_transport_order_row_dict) +external_api_transport_order_row_from_dict = ExternalAPITransportOrderRow.from_dict(external_api_transport_order_row_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPITransportOrderRowRawData.md b/pywaybiller/docs/ExternalAPITransportOrderRowRawData.md index 4e5dae8..8fd5475 100644 --- a/pywaybiller/docs/ExternalAPITransportOrderRowRawData.md +++ b/pywaybiller/docs/ExternalAPITransportOrderRowRawData.md @@ -2,9 +2,10 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**assortment_id** | **str** | | [optional] [readonly] +**assortment_id** | **int** | | [readonly] ## Example @@ -16,12 +17,12 @@ json = "{}" # create an instance of ExternalAPITransportOrderRowRawData from a JSON string external_api_transport_order_row_raw_data_instance = ExternalAPITransportOrderRowRawData.from_json(json) # print the JSON string representation of the object -print ExternalAPITransportOrderRowRawData.to_json() +print(ExternalAPITransportOrderRowRawData.to_json()) # convert the object into a dict external_api_transport_order_row_raw_data_dict = external_api_transport_order_row_raw_data_instance.to_dict() # create an instance of ExternalAPITransportOrderRowRawData from a dict -external_api_transport_order_row_raw_data_form_dict = external_api_transport_order_row_raw_data.from_dict(external_api_transport_order_row_raw_data_dict) +external_api_transport_order_row_raw_data_from_dict = ExternalAPITransportOrderRowRawData.from_dict(external_api_transport_order_row_raw_data_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPITransportOrderRowRequest.md b/pywaybiller/docs/ExternalAPITransportOrderRowRequest.md new file mode 100644 index 0000000..658d9d2 --- /dev/null +++ b/pywaybiller/docs/ExternalAPITransportOrderRowRequest.md @@ -0,0 +1,31 @@ +# ExternalAPITransportOrderRowRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assortment_id** | **int** | | +**assortment_name** | **str** | | [optional] +**amount** | **decimal.Decimal** | | + +## Example + +```python +from openapi_client.models.external_api_transport_order_row_request import ExternalAPITransportOrderRowRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPITransportOrderRowRequest from a JSON string +external_api_transport_order_row_request_instance = ExternalAPITransportOrderRowRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPITransportOrderRowRequest.to_json()) + +# convert the object into a dict +external_api_transport_order_row_request_dict = external_api_transport_order_row_request_instance.to_dict() +# create an instance of ExternalAPITransportOrderRowRequest from a dict +external_api_transport_order_row_request_from_dict = ExternalAPITransportOrderRowRequest.from_dict(external_api_transport_order_row_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPITransportOrderUpdate.md b/pywaybiller/docs/ExternalAPITransportOrderUpdate.md index 71cc030..e13a211 100644 --- a/pywaybiller/docs/ExternalAPITransportOrderUpdate.md +++ b/pywaybiller/docs/ExternalAPITransportOrderUpdate.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pallets_number** | **int** | | [optional] @@ -34,12 +35,12 @@ json = "{}" # create an instance of ExternalAPITransportOrderUpdate from a JSON string external_api_transport_order_update_instance = ExternalAPITransportOrderUpdate.from_json(json) # print the JSON string representation of the object -print ExternalAPITransportOrderUpdate.to_json() +print(ExternalAPITransportOrderUpdate.to_json()) # convert the object into a dict external_api_transport_order_update_dict = external_api_transport_order_update_instance.to_dict() # create an instance of ExternalAPITransportOrderUpdate from a dict -external_api_transport_order_update_form_dict = external_api_transport_order_update.from_dict(external_api_transport_order_update_dict) +external_api_transport_order_update_from_dict = ExternalAPITransportOrderUpdate.from_dict(external_api_transport_order_update_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPITransportOrderUpdateRequest.md b/pywaybiller/docs/ExternalAPITransportOrderUpdateRequest.md new file mode 100644 index 0000000..b8291b5 --- /dev/null +++ b/pywaybiller/docs/ExternalAPITransportOrderUpdateRequest.md @@ -0,0 +1,47 @@ +# ExternalAPITransportOrderUpdateRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pallets_number** | **int** | | [optional] +**origin_id** | **int** | | [optional] +**origin_raw_id** | **str** | | [optional] +**origin_name** | **str** | | [optional] +**origin_address** | **str** | | [optional] +**origin_latitude** | **float** | | [optional] +**origin_longitude** | **float** | | [optional] +**shipper_company_name** | **str** | | [optional] +**shipper_company_reg_code** | **str** | | [optional] +**destination_id** | **int** | | [optional] +**destination_raw_id** | **str** | | [optional] +**destination_name** | **str** | | [optional] +**destination_address** | **str** | | [optional] +**destination_latitude** | **float** | | [optional] +**destination_longitude** | **float** | | [optional] +**receiver_company_name** | **str** | | [optional] +**receiver_company_reg_code** | **str** | | [optional] +**truck_reg_number** | **str** | | [optional] +**trailer_reg_number** | **str** | | [optional] + +## Example + +```python +from openapi_client.models.external_api_transport_order_update_request import ExternalAPITransportOrderUpdateRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPITransportOrderUpdateRequest from a JSON string +external_api_transport_order_update_request_instance = ExternalAPITransportOrderUpdateRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPITransportOrderUpdateRequest.to_json()) + +# convert the object into a dict +external_api_transport_order_update_request_dict = external_api_transport_order_update_request_instance.to_dict() +# create an instance of ExternalAPITransportOrderUpdateRequest from a dict +external_api_transport_order_update_request_from_dict = ExternalAPITransportOrderUpdateRequest.from_dict(external_api_transport_order_update_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIVehicle.md b/pywaybiller/docs/ExternalAPIVehicle.md index cfe1975..4834b33 100644 --- a/pywaybiller/docs/ExternalAPIVehicle.md +++ b/pywaybiller/docs/ExternalAPIVehicle.md @@ -2,14 +2,15 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | | [optional] [readonly] -**reg_number** | **str** | | -**trailer_reg_number** | **str** | | -**inactive** | **bool** | Mitteaktiivseid sõidukeid ei saa kasutada | [optional] [readonly] -**company_name** | **str** | | -**company_reg_code** | **str** | | +**id** | **int** | Unique identifier for the vehicle | [readonly] +**reg_number** | **str** | Registration number of the truck | [readonly] +**trailer_reg_number** | **str** | Registration number of the attached trailer, if applicable | [readonly] +**inactive** | **bool** | Indicates if the vehicle has been deactivated | [readonly] +**company_name** | **str** | Name of the company owning the vehicle | [readonly] +**company_reg_code** | **str** | Registration code of the company owning the vehicle | [readonly] ## Example @@ -21,12 +22,12 @@ json = "{}" # create an instance of ExternalAPIVehicle from a JSON string external_api_vehicle_instance = ExternalAPIVehicle.from_json(json) # print the JSON string representation of the object -print ExternalAPIVehicle.to_json() +print(ExternalAPIVehicle.to_json()) # convert the object into a dict external_api_vehicle_dict = external_api_vehicle_instance.to_dict() # create an instance of ExternalAPIVehicle from a dict -external_api_vehicle_form_dict = external_api_vehicle.from_dict(external_api_vehicle_dict) +external_api_vehicle_from_dict = ExternalAPIVehicle.from_dict(external_api_vehicle_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIVehicleLocationData.md b/pywaybiller/docs/ExternalAPIVehicleLocationData.md index 2bca6c0..4e4ef45 100644 --- a/pywaybiller/docs/ExternalAPIVehicleLocationData.md +++ b/pywaybiller/docs/ExternalAPIVehicleLocationData.md @@ -2,17 +2,18 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**truck_reg_number** | **str** | The registration number of the vehicle. | [optional] [readonly] -**waybill_number** | **str** | The waybill number. | [optional] [readonly] -**transportation_company_name** | **str** | The name of the transportation company. | [optional] [readonly] -**receiver_company_name** | **str** | The name of the receiving company. | [optional] [readonly] -**origin_company_name** | **str** | The name of the origin company. | [optional] [readonly] -**origin_name** | **str** | | -**destination_name** | **str** | The name of the destination. | [optional] [readonly] -**raw_data** | [**ExternalAPIVehicleLocationDataRawData**](ExternalAPIVehicleLocationDataRawData.md) | | [optional] -**vehicle_location_data** | **str** | The vehicle location data. | [optional] [readonly] +**truck_reg_number** | **str** | Vehicle registration number | [readonly] +**waybill_number** | **str** | Unique waybill reference number | [readonly] +**transportation_company_name** | **str** | Name of the transport service provider | [readonly] +**receiver_company_name** | **str** | Name of the receiving company | [readonly] +**origin_company_name** | **str** | Name of the shipping company | [readonly] +**origin_name** | **str** | Name of the shipping location | [readonly] +**destination_name** | **str** | Name of the delivery destination | [readonly] +**raw_data** | [**ExternalAPIVehicleLocationDataRawData**](ExternalAPIVehicleLocationDataRawData.md) | The IDs of the Waybiller internal objects | [readonly] +**vehicle_location_data** | **List[Dict[str, ExternalAPIVehicleLocationDataVehicleLocationDataInnerValue]]** | Collection of vehicle location tracking points | [readonly] ## Example @@ -24,12 +25,12 @@ json = "{}" # create an instance of ExternalAPIVehicleLocationData from a JSON string external_api_vehicle_location_data_instance = ExternalAPIVehicleLocationData.from_json(json) # print the JSON string representation of the object -print ExternalAPIVehicleLocationData.to_json() +print(ExternalAPIVehicleLocationData.to_json()) # convert the object into a dict external_api_vehicle_location_data_dict = external_api_vehicle_location_data_instance.to_dict() # create an instance of ExternalAPIVehicleLocationData from a dict -external_api_vehicle_location_data_form_dict = external_api_vehicle_location_data.from_dict(external_api_vehicle_location_data_dict) +external_api_vehicle_location_data_from_dict = ExternalAPIVehicleLocationData.from_dict(external_api_vehicle_location_data_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIVehicleLocationDataRawData.md b/pywaybiller/docs/ExternalAPIVehicleLocationDataRawData.md index 5687926..f29678b 100644 --- a/pywaybiller/docs/ExternalAPIVehicleLocationDataRawData.md +++ b/pywaybiller/docs/ExternalAPIVehicleLocationDataRawData.md @@ -1,14 +1,14 @@ # ExternalAPIVehicleLocationDataRawData -The IDs of the Waybiller internal objects. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**waybill_id** | **int** | The ID of the waybill. | -**destination_id** | **int** | The ID of the destination. | -**origin_id** | **int** | The ID of the origin. | -**truck_id** | **int** | The ID of the truck. | +**waybill_id** | **int** | Unique identifier of the waybill | [readonly] +**destination_id** | **int** | Unique identifier of the destination | [readonly] +**origin_id** | **int** | Unique identifier of the origin | [readonly] +**truck_id** | **int** | Unique identifier of the truck | [readonly] ## Example @@ -20,12 +20,12 @@ json = "{}" # create an instance of ExternalAPIVehicleLocationDataRawData from a JSON string external_api_vehicle_location_data_raw_data_instance = ExternalAPIVehicleLocationDataRawData.from_json(json) # print the JSON string representation of the object -print ExternalAPIVehicleLocationDataRawData.to_json() +print(ExternalAPIVehicleLocationDataRawData.to_json()) # convert the object into a dict external_api_vehicle_location_data_raw_data_dict = external_api_vehicle_location_data_raw_data_instance.to_dict() # create an instance of ExternalAPIVehicleLocationDataRawData from a dict -external_api_vehicle_location_data_raw_data_form_dict = external_api_vehicle_location_data_raw_data.from_dict(external_api_vehicle_location_data_raw_data_dict) +external_api_vehicle_location_data_raw_data_from_dict = ExternalAPIVehicleLocationDataRawData.from_dict(external_api_vehicle_location_data_raw_data_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIVehicleLocationDataVehicleLocationDataInnerValue.md b/pywaybiller/docs/ExternalAPIVehicleLocationDataVehicleLocationDataInnerValue.md new file mode 100644 index 0000000..acbe277 --- /dev/null +++ b/pywaybiller/docs/ExternalAPIVehicleLocationDataVehicleLocationDataInnerValue.md @@ -0,0 +1,28 @@ +# ExternalAPIVehicleLocationDataVehicleLocationDataInnerValue + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```python +from openapi_client.models.external_api_vehicle_location_data_vehicle_location_data_inner_value import ExternalAPIVehicleLocationDataVehicleLocationDataInnerValue + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIVehicleLocationDataVehicleLocationDataInnerValue from a JSON string +external_api_vehicle_location_data_vehicle_location_data_inner_value_instance = ExternalAPIVehicleLocationDataVehicleLocationDataInnerValue.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIVehicleLocationDataVehicleLocationDataInnerValue.to_json()) + +# convert the object into a dict +external_api_vehicle_location_data_vehicle_location_data_inner_value_dict = external_api_vehicle_location_data_vehicle_location_data_inner_value_instance.to_dict() +# create an instance of ExternalAPIVehicleLocationDataVehicleLocationDataInnerValue from a dict +external_api_vehicle_location_data_vehicle_location_data_inner_value_from_dict = ExternalAPIVehicleLocationDataVehicleLocationDataInnerValue.from_dict(external_api_vehicle_location_data_vehicle_location_data_inner_value_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIWaybillAccept.md b/pywaybiller/docs/ExternalAPIWaybillAccept.md index f81c00c..4d41ba2 100644 --- a/pywaybiller/docs/ExternalAPIWaybillAccept.md +++ b/pywaybiller/docs/ExternalAPIWaybillAccept.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **updated_mileage** | **int** | Total mileage driven (in kilometres). This needs to be filled only if the mileage is updated as it overwrites the mileage entered by the driver. | [optional] @@ -18,12 +19,12 @@ json = "{}" # create an instance of ExternalAPIWaybillAccept from a JSON string external_api_waybill_accept_instance = ExternalAPIWaybillAccept.from_json(json) # print the JSON string representation of the object -print ExternalAPIWaybillAccept.to_json() +print(ExternalAPIWaybillAccept.to_json()) # convert the object into a dict external_api_waybill_accept_dict = external_api_waybill_accept_instance.to_dict() # create an instance of ExternalAPIWaybillAccept from a dict -external_api_waybill_accept_form_dict = external_api_waybill_accept.from_dict(external_api_waybill_accept_dict) +external_api_waybill_accept_from_dict = ExternalAPIWaybillAccept.from_dict(external_api_waybill_accept_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIWaybillAcceptRequest.md b/pywaybiller/docs/ExternalAPIWaybillAcceptRequest.md new file mode 100644 index 0000000..5a15825 --- /dev/null +++ b/pywaybiller/docs/ExternalAPIWaybillAcceptRequest.md @@ -0,0 +1,31 @@ +# ExternalAPIWaybillAcceptRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**updated_mileage** | **int** | Total mileage driven (in kilometres). This needs to be filled only if the mileage is updated as it overwrites the mileage entered by the driver. | [optional] +**confirmed_by_user_id** | **int** | The ID of the user that accepts the waybill (eg 28). Use GET Employments endpoint to query all available employments and get necessary `user_id` values. | +**accepted_amounts** | [**List[ExternalAPIWaybillRowAcceptedAmountRequest]**](ExternalAPIWaybillRowAcceptedAmountRequest.md) | Accepted amounts | + +## Example + +```python +from openapi_client.models.external_api_waybill_accept_request import ExternalAPIWaybillAcceptRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIWaybillAcceptRequest from a JSON string +external_api_waybill_accept_request_instance = ExternalAPIWaybillAcceptRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIWaybillAcceptRequest.to_json()) + +# convert the object into a dict +external_api_waybill_accept_request_dict = external_api_waybill_accept_request_instance.to_dict() +# create an instance of ExternalAPIWaybillAcceptRequest from a dict +external_api_waybill_accept_request_from_dict = ExternalAPIWaybillAcceptRequest.from_dict(external_api_waybill_accept_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIWaybillAcceptedAmounts.md b/pywaybiller/docs/ExternalAPIWaybillAcceptedAmounts.md index bfe161f..fb6c96d 100644 --- a/pywaybiller/docs/ExternalAPIWaybillAcceptedAmounts.md +++ b/pywaybiller/docs/ExternalAPIWaybillAcceptedAmounts.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **accepted_amounts** | [**List[ExternalAPIWaybillRowAcceptedAmount]**](ExternalAPIWaybillRowAcceptedAmount.md) | Accepted amounts | @@ -16,12 +17,12 @@ json = "{}" # create an instance of ExternalAPIWaybillAcceptedAmounts from a JSON string external_api_waybill_accepted_amounts_instance = ExternalAPIWaybillAcceptedAmounts.from_json(json) # print the JSON string representation of the object -print ExternalAPIWaybillAcceptedAmounts.to_json() +print(ExternalAPIWaybillAcceptedAmounts.to_json()) # convert the object into a dict external_api_waybill_accepted_amounts_dict = external_api_waybill_accepted_amounts_instance.to_dict() # create an instance of ExternalAPIWaybillAcceptedAmounts from a dict -external_api_waybill_accepted_amounts_form_dict = external_api_waybill_accepted_amounts.from_dict(external_api_waybill_accepted_amounts_dict) +external_api_waybill_accepted_amounts_from_dict = ExternalAPIWaybillAcceptedAmounts.from_dict(external_api_waybill_accepted_amounts_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIWaybillAcceptedAmountsRequest.md b/pywaybiller/docs/ExternalAPIWaybillAcceptedAmountsRequest.md new file mode 100644 index 0000000..8c14b5b --- /dev/null +++ b/pywaybiller/docs/ExternalAPIWaybillAcceptedAmountsRequest.md @@ -0,0 +1,29 @@ +# ExternalAPIWaybillAcceptedAmountsRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accepted_amounts** | [**List[ExternalAPIWaybillRowAcceptedAmountRequest]**](ExternalAPIWaybillRowAcceptedAmountRequest.md) | Accepted amounts | + +## Example + +```python +from openapi_client.models.external_api_waybill_accepted_amounts_request import ExternalAPIWaybillAcceptedAmountsRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIWaybillAcceptedAmountsRequest from a JSON string +external_api_waybill_accepted_amounts_request_instance = ExternalAPIWaybillAcceptedAmountsRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIWaybillAcceptedAmountsRequest.to_json()) + +# convert the object into a dict +external_api_waybill_accepted_amounts_request_dict = external_api_waybill_accepted_amounts_request_instance.to_dict() +# create an instance of ExternalAPIWaybillAcceptedAmountsRequest from a dict +external_api_waybill_accepted_amounts_request_from_dict = ExternalAPIWaybillAcceptedAmountsRequest.from_dict(external_api_waybill_accepted_amounts_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIWaybillCancel.md b/pywaybiller/docs/ExternalAPIWaybillCancel.md index 35b049c..70741da 100644 --- a/pywaybiller/docs/ExternalAPIWaybillCancel.md +++ b/pywaybiller/docs/ExternalAPIWaybillCancel.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **cancelled_by_user_id** | **int** | The ID of the user that cancels the waybill (eg 28). Use GET Employments endpoint to query all available employments and get necessary `user_id` values. | @@ -17,12 +18,12 @@ json = "{}" # create an instance of ExternalAPIWaybillCancel from a JSON string external_api_waybill_cancel_instance = ExternalAPIWaybillCancel.from_json(json) # print the JSON string representation of the object -print ExternalAPIWaybillCancel.to_json() +print(ExternalAPIWaybillCancel.to_json()) # convert the object into a dict external_api_waybill_cancel_dict = external_api_waybill_cancel_instance.to_dict() # create an instance of ExternalAPIWaybillCancel from a dict -external_api_waybill_cancel_form_dict = external_api_waybill_cancel.from_dict(external_api_waybill_cancel_dict) +external_api_waybill_cancel_from_dict = ExternalAPIWaybillCancel.from_dict(external_api_waybill_cancel_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIWaybillCancelRequest.md b/pywaybiller/docs/ExternalAPIWaybillCancelRequest.md new file mode 100644 index 0000000..3569b42 --- /dev/null +++ b/pywaybiller/docs/ExternalAPIWaybillCancelRequest.md @@ -0,0 +1,30 @@ +# ExternalAPIWaybillCancelRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cancelled_by_user_id** | **int** | The ID of the user that cancels the waybill (eg 28). Use GET Employments endpoint to query all available employments and get necessary `user_id` values. | +**reason** | **str** | Reason for cancellation. | + +## Example + +```python +from openapi_client.models.external_api_waybill_cancel_request import ExternalAPIWaybillCancelRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIWaybillCancelRequest from a JSON string +external_api_waybill_cancel_request_instance = ExternalAPIWaybillCancelRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIWaybillCancelRequest.to_json()) + +# convert the object into a dict +external_api_waybill_cancel_request_dict = external_api_waybill_cancel_request_instance.to_dict() +# create an instance of ExternalAPIWaybillCancelRequest from a dict +external_api_waybill_cancel_request_from_dict = ExternalAPIWaybillCancelRequest.from_dict(external_api_waybill_cancel_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIWaybillComment.md b/pywaybiller/docs/ExternalAPIWaybillCommentRequest.md similarity index 50% rename from pywaybiller/docs/ExternalAPIWaybillComment.md rename to pywaybiller/docs/ExternalAPIWaybillCommentRequest.md index 10cf60e..11ee60a 100644 --- a/pywaybiller/docs/ExternalAPIWaybillComment.md +++ b/pywaybiller/docs/ExternalAPIWaybillCommentRequest.md @@ -1,7 +1,8 @@ -# ExternalAPIWaybillComment +# ExternalAPIWaybillCommentRequest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **comment_by_user_id** | **int** | The ID of the user that adds the comment to the waybill. Use GET Employments endpoint to query all available employments and get necessary `user_id` values. | @@ -10,19 +11,19 @@ Name | Type | Description | Notes ## Example ```python -from openapi_client.models.external_api_waybill_comment import ExternalAPIWaybillComment +from openapi_client.models.external_api_waybill_comment_request import ExternalAPIWaybillCommentRequest # TODO update the JSON string below json = "{}" -# create an instance of ExternalAPIWaybillComment from a JSON string -external_api_waybill_comment_instance = ExternalAPIWaybillComment.from_json(json) +# create an instance of ExternalAPIWaybillCommentRequest from a JSON string +external_api_waybill_comment_request_instance = ExternalAPIWaybillCommentRequest.from_json(json) # print the JSON string representation of the object -print ExternalAPIWaybillComment.to_json() +print(ExternalAPIWaybillCommentRequest.to_json()) # convert the object into a dict -external_api_waybill_comment_dict = external_api_waybill_comment_instance.to_dict() -# create an instance of ExternalAPIWaybillComment from a dict -external_api_waybill_comment_form_dict = external_api_waybill_comment.from_dict(external_api_waybill_comment_dict) +external_api_waybill_comment_request_dict = external_api_waybill_comment_request_instance.to_dict() +# create an instance of ExternalAPIWaybillCommentRequest from a dict +external_api_waybill_comment_request_from_dict = ExternalAPIWaybillCommentRequest.from_dict(external_api_waybill_comment_request_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIWaybillCreate.md b/pywaybiller/docs/ExternalAPIWaybillCreate.md index 8204440..4ef6c01 100644 --- a/pywaybiller/docs/ExternalAPIWaybillCreate.md +++ b/pywaybiller/docs/ExternalAPIWaybillCreate.md @@ -2,12 +2,13 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **waybill_id** | **str** | The external ID of the waybill. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | -**number** | **str** | | [optional] [readonly] -**status** | **int** | | [optional] [readonly] -**status_description** | **str** | Human readable status description (`Created`, `In progress`, `At destination`, `Confirmed` or `Cancelled`). | [optional] +**number** | **str** | | [readonly] +**status** | [**WaybillStatusEnum**](WaybillStatusEnum.md) | | [readonly] +**status_description** | **str** | Human readable status description (`Created`, `In progress`, `At destination`, `Confirmed` or `Cancelled`). | [readonly] **rows** | [**List[ExternalAPIWaybillRow]**](ExternalAPIWaybillRow.md) | Waybill rows. | **destination_raw_id** | **str** | The ID of the destination. | [optional] **destination_id** | **int** | The external ID of the destination. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | [optional] @@ -15,12 +16,10 @@ Name | Type | Description | Notes **destination_address** | **str** | The address of the destination. | [optional] **destination_latitude** | **float** | The latitude of the destination. | [optional] **destination_longitude** | **float** | The longitude of the destination. | [optional] -**destination_company_name** | **str** | The name of the receiving company. Usually the owner company of the destination. | [optional] -**destination_company_reg_code** | **str** | The registry code of the receiving company. Usually the owner company of the destination. | [optional] **destination_waybill_reached_destination_emails** | **List[str]** | Comma separated list of e-mail addresses to whom send an e-mail when waybill reaches destination. | [optional] **destination_waybill_accepted_emails** | **List[str]** | Comma separated list of e-mail addresses to whom send an e-mail when waybill is accepted. | [optional] -**receiver_company_name** | **str** | The name of the receiving company. | [optional] [readonly] -**receiver_company_reg_code** | **str** | The registry code of the receiving company. | [optional] [readonly] +**receiver_company_name** | **str** | The name of the receiving company. | [readonly] +**receiver_company_reg_code** | **str** | The registry code of the receiving company. | [readonly] **origin_raw_id** | **str** | The ID of the origin. | [optional] **origin_id** | **int** | The external ID of the origin. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | [optional] **origin_name** | **str** | The name of the origin. | [optional] @@ -29,9 +28,10 @@ Name | Type | Description | Notes **origin_longitude** | **float** | The longitude of the origin. | [optional] **origin_waybill_reached_destination_emails** | **List[str]** | Comma separated list of e-mail addresses to whom send an e-mail when waybill reaches destination. | [optional] **origin_waybill_accepted_emails** | **List[str]** | Comma separated list of e-mail addresses to whom send an e-mail when waybill is accepted. | [optional] -**cadaster_number** | **str** | Cadaster number. | [optional] +**cadaster_number** | **str** | Cadaster number. Field is deprecated, please use `holding_rights` instead. | [optional] **dispatcher_name** | **str** | | [optional] **dispatcher_phone** | **str** | | [optional] +**holding_rights** | [**List[ExternalAPIWaybillHoldingRight]**](ExternalAPIWaybillHoldingRight.md) | | [optional] **shipper_company_name** | **str** | The name of the shipper company. | [optional] **shipper_company_reg_code** | **str** | The registry code of the shipper company. | [optional] **transportation_company_name** | **str** | The name of the transportation company. | @@ -42,24 +42,24 @@ Name | Type | Description | Notes **driver_name** | **str** | The name of the driver. | [optional] **driver_phone** | **str** | The phone number of the driver. | [optional] **driver_personal_code** | **str** | The personal code of the driver. | [optional] -**mileage** | **int** | The mileage can be calculated using a map or can be taken from Distance object if exist | [optional] [readonly] -**mileage_by_driver** | **int** | | [optional] [readonly] +**mileage** | **int** | The mileage can be calculated using a map or can be taken from Distance object if exist | [readonly] +**mileage_by_driver** | **int** | | [readonly] **confirmed_by_email** | **str** | The e-mail address of the user that accepted the waybill. | [optional] -**confirmed_by_name** | **str** | | [optional] [readonly] -**confirmed_by_phone** | **str** | | [optional] [readonly] +**confirmed_by_name** | **str** | | [readonly] +**confirmed_by_phone** | **str** | | [readonly] **cancelled_by_email** | **str** | The e-mail address of the user that cancelled the waybill. | [optional] -**cancelled_by_name** | **str** | | [optional] [readonly] -**cancelled_by_phone** | **str** | | [optional] [readonly] -**cancelling_reason** | **str** | | [optional] [readonly] -**dispatcher_timestamp** | **datetime** | Veoselehe loomise aeg | [optional] [readonly] -**driver_timestamp** | **datetime** | Hetk millal autojuht alustas sõitu | [optional] [readonly] -**destination_timestamp** | **datetime** | Time when waybill reached destination. | [optional] [readonly] -**confirmed_timestamp** | **datetime** | Sihtkohas kinnitamise aeg | [optional] [readonly] -**cancelled_timestamp** | **datetime** | Veoselehe tühistamise aeg | [optional] [readonly] -**pdf_url** | **str** | | [optional] [readonly] -**navision_bin_code** | **str** | Bin code. | [optional] [readonly] +**cancelled_by_name** | **str** | | [readonly] +**cancelled_by_phone** | **str** | | [readonly] +**cancelling_reason** | **str** | | [readonly] +**dispatcher_timestamp** | **datetime** | Waybill creation timestamp | [readonly] +**driver_timestamp** | **datetime** | Timestamp when driver started driving | [readonly] +**destination_timestamp** | **datetime** | Time when waybill reached destination. | [readonly] +**confirmed_timestamp** | **datetime** | Time of confirmation in the destination | [readonly] +**cancelled_timestamp** | **datetime** | Time of waybill cancelling | [readonly] +**pdf_url** | **str** | | [readonly] +**navision_bin_code** | **str** | Bin code. | [readonly] **evr_waybill_number** | **str** | EVR waybill number. | [optional] -**raw_data** | [**ExternalAPIWaybillRawData**](ExternalAPIWaybillRawData.md) | | [optional] +**raw_data** | [**ExternalAPIWaybillRawData**](ExternalAPIWaybillRawData.md) | The IDs of the Waybiller internal objects | [readonly] ## Example @@ -71,12 +71,12 @@ json = "{}" # create an instance of ExternalAPIWaybillCreate from a JSON string external_api_waybill_create_instance = ExternalAPIWaybillCreate.from_json(json) # print the JSON string representation of the object -print ExternalAPIWaybillCreate.to_json() +print(ExternalAPIWaybillCreate.to_json()) # convert the object into a dict external_api_waybill_create_dict = external_api_waybill_create_instance.to_dict() # create an instance of ExternalAPIWaybillCreate from a dict -external_api_waybill_create_form_dict = external_api_waybill_create.from_dict(external_api_waybill_create_dict) +external_api_waybill_create_from_dict = ExternalAPIWaybillCreate.from_dict(external_api_waybill_create_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIWaybillCreateRequest.md b/pywaybiller/docs/ExternalAPIWaybillCreateRequest.md new file mode 100644 index 0000000..72823b6 --- /dev/null +++ b/pywaybiller/docs/ExternalAPIWaybillCreateRequest.md @@ -0,0 +1,65 @@ +# ExternalAPIWaybillCreateRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**waybill_id** | **str** | The external ID of the waybill. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | +**rows** | [**List[ExternalAPIWaybillRowRequest]**](ExternalAPIWaybillRowRequest.md) | Waybill rows. | +**destination_raw_id** | **str** | The ID of the destination. | [optional] +**destination_id** | **int** | The external ID of the destination. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | [optional] +**destination_name** | **str** | The name of the destination. | [optional] +**destination_address** | **str** | The address of the destination. | [optional] +**destination_latitude** | **float** | The latitude of the destination. | [optional] +**destination_longitude** | **float** | The longitude of the destination. | [optional] +**destination_company_name** | **str** | The name of the receiving company. Usually the owner company of the destination. | [optional] +**destination_company_reg_code** | **str** | The registry code of the receiving company. Usually the owner company of the destination. | [optional] +**destination_waybill_reached_destination_emails** | **List[str]** | Comma separated list of e-mail addresses to whom send an e-mail when waybill reaches destination. | [optional] +**destination_waybill_accepted_emails** | **List[str]** | Comma separated list of e-mail addresses to whom send an e-mail when waybill is accepted. | [optional] +**origin_raw_id** | **str** | The ID of the origin. | [optional] +**origin_id** | **int** | The external ID of the origin. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | [optional] +**origin_name** | **str** | The name of the origin. | [optional] +**origin_address** | **str** | The address of the origin. | [optional] +**origin_latitude** | **float** | The latitude of the origin. | [optional] +**origin_longitude** | **float** | The longitude of the origin. | [optional] +**origin_waybill_reached_destination_emails** | **List[str]** | Comma separated list of e-mail addresses to whom send an e-mail when waybill reaches destination. | [optional] +**origin_waybill_accepted_emails** | **List[str]** | Comma separated list of e-mail addresses to whom send an e-mail when waybill is accepted. | [optional] +**cadaster_number** | **str** | Cadaster number. Field is deprecated, please use `holding_rights` instead. | [optional] +**dispatcher_name** | **str** | | [optional] +**dispatcher_phone** | **str** | | [optional] +**holding_rights** | [**List[ExternalAPIWaybillHoldingRightRequest]**](ExternalAPIWaybillHoldingRightRequest.md) | | [optional] +**shipper_company_name** | **str** | The name of the shipper company. | [optional] +**shipper_company_reg_code** | **str** | The registry code of the shipper company. | [optional] +**transportation_company_name** | **str** | The name of the transportation company. | +**transportation_company_reg_code** | **str** | The registry code of the transportation company. | +**truck_reg_number** | **str** | The registration number of the vehicle. | +**trailer_reg_number** | **str** | The registration number of the trailer. | [optional] +**driver_email** | **str** | The e-mail address of the driver user. | [optional] +**driver_name** | **str** | The name of the driver. | [optional] +**driver_phone** | **str** | The phone number of the driver. | [optional] +**driver_personal_code** | **str** | The personal code of the driver. | [optional] +**confirmed_by_email** | **str** | The e-mail address of the user that accepted the waybill. | [optional] +**cancelled_by_email** | **str** | The e-mail address of the user that cancelled the waybill. | [optional] +**evr_waybill_number** | **str** | EVR waybill number. | [optional] + +## Example + +```python +from openapi_client.models.external_api_waybill_create_request import ExternalAPIWaybillCreateRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIWaybillCreateRequest from a JSON string +external_api_waybill_create_request_instance = ExternalAPIWaybillCreateRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIWaybillCreateRequest.to_json()) + +# convert the object into a dict +external_api_waybill_create_request_dict = external_api_waybill_create_request_instance.to_dict() +# create an instance of ExternalAPIWaybillCreateRequest from a dict +external_api_waybill_create_request_from_dict = ExternalAPIWaybillCreateRequest.from_dict(external_api_waybill_create_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIWaybillDispatchedAmounts.md b/pywaybiller/docs/ExternalAPIWaybillDispatchedAmounts.md index bf1f26d..c231cf9 100644 --- a/pywaybiller/docs/ExternalAPIWaybillDispatchedAmounts.md +++ b/pywaybiller/docs/ExternalAPIWaybillDispatchedAmounts.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **dispatched_amounts** | [**List[ExternalAPIWaybillRowDispatchedAmount]**](ExternalAPIWaybillRowDispatchedAmount.md) | Dispatched amounts | @@ -16,12 +17,12 @@ json = "{}" # create an instance of ExternalAPIWaybillDispatchedAmounts from a JSON string external_api_waybill_dispatched_amounts_instance = ExternalAPIWaybillDispatchedAmounts.from_json(json) # print the JSON string representation of the object -print ExternalAPIWaybillDispatchedAmounts.to_json() +print(ExternalAPIWaybillDispatchedAmounts.to_json()) # convert the object into a dict external_api_waybill_dispatched_amounts_dict = external_api_waybill_dispatched_amounts_instance.to_dict() # create an instance of ExternalAPIWaybillDispatchedAmounts from a dict -external_api_waybill_dispatched_amounts_form_dict = external_api_waybill_dispatched_amounts.from_dict(external_api_waybill_dispatched_amounts_dict) +external_api_waybill_dispatched_amounts_from_dict = ExternalAPIWaybillDispatchedAmounts.from_dict(external_api_waybill_dispatched_amounts_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIWaybillDispatchedAmountsRequest.md b/pywaybiller/docs/ExternalAPIWaybillDispatchedAmountsRequest.md new file mode 100644 index 0000000..ada7208 --- /dev/null +++ b/pywaybiller/docs/ExternalAPIWaybillDispatchedAmountsRequest.md @@ -0,0 +1,29 @@ +# ExternalAPIWaybillDispatchedAmountsRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dispatched_amounts** | [**List[ExternalAPIWaybillRowDispatchedAmountRequest]**](ExternalAPIWaybillRowDispatchedAmountRequest.md) | Dispatched amounts | + +## Example + +```python +from openapi_client.models.external_api_waybill_dispatched_amounts_request import ExternalAPIWaybillDispatchedAmountsRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIWaybillDispatchedAmountsRequest from a JSON string +external_api_waybill_dispatched_amounts_request_instance = ExternalAPIWaybillDispatchedAmountsRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIWaybillDispatchedAmountsRequest.to_json()) + +# convert the object into a dict +external_api_waybill_dispatched_amounts_request_dict = external_api_waybill_dispatched_amounts_request_instance.to_dict() +# create an instance of ExternalAPIWaybillDispatchedAmountsRequest from a dict +external_api_waybill_dispatched_amounts_request_from_dict = ExternalAPIWaybillDispatchedAmountsRequest.from_dict(external_api_waybill_dispatched_amounts_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIWaybillFinishDrive.md b/pywaybiller/docs/ExternalAPIWaybillFinishDrive.md deleted file mode 100644 index fec541a..0000000 --- a/pywaybiller/docs/ExternalAPIWaybillFinishDrive.md +++ /dev/null @@ -1,28 +0,0 @@ -# ExternalAPIWaybillFinishDrive - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**kilometres** | **int** | Total mileage driven (in kilometres). | - -## Example - -```python -from openapi_client.models.external_api_waybill_finish_drive import ExternalAPIWaybillFinishDrive - -# TODO update the JSON string below -json = "{}" -# create an instance of ExternalAPIWaybillFinishDrive from a JSON string -external_api_waybill_finish_drive_instance = ExternalAPIWaybillFinishDrive.from_json(json) -# print the JSON string representation of the object -print ExternalAPIWaybillFinishDrive.to_json() - -# convert the object into a dict -external_api_waybill_finish_drive_dict = external_api_waybill_finish_drive_instance.to_dict() -# create an instance of ExternalAPIWaybillFinishDrive from a dict -external_api_waybill_finish_drive_form_dict = external_api_waybill_finish_drive.from_dict(external_api_waybill_finish_drive_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/pywaybiller/docs/ExternalAPIWaybillFinishDriveRequest.md b/pywaybiller/docs/ExternalAPIWaybillFinishDriveRequest.md new file mode 100644 index 0000000..aa401f7 --- /dev/null +++ b/pywaybiller/docs/ExternalAPIWaybillFinishDriveRequest.md @@ -0,0 +1,29 @@ +# ExternalAPIWaybillFinishDriveRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**kilometres** | **int** | Total mileage driven (in kilometres). | + +## Example + +```python +from openapi_client.models.external_api_waybill_finish_drive_request import ExternalAPIWaybillFinishDriveRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIWaybillFinishDriveRequest from a JSON string +external_api_waybill_finish_drive_request_instance = ExternalAPIWaybillFinishDriveRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIWaybillFinishDriveRequest.to_json()) + +# convert the object into a dict +external_api_waybill_finish_drive_request_dict = external_api_waybill_finish_drive_request_instance.to_dict() +# create an instance of ExternalAPIWaybillFinishDriveRequest from a dict +external_api_waybill_finish_drive_request_from_dict = ExternalAPIWaybillFinishDriveRequest.from_dict(external_api_waybill_finish_drive_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIWaybillHoldingRight.md b/pywaybiller/docs/ExternalAPIWaybillHoldingRight.md new file mode 100644 index 0000000..035a0a9 --- /dev/null +++ b/pywaybiller/docs/ExternalAPIWaybillHoldingRight.md @@ -0,0 +1,30 @@ +# ExternalAPIWaybillHoldingRight + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cadaster_number** | **str** | Cadaster number. | +**forest_notices** | **List[str]** | Origin forest notices. | [optional] + +## Example + +```python +from openapi_client.models.external_api_waybill_holding_right import ExternalAPIWaybillHoldingRight + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIWaybillHoldingRight from a JSON string +external_api_waybill_holding_right_instance = ExternalAPIWaybillHoldingRight.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIWaybillHoldingRight.to_json()) + +# convert the object into a dict +external_api_waybill_holding_right_dict = external_api_waybill_holding_right_instance.to_dict() +# create an instance of ExternalAPIWaybillHoldingRight from a dict +external_api_waybill_holding_right_from_dict = ExternalAPIWaybillHoldingRight.from_dict(external_api_waybill_holding_right_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIWaybillHoldingRightRequest.md b/pywaybiller/docs/ExternalAPIWaybillHoldingRightRequest.md new file mode 100644 index 0000000..fa2cbb1 --- /dev/null +++ b/pywaybiller/docs/ExternalAPIWaybillHoldingRightRequest.md @@ -0,0 +1,30 @@ +# ExternalAPIWaybillHoldingRightRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cadaster_number** | **str** | Cadaster number. | +**forest_notices** | **List[str]** | Origin forest notices. | [optional] + +## Example + +```python +from openapi_client.models.external_api_waybill_holding_right_request import ExternalAPIWaybillHoldingRightRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIWaybillHoldingRightRequest from a JSON string +external_api_waybill_holding_right_request_instance = ExternalAPIWaybillHoldingRightRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIWaybillHoldingRightRequest.to_json()) + +# convert the object into a dict +external_api_waybill_holding_right_request_dict = external_api_waybill_holding_right_request_instance.to_dict() +# create an instance of ExternalAPIWaybillHoldingRightRequest from a dict +external_api_waybill_holding_right_request_from_dict = ExternalAPIWaybillHoldingRightRequest.from_dict(external_api_waybill_holding_right_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIWaybillList.md b/pywaybiller/docs/ExternalAPIWaybillList.md index aeba8f4..f5eda4a 100644 --- a/pywaybiller/docs/ExternalAPIWaybillList.md +++ b/pywaybiller/docs/ExternalAPIWaybillList.md @@ -2,32 +2,35 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**waybill_id** | **str** | The external ID of the waybill. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | [optional] [readonly] -**destination_id** | **str** | The external ID of the destination. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | [optional] [readonly] -**dispatcher_timestamp** | **datetime** | Veoselehe loomise aeg | [optional] [readonly] -**driver_timestamp** | **datetime** | Hetk millal autojuht alustas sõitu | [optional] [readonly] -**destination_timestamp** | **datetime** | | [optional] [readonly] -**confirmed_timestamp** | **datetime** | Sihtkohas kinnitamise aeg | [optional] [readonly] -**cancelled_timestamp** | **datetime** | Veoselehe tühistamise aeg | [optional] [readonly] -**status** | **int** | | [optional] [readonly] -**number** | **str** | | [optional] [readonly] -**navision_bin_code** | **str** | Bin code. | [optional] [readonly] -**raw_data** | [**ExternalAPIWaybillRawDataList**](ExternalAPIWaybillRawDataList.md) | | [optional] -**shipper_company_name** | **str** | The name of the shipper company. | [optional] [readonly] -**origin_name** | **str** | | [optional] [readonly] -**origin_address** | **str** | | [optional] [readonly] -**transportation_company_name** | **str** | The name of the transportation company. | [optional] [readonly] -**truck_reg_number** | **str** | The registration number of the vehicle. | [optional] [readonly] -**trailer_reg_number** | **str** | The registration number of the trailer. | [optional] [readonly] -**receiver_company_name** | **str** | The name of the receiving company. | [optional] [readonly] -**receiver_company_reg_code** | **str** | The registry code of the receiving company. | [optional] [readonly] -**last_vehicle_location** | **object** | | [optional] [readonly] -**destination_name** | **str** | The name of the destination. | [optional] [readonly] -**destination_address** | **str** | The address of the destination. | [optional] [readonly] -**dispatched_amount** | **decimal.Decimal** | The total dispatched amount. | [optional] [readonly] -**rows** | [**List[ExternalAPIWaybillRowList]**](ExternalAPIWaybillRowList.md) | Waybill rows. | [optional] [readonly] +**waybill_id** | **str** | The external ID of the waybill. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | [readonly] +**destination_id** | **str** | The external ID of the destination. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | [readonly] +**dispatcher_timestamp** | **datetime** | Waybill creation timestamp | [readonly] +**driver_timestamp** | **datetime** | Timestamp when driver started driving | [readonly] +**destination_timestamp** | **datetime** | | [readonly] +**confirmed_timestamp** | **datetime** | Time of confirmation in the destination | [readonly] +**cancelled_timestamp** | **datetime** | Time of waybill cancelling | [readonly] +**status** | [**WaybillStatusEnum**](WaybillStatusEnum.md) | | [readonly] +**number** | **str** | | [readonly] +**navision_bin_code** | **str** | Bin code. | [readonly] +**project** | **str** | Project code in your system. | [readonly] +**raw_data** | [**ExternalAPIWaybillRawDataList**](ExternalAPIWaybillRawDataList.md) | The IDs of the Waybiller internal objects | [readonly] +**shipper_company_name** | **str** | The name of the shipper company. | [readonly] +**origin_name** | **str** | | [readonly] +**origin_address** | **str** | | [readonly] +**transportation_company_name** | **str** | The name of the transportation company. | [readonly] +**driver_name** | **str** | The name of the driver. | [readonly] +**truck_reg_number** | **str** | The registration number of the vehicle. | [readonly] +**trailer_reg_number** | **str** | The registration number of the trailer. | [readonly] +**receiver_company_name** | **str** | The name of the receiving company. | [readonly] +**receiver_company_reg_code** | **str** | The registry code of the receiving company. | [readonly] +**last_vehicle_location** | **Dict[str, object]** | | [readonly] +**destination_name** | **str** | The name of the destination. | [readonly] +**destination_address** | **str** | The address of the destination. | [readonly] +**dispatched_amount** | **decimal.Decimal** | The total dispatched amount. | [readonly] +**rows** | [**List[ExternalAPIWaybillRowList]**](ExternalAPIWaybillRowList.md) | Waybill rows. | [readonly] ## Example @@ -39,12 +42,12 @@ json = "{}" # create an instance of ExternalAPIWaybillList from a JSON string external_api_waybill_list_instance = ExternalAPIWaybillList.from_json(json) # print the JSON string representation of the object -print ExternalAPIWaybillList.to_json() +print(ExternalAPIWaybillList.to_json()) # convert the object into a dict external_api_waybill_list_dict = external_api_waybill_list_instance.to_dict() # create an instance of ExternalAPIWaybillList from a dict -external_api_waybill_list_form_dict = external_api_waybill_list.from_dict(external_api_waybill_list_dict) +external_api_waybill_list_from_dict = ExternalAPIWaybillList.from_dict(external_api_waybill_list_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIWaybillRawData.md b/pywaybiller/docs/ExternalAPIWaybillRawData.md index 288f86f..411ce1f 100644 --- a/pywaybiller/docs/ExternalAPIWaybillRawData.md +++ b/pywaybiller/docs/ExternalAPIWaybillRawData.md @@ -1,17 +1,17 @@ # ExternalAPIWaybillRawData -The IDs of the Waybiller internal objects. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**waybill_id** | **int** | The ID of the waybill. | [optional] [readonly] -**truck_id** | **int** | The ID of the truck. | [optional] [readonly] -**driver_user_id** | **int** | The ID of the driver. | [optional] [readonly] -**origin_id** | **int** | | [optional] [readonly] -**destination_id** | **int** | The ID of the destination. | [optional] [readonly] -**rows** | [**List[ExternalAPIWaybillRowRawData]**](ExternalAPIWaybillRowRawData.md) | Waybill rows. | [optional] [readonly] -**user_defined_fields** | **object** | User defined fields. | [optional] [readonly] +**waybill_id** | **int** | The ID of the waybill. | [readonly] +**truck_id** | **int** | The ID of the truck. | [readonly] +**driver_user_id** | **int** | The ID of the driver. | [readonly] +**origin_id** | **int** | The ID of the origin. | [readonly] +**destination_id** | **int** | The ID of the destination. | [readonly] +**rows** | [**List[ExternalAPIWaybillRowRawData]**](ExternalAPIWaybillRowRawData.md) | Waybill rows. | [readonly] +**user_defined_fields** | **Dict[str, object]** | User defined fields. | [readonly] ## Example @@ -23,12 +23,12 @@ json = "{}" # create an instance of ExternalAPIWaybillRawData from a JSON string external_api_waybill_raw_data_instance = ExternalAPIWaybillRawData.from_json(json) # print the JSON string representation of the object -print ExternalAPIWaybillRawData.to_json() +print(ExternalAPIWaybillRawData.to_json()) # convert the object into a dict external_api_waybill_raw_data_dict = external_api_waybill_raw_data_instance.to_dict() # create an instance of ExternalAPIWaybillRawData from a dict -external_api_waybill_raw_data_form_dict = external_api_waybill_raw_data.from_dict(external_api_waybill_raw_data_dict) +external_api_waybill_raw_data_from_dict = ExternalAPIWaybillRawData.from_dict(external_api_waybill_raw_data_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIWaybillRawDataList.md b/pywaybiller/docs/ExternalAPIWaybillRawDataList.md index b16387e..d006427 100644 --- a/pywaybiller/docs/ExternalAPIWaybillRawDataList.md +++ b/pywaybiller/docs/ExternalAPIWaybillRawDataList.md @@ -1,12 +1,12 @@ # ExternalAPIWaybillRawDataList -The IDs of the Waybiller internal objects. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**waybill_id** | **int** | The ID of the waybill. | -**destination_id** | **int** | The ID of the destination. | +**waybill_id** | **int** | The ID of the waybill. | [readonly] +**destination_id** | **int** | The ID of the destination. | [readonly] ## Example @@ -18,12 +18,12 @@ json = "{}" # create an instance of ExternalAPIWaybillRawDataList from a JSON string external_api_waybill_raw_data_list_instance = ExternalAPIWaybillRawDataList.from_json(json) # print the JSON string representation of the object -print ExternalAPIWaybillRawDataList.to_json() +print(ExternalAPIWaybillRawDataList.to_json()) # convert the object into a dict external_api_waybill_raw_data_list_dict = external_api_waybill_raw_data_list_instance.to_dict() # create an instance of ExternalAPIWaybillRawDataList from a dict -external_api_waybill_raw_data_list_form_dict = external_api_waybill_raw_data_list.from_dict(external_api_waybill_raw_data_list_dict) +external_api_waybill_raw_data_list_from_dict = ExternalAPIWaybillRawDataList.from_dict(external_api_waybill_raw_data_list_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIWaybillRefuse.md b/pywaybiller/docs/ExternalAPIWaybillRefuse.md index 8a3e2dd..b111ba0 100644 --- a/pywaybiller/docs/ExternalAPIWaybillRefuse.md +++ b/pywaybiller/docs/ExternalAPIWaybillRefuse.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **reason** | **str** | Reason for refusal. | @@ -17,12 +18,12 @@ json = "{}" # create an instance of ExternalAPIWaybillRefuse from a JSON string external_api_waybill_refuse_instance = ExternalAPIWaybillRefuse.from_json(json) # print the JSON string representation of the object -print ExternalAPIWaybillRefuse.to_json() +print(ExternalAPIWaybillRefuse.to_json()) # convert the object into a dict external_api_waybill_refuse_dict = external_api_waybill_refuse_instance.to_dict() # create an instance of ExternalAPIWaybillRefuse from a dict -external_api_waybill_refuse_form_dict = external_api_waybill_refuse.from_dict(external_api_waybill_refuse_dict) +external_api_waybill_refuse_from_dict = ExternalAPIWaybillRefuse.from_dict(external_api_waybill_refuse_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIWaybillRefuseRequest.md b/pywaybiller/docs/ExternalAPIWaybillRefuseRequest.md new file mode 100644 index 0000000..3a4e59c --- /dev/null +++ b/pywaybiller/docs/ExternalAPIWaybillRefuseRequest.md @@ -0,0 +1,30 @@ +# ExternalAPIWaybillRefuseRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reason** | **str** | Reason for refusal. | +**destination_raw_id** | **str** | The ID of the new destination. | [optional] + +## Example + +```python +from openapi_client.models.external_api_waybill_refuse_request import ExternalAPIWaybillRefuseRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIWaybillRefuseRequest from a JSON string +external_api_waybill_refuse_request_instance = ExternalAPIWaybillRefuseRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIWaybillRefuseRequest.to_json()) + +# convert the object into a dict +external_api_waybill_refuse_request_dict = external_api_waybill_refuse_request_instance.to_dict() +# create an instance of ExternalAPIWaybillRefuseRequest from a dict +external_api_waybill_refuse_request_from_dict = ExternalAPIWaybillRefuseRequest.from_dict(external_api_waybill_refuse_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIWaybillRetrieve.md b/pywaybiller/docs/ExternalAPIWaybillRetrieve.md index e61826d..4223f6b 100644 --- a/pywaybiller/docs/ExternalAPIWaybillRetrieve.md +++ b/pywaybiller/docs/ExternalAPIWaybillRetrieve.md @@ -2,64 +2,65 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**waybill_id** | **str** | The external ID of the waybill. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | [optional] [readonly] -**number** | **str** | | [optional] [readonly] -**status** | **int** | | [optional] [readonly] -**status_description** | **str** | Human readable status description (`Created`, `In progress`, `At destination`, `Confirmed` or `Cancelled`). | [optional] +**waybill_id** | **str** | The external ID of the waybill. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | [readonly] +**number** | **str** | | [readonly] +**status** | [**WaybillStatusEnum**](WaybillStatusEnum.md) | | [readonly] +**status_description** | **str** | Human readable status description (`Created`, `In progress`, `At destination`, `Confirmed` or `Cancelled`). | [readonly] **rows** | [**List[ExternalAPIWaybillRow]**](ExternalAPIWaybillRow.md) | Waybill rows. | **destination_raw_id** | **str** | The ID of the destination. | [optional] -**destination_id** | **str** | The external ID of the destination. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | [optional] [readonly] -**destination_name** | **str** | The name of the destination. | [optional] [readonly] -**destination_address** | **str** | The address of the destination. | [optional] [readonly] +**destination_id** | **str** | The external ID of the destination. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | [readonly] +**destination_name** | **str** | The name of the destination. | [readonly] +**destination_address** | **str** | The address of the destination. | [readonly] **destination_latitude** | **float** | The latitude of the destination. | [optional] **destination_longitude** | **float** | The longitude of the destination. | [optional] -**destination_company_name** | **str** | The name of the receiving company. Usually the owner company of the destination. | [optional] -**destination_company_reg_code** | **str** | The registry code of the receiving company. Usually the owner company of the destination. | [optional] -**destination_waybill_reached_destination_emails** | **List[str]** | Comma separated list of e-mail addresses to whom send an e-mail when waybill reaches destination. | [optional] [readonly] -**destination_waybill_accepted_emails** | **List[str]** | Comma separated list of e-mail addresses to whom send an e-mail when waybill is accepted. | [optional] [readonly] -**receiver_company_name** | **str** | The name of the receiving company. | [optional] [readonly] -**receiver_company_reg_code** | **str** | The registry code of the receiving company. | [optional] [readonly] +**destination_waybill_reached_destination_emails** | **List[str]** | Comma separated list of e-mail addresses to whom send an e-mail when waybill reaches destination. | [readonly] +**destination_waybill_accepted_emails** | **List[str]** | Comma separated list of e-mail addresses to whom send an e-mail when waybill is accepted. | [readonly] +**receiver_company_name** | **str** | The name of the receiving company. | [readonly] +**receiver_company_reg_code** | **str** | The registry code of the receiving company. | [readonly] **origin_raw_id** | **str** | The ID of the origin. | [optional] -**origin_id** | **str** | The external ID of the origin. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | [optional] +**origin_id** | **int** | The external ID of the origin. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | [optional] **origin_name** | **str** | The name of the origin. | [optional] **origin_address** | **str** | The address of the origin. | [optional] **origin_latitude** | **float** | The latitude of the origin. | [optional] **origin_longitude** | **float** | The longitude of the origin. | [optional] -**origin_waybill_reached_destination_emails** | **List[str]** | Comma separated list of e-mail addresses to whom send an e-mail when waybill reaches destination. | [optional] [readonly] -**origin_waybill_accepted_emails** | **List[str]** | Comma separated list of e-mail addresses to whom send an e-mail when waybill is accepted. | [optional] [readonly] -**cadaster_number** | **str** | Cadaster number. | [optional] [readonly] -**dispatcher_name** | **str** | | [optional] [readonly] -**dispatcher_phone** | **str** | | [optional] [readonly] -**shipper_company_name** | **str** | The name of the shipper company. | [optional] [readonly] -**shipper_company_reg_code** | **str** | The registry code of the shipper company. | [optional] [readonly] -**transportation_company_name** | **str** | The name of the transportation company. | [optional] [readonly] -**transportation_company_reg_code** | **str** | The registry code of the transportation company. | [optional] [readonly] +**origin_waybill_reached_destination_emails** | **List[str]** | Comma separated list of e-mail addresses to whom send an e-mail when waybill reaches destination. | [readonly] +**origin_waybill_accepted_emails** | **List[str]** | Comma separated list of e-mail addresses to whom send an e-mail when waybill is accepted. | [readonly] +**cadaster_number** | **str** | Cadaster number. | [readonly] +**dispatcher_name** | **str** | | [readonly] +**dispatcher_phone** | **str** | | [readonly] +**holding_rights** | [**List[ExternalAPIWaybillHoldingRight]**](ExternalAPIWaybillHoldingRight.md) | | [optional] +**shipper_company_name** | **str** | The name of the shipper company. | [readonly] +**shipper_company_reg_code** | **str** | The registry code of the shipper company. | [readonly] +**transportation_company_name** | **str** | The name of the transportation company. | [readonly] +**transportation_company_reg_code** | **str** | The registry code of the transportation company. | [readonly] **truck_reg_number** | **str** | The registration number of the vehicle. | **trailer_reg_number** | **str** | The registration number of the trailer. | [optional] **driver_email** | **str** | The e-mail address of the driver user. | [optional] -**driver_name** | **str** | The name of the driver. | [optional] -**driver_phone** | **str** | The phone number of the driver. | [optional] +**driver_name** | **str** | The name of the driver. | [readonly] +**driver_phone** | **str** | The phone number of the driver. | [readonly] **driver_personal_code** | **str** | The personal code of the driver. | [optional] -**mileage** | **int** | The mileage can be calculated using a map or can be taken from Distance object if exist | [optional] [readonly] -**mileage_by_driver** | **int** | | [optional] [readonly] +**mileage** | **int** | The mileage can be calculated using a map or can be taken from Distance object if exist | [readonly] +**mileage_by_driver** | **int** | | [readonly] **confirmed_by_email** | **str** | The e-mail address of the user that accepted the waybill. | [optional] -**confirmed_by_name** | **str** | | [optional] [readonly] -**confirmed_by_phone** | **str** | | [optional] [readonly] +**confirmed_by_name** | **str** | | [readonly] +**confirmed_by_phone** | **str** | | [readonly] **cancelled_by_email** | **str** | The e-mail address of the user that cancelled the waybill. | [optional] -**cancelled_by_name** | **str** | | [optional] [readonly] -**cancelled_by_phone** | **str** | | [optional] [readonly] -**cancelling_reason** | **str** | | [optional] [readonly] -**dispatcher_timestamp** | **datetime** | Veoselehe loomise aeg | [optional] [readonly] -**driver_timestamp** | **datetime** | Hetk millal autojuht alustas sõitu | [optional] [readonly] -**destination_timestamp** | **datetime** | Time when waybill reached destination. | [optional] [readonly] -**confirmed_timestamp** | **datetime** | Sihtkohas kinnitamise aeg | [optional] [readonly] -**cancelled_timestamp** | **datetime** | Veoselehe tühistamise aeg | [optional] [readonly] -**pdf_url** | **str** | | [optional] [readonly] -**navision_bin_code** | **str** | Bin code. | [optional] [readonly] -**evr_waybill_number** | **str** | EVR waybill number. | [optional] [readonly] -**raw_data** | [**ExternalAPIWaybillRawData**](ExternalAPIWaybillRawData.md) | | [optional] +**cancelled_by_name** | **str** | | [readonly] +**cancelled_by_phone** | **str** | | [readonly] +**cancelling_reason** | **str** | | [readonly] +**dispatcher_timestamp** | **datetime** | Waybill creation timestamp | [readonly] +**driver_timestamp** | **datetime** | Timestamp when driver started driving | [readonly] +**destination_timestamp** | **datetime** | Time when waybill reached destination. | [readonly] +**confirmed_timestamp** | **datetime** | Time of confirmation in the destination | [readonly] +**cancelled_timestamp** | **datetime** | Time of waybill cancelling | [readonly] +**pdf_url** | **str** | | [readonly] +**navision_bin_code** | **str** | Bin code. | [readonly] +**evr_waybill_number** | **str** | EVR waybill number. | [readonly] +**project** | **str** | Project code in your system. | [readonly] +**raw_data** | [**ExternalAPIWaybillRawData**](ExternalAPIWaybillRawData.md) | The IDs of the Waybiller internal objects | [readonly] ## Example @@ -71,12 +72,12 @@ json = "{}" # create an instance of ExternalAPIWaybillRetrieve from a JSON string external_api_waybill_retrieve_instance = ExternalAPIWaybillRetrieve.from_json(json) # print the JSON string representation of the object -print ExternalAPIWaybillRetrieve.to_json() +print(ExternalAPIWaybillRetrieve.to_json()) # convert the object into a dict external_api_waybill_retrieve_dict = external_api_waybill_retrieve_instance.to_dict() # create an instance of ExternalAPIWaybillRetrieve from a dict -external_api_waybill_retrieve_form_dict = external_api_waybill_retrieve.from_dict(external_api_waybill_retrieve_dict) +external_api_waybill_retrieve_from_dict = ExternalAPIWaybillRetrieve.from_dict(external_api_waybill_retrieve_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIWaybillRow.md b/pywaybiller/docs/ExternalAPIWaybillRow.md index 480bf7d..8540532 100644 --- a/pywaybiller/docs/ExternalAPIWaybillRow.md +++ b/pywaybiller/docs/ExternalAPIWaybillRow.md @@ -1,19 +1,20 @@ # ExternalAPIWaybillRow -Waybill rows. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **assortment_id** | **str** | The external ID of the assortment. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | [optional] -**assortment_ids** | **List[str]** | The external IDs of the assortment. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | [optional] [readonly] +**assortment_ids** | **List[str]** | The external IDs of the assortment. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | [readonly] **assortment_raw_id** | **int** | The ID of the assortment. | [optional] +**scale_assortment_raw_id** | **int** | The ID of the destination scale assortment. | [readonly] **assortment_name** | **str** | The name of the assortment. | [optional] -**dispatched_amount** | **decimal.Decimal** | Saadetud materjali kogus | [optional] -**accepted_amount** | **decimal.Decimal** | | [optional] [readonly] -**subset_type_name** | **str** | Subset type (eg fraction). | [optional] [readonly] +**dispatched_amount** | **decimal.Decimal** | Dispatched material amount | [optional] +**accepted_amount** | **decimal.Decimal** | | [readonly] +**subset_type_name** | **str** | Subset type (eg fraction). | [readonly] **subset_object_raw_id** | **int** | The ID of the subset of the assortment. | [optional] -**subset_object_name** | **str** | Subset object (eg 0-32mm). | [optional] [readonly] +**subset_object_name** | **str** | Subset object (eg 0-32mm). | [readonly] **extra_information_long** | **str** | | [optional] **extra_information_short** | **str** | | [optional] @@ -27,12 +28,12 @@ json = "{}" # create an instance of ExternalAPIWaybillRow from a JSON string external_api_waybill_row_instance = ExternalAPIWaybillRow.from_json(json) # print the JSON string representation of the object -print ExternalAPIWaybillRow.to_json() +print(ExternalAPIWaybillRow.to_json()) # convert the object into a dict external_api_waybill_row_dict = external_api_waybill_row_instance.to_dict() # create an instance of ExternalAPIWaybillRow from a dict -external_api_waybill_row_form_dict = external_api_waybill_row.from_dict(external_api_waybill_row_dict) +external_api_waybill_row_from_dict = ExternalAPIWaybillRow.from_dict(external_api_waybill_row_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIWaybillRowAcceptedAmount.md b/pywaybiller/docs/ExternalAPIWaybillRowAcceptedAmount.md index 13346fc..ba26ad2 100644 --- a/pywaybiller/docs/ExternalAPIWaybillRowAcceptedAmount.md +++ b/pywaybiller/docs/ExternalAPIWaybillRowAcceptedAmount.md @@ -1,12 +1,13 @@ # ExternalAPIWaybillRowAcceptedAmount -Accepted amounts ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**assortment_id** | **str** | The ID of the accepted assortment (eg 1). Use Querying of a single waybill endpoint to see the available assortments inside rows field using the assortment_raw_id value. | -**assortment_ids** | **List[str]** | The external IDs of the assortment. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | [optional] [readonly] +**assortment_id** | **int** | The ID of the dispatched assortment (eg 1). Use Querying of a single waybill endpoint to see the available assortments inside rows field using the assortment_raw_id value. | +**assortment_ids** | **List[str]** | The external IDs of the assortment. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | [readonly] +**accepted_assortment_id** | **int** | The ID of the accepted assortment (eg 1). Use Querying of a single waybill endpoint to see the available assortments inside rows field using the assortment_raw_id value. | [optional] **accepted_gross_weight** | **decimal.Decimal** | The accepted gross weight in tonnes. | [optional] **accepted_tare_weight** | **decimal.Decimal** | The accepted tare weight in tonnes. | [optional] **accepted_amount** | **decimal.Decimal** | The accepted amount in the unit that is attached to the assortment. | [optional] @@ -21,12 +22,12 @@ json = "{}" # create an instance of ExternalAPIWaybillRowAcceptedAmount from a JSON string external_api_waybill_row_accepted_amount_instance = ExternalAPIWaybillRowAcceptedAmount.from_json(json) # print the JSON string representation of the object -print ExternalAPIWaybillRowAcceptedAmount.to_json() +print(ExternalAPIWaybillRowAcceptedAmount.to_json()) # convert the object into a dict external_api_waybill_row_accepted_amount_dict = external_api_waybill_row_accepted_amount_instance.to_dict() # create an instance of ExternalAPIWaybillRowAcceptedAmount from a dict -external_api_waybill_row_accepted_amount_form_dict = external_api_waybill_row_accepted_amount.from_dict(external_api_waybill_row_accepted_amount_dict) +external_api_waybill_row_accepted_amount_from_dict = ExternalAPIWaybillRowAcceptedAmount.from_dict(external_api_waybill_row_accepted_amount_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIWaybillRowAcceptedAmountRequest.md b/pywaybiller/docs/ExternalAPIWaybillRowAcceptedAmountRequest.md new file mode 100644 index 0000000..adde2d1 --- /dev/null +++ b/pywaybiller/docs/ExternalAPIWaybillRowAcceptedAmountRequest.md @@ -0,0 +1,33 @@ +# ExternalAPIWaybillRowAcceptedAmountRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assortment_id** | **int** | The ID of the dispatched assortment (eg 1). Use Querying of a single waybill endpoint to see the available assortments inside rows field using the assortment_raw_id value. | +**accepted_assortment_id** | **int** | The ID of the accepted assortment (eg 1). Use Querying of a single waybill endpoint to see the available assortments inside rows field using the assortment_raw_id value. | [optional] +**accepted_gross_weight** | **decimal.Decimal** | The accepted gross weight in tonnes. | [optional] +**accepted_tare_weight** | **decimal.Decimal** | The accepted tare weight in tonnes. | [optional] +**accepted_amount** | **decimal.Decimal** | The accepted amount in the unit that is attached to the assortment. | [optional] + +## Example + +```python +from openapi_client.models.external_api_waybill_row_accepted_amount_request import ExternalAPIWaybillRowAcceptedAmountRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIWaybillRowAcceptedAmountRequest from a JSON string +external_api_waybill_row_accepted_amount_request_instance = ExternalAPIWaybillRowAcceptedAmountRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIWaybillRowAcceptedAmountRequest.to_json()) + +# convert the object into a dict +external_api_waybill_row_accepted_amount_request_dict = external_api_waybill_row_accepted_amount_request_instance.to_dict() +# create an instance of ExternalAPIWaybillRowAcceptedAmountRequest from a dict +external_api_waybill_row_accepted_amount_request_from_dict = ExternalAPIWaybillRowAcceptedAmountRequest.from_dict(external_api_waybill_row_accepted_amount_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIWaybillRowDispatchedAmount.md b/pywaybiller/docs/ExternalAPIWaybillRowDispatchedAmount.md index c5c4c6e..2ac7bd6 100644 --- a/pywaybiller/docs/ExternalAPIWaybillRowDispatchedAmount.md +++ b/pywaybiller/docs/ExternalAPIWaybillRowDispatchedAmount.md @@ -1,12 +1,12 @@ # ExternalAPIWaybillRowDispatchedAmount -Dispatched amounts ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**assortment_id** | **str** | The ID of the accepted assortment (eg 1). Use Querying of a single waybill endpoint to see the available assortments inside rows field using the assortment_raw_id value. | -**assortment_ids** | **List[str]** | The external IDs of the assortment. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | [optional] [readonly] +**assortment_id** | **int** | The ID of the dispatched assortment (eg 1). Use Querying of a single waybill endpoint to see the available assortments inside rows field using the assortment_raw_id value. | +**assortment_ids** | **List[str]** | The external IDs of the assortment. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | [readonly] **dispatched_gross_weight** | **decimal.Decimal** | The dispatched gross weight in tonnes. | [optional] **dispatched_tare_weight** | **decimal.Decimal** | The dispatched tare weight in tonnes. | [optional] **dispatched_amount** | **decimal.Decimal** | The dispatched amount in the unit that is attached to the assortment. | [optional] @@ -21,12 +21,12 @@ json = "{}" # create an instance of ExternalAPIWaybillRowDispatchedAmount from a JSON string external_api_waybill_row_dispatched_amount_instance = ExternalAPIWaybillRowDispatchedAmount.from_json(json) # print the JSON string representation of the object -print ExternalAPIWaybillRowDispatchedAmount.to_json() +print(ExternalAPIWaybillRowDispatchedAmount.to_json()) # convert the object into a dict external_api_waybill_row_dispatched_amount_dict = external_api_waybill_row_dispatched_amount_instance.to_dict() # create an instance of ExternalAPIWaybillRowDispatchedAmount from a dict -external_api_waybill_row_dispatched_amount_form_dict = external_api_waybill_row_dispatched_amount.from_dict(external_api_waybill_row_dispatched_amount_dict) +external_api_waybill_row_dispatched_amount_from_dict = ExternalAPIWaybillRowDispatchedAmount.from_dict(external_api_waybill_row_dispatched_amount_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIWaybillRowDispatchedAmountRequest.md b/pywaybiller/docs/ExternalAPIWaybillRowDispatchedAmountRequest.md new file mode 100644 index 0000000..c807c3e --- /dev/null +++ b/pywaybiller/docs/ExternalAPIWaybillRowDispatchedAmountRequest.md @@ -0,0 +1,32 @@ +# ExternalAPIWaybillRowDispatchedAmountRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assortment_id** | **int** | The ID of the dispatched assortment (eg 1). Use Querying of a single waybill endpoint to see the available assortments inside rows field using the assortment_raw_id value. | +**dispatched_gross_weight** | **decimal.Decimal** | The dispatched gross weight in tonnes. | [optional] +**dispatched_tare_weight** | **decimal.Decimal** | The dispatched tare weight in tonnes. | [optional] +**dispatched_amount** | **decimal.Decimal** | The dispatched amount in the unit that is attached to the assortment. | [optional] + +## Example + +```python +from openapi_client.models.external_api_waybill_row_dispatched_amount_request import ExternalAPIWaybillRowDispatchedAmountRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIWaybillRowDispatchedAmountRequest from a JSON string +external_api_waybill_row_dispatched_amount_request_instance = ExternalAPIWaybillRowDispatchedAmountRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIWaybillRowDispatchedAmountRequest.to_json()) + +# convert the object into a dict +external_api_waybill_row_dispatched_amount_request_dict = external_api_waybill_row_dispatched_amount_request_instance.to_dict() +# create an instance of ExternalAPIWaybillRowDispatchedAmountRequest from a dict +external_api_waybill_row_dispatched_amount_request_from_dict = ExternalAPIWaybillRowDispatchedAmountRequest.from_dict(external_api_waybill_row_dispatched_amount_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIWaybillRowList.md b/pywaybiller/docs/ExternalAPIWaybillRowList.md index b8379af..939e097 100644 --- a/pywaybiller/docs/ExternalAPIWaybillRowList.md +++ b/pywaybiller/docs/ExternalAPIWaybillRowList.md @@ -1,13 +1,18 @@ # ExternalAPIWaybillRowList -Waybill rows. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**assortment_id** | **str** | The ID of the assortment. | [optional] [readonly] -**assortment_ids** | **List[str]** | The IDs of the assortments. | [optional] [readonly] -**assortment_name** | **str** | The name of the assortment. | [optional] [readonly] +**assortment_id** | **str** | The ID of the assortment. | [readonly] +**assortment_ids** | **List[str]** | The IDs of the assortments. | [readonly] +**assortment_raw_id** | **int** | The ID of the assortment. | [optional] +**scale_assortment_raw_id** | **int** | The ID of the destination scale assortment. | [readonly] +**assortment_name** | **str** | The name of the assortment. | +**assortment_unit** | **str** | The unit of the assortment. | +**dispatched_amount** | **decimal.Decimal** | The dispatched assortment amount. | [readonly] +**accepted_amount** | **decimal.Decimal** | The accepted assortment amount. | [readonly] ## Example @@ -19,12 +24,12 @@ json = "{}" # create an instance of ExternalAPIWaybillRowList from a JSON string external_api_waybill_row_list_instance = ExternalAPIWaybillRowList.from_json(json) # print the JSON string representation of the object -print ExternalAPIWaybillRowList.to_json() +print(ExternalAPIWaybillRowList.to_json()) # convert the object into a dict external_api_waybill_row_list_dict = external_api_waybill_row_list_instance.to_dict() # create an instance of ExternalAPIWaybillRowList from a dict -external_api_waybill_row_list_form_dict = external_api_waybill_row_list.from_dict(external_api_waybill_row_list_dict) +external_api_waybill_row_list_from_dict = ExternalAPIWaybillRowList.from_dict(external_api_waybill_row_list_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIWaybillRowRawData.md b/pywaybiller/docs/ExternalAPIWaybillRowRawData.md index b765297..da412ca 100644 --- a/pywaybiller/docs/ExternalAPIWaybillRowRawData.md +++ b/pywaybiller/docs/ExternalAPIWaybillRowRawData.md @@ -1,13 +1,13 @@ # ExternalAPIWaybillRowRawData -Waybill rows. ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**assortment_id** | **int** | | [optional] [readonly] -**subset_id** | **int** | | [optional] [readonly] -**subset_type_id** | **int** | | [optional] [readonly] +**assortment_id** | **int** | | [readonly] +**subset_id** | **int** | | [readonly] +**subset_type_id** | **int** | | [readonly] ## Example @@ -19,12 +19,12 @@ json = "{}" # create an instance of ExternalAPIWaybillRowRawData from a JSON string external_api_waybill_row_raw_data_instance = ExternalAPIWaybillRowRawData.from_json(json) # print the JSON string representation of the object -print ExternalAPIWaybillRowRawData.to_json() +print(ExternalAPIWaybillRowRawData.to_json()) # convert the object into a dict external_api_waybill_row_raw_data_dict = external_api_waybill_row_raw_data_instance.to_dict() # create an instance of ExternalAPIWaybillRowRawData from a dict -external_api_waybill_row_raw_data_form_dict = external_api_waybill_row_raw_data.from_dict(external_api_waybill_row_raw_data_dict) +external_api_waybill_row_raw_data_from_dict = ExternalAPIWaybillRowRawData.from_dict(external_api_waybill_row_raw_data_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIWaybillRowRequest.md b/pywaybiller/docs/ExternalAPIWaybillRowRequest.md new file mode 100644 index 0000000..2feba89 --- /dev/null +++ b/pywaybiller/docs/ExternalAPIWaybillRowRequest.md @@ -0,0 +1,35 @@ +# ExternalAPIWaybillRowRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assortment_id** | **str** | The external ID of the assortment. Usually `null` if waybill was created in Waybiller UI and not over Waybiller External API. | [optional] +**assortment_raw_id** | **int** | The ID of the assortment. | [optional] +**assortment_name** | **str** | The name of the assortment. | [optional] +**dispatched_amount** | **decimal.Decimal** | Dispatched material amount | [optional] +**subset_object_raw_id** | **int** | The ID of the subset of the assortment. | [optional] +**extra_information_long** | **str** | | [optional] +**extra_information_short** | **str** | | [optional] + +## Example + +```python +from openapi_client.models.external_api_waybill_row_request import ExternalAPIWaybillRowRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIWaybillRowRequest from a JSON string +external_api_waybill_row_request_instance = ExternalAPIWaybillRowRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIWaybillRowRequest.to_json()) + +# convert the object into a dict +external_api_waybill_row_request_dict = external_api_waybill_row_request_instance.to_dict() +# create an instance of ExternalAPIWaybillRowRequest from a dict +external_api_waybill_row_request_from_dict = ExternalAPIWaybillRowRequest.from_dict(external_api_waybill_row_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIWaybillStartDrive.md b/pywaybiller/docs/ExternalAPIWaybillStartDrive.md index 952a3dc..834f486 100644 --- a/pywaybiller/docs/ExternalAPIWaybillStartDrive.md +++ b/pywaybiller/docs/ExternalAPIWaybillStartDrive.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **driver_user_id** | **int** | The ID of the driver user (eg 28). Use GET Employments endpoint to query all available employments and get necessary `user_id` values. | @@ -18,12 +19,12 @@ json = "{}" # create an instance of ExternalAPIWaybillStartDrive from a JSON string external_api_waybill_start_drive_instance = ExternalAPIWaybillStartDrive.from_json(json) # print the JSON string representation of the object -print ExternalAPIWaybillStartDrive.to_json() +print(ExternalAPIWaybillStartDrive.to_json()) # convert the object into a dict external_api_waybill_start_drive_dict = external_api_waybill_start_drive_instance.to_dict() # create an instance of ExternalAPIWaybillStartDrive from a dict -external_api_waybill_start_drive_form_dict = external_api_waybill_start_drive.from_dict(external_api_waybill_start_drive_dict) +external_api_waybill_start_drive_from_dict = ExternalAPIWaybillStartDrive.from_dict(external_api_waybill_start_drive_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/ExternalAPIWaybillStartDriveRequest.md b/pywaybiller/docs/ExternalAPIWaybillStartDriveRequest.md new file mode 100644 index 0000000..458a1b7 --- /dev/null +++ b/pywaybiller/docs/ExternalAPIWaybillStartDriveRequest.md @@ -0,0 +1,31 @@ +# ExternalAPIWaybillStartDriveRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**driver_user_id** | **int** | The ID of the driver user (eg 28). Use GET Employments endpoint to query all available employments and get necessary `user_id` values. | +**truck_id** | **int** | The ID of the vehicle (eg 1410). Use GET Vehicles endpoint to query all available vehicles and get necessary `id` values. | [optional] +**destination_id** | **str** | The ID of the destination (eg 330). This value is required if the Waybill is missing Destination. Use GET Destinations endpoint to query all available destinations and get necessary `id` values. | [optional] + +## Example + +```python +from openapi_client.models.external_api_waybill_start_drive_request import ExternalAPIWaybillStartDriveRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of ExternalAPIWaybillStartDriveRequest from a JSON string +external_api_waybill_start_drive_request_instance = ExternalAPIWaybillStartDriveRequest.from_json(json) +# print the JSON string representation of the object +print(ExternalAPIWaybillStartDriveRequest.to_json()) + +# convert the object into a dict +external_api_waybill_start_drive_request_dict = external_api_waybill_start_drive_request_instance.to_dict() +# create an instance of ExternalAPIWaybillStartDriveRequest from a dict +external_api_waybill_start_drive_request_from_dict = ExternalAPIWaybillStartDriveRequest.from_dict(external_api_waybill_start_drive_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/ExternalAPIWaybillVehicleLocation.md b/pywaybiller/docs/ExternalAPIWaybillVehicleLocation.md index 03c1cdd..14f060f 100644 --- a/pywaybiller/docs/ExternalAPIWaybillVehicleLocation.md +++ b/pywaybiller/docs/ExternalAPIWaybillVehicleLocation.md @@ -2,11 +2,12 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**latitude** | **float** | The latitude coordinate of the vehicle (eg 59.401034). | [optional] [readonly] -**longitude** | **float** | The longitude coordinate of the vehicle (eg 24.791717). | [optional] [readonly] -**location_timestamp** | **str** | UTC timestamp when vehicle was in that position (eg 2020-05-08T19:06:33). | [optional] [readonly] +**latitude** | **float** | The latitude coordinate of the vehicle (eg 59.401034). | [readonly] +**longitude** | **float** | The longitude coordinate of the vehicle (eg 24.791717). | [readonly] +**location_timestamp** | **str** | UTC timestamp when vehicle was in that position (eg 2020-05-08T19:06:33). | [readonly] ## Example @@ -18,12 +19,12 @@ json = "{}" # create an instance of ExternalAPIWaybillVehicleLocation from a JSON string external_api_waybill_vehicle_location_instance = ExternalAPIWaybillVehicleLocation.from_json(json) # print the JSON string representation of the object -print ExternalAPIWaybillVehicleLocation.to_json() +print(ExternalAPIWaybillVehicleLocation.to_json()) # convert the object into a dict external_api_waybill_vehicle_location_dict = external_api_waybill_vehicle_location_instance.to_dict() # create an instance of ExternalAPIWaybillVehicleLocation from a dict -external_api_waybill_vehicle_location_form_dict = external_api_waybill_vehicle_location.from_dict(external_api_waybill_vehicle_location_dict) +external_api_waybill_vehicle_location_from_dict = ExternalAPIWaybillVehicleLocation.from_dict(external_api_waybill_vehicle_location_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/GeoLocation.md b/pywaybiller/docs/GeoLocation.md index 4a14939..ca61d42 100644 --- a/pywaybiller/docs/GeoLocation.md +++ b/pywaybiller/docs/GeoLocation.md @@ -2,13 +2,14 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **int** | | [optional] [readonly] +**id** | **int** | | [readonly] **address** | **str** | | **lat** | **float** | | **lng** | **float** | | -**gmaps_link** | **str** | | [optional] [readonly] +**gmaps_link** | **str** | | [readonly] ## Example @@ -20,12 +21,12 @@ json = "{}" # create an instance of GeoLocation from a JSON string geo_location_instance = GeoLocation.from_json(json) # print the JSON string representation of the object -print GeoLocation.to_json() +print(GeoLocation.to_json()) # convert the object into a dict geo_location_dict = geo_location_instance.to_dict() # create an instance of GeoLocation from a dict -geo_location_form_dict = geo_location.from_dict(geo_location_dict) +geo_location_from_dict = GeoLocation.from_dict(geo_location_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/GeoLocationRequest.md b/pywaybiller/docs/GeoLocationRequest.md new file mode 100644 index 0000000..a4d2040 --- /dev/null +++ b/pywaybiller/docs/GeoLocationRequest.md @@ -0,0 +1,31 @@ +# GeoLocationRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**address** | **str** | | +**lat** | **float** | | +**lng** | **float** | | + +## Example + +```python +from openapi_client.models.geo_location_request import GeoLocationRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of GeoLocationRequest from a JSON string +geo_location_request_instance = GeoLocationRequest.from_json(json) +# print the JSON string representation of the object +print(GeoLocationRequest.to_json()) + +# convert the object into a dict +geo_location_request_dict = geo_location_request_instance.to_dict() +# create an instance of GeoLocationRequest from a dict +geo_location_request_from_dict = GeoLocationRequest.from_dict(geo_location_request_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/LanguageEnum.md b/pywaybiller/docs/LanguageEnum.md new file mode 100644 index 0000000..f4ddf08 --- /dev/null +++ b/pywaybiller/docs/LanguageEnum.md @@ -0,0 +1,25 @@ +# LanguageEnum + +* `` - * `et` - Eesti * `ru` - Русский * `en` - English * `us` - English (US) * `lv` - Latviski * `fi` - Suomi * `nb` - Norsk * `pl` - Polski + +## Enum + +* `ET` (value: `'et'`) + +* `RU` (value: `'ru'`) + +* `EN` (value: `'en'`) + +* `US` (value: `'us'`) + +* `LV` (value: `'lv'`) + +* `FI` (value: `'fi'`) + +* `NB` (value: `'nb'`) + +* `PL` (value: `'pl'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pywaybiller/docs/LoaderActionLogsApi.md b/pywaybiller/docs/LoaderActionLogsApi.md index 975ef20..7545e04 100644 --- a/pywaybiller/docs/LoaderActionLogsApi.md +++ b/pywaybiller/docs/LoaderActionLogsApi.md @@ -1,34 +1,33 @@ # openapi_client.LoaderActionLogsApi -All URIs are relative to *https://app.waybiller.com/external-api* +All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- -[**loader_action_logs_list**](LoaderActionLogsApi.md#loader_action_logs_list) | **GET** /loader-action-logs/ | Querying of loader action log data +[**loader_action_logs_list**](LoaderActionLogsApi.md#loader_action_logs_list) | **GET** /external-api/loader-action-logs/ | Querying loader action logs # **loader_action_logs_list** -> LoaderActionLogsList200Response loader_action_logs_list(timestamp__lte=timestamp__lte, timestamp__gte=timestamp__gte, timestamp__lt=timestamp__lt, timestamp__gt=timestamp__gt, timestamp=timestamp, timestamp__isnull=timestamp__isnull, loader_unit_id=loader_unit_id, limit=limit, offset=offset) +> PaginatedExternalAPILoaderActionLogList loader_action_logs_list(limit=limit, loader_unit_id=loader_unit_id, offset=offset, timestamp=timestamp, timestamp__gt=timestamp__gt, timestamp__gte=timestamp__gte, timestamp__isnull=timestamp__isnull, timestamp__lt=timestamp__lt, timestamp__lte=timestamp__lte) -Querying of loader action log data +Querying loader action logs -Returns all loader action logs your company created, according to the specified filters. +Returns all loader action logs created by your company according to the specified filters. ### Example -* Api Key Authentication (API key): +* Api Key Authentication (ApiKeyAuth): + ```python -import time -import os import openapi_client -from openapi_client.models.loader_action_logs_list200_response import LoaderActionLogsList200Response +from openapi_client.models.paginated_external_api_loader_action_log_list import PaginatedExternalAPILoaderActionLogList from openapi_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to https://app.waybiller.com/external-api +# Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = openapi_client.Configuration( - host = "https://app.waybiller.com/external-api" + host = "http://localhost" ) # The client must configure the authentication and authorization parameters @@ -36,29 +35,29 @@ configuration = openapi_client.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: API key -configuration.api_key['API key'] = os.environ["API_KEY"] +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['API key'] = 'Bearer' +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' # Enter a context with an instance of the API client with openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = openapi_client.LoaderActionLogsApi(api_client) - timestamp__lte = 'timestamp__lte_example' # str | Filters loader action logs for your company within specified time period (less than or equal). (optional) - timestamp__gte = 'timestamp__gte_example' # str | Filters loader action logs for your company within specified time period (greater than or equal). (optional) - timestamp__lt = 'timestamp__lt_example' # str | Filters loader action logs for your company within specified time period (less than). (optional) - timestamp__gt = 'timestamp__gt_example' # str | Filters loader action logs for your company within specified time period (greater than). (optional) - timestamp = 'timestamp_example' # str | Filters loader action logs for your company within specified time period (exact). (optional) - timestamp__isnull = 'timestamp__isnull_example' # str | Filters loader action logs for your company with timestamp null. (optional) - loader_unit_id = 56 # int | Filters loader action logs for your company with specified loader unit id. (optional) - limit = 56 # int | Number of results to return per page. (optional) - offset = 56 # int | The initial index from which to return the results. (optional) + limit = 30 # int | Maximum number of objects to return per page (optional) (default to 30) + loader_unit_id = 56 # int | Filters loader action logs for your company with the specified loader unit ID (optional) + offset = 0 # int | The initial index from which to return the results (optional) (default to 0) + timestamp = 'timestamp_example' # str | Filters loader action logs for your company within the specified time period (exact) (optional) + timestamp__gt = 'timestamp__gt_example' # str | Filters loader action logs for your company within the specified time period (greater than) (optional) + timestamp__gte = 'timestamp__gte_example' # str | Filters loader action logs for your company within the specified time period (greater than or equal) (optional) + timestamp__isnull = 'timestamp__isnull_example' # str | Filters loader action logs for your company that do not have a timestamp (optional) + timestamp__lt = 'timestamp__lt_example' # str | Filters loader action logs for your company within the specified time period (less than) (optional) + timestamp__lte = 'timestamp__lte_example' # str | Filters loader action logs for your company within the specified time period (less than or equal) (optional) try: - # Querying of loader action log data - api_response = api_instance.loader_action_logs_list(timestamp__lte=timestamp__lte, timestamp__gte=timestamp__gte, timestamp__lt=timestamp__lt, timestamp__gt=timestamp__gt, timestamp=timestamp, timestamp__isnull=timestamp__isnull, loader_unit_id=loader_unit_id, limit=limit, offset=offset) + # Querying loader action logs + api_response = api_instance.loader_action_logs_list(limit=limit, loader_unit_id=loader_unit_id, offset=offset, timestamp=timestamp, timestamp__gt=timestamp__gt, timestamp__gte=timestamp__gte, timestamp__isnull=timestamp__isnull, timestamp__lt=timestamp__lt, timestamp__lte=timestamp__lte) print("The response of LoaderActionLogsApi->loader_action_logs_list:\n") pprint(api_response) except Exception as e: @@ -69,25 +68,26 @@ with openapi_client.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **timestamp__lte** | **str**| Filters loader action logs for your company within specified time period (less than or equal). | [optional] - **timestamp__gte** | **str**| Filters loader action logs for your company within specified time period (greater than or equal). | [optional] - **timestamp__lt** | **str**| Filters loader action logs for your company within specified time period (less than). | [optional] - **timestamp__gt** | **str**| Filters loader action logs for your company within specified time period (greater than). | [optional] - **timestamp** | **str**| Filters loader action logs for your company within specified time period (exact). | [optional] - **timestamp__isnull** | **str**| Filters loader action logs for your company with timestamp null. | [optional] - **loader_unit_id** | **int**| Filters loader action logs for your company with specified loader unit id. | [optional] - **limit** | **int**| Number of results to return per page. | [optional] - **offset** | **int**| The initial index from which to return the results. | [optional] + **limit** | **int**| Maximum number of objects to return per page | [optional] [default to 30] + **loader_unit_id** | **int**| Filters loader action logs for your company with the specified loader unit ID | [optional] + **offset** | **int**| The initial index from which to return the results | [optional] [default to 0] + **timestamp** | **str**| Filters loader action logs for your company within the specified time period (exact) | [optional] + **timestamp__gt** | **str**| Filters loader action logs for your company within the specified time period (greater than) | [optional] + **timestamp__gte** | **str**| Filters loader action logs for your company within the specified time period (greater than or equal) | [optional] + **timestamp__isnull** | **str**| Filters loader action logs for your company that do not have a timestamp | [optional] + **timestamp__lt** | **str**| Filters loader action logs for your company within the specified time period (less than) | [optional] + **timestamp__lte** | **str**| Filters loader action logs for your company within the specified time period (less than or equal) | [optional] ### Return type -[**LoaderActionLogsList200Response**](LoaderActionLogsList200Response.md) +[**PaginatedExternalAPILoaderActionLogList**](PaginatedExternalAPILoaderActionLogList.md) ### Authorization -[API key](../README.md#API key) +[ApiKeyAuth](../README.md#ApiKeyAuth) ### HTTP request headers @@ -95,9 +95,11 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | +**403** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/LoaderActionLogsList200Response.md b/pywaybiller/docs/LoaderActionLogsList200Response.md deleted file mode 100644 index 2018cae..0000000 --- a/pywaybiller/docs/LoaderActionLogsList200Response.md +++ /dev/null @@ -1,31 +0,0 @@ -# LoaderActionLogsList200Response - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**count** | **int** | | -**next** | **str** | | [optional] -**previous** | **str** | | [optional] -**results** | [**List[ExternalAPILoaderActionLog]**](ExternalAPILoaderActionLog.md) | | - -## Example - -```python -from openapi_client.models.loader_action_logs_list200_response import LoaderActionLogsList200Response - -# TODO update the JSON string below -json = "{}" -# create an instance of LoaderActionLogsList200Response from a JSON string -loader_action_logs_list200_response_instance = LoaderActionLogsList200Response.from_json(json) -# print the JSON string representation of the object -print LoaderActionLogsList200Response.to_json() - -# convert the object into a dict -loader_action_logs_list200_response_dict = loader_action_logs_list200_response_instance.to_dict() -# create an instance of LoaderActionLogsList200Response from a dict -loader_action_logs_list200_response_form_dict = loader_action_logs_list200_response.from_dict(loader_action_logs_list200_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/pywaybiller/docs/OrdersApi.md b/pywaybiller/docs/OrdersApi.md index 8461307..90d4aee 100644 --- a/pywaybiller/docs/OrdersApi.md +++ b/pywaybiller/docs/OrdersApi.md @@ -1,38 +1,43 @@ # openapi_client.OrdersApi -All URIs are relative to *https://app.waybiller.com/external-api* +All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- -[**orders_create**](OrdersApi.md#orders_create) | **POST** /orders/ | Creation of an order -[**orders_list**](OrdersApi.md#orders_list) | **GET** /orders/ | Querying of orders -[**orders_read**](OrdersApi.md#orders_read) | **GET** /orders/{id}/ | Querying of a single order -[**orders_transportation**](OrdersApi.md#orders_transportation) | **PUT** /orders/{id}/transportation/ | Editing of an order transportation companies and vehicles. -[**orders_update**](OrdersApi.md#orders_update) | **PUT** /orders/{id}/ | Editing of an order +[**orders_create**](OrdersApi.md#orders_create) | **POST** /external-api/orders/ | Creation of an order +[**orders_list**](OrdersApi.md#orders_list) | **GET** /external-api/orders/ | Querying of orders +[**orders_retrieve**](OrdersApi.md#orders_retrieve) | **GET** /external-api/orders/{id}/ | Querying of a single order +[**orders_transportation_update**](OrdersApi.md#orders_transportation_update) | **PUT** /external-api/orders/{id}/transportation/ | Editing of an order transportation companies and vehicles +[**orders_update**](OrdersApi.md#orders_update) | **PUT** /external-api/orders/{id}/ | Editing of an order # **orders_create** -> ExternalAPIOrderCreate orders_create(data) +> ExternalAPIOrderCreate orders_create(external_api_order_create_request) Creation of an order -Creates a new order.

**NB!** All posted IDs are IDs in your system and these are used to match objects in your system with objects in Waybiller. It is also possible to use the Waybiller IDs (`_raw_id`) (if you have received it via GET endpoints (e.g. Destinations, Origin assortments). Exception is `client`, where the `reg_code` is used as raw id. +Creates a new order.

+ **NB!** All posted IDs are IDs in your system and these are used to match objects in your system with objects in Waybiller. + It is also possible to use the Waybiller IDs (`_raw_id`) + (if you have received it via GET endpoints (e.g. Destinations, Origin assortments). + Exception is `client`, where the `reg_code` is used as raw id. + ### Example -* Api Key Authentication (API key): +* Api Key Authentication (ApiKeyAuth): + ```python -import time -import os import openapi_client from openapi_client.models.external_api_order_create import ExternalAPIOrderCreate +from openapi_client.models.external_api_order_create_request import ExternalAPIOrderCreateRequest from openapi_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to https://app.waybiller.com/external-api +# Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = openapi_client.Configuration( - host = "https://app.waybiller.com/external-api" + host = "http://localhost" ) # The client must configure the authentication and authorization parameters @@ -40,21 +45,21 @@ configuration = openapi_client.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: API key -configuration.api_key['API key'] = os.environ["API_KEY"] +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['API key'] = 'Bearer' +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' # Enter a context with an instance of the API client with openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = openapi_client.OrdersApi(api_client) - data = openapi_client.ExternalAPIOrderCreate() # ExternalAPIOrderCreate | + external_api_order_create_request = openapi_client.ExternalAPIOrderCreateRequest() # ExternalAPIOrderCreateRequest | try: # Creation of an order - api_response = api_instance.orders_create(data) + api_response = api_instance.orders_create(external_api_order_create_request) print("The response of OrdersApi->orders_create:\n") pprint(api_response) except Exception as e: @@ -65,9 +70,10 @@ with openapi_client.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **data** | [**ExternalAPIOrderCreate**](ExternalAPIOrderCreate.md)| | + **external_api_order_create_request** | [**ExternalAPIOrderCreateRequest**](ExternalAPIOrderCreateRequest.md)| | ### Return type @@ -75,7 +81,7 @@ Name | Type | Description | Notes ### Authorization -[API key](../README.md#API key) +[ApiKeyAuth](../README.md#ApiKeyAuth) ### HTTP request headers @@ -83,14 +89,16 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | | - | +**403** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **orders_list** -> OrdersList200Response orders_list(limit=limit, offset=offset) +> PaginatedExternalAPIOrderListList orders_list(limit=limit, offset=offset) Querying of orders @@ -98,19 +106,18 @@ Returns all orders associated with your company. ### Example -* Api Key Authentication (API key): +* Api Key Authentication (ApiKeyAuth): + ```python -import time -import os import openapi_client -from openapi_client.models.orders_list200_response import OrdersList200Response +from openapi_client.models.paginated_external_api_order_list_list import PaginatedExternalAPIOrderListList from openapi_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to https://app.waybiller.com/external-api +# Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = openapi_client.Configuration( - host = "https://app.waybiller.com/external-api" + host = "http://localhost" ) # The client must configure the authentication and authorization parameters @@ -118,18 +125,18 @@ configuration = openapi_client.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: API key -configuration.api_key['API key'] = os.environ["API_KEY"] +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['API key'] = 'Bearer' +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' # Enter a context with an instance of the API client with openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = openapi_client.OrdersApi(api_client) - limit = 56 # int | Number of results to return per page. (optional) - offset = 56 # int | The initial index from which to return the results. (optional) + limit = 30 # int | Maximum number of objects to return per page (optional) (default to 30) + offset = 0 # int | The initial index from which to return the results (optional) (default to 0) try: # Querying of orders @@ -144,18 +151,19 @@ with openapi_client.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **limit** | **int**| Number of results to return per page. | [optional] - **offset** | **int**| The initial index from which to return the results. | [optional] + **limit** | **int**| Maximum number of objects to return per page | [optional] [default to 30] + **offset** | **int**| The initial index from which to return the results | [optional] [default to 0] ### Return type -[**OrdersList200Response**](OrdersList200Response.md) +[**PaginatedExternalAPIOrderListList**](PaginatedExternalAPIOrderListList.md) ### Authorization -[API key](../README.md#API key) +[ApiKeyAuth](../README.md#ApiKeyAuth) ### HTTP request headers @@ -163,14 +171,16 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | +**403** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **orders_read** -> ExternalAPIOrder orders_read(id) +# **orders_retrieve** +> ExternalAPIOrder orders_retrieve(id) Querying of a single order @@ -178,19 +188,18 @@ Returns an order with the specified ID. Only companies associated with the order ### Example -* Api Key Authentication (API key): +* Api Key Authentication (ApiKeyAuth): + ```python -import time -import os import openapi_client from openapi_client.models.external_api_order import ExternalAPIOrder from openapi_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to https://app.waybiller.com/external-api +# Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = openapi_client.Configuration( - host = "https://app.waybiller.com/external-api" + host = "http://localhost" ) # The client must configure the authentication and authorization parameters @@ -198,11 +207,11 @@ configuration = openapi_client.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: API key -configuration.api_key['API key'] = os.environ["API_KEY"] +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['API key'] = 'Bearer' +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' # Enter a context with an instance of the API client with openapi_client.ApiClient(configuration) as api_client: @@ -212,17 +221,18 @@ with openapi_client.ApiClient(configuration) as api_client: try: # Querying of a single order - api_response = api_instance.orders_read(id) - print("The response of OrdersApi->orders_read:\n") + api_response = api_instance.orders_retrieve(id) + print("The response of OrdersApi->orders_retrieve:\n") pprint(api_response) except Exception as e: - print("Exception when calling OrdersApi->orders_read: %s\n" % e) + print("Exception when calling OrdersApi->orders_retrieve: %s\n" % e) ``` ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **str**| The ID of the order queried. | @@ -233,7 +243,7 @@ Name | Type | Description | Notes ### Authorization -[API key](../README.md#API key) +[ApiKeyAuth](../README.md#ApiKeyAuth) ### HTTP request headers @@ -241,34 +251,37 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | +**403** | | - | +**404** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **orders_transportation** -> ExternalAPIPartialOrderUpdate orders_transportation(id, data) +# **orders_transportation_update** +> ExternalAPIPartialOrderUpdate orders_transportation_update(id, external_api_partial_order_update_request=external_api_partial_order_update_request) -Editing of an order transportation companies and vehicles. +Editing of an order transportation companies and vehicles Edits order transportation companies and vehicles data. It is allowed to be used by order's client company ### Example -* Api Key Authentication (API key): +* Api Key Authentication (ApiKeyAuth): + ```python -import time -import os import openapi_client from openapi_client.models.external_api_partial_order_update import ExternalAPIPartialOrderUpdate +from openapi_client.models.external_api_partial_order_update_request import ExternalAPIPartialOrderUpdateRequest from openapi_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to https://app.waybiller.com/external-api +# Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = openapi_client.Configuration( - host = "https://app.waybiller.com/external-api" + host = "http://localhost" ) # The client must configure the authentication and authorization parameters @@ -276,36 +289,37 @@ configuration = openapi_client.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: API key -configuration.api_key['API key'] = os.environ["API_KEY"] +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['API key'] = 'Bearer' +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' # Enter a context with an instance of the API client with openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = openapi_client.OrdersApi(api_client) - id = 'id_example' # str | - data = openapi_client.ExternalAPIPartialOrderUpdate() # ExternalAPIPartialOrderUpdate | + id = 56 # int | A unique integer value identifying this Order. + external_api_partial_order_update_request = openapi_client.ExternalAPIPartialOrderUpdateRequest() # ExternalAPIPartialOrderUpdateRequest | (optional) try: - # Editing of an order transportation companies and vehicles. - api_response = api_instance.orders_transportation(id, data) - print("The response of OrdersApi->orders_transportation:\n") + # Editing of an order transportation companies and vehicles + api_response = api_instance.orders_transportation_update(id, external_api_partial_order_update_request=external_api_partial_order_update_request) + print("The response of OrdersApi->orders_transportation_update:\n") pprint(api_response) except Exception as e: - print("Exception when calling OrdersApi->orders_transportation: %s\n" % e) + print("Exception when calling OrdersApi->orders_transportation_update: %s\n" % e) ``` ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **data** | [**ExternalAPIPartialOrderUpdate**](ExternalAPIPartialOrderUpdate.md)| | + **id** | **int**| A unique integer value identifying this Order. | + **external_api_partial_order_update_request** | [**ExternalAPIPartialOrderUpdateRequest**](ExternalAPIPartialOrderUpdateRequest.md)| | [optional] ### Return type @@ -313,7 +327,7 @@ Name | Type | Description | Notes ### Authorization -[API key](../README.md#API key) +[ApiKeyAuth](../README.md#ApiKeyAuth) ### HTTP request headers @@ -321,14 +335,16 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | +**403** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **orders_update** -> ExternalAPIOrderUpdate orders_update(id, data) +> ExternalAPIOrderUpdate orders_update(id, external_api_order_update_request=external_api_order_update_request) Editing of an order @@ -336,19 +352,19 @@ Edits order. It is allowed to be used by order's owner company ### Example -* Api Key Authentication (API key): +* Api Key Authentication (ApiKeyAuth): + ```python -import time -import os import openapi_client from openapi_client.models.external_api_order_update import ExternalAPIOrderUpdate +from openapi_client.models.external_api_order_update_request import ExternalAPIOrderUpdateRequest from openapi_client.rest import ApiException from pprint import pprint -# Defining the host is optional and defaults to https://app.waybiller.com/external-api +# Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. configuration = openapi_client.Configuration( - host = "https://app.waybiller.com/external-api" + host = "http://localhost" ) # The client must configure the authentication and authorization parameters @@ -356,22 +372,22 @@ configuration = openapi_client.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: API key -configuration.api_key['API key'] = os.environ["API_KEY"] +# Configure API key authorization: ApiKeyAuth +configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"] # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['API key'] = 'Bearer' +# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer' # Enter a context with an instance of the API client with openapi_client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = openapi_client.OrdersApi(api_client) - id = 'id_example' # str | - data = openapi_client.ExternalAPIOrderUpdate() # ExternalAPIOrderUpdate | + id = 56 # int | A unique integer value identifying this Order. + external_api_order_update_request = openapi_client.ExternalAPIOrderUpdateRequest() # ExternalAPIOrderUpdateRequest | (optional) try: # Editing of an order - api_response = api_instance.orders_update(id, data) + api_response = api_instance.orders_update(id, external_api_order_update_request=external_api_order_update_request) print("The response of OrdersApi->orders_update:\n") pprint(api_response) except Exception as e: @@ -382,10 +398,11 @@ with openapi_client.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **data** | [**ExternalAPIOrderUpdate**](ExternalAPIOrderUpdate.md)| | + **id** | **int**| A unique integer value identifying this Order. | + **external_api_order_update_request** | [**ExternalAPIOrderUpdateRequest**](ExternalAPIOrderUpdateRequest.md)| | [optional] ### Return type @@ -393,7 +410,7 @@ Name | Type | Description | Notes ### Authorization -[API key](../README.md#API key) +[ApiKeyAuth](../README.md#ApiKeyAuth) ### HTTP request headers @@ -401,9 +418,11 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | | - | +**403** | | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) diff --git a/pywaybiller/docs/OrdersList200Response.md b/pywaybiller/docs/OrdersList200Response.md deleted file mode 100644 index 7f04f8e..0000000 --- a/pywaybiller/docs/OrdersList200Response.md +++ /dev/null @@ -1,31 +0,0 @@ -# OrdersList200Response - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**count** | **int** | | -**next** | **str** | | [optional] -**previous** | **str** | | [optional] -**results** | [**List[ExternalAPIOrderList]**](ExternalAPIOrderList.md) | | - -## Example - -```python -from openapi_client.models.orders_list200_response import OrdersList200Response - -# TODO update the JSON string below -json = "{}" -# create an instance of OrdersList200Response from a JSON string -orders_list200_response_instance = OrdersList200Response.from_json(json) -# print the JSON string representation of the object -print OrdersList200Response.to_json() - -# convert the object into a dict -orders_list200_response_dict = orders_list200_response_instance.to_dict() -# create an instance of OrdersList200Response from a dict -orders_list200_response_form_dict = orders_list200_response.from_dict(orders_list200_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/pywaybiller/docs/OriginAssortmentsApi.md b/pywaybiller/docs/OriginAssortmentsApi.md index 76f4986..950b125 100644 --- a/pywaybiller/docs/OriginAssortmentsApi.md +++ b/pywaybiller/docs/OriginAssortmentsApi.md @@ -1,35 +1,40 @@ # openapi_client.OriginAssortmentsApi -All URIs are relative to *https://app.waybiller.com/external-api* +All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- -[**origin_assortments_list**](OriginAssortmentsApi.md#origin_assortments_list) | **GET** /origin-assortments/ | Querying of origin assortments -[**origin_assortments_read**](OriginAssortmentsApi.md#origin_assortments_read) | **GET** /origin-assortments/{id}/ | Querying of a single origin assortment +[**origin_assortments_list**](OriginAssortmentsApi.md#origin_assortments_list) | **GET** /external-api/origin-assortments/ | Querying origin assortments +[**origin_assortments_retrieve**](OriginAssortmentsApi.md#origin_assortments_retrieve) | **GET** /external-api/origin-assortments/{id}/ | Querying a single origin assortment # **origin_assortments_list** -> OriginAssortmentsList200Response origin_assortments_list(origin__id__lte=origin__id__lte, origin__id__gte=origin__id__gte, origin__id__lt=origin__id__lt, origin__id__gt=origin__id__gt, origin__id=origin__id, origin__id__in=origin__id__in, origin__name=origin__name, origin__name__iexact=origin__name__iexact, origin__name__contains=origin__name__contains, origin__name__icontains=origin__name__icontains, assortment__name=assortment__name, assortment__name__iexact=assortment__name__iexact, assortment__name__contains=assortment__name__contains, assortment__name__icontains=assortment__name__icontains, subset_type__name=subset_type__name, subset_type__name__iexact=subset_type__name__iexact, subset_type__name__contains=subset_type__name__contains, subset_type__name__icontains=subset_type__name__icontains, subset__value=subset__value, subset__value__iexact=subset__value__iexact, subset__value__contains=subset__value__contains, subset__value__icontains=subset__value__icontains, limit=limit, offset=offset) +> PaginatedExternalAPIOriginAssortmentList origin_assortments_list(assortment__name=assortment__name, assortment__name__contains=assortment__name__contains, assortment__name__icontains=assortment__name__icontains, assortment__name__iexact=assortment__name__iexact, limit=limit, offset=offset, origin__id=origin__id, origin__id__gt=origin__id__gt, origin__id__gte=origin__id__gte, origin__id__in=origin__id__in, origin__id__lt=origin__id__lt, origin__id__lte=origin__id__lte, origin__name=origin__name, origin__name__contains=origin__name__contains, origin__name__icontains=origin__name__icontains, origin__name__iexact=origin__name__iexact, subset__subset_type__name=subset__subset_type__name, subset__subset_type__name__contains=subset__subset_type__name__contains, subset__subset_type__name__icontains=subset__subset_type__name__icontains, subset__subset_type__name__iexact=subset__subset_type__name__iexact, subset__value=subset__value, subset__value__contains=subset__value__contains, subset__value__icontains=subset__value__icontains, subset__value__iexact=subset__value__iexact) -Querying of origin assortments +Querying origin assortments + +Returns all origin assortments associated with your company based on specified filters. + +Available assortments include: +- Your company's origin assortments +- Your partner companies' origin assortments +- Public origin assortments -Returns all origin assortments (according to specified filters) that are associated with your company: