yellowgrid-api-ts 3.2.72-dev.0 → 3.2.74-dev.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +257 -235
- package/.openapi-generator/VERSION +1 -1
- package/.openapi-generator-ignore +0 -0
- package/README.md +37 -1
- package/api.ts +6620 -331
- package/base.ts +26 -2
- package/common.ts +39 -16
- package/config.json +0 -0
- package/configuration.ts +19 -25
- package/dist/api.d.ts +5639 -45
- package/dist/api.js +1848 -222
- package/dist/base.d.ts +25 -1
- package/dist/base.js +21 -2
- package/dist/common.d.ts +36 -5
- package/dist/common.js +39 -17
- package/dist/configuration.d.ts +18 -25
- package/dist/configuration.js +2 -2
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/CourierEnum.d.ts +18 -0
- package/dist/models/CourierEnum.js +20 -0
- package/dist/models/EventStatusEnum.d.ts +0 -0
- package/dist/models/EventStatusEnum.js +0 -0
- package/dist/models/EventTypeEnum.d.ts +0 -0
- package/dist/models/EventTypeEnum.js +0 -0
- package/dist/models/PortStatusEnum.d.ts +0 -0
- package/dist/models/PortStatusEnum.js +0 -0
- package/dist/models/PrinterEnum.d.ts +18 -0
- package/dist/models/PrinterEnum.js +20 -0
- package/dist/models/ServiceEnum.d.ts +0 -0
- package/dist/models/ServiceEnum.js +0 -0
- package/dist/models/ServiceHealthEnum.d.ts +0 -0
- package/dist/models/ServiceHealthEnum.js +0 -0
- package/dist/models/ServiceStatusEnum.d.ts +0 -0
- package/dist/models/ServiceStatusEnum.js +0 -0
- package/dist/models/UpdateTypeEnum.d.ts +0 -0
- package/dist/models/UpdateTypeEnum.js +0 -0
- package/docs/AbstractOrderRequestDTO.md +0 -0
- package/docs/AccountContactEntity.md +0 -0
- package/docs/AccountContactModel.md +0 -0
- package/docs/AccountContactRequestModel.md +0 -0
- package/docs/AccountDetailedSummaryDTO.md +0 -0
- package/docs/AccountRequestModel.md +0 -0
- package/docs/AccountSummaryDTO.md +0 -0
- package/docs/AccountsApi.md +1 -1
- package/docs/AccountsResponseModel.md +0 -0
- package/docs/AddressModel.md +0 -0
- package/docs/AddressRequestModel.md +0 -0
- package/docs/AdminNumberPortDTO.md +0 -2
- package/docs/AdminOrderRequestDTO.md +0 -0
- package/docs/AdminUserModel.md +0 -0
- package/docs/AgentHoursGraphModel.md +0 -0
- package/docs/AgentHoursGraphMonthModel.md +0 -0
- package/docs/ApiLogEntity.md +0 -0
- package/docs/AreaCodeModel.md +0 -0
- package/docs/AttachmentModel.md +0 -0
- package/docs/AttributeSetEnum.md +0 -0
- package/docs/AuditLogEntity.md +0 -0
- package/docs/AuthCodeResponseModel.md +0 -0
- package/docs/BasicItemDTO.md +0 -0
- package/docs/BasicProductDTO.md +0 -0
- package/docs/BatchDTO.md +59 -0
- package/docs/BatchEntity.md +0 -0
- package/docs/CRMApi.md +1 -1
- package/docs/CallBarringModel.md +0 -0
- package/docs/Class3CXApi.md +1 -1
- package/docs/Class3CXInstallationWizardApi.md +1 -1
- package/docs/Class3CXInstallationsApi.md +1 -1
- package/docs/Class3CXIntegrationsApi.md +1 -1
- package/docs/Class3CXMultiTenantApi.md +1 -1
- package/docs/ClientDetailsModel.md +0 -0
- package/docs/ClientModel.md +0 -0
- package/docs/CompanyContractModel.md +0 -0
- package/docs/ContactInfoModel.md +0 -0
- package/docs/ConversationModel.md +0 -0
- package/docs/CourierPriceEntity.md +0 -0
- package/docs/CreditAccountEntity.md +0 -0
- package/docs/CreditNoteDTO.md +21 -0
- package/docs/CreditNoteEntity.md +29 -0
- package/docs/CreditNoteItemDTO.md +25 -0
- package/docs/CreditNoteItemEntity.md +29 -0
- package/docs/CreditNoteModel.md +29 -0
- package/docs/CrmContactDTO.md +0 -0
- package/docs/CustomerInformationModel.md +0 -0
- package/docs/CustomerItemRequestDTO.md +0 -0
- package/docs/CustomerOrderRequestDTO.md +0 -0
- package/docs/CustomerPriceListEnum.md +0 -0
- package/docs/CustomerSummaryReportDTO.md +0 -0
- package/docs/DdiRangeRequestModel.md +0 -0
- package/docs/DdiRangesRequestModel.md +0 -0
- package/docs/DetailedItemRequestDTO.md +0 -0
- package/docs/DetailedOrderRequestDTO.md +0 -0
- package/docs/DivertRequestModel.md +0 -0
- package/docs/DivertResponseModel.md +0 -0
- package/docs/EdTechProClientEntity.md +0 -0
- package/docs/EdTechProSchoolModel.md +0 -0
- package/docs/EdTechProSchoolsModel.md +0 -0
- package/docs/EdTechProSetupModel.md +0 -0
- package/docs/EventDTO.md +0 -0
- package/docs/EventRequestDTO.md +0 -0
- package/docs/EventSubscriptionModel.md +0 -0
- package/docs/EventUpdateDTO.md +0 -0
- package/docs/EventUpdateEntity.md +0 -0
- package/docs/EventUpdateRequestDTO.md +0 -0
- package/docs/FraudManagementModel.md +0 -0
- package/docs/FreshdeskCompanyTicketsModel.md +0 -0
- package/docs/FreshdeskTicketEntity.md +0 -0
- package/docs/FtpAccountsEntity.md +0 -0
- package/docs/GenericFileModel.md +0 -0
- package/docs/GetGetPrice200Response.md +0 -0
- package/docs/GetGetRecording200Response.md +0 -0
- package/docs/HostingChangeResponseModel.md +0 -0
- package/docs/HostingRegionDTO.md +0 -0
- package/docs/InstanceAutoFailoverEntity.md +0 -0
- package/docs/InstanceDeletionScheduleEntity.md +0 -0
- package/docs/InstanceEntity.md +0 -0
- package/docs/InstanceFailoverEntity.md +0 -0
- package/docs/InstanceMonitoringEntity.md +0 -0
- package/docs/InstanceMonitoringLogEntity.md +0 -0
- package/docs/InstanceScheduledTasksEntity.md +0 -0
- package/docs/InstanceTcxDetailsEntity.md +0 -0
- package/docs/InstanceUserCredentialsEntity.md +0 -0
- package/docs/ItemDTO.md +0 -0
- package/docs/ItemDiscountEntity.md +0 -0
- package/docs/ItemEntity.md +0 -0
- package/docs/LinkedOrderEntity.md +0 -0
- package/docs/MFARequiredModel.md +0 -0
- package/docs/MonthlyUsageModel.md +0 -0
- package/docs/MultiTenantChangeResponseModel.md +0 -0
- package/docs/MyPBXToolsApi.md +1 -1
- package/docs/NavigationModel.md +0 -0
- package/docs/NumberPortDTO.md +0 -0
- package/docs/NumberPortModel.md +51 -0
- package/docs/NumberPortNoteDTO.md +0 -0
- package/docs/NumberPortRangeDTO.md +0 -0
- package/docs/NumberPortRangeRequestDTO.md +0 -0
- package/docs/NumberPortingApi.md +1 -1
- package/docs/NumberPortsModel.md +0 -0
- package/docs/OAuth20Api.md +1 -1
- package/docs/OfflineInstancesEntity.md +0 -0
- package/docs/OrderDetailsDTO.md +63 -0
- package/docs/OrderEntity.md +0 -0
- package/docs/OrderItemDTO.md +55 -0
- package/docs/OrderRequestModel.md +0 -0
- package/docs/OrderSummariesModel.md +0 -0
- package/docs/OrderSummaryDTO.md +0 -0
- package/docs/OrderTotalModel.md +0 -0
- package/docs/OrderedItemEntity.md +0 -0
- package/docs/OrderedItemModel.md +47 -0
- package/docs/OrdersApi.md +882 -48
- package/docs/PatchSetTcxWizardCnameRequest.md +0 -0
- package/docs/PatchUpdateAccountContactPasswordRequest.md +0 -0
- package/docs/PortalAccountModel.md +0 -0
- package/docs/PortalLoginModel.md +0 -0
- package/docs/PostAddOrderNoteRequest.md +20 -0
- package/docs/PostAddWebhook200Response.md +0 -0
- package/docs/PostGetClientCredentialsRequest.md +0 -0
- package/docs/PostGetProductForCustomerRequest.md +0 -0
- package/docs/PostGetProductRequest.md +0 -0
- package/docs/PostSplitOrderRequest.md +20 -0
- package/docs/PriceListItemModel.md +0 -0
- package/docs/PricingApi.md +1 -1
- package/docs/PrinterEntity.md +29 -0
- package/docs/PrizesEntity.md +0 -0
- package/docs/ProductPriceListItemModel.md +0 -0
- package/docs/ProductSearchResultsModel.md +0 -0
- package/docs/ProductSerialInfoModel.md +0 -0
- package/docs/ProductSummaryDTO.md +0 -0
- package/docs/ProductsApi.md +1 -1
- package/docs/PromoCodesEntity.md +0 -0
- package/docs/PromoItemsEntity.md +0 -0
- package/docs/ProvisioningApi.md +1 -1
- package/docs/ProvisioningModel.md +0 -0
- package/docs/ProvisioningRequestEntity.md +0 -0
- package/docs/PutAllocateItemsRequest.md +20 -0
- package/docs/PutAllocateItemsRequestItemsInner.md +22 -0
- package/docs/RecordingBackupAzureModel.md +0 -0
- package/docs/RecordingsBackupInfoDTO.md +0 -0
- package/docs/ResourceNotReadyException.md +0 -0
- package/docs/RootAccessModel.md +0 -0
- package/docs/S3BucketEntity.md +0 -0
- package/docs/SIPTrunksApi.md +1 -1
- package/docs/SMSApi.md +1 -1
- package/docs/ScannedItemModel.md +0 -0
- package/docs/ScopeModel.md +0 -0
- package/docs/ServiceHealthDTO.md +0 -0
- package/docs/ServiceStatusDTO.md +0 -0
- package/docs/ServicesApi.md +1 -1
- package/docs/ShipmentAddressEntity.md +0 -0
- package/docs/ShipmentDTO.md +35 -0
- package/docs/ShipmentEntity.md +0 -0
- package/docs/ShipmentItemDTO.md +23 -0
- package/docs/ShipmentItemEntity.md +0 -0
- package/docs/ShipmentItemModel.md +29 -0
- package/docs/ShipmentModel.md +43 -0
- package/docs/ShipmentRequestDTO.md +31 -0
- package/docs/ShippingApi.md +1 -1
- package/docs/ShippingConsignmentModel.md +0 -0
- package/docs/ShippingInformationDTO.md +0 -0
- package/docs/ShippingRequestDTO.md +24 -0
- package/docs/ShippingServiceDTO.md +0 -0
- package/docs/ShippingServiceModel.md +0 -0
- package/docs/ShippingServicesModel.md +0 -0
- package/docs/SipTrunkChangeResponseModel.md +0 -0
- package/docs/SipTrunkCreationRequestModel.md +0 -0
- package/docs/SipTrunkEntity.md +0 -0
- package/docs/SipTrunksResponseModel.md +0 -0
- package/docs/SmsAccountEntity.md +0 -0
- package/docs/SmsDataModel.md +0 -0
- package/docs/SmsMessageModel.md +0 -0
- package/docs/SmsNumbersEntity.md +0 -0
- package/docs/SmsPayloadModel.md +0 -0
- package/docs/SmsPhoneNumberModel.md +0 -0
- package/docs/SmsResponseModel.md +0 -0
- package/docs/SmsWhitelistEntity.md +0 -0
- package/docs/StockManagementApi.md +1 -1
- package/docs/StockOrderCourierEntity.md +0 -0
- package/docs/StockOrderDeductionModel.md +0 -0
- package/docs/StockOrderDeductionRequestModel.md +0 -0
- package/docs/StockOrderDeductionsEntity.md +0 -0
- package/docs/StockOrderEntity.md +0 -0
- package/docs/StockOrderItemEntity.md +0 -0
- package/docs/StockOrderItemModel.md +0 -0
- package/docs/StockOrderItemRequestModel.md +0 -0
- package/docs/StockOrderModel.md +0 -0
- package/docs/StockOrderProductEntity.md +0 -0
- package/docs/StockOrderRequestModel.md +0 -0
- package/docs/StockOrderSupplierEntity.md +0 -0
- package/docs/StockOrderSupplierModel.md +0 -0
- package/docs/StockOrdersModel.md +0 -0
- package/docs/StockProductModel.md +0 -0
- package/docs/StockProductPriceModel.md +0 -0
- package/docs/StockProductSummariesModel.md +0 -0
- package/docs/StockProductSummaryModel.md +0 -0
- package/docs/StockTransactionsEntity.md +0 -0
- package/docs/SupplierEntity.md +0 -0
- package/docs/SupplierItemEntity.md +0 -0
- package/docs/SupplierItemModel.md +35 -0
- package/docs/SupplierModel.md +37 -0
- package/docs/SupportTicketModel.md +0 -0
- package/docs/SystemApi.md +1 -1
- package/docs/TcxBackupEntity.md +0 -0
- package/docs/TcxBackupModel.md +0 -0
- package/docs/TcxBillingEntity.md +0 -0
- package/docs/TcxBulkLicenceDetailsModel.md +0 -0
- package/docs/TcxDeadLicenceEntity.md +0 -0
- package/docs/TcxExtsEntity.md +0 -0
- package/docs/TcxHostingPricingEntity.md +0 -0
- package/docs/TcxInstallationDetailsModel.md +0 -0
- package/docs/TcxInstallationModel.md +0 -0
- package/docs/TcxInstallationsModel.md +0 -0
- package/docs/TcxKeySummaryDTO.md +0 -0
- package/docs/TcxKeysEntity.md +0 -0
- package/docs/TcxLicenceDetailsErrorModel.md +0 -0
- package/docs/TcxLicenceDetailsModel.md +0 -0
- package/docs/TcxMacsEntity.md +0 -0
- package/docs/TcxMultiTenantModel.md +0 -0
- package/docs/TcxMultiTenantUserModel.md +0 -0
- package/docs/TcxMultiTenantsModel.md +0 -0
- package/docs/TcxNumbersEntity.md +0 -0
- package/docs/TcxOfficeHoursEntity.md +0 -0
- package/docs/TcxPhoneModel.md +0 -0
- package/docs/TcxPhonesEntity.md +0 -0
- package/docs/TcxRemoteStorageModel.md +0 -0
- package/docs/TcxSbcDTO.md +0 -0
- package/docs/TcxSbcEntity.md +0 -0
- package/docs/TcxSbcModel.md +0 -0
- package/docs/TcxSetupEntity.md +0 -0
- package/docs/TcxSetupsModel.md +0 -0
- package/docs/TcxSipTrunksEntity.md +0 -0
- package/docs/TcxTemplateXmlEnum.md +0 -0
- package/docs/TcxUsersEntity.md +0 -0
- package/docs/TcxWizardConfigModel.md +0 -0
- package/docs/TcxWizardModel.md +0 -0
- package/docs/TechSupportCompanySummaryDTO.md +0 -0
- package/docs/TelephonySupportTicketModel.md +41 -0
- package/docs/TicketSummaryModel.md +0 -0
- package/docs/TicketTimeDTO.md +0 -0
- package/docs/TicketsApi.md +1 -1
- package/docs/TokenResponseModel.md +0 -0
- package/docs/UpgradeOrderResponseModel.md +0 -0
- package/docs/UpgradeRequestModel.md +0 -0
- package/docs/UserEntity.md +0 -0
- package/docs/WebhooksApi.md +1 -1
- package/docs/XeroLogEntity.md +0 -0
- package/getEnums.php +0 -0
- package/git_push.sh +0 -0
- package/hs_err_pid16044.log +249 -0
- package/hs_err_pid44560.log +249 -0
- package/hs_err_pid53988.log +249 -0
- package/hs_err_pid58728.log +40 -0
- package/index.ts +1 -1
- package/models/CourierEnum.ts +19 -0
- package/models/EventStatusEnum.ts +0 -0
- package/models/EventTypeEnum.ts +0 -0
- package/models/PortStatusEnum.ts +0 -0
- package/models/PrinterEnum.ts +19 -0
- package/models/ServiceEnum.ts +0 -0
- package/models/ServiceHealthEnum.ts +0 -0
- package/models/ServiceStatusEnum.ts +0 -0
- package/models/UpdateTypeEnum.ts +0 -0
- package/openapitools.json +1 -1
- package/package.json +2 -2
- package/tsconfig.json +0 -0
- package/dist/models/StatusEnum.d.ts +0 -18
- package/dist/models/StatusEnum.js +0 -20
- package/dist/src/apis/AccountsApi.d.ts +0 -258
- package/dist/src/apis/AccountsApi.js +0 -975
- package/dist/src/apis/CRMApi.d.ts +0 -26
- package/dist/src/apis/CRMApi.js +0 -122
- package/dist/src/apis/Class3CXApi.d.ts +0 -44
- package/dist/src/apis/Class3CXApi.js +0 -177
- package/dist/src/apis/Class3CXInstallationWizardApi.d.ts +0 -446
- package/dist/src/apis/Class3CXInstallationWizardApi.js +0 -1740
- package/dist/src/apis/Class3CXInstallationsApi.d.ts +0 -253
- package/dist/src/apis/Class3CXInstallationsApi.js +0 -806
- package/dist/src/apis/Class3CXIntegrationsApi.d.ts +0 -102
- package/dist/src/apis/Class3CXIntegrationsApi.js +0 -386
- package/dist/src/apis/Class3CXMultiTenantApi.d.ts +0 -122
- package/dist/src/apis/Class3CXMultiTenantApi.js +0 -431
- package/dist/src/apis/MyPBXToolsApi.d.ts +0 -32
- package/dist/src/apis/MyPBXToolsApi.js +0 -136
- package/dist/src/apis/OAuth20Api.d.ts +0 -185
- package/dist/src/apis/OAuth20Api.js +0 -507
- package/dist/src/apis/OrdersApi.d.ts +0 -154
- package/dist/src/apis/OrdersApi.js +0 -512
- package/dist/src/apis/PricingApi.d.ts +0 -154
- package/dist/src/apis/PricingApi.js +0 -308
- package/dist/src/apis/ProductsApi.d.ts +0 -135
- package/dist/src/apis/ProductsApi.js +0 -531
- package/dist/src/apis/ProvisioningApi.d.ts +0 -112
- package/dist/src/apis/ProvisioningApi.js +0 -427
- package/dist/src/apis/SIPTrunksApi.d.ts +0 -315
- package/dist/src/apis/SIPTrunksApi.js +0 -1197
- package/dist/src/apis/SMSApi.d.ts +0 -30
- package/dist/src/apis/SMSApi.js +0 -130
- package/dist/src/apis/ServicesApi.d.ts +0 -81
- package/dist/src/apis/ServicesApi.js +0 -386
- package/dist/src/apis/ShippingApi.d.ts +0 -45
- package/dist/src/apis/ShippingApi.js +0 -179
- package/dist/src/apis/StockManagementApi.d.ts +0 -345
- package/dist/src/apis/StockManagementApi.js +0 -1293
- package/dist/src/apis/SystemApi.d.ts +0 -37
- package/dist/src/apis/SystemApi.js +0 -146
- package/dist/src/apis/TicketsApi.d.ts +0 -79
- package/dist/src/apis/TicketsApi.js +0 -360
- package/dist/src/apis/WebhooksApi.d.ts +0 -56
- package/dist/src/apis/WebhooksApi.js +0 -189
- package/dist/src/apis/index.d.ts +0 -21
- package/dist/src/apis/index.js +0 -39
- package/dist/src/index.d.ts +0 -3
- package/dist/src/index.js +0 -21
- package/dist/src/models/AbstractOrderRequestDTO.d.ts +0 -71
- package/dist/src/models/AbstractOrderRequestDTO.js +0 -64
- package/dist/src/models/AccountContactEntity.d.ts +0 -104
- package/dist/src/models/AccountContactEntity.js +0 -73
- package/dist/src/models/AccountContactModel.d.ts +0 -104
- package/dist/src/models/AccountContactModel.js +0 -73
- package/dist/src/models/AccountContactRequestModel.d.ts +0 -80
- package/dist/src/models/AccountContactRequestModel.js +0 -65
- package/dist/src/models/AccountDetailedSummaryDTO.d.ts +0 -89
- package/dist/src/models/AccountDetailedSummaryDTO.js +0 -70
- package/dist/src/models/AccountRequestModel.d.ts +0 -128
- package/dist/src/models/AccountRequestModel.js +0 -81
- package/dist/src/models/AccountSummaryDTO.d.ts +0 -44
- package/dist/src/models/AccountSummaryDTO.js +0 -53
- package/dist/src/models/AccountsResponseModel.d.ts +0 -51
- package/dist/src/models/AccountsResponseModel.js +0 -56
- package/dist/src/models/AddressModel.d.ts +0 -110
- package/dist/src/models/AddressModel.js +0 -75
- package/dist/src/models/AddressRequestModel.d.ts +0 -50
- package/dist/src/models/AddressRequestModel.js +0 -55
- package/dist/src/models/AdminOrderRequestDTO.d.ts +0 -113
- package/dist/src/models/AdminOrderRequestDTO.js +0 -78
- package/dist/src/models/AdminUserModel.d.ts +0 -79
- package/dist/src/models/AdminUserModel.js +0 -72
- package/dist/src/models/AgentHoursGraphModel.d.ts +0 -51
- package/dist/src/models/AgentHoursGraphModel.js +0 -56
- package/dist/src/models/AgentHoursGraphMonthModel.d.ts +0 -38
- package/dist/src/models/AgentHoursGraphMonthModel.js +0 -51
- package/dist/src/models/ApiLogEntity.d.ts +0 -98
- package/dist/src/models/ApiLogEntity.js +0 -71
- package/dist/src/models/AreaCodeModel.d.ts +0 -38
- package/dist/src/models/AreaCodeModel.js +0 -51
- package/dist/src/models/AttachmentModel.d.ts +0 -56
- package/dist/src/models/AttachmentModel.js +0 -57
- package/dist/src/models/AttributeSetEnum.d.ts +0 -38
- package/dist/src/models/AttributeSetEnum.js +0 -51
- package/dist/src/models/AuditLogEntity.d.ts +0 -80
- package/dist/src/models/AuditLogEntity.js +0 -65
- package/dist/src/models/AuthCodeResponseModel.d.ts +0 -44
- package/dist/src/models/AuthCodeResponseModel.js +0 -53
- package/dist/src/models/BasicItemDTO.d.ts +0 -38
- package/dist/src/models/BasicItemDTO.js +0 -51
- package/dist/src/models/BasicProductDTO.d.ts +0 -38
- package/dist/src/models/BasicProductDTO.js +0 -51
- package/dist/src/models/BatchEntity.d.ts +0 -128
- package/dist/src/models/BatchEntity.js +0 -81
- package/dist/src/models/CallBarringModel.d.ts +0 -56
- package/dist/src/models/CallBarringModel.js +0 -57
- package/dist/src/models/ClientDetailsModel.d.ts +0 -68
- package/dist/src/models/ClientDetailsModel.js +0 -61
- package/dist/src/models/ClientModel.d.ts +0 -50
- package/dist/src/models/ClientModel.js +0 -55
- package/dist/src/models/CompanyContractModel.d.ts +0 -56
- package/dist/src/models/CompanyContractModel.js +0 -57
- package/dist/src/models/ContactInfoModel.d.ts +0 -56
- package/dist/src/models/ContactInfoModel.js +0 -57
- package/dist/src/models/ConversationModel.d.ts +0 -75
- package/dist/src/models/ConversationModel.js +0 -64
- package/dist/src/models/CourierPriceEntity.d.ts +0 -86
- package/dist/src/models/CourierPriceEntity.js +0 -67
- package/dist/src/models/CreditAccountEntity.d.ts +0 -152
- package/dist/src/models/CreditAccountEntity.js +0 -89
- package/dist/src/models/CrmContactDTO.d.ts +0 -68
- package/dist/src/models/CrmContactDTO.js +0 -61
- package/dist/src/models/CustomerInformationModel.d.ts +0 -68
- package/dist/src/models/CustomerInformationModel.js +0 -61
- package/dist/src/models/CustomerItemRequestDTO.d.ts +0 -81
- package/dist/src/models/CustomerItemRequestDTO.js +0 -66
- package/dist/src/models/CustomerOrderRequestDTO.d.ts +0 -71
- package/dist/src/models/CustomerOrderRequestDTO.js +0 -64
- package/dist/src/models/CustomerPriceListEnum.d.ts +0 -38
- package/dist/src/models/CustomerPriceListEnum.js +0 -51
- package/dist/src/models/CustomerSummaryReportDTO.d.ts +0 -65
- package/dist/src/models/CustomerSummaryReportDTO.js +0 -62
- package/dist/src/models/DdiRangeRequestModel.d.ts +0 -44
- package/dist/src/models/DdiRangeRequestModel.js +0 -53
- package/dist/src/models/DdiRangesRequestModel.d.ts +0 -33
- package/dist/src/models/DdiRangesRequestModel.js +0 -50
- package/dist/src/models/DetailedItemRequestDTO.d.ts +0 -99
- package/dist/src/models/DetailedItemRequestDTO.js +0 -72
- package/dist/src/models/DetailedOrderRequestDTO.d.ts +0 -71
- package/dist/src/models/DetailedOrderRequestDTO.js +0 -64
- package/dist/src/models/DivertRequestModel.d.ts +0 -38
- package/dist/src/models/DivertRequestModel.js +0 -51
- package/dist/src/models/DivertResponseModel.d.ts +0 -52
- package/dist/src/models/DivertResponseModel.js +0 -61
- package/dist/src/models/EdTechProClientEntity.d.ts +0 -56
- package/dist/src/models/EdTechProClientEntity.js +0 -57
- package/dist/src/models/EdTechProSchoolModel.d.ts +0 -104
- package/dist/src/models/EdTechProSchoolModel.js +0 -73
- package/dist/src/models/EdTechProSchoolsModel.d.ts +0 -51
- package/dist/src/models/EdTechProSchoolsModel.js +0 -56
- package/dist/src/models/EdTechProSetupModel.d.ts +0 -56
- package/dist/src/models/EdTechProSetupModel.js +0 -57
- package/dist/src/models/EventDTO.d.ts +0 -84
- package/dist/src/models/EventDTO.js +0 -73
- package/dist/src/models/EventRequestDTO.d.ts +0 -44
- package/dist/src/models/EventRequestDTO.js +0 -53
- package/dist/src/models/EventSubscriptionModel.d.ts +0 -38
- package/dist/src/models/EventSubscriptionModel.js +0 -51
- package/dist/src/models/EventTypeEnum.d.ts +0 -19
- package/dist/src/models/EventTypeEnum.js +0 -24
- package/dist/src/models/EventUpdateDTO.d.ts +0 -50
- package/dist/src/models/EventUpdateDTO.js +0 -55
- package/dist/src/models/EventUpdateEntity.d.ts +0 -56
- package/dist/src/models/EventUpdateEntity.js +0 -57
- package/dist/src/models/EventUpdateRequestDTO.d.ts +0 -44
- package/dist/src/models/EventUpdateRequestDTO.js +0 -53
- package/dist/src/models/FraudManagementModel.d.ts +0 -38
- package/dist/src/models/FraudManagementModel.js +0 -51
- package/dist/src/models/FreshdeskCompanyTicketsModel.d.ts +0 -51
- package/dist/src/models/FreshdeskCompanyTicketsModel.js +0 -56
- package/dist/src/models/FreshdeskTicketEntity.d.ts +0 -68
- package/dist/src/models/FreshdeskTicketEntity.js +0 -61
- package/dist/src/models/FtpAccountsEntity.d.ts +0 -56
- package/dist/src/models/FtpAccountsEntity.js +0 -57
- package/dist/src/models/GenericFileModel.d.ts +0 -44
- package/dist/src/models/GenericFileModel.js +0 -53
- package/dist/src/models/GetGetPrice200Response.d.ts +0 -32
- package/dist/src/models/GetGetPrice200Response.js +0 -49
- package/dist/src/models/GetGetRecording200Response.d.ts +0 -32
- package/dist/src/models/GetGetRecording200Response.js +0 -49
- package/dist/src/models/HostingChangeResponseModel.d.ts +0 -64
- package/dist/src/models/HostingChangeResponseModel.js +0 -65
- package/dist/src/models/HostingRegionDTO.d.ts +0 -59
- package/dist/src/models/HostingRegionDTO.js +0 -68
- package/dist/src/models/InstanceAutoFailoverEntity.d.ts +0 -56
- package/dist/src/models/InstanceAutoFailoverEntity.js +0 -57
- package/dist/src/models/InstanceDeletionScheduleEntity.d.ts +0 -50
- package/dist/src/models/InstanceDeletionScheduleEntity.js +0 -55
- package/dist/src/models/InstanceEntity.d.ts +0 -152
- package/dist/src/models/InstanceEntity.js +0 -89
- package/dist/src/models/InstanceFailoverEntity.d.ts +0 -92
- package/dist/src/models/InstanceFailoverEntity.js +0 -69
- package/dist/src/models/InstanceMonitoringEntity.d.ts +0 -44
- package/dist/src/models/InstanceMonitoringEntity.js +0 -53
- package/dist/src/models/InstanceMonitoringLogEntity.d.ts +0 -62
- package/dist/src/models/InstanceMonitoringLogEntity.js +0 -59
- package/dist/src/models/InstanceScheduledTasksEntity.d.ts +0 -62
- package/dist/src/models/InstanceScheduledTasksEntity.js +0 -59
- package/dist/src/models/InstanceTcxDetailsEntity.d.ts +0 -86
- package/dist/src/models/InstanceTcxDetailsEntity.js +0 -67
- package/dist/src/models/InstanceUserCredentialsEntity.d.ts +0 -56
- package/dist/src/models/InstanceUserCredentialsEntity.js +0 -57
- package/dist/src/models/ItemDTO.d.ts +0 -117
- package/dist/src/models/ItemDTO.js +0 -78
- package/dist/src/models/ItemDiscountEntity.d.ts +0 -77
- package/dist/src/models/ItemDiscountEntity.js +0 -70
- package/dist/src/models/ItemEntity.d.ts +0 -158
- package/dist/src/models/ItemEntity.js +0 -91
- package/dist/src/models/LinkedOrderEntity.d.ts +0 -38
- package/dist/src/models/LinkedOrderEntity.js +0 -51
- package/dist/src/models/MFARequiredModel.d.ts +0 -38
- package/dist/src/models/MFARequiredModel.js +0 -51
- package/dist/src/models/MonthlyUsageModel.d.ts +0 -38
- package/dist/src/models/MonthlyUsageModel.js +0 -51
- package/dist/src/models/MultiTenantChangeResponseModel.d.ts +0 -70
- package/dist/src/models/MultiTenantChangeResponseModel.js +0 -75
- package/dist/src/models/NavigationModel.d.ts +0 -50
- package/dist/src/models/NavigationModel.js +0 -55
- package/dist/src/models/OfflineInstancesEntity.d.ts +0 -56
- package/dist/src/models/OfflineInstancesEntity.js +0 -57
- package/dist/src/models/OrderEntity.d.ts +0 -374
- package/dist/src/models/OrderEntity.js +0 -163
- package/dist/src/models/OrderRequestModel.d.ts +0 -120
- package/dist/src/models/OrderRequestModel.js +0 -88
- package/dist/src/models/OrderSummariesModel.d.ts +0 -51
- package/dist/src/models/OrderSummariesModel.js +0 -56
- package/dist/src/models/OrderSummaryDTO.d.ts +0 -126
- package/dist/src/models/OrderSummaryDTO.js +0 -83
- package/dist/src/models/OrderTotalModel.d.ts +0 -111
- package/dist/src/models/OrderTotalModel.js +0 -100
- package/dist/src/models/OrderedItemEntity.d.ts +0 -110
- package/dist/src/models/OrderedItemEntity.js +0 -75
- package/dist/src/models/PatchSetTcxWizardCnameRequest.d.ts +0 -32
- package/dist/src/models/PatchSetTcxWizardCnameRequest.js +0 -49
- package/dist/src/models/PatchUpdateAccountContactPasswordRequest.d.ts +0 -32
- package/dist/src/models/PatchUpdateAccountContactPasswordRequest.js +0 -49
- package/dist/src/models/PortalAccountModel.d.ts +0 -171
- package/dist/src/models/PortalAccountModel.js +0 -96
- package/dist/src/models/PortalLoginModel.d.ts +0 -68
- package/dist/src/models/PortalLoginModel.js +0 -61
- package/dist/src/models/PostAddWebhook200Response.d.ts +0 -32
- package/dist/src/models/PostAddWebhook200Response.js +0 -49
- package/dist/src/models/PostGetClientCredentialsRequest.d.ts +0 -32
- package/dist/src/models/PostGetClientCredentialsRequest.js +0 -49
- package/dist/src/models/PostGetProductForCustomerRequest.d.ts +0 -50
- package/dist/src/models/PostGetProductForCustomerRequest.js +0 -55
- package/dist/src/models/PostGetProductRequest.d.ts +0 -44
- package/dist/src/models/PostGetProductRequest.js +0 -53
- package/dist/src/models/PriceListItemModel.d.ts +0 -56
- package/dist/src/models/PriceListItemModel.js +0 -57
- package/dist/src/models/PrizesEntity.d.ts +0 -62
- package/dist/src/models/PrizesEntity.js +0 -59
- package/dist/src/models/ProductPriceListItemModel.d.ts +0 -62
- package/dist/src/models/ProductPriceListItemModel.js +0 -59
- package/dist/src/models/ProductSearchResultsModel.d.ts +0 -33
- package/dist/src/models/ProductSearchResultsModel.js +0 -50
- package/dist/src/models/ProductSerialInfoModel.d.ts +0 -50
- package/dist/src/models/ProductSerialInfoModel.js +0 -55
- package/dist/src/models/ProductSummaryDTO.d.ts +0 -81
- package/dist/src/models/ProductSummaryDTO.js +0 -66
- package/dist/src/models/PromoCodesEntity.d.ts +0 -98
- package/dist/src/models/PromoCodesEntity.js +0 -71
- package/dist/src/models/PromoItemsEntity.d.ts +0 -74
- package/dist/src/models/PromoItemsEntity.js +0 -63
- package/dist/src/models/ProvisioningModel.d.ts +0 -56
- package/dist/src/models/ProvisioningModel.js +0 -57
- package/dist/src/models/ProvisioningRequestEntity.d.ts +0 -44
- package/dist/src/models/ProvisioningRequestEntity.js +0 -53
- package/dist/src/models/RecordingBackupAzureModel.d.ts +0 -50
- package/dist/src/models/RecordingBackupAzureModel.js +0 -55
- package/dist/src/models/RecordingsBackupInfoDTO.d.ts +0 -40
- package/dist/src/models/RecordingsBackupInfoDTO.js +0 -53
- package/dist/src/models/ResourceNotReadyException.d.ts +0 -44
- package/dist/src/models/ResourceNotReadyException.js +0 -53
- package/dist/src/models/RootAccessModel.d.ts +0 -44
- package/dist/src/models/RootAccessModel.js +0 -53
- package/dist/src/models/S3BucketEntity.d.ts +0 -50
- package/dist/src/models/S3BucketEntity.js +0 -55
- package/dist/src/models/ScannedItemModel.d.ts +0 -56
- package/dist/src/models/ScannedItemModel.js +0 -57
- package/dist/src/models/ScopeModel.d.ts +0 -38
- package/dist/src/models/ScopeModel.js +0 -51
- package/dist/src/models/ServiceEnum.d.ts +0 -14
- package/dist/src/models/ServiceEnum.js +0 -19
- package/dist/src/models/ServiceHealthDTO.d.ts +0 -48
- package/dist/src/models/ServiceHealthDTO.js +0 -61
- package/dist/src/models/ServiceHealthEnum.d.ts +0 -19
- package/dist/src/models/ServiceHealthEnum.js +0 -24
- package/dist/src/models/ServiceStatusDTO.d.ts +0 -60
- package/dist/src/models/ServiceStatusDTO.js +0 -65
- package/dist/src/models/ServiceStatusEnum.d.ts +0 -19
- package/dist/src/models/ServiceStatusEnum.js +0 -24
- package/dist/src/models/ShipmentAddressEntity.d.ts +0 -92
- package/dist/src/models/ShipmentAddressEntity.js +0 -69
- package/dist/src/models/ShipmentEntity.d.ts +0 -98
- package/dist/src/models/ShipmentEntity.js +0 -71
- package/dist/src/models/ShipmentItemEntity.d.ts +0 -56
- package/dist/src/models/ShipmentItemEntity.js +0 -57
- package/dist/src/models/ShippingConsignmentModel.d.ts +0 -51
- package/dist/src/models/ShippingConsignmentModel.js +0 -56
- package/dist/src/models/ShippingInformationDTO.d.ts +0 -45
- package/dist/src/models/ShippingInformationDTO.js +0 -54
- package/dist/src/models/ShippingServiceDTO.d.ts +0 -47
- package/dist/src/models/ShippingServiceDTO.js +0 -60
- package/dist/src/models/ShippingServiceModel.d.ts +0 -71
- package/dist/src/models/ShippingServiceModel.js +0 -68
- package/dist/src/models/ShippingServicesModel.d.ts +0 -33
- package/dist/src/models/ShippingServicesModel.js +0 -50
- package/dist/src/models/SipTrunkChangeResponseModel.d.ts +0 -77
- package/dist/src/models/SipTrunkChangeResponseModel.js +0 -78
- package/dist/src/models/SipTrunkCreationRequestModel.d.ts +0 -66
- package/dist/src/models/SipTrunkCreationRequestModel.js +0 -63
- package/dist/src/models/SipTrunkEntity.d.ts +0 -98
- package/dist/src/models/SipTrunkEntity.js +0 -71
- package/dist/src/models/SipTrunksResponseModel.d.ts +0 -51
- package/dist/src/models/SipTrunksResponseModel.js +0 -56
- package/dist/src/models/SmsAccountEntity.d.ts +0 -68
- package/dist/src/models/SmsAccountEntity.js +0 -61
- package/dist/src/models/SmsDataModel.d.ts +0 -33
- package/dist/src/models/SmsDataModel.js +0 -50
- package/dist/src/models/SmsMessageModel.d.ts +0 -44
- package/dist/src/models/SmsMessageModel.js +0 -53
- package/dist/src/models/SmsNumbersEntity.d.ts +0 -38
- package/dist/src/models/SmsNumbersEntity.js +0 -51
- package/dist/src/models/SmsPayloadModel.d.ts +0 -45
- package/dist/src/models/SmsPayloadModel.js +0 -54
- package/dist/src/models/SmsPhoneNumberModel.d.ts +0 -53
- package/dist/src/models/SmsPhoneNumberModel.js +0 -66
- package/dist/src/models/SmsResponseModel.d.ts +0 -67
- package/dist/src/models/SmsResponseModel.js +0 -68
- package/dist/src/models/SmsWhitelistEntity.d.ts +0 -38
- package/dist/src/models/SmsWhitelistEntity.js +0 -51
- package/dist/src/models/StockOrderCourierEntity.d.ts +0 -50
- package/dist/src/models/StockOrderCourierEntity.js +0 -55
- package/dist/src/models/StockOrderDeductionModel.d.ts +0 -50
- package/dist/src/models/StockOrderDeductionModel.js +0 -55
- package/dist/src/models/StockOrderDeductionRequestModel.d.ts +0 -38
- package/dist/src/models/StockOrderDeductionRequestModel.js +0 -51
- package/dist/src/models/StockOrderDeductionsEntity.d.ts +0 -50
- package/dist/src/models/StockOrderDeductionsEntity.js +0 -55
- package/dist/src/models/StockOrderEntity.d.ts +0 -158
- package/dist/src/models/StockOrderEntity.js +0 -91
- package/dist/src/models/StockOrderItemEntity.d.ts +0 -68
- package/dist/src/models/StockOrderItemEntity.js +0 -61
- package/dist/src/models/StockOrderItemModel.d.ts +0 -80
- package/dist/src/models/StockOrderItemModel.js +0 -65
- package/dist/src/models/StockOrderItemRequestModel.d.ts +0 -50
- package/dist/src/models/StockOrderItemRequestModel.js +0 -55
- package/dist/src/models/StockOrderModel.d.ts +0 -137
- package/dist/src/models/StockOrderModel.js +0 -97
- package/dist/src/models/StockOrderProductEntity.d.ts +0 -62
- package/dist/src/models/StockOrderProductEntity.js +0 -59
- package/dist/src/models/StockOrderRequestModel.d.ts +0 -46
- package/dist/src/models/StockOrderRequestModel.js +0 -55
- package/dist/src/models/StockOrderSupplierEntity.d.ts +0 -80
- package/dist/src/models/StockOrderSupplierEntity.js +0 -65
- package/dist/src/models/StockOrderSupplierModel.d.ts +0 -80
- package/dist/src/models/StockOrderSupplierModel.js +0 -65
- package/dist/src/models/StockOrdersModel.d.ts +0 -51
- package/dist/src/models/StockOrdersModel.js +0 -56
- package/dist/src/models/StockProductModel.d.ts +0 -120
- package/dist/src/models/StockProductModel.js +0 -81
- package/dist/src/models/StockProductPriceModel.d.ts +0 -39
- package/dist/src/models/StockProductPriceModel.js +0 -52
- package/dist/src/models/StockProductSummariesModel.d.ts +0 -51
- package/dist/src/models/StockProductSummariesModel.js +0 -56
- package/dist/src/models/StockProductSummaryModel.d.ts +0 -69
- package/dist/src/models/StockProductSummaryModel.js +0 -62
- package/dist/src/models/StockTransactionsEntity.d.ts +0 -74
- package/dist/src/models/StockTransactionsEntity.js +0 -63
- package/dist/src/models/SupplierEntity.d.ts +0 -80
- package/dist/src/models/SupplierEntity.js +0 -65
- package/dist/src/models/SupplierItemEntity.d.ts +0 -74
- package/dist/src/models/SupplierItemEntity.js +0 -63
- package/dist/src/models/TcxBackupEntity.d.ts +0 -80
- package/dist/src/models/TcxBackupEntity.js +0 -65
- package/dist/src/models/TcxBackupModel.d.ts +0 -140
- package/dist/src/models/TcxBackupModel.js +0 -85
- package/dist/src/models/TcxBillingEntity.d.ts +0 -86
- package/dist/src/models/TcxBillingEntity.js +0 -67
- package/dist/src/models/TcxBulkLicenceDetailsModel.d.ts +0 -40
- package/dist/src/models/TcxBulkLicenceDetailsModel.js +0 -53
- package/dist/src/models/TcxDeadLicenceEntity.d.ts +0 -44
- package/dist/src/models/TcxDeadLicenceEntity.js +0 -53
- package/dist/src/models/TcxExtsEntity.d.ts +0 -74
- package/dist/src/models/TcxExtsEntity.js +0 -63
- package/dist/src/models/TcxHostingPricingEntity.d.ts +0 -74
- package/dist/src/models/TcxHostingPricingEntity.js +0 -63
- package/dist/src/models/TcxInstallationDetailsModel.d.ts +0 -106
- package/dist/src/models/TcxInstallationDetailsModel.js +0 -75
- package/dist/src/models/TcxInstallationModel.d.ts +0 -200
- package/dist/src/models/TcxInstallationModel.js +0 -105
- package/dist/src/models/TcxInstallationsModel.d.ts +0 -51
- package/dist/src/models/TcxInstallationsModel.js +0 -56
- package/dist/src/models/TcxKeySummaryDTO.d.ts +0 -56
- package/dist/src/models/TcxKeySummaryDTO.js +0 -57
- package/dist/src/models/TcxKeysEntity.d.ts +0 -62
- package/dist/src/models/TcxKeysEntity.js +0 -59
- package/dist/src/models/TcxLicenceDetailsErrorModel.d.ts +0 -50
- package/dist/src/models/TcxLicenceDetailsErrorModel.js +0 -55
- package/dist/src/models/TcxLicenceDetailsModel.d.ts +0 -92
- package/dist/src/models/TcxLicenceDetailsModel.js +0 -69
- package/dist/src/models/TcxMacsEntity.d.ts +0 -44
- package/dist/src/models/TcxMacsEntity.js +0 -53
- package/dist/src/models/TcxMultiTenantModel.d.ts +0 -118
- package/dist/src/models/TcxMultiTenantModel.js +0 -83
- package/dist/src/models/TcxMultiTenantUserModel.d.ts +0 -44
- package/dist/src/models/TcxMultiTenantUserModel.js +0 -53
- package/dist/src/models/TcxMultiTenantsModel.d.ts +0 -51
- package/dist/src/models/TcxMultiTenantsModel.js +0 -56
- package/dist/src/models/TcxNumbersEntity.d.ts +0 -44
- package/dist/src/models/TcxNumbersEntity.js +0 -53
- package/dist/src/models/TcxOfficeHoursEntity.d.ts +0 -116
- package/dist/src/models/TcxOfficeHoursEntity.js +0 -77
- package/dist/src/models/TcxPhoneModel.d.ts +0 -68
- package/dist/src/models/TcxPhoneModel.js +0 -61
- package/dist/src/models/TcxPhonesEntity.d.ts +0 -62
- package/dist/src/models/TcxPhonesEntity.js +0 -59
- package/dist/src/models/TcxRemoteStorageModel.d.ts +0 -50
- package/dist/src/models/TcxRemoteStorageModel.js +0 -55
- package/dist/src/models/TcxSbcDTO.d.ts +0 -62
- package/dist/src/models/TcxSbcDTO.js +0 -59
- package/dist/src/models/TcxSbcEntity.d.ts +0 -122
- package/dist/src/models/TcxSbcEntity.js +0 -79
- package/dist/src/models/TcxSbcModel.d.ts +0 -122
- package/dist/src/models/TcxSbcModel.js +0 -79
- package/dist/src/models/TcxSetupEntity.d.ts +0 -207
- package/dist/src/models/TcxSetupEntity.js +0 -123
- package/dist/src/models/TcxSetupsModel.d.ts +0 -51
- package/dist/src/models/TcxSetupsModel.js +0 -56
- package/dist/src/models/TcxSipTrunksEntity.d.ts +0 -104
- package/dist/src/models/TcxSipTrunksEntity.js +0 -73
- package/dist/src/models/TcxTemplateXmlEnum.d.ts +0 -38
- package/dist/src/models/TcxTemplateXmlEnum.js +0 -51
- package/dist/src/models/TcxUsersEntity.d.ts +0 -62
- package/dist/src/models/TcxUsersEntity.js +0 -59
- package/dist/src/models/TcxWizardConfigModel.d.ts +0 -39
- package/dist/src/models/TcxWizardConfigModel.js +0 -52
- package/dist/src/models/TcxWizardModel.d.ts +0 -150
- package/dist/src/models/TcxWizardModel.js +0 -114
- package/dist/src/models/TechSupportCompanySummaryDTO.d.ts +0 -57
- package/dist/src/models/TechSupportCompanySummaryDTO.js +0 -58
- package/dist/src/models/TelephonySupportTicketModel.d.ts +0 -94
- package/dist/src/models/TelephonySupportTicketModel.js +0 -71
- package/dist/src/models/TicketSummaryModel.d.ts +0 -74
- package/dist/src/models/TicketSummaryModel.js +0 -63
- package/dist/src/models/TicketTimeDTO.d.ts +0 -80
- package/dist/src/models/TicketTimeDTO.js +0 -65
- package/dist/src/models/TokenResponseModel.d.ts +0 -44
- package/dist/src/models/TokenResponseModel.js +0 -53
- package/dist/src/models/UpdateTypeEnum.d.ts +0 -19
- package/dist/src/models/UpdateTypeEnum.js +0 -24
- package/dist/src/models/UpgradeOrderResponseModel.d.ts +0 -38
- package/dist/src/models/UpgradeOrderResponseModel.js +0 -51
- package/dist/src/models/UpgradeRequestModel.d.ts +0 -66
- package/dist/src/models/UpgradeRequestModel.js +0 -70
- package/dist/src/models/UserEntity.d.ts +0 -98
- package/dist/src/models/UserEntity.js +0 -71
- package/dist/src/models/XeroLogEntity.d.ts +0 -86
- package/dist/src/models/XeroLogEntity.js +0 -67
- package/dist/src/models/index.d.ts +0 -196
- package/dist/src/models/index.js +0 -214
- package/dist/src/runtime.d.ts +0 -184
- package/dist/src/runtime.js +0 -564
package/docs/OrdersApi.md
CHANGED
|
@@ -1,17 +1,88 @@
|
|
|
1
1
|
# OrdersApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://
|
|
3
|
+
All URIs are relative to *https://api.yellowgrid.local*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**deleteDeleteBatch**](#deletedeletebatch) | **DELETE** /admin/orders/{id}/batches/{batch_id} | |
|
|
7
8
|
|[**deleteUpdateOrder**](#deleteupdateorder) | **DELETE** /orders/{id} | Delete Orders (Beta)|
|
|
9
|
+
|[**deleteUpdateShipment**](#deleteupdateshipment) | **DELETE** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Delete Shipment (Admin)|
|
|
8
10
|
|[**getGetAdminEditableOrder**](#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)|
|
|
11
|
+
|[**getGetAdminOrderDetails**](#getgetadminorderdetails) | **GET** /admin/orders/{id}/details | Get Order Details (Admin)|
|
|
9
12
|
|[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)|
|
|
13
|
+
|[**getGetOrderPdf**](#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF|
|
|
10
14
|
|[**getGetOrders**](#getgetorders) | **GET** /orders | Get Orders (Beta)|
|
|
15
|
+
|[**postAddOrderNote**](#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note|
|
|
11
16
|
|[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
|
|
17
|
+
|[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
|
|
18
|
+
|[**postCreateShipment**](#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)|
|
|
12
19
|
|[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
|
|
20
|
+
|[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
|
|
21
|
+
|[**postPrintShippingLabel**](#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label|
|
|
22
|
+
|[**postSendOrderEmail**](#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email|
|
|
23
|
+
|[**postSendSupplierEmail**](#postsendsupplieremail) | **POST** /admin/orders/{id}/batches/{batch_id}/email/send | Send Supplier Email|
|
|
24
|
+
|[**postSplitOrder**](#postsplitorder) | **POST** /admin/orders/{id}/split | Split Order|
|
|
25
|
+
|[**putAllocateItems**](#putallocateitems) | **PUT** /admin/orders/{id}/items/allocate | Allocate Items To Supplier|
|
|
13
26
|
|[**putUpdateAdminOrder**](#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)|
|
|
14
27
|
|[**putUpdateOrder**](#putupdateorder) | **PUT** /orders/{id} | Update An Order (Beta)|
|
|
28
|
+
|[**putUpdateShipment**](#putupdateshipment) | **PUT** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Update Shipment (Admin)|
|
|
29
|
+
|
|
30
|
+
# **deleteDeleteBatch**
|
|
31
|
+
> deleteDeleteBatch()
|
|
32
|
+
|
|
33
|
+
Delete Batch (Admin)
|
|
34
|
+
|
|
35
|
+
### Example
|
|
36
|
+
|
|
37
|
+
```typescript
|
|
38
|
+
import {
|
|
39
|
+
OrdersApi,
|
|
40
|
+
Configuration
|
|
41
|
+
} from 'yellowgrid-api-ts';
|
|
42
|
+
|
|
43
|
+
const configuration = new Configuration();
|
|
44
|
+
const apiInstance = new OrdersApi(configuration);
|
|
45
|
+
|
|
46
|
+
let id: number; //Order ID (default to undefined)
|
|
47
|
+
let batchId: number; //Batch ID (default to undefined)
|
|
48
|
+
|
|
49
|
+
const { status, data } = await apiInstance.deleteDeleteBatch(
|
|
50
|
+
id,
|
|
51
|
+
batchId
|
|
52
|
+
);
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Parameters
|
|
56
|
+
|
|
57
|
+
|Name | Type | Description | Notes|
|
|
58
|
+
|------------- | ------------- | ------------- | -------------|
|
|
59
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
60
|
+
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
### Return type
|
|
64
|
+
|
|
65
|
+
void (empty response body)
|
|
66
|
+
|
|
67
|
+
### Authorization
|
|
68
|
+
|
|
69
|
+
No authorization required
|
|
70
|
+
|
|
71
|
+
### HTTP request headers
|
|
72
|
+
|
|
73
|
+
- **Content-Type**: Not defined
|
|
74
|
+
- **Accept**: Not defined
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
### HTTP response details
|
|
78
|
+
| Status code | Description | Response headers |
|
|
79
|
+
|-------------|-------------|------------------|
|
|
80
|
+
|**200** | No Response | - |
|
|
81
|
+
|**400** | Bad Request | - |
|
|
82
|
+
|**401** | Unauthorised | - |
|
|
83
|
+
|**403** | Access Denied | - |
|
|
84
|
+
|
|
85
|
+
[[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)
|
|
15
86
|
|
|
16
87
|
# **deleteUpdateOrder**
|
|
17
88
|
> deleteUpdateOrder()
|
|
@@ -43,6 +114,66 @@ const { status, data } = await apiInstance.deleteUpdateOrder(
|
|
|
43
114
|
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
44
115
|
|
|
45
116
|
|
|
117
|
+
### Return type
|
|
118
|
+
|
|
119
|
+
void (empty response body)
|
|
120
|
+
|
|
121
|
+
### Authorization
|
|
122
|
+
|
|
123
|
+
No authorization required
|
|
124
|
+
|
|
125
|
+
### HTTP request headers
|
|
126
|
+
|
|
127
|
+
- **Content-Type**: Not defined
|
|
128
|
+
- **Accept**: Not defined
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
### HTTP response details
|
|
132
|
+
| Status code | Description | Response headers |
|
|
133
|
+
|-------------|-------------|------------------|
|
|
134
|
+
|**200** | No Response | - |
|
|
135
|
+
|**400** | Bad Request | - |
|
|
136
|
+
|**401** | Unauthorised | - |
|
|
137
|
+
|**403** | Access Denied | - |
|
|
138
|
+
|
|
139
|
+
[[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)
|
|
140
|
+
|
|
141
|
+
# **deleteUpdateShipment**
|
|
142
|
+
> deleteUpdateShipment()
|
|
143
|
+
|
|
144
|
+
Delete Shipment (Admin)
|
|
145
|
+
|
|
146
|
+
### Example
|
|
147
|
+
|
|
148
|
+
```typescript
|
|
149
|
+
import {
|
|
150
|
+
OrdersApi,
|
|
151
|
+
Configuration
|
|
152
|
+
} from 'yellowgrid-api-ts';
|
|
153
|
+
|
|
154
|
+
const configuration = new Configuration();
|
|
155
|
+
const apiInstance = new OrdersApi(configuration);
|
|
156
|
+
|
|
157
|
+
let id: number; //Order ID (default to undefined)
|
|
158
|
+
let batchId: number; //Batch ID (default to undefined)
|
|
159
|
+
let shipmentId: number; //Shipment ID (default to undefined)
|
|
160
|
+
|
|
161
|
+
const { status, data } = await apiInstance.deleteUpdateShipment(
|
|
162
|
+
id,
|
|
163
|
+
batchId,
|
|
164
|
+
shipmentId
|
|
165
|
+
);
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
### Parameters
|
|
169
|
+
|
|
170
|
+
|Name | Type | Description | Notes|
|
|
171
|
+
|------------- | ------------- | ------------- | -------------|
|
|
172
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
173
|
+
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
174
|
+
| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
|
|
175
|
+
|
|
176
|
+
|
|
46
177
|
### Return type
|
|
47
178
|
|
|
48
179
|
void (empty response body)
|
|
@@ -121,6 +252,60 @@ No authorization required
|
|
|
121
252
|
|
|
122
253
|
[[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)
|
|
123
254
|
|
|
255
|
+
# **getGetAdminOrderDetails**
|
|
256
|
+
> OrderDetailsDTO getGetAdminOrderDetails()
|
|
257
|
+
|
|
258
|
+
Get Order Details (Admin)
|
|
259
|
+
|
|
260
|
+
### Example
|
|
261
|
+
|
|
262
|
+
```typescript
|
|
263
|
+
import {
|
|
264
|
+
OrdersApi,
|
|
265
|
+
Configuration
|
|
266
|
+
} from 'yellowgrid-api-ts';
|
|
267
|
+
|
|
268
|
+
const configuration = new Configuration();
|
|
269
|
+
const apiInstance = new OrdersApi(configuration);
|
|
270
|
+
|
|
271
|
+
let id: number; //Order ID (default to undefined)
|
|
272
|
+
|
|
273
|
+
const { status, data } = await apiInstance.getGetAdminOrderDetails(
|
|
274
|
+
id
|
|
275
|
+
);
|
|
276
|
+
```
|
|
277
|
+
|
|
278
|
+
### Parameters
|
|
279
|
+
|
|
280
|
+
|Name | Type | Description | Notes|
|
|
281
|
+
|------------- | ------------- | ------------- | -------------|
|
|
282
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
### Return type
|
|
286
|
+
|
|
287
|
+
**OrderDetailsDTO**
|
|
288
|
+
|
|
289
|
+
### Authorization
|
|
290
|
+
|
|
291
|
+
No authorization required
|
|
292
|
+
|
|
293
|
+
### HTTP request headers
|
|
294
|
+
|
|
295
|
+
- **Content-Type**: Not defined
|
|
296
|
+
- **Accept**: application/json
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
### HTTP response details
|
|
300
|
+
| Status code | Description | Response headers |
|
|
301
|
+
|-------------|-------------|------------------|
|
|
302
|
+
|**200** | Order Details | - |
|
|
303
|
+
|**400** | Bad Request | - |
|
|
304
|
+
|**401** | Unauthorised | - |
|
|
305
|
+
|**403** | Access Denied | - |
|
|
306
|
+
|
|
307
|
+
[[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)
|
|
308
|
+
|
|
124
309
|
# **getGetEditableOrder**
|
|
125
310
|
> DetailedOrderRequestDTO getGetEditableOrder()
|
|
126
311
|
|
|
@@ -175,6 +360,60 @@ No authorization required
|
|
|
175
360
|
|
|
176
361
|
[[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)
|
|
177
362
|
|
|
363
|
+
# **getGetOrderPdf**
|
|
364
|
+
> File getGetOrderPdf()
|
|
365
|
+
|
|
366
|
+
Download Order PDF
|
|
367
|
+
|
|
368
|
+
### Example
|
|
369
|
+
|
|
370
|
+
```typescript
|
|
371
|
+
import {
|
|
372
|
+
OrdersApi,
|
|
373
|
+
Configuration
|
|
374
|
+
} from 'yellowgrid-api-ts';
|
|
375
|
+
|
|
376
|
+
const configuration = new Configuration();
|
|
377
|
+
const apiInstance = new OrdersApi(configuration);
|
|
378
|
+
|
|
379
|
+
let id: number; //Order ID (default to undefined)
|
|
380
|
+
|
|
381
|
+
const { status, data } = await apiInstance.getGetOrderPdf(
|
|
382
|
+
id
|
|
383
|
+
);
|
|
384
|
+
```
|
|
385
|
+
|
|
386
|
+
### Parameters
|
|
387
|
+
|
|
388
|
+
|Name | Type | Description | Notes|
|
|
389
|
+
|------------- | ------------- | ------------- | -------------|
|
|
390
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
### Return type
|
|
394
|
+
|
|
395
|
+
**File**
|
|
396
|
+
|
|
397
|
+
### Authorization
|
|
398
|
+
|
|
399
|
+
No authorization required
|
|
400
|
+
|
|
401
|
+
### HTTP request headers
|
|
402
|
+
|
|
403
|
+
- **Content-Type**: Not defined
|
|
404
|
+
- **Accept**: application/pdf
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
### HTTP response details
|
|
408
|
+
| Status code | Description | Response headers |
|
|
409
|
+
|-------------|-------------|------------------|
|
|
410
|
+
|**200** | Order PDF | - |
|
|
411
|
+
|**400** | Bad Request | - |
|
|
412
|
+
|**401** | Unauthorised | - |
|
|
413
|
+
|**403** | Access Denied | - |
|
|
414
|
+
|
|
415
|
+
[[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)
|
|
416
|
+
|
|
178
417
|
# **getGetOrders**
|
|
179
418
|
> OrderSummariesModel getGetOrders()
|
|
180
419
|
|
|
@@ -247,10 +486,10 @@ No authorization required
|
|
|
247
486
|
|
|
248
487
|
[[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)
|
|
249
488
|
|
|
250
|
-
# **
|
|
251
|
-
>
|
|
489
|
+
# **postAddOrderNote**
|
|
490
|
+
> AuditLogEntity postAddOrderNote()
|
|
252
491
|
|
|
253
|
-
|
|
492
|
+
Add Order Note
|
|
254
493
|
|
|
255
494
|
### Example
|
|
256
495
|
|
|
@@ -258,18 +497,18 @@ Create An Order (Admin)
|
|
|
258
497
|
import {
|
|
259
498
|
OrdersApi,
|
|
260
499
|
Configuration,
|
|
261
|
-
|
|
500
|
+
PostAddOrderNoteRequest
|
|
262
501
|
} from 'yellowgrid-api-ts';
|
|
263
502
|
|
|
264
503
|
const configuration = new Configuration();
|
|
265
504
|
const apiInstance = new OrdersApi(configuration);
|
|
266
505
|
|
|
267
|
-
let
|
|
268
|
-
let
|
|
506
|
+
let id: number; //Order ID (default to undefined)
|
|
507
|
+
let postAddOrderNoteRequest: PostAddOrderNoteRequest; // (optional)
|
|
269
508
|
|
|
270
|
-
const { status, data } = await apiInstance.
|
|
271
|
-
|
|
272
|
-
|
|
509
|
+
const { status, data } = await apiInstance.postAddOrderNote(
|
|
510
|
+
id,
|
|
511
|
+
postAddOrderNoteRequest
|
|
273
512
|
);
|
|
274
513
|
```
|
|
275
514
|
|
|
@@ -277,13 +516,13 @@ const { status, data } = await apiInstance.postCreateAdminOrder(
|
|
|
277
516
|
|
|
278
517
|
|Name | Type | Description | Notes|
|
|
279
518
|
|------------- | ------------- | ------------- | -------------|
|
|
280
|
-
| **
|
|
281
|
-
| **
|
|
519
|
+
| **postAddOrderNoteRequest** | **PostAddOrderNoteRequest**| | |
|
|
520
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
282
521
|
|
|
283
522
|
|
|
284
523
|
### Return type
|
|
285
524
|
|
|
286
|
-
**
|
|
525
|
+
**AuditLogEntity**
|
|
287
526
|
|
|
288
527
|
### Authorization
|
|
289
528
|
|
|
@@ -298,17 +537,17 @@ No authorization required
|
|
|
298
537
|
### HTTP response details
|
|
299
538
|
| Status code | Description | Response headers |
|
|
300
539
|
|-------------|-------------|------------------|
|
|
301
|
-
|**200** |
|
|
540
|
+
|**200** | Audit Log Entry | - |
|
|
302
541
|
|**400** | Bad Request | - |
|
|
303
542
|
|**401** | Unauthorised | - |
|
|
304
543
|
|**403** | Access Denied | - |
|
|
305
544
|
|
|
306
545
|
[[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)
|
|
307
546
|
|
|
308
|
-
# **
|
|
309
|
-
> Array<OrderSummaryDTO>
|
|
547
|
+
# **postCreateAdminOrder**
|
|
548
|
+
> Array<OrderSummaryDTO> postCreateAdminOrder()
|
|
310
549
|
|
|
311
|
-
Create An Order (
|
|
550
|
+
Create An Order (Admin)
|
|
312
551
|
|
|
313
552
|
### Example
|
|
314
553
|
|
|
@@ -316,18 +555,18 @@ Create An Order (Beta)
|
|
|
316
555
|
import {
|
|
317
556
|
OrdersApi,
|
|
318
557
|
Configuration,
|
|
319
|
-
|
|
558
|
+
AdminOrderRequestDTO
|
|
320
559
|
} from 'yellowgrid-api-ts';
|
|
321
560
|
|
|
322
561
|
const configuration = new Configuration();
|
|
323
562
|
const apiInstance = new OrdersApi(configuration);
|
|
324
563
|
|
|
325
564
|
let readonly: boolean; //Readonly Order (optional) (default to undefined)
|
|
326
|
-
let
|
|
565
|
+
let adminOrderRequestDTO: AdminOrderRequestDTO; //Admin Order Request (optional)
|
|
327
566
|
|
|
328
|
-
const { status, data } = await apiInstance.
|
|
567
|
+
const { status, data } = await apiInstance.postCreateAdminOrder(
|
|
329
568
|
readonly,
|
|
330
|
-
|
|
569
|
+
adminOrderRequestDTO
|
|
331
570
|
);
|
|
332
571
|
```
|
|
333
572
|
|
|
@@ -335,7 +574,7 @@ const { status, data } = await apiInstance.postGetOrders(
|
|
|
335
574
|
|
|
336
575
|
|Name | Type | Description | Notes|
|
|
337
576
|
|------------- | ------------- | ------------- | -------------|
|
|
338
|
-
| **
|
|
577
|
+
| **adminOrderRequestDTO** | **AdminOrderRequestDTO**| Admin Order Request | |
|
|
339
578
|
| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
|
|
340
579
|
|
|
341
580
|
|
|
@@ -363,10 +602,10 @@ No authorization required
|
|
|
363
602
|
|
|
364
603
|
[[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)
|
|
365
604
|
|
|
366
|
-
# **
|
|
367
|
-
>
|
|
605
|
+
# **postCreateConsignment**
|
|
606
|
+
> ShipmentModel postCreateConsignment()
|
|
368
607
|
|
|
369
|
-
|
|
608
|
+
Create Shipping Consignment
|
|
370
609
|
|
|
371
610
|
### Example
|
|
372
611
|
|
|
@@ -374,20 +613,20 @@ Update An Order (Admin)
|
|
|
374
613
|
import {
|
|
375
614
|
OrdersApi,
|
|
376
615
|
Configuration,
|
|
377
|
-
|
|
616
|
+
ShippingRequestDTO
|
|
378
617
|
} from 'yellowgrid-api-ts';
|
|
379
618
|
|
|
380
619
|
const configuration = new Configuration();
|
|
381
620
|
const apiInstance = new OrdersApi(configuration);
|
|
382
621
|
|
|
383
622
|
let id: number; //Order ID (default to undefined)
|
|
384
|
-
let
|
|
385
|
-
let
|
|
623
|
+
let shipmentId: number; //Shipment ID (default to undefined)
|
|
624
|
+
let shippingRequestDTO: ShippingRequestDTO; //Shipping Request (optional)
|
|
386
625
|
|
|
387
|
-
const { status, data } = await apiInstance.
|
|
626
|
+
const { status, data } = await apiInstance.postCreateConsignment(
|
|
388
627
|
id,
|
|
389
|
-
|
|
390
|
-
|
|
628
|
+
shipmentId,
|
|
629
|
+
shippingRequestDTO
|
|
391
630
|
);
|
|
392
631
|
```
|
|
393
632
|
|
|
@@ -395,14 +634,14 @@ const { status, data } = await apiInstance.putUpdateAdminOrder(
|
|
|
395
634
|
|
|
396
635
|
|Name | Type | Description | Notes|
|
|
397
636
|
|------------- | ------------- | ------------- | -------------|
|
|
398
|
-
| **
|
|
637
|
+
| **shippingRequestDTO** | **ShippingRequestDTO**| Shipping Request | |
|
|
399
638
|
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
400
|
-
| **
|
|
639
|
+
| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
|
|
401
640
|
|
|
402
641
|
|
|
403
642
|
### Return type
|
|
404
643
|
|
|
405
|
-
**
|
|
644
|
+
**ShipmentModel**
|
|
406
645
|
|
|
407
646
|
### Authorization
|
|
408
647
|
|
|
@@ -417,17 +656,17 @@ No authorization required
|
|
|
417
656
|
### HTTP response details
|
|
418
657
|
| Status code | Description | Response headers |
|
|
419
658
|
|-------------|-------------|------------------|
|
|
420
|
-
|**200** |
|
|
659
|
+
|**200** | Shipping Information | - |
|
|
421
660
|
|**400** | Bad Request | - |
|
|
422
661
|
|**401** | Unauthorised | - |
|
|
423
662
|
|**403** | Access Denied | - |
|
|
424
663
|
|
|
425
664
|
[[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)
|
|
426
665
|
|
|
427
|
-
# **
|
|
428
|
-
>
|
|
666
|
+
# **postCreateShipment**
|
|
667
|
+
> ShipmentDTO postCreateShipment()
|
|
429
668
|
|
|
430
|
-
|
|
669
|
+
Create Shipment (Admin)
|
|
431
670
|
|
|
432
671
|
### Example
|
|
433
672
|
|
|
@@ -435,20 +674,20 @@ Update An Order (Beta)
|
|
|
435
674
|
import {
|
|
436
675
|
OrdersApi,
|
|
437
676
|
Configuration,
|
|
438
|
-
|
|
677
|
+
ShipmentRequestDTO
|
|
439
678
|
} from 'yellowgrid-api-ts';
|
|
440
679
|
|
|
441
680
|
const configuration = new Configuration();
|
|
442
681
|
const apiInstance = new OrdersApi(configuration);
|
|
443
682
|
|
|
444
683
|
let id: number; //Order ID (default to undefined)
|
|
445
|
-
let
|
|
446
|
-
let
|
|
684
|
+
let batchId: number; //Batch ID (default to undefined)
|
|
685
|
+
let shipmentRequestDTO: ShipmentRequestDTO; //Shipment Request (optional)
|
|
447
686
|
|
|
448
|
-
const { status, data } = await apiInstance.
|
|
687
|
+
const { status, data } = await apiInstance.postCreateShipment(
|
|
449
688
|
id,
|
|
450
|
-
|
|
451
|
-
|
|
689
|
+
batchId,
|
|
690
|
+
shipmentRequestDTO
|
|
452
691
|
);
|
|
453
692
|
```
|
|
454
693
|
|
|
@@ -456,14 +695,14 @@ const { status, data } = await apiInstance.putUpdateOrder(
|
|
|
456
695
|
|
|
457
696
|
|Name | Type | Description | Notes|
|
|
458
697
|
|------------- | ------------- | ------------- | -------------|
|
|
459
|
-
| **
|
|
698
|
+
| **shipmentRequestDTO** | **ShipmentRequestDTO**| Shipment Request | |
|
|
460
699
|
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
461
|
-
| **
|
|
700
|
+
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
462
701
|
|
|
463
702
|
|
|
464
703
|
### Return type
|
|
465
704
|
|
|
466
|
-
**
|
|
705
|
+
**ShipmentDTO**
|
|
467
706
|
|
|
468
707
|
### Authorization
|
|
469
708
|
|
|
@@ -478,7 +717,602 @@ No authorization required
|
|
|
478
717
|
### HTTP response details
|
|
479
718
|
| Status code | Description | Response headers |
|
|
480
719
|
|-------------|-------------|------------------|
|
|
481
|
-
|**200** |
|
|
720
|
+
|**200** | Shipment | - |
|
|
721
|
+
|**400** | Bad Request | - |
|
|
722
|
+
|**401** | Unauthorised | - |
|
|
723
|
+
|**403** | Access Denied | - |
|
|
724
|
+
|
|
725
|
+
[[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)
|
|
726
|
+
|
|
727
|
+
# **postGetOrders**
|
|
728
|
+
> Array<OrderSummaryDTO> postGetOrders()
|
|
729
|
+
|
|
730
|
+
Create An Order (Beta)
|
|
731
|
+
|
|
732
|
+
### Example
|
|
733
|
+
|
|
734
|
+
```typescript
|
|
735
|
+
import {
|
|
736
|
+
OrdersApi,
|
|
737
|
+
Configuration,
|
|
738
|
+
CustomerOrderRequestDTO
|
|
739
|
+
} from 'yellowgrid-api-ts';
|
|
740
|
+
|
|
741
|
+
const configuration = new Configuration();
|
|
742
|
+
const apiInstance = new OrdersApi(configuration);
|
|
743
|
+
|
|
744
|
+
let readonly: boolean; //Readonly Order (optional) (default to undefined)
|
|
745
|
+
let customerOrderRequestDTO: CustomerOrderRequestDTO; //Order Request (optional)
|
|
746
|
+
|
|
747
|
+
const { status, data } = await apiInstance.postGetOrders(
|
|
748
|
+
readonly,
|
|
749
|
+
customerOrderRequestDTO
|
|
750
|
+
);
|
|
751
|
+
```
|
|
752
|
+
|
|
753
|
+
### Parameters
|
|
754
|
+
|
|
755
|
+
|Name | Type | Description | Notes|
|
|
756
|
+
|------------- | ------------- | ------------- | -------------|
|
|
757
|
+
| **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
|
|
758
|
+
| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
### Return type
|
|
762
|
+
|
|
763
|
+
**Array<OrderSummaryDTO>**
|
|
764
|
+
|
|
765
|
+
### Authorization
|
|
766
|
+
|
|
767
|
+
No authorization required
|
|
768
|
+
|
|
769
|
+
### HTTP request headers
|
|
770
|
+
|
|
771
|
+
- **Content-Type**: application/json
|
|
772
|
+
- **Accept**: application/json
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
### HTTP response details
|
|
776
|
+
| Status code | Description | Response headers |
|
|
777
|
+
|-------------|-------------|------------------|
|
|
778
|
+
|**200** | Order Summaries | - |
|
|
779
|
+
|**400** | Bad Request | - |
|
|
780
|
+
|**401** | Unauthorised | - |
|
|
781
|
+
|**403** | Access Denied | - |
|
|
782
|
+
|
|
783
|
+
[[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)
|
|
784
|
+
|
|
785
|
+
# **postIssueCredit**
|
|
786
|
+
> CreditNoteModel postIssueCredit()
|
|
787
|
+
|
|
788
|
+
Issue Credit (Admin)
|
|
789
|
+
|
|
790
|
+
### Example
|
|
791
|
+
|
|
792
|
+
```typescript
|
|
793
|
+
import {
|
|
794
|
+
OrdersApi,
|
|
795
|
+
Configuration,
|
|
796
|
+
CreditNoteDTO
|
|
797
|
+
} from 'yellowgrid-api-ts';
|
|
798
|
+
|
|
799
|
+
const configuration = new Configuration();
|
|
800
|
+
const apiInstance = new OrdersApi(configuration);
|
|
801
|
+
|
|
802
|
+
let id: number; //Order ID (default to undefined)
|
|
803
|
+
let creditNoteDTO: CreditNoteDTO; //Credit Request (optional)
|
|
804
|
+
|
|
805
|
+
const { status, data } = await apiInstance.postIssueCredit(
|
|
806
|
+
id,
|
|
807
|
+
creditNoteDTO
|
|
808
|
+
);
|
|
809
|
+
```
|
|
810
|
+
|
|
811
|
+
### Parameters
|
|
812
|
+
|
|
813
|
+
|Name | Type | Description | Notes|
|
|
814
|
+
|------------- | ------------- | ------------- | -------------|
|
|
815
|
+
| **creditNoteDTO** | **CreditNoteDTO**| Credit Request | |
|
|
816
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
### Return type
|
|
820
|
+
|
|
821
|
+
**CreditNoteModel**
|
|
822
|
+
|
|
823
|
+
### Authorization
|
|
824
|
+
|
|
825
|
+
No authorization required
|
|
826
|
+
|
|
827
|
+
### HTTP request headers
|
|
828
|
+
|
|
829
|
+
- **Content-Type**: application/json
|
|
830
|
+
- **Accept**: application/json
|
|
831
|
+
|
|
832
|
+
|
|
833
|
+
### HTTP response details
|
|
834
|
+
| Status code | Description | Response headers |
|
|
835
|
+
|-------------|-------------|------------------|
|
|
836
|
+
|**200** | Credit Note | - |
|
|
837
|
+
|**400** | Bad Request | - |
|
|
838
|
+
|**401** | Unauthorised | - |
|
|
839
|
+
|**403** | Access Denied | - |
|
|
840
|
+
|
|
841
|
+
[[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)
|
|
842
|
+
|
|
843
|
+
# **postPrintShippingLabel**
|
|
844
|
+
> File postPrintShippingLabel()
|
|
845
|
+
|
|
846
|
+
Print Shipment Label
|
|
847
|
+
|
|
848
|
+
### Example
|
|
849
|
+
|
|
850
|
+
```typescript
|
|
851
|
+
import {
|
|
852
|
+
OrdersApi,
|
|
853
|
+
Configuration
|
|
854
|
+
} from 'yellowgrid-api-ts';
|
|
855
|
+
|
|
856
|
+
const configuration = new Configuration();
|
|
857
|
+
const apiInstance = new OrdersApi(configuration);
|
|
858
|
+
|
|
859
|
+
let id: number; //Order ID (default to undefined)
|
|
860
|
+
let shipmentId: number; //Shipment ID (default to undefined)
|
|
861
|
+
let printer: 1 | 2 | 3; //Printer (default to undefined)
|
|
862
|
+
|
|
863
|
+
const { status, data } = await apiInstance.postPrintShippingLabel(
|
|
864
|
+
id,
|
|
865
|
+
shipmentId,
|
|
866
|
+
printer
|
|
867
|
+
);
|
|
868
|
+
```
|
|
869
|
+
|
|
870
|
+
### Parameters
|
|
871
|
+
|
|
872
|
+
|Name | Type | Description | Notes|
|
|
873
|
+
|------------- | ------------- | ------------- | -------------|
|
|
874
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
875
|
+
| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
|
|
876
|
+
| **printer** | [**1 | 2 | 3**]**Array<1 | 2 | 3>** | Printer | defaults to undefined|
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
### Return type
|
|
880
|
+
|
|
881
|
+
**File**
|
|
882
|
+
|
|
883
|
+
### Authorization
|
|
884
|
+
|
|
885
|
+
No authorization required
|
|
886
|
+
|
|
887
|
+
### HTTP request headers
|
|
888
|
+
|
|
889
|
+
- **Content-Type**: Not defined
|
|
890
|
+
- **Accept**: text/html, application/json
|
|
891
|
+
|
|
892
|
+
|
|
893
|
+
### HTTP response details
|
|
894
|
+
| Status code | Description | Response headers |
|
|
895
|
+
|-------------|-------------|------------------|
|
|
896
|
+
|**200** | Shipping Label | - |
|
|
897
|
+
|**400** | Bad Request | - |
|
|
898
|
+
|**401** | Unauthorised | - |
|
|
899
|
+
|**403** | Access Denied | - |
|
|
900
|
+
|
|
901
|
+
[[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)
|
|
902
|
+
|
|
903
|
+
# **postSendOrderEmail**
|
|
904
|
+
> postSendOrderEmail()
|
|
905
|
+
|
|
906
|
+
Send Order Email
|
|
907
|
+
|
|
908
|
+
### Example
|
|
909
|
+
|
|
910
|
+
```typescript
|
|
911
|
+
import {
|
|
912
|
+
OrdersApi,
|
|
913
|
+
Configuration
|
|
914
|
+
} from 'yellowgrid-api-ts';
|
|
915
|
+
|
|
916
|
+
const configuration = new Configuration();
|
|
917
|
+
const apiInstance = new OrdersApi(configuration);
|
|
918
|
+
|
|
919
|
+
let id: number; //Order ID (default to undefined)
|
|
920
|
+
let email: string; //Email Address (default to undefined)
|
|
921
|
+
|
|
922
|
+
const { status, data } = await apiInstance.postSendOrderEmail(
|
|
923
|
+
id,
|
|
924
|
+
email
|
|
925
|
+
);
|
|
926
|
+
```
|
|
927
|
+
|
|
928
|
+
### Parameters
|
|
929
|
+
|
|
930
|
+
|Name | Type | Description | Notes|
|
|
931
|
+
|------------- | ------------- | ------------- | -------------|
|
|
932
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
933
|
+
| **email** | [**string**] | Email Address | defaults to undefined|
|
|
934
|
+
|
|
935
|
+
|
|
936
|
+
### Return type
|
|
937
|
+
|
|
938
|
+
void (empty response body)
|
|
939
|
+
|
|
940
|
+
### Authorization
|
|
941
|
+
|
|
942
|
+
No authorization required
|
|
943
|
+
|
|
944
|
+
### HTTP request headers
|
|
945
|
+
|
|
946
|
+
- **Content-Type**: Not defined
|
|
947
|
+
- **Accept**: Not defined
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
### HTTP response details
|
|
951
|
+
| Status code | Description | Response headers |
|
|
952
|
+
|-------------|-------------|------------------|
|
|
953
|
+
|**200** | No Response | - |
|
|
954
|
+
|**400** | Bad Request | - |
|
|
955
|
+
|**401** | Unauthorised | - |
|
|
956
|
+
|**403** | Access Denied | - |
|
|
957
|
+
|
|
958
|
+
[[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)
|
|
959
|
+
|
|
960
|
+
# **postSendSupplierEmail**
|
|
961
|
+
> postSendSupplierEmail()
|
|
962
|
+
|
|
963
|
+
Send Supplier Email
|
|
964
|
+
|
|
965
|
+
### Example
|
|
966
|
+
|
|
967
|
+
```typescript
|
|
968
|
+
import {
|
|
969
|
+
OrdersApi,
|
|
970
|
+
Configuration
|
|
971
|
+
} from 'yellowgrid-api-ts';
|
|
972
|
+
|
|
973
|
+
const configuration = new Configuration();
|
|
974
|
+
const apiInstance = new OrdersApi(configuration);
|
|
975
|
+
|
|
976
|
+
let id: number; //Order ID (default to undefined)
|
|
977
|
+
let batchId: number; //Batch ID (default to undefined)
|
|
978
|
+
|
|
979
|
+
const { status, data } = await apiInstance.postSendSupplierEmail(
|
|
980
|
+
id,
|
|
981
|
+
batchId
|
|
982
|
+
);
|
|
983
|
+
```
|
|
984
|
+
|
|
985
|
+
### Parameters
|
|
986
|
+
|
|
987
|
+
|Name | Type | Description | Notes|
|
|
988
|
+
|------------- | ------------- | ------------- | -------------|
|
|
989
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
990
|
+
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
### Return type
|
|
994
|
+
|
|
995
|
+
void (empty response body)
|
|
996
|
+
|
|
997
|
+
### Authorization
|
|
998
|
+
|
|
999
|
+
No authorization required
|
|
1000
|
+
|
|
1001
|
+
### HTTP request headers
|
|
1002
|
+
|
|
1003
|
+
- **Content-Type**: Not defined
|
|
1004
|
+
- **Accept**: Not defined
|
|
1005
|
+
|
|
1006
|
+
|
|
1007
|
+
### HTTP response details
|
|
1008
|
+
| Status code | Description | Response headers |
|
|
1009
|
+
|-------------|-------------|------------------|
|
|
1010
|
+
|**200** | No Response | - |
|
|
1011
|
+
|**400** | Bad Request | - |
|
|
1012
|
+
|**401** | Unauthorised | - |
|
|
1013
|
+
|**403** | Access Denied | - |
|
|
1014
|
+
|
|
1015
|
+
[[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)
|
|
1016
|
+
|
|
1017
|
+
# **postSplitOrder**
|
|
1018
|
+
> Array<OrderSummaryDTO> postSplitOrder()
|
|
1019
|
+
|
|
1020
|
+
Split Order
|
|
1021
|
+
|
|
1022
|
+
### Example
|
|
1023
|
+
|
|
1024
|
+
```typescript
|
|
1025
|
+
import {
|
|
1026
|
+
OrdersApi,
|
|
1027
|
+
Configuration,
|
|
1028
|
+
PostSplitOrderRequest
|
|
1029
|
+
} from 'yellowgrid-api-ts';
|
|
1030
|
+
|
|
1031
|
+
const configuration = new Configuration();
|
|
1032
|
+
const apiInstance = new OrdersApi(configuration);
|
|
1033
|
+
|
|
1034
|
+
let id: number; //Order ID (default to undefined)
|
|
1035
|
+
let postSplitOrderRequest: PostSplitOrderRequest; // (optional)
|
|
1036
|
+
|
|
1037
|
+
const { status, data } = await apiInstance.postSplitOrder(
|
|
1038
|
+
id,
|
|
1039
|
+
postSplitOrderRequest
|
|
1040
|
+
);
|
|
1041
|
+
```
|
|
1042
|
+
|
|
1043
|
+
### Parameters
|
|
1044
|
+
|
|
1045
|
+
|Name | Type | Description | Notes|
|
|
1046
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1047
|
+
| **postSplitOrderRequest** | **PostSplitOrderRequest**| | |
|
|
1048
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1049
|
+
|
|
1050
|
+
|
|
1051
|
+
### Return type
|
|
1052
|
+
|
|
1053
|
+
**Array<OrderSummaryDTO>**
|
|
1054
|
+
|
|
1055
|
+
### Authorization
|
|
1056
|
+
|
|
1057
|
+
No authorization required
|
|
1058
|
+
|
|
1059
|
+
### HTTP request headers
|
|
1060
|
+
|
|
1061
|
+
- **Content-Type**: application/json
|
|
1062
|
+
- **Accept**: application/json
|
|
1063
|
+
|
|
1064
|
+
|
|
1065
|
+
### HTTP response details
|
|
1066
|
+
| Status code | Description | Response headers |
|
|
1067
|
+
|-------------|-------------|------------------|
|
|
1068
|
+
|**200** | Order Summaries | - |
|
|
1069
|
+
|**400** | Bad Request | - |
|
|
1070
|
+
|**401** | Unauthorised | - |
|
|
1071
|
+
|**403** | Access Denied | - |
|
|
1072
|
+
|
|
1073
|
+
[[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)
|
|
1074
|
+
|
|
1075
|
+
# **putAllocateItems**
|
|
1076
|
+
> Array<BatchDTO> putAllocateItems()
|
|
1077
|
+
|
|
1078
|
+
Allocate Items To Supplier
|
|
1079
|
+
|
|
1080
|
+
### Example
|
|
1081
|
+
|
|
1082
|
+
```typescript
|
|
1083
|
+
import {
|
|
1084
|
+
OrdersApi,
|
|
1085
|
+
Configuration,
|
|
1086
|
+
PutAllocateItemsRequest
|
|
1087
|
+
} from 'yellowgrid-api-ts';
|
|
1088
|
+
|
|
1089
|
+
const configuration = new Configuration();
|
|
1090
|
+
const apiInstance = new OrdersApi(configuration);
|
|
1091
|
+
|
|
1092
|
+
let id: number; //Order ID (default to undefined)
|
|
1093
|
+
let supplierId: number; //Supplier ID (default to undefined)
|
|
1094
|
+
let putAllocateItemsRequest: PutAllocateItemsRequest; // (optional)
|
|
1095
|
+
|
|
1096
|
+
const { status, data } = await apiInstance.putAllocateItems(
|
|
1097
|
+
id,
|
|
1098
|
+
supplierId,
|
|
1099
|
+
putAllocateItemsRequest
|
|
1100
|
+
);
|
|
1101
|
+
```
|
|
1102
|
+
|
|
1103
|
+
### Parameters
|
|
1104
|
+
|
|
1105
|
+
|Name | Type | Description | Notes|
|
|
1106
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1107
|
+
| **putAllocateItemsRequest** | **PutAllocateItemsRequest**| | |
|
|
1108
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1109
|
+
| **supplierId** | [**number**] | Supplier ID | defaults to undefined|
|
|
1110
|
+
|
|
1111
|
+
|
|
1112
|
+
### Return type
|
|
1113
|
+
|
|
1114
|
+
**Array<BatchDTO>**
|
|
1115
|
+
|
|
1116
|
+
### Authorization
|
|
1117
|
+
|
|
1118
|
+
No authorization required
|
|
1119
|
+
|
|
1120
|
+
### HTTP request headers
|
|
1121
|
+
|
|
1122
|
+
- **Content-Type**: application/json
|
|
1123
|
+
- **Accept**: application/json
|
|
1124
|
+
|
|
1125
|
+
|
|
1126
|
+
### HTTP response details
|
|
1127
|
+
| Status code | Description | Response headers |
|
|
1128
|
+
|-------------|-------------|------------------|
|
|
1129
|
+
|**200** | Order Batches | - |
|
|
1130
|
+
|**400** | Bad Request | - |
|
|
1131
|
+
|**401** | Unauthorised | - |
|
|
1132
|
+
|**403** | Access Denied | - |
|
|
1133
|
+
|
|
1134
|
+
[[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)
|
|
1135
|
+
|
|
1136
|
+
# **putUpdateAdminOrder**
|
|
1137
|
+
> Array<OrderSummaryDTO> putUpdateAdminOrder()
|
|
1138
|
+
|
|
1139
|
+
Update An Order (Admin)
|
|
1140
|
+
|
|
1141
|
+
### Example
|
|
1142
|
+
|
|
1143
|
+
```typescript
|
|
1144
|
+
import {
|
|
1145
|
+
OrdersApi,
|
|
1146
|
+
Configuration,
|
|
1147
|
+
AdminOrderRequestDTO
|
|
1148
|
+
} from 'yellowgrid-api-ts';
|
|
1149
|
+
|
|
1150
|
+
const configuration = new Configuration();
|
|
1151
|
+
const apiInstance = new OrdersApi(configuration);
|
|
1152
|
+
|
|
1153
|
+
let id: number; //Order ID (default to undefined)
|
|
1154
|
+
let readonly: boolean; //Readonly Order (optional) (default to undefined)
|
|
1155
|
+
let adminOrderRequestDTO: AdminOrderRequestDTO; //Order Request (optional)
|
|
1156
|
+
|
|
1157
|
+
const { status, data } = await apiInstance.putUpdateAdminOrder(
|
|
1158
|
+
id,
|
|
1159
|
+
readonly,
|
|
1160
|
+
adminOrderRequestDTO
|
|
1161
|
+
);
|
|
1162
|
+
```
|
|
1163
|
+
|
|
1164
|
+
### Parameters
|
|
1165
|
+
|
|
1166
|
+
|Name | Type | Description | Notes|
|
|
1167
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1168
|
+
| **adminOrderRequestDTO** | **AdminOrderRequestDTO**| Order Request | |
|
|
1169
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1170
|
+
| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
|
|
1171
|
+
|
|
1172
|
+
|
|
1173
|
+
### Return type
|
|
1174
|
+
|
|
1175
|
+
**Array<OrderSummaryDTO>**
|
|
1176
|
+
|
|
1177
|
+
### Authorization
|
|
1178
|
+
|
|
1179
|
+
No authorization required
|
|
1180
|
+
|
|
1181
|
+
### HTTP request headers
|
|
1182
|
+
|
|
1183
|
+
- **Content-Type**: application/json
|
|
1184
|
+
- **Accept**: application/json
|
|
1185
|
+
|
|
1186
|
+
|
|
1187
|
+
### HTTP response details
|
|
1188
|
+
| Status code | Description | Response headers |
|
|
1189
|
+
|-------------|-------------|------------------|
|
|
1190
|
+
|**200** | Order Summaries | - |
|
|
1191
|
+
|**400** | Bad Request | - |
|
|
1192
|
+
|**401** | Unauthorised | - |
|
|
1193
|
+
|**403** | Access Denied | - |
|
|
1194
|
+
|
|
1195
|
+
[[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)
|
|
1196
|
+
|
|
1197
|
+
# **putUpdateOrder**
|
|
1198
|
+
> Array<OrderSummaryDTO> putUpdateOrder()
|
|
1199
|
+
|
|
1200
|
+
Update An Order (Beta)
|
|
1201
|
+
|
|
1202
|
+
### Example
|
|
1203
|
+
|
|
1204
|
+
```typescript
|
|
1205
|
+
import {
|
|
1206
|
+
OrdersApi,
|
|
1207
|
+
Configuration,
|
|
1208
|
+
CustomerOrderRequestDTO
|
|
1209
|
+
} from 'yellowgrid-api-ts';
|
|
1210
|
+
|
|
1211
|
+
const configuration = new Configuration();
|
|
1212
|
+
const apiInstance = new OrdersApi(configuration);
|
|
1213
|
+
|
|
1214
|
+
let id: number; //Order ID (default to undefined)
|
|
1215
|
+
let readonly: boolean; //Readonly Order (optional) (default to undefined)
|
|
1216
|
+
let customerOrderRequestDTO: CustomerOrderRequestDTO; //Order Request (optional)
|
|
1217
|
+
|
|
1218
|
+
const { status, data } = await apiInstance.putUpdateOrder(
|
|
1219
|
+
id,
|
|
1220
|
+
readonly,
|
|
1221
|
+
customerOrderRequestDTO
|
|
1222
|
+
);
|
|
1223
|
+
```
|
|
1224
|
+
|
|
1225
|
+
### Parameters
|
|
1226
|
+
|
|
1227
|
+
|Name | Type | Description | Notes|
|
|
1228
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1229
|
+
| **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
|
|
1230
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1231
|
+
| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
### Return type
|
|
1235
|
+
|
|
1236
|
+
**Array<OrderSummaryDTO>**
|
|
1237
|
+
|
|
1238
|
+
### Authorization
|
|
1239
|
+
|
|
1240
|
+
No authorization required
|
|
1241
|
+
|
|
1242
|
+
### HTTP request headers
|
|
1243
|
+
|
|
1244
|
+
- **Content-Type**: application/json
|
|
1245
|
+
- **Accept**: application/json
|
|
1246
|
+
|
|
1247
|
+
|
|
1248
|
+
### HTTP response details
|
|
1249
|
+
| Status code | Description | Response headers |
|
|
1250
|
+
|-------------|-------------|------------------|
|
|
1251
|
+
|**200** | Order Summaries | - |
|
|
1252
|
+
|**400** | Bad Request | - |
|
|
1253
|
+
|**401** | Unauthorised | - |
|
|
1254
|
+
|**403** | Access Denied | - |
|
|
1255
|
+
|
|
1256
|
+
[[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)
|
|
1257
|
+
|
|
1258
|
+
# **putUpdateShipment**
|
|
1259
|
+
> ShipmentModel putUpdateShipment()
|
|
1260
|
+
|
|
1261
|
+
Update Shipment (Admin)
|
|
1262
|
+
|
|
1263
|
+
### Example
|
|
1264
|
+
|
|
1265
|
+
```typescript
|
|
1266
|
+
import {
|
|
1267
|
+
OrdersApi,
|
|
1268
|
+
Configuration,
|
|
1269
|
+
ShipmentRequestDTO
|
|
1270
|
+
} from 'yellowgrid-api-ts';
|
|
1271
|
+
|
|
1272
|
+
const configuration = new Configuration();
|
|
1273
|
+
const apiInstance = new OrdersApi(configuration);
|
|
1274
|
+
|
|
1275
|
+
let id: number; //Order ID (default to undefined)
|
|
1276
|
+
let batchId: number; //Batch ID (default to undefined)
|
|
1277
|
+
let shipmentId: number; //Shipment ID (default to undefined)
|
|
1278
|
+
let shipmentRequestDTO: ShipmentRequestDTO; //Shipment Request (optional)
|
|
1279
|
+
|
|
1280
|
+
const { status, data } = await apiInstance.putUpdateShipment(
|
|
1281
|
+
id,
|
|
1282
|
+
batchId,
|
|
1283
|
+
shipmentId,
|
|
1284
|
+
shipmentRequestDTO
|
|
1285
|
+
);
|
|
1286
|
+
```
|
|
1287
|
+
|
|
1288
|
+
### Parameters
|
|
1289
|
+
|
|
1290
|
+
|Name | Type | Description | Notes|
|
|
1291
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1292
|
+
| **shipmentRequestDTO** | **ShipmentRequestDTO**| Shipment Request | |
|
|
1293
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1294
|
+
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
1295
|
+
| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
|
|
1296
|
+
|
|
1297
|
+
|
|
1298
|
+
### Return type
|
|
1299
|
+
|
|
1300
|
+
**ShipmentModel**
|
|
1301
|
+
|
|
1302
|
+
### Authorization
|
|
1303
|
+
|
|
1304
|
+
No authorization required
|
|
1305
|
+
|
|
1306
|
+
### HTTP request headers
|
|
1307
|
+
|
|
1308
|
+
- **Content-Type**: application/json
|
|
1309
|
+
- **Accept**: application/json
|
|
1310
|
+
|
|
1311
|
+
|
|
1312
|
+
### HTTP response details
|
|
1313
|
+
| Status code | Description | Response headers |
|
|
1314
|
+
|-------------|-------------|------------------|
|
|
1315
|
+
|**200** | Shipment | - |
|
|
482
1316
|
|**400** | Bad Request | - |
|
|
483
1317
|
|**401** | Unauthorised | - |
|
|
484
1318
|
|**403** | Access Denied | - |
|