yellowgrid-api-ts 3.2.263 → 3.2.264-dev.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +418 -365
- package/.openapi-generator/VERSION +1 -1
- package/README.md +116 -3
- package/api.ts +9150 -3168
- package/base.ts +2 -2
- package/common.ts +3 -3
- package/config.json +4 -4
- package/configuration.ts +1 -1
- package/dist/api.d.ts +11794 -8215
- package/dist/api.js +14313 -9048
- 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/AgentEnum.d.ts +48 -0
- package/dist/models/AgentEnum.js +50 -0
- package/dist/models/CategoryEnum.d.ts +108 -0
- package/dist/models/CategoryEnum.js +110 -0
- package/dist/models/ConnectionTypeEnum.d.ts +17 -7
- package/dist/models/ConnectionTypeEnum.js +17 -7
- package/dist/models/ReasonEnum.d.ts +18 -0
- package/dist/models/ReasonEnum.js +20 -0
- package/dist/models/ReportEnum.d.ts +11 -1
- package/dist/models/ReportEnum.js +11 -1
- package/dist/models/ResolutionEnum.d.ts +18 -0
- package/dist/models/ResolutionEnum.js +20 -0
- package/dist/models/RmaItemCreditTypeEnum.d.ts +13 -0
- package/dist/models/RmaItemCreditTypeEnum.js +15 -0
- package/dist/models/RmaItemResolutionEnum.d.ts +28 -0
- package/dist/models/RmaItemResolutionEnum.js +30 -0
- package/dist/models/RmaItemStatusEnum.d.ts +18 -0
- package/dist/models/RmaItemStatusEnum.js +20 -0
- package/dist/models/RmaStatusEnum.d.ts +33 -0
- package/dist/models/RmaStatusEnum.js +35 -0
- package/docs/AbstractOrderRequestDTO.md +4 -4
- package/docs/AccountAddressesDTO.md +3 -3
- package/docs/AccountContactEntity.md +13 -13
- package/docs/AccountContactModel.md +13 -13
- package/docs/AccountContactRequestModel.md +9 -9
- package/docs/AccountDetailedSummaryDTO.md +11 -9
- package/docs/AccountFinanceDTO.md +10 -10
- package/docs/AccountRequestModel.md +11 -11
- package/docs/AccountSummaryDTO.md +3 -3
- package/docs/AccountsApi.md +159 -1
- package/docs/AccountsResponseModel.md +4 -4
- package/docs/AddressDTO.md +12 -6
- package/docs/AddressModel.md +5 -5
- package/docs/AddressRequestModel.md +4 -4
- package/docs/AdminCustomerRmasModel.md +27 -0
- package/docs/AdminNumberPortDTO.md +7 -7
- package/docs/AdminOrderRequestDTO.md +4 -4
- package/docs/AdminRmaDTO.md +67 -0
- package/docs/AdminRmaItemDTO.md +51 -0
- package/docs/AdminRmaNoteDTO.md +27 -0
- package/docs/AdminRmaSummaryDTO.md +39 -0
- package/docs/AdminUserModel.md +7 -5
- package/docs/AgentHoursGraphModel.md +4 -4
- package/docs/AgentHoursGraphMonthModel.md +2 -2
- package/docs/ApiLogEntity.md +12 -12
- package/docs/AreaCodeModel.md +2 -2
- package/docs/AttachmentModel.md +5 -5
- package/docs/AttributeSetEnum.md +2 -2
- package/docs/AuditLogEntity.md +9 -9
- package/docs/AuthCodeResponseModel.md +1 -1
- package/docs/AxisDataDTO.md +1 -1
- package/docs/BasicItemDTO.md +2 -2
- package/docs/BasicProductDTO.md +2 -2
- package/docs/BatchDTO.md +17 -17
- package/docs/BatchEntity.md +17 -17
- package/docs/BillingApi.md +63 -5
- package/docs/BrandedVideoSummaryDTO.md +47 -0
- package/docs/BrandedVideosApi.md +424 -0
- package/docs/BrandedVideosSummariesModel.md +27 -0
- package/docs/CRMApi.md +60 -1
- package/docs/CallBarringModel.md +5 -5
- package/docs/CallJournalRequestModel.md +35 -0
- package/docs/Class3CXApi.md +49 -1
- package/docs/Class3CXInstallationWizardApi.md +385 -1
- package/docs/Class3CXInstallationsApi.md +1 -1
- package/docs/Class3CXIntegrationsApi.md +53 -1
- package/docs/Class3CXMultiTenantApi.md +1 -1
- package/docs/ClientDetailsModel.md +7 -7
- package/docs/ClientModel.md +4 -4
- package/docs/CollectionDateDTO.md +27 -0
- package/docs/CollectionDatesRequestDTO.md +23 -0
- package/docs/CompanyContractModel.md +5 -5
- package/docs/ContactInfoModel.md +5 -5
- package/docs/ConversationModel.md +8 -8
- package/docs/CourierPriceEntity.md +10 -10
- package/docs/CreditAccountEntity.md +25 -23
- package/docs/CreditNoteDTO.md +5 -1
- package/docs/CreditNoteEntity.md +5 -5
- package/docs/CreditNoteItemDTO.md +3 -1
- package/docs/CreditNoteItemEntity.md +7 -5
- package/docs/CreditNoteItemModel.md +7 -5
- package/docs/CreditNoteModel.md +5 -5
- package/docs/CrmActivitiesResponseDTO.md +2 -2
- package/docs/CrmActivityDTO.md +11 -3
- package/docs/CrmContactDTO.md +7 -7
- package/docs/CrmDateActivitiesDTO.md +1 -1
- package/docs/CrmNoteEntity.md +10 -10
- package/docs/CrmNoteModel.md +10 -10
- package/docs/CustomerCoordinatesDTO.md +5 -5
- package/docs/CustomerInformationModel.md +4 -4
- package/docs/CustomerItemRequestDTO.md +4 -2
- package/docs/CustomerListAccountDTO.md +13 -13
- package/docs/CustomerOrderRequestDTO.md +4 -4
- package/docs/CustomerPriceListEnum.md +2 -2
- package/docs/CustomerRmasModel.md +27 -0
- package/docs/CustomerSummaryReportDTO.md +6 -6
- package/docs/DdiRangeRequestModel.md +3 -3
- package/docs/DdiRangesRequestModel.md +1 -1
- package/docs/DetailedItemRequestDTO.md +4 -2
- package/docs/DetailedOrderRequestDTO.md +4 -4
- package/docs/DeviceModel.md +25 -0
- package/docs/DivertRequestModel.md +1 -1
- package/docs/DivertResponseModel.md +2 -2
- package/docs/EdTechProClientEntity.md +4 -4
- package/docs/EdTechProSchoolModel.md +11 -11
- package/docs/EdTechProSchoolsModel.md +4 -4
- package/docs/EdTechProSetupModel.md +5 -5
- package/docs/{PostSplitOrderRequest.md → EmailRequestModel.md} +6 -5
- package/docs/EngineeredWizardRequestModel.md +25 -0
- package/docs/EventDTO.md +8 -8
- package/docs/EventRequestDTO.md +3 -3
- package/docs/EventSubscriptionModel.md +2 -2
- package/docs/EventUpdateDTO.md +4 -4
- package/docs/EventUpdateEntity.md +5 -5
- package/docs/EventUpdateRequestDTO.md +3 -3
- package/docs/ExpiringKeyDTO.md +5 -5
- package/docs/FraudManagementModel.md +2 -2
- package/docs/FreshdeskCompanyTicketsModel.md +4 -4
- package/docs/FreshdeskTicketEntity.md +6 -6
- package/docs/FtpAccountsEntity.md +5 -5
- package/docs/GenericFileModel.md +3 -3
- package/docs/GetGetTcxHostingPriceList200Response.md +20 -0
- package/docs/GraphDTO.md +6 -6
- package/docs/HostingChangeResponseModel.md +5 -5
- package/docs/HostingRegionDTO.md +3 -3
- package/docs/InstallationDetailsDTO.md +3 -3
- package/docs/InstanceAutoFailoverEntity.md +5 -5
- package/docs/InstanceDeletionScheduleEntity.md +4 -4
- package/docs/InstanceEntity.md +21 -21
- package/docs/InstanceFailoverEntity.md +11 -11
- package/docs/InstanceMonitoringEntity.md +3 -3
- package/docs/InstanceMonitoringLogEntity.md +6 -6
- package/docs/InstanceScheduledTasksEntity.md +6 -6
- package/docs/InstanceTcxDetailsEntity.md +10 -10
- package/docs/InstanceUserCredentialsEntity.md +5 -5
- package/docs/ItemDTO.md +2 -2
- package/docs/ItemDiscountEntity.md +6 -6
- package/docs/ItemEntity.md +21 -21
- package/docs/ItemResolutionRequestModel.md +21 -0
- package/docs/LinkedOrderEntity.md +2 -2
- package/docs/MFARequiredModel.md +2 -2
- package/docs/MacAddressDTO.md +2 -2
- package/docs/MacAddressRequestModel.md +21 -0
- package/docs/MiscApi.md +1 -1
- package/docs/MonthlyUsageModel.md +2 -2
- package/docs/MultiTenantChangeResponseModel.md +4 -4
- package/docs/MyPBXToolsApi.md +1 -1
- package/docs/NameRequestModel.md +21 -0
- package/docs/NavigationModel.md +4 -4
- package/docs/NoteRequestModel.md +21 -0
- package/docs/NumberPortDTO.md +7 -7
- package/docs/NumberPortNoteDTO.md +5 -5
- package/docs/NumberPortRangeDTO.md +2 -2
- package/docs/NumberPortingApi.md +22 -22
- package/docs/NumberPortsModel.md +4 -4
- package/docs/OAuth20Api.md +5 -5
- package/docs/OfflineInstancesEntity.md +5 -5
- package/docs/OrderDTO.md +3 -3
- package/docs/OrderDetailsDTO.md +14 -10
- package/docs/OrderEntity.md +56 -56
- package/docs/OrderItemDTO.md +2 -2
- package/docs/OrderRequestModel.md +6 -6
- package/docs/OrderSummariesModel.md +4 -4
- package/docs/OrderSummaryDTO.md +12 -10
- package/docs/OrderTotalModel.md +7 -7
- package/docs/OrderedItemEntity.md +14 -14
- package/docs/OrderedItemModel.md +14 -14
- package/docs/OrdersApi.md +119 -6
- package/docs/PartnerDTO.md +12 -10
- package/docs/PasswordSenderDTO.md +2 -2
- package/docs/PasswordSenderEntity.md +7 -7
- package/docs/PatchApproveRmaRequest.md +20 -0
- package/docs/PortalAccountModel.md +25 -23
- package/docs/PortalLoginModel.md +7 -7
- package/docs/PostGenerateReport200Response.md +8 -8
- package/docs/PriceListItemModel.md +2 -2
- package/docs/PricingApi.md +5 -5
- package/docs/PrinterEntity.md +5 -5
- package/docs/PrizesEntity.md +6 -6
- package/docs/ProductDetailedSummaryDTO.md +2 -2
- package/docs/ProductPriceListItemModel.md +2 -2
- package/docs/{StockProductPriceModel.md → ProductPriceModel.md} +5 -5
- package/docs/ProductSearchResultsModel.md +1 -1
- package/docs/ProductSerialInfoDTO.md +27 -0
- package/docs/ProductSerialInfoModel.md +3 -3
- package/docs/ProductSummaryDTO.md +2 -2
- package/docs/ProductsApi.md +1 -1
- package/docs/PromoCodesEntity.md +13 -13
- package/docs/PromoItemModel.md +35 -0
- package/docs/PromoItemsEntity.md +8 -8
- package/docs/PromoModel.md +45 -0
- package/docs/PromoSummariesModel.md +27 -0
- package/docs/PromoSummaryDTO.md +31 -0
- package/docs/PromotionsApi.md +241 -0
- package/docs/ProspectDTO.md +7 -7
- package/docs/ProspectEntity.md +11 -11
- package/docs/ProspectsApi.md +1 -1
- package/docs/ProvisioningApi.md +1 -1
- package/docs/ProvisioningModel.md +3 -3
- package/docs/ProvisioningRequestEntity.md +3 -3
- package/docs/RMAApi.md +1753 -0
- package/docs/ReasonRequestModel.md +21 -0
- package/docs/RecordingBackupAzureModel.md +4 -4
- package/docs/RemoteStorageDTO.md +4 -4
- package/docs/ReportRequestDTO.md +1 -1
- package/docs/ReportsApi.md +1 -1
- package/docs/RequestDTO.md +29 -0
- package/docs/ResolutionRequestModel.md +21 -0
- package/docs/ResourceNotReadyException.md +3 -3
- package/docs/ResponseDTO.md +27 -0
- package/docs/RmaCollectionDTO.md +27 -0
- package/docs/RmaCreditItemRequestDTO.md +25 -0
- package/docs/RmaDTO.md +47 -0
- package/docs/RmaItemDTO.md +35 -0
- package/docs/RmaItemRequestDTO.md +25 -0
- package/docs/RmaOrderDTO.md +33 -0
- package/docs/RmaOrderItemDTO.md +37 -0
- package/docs/RmaOrderSummaryDTO.md +25 -0
- package/docs/RmaReplacementOrderItemDTO.md +23 -0
- package/docs/RmaReplacementOrderRequestDTO.md +21 -0
- package/docs/RmaRequestDTO.md +36 -0
- package/docs/RmaReturnDTO.md +31 -0
- package/docs/RmaSummaryDTO.md +31 -0
- package/docs/RmaSummaryItemDTO.md +23 -0
- package/docs/RootAccessModel.md +3 -3
- package/docs/S3BucketEntity.md +4 -4
- package/docs/SIPTrunksApi.md +1 -1
- package/docs/SMSApi.md +1 -1
- package/docs/ScannedItemModel.md +1 -1
- package/docs/ScopeModel.md +2 -2
- package/docs/SearchSchoolModel.md +35 -0
- package/docs/SerialNumberRequestModel.md +21 -0
- package/docs/SeriesDTO.md +3 -3
- package/docs/ServiceHealthDTO.md +2 -2
- package/docs/ServiceStatusDTO.md +4 -4
- package/docs/ServicesApi.md +1 -1
- package/docs/ShipmentAddressEntity.md +11 -11
- package/docs/ShipmentDTO.md +4 -4
- package/docs/ShipmentEntity.md +12 -12
- package/docs/ShipmentItemDTO.md +2 -2
- package/docs/ShipmentItemEntity.md +5 -5
- package/docs/ShipmentItemModel.md +5 -5
- package/docs/ShipmentModel.md +12 -12
- package/docs/ShipmentRequestDTO.md +4 -4
- package/docs/ShippingApi.md +57 -1
- package/docs/ShippingConsignmentModel.md +4 -4
- package/docs/ShippingInformationDTO.md +3 -3
- package/docs/ShippingRequestDTO.md +3 -3
- package/docs/ShippingServiceDTO.md +2 -2
- package/docs/ShippingServiceModel.md +4 -4
- package/docs/ShippingServicesModel.md +1 -1
- package/docs/SipTrunkChangeResponseModel.md +5 -5
- package/docs/SipTrunkCreationRequestModel.md +6 -6
- package/docs/SipTrunkEntity.md +12 -12
- package/docs/SipTrunksResponseModel.md +4 -4
- package/docs/SmsAccountDTO.md +6 -6
- package/docs/SmsAccountEntity.md +6 -6
- package/docs/SmsAccountRequestDTO.md +5 -5
- package/docs/SmsDataModel.md +1 -1
- package/docs/SmsMessageModel.md +3 -3
- package/docs/SmsNumbersEntity.md +2 -2
- package/docs/SmsPayloadModel.md +3 -3
- package/docs/SmsPhoneNumberModel.md +1 -1
- package/docs/SmsResponseModel.md +3 -3
- package/docs/SmsWhitelistEntity.md +2 -2
- package/docs/StockManagementApi.md +1 -1
- package/docs/StockOrderCourierEntity.md +4 -4
- package/docs/StockOrderDeductionModel.md +4 -4
- package/docs/StockOrderDeductionRequestModel.md +2 -2
- package/docs/StockOrderDeductionsEntity.md +4 -4
- package/docs/StockOrderEntity.md +22 -22
- package/docs/StockOrderItemEntity.md +7 -7
- package/docs/StockOrderItemModel.md +7 -7
- package/docs/StockOrderItemRequestModel.md +4 -4
- package/docs/StockOrderModel.md +14 -14
- package/docs/StockOrderProductEntity.md +6 -6
- package/docs/StockOrderRequestModel.md +3 -3
- package/docs/StockOrderSupplierEntity.md +9 -9
- package/docs/StockOrderSupplierModel.md +9 -9
- package/docs/StockOrdersModel.md +4 -4
- package/docs/StockProductModel.md +11 -9
- package/docs/StockProductSummariesModel.md +4 -4
- package/docs/StockProductSummaryModel.md +6 -6
- package/docs/StockReportItemModel.md +6 -6
- package/docs/StockReportModel.md +5 -5
- package/docs/StockTransactionsEntity.md +8 -8
- package/docs/SupplierEntity.md +9 -9
- package/docs/SupplierItemEntity.md +8 -8
- package/docs/SupplierItemModel.md +8 -8
- package/docs/SupplierItemsResultsDTO.md +1 -1
- package/docs/SupplierModel.md +9 -9
- package/docs/SupplierProductDTO.md +43 -0
- package/docs/SupplierProductModel.md +3 -3
- package/docs/SupplierProductResultsModel.md +4 -4
- package/docs/SuppliersApi.md +57 -1
- package/docs/SupportTicketModel.md +10 -10
- package/docs/SystemApi.md +1 -1
- package/docs/TableDTO.md +3 -3
- package/docs/TableDataDTO.md +1 -1
- package/docs/TableHistoryEntity.md +8 -8
- package/docs/TableRowDTO.md +1 -1
- package/docs/TcxBackupEntity.md +9 -9
- package/docs/TcxBackupModel.md +9 -9
- package/docs/TcxBillingEntity.md +10 -10
- package/docs/TcxBulkLicenceDetailsModel.md +2 -2
- package/docs/TcxDeadLicenceEntity.md +3 -3
- package/docs/TcxEngineerTaskDTO.md +29 -0
- package/docs/TcxEngineeringDTO.md +37 -0
- package/docs/TcxInstallationModel.md +17 -17
- package/docs/TcxInstallationsModel.md +4 -4
- package/docs/TcxKeySummaryDTO.md +3 -3
- package/docs/TcxKeysEntity.md +7 -7
- package/docs/TcxLicenceDetailsErrorModel.md +4 -4
- package/docs/TcxLicenceDetailsModel.md +11 -11
- package/docs/TcxMacsEntity.md +3 -3
- package/docs/TcxMultiTenantModel.md +7 -7
- package/docs/TcxMultiTenantUserModel.md +3 -3
- package/docs/TcxMultiTenantsModel.md +4 -4
- package/docs/TcxRemoteStorageModel.md +4 -4
- package/docs/TcxSbcDTO.md +7 -7
- package/docs/TcxSbcResponseDTO.md +2 -2
- package/docs/TcxSetupsModel.md +4 -4
- package/docs/TcxSummaryDTO.md +23 -0
- package/docs/TcxTemplateXmlEnum.md +2 -2
- package/docs/TcxUsersEntity.md +6 -6
- package/docs/TcxWizardConfigModel.md +2 -2
- package/docs/TcxWizardModel.md +2 -0
- package/docs/TechSupportCompanySummaryDTO.md +5 -5
- package/docs/ThumbnailDTO.md +25 -0
- package/docs/TicketSummaryModel.md +6 -6
- package/docs/TicketTimeDTO.md +9 -9
- package/docs/TicketsApi.md +11 -11
- package/docs/TokenResponseModel.md +3 -3
- package/docs/UpgradeOrderResponseModel.md +2 -2
- package/docs/UpgradeRequestModel.md +4 -4
- package/docs/UserEntity.md +10 -10
- package/docs/VideoRequestEntity.md +51 -0
- package/docs/WebhooksApi.md +1 -1
- package/docs/XeroLogEntity.md +10 -10
- package/getEnums.php +31 -31
- package/git_push.sh +14 -17
- package/index.ts +1 -1
- package/models/AgentEnum.ts +49 -0
- package/models/CategoryEnum.ts +109 -0
- package/models/ConnectionTypeEnum.ts +17 -7
- package/models/ReasonEnum.ts +19 -0
- package/models/ReportEnum.ts +11 -1
- package/models/ResolutionEnum.ts +19 -0
- package/models/RmaItemCreditTypeEnum.ts +14 -0
- package/models/RmaItemResolutionEnum.ts +29 -0
- package/models/RmaItemStatusEnum.ts +19 -0
- package/models/RmaStatusEnum.ts +34 -0
- package/openapitools.json +1 -1
- package/package.json +2 -2
|
@@ -1 +1 @@
|
|
|
1
|
-
7.
|
|
1
|
+
7.26.0
|
package/README.md
CHANGED
|
@@ -47,7 +47,7 @@ npm install PATH_TO_GENERATED_PACKAGE --save
|
|
|
47
47
|
|
|
48
48
|
### Documentation for API Endpoints
|
|
49
49
|
|
|
50
|
-
All URIs are relative to *https://
|
|
50
|
+
All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
51
51
|
|
|
52
52
|
Class | Method | HTTP request | Description
|
|
53
53
|
------------ | ------------- | ------------- | -------------
|
|
@@ -65,9 +65,11 @@ Class | Method | HTTP request | Description
|
|
|
65
65
|
*AccountsApi* | [**getGetCustomerAccountsList**](docs/AccountsApi.md#getgetcustomeraccountslist) | **GET** /admin/accounts/customers/list |
|
|
66
66
|
*AccountsApi* | [**getGetCustomerKeys**](docs/AccountsApi.md#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys
|
|
67
67
|
*AccountsApi* | [**getGetCustomerMap**](docs/AccountsApi.md#getgetcustomermap) | **GET** /admin/accounts/customer/map |
|
|
68
|
+
*AccountsApi* | [**getGetDeliveryAddresses**](docs/AccountsApi.md#getgetdeliveryaddresses) | **GET** /accounts/addresses/delivery |
|
|
68
69
|
*AccountsApi* | [**getGetFinanceSettings**](docs/AccountsApi.md#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance |
|
|
69
70
|
*AccountsApi* | [**getGetLastAccount**](docs/AccountsApi.md#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account
|
|
70
71
|
*AccountsApi* | [**getGetNewPriceList**](docs/AccountsApi.md#getgetnewpricelist) | **GET** /admin/accounts/priceList/new | Download New Price List
|
|
72
|
+
*AccountsApi* | [**getGetTcxHostingPriceList**](docs/AccountsApi.md#getgettcxhostingpricelist) | **GET** /admin/accounts/{id}/tcx/hosting/pricelist |
|
|
71
73
|
*AccountsApi* | [**getGetTcxPartnerDetails**](docs/AccountsApi.md#getgettcxpartnerdetails) | **GET** /admin/accounts/{id}/tcx/partner |
|
|
72
74
|
*AccountsApi* | [**getVerifyEmailAddress**](docs/AccountsApi.md#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address
|
|
73
75
|
*AccountsApi* | [**patchSetAccountStatus**](docs/AccountsApi.md#patchsetaccountstatus) | **PATCH** /admin/accounts/{id}/status/{state} |
|
|
@@ -94,6 +96,7 @@ Class | Method | HTTP request | Description
|
|
|
94
96
|
*AccountsApi* | [**postSendEmailVerificationEmail**](docs/AccountsApi.md#postsendemailverificationemail) | **POST** /accounts/contacts/verify/{email} | Send email verification email
|
|
95
97
|
*AccountsApi* | [**postSendPasswordReset**](docs/AccountsApi.md#postsendpasswordreset) | **POST** /accounts/contacts/password/reset | Send password reset email
|
|
96
98
|
*AccountsApi* | [**postSendWelcomeEmail**](docs/AccountsApi.md#postsendwelcomeemail) | **POST** /admin/accounts/{id}/email/welcome |
|
|
99
|
+
*AccountsApi* | [**postSendXeroDocument**](docs/AccountsApi.md#postsendxerodocument) | **POST** /admin/finance/documents/send | Send Xero Document
|
|
97
100
|
*AccountsApi* | [**postSubmitResellerApplication**](docs/AccountsApi.md#postsubmitresellerapplication) | **POST** /accounts/reseller | Submit reseller application
|
|
98
101
|
*AccountsApi* | [**putAdminUpdateAccountContact**](docs/AccountsApi.md#putadminupdateaccountcontact) | **PUT** /admin/accounts/{id}/contacts/{contact_id} |
|
|
99
102
|
*AccountsApi* | [**putUpdateAccountContact**](docs/AccountsApi.md#putupdateaccountcontact) | **PUT** /accounts/me/contacts/{email} | Update Account Contact
|
|
@@ -156,6 +159,7 @@ Class | Method | HTTP request | Description
|
|
|
156
159
|
*BillingApi* | [**postUpdateRecurringCharge**](docs/BillingApi.md#postupdaterecurringcharge) | **POST** /billing/customer/updateRecurringCharges |
|
|
157
160
|
*BillingApi* | [**putAddCallTariffToCallTariffPlan**](docs/BillingApi.md#putaddcalltarifftocalltariffplan) | **PUT** /billing/admin/callTariffPlan/callTariff |
|
|
158
161
|
*BillingApi* | [**putAddServiceToServicePlan**](docs/BillingApi.md#putaddservicetoserviceplan) | **PUT** /billing/admin/servicePlan/service |
|
|
162
|
+
*BillingApi* | [**putChangeParent**](docs/BillingApi.md#putchangeparent) | **PUT** /billing/admin/parent/change |
|
|
159
163
|
*BillingApi* | [**putConnectionSearch**](docs/BillingApi.md#putconnectionsearch) | **PUT** /billing/admin/connections |
|
|
160
164
|
*BillingApi* | [**putConvertChildToParent**](docs/BillingApi.md#putconvertchildtoparent) | **PUT** /billing/customer/makeParent |
|
|
161
165
|
*BillingApi* | [**putDisableBundles**](docs/BillingApi.md#putdisablebundles) | **PUT** /billing/customer/disableBundles |
|
|
@@ -166,9 +170,18 @@ Class | Method | HTTP request | Description
|
|
|
166
170
|
*BillingApi* | [**putGetCallTariffPlan**](docs/BillingApi.md#putgetcalltariffplan) | **PUT** /billing/admin/callTariffPlan |
|
|
167
171
|
*BillingApi* | [**putGetConnections**](docs/BillingApi.md#putgetconnections) | **PUT** /billing/customer/connections |
|
|
168
172
|
*BillingApi* | [**putGetPriceGroups**](docs/BillingApi.md#putgetpricegroups) | **PUT** /billing/admin/priceGroups |
|
|
173
|
+
*BrandedVideosApi* | [**deleteDeleteVideoRequest**](docs/BrandedVideosApi.md#deletedeletevideorequest) | **DELETE** /marketing/videos/{id} |
|
|
174
|
+
*BrandedVideosApi* | [**getDownloadLogo**](docs/BrandedVideosApi.md#getdownloadlogo) | **GET** /marketing/videos/logo |
|
|
175
|
+
*BrandedVideosApi* | [**getGetBrandedVideos**](docs/BrandedVideosApi.md#getgetbrandedvideos) | **GET** /marketing/videos |
|
|
176
|
+
*BrandedVideosApi* | [**getGetThumbnails**](docs/BrandedVideosApi.md#getgetthumbnails) | **GET** /marketing/videos/thumbnails |
|
|
177
|
+
*BrandedVideosApi* | [**postDownloadLogo**](docs/BrandedVideosApi.md#postdownloadlogo) | **POST** /marketing/videos/logo |
|
|
178
|
+
*BrandedVideosApi* | [**postSendBrandedVideoEmail**](docs/BrandedVideosApi.md#postsendbrandedvideoemail) | **POST** /marketing/videos/{id}/send |
|
|
179
|
+
*BrandedVideosApi* | [**postUploadVideo**](docs/BrandedVideosApi.md#postuploadvideo) | **POST** /marketing/videos/{id}/upload |
|
|
169
180
|
*CRMApi* | [**getGetCrmActivities**](docs/CRMApi.md#getgetcrmactivities) | **GET** /admin/crm/{id}/activities |
|
|
170
181
|
*CRMApi* | [**getSearchByPhone**](docs/CRMApi.md#getsearchbyphone) | **GET** /crm/contact/search |
|
|
171
182
|
*CRMApi* | [**postCreateCrmNote**](docs/CRMApi.md#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note |
|
|
183
|
+
*CRMApi* | [**postJournalCall**](docs/CRMApi.md#postjournalcall) | **POST** /crm/contact/{id}/journal |
|
|
184
|
+
*Class3CXApi* | [**getGetCCDevices**](docs/Class3CXApi.md#getgetccdevices) | **GET** /tcx/cc/devices |
|
|
172
185
|
*Class3CXApi* | [**getGetLicenceDetails**](docs/Class3CXApi.md#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details
|
|
173
186
|
*Class3CXApi* | [**getGetTcxCreditStatus**](docs/Class3CXApi.md#getgettcxcreditstatus) | **GET** /tcx/admin/credit | Get 3CX Credit Status
|
|
174
187
|
*Class3CXApi* | [**getGetTcxExpiringKeys**](docs/Class3CXApi.md#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring | Get 3CX Expiring Keys
|
|
@@ -187,6 +200,7 @@ Class | Method | HTTP request | Description
|
|
|
187
200
|
*Class3CXInstallationWizardApi* | [**getGetHostingRegions**](docs/Class3CXInstallationWizardApi.md#getgethostingregions) | **GET** /tcx/wizards/regions | Get 3CX Hosting Regions
|
|
188
201
|
*Class3CXInstallationWizardApi* | [**getGetInstallStatus**](docs/Class3CXInstallationWizardApi.md#getgetinstallstatus) | **GET** /tcx/wizard/build/status | Get 3CX Instance Install Status
|
|
189
202
|
*Class3CXInstallationWizardApi* | [**getGetInstanceInstallStatus**](docs/Class3CXInstallationWizardApi.md#getgetinstanceinstallstatus) | **GET** /tcx/wizards/instances/build/status | Get 3CX Instance Install Status
|
|
203
|
+
*Class3CXInstallationWizardApi* | [**getGetOrderItems**](docs/Class3CXInstallationWizardApi.md#getgetorderitems) | **GET** /tcx/wizards/order/items | Get all items on the order linked to this wizard\'s licence key
|
|
190
204
|
*Class3CXInstallationWizardApi* | [**getGetPbxIpAddress**](docs/Class3CXInstallationWizardApi.md#getgetpbxipaddress) | **GET** /tcx/wizards/instances/ip | Get PBX IP Address
|
|
191
205
|
*Class3CXInstallationWizardApi* | [**getGetSipTrunkTcxWizard**](docs/Class3CXInstallationWizardApi.md#getgetsiptrunktcxwizard) | **GET** /tcx/wizards/sip/trunks/{id} | Get SIP Trunk
|
|
192
206
|
*Class3CXInstallationWizardApi* | [**getGetSipTrunksTcxWizard**](docs/Class3CXInstallationWizardApi.md#getgetsiptrunkstcxwizard) | **GET** /tcx/wizards/sip/trunks | Get SIP Trunks
|
|
@@ -195,7 +209,13 @@ Class | Method | HTTP request | Description
|
|
|
195
209
|
*Class3CXInstallationWizardApi* | [**patchAddNumbers**](docs/Class3CXInstallationWizardApi.md#patchaddnumbers) | **PATCH** /tcx/wizards/numbers | Update 3CX Installation Wizard Numbers
|
|
196
210
|
*Class3CXInstallationWizardApi* | [**patchAddPhones**](docs/Class3CXInstallationWizardApi.md#patchaddphones) | **PATCH** /tcx/wizards/phones | Update 3CX Installation Wizard Phones
|
|
197
211
|
*Class3CXInstallationWizardApi* | [**patchAddSbcs**](docs/Class3CXInstallationWizardApi.md#patchaddsbcs) | **PATCH** /tcx/wizards/sbcs | Update 3CX Installation Wizard SBCs
|
|
212
|
+
*Class3CXInstallationWizardApi* | [**patchAllocateEngineer**](docs/Class3CXInstallationWizardApi.md#patchallocateengineer) | **PATCH** /tcx/wizards/engineering/engineer |
|
|
198
213
|
*Class3CXInstallationWizardApi* | [**patchGetWizard**](docs/Class3CXInstallationWizardApi.md#patchgetwizard) | **PATCH** /tcx/wizards | Update 3CX Installation Wizard
|
|
214
|
+
*Class3CXInstallationWizardApi* | [**patchMarkEngineerTaskAsComplete**](docs/Class3CXInstallationWizardApi.md#patchmarkengineertaskascomplete) | **PATCH** /tcx/wizards/engineering/tasks/{task_id}/complete |
|
|
215
|
+
*Class3CXInstallationWizardApi* | [**patchUpdateEngineerTaskNote**](docs/Class3CXInstallationWizardApi.md#patchupdateengineertasknote) | **PATCH** /tcx/wizards/engineering/tasks/{task_id}/note |
|
|
216
|
+
*Class3CXInstallationWizardApi* | [**patchUpdateGoLiveDate**](docs/Class3CXInstallationWizardApi.md#patchupdategolivedate) | **PATCH** /tcx/wizards/engineering/go_live_date |
|
|
217
|
+
*Class3CXInstallationWizardApi* | [**patchUpdateNote**](docs/Class3CXInstallationWizardApi.md#patchupdatenote) | **PATCH** /tcx/wizards/engineering/note |
|
|
218
|
+
*Class3CXInstallationWizardApi* | [**patchUpdateSpec**](docs/Class3CXInstallationWizardApi.md#patchupdatespec) | **PATCH** /tcx/wizards/engineering/spec |
|
|
199
219
|
*Class3CXInstallationWizardApi* | [**postAddExtensions**](docs/Class3CXInstallationWizardApi.md#postaddextensions) | **POST** /tcx/wizards/extensions | Add Extensions To 3CX Installation Wizard
|
|
200
220
|
*Class3CXInstallationWizardApi* | [**postAddNumbers**](docs/Class3CXInstallationWizardApi.md#postaddnumbers) | **POST** /tcx/wizards/numbers | Add Numbers To 3CX Installation Wizard
|
|
201
221
|
*Class3CXInstallationWizardApi* | [**postAddPhones**](docs/Class3CXInstallationWizardApi.md#postaddphones) | **POST** /tcx/wizards/phones | Add Phones To 3CX Installation Wizard
|
|
@@ -232,6 +252,7 @@ Class | Method | HTTP request | Description
|
|
|
232
252
|
*Class3CXIntegrationsApi* | [**getGetPrice**](docs/Class3CXIntegrationsApi.md#getgetprice) | **GET** /tcx/integrations/edtechpro/prices |
|
|
233
253
|
*Class3CXIntegrationsApi* | [**getGetSchools**](docs/Class3CXIntegrationsApi.md#getgetschools) | **GET** /tcx/integrations/edtechpro/schools |
|
|
234
254
|
*Class3CXIntegrationsApi* | [**getGetTrusts**](docs/Class3CXIntegrationsApi.md#getgettrusts) | **GET** /tcx/integrations/edtechpro/trusts |
|
|
255
|
+
*Class3CXIntegrationsApi* | [**getSearchSchools**](docs/Class3CXIntegrationsApi.md#getsearchschools) | **GET** /tcx/integrations/edtechpro/search/schools |
|
|
235
256
|
*Class3CXIntegrationsApi* | [**patchUpdateEtpOrderReference**](docs/Class3CXIntegrationsApi.md#patchupdateetporderreference) | **PATCH** /tcx/integrations/edtechpro/{clientId}/schools/{schoolId}/orderReference |
|
|
236
257
|
*Class3CXIntegrationsApi* | [**postOrderEdTechPro**](docs/Class3CXIntegrationsApi.md#postorderedtechpro) | **POST** /tcx/integrations/edtechpro/orders |
|
|
237
258
|
*Class3CXIntegrationsApi* | [**postUpgradeEdTechPro**](docs/Class3CXIntegrationsApi.md#postupgradeedtechpro) | **POST** /tcx/integrations/edtechpro/upgrades |
|
|
@@ -270,6 +291,7 @@ Class | Method | HTTP request | Description
|
|
|
270
291
|
*OrdersApi* | [**getGetAdminEditableOrder**](docs/OrdersApi.md#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)
|
|
271
292
|
*OrdersApi* | [**getGetAdminOrderDetails**](docs/OrdersApi.md#getgetadminorderdetails) | **GET** /admin/orders/{id}/details | Get Order Details (Admin)
|
|
272
293
|
*OrdersApi* | [**getGetCommercialInvoice**](docs/OrdersApi.md#getgetcommercialinvoice) | **GET** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/pdf | Get Commercial Invoice PDF
|
|
294
|
+
*OrdersApi* | [**getGetCustomerOrderSummary**](docs/OrdersApi.md#getgetcustomerordersummary) | **GET** /orders/{id}/summary |
|
|
273
295
|
*OrdersApi* | [**getGetEditableOrder**](docs/OrdersApi.md#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)
|
|
274
296
|
*OrdersApi* | [**getGetItemSerialInfo**](docs/OrdersApi.md#getgetitemserialinfo) | **GET** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)
|
|
275
297
|
*OrdersApi* | [**getGetOrderPdf**](docs/OrdersApi.md#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF
|
|
@@ -281,6 +303,7 @@ Class | Method | HTTP request | Description
|
|
|
281
303
|
*OrdersApi* | [**postCreateConsignment**](docs/OrdersApi.md#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment
|
|
282
304
|
*OrdersApi* | [**postCreatePortalOrderLegacy**](docs/OrdersApi.md#postcreateportalorderlegacy) | **POST** /orders/portal/legacy | Create an order via the legacy portal
|
|
283
305
|
*OrdersApi* | [**postCreateShipment**](docs/OrdersApi.md#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)
|
|
306
|
+
*OrdersApi* | [**postCreateWizardFromOrder**](docs/OrdersApi.md#postcreatewizardfromorder) | **POST** /admin/orders/{id}/wizard |
|
|
284
307
|
*OrdersApi* | [**postGetOrders**](docs/OrdersApi.md#postgetorders) | **POST** /orders | Create An Order (Beta)
|
|
285
308
|
*OrdersApi* | [**postIssueCredit**](docs/OrdersApi.md#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)
|
|
286
309
|
*OrdersApi* | [**postPrintShippingLabel**](docs/OrdersApi.md#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label
|
|
@@ -307,6 +330,10 @@ Class | Method | HTTP request | Description
|
|
|
307
330
|
*ProductsApi* | [**patchAddQuantityToStock**](docs/ProductsApi.md#patchaddquantitytostock) | **PATCH** /products/{sku}/stock/add | Add Item Quantity To Stock
|
|
308
331
|
*ProductsApi* | [**postGetProduct**](docs/ProductsApi.md#postgetproduct) | **POST** /products/{sku} | Get Product
|
|
309
332
|
*ProductsApi* | [**postGetProductForCustomer**](docs/ProductsApi.md#postgetproductforcustomer) | **POST** /admin/products/{sku} | Get Product For Customer
|
|
333
|
+
*PromotionsApi* | [**getGetPromo**](docs/PromotionsApi.md#getgetpromo) | **GET** /marketing/promos/{id} |
|
|
334
|
+
*PromotionsApi* | [**getGetPromos**](docs/PromotionsApi.md#getgetpromos) | **GET** /marketing/promos |
|
|
335
|
+
*PromotionsApi* | [**postGetPromos**](docs/PromotionsApi.md#postgetpromos) | **POST** /marketing/promos |
|
|
336
|
+
*PromotionsApi* | [**putGetPromo**](docs/PromotionsApi.md#putgetpromo) | **PUT** /marketing/promos/{id} |
|
|
310
337
|
*ProspectsApi* | [**getGetProspect**](docs/ProspectsApi.md#getgetprospect) | **GET** /accounts/prospects/{xero_id} | Get Prospect
|
|
311
338
|
*ProspectsApi* | [**getGetProspects**](docs/ProspectsApi.md#getgetprospects) | **GET** /accounts/prospects | Get Prospects
|
|
312
339
|
*ProspectsApi* | [**getRemoveFromProspects**](docs/ProspectsApi.md#getremovefromprospects) | **GET** /accounts/prospects/{xero_id}/remove | Remove From Prospects
|
|
@@ -321,6 +348,36 @@ Class | Method | HTTP request | Description
|
|
|
321
348
|
*ProvisioningApi* | [**postAddFanvilGroup**](docs/ProvisioningApi.md#postaddfanvilgroup) | **POST** /provisioning/fanvil/groups | Add group to DB and FDPS
|
|
322
349
|
*ProvisioningApi* | [**postAddFanvilMac**](docs/ProvisioningApi.md#postaddfanvilmac) | **POST** /provisioning/fanvil/groups/{id}/macs/{mac} | Add MAC address to DB and FDPS group
|
|
323
350
|
*ProvisioningApi* | [**postCreateMac**](docs/ProvisioningApi.md#postcreatemac) | **POST** /admin/provisioning/fanvil/macs |
|
|
351
|
+
*RMAApi* | [**deleteDeleteRmaItem**](docs/RMAApi.md#deletedeletermaitem) | **DELETE** /admin/rma/{id}/items/{item_id} |
|
|
352
|
+
*RMAApi* | [**deleteGetAdminRma**](docs/RMAApi.md#deletegetadminrma) | **DELETE** /admin/rma/{id} |
|
|
353
|
+
*RMAApi* | [**getCreateRma**](docs/RMAApi.md#getcreaterma) | **GET** /rma |
|
|
354
|
+
*RMAApi* | [**getGetAdminRma**](docs/RMAApi.md#getgetadminrma) | **GET** /admin/rma/{id} |
|
|
355
|
+
*RMAApi* | [**getGetAdminRmaOrder**](docs/RMAApi.md#getgetadminrmaorder) | **GET** /admin/rma/{id}/order |
|
|
356
|
+
*RMAApi* | [**getGetAdminRmas**](docs/RMAApi.md#getgetadminrmas) | **GET** /admin/rma |
|
|
357
|
+
*RMAApi* | [**getGetRma**](docs/RMAApi.md#getgetrma) | **GET** /rma/{id} |
|
|
358
|
+
*RMAApi* | [**getGetRmaOrder**](docs/RMAApi.md#getgetrmaorder) | **GET** /rma/orders/{id} |
|
|
359
|
+
*RMAApi* | [**getSearchAdvanceReplacementOrders**](docs/RMAApi.md#getsearchadvancereplacementorders) | **GET** /rma/advance_replacement/orders |
|
|
360
|
+
*RMAApi* | [**getSearchRmaOrders**](docs/RMAApi.md#getsearchrmaorders) | **GET** /rma/orders |
|
|
361
|
+
*RMAApi* | [**patchApproveRma**](docs/RMAApi.md#patchapproverma) | **PATCH** /admin/rma/{id}/approve |
|
|
362
|
+
*RMAApi* | [**patchMarkRmaItemAsBinned**](docs/RMAApi.md#patchmarkrmaitemasbinned) | **PATCH** /admin/rma/{id}/items/{item_id}/bin |
|
|
363
|
+
*RMAApi* | [**patchMarkRmaItemAsReceived**](docs/RMAApi.md#patchmarkrmaitemasreceived) | **PATCH** /admin/rma/{id}/items/{item_id}/received |
|
|
364
|
+
*RMAApi* | [**patchMarkRmaItemAsUnresolved**](docs/RMAApi.md#patchmarkrmaitemasunresolved) | **PATCH** /admin/rma/{id}/items/{item_id}/unresolved |
|
|
365
|
+
*RMAApi* | [**patchRejectRma**](docs/RMAApi.md#patchrejectrma) | **PATCH** /admin/rma/{id}/reject |
|
|
366
|
+
*RMAApi* | [**patchResolveRma**](docs/RMAApi.md#patchresolverma) | **PATCH** /admin/rma/{id}/resolve |
|
|
367
|
+
*RMAApi* | [**patchUpdateRmaContactEmail**](docs/RMAApi.md#patchupdatermacontactemail) | **PATCH** /admin/rma/{id}/contactEmail |
|
|
368
|
+
*RMAApi* | [**patchUpdateRmaContactName**](docs/RMAApi.md#patchupdatermacontactname) | **PATCH** /admin/rma/{id}/contactName |
|
|
369
|
+
*RMAApi* | [**patchUpdateRmaItemMacAddress**](docs/RMAApi.md#patchupdatermaitemmacaddress) | **PATCH** /admin/rma/{id}/items/{item_id}/mac |
|
|
370
|
+
*RMAApi* | [**patchUpdateRmaItemNote**](docs/RMAApi.md#patchupdatermaitemnote) | **PATCH** /admin/rma/{id}/items/{item_id}/note |
|
|
371
|
+
*RMAApi* | [**patchUpdateRmaItemSerialNumber**](docs/RMAApi.md#patchupdatermaitemserialnumber) | **PATCH** /admin/rma/{id}/items/{item_id}/serial |
|
|
372
|
+
*RMAApi* | [**patchUpdateRmaReason**](docs/RMAApi.md#patchupdatermareason) | **PATCH** /admin/rma/{id}/reason |
|
|
373
|
+
*RMAApi* | [**patchUpdateRmaResolution**](docs/RMAApi.md#patchupdatermaresolution) | **PATCH** /admin/rma/{id}/resolution |
|
|
374
|
+
*RMAApi* | [**patchUpdateRmaReturnAddress**](docs/RMAApi.md#patchupdatermareturnaddress) | **PATCH** /admin/rma/{id}/address |
|
|
375
|
+
*RMAApi* | [**postCreateReplacementOrder**](docs/RMAApi.md#postcreatereplacementorder) | **POST** /admin/rma/{id}/replacement_order |
|
|
376
|
+
*RMAApi* | [**postCreateRma**](docs/RMAApi.md#postcreaterma) | **POST** /rma |
|
|
377
|
+
*RMAApi* | [**postCreateRmaCollection**](docs/RMAApi.md#postcreatermacollection) | **POST** /admin/rma/{id}/collection |
|
|
378
|
+
*RMAApi* | [**postCreateRmaCreditNote**](docs/RMAApi.md#postcreatermacreditnote) | **POST** /admin/rma/{id}/credit |
|
|
379
|
+
*RMAApi* | [**postCreateRmaNote**](docs/RMAApi.md#postcreatermanote) | **POST** /admin/rma/{id}/notes |
|
|
380
|
+
*RMAApi* | [**postCreateRmaReturn**](docs/RMAApi.md#postcreatermareturn) | **POST** /admin/rma/{id}/return |
|
|
324
381
|
*ReportsApi* | [**getGetStockReport**](docs/ReportsApi.md#getgetstockreport) | **GET** /reports/stock |
|
|
325
382
|
*ReportsApi* | [**postGenerateReport**](docs/ReportsApi.md#postgeneratereport) | **POST** /reports | Generate Reports
|
|
326
383
|
*SIPTrunksApi* | [**deleteGetSipTrunk**](docs/SIPTrunksApi.md#deletegetsiptrunk) | **DELETE** /sip/trunks/{id} | Delete SIP Trunk
|
|
@@ -356,6 +413,7 @@ Class | Method | HTTP request | Description
|
|
|
356
413
|
*ServicesApi* | [**postCreateEventUpdate**](docs/ServicesApi.md#postcreateeventupdate) | **POST** /services/events/{id}/updates |
|
|
357
414
|
*ServicesApi* | [**postSubscribe**](docs/ServicesApi.md#postsubscribe) | **POST** /services/events/subscribe |
|
|
358
415
|
*ShippingApi* | [**postGetAdminShippingServices**](docs/ShippingApi.md#postgetadminshippingservices) | **POST** /admin/shipping/services | Get Shipping Services
|
|
416
|
+
*ShippingApi* | [**postGetCollectionDates**](docs/ShippingApi.md#postgetcollectiondates) | **POST** /shipping/collections/dates |
|
|
359
417
|
*ShippingApi* | [**postGetShippingServices**](docs/ShippingApi.md#postgetshippingservices) | **POST** /shipping/services | Get Shipping Services
|
|
360
418
|
*StockManagementApi* | [**deleteDeleteStockOrder**](docs/StockManagementApi.md#deletedeletestockorder) | **DELETE** /stock/orders/{id} | Delete Stock Order
|
|
361
419
|
*StockManagementApi* | [**deleteDeleteStockOrderDeduction**](docs/StockManagementApi.md#deletedeletestockorderdeduction) | **DELETE** /stock/orders/{order_id}/deductions/{deduction_id} | Delete Stock Order Deduction
|
|
@@ -384,6 +442,7 @@ Class | Method | HTTP request | Description
|
|
|
384
442
|
*SuppliersApi* | [**getGetSupplierItem**](docs/SuppliersApi.md#getgetsupplieritem) | **GET** /suppliers/items/{id} | Get Supplier Item
|
|
385
443
|
*SuppliersApi* | [**getGetSupplierItems**](docs/SuppliersApi.md#getgetsupplieritems) | **GET** /suppliers/items | Get Supplier Items
|
|
386
444
|
*SuppliersApi* | [**getGetSuppliers**](docs/SuppliersApi.md#getgetsuppliers) | **GET** /suppliers | Get Suppliers
|
|
445
|
+
*SuppliersApi* | [**postGetSupplierItems**](docs/SuppliersApi.md#postgetsupplieritems) | **POST** /suppliers/items |
|
|
387
446
|
*SuppliersApi* | [**putGetSupplierItem**](docs/SuppliersApi.md#putgetsupplieritem) | **PUT** /suppliers/items/{id} | Update Supplier Product
|
|
388
447
|
*SystemApi* | [**getLogSearch**](docs/SystemApi.md#getlogsearch) | **GET** /system/logs/api/search | Search for logs
|
|
389
448
|
*TicketsApi* | [**getCreateTicket**](docs/TicketsApi.md#getcreateticket) | **GET** /tickets/support |
|
|
@@ -410,8 +469,13 @@ Class | Method | HTTP request | Description
|
|
|
410
469
|
- [AddressDTO](docs/AddressDTO.md)
|
|
411
470
|
- [AddressModel](docs/AddressModel.md)
|
|
412
471
|
- [AddressRequestModel](docs/AddressRequestModel.md)
|
|
472
|
+
- [AdminCustomerRmasModel](docs/AdminCustomerRmasModel.md)
|
|
413
473
|
- [AdminNumberPortDTO](docs/AdminNumberPortDTO.md)
|
|
414
474
|
- [AdminOrderRequestDTO](docs/AdminOrderRequestDTO.md)
|
|
475
|
+
- [AdminRmaDTO](docs/AdminRmaDTO.md)
|
|
476
|
+
- [AdminRmaItemDTO](docs/AdminRmaItemDTO.md)
|
|
477
|
+
- [AdminRmaNoteDTO](docs/AdminRmaNoteDTO.md)
|
|
478
|
+
- [AdminRmaSummaryDTO](docs/AdminRmaSummaryDTO.md)
|
|
415
479
|
- [AdminUserModel](docs/AdminUserModel.md)
|
|
416
480
|
- [AgentHoursGraphModel](docs/AgentHoursGraphModel.md)
|
|
417
481
|
- [AgentHoursGraphMonthModel](docs/AgentHoursGraphMonthModel.md)
|
|
@@ -427,15 +491,20 @@ Class | Method | HTTP request | Description
|
|
|
427
491
|
- [BasicProductDTO](docs/BasicProductDTO.md)
|
|
428
492
|
- [BatchDTO](docs/BatchDTO.md)
|
|
429
493
|
- [BatchEntity](docs/BatchEntity.md)
|
|
494
|
+
- [BrandedVideoSummaryDTO](docs/BrandedVideoSummaryDTO.md)
|
|
495
|
+
- [BrandedVideosSummariesModel](docs/BrandedVideosSummariesModel.md)
|
|
430
496
|
- [Bundle](docs/Bundle.md)
|
|
431
497
|
- [BundleCustomer](docs/BundleCustomer.md)
|
|
432
498
|
- [CallBarringModel](docs/CallBarringModel.md)
|
|
499
|
+
- [CallJournalRequestModel](docs/CallJournalRequestModel.md)
|
|
433
500
|
- [CallTariff](docs/CallTariff.md)
|
|
434
501
|
- [CallTariffPlan](docs/CallTariffPlan.md)
|
|
435
502
|
- [CallTariffResponse](docs/CallTariffResponse.md)
|
|
436
503
|
- [Cdr](docs/Cdr.md)
|
|
437
504
|
- [ClientDetailsModel](docs/ClientDetailsModel.md)
|
|
438
505
|
- [ClientModel](docs/ClientModel.md)
|
|
506
|
+
- [CollectionDateDTO](docs/CollectionDateDTO.md)
|
|
507
|
+
- [CollectionDatesRequestDTO](docs/CollectionDatesRequestDTO.md)
|
|
439
508
|
- [CompanyContractModel](docs/CompanyContractModel.md)
|
|
440
509
|
- [ConnectionRequest](docs/ConnectionRequest.md)
|
|
441
510
|
- [ConnectionType](docs/ConnectionType.md)
|
|
@@ -467,17 +536,21 @@ Class | Method | HTTP request | Description
|
|
|
467
536
|
- [CustomerPriceListEnum](docs/CustomerPriceListEnum.md)
|
|
468
537
|
- [CustomerRate](docs/CustomerRate.md)
|
|
469
538
|
- [CustomerRateType](docs/CustomerRateType.md)
|
|
539
|
+
- [CustomerRmasModel](docs/CustomerRmasModel.md)
|
|
470
540
|
- [CustomerSummaryReportDTO](docs/CustomerSummaryReportDTO.md)
|
|
471
541
|
- [DdiRangeRequestModel](docs/DdiRangeRequestModel.md)
|
|
472
542
|
- [DdiRangesRequestModel](docs/DdiRangesRequestModel.md)
|
|
473
543
|
- [DetailedItemRequestDTO](docs/DetailedItemRequestDTO.md)
|
|
474
544
|
- [DetailedOrderRequestDTO](docs/DetailedOrderRequestDTO.md)
|
|
545
|
+
- [DeviceModel](docs/DeviceModel.md)
|
|
475
546
|
- [DivertRequestModel](docs/DivertRequestModel.md)
|
|
476
547
|
- [DivertResponseModel](docs/DivertResponseModel.md)
|
|
477
548
|
- [EdTechProClientEntity](docs/EdTechProClientEntity.md)
|
|
478
549
|
- [EdTechProSchoolModel](docs/EdTechProSchoolModel.md)
|
|
479
550
|
- [EdTechProSchoolsModel](docs/EdTechProSchoolsModel.md)
|
|
480
551
|
- [EdTechProSetupModel](docs/EdTechProSetupModel.md)
|
|
552
|
+
- [EmailRequestModel](docs/EmailRequestModel.md)
|
|
553
|
+
- [EngineeredWizardRequestModel](docs/EngineeredWizardRequestModel.md)
|
|
481
554
|
- [EventDTO](docs/EventDTO.md)
|
|
482
555
|
- [EventRequestDTO](docs/EventRequestDTO.md)
|
|
483
556
|
- [EventSubscriptionModel](docs/EventSubscriptionModel.md)
|
|
@@ -493,6 +566,7 @@ Class | Method | HTTP request | Description
|
|
|
493
566
|
- [GetCheckMacExists200Response](docs/GetCheckMacExists200Response.md)
|
|
494
567
|
- [GetGetPrice200Response](docs/GetGetPrice200Response.md)
|
|
495
568
|
- [GetGetRecording200Response](docs/GetGetRecording200Response.md)
|
|
569
|
+
- [GetGetTcxHostingPriceList200Response](docs/GetGetTcxHostingPriceList200Response.md)
|
|
496
570
|
- [GraphDTO](docs/GraphDTO.md)
|
|
497
571
|
- [HostingChangeResponseModel](docs/HostingChangeResponseModel.md)
|
|
498
572
|
- [HostingRegionDTO](docs/HostingRegionDTO.md)
|
|
@@ -512,13 +586,17 @@ Class | Method | HTTP request | Description
|
|
|
512
586
|
- [ItemDTO](docs/ItemDTO.md)
|
|
513
587
|
- [ItemDiscountEntity](docs/ItemDiscountEntity.md)
|
|
514
588
|
- [ItemEntity](docs/ItemEntity.md)
|
|
589
|
+
- [ItemResolutionRequestModel](docs/ItemResolutionRequestModel.md)
|
|
515
590
|
- [LinkedOrderEntity](docs/LinkedOrderEntity.md)
|
|
516
591
|
- [MFARequiredModel](docs/MFARequiredModel.md)
|
|
517
592
|
- [MacAddressDTO](docs/MacAddressDTO.md)
|
|
593
|
+
- [MacAddressRequestModel](docs/MacAddressRequestModel.md)
|
|
518
594
|
- [MonthlyUsageModel](docs/MonthlyUsageModel.md)
|
|
519
595
|
- [MultiTenantChangeResponseModel](docs/MultiTenantChangeResponseModel.md)
|
|
520
596
|
- [MultiTenantSipTrunkRequest](docs/MultiTenantSipTrunkRequest.md)
|
|
597
|
+
- [NameRequestModel](docs/NameRequestModel.md)
|
|
521
598
|
- [NavigationModel](docs/NavigationModel.md)
|
|
599
|
+
- [NoteRequestModel](docs/NoteRequestModel.md)
|
|
522
600
|
- [NumberPortAdminNoteBody](docs/NumberPortAdminNoteBody.md)
|
|
523
601
|
- [NumberPortDTO](docs/NumberPortDTO.md)
|
|
524
602
|
- [NumberPortNoteDTO](docs/NumberPortNoteDTO.md)
|
|
@@ -542,6 +620,7 @@ Class | Method | HTTP request | Description
|
|
|
542
620
|
- [PartnerDTO](docs/PartnerDTO.md)
|
|
543
621
|
- [PasswordSenderDTO](docs/PasswordSenderDTO.md)
|
|
544
622
|
- [PasswordSenderEntity](docs/PasswordSenderEntity.md)
|
|
623
|
+
- [PatchApproveRmaRequest](docs/PatchApproveRmaRequest.md)
|
|
545
624
|
- [PatchUpdateAccountCnameRequest](docs/PatchUpdateAccountCnameRequest.md)
|
|
546
625
|
- [PatchUpdateAccountCompanyNumberRequest](docs/PatchUpdateAccountCompanyNumberRequest.md)
|
|
547
626
|
- [PatchUpdateAccountContactPasswordRequest](docs/PatchUpdateAccountContactPasswordRequest.md)
|
|
@@ -572,7 +651,6 @@ Class | Method | HTTP request | Description
|
|
|
572
651
|
- [PostGetServicePlansRequest](docs/PostGetServicePlansRequest.md)
|
|
573
652
|
- [PostGetSipTrunksBillingRequest](docs/PostGetSipTrunksBillingRequest.md)
|
|
574
653
|
- [PostSendWelcomeEmailRequest](docs/PostSendWelcomeEmailRequest.md)
|
|
575
|
-
- [PostSplitOrderRequest](docs/PostSplitOrderRequest.md)
|
|
576
654
|
- [PostUpdateConnectionRequest](docs/PostUpdateConnectionRequest.md)
|
|
577
655
|
- [PostUpdateRecurringChargeRequest](docs/PostUpdateRecurringChargeRequest.md)
|
|
578
656
|
- [PriceGroup](docs/PriceGroup.md)
|
|
@@ -583,11 +661,17 @@ Class | Method | HTTP request | Description
|
|
|
583
661
|
- [ProcessedCdr](docs/ProcessedCdr.md)
|
|
584
662
|
- [ProductDetailedSummaryDTO](docs/ProductDetailedSummaryDTO.md)
|
|
585
663
|
- [ProductPriceListItemModel](docs/ProductPriceListItemModel.md)
|
|
664
|
+
- [ProductPriceModel](docs/ProductPriceModel.md)
|
|
586
665
|
- [ProductSearchResultsModel](docs/ProductSearchResultsModel.md)
|
|
666
|
+
- [ProductSerialInfoDTO](docs/ProductSerialInfoDTO.md)
|
|
587
667
|
- [ProductSerialInfoModel](docs/ProductSerialInfoModel.md)
|
|
588
668
|
- [ProductSummaryDTO](docs/ProductSummaryDTO.md)
|
|
589
669
|
- [PromoCodesEntity](docs/PromoCodesEntity.md)
|
|
670
|
+
- [PromoItemModel](docs/PromoItemModel.md)
|
|
590
671
|
- [PromoItemsEntity](docs/PromoItemsEntity.md)
|
|
672
|
+
- [PromoModel](docs/PromoModel.md)
|
|
673
|
+
- [PromoSummariesModel](docs/PromoSummariesModel.md)
|
|
674
|
+
- [PromoSummaryDTO](docs/PromoSummaryDTO.md)
|
|
591
675
|
- [ProspectDTO](docs/ProspectDTO.md)
|
|
592
676
|
- [ProspectEntity](docs/ProspectEntity.md)
|
|
593
677
|
- [ProvisioningModel](docs/ProvisioningModel.md)
|
|
@@ -600,12 +684,30 @@ Class | Method | HTTP request | Description
|
|
|
600
684
|
- [PutGetBaseServicesRequest](docs/PutGetBaseServicesRequest.md)
|
|
601
685
|
- [PutGetCallTariffPlanRequest](docs/PutGetCallTariffPlanRequest.md)
|
|
602
686
|
- [PutGetPriceGroupsRequest](docs/PutGetPriceGroupsRequest.md)
|
|
687
|
+
- [ReasonRequestModel](docs/ReasonRequestModel.md)
|
|
603
688
|
- [RecordingBackupAzureModel](docs/RecordingBackupAzureModel.md)
|
|
604
689
|
- [RecordingsBackupInfoDTO](docs/RecordingsBackupInfoDTO.md)
|
|
605
690
|
- [RecurringCharge](docs/RecurringCharge.md)
|
|
606
691
|
- [RemoteStorageDTO](docs/RemoteStorageDTO.md)
|
|
607
692
|
- [ReportRequestDTO](docs/ReportRequestDTO.md)
|
|
693
|
+
- [RequestDTO](docs/RequestDTO.md)
|
|
694
|
+
- [ResolutionRequestModel](docs/ResolutionRequestModel.md)
|
|
608
695
|
- [ResourceNotReadyException](docs/ResourceNotReadyException.md)
|
|
696
|
+
- [ResponseDTO](docs/ResponseDTO.md)
|
|
697
|
+
- [RmaCollectionDTO](docs/RmaCollectionDTO.md)
|
|
698
|
+
- [RmaCreditItemRequestDTO](docs/RmaCreditItemRequestDTO.md)
|
|
699
|
+
- [RmaDTO](docs/RmaDTO.md)
|
|
700
|
+
- [RmaItemDTO](docs/RmaItemDTO.md)
|
|
701
|
+
- [RmaItemRequestDTO](docs/RmaItemRequestDTO.md)
|
|
702
|
+
- [RmaOrderDTO](docs/RmaOrderDTO.md)
|
|
703
|
+
- [RmaOrderItemDTO](docs/RmaOrderItemDTO.md)
|
|
704
|
+
- [RmaOrderSummaryDTO](docs/RmaOrderSummaryDTO.md)
|
|
705
|
+
- [RmaReplacementOrderItemDTO](docs/RmaReplacementOrderItemDTO.md)
|
|
706
|
+
- [RmaReplacementOrderRequestDTO](docs/RmaReplacementOrderRequestDTO.md)
|
|
707
|
+
- [RmaRequestDTO](docs/RmaRequestDTO.md)
|
|
708
|
+
- [RmaReturnDTO](docs/RmaReturnDTO.md)
|
|
709
|
+
- [RmaSummaryDTO](docs/RmaSummaryDTO.md)
|
|
710
|
+
- [RmaSummaryItemDTO](docs/RmaSummaryItemDTO.md)
|
|
609
711
|
- [RootAccessModel](docs/RootAccessModel.md)
|
|
610
712
|
- [S3BucketEntity](docs/S3BucketEntity.md)
|
|
611
713
|
- [SbcDTO](docs/SbcDTO.md)
|
|
@@ -613,6 +715,8 @@ Class | Method | HTTP request | Description
|
|
|
613
715
|
- [ScopeModel](docs/ScopeModel.md)
|
|
614
716
|
- [Sdr](docs/Sdr.md)
|
|
615
717
|
- [SdrReferenceType](docs/SdrReferenceType.md)
|
|
718
|
+
- [SearchSchoolModel](docs/SearchSchoolModel.md)
|
|
719
|
+
- [SerialNumberRequestModel](docs/SerialNumberRequestModel.md)
|
|
616
720
|
- [SeriesDTO](docs/SeriesDTO.md)
|
|
617
721
|
- [Service](docs/Service.md)
|
|
618
722
|
- [ServiceHealthDTO](docs/ServiceHealthDTO.md)
|
|
@@ -663,7 +767,6 @@ Class | Method | HTTP request | Description
|
|
|
663
767
|
- [StockOrderSupplierModel](docs/StockOrderSupplierModel.md)
|
|
664
768
|
- [StockOrdersModel](docs/StockOrdersModel.md)
|
|
665
769
|
- [StockProductModel](docs/StockProductModel.md)
|
|
666
|
-
- [StockProductPriceModel](docs/StockProductPriceModel.md)
|
|
667
770
|
- [StockProductSummariesModel](docs/StockProductSummariesModel.md)
|
|
668
771
|
- [StockProductSummaryModel](docs/StockProductSummaryModel.md)
|
|
669
772
|
- [StockReportItemModel](docs/StockReportItemModel.md)
|
|
@@ -674,6 +777,7 @@ Class | Method | HTTP request | Description
|
|
|
674
777
|
- [SupplierItemModel](docs/SupplierItemModel.md)
|
|
675
778
|
- [SupplierItemsResultsDTO](docs/SupplierItemsResultsDTO.md)
|
|
676
779
|
- [SupplierModel](docs/SupplierModel.md)
|
|
780
|
+
- [SupplierProductDTO](docs/SupplierProductDTO.md)
|
|
677
781
|
- [SupplierProductModel](docs/SupplierProductModel.md)
|
|
678
782
|
- [SupplierProductResultsModel](docs/SupplierProductResultsModel.md)
|
|
679
783
|
- [SupportTicketModel](docs/SupportTicketModel.md)
|
|
@@ -687,6 +791,8 @@ Class | Method | HTTP request | Description
|
|
|
687
791
|
- [TcxBillingEntity](docs/TcxBillingEntity.md)
|
|
688
792
|
- [TcxBulkLicenceDetailsModel](docs/TcxBulkLicenceDetailsModel.md)
|
|
689
793
|
- [TcxDeadLicenceEntity](docs/TcxDeadLicenceEntity.md)
|
|
794
|
+
- [TcxEngineerTaskDTO](docs/TcxEngineerTaskDTO.md)
|
|
795
|
+
- [TcxEngineeringDTO](docs/TcxEngineeringDTO.md)
|
|
690
796
|
- [TcxExtsEntity](docs/TcxExtsEntity.md)
|
|
691
797
|
- [TcxInstallationModel](docs/TcxInstallationModel.md)
|
|
692
798
|
- [TcxInstallationsModel](docs/TcxInstallationsModel.md)
|
|
@@ -710,11 +816,13 @@ Class | Method | HTTP request | Description
|
|
|
710
816
|
- [TcxSetupEntity](docs/TcxSetupEntity.md)
|
|
711
817
|
- [TcxSetupsModel](docs/TcxSetupsModel.md)
|
|
712
818
|
- [TcxSipTrunksEntity](docs/TcxSipTrunksEntity.md)
|
|
819
|
+
- [TcxSummaryDTO](docs/TcxSummaryDTO.md)
|
|
713
820
|
- [TcxTemplateXmlEnum](docs/TcxTemplateXmlEnum.md)
|
|
714
821
|
- [TcxUsersEntity](docs/TcxUsersEntity.md)
|
|
715
822
|
- [TcxWizardConfigModel](docs/TcxWizardConfigModel.md)
|
|
716
823
|
- [TcxWizardModel](docs/TcxWizardModel.md)
|
|
717
824
|
- [TechSupportCompanySummaryDTO](docs/TechSupportCompanySummaryDTO.md)
|
|
825
|
+
- [ThumbnailDTO](docs/ThumbnailDTO.md)
|
|
718
826
|
- [TicketSummaryModel](docs/TicketSummaryModel.md)
|
|
719
827
|
- [TicketTimeDTO](docs/TicketTimeDTO.md)
|
|
720
828
|
- [TokenResponseModel](docs/TokenResponseModel.md)
|
|
@@ -722,6 +830,7 @@ Class | Method | HTTP request | Description
|
|
|
722
830
|
- [UpgradeOrderResponseModel](docs/UpgradeOrderResponseModel.md)
|
|
723
831
|
- [UpgradeRequestModel](docs/UpgradeRequestModel.md)
|
|
724
832
|
- [UserEntity](docs/UserEntity.md)
|
|
833
|
+
- [VideoRequestEntity](docs/VideoRequestEntity.md)
|
|
725
834
|
- [XeroLogEntity](docs/XeroLogEntity.md)
|
|
726
835
|
|
|
727
836
|
|
|
@@ -744,6 +853,8 @@ Authentication schemes defined for the API:
|
|
|
744
853
|
- **tcx_wizard**: 3CX Installation Wizard
|
|
745
854
|
- **accounts.read**: Accounts (Read)
|
|
746
855
|
- **accounts.write**: Accounts (Write)
|
|
856
|
+
- **branded_videosread**: Branded Videosread (Read)
|
|
857
|
+
- **branded_videoswrite**: Branded Videoswrite (Read)
|
|
747
858
|
- **number_porting.read**: Number Porting (Read)
|
|
748
859
|
- **number_porting.write**: Number Porting (Write)
|
|
749
860
|
- **pricing.read**: Pricing (Read)
|
|
@@ -752,6 +863,8 @@ Authentication schemes defined for the API:
|
|
|
752
863
|
- **products.read**: Products (Read)
|
|
753
864
|
- **provisioning.read**: Provisioning (Read)
|
|
754
865
|
- **provisioning.write**: Provisioning (Write)
|
|
866
|
+
- **rma.read**: Rma (Read)
|
|
867
|
+
- **rma.write**: Rma (Write)
|
|
755
868
|
- **sms.read**: Sms (Read)
|
|
756
869
|
- **sms.write**: Sms (Write)
|
|
757
870
|
- **trunks.read**: Trunks (Read)
|