yellowgrid-api-ts 3.2.100-dev.0 → 3.2.100
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 +33 -1
- package/.openapi-generator/VERSION +1 -1
- package/.openapi-generator-ignore +0 -0
- package/README.md +69 -2
- package/api.ts +4985 -1230
- package/base.ts +2 -2
- package/common.ts +1 -1
- package/config.json +3 -3
- package/configuration.ts +1 -1
- package/dist/api.d.ts +2544 -198
- package/dist/api.js +4531 -1252
- package/dist/base.d.ts +1 -1
- package/dist/base.js +2 -2
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/CourierEnum.d.ts +0 -0
- package/dist/models/CourierEnum.js +0 -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 +0 -0
- package/dist/models/PrinterEnum.js +0 -0
- package/dist/models/ScheduledTaskEnum.d.ts +33 -0
- package/dist/models/ScheduledTaskEnum.js +35 -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 +4 -0
- 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 +348 -5
- 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/CreditNoteItemModel.md +29 -0
- package/docs/CreditNoteModel.md +31 -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/InstallationDetailsDTO.md +39 -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/NumberPortNoteDTO.md +0 -0
- package/docs/NumberPortRangeDTO.md +0 -0
- package/docs/NumberPortRangeRequestDTO.md +0 -0
- package/docs/NumberPortingApi.md +61 -6
- package/docs/NumberPortsModel.md +0 -0
- package/docs/OAuth20Api.md +4 -4
- package/docs/OfflineInstancesEntity.md +0 -0
- package/docs/OrderDetailsDTO.md +65 -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 +1384 -75
- 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/PostAddAdminNoteRequest.md +20 -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 +2 -0
- package/docs/ProductsApi.md +59 -1
- package/docs/PromoCodesEntity.md +0 -0
- package/docs/PromoItemsEntity.md +0 -0
- package/docs/ProspectDTO.md +33 -0
- package/docs/ProspectEntity.md +41 -0
- package/docs/ProspectsApi.md +226 -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/RemoteStorageDTO.md +27 -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 +57 -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 +41 -0
- package/docs/ShipmentEntity.md +0 -0
- package/docs/ShipmentItemDTO.md +23 -0
- package/docs/ShipmentItemEntity.md +1 -1
- 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 +28 -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/SmsAccountDTO.md +31 -0
- package/docs/SmsAccountEntity.md +0 -0
- package/docs/SmsAccountRequestDTO.md +29 -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/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 +4 -0
- package/docs/TcxSbcEntity.md +0 -0
- package/docs/TcxSbcModel.md +0 -0
- package/docs/TcxSbcResponseDTO.md +23 -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/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 +31 -31
- package/git_push.sh +0 -0
- package/index.ts +1 -1
- package/models/CourierEnum.ts +0 -0
- package/models/EventStatusEnum.ts +0 -0
- package/models/EventTypeEnum.ts +0 -0
- package/models/PortStatusEnum.ts +0 -0
- package/models/PrinterEnum.ts +0 -0
- package/models/ScheduledTaskEnum.ts +34 -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 +1 -1
- 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/TcxInstallationDetailsModel.md +0 -45
package/docs/OrdersApi.md
CHANGED
|
@@ -1,22 +1,1143 @@
|
|
|
1
1
|
# OrdersApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://
|
|
3
|
+
All URIs are relative to *https://bitbucket.org*
|
|
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)|
|
|
12
|
+
|[**getGetCommercialInvoice**](#getgetcommercialinvoice) | **GET** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/pdf | Get Commercial Invoice PDF|
|
|
9
13
|
|[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)|
|
|
14
|
+
|[**getGetItemSerialInfo**](#getgetitemserialinfo) | **GET** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)|
|
|
15
|
+
|[**getGetOrderPdf**](#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF|
|
|
16
|
+
|[**getGetOrderSummary**](#getgetordersummary) | **GET** /admin/orders/{id}/summary | Get Order Summary (Admin)|
|
|
10
17
|
|[**getGetOrders**](#getgetorders) | **GET** /orders | Get Orders (Beta)|
|
|
18
|
+
|[**patchCompleteOrder**](#patchcompleteorder) | **PATCH** /admin/orders/{id}/complete | Mark Order As Complete (Admin)|
|
|
19
|
+
|[**postAddOrderNote**](#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note|
|
|
11
20
|
|[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
|
|
21
|
+
|[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
|
|
22
|
+
|[**postCreateShipment**](#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)|
|
|
12
23
|
|[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
|
|
24
|
+
|[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
|
|
25
|
+
|[**postPrintShippingLabel**](#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label|
|
|
26
|
+
|[**postProcessTcxLicences**](#postprocesstcxlicences) | **POST** /admin/orders/{id}/batches/{batch_id}/licences/process | Process 3CX Licences (Admin)|
|
|
27
|
+
|[**postSendOrderEmail**](#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email|
|
|
28
|
+
|[**postSendShipmentEmail**](#postsendshipmentemail) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/send/email | Send Shipment Email (Admin)|
|
|
29
|
+
|[**postSendSupplierEmail**](#postsendsupplieremail) | **POST** /admin/orders/{id}/batches/{batch_id}/email/send | Send Supplier Email|
|
|
30
|
+
|[**postSplitOrder**](#postsplitorder) | **POST** /admin/orders/{id}/split | Split Order|
|
|
31
|
+
|[**putAllocateItems**](#putallocateitems) | **PUT** /admin/orders/{id}/items/allocate | Allocate Items To Supplier|
|
|
13
32
|
|[**putUpdateAdminOrder**](#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)|
|
|
33
|
+
|[**putUpdateBatchItem**](#putupdatebatchitem) | **PUT** /admin/orders/{id}/batches/{batch_id}/items/{item_id} | Update Batch Item (Admin)|
|
|
14
34
|
|[**putUpdateOrder**](#putupdateorder) | **PUT** /orders/{id} | Update An Order (Beta)|
|
|
35
|
+
|[**putUpdatePaymentStatus**](#putupdatepaymentstatus) | **PUT** /admin/orders/{id}/paid | Change Payment Status (Admin)|
|
|
36
|
+
|[**putUpdateShipment**](#putupdateshipment) | **PUT** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Update Shipment (Admin)|
|
|
37
|
+
|
|
38
|
+
# **deleteDeleteBatch**
|
|
39
|
+
> deleteDeleteBatch()
|
|
40
|
+
|
|
41
|
+
Delete Batch (Admin)
|
|
42
|
+
|
|
43
|
+
### Example
|
|
44
|
+
|
|
45
|
+
```typescript
|
|
46
|
+
import {
|
|
47
|
+
OrdersApi,
|
|
48
|
+
Configuration
|
|
49
|
+
} from 'yellowgrid-api-ts';
|
|
50
|
+
|
|
51
|
+
const configuration = new Configuration();
|
|
52
|
+
const apiInstance = new OrdersApi(configuration);
|
|
53
|
+
|
|
54
|
+
let id: number; //Order ID (default to undefined)
|
|
55
|
+
let batchId: number; //Batch ID (default to undefined)
|
|
56
|
+
|
|
57
|
+
const { status, data } = await apiInstance.deleteDeleteBatch(
|
|
58
|
+
id,
|
|
59
|
+
batchId
|
|
60
|
+
);
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Parameters
|
|
64
|
+
|
|
65
|
+
|Name | Type | Description | Notes|
|
|
66
|
+
|------------- | ------------- | ------------- | -------------|
|
|
67
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
68
|
+
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
### Return type
|
|
72
|
+
|
|
73
|
+
void (empty response body)
|
|
74
|
+
|
|
75
|
+
### Authorization
|
|
76
|
+
|
|
77
|
+
No authorization required
|
|
78
|
+
|
|
79
|
+
### HTTP request headers
|
|
80
|
+
|
|
81
|
+
- **Content-Type**: Not defined
|
|
82
|
+
- **Accept**: Not defined
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
### HTTP response details
|
|
86
|
+
| Status code | Description | Response headers |
|
|
87
|
+
|-------------|-------------|------------------|
|
|
88
|
+
|**200** | No Response | - |
|
|
89
|
+
|**400** | Bad Request | - |
|
|
90
|
+
|**401** | Unauthorised | - |
|
|
91
|
+
|**403** | Access Denied | - |
|
|
92
|
+
|
|
93
|
+
[[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
94
|
|
|
16
95
|
# **deleteUpdateOrder**
|
|
17
96
|
> deleteUpdateOrder()
|
|
18
97
|
|
|
19
|
-
Delete Orders (Beta)
|
|
98
|
+
Delete Orders (Beta)
|
|
99
|
+
|
|
100
|
+
### Example
|
|
101
|
+
|
|
102
|
+
```typescript
|
|
103
|
+
import {
|
|
104
|
+
OrdersApi,
|
|
105
|
+
Configuration
|
|
106
|
+
} from 'yellowgrid-api-ts';
|
|
107
|
+
|
|
108
|
+
const configuration = new Configuration();
|
|
109
|
+
const apiInstance = new OrdersApi(configuration);
|
|
110
|
+
|
|
111
|
+
let id: number; //Order ID (default to undefined)
|
|
112
|
+
|
|
113
|
+
const { status, data } = await apiInstance.deleteUpdateOrder(
|
|
114
|
+
id
|
|
115
|
+
);
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
### Parameters
|
|
119
|
+
|
|
120
|
+
|Name | Type | Description | Notes|
|
|
121
|
+
|------------- | ------------- | ------------- | -------------|
|
|
122
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
### Return type
|
|
126
|
+
|
|
127
|
+
void (empty response body)
|
|
128
|
+
|
|
129
|
+
### Authorization
|
|
130
|
+
|
|
131
|
+
No authorization required
|
|
132
|
+
|
|
133
|
+
### HTTP request headers
|
|
134
|
+
|
|
135
|
+
- **Content-Type**: Not defined
|
|
136
|
+
- **Accept**: Not defined
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
### HTTP response details
|
|
140
|
+
| Status code | Description | Response headers |
|
|
141
|
+
|-------------|-------------|------------------|
|
|
142
|
+
|**200** | No Response | - |
|
|
143
|
+
|**400** | Bad Request | - |
|
|
144
|
+
|**401** | Unauthorised | - |
|
|
145
|
+
|**403** | Access Denied | - |
|
|
146
|
+
|
|
147
|
+
[[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)
|
|
148
|
+
|
|
149
|
+
# **deleteUpdateShipment**
|
|
150
|
+
> deleteUpdateShipment()
|
|
151
|
+
|
|
152
|
+
Delete Shipment (Admin)
|
|
153
|
+
|
|
154
|
+
### Example
|
|
155
|
+
|
|
156
|
+
```typescript
|
|
157
|
+
import {
|
|
158
|
+
OrdersApi,
|
|
159
|
+
Configuration
|
|
160
|
+
} from 'yellowgrid-api-ts';
|
|
161
|
+
|
|
162
|
+
const configuration = new Configuration();
|
|
163
|
+
const apiInstance = new OrdersApi(configuration);
|
|
164
|
+
|
|
165
|
+
let id: number; //Order ID (default to undefined)
|
|
166
|
+
let batchId: number; //Batch ID (default to undefined)
|
|
167
|
+
let shipmentId: number; //Shipment ID (default to undefined)
|
|
168
|
+
|
|
169
|
+
const { status, data } = await apiInstance.deleteUpdateShipment(
|
|
170
|
+
id,
|
|
171
|
+
batchId,
|
|
172
|
+
shipmentId
|
|
173
|
+
);
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
### Parameters
|
|
177
|
+
|
|
178
|
+
|Name | Type | Description | Notes|
|
|
179
|
+
|------------- | ------------- | ------------- | -------------|
|
|
180
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
181
|
+
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
182
|
+
| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
### Return type
|
|
186
|
+
|
|
187
|
+
void (empty response body)
|
|
188
|
+
|
|
189
|
+
### Authorization
|
|
190
|
+
|
|
191
|
+
No authorization required
|
|
192
|
+
|
|
193
|
+
### HTTP request headers
|
|
194
|
+
|
|
195
|
+
- **Content-Type**: Not defined
|
|
196
|
+
- **Accept**: Not defined
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
### HTTP response details
|
|
200
|
+
| Status code | Description | Response headers |
|
|
201
|
+
|-------------|-------------|------------------|
|
|
202
|
+
|**200** | No Response | - |
|
|
203
|
+
|**400** | Bad Request | - |
|
|
204
|
+
|**401** | Unauthorised | - |
|
|
205
|
+
|**403** | Access Denied | - |
|
|
206
|
+
|
|
207
|
+
[[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)
|
|
208
|
+
|
|
209
|
+
# **getGetAdminEditableOrder**
|
|
210
|
+
> AdminOrderRequestDTO getGetAdminEditableOrder()
|
|
211
|
+
|
|
212
|
+
Get Editable Order (Admin)
|
|
213
|
+
|
|
214
|
+
### Example
|
|
215
|
+
|
|
216
|
+
```typescript
|
|
217
|
+
import {
|
|
218
|
+
OrdersApi,
|
|
219
|
+
Configuration
|
|
220
|
+
} from 'yellowgrid-api-ts';
|
|
221
|
+
|
|
222
|
+
const configuration = new Configuration();
|
|
223
|
+
const apiInstance = new OrdersApi(configuration);
|
|
224
|
+
|
|
225
|
+
let id: number; //Order ID (default to undefined)
|
|
226
|
+
|
|
227
|
+
const { status, data } = await apiInstance.getGetAdminEditableOrder(
|
|
228
|
+
id
|
|
229
|
+
);
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
### Parameters
|
|
233
|
+
|
|
234
|
+
|Name | Type | Description | Notes|
|
|
235
|
+
|------------- | ------------- | ------------- | -------------|
|
|
236
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
### Return type
|
|
240
|
+
|
|
241
|
+
**AdminOrderRequestDTO**
|
|
242
|
+
|
|
243
|
+
### Authorization
|
|
244
|
+
|
|
245
|
+
No authorization required
|
|
246
|
+
|
|
247
|
+
### HTTP request headers
|
|
248
|
+
|
|
249
|
+
- **Content-Type**: Not defined
|
|
250
|
+
- **Accept**: application/json
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
### HTTP response details
|
|
254
|
+
| Status code | Description | Response headers |
|
|
255
|
+
|-------------|-------------|------------------|
|
|
256
|
+
|**200** | Order Request | - |
|
|
257
|
+
|**400** | Bad Request | - |
|
|
258
|
+
|**401** | Unauthorised | - |
|
|
259
|
+
|**403** | Access Denied | - |
|
|
260
|
+
|
|
261
|
+
[[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)
|
|
262
|
+
|
|
263
|
+
# **getGetAdminOrderDetails**
|
|
264
|
+
> OrderDetailsDTO getGetAdminOrderDetails()
|
|
265
|
+
|
|
266
|
+
Get Order Details (Admin)
|
|
267
|
+
|
|
268
|
+
### Example
|
|
269
|
+
|
|
270
|
+
```typescript
|
|
271
|
+
import {
|
|
272
|
+
OrdersApi,
|
|
273
|
+
Configuration
|
|
274
|
+
} from 'yellowgrid-api-ts';
|
|
275
|
+
|
|
276
|
+
const configuration = new Configuration();
|
|
277
|
+
const apiInstance = new OrdersApi(configuration);
|
|
278
|
+
|
|
279
|
+
let id: number; //Order ID (default to undefined)
|
|
280
|
+
|
|
281
|
+
const { status, data } = await apiInstance.getGetAdminOrderDetails(
|
|
282
|
+
id
|
|
283
|
+
);
|
|
284
|
+
```
|
|
285
|
+
|
|
286
|
+
### Parameters
|
|
287
|
+
|
|
288
|
+
|Name | Type | Description | Notes|
|
|
289
|
+
|------------- | ------------- | ------------- | -------------|
|
|
290
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
### Return type
|
|
294
|
+
|
|
295
|
+
**OrderDetailsDTO**
|
|
296
|
+
|
|
297
|
+
### Authorization
|
|
298
|
+
|
|
299
|
+
No authorization required
|
|
300
|
+
|
|
301
|
+
### HTTP request headers
|
|
302
|
+
|
|
303
|
+
- **Content-Type**: Not defined
|
|
304
|
+
- **Accept**: application/json
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
### HTTP response details
|
|
308
|
+
| Status code | Description | Response headers |
|
|
309
|
+
|-------------|-------------|------------------|
|
|
310
|
+
|**200** | Order Details | - |
|
|
311
|
+
|**400** | Bad Request | - |
|
|
312
|
+
|**401** | Unauthorised | - |
|
|
313
|
+
|**403** | Access Denied | - |
|
|
314
|
+
|
|
315
|
+
[[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)
|
|
316
|
+
|
|
317
|
+
# **getGetCommercialInvoice**
|
|
318
|
+
> File getGetCommercialInvoice()
|
|
319
|
+
|
|
320
|
+
Get Commercial Invoice PDF
|
|
321
|
+
|
|
322
|
+
### Example
|
|
323
|
+
|
|
324
|
+
```typescript
|
|
325
|
+
import {
|
|
326
|
+
OrdersApi,
|
|
327
|
+
Configuration
|
|
328
|
+
} from 'yellowgrid-api-ts';
|
|
329
|
+
|
|
330
|
+
const configuration = new Configuration();
|
|
331
|
+
const apiInstance = new OrdersApi(configuration);
|
|
332
|
+
|
|
333
|
+
let id: number; //Order ID (default to undefined)
|
|
334
|
+
let batchId: number; //Batch ID (default to undefined)
|
|
335
|
+
let shipmentId: number; //Shipment ID (default to undefined)
|
|
336
|
+
|
|
337
|
+
const { status, data } = await apiInstance.getGetCommercialInvoice(
|
|
338
|
+
id,
|
|
339
|
+
batchId,
|
|
340
|
+
shipmentId
|
|
341
|
+
);
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
### Parameters
|
|
345
|
+
|
|
346
|
+
|Name | Type | Description | Notes|
|
|
347
|
+
|------------- | ------------- | ------------- | -------------|
|
|
348
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
349
|
+
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
350
|
+
| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
### Return type
|
|
354
|
+
|
|
355
|
+
**File**
|
|
356
|
+
|
|
357
|
+
### Authorization
|
|
358
|
+
|
|
359
|
+
No authorization required
|
|
360
|
+
|
|
361
|
+
### HTTP request headers
|
|
362
|
+
|
|
363
|
+
- **Content-Type**: Not defined
|
|
364
|
+
- **Accept**: application/pdf
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
### HTTP response details
|
|
368
|
+
| Status code | Description | Response headers |
|
|
369
|
+
|-------------|-------------|------------------|
|
|
370
|
+
|**200** | Order PDF | - |
|
|
371
|
+
|**400** | Bad Request | - |
|
|
372
|
+
|**401** | Unauthorised | - |
|
|
373
|
+
|**403** | Access Denied | - |
|
|
374
|
+
|
|
375
|
+
[[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)
|
|
376
|
+
|
|
377
|
+
# **getGetEditableOrder**
|
|
378
|
+
> DetailedOrderRequestDTO getGetEditableOrder()
|
|
379
|
+
|
|
380
|
+
Get Editable Order (Beta)
|
|
381
|
+
|
|
382
|
+
### Example
|
|
383
|
+
|
|
384
|
+
```typescript
|
|
385
|
+
import {
|
|
386
|
+
OrdersApi,
|
|
387
|
+
Configuration
|
|
388
|
+
} from 'yellowgrid-api-ts';
|
|
389
|
+
|
|
390
|
+
const configuration = new Configuration();
|
|
391
|
+
const apiInstance = new OrdersApi(configuration);
|
|
392
|
+
|
|
393
|
+
let id: number; //Order ID (default to undefined)
|
|
394
|
+
|
|
395
|
+
const { status, data } = await apiInstance.getGetEditableOrder(
|
|
396
|
+
id
|
|
397
|
+
);
|
|
398
|
+
```
|
|
399
|
+
|
|
400
|
+
### Parameters
|
|
401
|
+
|
|
402
|
+
|Name | Type | Description | Notes|
|
|
403
|
+
|------------- | ------------- | ------------- | -------------|
|
|
404
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
### Return type
|
|
408
|
+
|
|
409
|
+
**DetailedOrderRequestDTO**
|
|
410
|
+
|
|
411
|
+
### Authorization
|
|
412
|
+
|
|
413
|
+
No authorization required
|
|
414
|
+
|
|
415
|
+
### HTTP request headers
|
|
416
|
+
|
|
417
|
+
- **Content-Type**: Not defined
|
|
418
|
+
- **Accept**: application/json
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
### HTTP response details
|
|
422
|
+
| Status code | Description | Response headers |
|
|
423
|
+
|-------------|-------------|------------------|
|
|
424
|
+
|**200** | Order Request | - |
|
|
425
|
+
|**400** | Bad Request | - |
|
|
426
|
+
|**401** | Unauthorised | - |
|
|
427
|
+
|**403** | Access Denied | - |
|
|
428
|
+
|
|
429
|
+
[[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)
|
|
430
|
+
|
|
431
|
+
# **getGetItemSerialInfo**
|
|
432
|
+
> ProductSerialInfoModel getGetItemSerialInfo()
|
|
433
|
+
|
|
434
|
+
Get Item Serial Info (Admin)
|
|
435
|
+
|
|
436
|
+
### Example
|
|
437
|
+
|
|
438
|
+
```typescript
|
|
439
|
+
import {
|
|
440
|
+
OrdersApi,
|
|
441
|
+
Configuration
|
|
442
|
+
} from 'yellowgrid-api-ts';
|
|
443
|
+
|
|
444
|
+
const configuration = new Configuration();
|
|
445
|
+
const apiInstance = new OrdersApi(configuration);
|
|
446
|
+
|
|
447
|
+
let id: number; //Order ID (default to undefined)
|
|
448
|
+
let itemId: number; //Shipment Item ID (default to undefined)
|
|
449
|
+
|
|
450
|
+
const { status, data } = await apiInstance.getGetItemSerialInfo(
|
|
451
|
+
id,
|
|
452
|
+
itemId
|
|
453
|
+
);
|
|
454
|
+
```
|
|
455
|
+
|
|
456
|
+
### Parameters
|
|
457
|
+
|
|
458
|
+
|Name | Type | Description | Notes|
|
|
459
|
+
|------------- | ------------- | ------------- | -------------|
|
|
460
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
461
|
+
| **itemId** | [**number**] | Shipment Item ID | defaults to undefined|
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
### Return type
|
|
465
|
+
|
|
466
|
+
**ProductSerialInfoModel**
|
|
467
|
+
|
|
468
|
+
### Authorization
|
|
469
|
+
|
|
470
|
+
No authorization required
|
|
471
|
+
|
|
472
|
+
### HTTP request headers
|
|
473
|
+
|
|
474
|
+
- **Content-Type**: Not defined
|
|
475
|
+
- **Accept**: application/json
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
### HTTP response details
|
|
479
|
+
| Status code | Description | Response headers |
|
|
480
|
+
|-------------|-------------|------------------|
|
|
481
|
+
|**200** | Serial Info | - |
|
|
482
|
+
|**400** | Bad Request | - |
|
|
483
|
+
|**401** | Unauthorised | - |
|
|
484
|
+
|**403** | Access Denied | - |
|
|
485
|
+
|
|
486
|
+
[[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)
|
|
487
|
+
|
|
488
|
+
# **getGetOrderPdf**
|
|
489
|
+
> File getGetOrderPdf()
|
|
490
|
+
|
|
491
|
+
Download Order PDF
|
|
492
|
+
|
|
493
|
+
### Example
|
|
494
|
+
|
|
495
|
+
```typescript
|
|
496
|
+
import {
|
|
497
|
+
OrdersApi,
|
|
498
|
+
Configuration
|
|
499
|
+
} from 'yellowgrid-api-ts';
|
|
500
|
+
|
|
501
|
+
const configuration = new Configuration();
|
|
502
|
+
const apiInstance = new OrdersApi(configuration);
|
|
503
|
+
|
|
504
|
+
let id: number; //Order ID (default to undefined)
|
|
505
|
+
|
|
506
|
+
const { status, data } = await apiInstance.getGetOrderPdf(
|
|
507
|
+
id
|
|
508
|
+
);
|
|
509
|
+
```
|
|
510
|
+
|
|
511
|
+
### Parameters
|
|
512
|
+
|
|
513
|
+
|Name | Type | Description | Notes|
|
|
514
|
+
|------------- | ------------- | ------------- | -------------|
|
|
515
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
### Return type
|
|
519
|
+
|
|
520
|
+
**File**
|
|
521
|
+
|
|
522
|
+
### Authorization
|
|
523
|
+
|
|
524
|
+
No authorization required
|
|
525
|
+
|
|
526
|
+
### HTTP request headers
|
|
527
|
+
|
|
528
|
+
- **Content-Type**: Not defined
|
|
529
|
+
- **Accept**: application/pdf
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
### HTTP response details
|
|
533
|
+
| Status code | Description | Response headers |
|
|
534
|
+
|-------------|-------------|------------------|
|
|
535
|
+
|**200** | Order PDF | - |
|
|
536
|
+
|**400** | Bad Request | - |
|
|
537
|
+
|**401** | Unauthorised | - |
|
|
538
|
+
|**403** | Access Denied | - |
|
|
539
|
+
|
|
540
|
+
[[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)
|
|
541
|
+
|
|
542
|
+
# **getGetOrderSummary**
|
|
543
|
+
> OrderSummaryDTO getGetOrderSummary()
|
|
544
|
+
|
|
545
|
+
Get Order Summary (Admin)
|
|
546
|
+
|
|
547
|
+
### Example
|
|
548
|
+
|
|
549
|
+
```typescript
|
|
550
|
+
import {
|
|
551
|
+
OrdersApi,
|
|
552
|
+
Configuration
|
|
553
|
+
} from 'yellowgrid-api-ts';
|
|
554
|
+
|
|
555
|
+
const configuration = new Configuration();
|
|
556
|
+
const apiInstance = new OrdersApi(configuration);
|
|
557
|
+
|
|
558
|
+
let id: number; //Order ID (default to undefined)
|
|
559
|
+
|
|
560
|
+
const { status, data } = await apiInstance.getGetOrderSummary(
|
|
561
|
+
id
|
|
562
|
+
);
|
|
563
|
+
```
|
|
564
|
+
|
|
565
|
+
### Parameters
|
|
566
|
+
|
|
567
|
+
|Name | Type | Description | Notes|
|
|
568
|
+
|------------- | ------------- | ------------- | -------------|
|
|
569
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
### Return type
|
|
573
|
+
|
|
574
|
+
**OrderSummaryDTO**
|
|
575
|
+
|
|
576
|
+
### Authorization
|
|
577
|
+
|
|
578
|
+
No authorization required
|
|
579
|
+
|
|
580
|
+
### HTTP request headers
|
|
581
|
+
|
|
582
|
+
- **Content-Type**: Not defined
|
|
583
|
+
- **Accept**: application/json
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
### HTTP response details
|
|
587
|
+
| Status code | Description | Response headers |
|
|
588
|
+
|-------------|-------------|------------------|
|
|
589
|
+
|**200** | Order Summary | - |
|
|
590
|
+
|**400** | Bad Request | - |
|
|
591
|
+
|**401** | Unauthorised | - |
|
|
592
|
+
|**403** | Access Denied | - |
|
|
593
|
+
|
|
594
|
+
[[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)
|
|
595
|
+
|
|
596
|
+
# **getGetOrders**
|
|
597
|
+
> OrderSummariesModel getGetOrders()
|
|
598
|
+
|
|
599
|
+
Get Orders (Beta)
|
|
600
|
+
|
|
601
|
+
### Example
|
|
602
|
+
|
|
603
|
+
```typescript
|
|
604
|
+
import {
|
|
605
|
+
OrdersApi,
|
|
606
|
+
Configuration
|
|
607
|
+
} from 'yellowgrid-api-ts';
|
|
608
|
+
|
|
609
|
+
const configuration = new Configuration();
|
|
610
|
+
const apiInstance = new OrdersApi(configuration);
|
|
611
|
+
|
|
612
|
+
let pageSize: number; //Number Of Results (optional) (default to 20)
|
|
613
|
+
let page: number; //Page Number (optional) (default to 1)
|
|
614
|
+
let search: string; //Search (optional) (default to undefined)
|
|
615
|
+
let fulfillable: boolean; //Fulfillable (optional) (default to undefined)
|
|
616
|
+
let status: 'PAID' | 'INVOICE_PAID' | 'UNPAID' | 'QUOTE'; //Status (optional) (default to undefined)
|
|
617
|
+
let filter: 'OUTSTANDING' | 'QUOTES' | 'ALL' | 'BACK_ORDERS'; //Filter (optional) (default to undefined)
|
|
618
|
+
let customerId: number; //Customer ID (optional) (default to undefined)
|
|
619
|
+
|
|
620
|
+
const { status, data } = await apiInstance.getGetOrders(
|
|
621
|
+
pageSize,
|
|
622
|
+
page,
|
|
623
|
+
search,
|
|
624
|
+
fulfillable,
|
|
625
|
+
status,
|
|
626
|
+
filter,
|
|
627
|
+
customerId
|
|
628
|
+
);
|
|
629
|
+
```
|
|
630
|
+
|
|
631
|
+
### Parameters
|
|
632
|
+
|
|
633
|
+
|Name | Type | Description | Notes|
|
|
634
|
+
|------------- | ------------- | ------------- | -------------|
|
|
635
|
+
| **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
|
|
636
|
+
| **page** | [**number**] | Page Number | (optional) defaults to 1|
|
|
637
|
+
| **search** | [**string**] | Search | (optional) defaults to undefined|
|
|
638
|
+
| **fulfillable** | [**boolean**] | Fulfillable | (optional) defaults to undefined|
|
|
639
|
+
| **status** | [**'PAID' | 'INVOICE_PAID' | 'UNPAID' | 'QUOTE'**]**Array<'PAID' | 'INVOICE_PAID' | 'UNPAID' | 'QUOTE'>** | Status | (optional) defaults to undefined|
|
|
640
|
+
| **filter** | [**'OUTSTANDING' | 'QUOTES' | 'ALL' | 'BACK_ORDERS'**]**Array<'OUTSTANDING' | 'QUOTES' | 'ALL' | 'BACK_ORDERS'>** | Filter | (optional) defaults to undefined|
|
|
641
|
+
| **customerId** | [**number**] | Customer ID | (optional) defaults to undefined|
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
### Return type
|
|
645
|
+
|
|
646
|
+
**OrderSummariesModel**
|
|
647
|
+
|
|
648
|
+
### Authorization
|
|
649
|
+
|
|
650
|
+
No authorization required
|
|
651
|
+
|
|
652
|
+
### HTTP request headers
|
|
653
|
+
|
|
654
|
+
- **Content-Type**: Not defined
|
|
655
|
+
- **Accept**: application/json
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
### HTTP response details
|
|
659
|
+
| Status code | Description | Response headers |
|
|
660
|
+
|-------------|-------------|------------------|
|
|
661
|
+
|**200** | Order Summaries | - |
|
|
662
|
+
|**400** | Bad Request | - |
|
|
663
|
+
|**401** | Unauthorised | - |
|
|
664
|
+
|**403** | Access Denied | - |
|
|
665
|
+
|
|
666
|
+
[[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)
|
|
667
|
+
|
|
668
|
+
# **patchCompleteOrder**
|
|
669
|
+
> OrderDetailsDTO patchCompleteOrder()
|
|
670
|
+
|
|
671
|
+
Mark Order As Complete (Admin)
|
|
672
|
+
|
|
673
|
+
### Example
|
|
674
|
+
|
|
675
|
+
```typescript
|
|
676
|
+
import {
|
|
677
|
+
OrdersApi,
|
|
678
|
+
Configuration
|
|
679
|
+
} from 'yellowgrid-api-ts';
|
|
680
|
+
|
|
681
|
+
const configuration = new Configuration();
|
|
682
|
+
const apiInstance = new OrdersApi(configuration);
|
|
683
|
+
|
|
684
|
+
let id: number; //Order ID (default to undefined)
|
|
685
|
+
|
|
686
|
+
const { status, data } = await apiInstance.patchCompleteOrder(
|
|
687
|
+
id
|
|
688
|
+
);
|
|
689
|
+
```
|
|
690
|
+
|
|
691
|
+
### Parameters
|
|
692
|
+
|
|
693
|
+
|Name | Type | Description | Notes|
|
|
694
|
+
|------------- | ------------- | ------------- | -------------|
|
|
695
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
### Return type
|
|
699
|
+
|
|
700
|
+
**OrderDetailsDTO**
|
|
701
|
+
|
|
702
|
+
### Authorization
|
|
703
|
+
|
|
704
|
+
No authorization required
|
|
705
|
+
|
|
706
|
+
### HTTP request headers
|
|
707
|
+
|
|
708
|
+
- **Content-Type**: Not defined
|
|
709
|
+
- **Accept**: application/json
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
### HTTP response details
|
|
713
|
+
| Status code | Description | Response headers |
|
|
714
|
+
|-------------|-------------|------------------|
|
|
715
|
+
|**200** | Order Details | - |
|
|
716
|
+
|**400** | Bad Request | - |
|
|
717
|
+
|**401** | Unauthorised | - |
|
|
718
|
+
|**403** | Access Denied | - |
|
|
719
|
+
|
|
720
|
+
[[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)
|
|
721
|
+
|
|
722
|
+
# **postAddOrderNote**
|
|
723
|
+
> AuditLogEntity postAddOrderNote()
|
|
724
|
+
|
|
725
|
+
Add Order Note
|
|
726
|
+
|
|
727
|
+
### Example
|
|
728
|
+
|
|
729
|
+
```typescript
|
|
730
|
+
import {
|
|
731
|
+
OrdersApi,
|
|
732
|
+
Configuration,
|
|
733
|
+
PostAddOrderNoteRequest
|
|
734
|
+
} from 'yellowgrid-api-ts';
|
|
735
|
+
|
|
736
|
+
const configuration = new Configuration();
|
|
737
|
+
const apiInstance = new OrdersApi(configuration);
|
|
738
|
+
|
|
739
|
+
let id: number; //Order ID (default to undefined)
|
|
740
|
+
let postAddOrderNoteRequest: PostAddOrderNoteRequest; // (optional)
|
|
741
|
+
|
|
742
|
+
const { status, data } = await apiInstance.postAddOrderNote(
|
|
743
|
+
id,
|
|
744
|
+
postAddOrderNoteRequest
|
|
745
|
+
);
|
|
746
|
+
```
|
|
747
|
+
|
|
748
|
+
### Parameters
|
|
749
|
+
|
|
750
|
+
|Name | Type | Description | Notes|
|
|
751
|
+
|------------- | ------------- | ------------- | -------------|
|
|
752
|
+
| **postAddOrderNoteRequest** | **PostAddOrderNoteRequest**| | |
|
|
753
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
### Return type
|
|
757
|
+
|
|
758
|
+
**AuditLogEntity**
|
|
759
|
+
|
|
760
|
+
### Authorization
|
|
761
|
+
|
|
762
|
+
No authorization required
|
|
763
|
+
|
|
764
|
+
### HTTP request headers
|
|
765
|
+
|
|
766
|
+
- **Content-Type**: application/json
|
|
767
|
+
- **Accept**: application/json
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
### HTTP response details
|
|
771
|
+
| Status code | Description | Response headers |
|
|
772
|
+
|-------------|-------------|------------------|
|
|
773
|
+
|**200** | Audit Log Entry | - |
|
|
774
|
+
|**400** | Bad Request | - |
|
|
775
|
+
|**401** | Unauthorised | - |
|
|
776
|
+
|**403** | Access Denied | - |
|
|
777
|
+
|
|
778
|
+
[[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)
|
|
779
|
+
|
|
780
|
+
# **postCreateAdminOrder**
|
|
781
|
+
> Array<OrderSummaryDTO> postCreateAdminOrder()
|
|
782
|
+
|
|
783
|
+
Create An Order (Admin)
|
|
784
|
+
|
|
785
|
+
### Example
|
|
786
|
+
|
|
787
|
+
```typescript
|
|
788
|
+
import {
|
|
789
|
+
OrdersApi,
|
|
790
|
+
Configuration,
|
|
791
|
+
AdminOrderRequestDTO
|
|
792
|
+
} from 'yellowgrid-api-ts';
|
|
793
|
+
|
|
794
|
+
const configuration = new Configuration();
|
|
795
|
+
const apiInstance = new OrdersApi(configuration);
|
|
796
|
+
|
|
797
|
+
let readonly: boolean; //Readonly Order (optional) (default to undefined)
|
|
798
|
+
let adminOrderRequestDTO: AdminOrderRequestDTO; //Admin Order Request (optional)
|
|
799
|
+
|
|
800
|
+
const { status, data } = await apiInstance.postCreateAdminOrder(
|
|
801
|
+
readonly,
|
|
802
|
+
adminOrderRequestDTO
|
|
803
|
+
);
|
|
804
|
+
```
|
|
805
|
+
|
|
806
|
+
### Parameters
|
|
807
|
+
|
|
808
|
+
|Name | Type | Description | Notes|
|
|
809
|
+
|------------- | ------------- | ------------- | -------------|
|
|
810
|
+
| **adminOrderRequestDTO** | **AdminOrderRequestDTO**| Admin Order Request | |
|
|
811
|
+
| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
### Return type
|
|
815
|
+
|
|
816
|
+
**Array<OrderSummaryDTO>**
|
|
817
|
+
|
|
818
|
+
### Authorization
|
|
819
|
+
|
|
820
|
+
No authorization required
|
|
821
|
+
|
|
822
|
+
### HTTP request headers
|
|
823
|
+
|
|
824
|
+
- **Content-Type**: application/json
|
|
825
|
+
- **Accept**: application/json
|
|
826
|
+
|
|
827
|
+
|
|
828
|
+
### HTTP response details
|
|
829
|
+
| Status code | Description | Response headers |
|
|
830
|
+
|-------------|-------------|------------------|
|
|
831
|
+
|**200** | Order Summaries | - |
|
|
832
|
+
|**400** | Bad Request | - |
|
|
833
|
+
|**401** | Unauthorised | - |
|
|
834
|
+
|**403** | Access Denied | - |
|
|
835
|
+
|
|
836
|
+
[[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)
|
|
837
|
+
|
|
838
|
+
# **postCreateConsignment**
|
|
839
|
+
> ShipmentDTO postCreateConsignment()
|
|
840
|
+
|
|
841
|
+
Create Shipping Consignment
|
|
842
|
+
|
|
843
|
+
### Example
|
|
844
|
+
|
|
845
|
+
```typescript
|
|
846
|
+
import {
|
|
847
|
+
OrdersApi,
|
|
848
|
+
Configuration,
|
|
849
|
+
ShippingRequestDTO
|
|
850
|
+
} from 'yellowgrid-api-ts';
|
|
851
|
+
|
|
852
|
+
const configuration = new Configuration();
|
|
853
|
+
const apiInstance = new OrdersApi(configuration);
|
|
854
|
+
|
|
855
|
+
let id: number; //Order ID (default to undefined)
|
|
856
|
+
let shipmentId: number; //Shipment ID (default to undefined)
|
|
857
|
+
let shippingRequestDTO: ShippingRequestDTO; //Shipping Request (optional)
|
|
858
|
+
|
|
859
|
+
const { status, data } = await apiInstance.postCreateConsignment(
|
|
860
|
+
id,
|
|
861
|
+
shipmentId,
|
|
862
|
+
shippingRequestDTO
|
|
863
|
+
);
|
|
864
|
+
```
|
|
865
|
+
|
|
866
|
+
### Parameters
|
|
867
|
+
|
|
868
|
+
|Name | Type | Description | Notes|
|
|
869
|
+
|------------- | ------------- | ------------- | -------------|
|
|
870
|
+
| **shippingRequestDTO** | **ShippingRequestDTO**| Shipping Request | |
|
|
871
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
872
|
+
| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
|
|
873
|
+
|
|
874
|
+
|
|
875
|
+
### Return type
|
|
876
|
+
|
|
877
|
+
**ShipmentDTO**
|
|
878
|
+
|
|
879
|
+
### Authorization
|
|
880
|
+
|
|
881
|
+
No authorization required
|
|
882
|
+
|
|
883
|
+
### HTTP request headers
|
|
884
|
+
|
|
885
|
+
- **Content-Type**: application/json
|
|
886
|
+
- **Accept**: application/json
|
|
887
|
+
|
|
888
|
+
|
|
889
|
+
### HTTP response details
|
|
890
|
+
| Status code | Description | Response headers |
|
|
891
|
+
|-------------|-------------|------------------|
|
|
892
|
+
|**200** | Shipping Information | - |
|
|
893
|
+
|**400** | Bad Request | - |
|
|
894
|
+
|**401** | Unauthorised | - |
|
|
895
|
+
|**403** | Access Denied | - |
|
|
896
|
+
|
|
897
|
+
[[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)
|
|
898
|
+
|
|
899
|
+
# **postCreateShipment**
|
|
900
|
+
> ShipmentDTO postCreateShipment()
|
|
901
|
+
|
|
902
|
+
Create Shipment (Admin)
|
|
903
|
+
|
|
904
|
+
### Example
|
|
905
|
+
|
|
906
|
+
```typescript
|
|
907
|
+
import {
|
|
908
|
+
OrdersApi,
|
|
909
|
+
Configuration,
|
|
910
|
+
ShipmentRequestDTO
|
|
911
|
+
} from 'yellowgrid-api-ts';
|
|
912
|
+
|
|
913
|
+
const configuration = new Configuration();
|
|
914
|
+
const apiInstance = new OrdersApi(configuration);
|
|
915
|
+
|
|
916
|
+
let id: number; //Order ID (default to undefined)
|
|
917
|
+
let batchId: number; //Batch ID (default to undefined)
|
|
918
|
+
let shipmentRequestDTO: ShipmentRequestDTO; //Shipment Request (optional)
|
|
919
|
+
|
|
920
|
+
const { status, data } = await apiInstance.postCreateShipment(
|
|
921
|
+
id,
|
|
922
|
+
batchId,
|
|
923
|
+
shipmentRequestDTO
|
|
924
|
+
);
|
|
925
|
+
```
|
|
926
|
+
|
|
927
|
+
### Parameters
|
|
928
|
+
|
|
929
|
+
|Name | Type | Description | Notes|
|
|
930
|
+
|------------- | ------------- | ------------- | -------------|
|
|
931
|
+
| **shipmentRequestDTO** | **ShipmentRequestDTO**| Shipment Request | |
|
|
932
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
933
|
+
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
934
|
+
|
|
935
|
+
|
|
936
|
+
### Return type
|
|
937
|
+
|
|
938
|
+
**ShipmentDTO**
|
|
939
|
+
|
|
940
|
+
### Authorization
|
|
941
|
+
|
|
942
|
+
No authorization required
|
|
943
|
+
|
|
944
|
+
### HTTP request headers
|
|
945
|
+
|
|
946
|
+
- **Content-Type**: application/json
|
|
947
|
+
- **Accept**: application/json
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
### HTTP response details
|
|
951
|
+
| Status code | Description | Response headers |
|
|
952
|
+
|-------------|-------------|------------------|
|
|
953
|
+
|**200** | Shipment | - |
|
|
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
|
+
# **postGetOrders**
|
|
961
|
+
> Array<OrderSummaryDTO> postGetOrders()
|
|
962
|
+
|
|
963
|
+
Create An Order (Beta)
|
|
964
|
+
|
|
965
|
+
### Example
|
|
966
|
+
|
|
967
|
+
```typescript
|
|
968
|
+
import {
|
|
969
|
+
OrdersApi,
|
|
970
|
+
Configuration,
|
|
971
|
+
CustomerOrderRequestDTO
|
|
972
|
+
} from 'yellowgrid-api-ts';
|
|
973
|
+
|
|
974
|
+
const configuration = new Configuration();
|
|
975
|
+
const apiInstance = new OrdersApi(configuration);
|
|
976
|
+
|
|
977
|
+
let readonly: boolean; //Readonly Order (optional) (default to undefined)
|
|
978
|
+
let customerOrderRequestDTO: CustomerOrderRequestDTO; //Order Request (optional)
|
|
979
|
+
|
|
980
|
+
const { status, data } = await apiInstance.postGetOrders(
|
|
981
|
+
readonly,
|
|
982
|
+
customerOrderRequestDTO
|
|
983
|
+
);
|
|
984
|
+
```
|
|
985
|
+
|
|
986
|
+
### Parameters
|
|
987
|
+
|
|
988
|
+
|Name | Type | Description | Notes|
|
|
989
|
+
|------------- | ------------- | ------------- | -------------|
|
|
990
|
+
| **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
|
|
991
|
+
| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
|
|
992
|
+
|
|
993
|
+
|
|
994
|
+
### Return type
|
|
995
|
+
|
|
996
|
+
**Array<OrderSummaryDTO>**
|
|
997
|
+
|
|
998
|
+
### Authorization
|
|
999
|
+
|
|
1000
|
+
No authorization required
|
|
1001
|
+
|
|
1002
|
+
### HTTP request headers
|
|
1003
|
+
|
|
1004
|
+
- **Content-Type**: application/json
|
|
1005
|
+
- **Accept**: application/json
|
|
1006
|
+
|
|
1007
|
+
|
|
1008
|
+
### HTTP response details
|
|
1009
|
+
| Status code | Description | Response headers |
|
|
1010
|
+
|-------------|-------------|------------------|
|
|
1011
|
+
|**200** | Order Summaries | - |
|
|
1012
|
+
|**400** | Bad Request | - |
|
|
1013
|
+
|**401** | Unauthorised | - |
|
|
1014
|
+
|**403** | Access Denied | - |
|
|
1015
|
+
|
|
1016
|
+
[[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)
|
|
1017
|
+
|
|
1018
|
+
# **postIssueCredit**
|
|
1019
|
+
> CreditNoteModel postIssueCredit()
|
|
1020
|
+
|
|
1021
|
+
Issue Credit (Admin)
|
|
1022
|
+
|
|
1023
|
+
### Example
|
|
1024
|
+
|
|
1025
|
+
```typescript
|
|
1026
|
+
import {
|
|
1027
|
+
OrdersApi,
|
|
1028
|
+
Configuration,
|
|
1029
|
+
CreditNoteDTO
|
|
1030
|
+
} from 'yellowgrid-api-ts';
|
|
1031
|
+
|
|
1032
|
+
const configuration = new Configuration();
|
|
1033
|
+
const apiInstance = new OrdersApi(configuration);
|
|
1034
|
+
|
|
1035
|
+
let id: number; //Order ID (default to undefined)
|
|
1036
|
+
let creditNoteDTO: CreditNoteDTO; //Credit Request (optional)
|
|
1037
|
+
|
|
1038
|
+
const { status, data } = await apiInstance.postIssueCredit(
|
|
1039
|
+
id,
|
|
1040
|
+
creditNoteDTO
|
|
1041
|
+
);
|
|
1042
|
+
```
|
|
1043
|
+
|
|
1044
|
+
### Parameters
|
|
1045
|
+
|
|
1046
|
+
|Name | Type | Description | Notes|
|
|
1047
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1048
|
+
| **creditNoteDTO** | **CreditNoteDTO**| Credit Request | |
|
|
1049
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
### Return type
|
|
1053
|
+
|
|
1054
|
+
**CreditNoteModel**
|
|
1055
|
+
|
|
1056
|
+
### Authorization
|
|
1057
|
+
|
|
1058
|
+
No authorization required
|
|
1059
|
+
|
|
1060
|
+
### HTTP request headers
|
|
1061
|
+
|
|
1062
|
+
- **Content-Type**: application/json
|
|
1063
|
+
- **Accept**: application/json
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
### HTTP response details
|
|
1067
|
+
| Status code | Description | Response headers |
|
|
1068
|
+
|-------------|-------------|------------------|
|
|
1069
|
+
|**200** | Credit Note | - |
|
|
1070
|
+
|**400** | Bad Request | - |
|
|
1071
|
+
|**401** | Unauthorised | - |
|
|
1072
|
+
|**403** | Access Denied | - |
|
|
1073
|
+
|
|
1074
|
+
[[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)
|
|
1075
|
+
|
|
1076
|
+
# **postPrintShippingLabel**
|
|
1077
|
+
> File postPrintShippingLabel()
|
|
1078
|
+
|
|
1079
|
+
Print Shipment Label
|
|
1080
|
+
|
|
1081
|
+
### Example
|
|
1082
|
+
|
|
1083
|
+
```typescript
|
|
1084
|
+
import {
|
|
1085
|
+
OrdersApi,
|
|
1086
|
+
Configuration
|
|
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 shipmentId: number; //Shipment ID (default to undefined)
|
|
1094
|
+
let printer: 1 | 2 | 3; //Printer (default to undefined)
|
|
1095
|
+
|
|
1096
|
+
const { status, data } = await apiInstance.postPrintShippingLabel(
|
|
1097
|
+
id,
|
|
1098
|
+
shipmentId,
|
|
1099
|
+
printer
|
|
1100
|
+
);
|
|
1101
|
+
```
|
|
1102
|
+
|
|
1103
|
+
### Parameters
|
|
1104
|
+
|
|
1105
|
+
|Name | Type | Description | Notes|
|
|
1106
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1107
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1108
|
+
| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
|
|
1109
|
+
| **printer** | [**1 | 2 | 3**]**Array<1 | 2 | 3>** | Printer | defaults to undefined|
|
|
1110
|
+
|
|
1111
|
+
|
|
1112
|
+
### Return type
|
|
1113
|
+
|
|
1114
|
+
**File**
|
|
1115
|
+
|
|
1116
|
+
### Authorization
|
|
1117
|
+
|
|
1118
|
+
No authorization required
|
|
1119
|
+
|
|
1120
|
+
### HTTP request headers
|
|
1121
|
+
|
|
1122
|
+
- **Content-Type**: Not defined
|
|
1123
|
+
- **Accept**: text/html
|
|
1124
|
+
|
|
1125
|
+
|
|
1126
|
+
### HTTP response details
|
|
1127
|
+
| Status code | Description | Response headers |
|
|
1128
|
+
|-------------|-------------|------------------|
|
|
1129
|
+
|**200** | Shipping Label | - |
|
|
1130
|
+
|**204** | No Response | - |
|
|
1131
|
+
|**400** | Bad Request | - |
|
|
1132
|
+
|**401** | Unauthorised | - |
|
|
1133
|
+
|**403** | Access Denied | - |
|
|
1134
|
+
|
|
1135
|
+
[[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)
|
|
1136
|
+
|
|
1137
|
+
# **postProcessTcxLicences**
|
|
1138
|
+
> OrderDetailsDTO postProcessTcxLicences()
|
|
1139
|
+
|
|
1140
|
+
Process 3CX Licences (Admin)
|
|
20
1141
|
|
|
21
1142
|
### Example
|
|
22
1143
|
|
|
@@ -30,9 +1151,11 @@ const configuration = new Configuration();
|
|
|
30
1151
|
const apiInstance = new OrdersApi(configuration);
|
|
31
1152
|
|
|
32
1153
|
let id: number; //Order ID (default to undefined)
|
|
1154
|
+
let batchId: number; //Batch ID (default to undefined)
|
|
33
1155
|
|
|
34
|
-
const { status, data } = await apiInstance.
|
|
35
|
-
id
|
|
1156
|
+
const { status, data } = await apiInstance.postProcessTcxLicences(
|
|
1157
|
+
id,
|
|
1158
|
+
batchId
|
|
36
1159
|
);
|
|
37
1160
|
```
|
|
38
1161
|
|
|
@@ -41,11 +1164,12 @@ const { status, data } = await apiInstance.deleteUpdateOrder(
|
|
|
41
1164
|
|Name | Type | Description | Notes|
|
|
42
1165
|
|------------- | ------------- | ------------- | -------------|
|
|
43
1166
|
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1167
|
+
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
44
1168
|
|
|
45
1169
|
|
|
46
1170
|
### Return type
|
|
47
1171
|
|
|
48
|
-
|
|
1172
|
+
**OrderDetailsDTO**
|
|
49
1173
|
|
|
50
1174
|
### Authorization
|
|
51
1175
|
|
|
@@ -54,23 +1178,23 @@ No authorization required
|
|
|
54
1178
|
### HTTP request headers
|
|
55
1179
|
|
|
56
1180
|
- **Content-Type**: Not defined
|
|
57
|
-
- **Accept**:
|
|
1181
|
+
- **Accept**: application/json
|
|
58
1182
|
|
|
59
1183
|
|
|
60
1184
|
### HTTP response details
|
|
61
1185
|
| Status code | Description | Response headers |
|
|
62
1186
|
|-------------|-------------|------------------|
|
|
63
|
-
|**200** |
|
|
1187
|
+
|**200** | Order Details | - |
|
|
64
1188
|
|**400** | Bad Request | - |
|
|
65
1189
|
|**401** | Unauthorised | - |
|
|
66
1190
|
|**403** | Access Denied | - |
|
|
67
1191
|
|
|
68
1192
|
[[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)
|
|
69
1193
|
|
|
70
|
-
# **
|
|
71
|
-
>
|
|
1194
|
+
# **postSendOrderEmail**
|
|
1195
|
+
> postSendOrderEmail()
|
|
72
1196
|
|
|
73
|
-
|
|
1197
|
+
Send Order Email
|
|
74
1198
|
|
|
75
1199
|
### Example
|
|
76
1200
|
|
|
@@ -84,9 +1208,11 @@ const configuration = new Configuration();
|
|
|
84
1208
|
const apiInstance = new OrdersApi(configuration);
|
|
85
1209
|
|
|
86
1210
|
let id: number; //Order ID (default to undefined)
|
|
1211
|
+
let email: string; //Email Address (default to undefined)
|
|
87
1212
|
|
|
88
|
-
const { status, data } = await apiInstance.
|
|
89
|
-
id
|
|
1213
|
+
const { status, data } = await apiInstance.postSendOrderEmail(
|
|
1214
|
+
id,
|
|
1215
|
+
email
|
|
90
1216
|
);
|
|
91
1217
|
```
|
|
92
1218
|
|
|
@@ -95,11 +1221,12 @@ const { status, data } = await apiInstance.getGetAdminEditableOrder(
|
|
|
95
1221
|
|Name | Type | Description | Notes|
|
|
96
1222
|
|------------- | ------------- | ------------- | -------------|
|
|
97
1223
|
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1224
|
+
| **email** | [**string**] | Email Address | defaults to undefined|
|
|
98
1225
|
|
|
99
1226
|
|
|
100
1227
|
### Return type
|
|
101
1228
|
|
|
102
|
-
|
|
1229
|
+
void (empty response body)
|
|
103
1230
|
|
|
104
1231
|
### Authorization
|
|
105
1232
|
|
|
@@ -108,23 +1235,23 @@ No authorization required
|
|
|
108
1235
|
### HTTP request headers
|
|
109
1236
|
|
|
110
1237
|
- **Content-Type**: Not defined
|
|
111
|
-
- **Accept**:
|
|
1238
|
+
- **Accept**: Not defined
|
|
112
1239
|
|
|
113
1240
|
|
|
114
1241
|
### HTTP response details
|
|
115
1242
|
| Status code | Description | Response headers |
|
|
116
1243
|
|-------------|-------------|------------------|
|
|
117
|
-
|**200** |
|
|
1244
|
+
|**200** | No Response | - |
|
|
118
1245
|
|**400** | Bad Request | - |
|
|
119
1246
|
|**401** | Unauthorised | - |
|
|
120
1247
|
|**403** | Access Denied | - |
|
|
121
1248
|
|
|
122
1249
|
[[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
1250
|
|
|
124
|
-
# **
|
|
125
|
-
>
|
|
1251
|
+
# **postSendShipmentEmail**
|
|
1252
|
+
> postSendShipmentEmail()
|
|
126
1253
|
|
|
127
|
-
|
|
1254
|
+
Send Shipment Email (Admin)
|
|
128
1255
|
|
|
129
1256
|
### Example
|
|
130
1257
|
|
|
@@ -138,9 +1265,15 @@ const configuration = new Configuration();
|
|
|
138
1265
|
const apiInstance = new OrdersApi(configuration);
|
|
139
1266
|
|
|
140
1267
|
let id: number; //Order ID (default to undefined)
|
|
1268
|
+
let batchId: number; //Batch ID (default to undefined)
|
|
1269
|
+
let shipmentId: number; //Shipment ID (default to undefined)
|
|
1270
|
+
let email: string; //Email Address (default to undefined)
|
|
141
1271
|
|
|
142
|
-
const { status, data } = await apiInstance.
|
|
143
|
-
id
|
|
1272
|
+
const { status, data } = await apiInstance.postSendShipmentEmail(
|
|
1273
|
+
id,
|
|
1274
|
+
batchId,
|
|
1275
|
+
shipmentId,
|
|
1276
|
+
email
|
|
144
1277
|
);
|
|
145
1278
|
```
|
|
146
1279
|
|
|
@@ -149,11 +1282,14 @@ const { status, data } = await apiInstance.getGetEditableOrder(
|
|
|
149
1282
|
|Name | Type | Description | Notes|
|
|
150
1283
|
|------------- | ------------- | ------------- | -------------|
|
|
151
1284
|
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1285
|
+
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
1286
|
+
| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
|
|
1287
|
+
| **email** | [**string**] | Email Address | defaults to undefined|
|
|
152
1288
|
|
|
153
1289
|
|
|
154
1290
|
### Return type
|
|
155
1291
|
|
|
156
|
-
|
|
1292
|
+
void (empty response body)
|
|
157
1293
|
|
|
158
1294
|
### Authorization
|
|
159
1295
|
|
|
@@ -162,23 +1298,23 @@ No authorization required
|
|
|
162
1298
|
### HTTP request headers
|
|
163
1299
|
|
|
164
1300
|
- **Content-Type**: Not defined
|
|
165
|
-
- **Accept**:
|
|
1301
|
+
- **Accept**: Not defined
|
|
166
1302
|
|
|
167
1303
|
|
|
168
1304
|
### HTTP response details
|
|
169
1305
|
| Status code | Description | Response headers |
|
|
170
1306
|
|-------------|-------------|------------------|
|
|
171
|
-
|**200** |
|
|
1307
|
+
|**200** | No Response | - |
|
|
172
1308
|
|**400** | Bad Request | - |
|
|
173
1309
|
|**401** | Unauthorised | - |
|
|
174
1310
|
|**403** | Access Denied | - |
|
|
175
1311
|
|
|
176
1312
|
[[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
1313
|
|
|
178
|
-
# **
|
|
179
|
-
>
|
|
1314
|
+
# **postSendSupplierEmail**
|
|
1315
|
+
> postSendSupplierEmail()
|
|
180
1316
|
|
|
181
|
-
|
|
1317
|
+
Send Supplier Email
|
|
182
1318
|
|
|
183
1319
|
### Example
|
|
184
1320
|
|
|
@@ -191,22 +1327,12 @@ import {
|
|
|
191
1327
|
const configuration = new Configuration();
|
|
192
1328
|
const apiInstance = new OrdersApi(configuration);
|
|
193
1329
|
|
|
194
|
-
let
|
|
195
|
-
let
|
|
196
|
-
let search: string; //Search (optional) (default to undefined)
|
|
197
|
-
let fulfillable: boolean; //Fulfillable (optional) (default to undefined)
|
|
198
|
-
let status: 'PAID' | 'INVOICE_PAID' | 'UNPAID' | 'QUOTE'; //Status (optional) (default to undefined)
|
|
199
|
-
let filter: 'OUTSTANDING' | 'QUOTES' | 'ALL' | 'BACK_ORDERS'; //Filter (optional) (default to undefined)
|
|
200
|
-
let customerId: number; //Customer ID (optional) (default to undefined)
|
|
1330
|
+
let id: number; //Order ID (default to undefined)
|
|
1331
|
+
let batchId: number; //Batch ID (default to undefined)
|
|
201
1332
|
|
|
202
|
-
const { status, data } = await apiInstance.
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
search,
|
|
206
|
-
fulfillable,
|
|
207
|
-
status,
|
|
208
|
-
filter,
|
|
209
|
-
customerId
|
|
1333
|
+
const { status, data } = await apiInstance.postSendSupplierEmail(
|
|
1334
|
+
id,
|
|
1335
|
+
batchId
|
|
210
1336
|
);
|
|
211
1337
|
```
|
|
212
1338
|
|
|
@@ -214,18 +1340,13 @@ const { status, data } = await apiInstance.getGetOrders(
|
|
|
214
1340
|
|
|
215
1341
|
|Name | Type | Description | Notes|
|
|
216
1342
|
|------------- | ------------- | ------------- | -------------|
|
|
217
|
-
| **
|
|
218
|
-
| **
|
|
219
|
-
| **search** | [**string**] | Search | (optional) defaults to undefined|
|
|
220
|
-
| **fulfillable** | [**boolean**] | Fulfillable | (optional) defaults to undefined|
|
|
221
|
-
| **status** | [**'PAID' | 'INVOICE_PAID' | 'UNPAID' | 'QUOTE'**]**Array<'PAID' | 'INVOICE_PAID' | 'UNPAID' | 'QUOTE'>** | Status | (optional) defaults to undefined|
|
|
222
|
-
| **filter** | [**'OUTSTANDING' | 'QUOTES' | 'ALL' | 'BACK_ORDERS'**]**Array<'OUTSTANDING' | 'QUOTES' | 'ALL' | 'BACK_ORDERS'>** | Filter | (optional) defaults to undefined|
|
|
223
|
-
| **customerId** | [**number**] | Customer ID | (optional) defaults to undefined|
|
|
1343
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1344
|
+
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
224
1345
|
|
|
225
1346
|
|
|
226
1347
|
### Return type
|
|
227
1348
|
|
|
228
|
-
|
|
1349
|
+
void (empty response body)
|
|
229
1350
|
|
|
230
1351
|
### Authorization
|
|
231
1352
|
|
|
@@ -234,23 +1355,23 @@ No authorization required
|
|
|
234
1355
|
### HTTP request headers
|
|
235
1356
|
|
|
236
1357
|
- **Content-Type**: Not defined
|
|
237
|
-
- **Accept**:
|
|
1358
|
+
- **Accept**: Not defined
|
|
238
1359
|
|
|
239
1360
|
|
|
240
1361
|
### HTTP response details
|
|
241
1362
|
| Status code | Description | Response headers |
|
|
242
1363
|
|-------------|-------------|------------------|
|
|
243
|
-
|**200** |
|
|
1364
|
+
|**200** | No Response | - |
|
|
244
1365
|
|**400** | Bad Request | - |
|
|
245
1366
|
|**401** | Unauthorised | - |
|
|
246
1367
|
|**403** | Access Denied | - |
|
|
247
1368
|
|
|
248
1369
|
[[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
1370
|
|
|
250
|
-
# **
|
|
251
|
-
> Array<OrderSummaryDTO>
|
|
1371
|
+
# **postSplitOrder**
|
|
1372
|
+
> Array<OrderSummaryDTO> postSplitOrder()
|
|
252
1373
|
|
|
253
|
-
|
|
1374
|
+
Split Order
|
|
254
1375
|
|
|
255
1376
|
### Example
|
|
256
1377
|
|
|
@@ -258,18 +1379,18 @@ Create An Order (Admin)
|
|
|
258
1379
|
import {
|
|
259
1380
|
OrdersApi,
|
|
260
1381
|
Configuration,
|
|
261
|
-
|
|
1382
|
+
PostSplitOrderRequest
|
|
262
1383
|
} from 'yellowgrid-api-ts';
|
|
263
1384
|
|
|
264
1385
|
const configuration = new Configuration();
|
|
265
1386
|
const apiInstance = new OrdersApi(configuration);
|
|
266
1387
|
|
|
267
|
-
let
|
|
268
|
-
let
|
|
1388
|
+
let id: number; //Order ID (default to undefined)
|
|
1389
|
+
let postSplitOrderRequest: PostSplitOrderRequest; // (optional)
|
|
269
1390
|
|
|
270
|
-
const { status, data } = await apiInstance.
|
|
271
|
-
|
|
272
|
-
|
|
1391
|
+
const { status, data } = await apiInstance.postSplitOrder(
|
|
1392
|
+
id,
|
|
1393
|
+
postSplitOrderRequest
|
|
273
1394
|
);
|
|
274
1395
|
```
|
|
275
1396
|
|
|
@@ -277,8 +1398,8 @@ const { status, data } = await apiInstance.postCreateAdminOrder(
|
|
|
277
1398
|
|
|
278
1399
|
|Name | Type | Description | Notes|
|
|
279
1400
|
|------------- | ------------- | ------------- | -------------|
|
|
280
|
-
| **
|
|
281
|
-
| **
|
|
1401
|
+
| **postSplitOrderRequest** | **PostSplitOrderRequest**| | |
|
|
1402
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
282
1403
|
|
|
283
1404
|
|
|
284
1405
|
### Return type
|
|
@@ -305,10 +1426,10 @@ No authorization required
|
|
|
305
1426
|
|
|
306
1427
|
[[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
1428
|
|
|
308
|
-
# **
|
|
309
|
-
> Array<
|
|
1429
|
+
# **putAllocateItems**
|
|
1430
|
+
> Array<BatchDTO> putAllocateItems()
|
|
310
1431
|
|
|
311
|
-
|
|
1432
|
+
Allocate Items To Supplier
|
|
312
1433
|
|
|
313
1434
|
### Example
|
|
314
1435
|
|
|
@@ -316,18 +1437,20 @@ Create An Order (Beta)
|
|
|
316
1437
|
import {
|
|
317
1438
|
OrdersApi,
|
|
318
1439
|
Configuration,
|
|
319
|
-
|
|
1440
|
+
PutAllocateItemsRequest
|
|
320
1441
|
} from 'yellowgrid-api-ts';
|
|
321
1442
|
|
|
322
1443
|
const configuration = new Configuration();
|
|
323
1444
|
const apiInstance = new OrdersApi(configuration);
|
|
324
1445
|
|
|
325
|
-
let
|
|
326
|
-
let
|
|
1446
|
+
let id: number; //Order ID (default to undefined)
|
|
1447
|
+
let supplierId: number; //Supplier ID (default to undefined)
|
|
1448
|
+
let putAllocateItemsRequest: PutAllocateItemsRequest; // (optional)
|
|
327
1449
|
|
|
328
|
-
const { status, data } = await apiInstance.
|
|
329
|
-
|
|
330
|
-
|
|
1450
|
+
const { status, data } = await apiInstance.putAllocateItems(
|
|
1451
|
+
id,
|
|
1452
|
+
supplierId,
|
|
1453
|
+
putAllocateItemsRequest
|
|
331
1454
|
);
|
|
332
1455
|
```
|
|
333
1456
|
|
|
@@ -335,13 +1458,14 @@ const { status, data } = await apiInstance.postGetOrders(
|
|
|
335
1458
|
|
|
336
1459
|
|Name | Type | Description | Notes|
|
|
337
1460
|
|------------- | ------------- | ------------- | -------------|
|
|
338
|
-
| **
|
|
339
|
-
| **
|
|
1461
|
+
| **putAllocateItemsRequest** | **PutAllocateItemsRequest**| | |
|
|
1462
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1463
|
+
| **supplierId** | [**number**] | Supplier ID | defaults to undefined|
|
|
340
1464
|
|
|
341
1465
|
|
|
342
1466
|
### Return type
|
|
343
1467
|
|
|
344
|
-
**Array<
|
|
1468
|
+
**Array<BatchDTO>**
|
|
345
1469
|
|
|
346
1470
|
### Authorization
|
|
347
1471
|
|
|
@@ -356,7 +1480,7 @@ No authorization required
|
|
|
356
1480
|
### HTTP response details
|
|
357
1481
|
| Status code | Description | Response headers |
|
|
358
1482
|
|-------------|-------------|------------------|
|
|
359
|
-
|**200** | Order
|
|
1483
|
+
|**200** | Order Batches | - |
|
|
360
1484
|
|**400** | Bad Request | - |
|
|
361
1485
|
|**401** | Unauthorised | - |
|
|
362
1486
|
|**403** | Access Denied | - |
|
|
@@ -424,6 +1548,70 @@ No authorization required
|
|
|
424
1548
|
|
|
425
1549
|
[[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
1550
|
|
|
1551
|
+
# **putUpdateBatchItem**
|
|
1552
|
+
> OrderedItemModel putUpdateBatchItem()
|
|
1553
|
+
|
|
1554
|
+
Update Batch Item (Admin)
|
|
1555
|
+
|
|
1556
|
+
### Example
|
|
1557
|
+
|
|
1558
|
+
```typescript
|
|
1559
|
+
import {
|
|
1560
|
+
OrdersApi,
|
|
1561
|
+
Configuration,
|
|
1562
|
+
OrderedItemModel
|
|
1563
|
+
} from 'yellowgrid-api-ts';
|
|
1564
|
+
|
|
1565
|
+
const configuration = new Configuration();
|
|
1566
|
+
const apiInstance = new OrdersApi(configuration);
|
|
1567
|
+
|
|
1568
|
+
let id: number; //Order ID (default to undefined)
|
|
1569
|
+
let batchId: number; //Batch ID (default to undefined)
|
|
1570
|
+
let itemId: number; //Ordered Item ID (default to undefined)
|
|
1571
|
+
let orderedItemModel: OrderedItemModel; //Batch Item (optional)
|
|
1572
|
+
|
|
1573
|
+
const { status, data } = await apiInstance.putUpdateBatchItem(
|
|
1574
|
+
id,
|
|
1575
|
+
batchId,
|
|
1576
|
+
itemId,
|
|
1577
|
+
orderedItemModel
|
|
1578
|
+
);
|
|
1579
|
+
```
|
|
1580
|
+
|
|
1581
|
+
### Parameters
|
|
1582
|
+
|
|
1583
|
+
|Name | Type | Description | Notes|
|
|
1584
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1585
|
+
| **orderedItemModel** | **OrderedItemModel**| Batch Item | |
|
|
1586
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1587
|
+
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
1588
|
+
| **itemId** | [**number**] | Ordered Item ID | defaults to undefined|
|
|
1589
|
+
|
|
1590
|
+
|
|
1591
|
+
### Return type
|
|
1592
|
+
|
|
1593
|
+
**OrderedItemModel**
|
|
1594
|
+
|
|
1595
|
+
### Authorization
|
|
1596
|
+
|
|
1597
|
+
No authorization required
|
|
1598
|
+
|
|
1599
|
+
### HTTP request headers
|
|
1600
|
+
|
|
1601
|
+
- **Content-Type**: application/json
|
|
1602
|
+
- **Accept**: application/json
|
|
1603
|
+
|
|
1604
|
+
|
|
1605
|
+
### HTTP response details
|
|
1606
|
+
| Status code | Description | Response headers |
|
|
1607
|
+
|-------------|-------------|------------------|
|
|
1608
|
+
|**200** | Ordered Item | - |
|
|
1609
|
+
|**400** | Bad Request | - |
|
|
1610
|
+
|**401** | Unauthorised | - |
|
|
1611
|
+
|**403** | Access Denied | - |
|
|
1612
|
+
|
|
1613
|
+
[[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)
|
|
1614
|
+
|
|
427
1615
|
# **putUpdateOrder**
|
|
428
1616
|
> Array<OrderSummaryDTO> putUpdateOrder()
|
|
429
1617
|
|
|
@@ -485,3 +1673,124 @@ No authorization required
|
|
|
485
1673
|
|
|
486
1674
|
[[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)
|
|
487
1675
|
|
|
1676
|
+
# **putUpdatePaymentStatus**
|
|
1677
|
+
> OrderDetailsDTO putUpdatePaymentStatus()
|
|
1678
|
+
|
|
1679
|
+
Change Payment Status (Admin)
|
|
1680
|
+
|
|
1681
|
+
### Example
|
|
1682
|
+
|
|
1683
|
+
```typescript
|
|
1684
|
+
import {
|
|
1685
|
+
OrdersApi,
|
|
1686
|
+
Configuration
|
|
1687
|
+
} from 'yellowgrid-api-ts';
|
|
1688
|
+
|
|
1689
|
+
const configuration = new Configuration();
|
|
1690
|
+
const apiInstance = new OrdersApi(configuration);
|
|
1691
|
+
|
|
1692
|
+
let id: number; //Order ID (default to undefined)
|
|
1693
|
+
let paid: boolean; //Paid (default to undefined)
|
|
1694
|
+
|
|
1695
|
+
const { status, data } = await apiInstance.putUpdatePaymentStatus(
|
|
1696
|
+
id,
|
|
1697
|
+
paid
|
|
1698
|
+
);
|
|
1699
|
+
```
|
|
1700
|
+
|
|
1701
|
+
### Parameters
|
|
1702
|
+
|
|
1703
|
+
|Name | Type | Description | Notes|
|
|
1704
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1705
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1706
|
+
| **paid** | [**boolean**] | Paid | defaults to undefined|
|
|
1707
|
+
|
|
1708
|
+
|
|
1709
|
+
### Return type
|
|
1710
|
+
|
|
1711
|
+
**OrderDetailsDTO**
|
|
1712
|
+
|
|
1713
|
+
### Authorization
|
|
1714
|
+
|
|
1715
|
+
No authorization required
|
|
1716
|
+
|
|
1717
|
+
### HTTP request headers
|
|
1718
|
+
|
|
1719
|
+
- **Content-Type**: Not defined
|
|
1720
|
+
- **Accept**: application/json
|
|
1721
|
+
|
|
1722
|
+
|
|
1723
|
+
### HTTP response details
|
|
1724
|
+
| Status code | Description | Response headers |
|
|
1725
|
+
|-------------|-------------|------------------|
|
|
1726
|
+
|**200** | Order Details | - |
|
|
1727
|
+
|**400** | Bad Request | - |
|
|
1728
|
+
|**401** | Unauthorised | - |
|
|
1729
|
+
|**403** | Access Denied | - |
|
|
1730
|
+
|
|
1731
|
+
[[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)
|
|
1732
|
+
|
|
1733
|
+
# **putUpdateShipment**
|
|
1734
|
+
> ShipmentDTO putUpdateShipment()
|
|
1735
|
+
|
|
1736
|
+
Update Shipment (Admin)
|
|
1737
|
+
|
|
1738
|
+
### Example
|
|
1739
|
+
|
|
1740
|
+
```typescript
|
|
1741
|
+
import {
|
|
1742
|
+
OrdersApi,
|
|
1743
|
+
Configuration,
|
|
1744
|
+
ShipmentRequestDTO
|
|
1745
|
+
} from 'yellowgrid-api-ts';
|
|
1746
|
+
|
|
1747
|
+
const configuration = new Configuration();
|
|
1748
|
+
const apiInstance = new OrdersApi(configuration);
|
|
1749
|
+
|
|
1750
|
+
let id: number; //Order ID (default to undefined)
|
|
1751
|
+
let batchId: number; //Batch ID (default to undefined)
|
|
1752
|
+
let shipmentId: number; //Shipment ID (default to undefined)
|
|
1753
|
+
let shipmentRequestDTO: ShipmentRequestDTO; //Shipment Request (optional)
|
|
1754
|
+
|
|
1755
|
+
const { status, data } = await apiInstance.putUpdateShipment(
|
|
1756
|
+
id,
|
|
1757
|
+
batchId,
|
|
1758
|
+
shipmentId,
|
|
1759
|
+
shipmentRequestDTO
|
|
1760
|
+
);
|
|
1761
|
+
```
|
|
1762
|
+
|
|
1763
|
+
### Parameters
|
|
1764
|
+
|
|
1765
|
+
|Name | Type | Description | Notes|
|
|
1766
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1767
|
+
| **shipmentRequestDTO** | **ShipmentRequestDTO**| Shipment Request | |
|
|
1768
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
1769
|
+
| **batchId** | [**number**] | Batch ID | defaults to undefined|
|
|
1770
|
+
| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
|
|
1771
|
+
|
|
1772
|
+
|
|
1773
|
+
### Return type
|
|
1774
|
+
|
|
1775
|
+
**ShipmentDTO**
|
|
1776
|
+
|
|
1777
|
+
### Authorization
|
|
1778
|
+
|
|
1779
|
+
No authorization required
|
|
1780
|
+
|
|
1781
|
+
### HTTP request headers
|
|
1782
|
+
|
|
1783
|
+
- **Content-Type**: application/json
|
|
1784
|
+
- **Accept**: application/json
|
|
1785
|
+
|
|
1786
|
+
|
|
1787
|
+
### HTTP response details
|
|
1788
|
+
| Status code | Description | Response headers |
|
|
1789
|
+
|-------------|-------------|------------------|
|
|
1790
|
+
|**200** | Shipment | - |
|
|
1791
|
+
|**400** | Bad Request | - |
|
|
1792
|
+
|**401** | Unauthorised | - |
|
|
1793
|
+
|**403** | Access Denied | - |
|
|
1794
|
+
|
|
1795
|
+
[[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)
|
|
1796
|
+
|