yellowgrid-api-ts 3.2.264 → 3.2.265-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 +417 -365
- package/.openapi-generator/VERSION +1 -1
- package/README.md +116 -3
- package/api.ts +9153 -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 +11797 -8215
- package/dist/api.js +14308 -9052
- 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 +0 -5
- package/dist/models/ConnectionTypeEnum.js +0 -5
- 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 +33 -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 +0 -5
- 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
package/docs/SupplierModel.md
CHANGED
|
@@ -6,15 +6,15 @@ Supplier
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**name** | **string** | name | [
|
|
11
|
-
**shortName** | **string** | nameShort | [
|
|
12
|
-
**email** | **string** | email | [
|
|
13
|
-
**phone** | **string** | phone | [
|
|
14
|
-
**defaultCourier** | **string** | defaultCourier | [
|
|
15
|
-
**defaultCarriage** | **number** | defaultCarriage | [
|
|
16
|
-
**accountNumber** | **string** | account | [
|
|
17
|
-
**xeroAccountNumber** | **string** | internalAccount | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**name** | **string** | name | [default to undefined]
|
|
11
|
+
**shortName** | **string** | nameShort | [default to undefined]
|
|
12
|
+
**email** | **string** | email | [default to undefined]
|
|
13
|
+
**phone** | **string** | phone | [default to undefined]
|
|
14
|
+
**defaultCourier** | **string** | defaultCourier | [default to undefined]
|
|
15
|
+
**defaultCarriage** | **number** | defaultCarriage | [default to undefined]
|
|
16
|
+
**accountNumber** | **string** | account | [default to undefined]
|
|
17
|
+
**xeroAccountNumber** | **string** | internalAccount | [default to undefined]
|
|
18
18
|
|
|
19
19
|
## Example
|
|
20
20
|
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# SupplierProductDTO
|
|
2
|
+
|
|
3
|
+
Supplier Product
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**title** | **string** | Title | [default to undefined]
|
|
10
|
+
**sku** | **string** | SKU | [default to undefined]
|
|
11
|
+
**attributeSet** | [**AttributeSetEnum**](AttributeSetEnum.md) | | [optional] [default to undefined]
|
|
12
|
+
**weight** | **number** | Weight (KG) | [optional] [default to undefined]
|
|
13
|
+
**ean** | **string** | EAN | [optional] [default to undefined]
|
|
14
|
+
**serialPrefix** | **string** | Serial Prefix | [optional] [default to undefined]
|
|
15
|
+
**tcxLabel** | **string** | 3CX Phone Label | [optional] [default to undefined]
|
|
16
|
+
**tcxTemplate** | [**TcxTemplateXmlEnum**](TcxTemplateXmlEnum.md) | | [optional] [default to undefined]
|
|
17
|
+
**salesPrices** | [**Array<ProductPriceModel>**](ProductPriceModel.md) | Prices | [default to undefined]
|
|
18
|
+
**category** | **string** | Category | [default to undefined]
|
|
19
|
+
**supplierId** | **number** | Supplier ID | [default to undefined]
|
|
20
|
+
**price** | **number** | Supplier Price | [default to undefined]
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
import { SupplierProductDTO } from 'yellowgrid-api-ts';
|
|
26
|
+
|
|
27
|
+
const instance: SupplierProductDTO = {
|
|
28
|
+
title,
|
|
29
|
+
sku,
|
|
30
|
+
attributeSet,
|
|
31
|
+
weight,
|
|
32
|
+
ean,
|
|
33
|
+
serialPrefix,
|
|
34
|
+
tcxLabel,
|
|
35
|
+
tcxTemplate,
|
|
36
|
+
salesPrices,
|
|
37
|
+
category,
|
|
38
|
+
supplierId,
|
|
39
|
+
price,
|
|
40
|
+
};
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -6,9 +6,9 @@ Supplier Product
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**sku** | **string** | SKU | [
|
|
10
|
-
**description** | **string** | Description | [
|
|
11
|
-
**items** | [**Array<SupplierItemModel>**](SupplierItemModel.md) | Items | [
|
|
9
|
+
**sku** | **string** | SKU | [default to undefined]
|
|
10
|
+
**description** | **string** | Description | [default to undefined]
|
|
11
|
+
**items** | [**Array<SupplierItemModel>**](SupplierItemModel.md) | Items | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -6,10 +6,10 @@ Supplier Product Results
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**results** | [**Array<SupplierProductModel>**](SupplierProductModel.md) | Results | [
|
|
10
|
-
**page** | **number** | Page | [
|
|
11
|
-
**perPage** | **number** | Per Page | [
|
|
12
|
-
**totalResults** | **number** | Total Results | [
|
|
9
|
+
**results** | [**Array<SupplierProductModel>**](SupplierProductModel.md) | Results | [default to undefined]
|
|
10
|
+
**page** | **number** | Page | [default to undefined]
|
|
11
|
+
**perPage** | **number** | Per Page | [default to undefined]
|
|
12
|
+
**totalResults** | **number** | Total Results | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
package/docs/SuppliersApi.md
CHANGED
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
# SuppliersApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://
|
|
3
|
+
All URIs are relative to *https://api.local.yellowgrid.co.uk*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**getGetSupplierItem**](#getgetsupplieritem) | **GET** /suppliers/items/{id} | Get Supplier Item|
|
|
8
8
|
|[**getGetSupplierItems**](#getgetsupplieritems) | **GET** /suppliers/items | Get Supplier Items|
|
|
9
9
|
|[**getGetSuppliers**](#getgetsuppliers) | **GET** /suppliers | Get Suppliers|
|
|
10
|
+
|[**postGetSupplierItems**](#postgetsupplieritems) | **POST** /suppliers/items | |
|
|
10
11
|
|[**putGetSupplierItem**](#putgetsupplieritem) | **PUT** /suppliers/items/{id} | Update Supplier Product|
|
|
11
12
|
|
|
12
13
|
# **getGetSupplierItem**
|
|
@@ -170,6 +171,61 @@ No authorization required
|
|
|
170
171
|
|
|
171
172
|
[[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)
|
|
172
173
|
|
|
174
|
+
# **postGetSupplierItems**
|
|
175
|
+
> SupplierProductDTO postGetSupplierItems()
|
|
176
|
+
|
|
177
|
+
Create Supplier Product
|
|
178
|
+
|
|
179
|
+
### Example
|
|
180
|
+
|
|
181
|
+
```typescript
|
|
182
|
+
import {
|
|
183
|
+
SuppliersApi,
|
|
184
|
+
Configuration,
|
|
185
|
+
SupplierProductDTO
|
|
186
|
+
} from 'yellowgrid-api-ts';
|
|
187
|
+
|
|
188
|
+
const configuration = new Configuration();
|
|
189
|
+
const apiInstance = new SuppliersApi(configuration);
|
|
190
|
+
|
|
191
|
+
let supplierProductDTO: SupplierProductDTO; //Supplier Product (optional)
|
|
192
|
+
|
|
193
|
+
const { status, data } = await apiInstance.postGetSupplierItems(
|
|
194
|
+
supplierProductDTO
|
|
195
|
+
);
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
### Parameters
|
|
199
|
+
|
|
200
|
+
|Name | Type | Description | Notes|
|
|
201
|
+
|------------- | ------------- | ------------- | -------------|
|
|
202
|
+
| **supplierProductDTO** | **SupplierProductDTO**| Supplier Product | |
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
### Return type
|
|
206
|
+
|
|
207
|
+
**SupplierProductDTO**
|
|
208
|
+
|
|
209
|
+
### Authorization
|
|
210
|
+
|
|
211
|
+
No authorization required
|
|
212
|
+
|
|
213
|
+
### HTTP request headers
|
|
214
|
+
|
|
215
|
+
- **Content-Type**: application/json
|
|
216
|
+
- **Accept**: application/json
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
### HTTP response details
|
|
220
|
+
| Status code | Description | Response headers |
|
|
221
|
+
|-------------|-------------|------------------|
|
|
222
|
+
|**200** | Supplier Product | - |
|
|
223
|
+
|**400** | Bad Request | - |
|
|
224
|
+
|**401** | Unauthorised | - |
|
|
225
|
+
|**403** | Access Denied | - |
|
|
226
|
+
|
|
227
|
+
[[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)
|
|
228
|
+
|
|
173
229
|
# **putGetSupplierItem**
|
|
174
230
|
> SupplierProductModel putGetSupplierItem()
|
|
175
231
|
|
|
@@ -6,17 +6,17 @@ Telephony Support Ticket
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | Ticket ID | [
|
|
10
|
-
**status** | **string** | Ticket status | [
|
|
11
|
-
**statusId** | **number** | Ticket status ID | [
|
|
12
|
-
**subject** | **string** | Ticket subject | [
|
|
9
|
+
**id** | **number** | Ticket ID | [default to undefined]
|
|
10
|
+
**status** | **string** | Ticket status | [default to undefined]
|
|
11
|
+
**statusId** | **number** | Ticket status ID | [default to undefined]
|
|
12
|
+
**subject** | **string** | Ticket subject | [default to undefined]
|
|
13
13
|
**supportEmail** | **string** | Support email address | [optional] [default to undefined]
|
|
14
|
-
**toEmails** | **Array<string>** | Recipient emails | [
|
|
15
|
-
**description** | **string** | Ticket description (HTML) | [
|
|
16
|
-
**descriptionText** | **string** | Ticket description (plain text) | [
|
|
17
|
-
**createdAt** | **string** | Creation timestamp | [
|
|
18
|
-
**attachments** | [**Array<AttachmentModel>**](AttachmentModel.md) | Attachments | [
|
|
19
|
-
**conversations** | [**Array<ConversationModel>**](ConversationModel.md) | Conversations | [
|
|
14
|
+
**toEmails** | **Array<string>** | Recipient emails | [default to undefined]
|
|
15
|
+
**description** | **string** | Ticket description (HTML) | [default to undefined]
|
|
16
|
+
**descriptionText** | **string** | Ticket description (plain text) | [default to undefined]
|
|
17
|
+
**createdAt** | **string** | Creation timestamp | [default to undefined]
|
|
18
|
+
**attachments** | [**Array<AttachmentModel>**](AttachmentModel.md) | Attachments | [default to undefined]
|
|
19
|
+
**conversations** | [**Array<ConversationModel>**](ConversationModel.md) | Conversations | [default to undefined]
|
|
20
20
|
|
|
21
21
|
## Example
|
|
22
22
|
|
package/docs/SystemApi.md
CHANGED
package/docs/TableDTO.md
CHANGED
|
@@ -6,9 +6,9 @@ Table
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**title** | **string** | Title | [
|
|
10
|
-
**headers** | [**TableRowDTO**](TableRowDTO.md) | | [
|
|
11
|
-
**rows** | [**Array<TableRowDTO>**](TableRowDTO.md) | Rows | [
|
|
9
|
+
**title** | **string** | Title | [default to undefined]
|
|
10
|
+
**headers** | [**TableRowDTO**](TableRowDTO.md) | | [default to undefined]
|
|
11
|
+
**rows** | [**Array<TableRowDTO>**](TableRowDTO.md) | Rows | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
package/docs/TableDataDTO.md
CHANGED
|
@@ -6,14 +6,14 @@ TableAttribsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**ownerId** | **string** | ownerId | [
|
|
10
|
-
**dbTable** | **string** | table | [
|
|
11
|
-
**orderingField** | **string** | orderingField | [
|
|
12
|
-
**asc** | **number** | asc | [
|
|
13
|
-
**perPage** | **number** | perPage | [
|
|
14
|
-
**currPage** | **number** | currPage | [
|
|
15
|
-
**filter** | **string** | filter | [
|
|
16
|
-
**page** | **number** | page | [
|
|
9
|
+
**ownerId** | **string** | ownerId | [default to undefined]
|
|
10
|
+
**dbTable** | **string** | table | [default to undefined]
|
|
11
|
+
**orderingField** | **string** | orderingField | [default to undefined]
|
|
12
|
+
**asc** | **number** | asc | [default to undefined]
|
|
13
|
+
**perPage** | **number** | perPage | [default to undefined]
|
|
14
|
+
**currPage** | **number** | currPage | [default to undefined]
|
|
15
|
+
**filter** | **string** | filter | [default to undefined]
|
|
16
|
+
**page** | **number** | page | [default to undefined]
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
package/docs/TableRowDTO.md
CHANGED
|
@@ -6,7 +6,7 @@ Table Row
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**data** | [**Array<TableDataDTO>**](TableDataDTO.md) | Table Data | [
|
|
9
|
+
**data** | [**Array<TableDataDTO>**](TableDataDTO.md) | Table Data | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
package/docs/TcxBackupEntity.md
CHANGED
|
@@ -6,15 +6,15 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**path** | **string** | Backup Filename | [
|
|
11
|
-
**password** | **string** | password | [
|
|
12
|
-
**adminUsername** | **string** | adminUsername | [
|
|
13
|
-
**httpPort** | **number** | HTTP Port | [
|
|
14
|
-
**httpsPort** | **number** | HTTPS Port | [
|
|
15
|
-
**sipPort** | **number** | SIP Port | [
|
|
16
|
-
**tunnelPort** | **number** | 3CX Tunnel Port | [
|
|
17
|
-
**schedule** | **string** | 3CX Wizard Build Schedule | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**path** | **string** | Backup Filename | [default to undefined]
|
|
11
|
+
**password** | **string** | password | [default to undefined]
|
|
12
|
+
**adminUsername** | **string** | adminUsername | [default to undefined]
|
|
13
|
+
**httpPort** | **number** | HTTP Port | [default to undefined]
|
|
14
|
+
**httpsPort** | **number** | HTTPS Port | [default to undefined]
|
|
15
|
+
**sipPort** | **number** | SIP Port | [default to undefined]
|
|
16
|
+
**tunnelPort** | **number** | 3CX Tunnel Port | [default to undefined]
|
|
17
|
+
**schedule** | **string** | 3CX Wizard Build Schedule | [default to undefined]
|
|
18
18
|
|
|
19
19
|
## Example
|
|
20
20
|
|
package/docs/TcxBackupModel.md
CHANGED
|
@@ -6,15 +6,15 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**path** | **string** | Backup Filename | [
|
|
11
|
-
**password** | **string** | password | [
|
|
12
|
-
**adminUsername** | **string** | adminUsername | [
|
|
13
|
-
**httpPort** | **number** | HTTP Port | [
|
|
14
|
-
**httpsPort** | **number** | HTTPS Port | [
|
|
15
|
-
**sipPort** | **number** | SIP Port | [
|
|
16
|
-
**tunnelPort** | **number** | 3CX Tunnel Port | [
|
|
17
|
-
**schedule** | **string** | 3CX Wizard Build Schedule | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**path** | **string** | Backup Filename | [default to undefined]
|
|
11
|
+
**password** | **string** | password | [default to undefined]
|
|
12
|
+
**adminUsername** | **string** | adminUsername | [default to undefined]
|
|
13
|
+
**httpPort** | **number** | HTTP Port | [default to undefined]
|
|
14
|
+
**httpsPort** | **number** | HTTPS Port | [default to undefined]
|
|
15
|
+
**sipPort** | **number** | SIP Port | [default to undefined]
|
|
16
|
+
**tunnelPort** | **number** | 3CX Tunnel Port | [default to undefined]
|
|
17
|
+
**schedule** | **string** | 3CX Wizard Build Schedule | [default to undefined]
|
|
18
18
|
**size** | **number** | Backup Size | [optional] [default to undefined]
|
|
19
19
|
**email** | **string** | 3CX Admin Email | [optional] [default to undefined]
|
|
20
20
|
**version** | **string** | 3CX Version | [optional] [default to undefined]
|
package/docs/TcxBillingEntity.md
CHANGED
|
@@ -6,16 +6,16 @@ TcxBillingEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**tcxId** | **number** | tcxId | [
|
|
11
|
-
**method** | **string** | method | [
|
|
12
|
-
**amount** | **number** | amount | [
|
|
13
|
-
**currency** | **string** | currency | [
|
|
14
|
-
**notes** | **string** | notes | [
|
|
15
|
-
**invoicing** | **string** | invoicing | [
|
|
16
|
-
**monthInterval** | **number** | monthInterval | [
|
|
17
|
-
**startDate** | **string** | startDate | [
|
|
18
|
-
**billTo** | **string** | billTo | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**tcxId** | **number** | tcxId | [default to undefined]
|
|
11
|
+
**method** | **string** | method | [default to undefined]
|
|
12
|
+
**amount** | **number** | amount | [default to undefined]
|
|
13
|
+
**currency** | **string** | currency | [default to undefined]
|
|
14
|
+
**notes** | **string** | notes | [default to undefined]
|
|
15
|
+
**invoicing** | **string** | invoicing | [default to undefined]
|
|
16
|
+
**monthInterval** | **number** | monthInterval | [default to undefined]
|
|
17
|
+
**startDate** | **string** | startDate | [default to undefined]
|
|
18
|
+
**billTo** | **string** | billTo | [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
|
@@ -6,8 +6,8 @@ Bulk 3CX Licence Details
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**licenceDetails** | [**Array<TcxLicenceDetailsModel>**](TcxLicenceDetailsModel.md) | Licence Details | [
|
|
10
|
-
**errors** | [**Array<TcxLicenceDetailsErrorModel>**](TcxLicenceDetailsErrorModel.md) | Licence Error Details | [
|
|
9
|
+
**licenceDetails** | [**Array<TcxLicenceDetailsModel>**](TcxLicenceDetailsModel.md) | Licence Details | [default to undefined]
|
|
10
|
+
**errors** | [**Array<TcxLicenceDetailsErrorModel>**](TcxLicenceDetailsErrorModel.md) | Licence Error Details | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -6,9 +6,9 @@ DeadLicencesEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**licencekey** | **string** | licencekey | [
|
|
11
|
-
**date** | **string** | date | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**licencekey** | **string** | licencekey | [default to undefined]
|
|
11
|
+
**date** | **string** | date | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# TcxEngineerTaskDTO
|
|
2
|
+
|
|
3
|
+
3CX Engineer Task
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**taskId** | **number** | Task ID | [default to undefined]
|
|
10
|
+
**title** | **string** | Title | [default to undefined]
|
|
11
|
+
**description** | **string** | Description | [default to undefined]
|
|
12
|
+
**complete** | **boolean** | Completion Status | [default to undefined]
|
|
13
|
+
**note** | **string** | Note | [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { TcxEngineerTaskDTO } from 'yellowgrid-api-ts';
|
|
19
|
+
|
|
20
|
+
const instance: TcxEngineerTaskDTO = {
|
|
21
|
+
taskId,
|
|
22
|
+
title,
|
|
23
|
+
description,
|
|
24
|
+
complete,
|
|
25
|
+
note,
|
|
26
|
+
};
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# TcxEngineeringDTO
|
|
2
|
+
|
|
3
|
+
3CX Engineering
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **number** | Engineering ID | [default to undefined]
|
|
10
|
+
**wizardId** | **number** | Wizard ID | [default to undefined]
|
|
11
|
+
**engineerId** | **number** | Engineer ID | [default to undefined]
|
|
12
|
+
**engineerName** | **string** | Engineer Name | [default to undefined]
|
|
13
|
+
**ticketUrl** | **string** | Ticket URL | [default to undefined]
|
|
14
|
+
**goLiveDate** | **string** | Date Time | [optional] [default to undefined]
|
|
15
|
+
**spec** | **string** | Spec | [optional] [default to undefined]
|
|
16
|
+
**note** | **string** | Note | [optional] [default to undefined]
|
|
17
|
+
**tasks** | [**Array<TcxEngineerTaskDTO>**](TcxEngineerTaskDTO.md) | Tasks | [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { TcxEngineeringDTO } from 'yellowgrid-api-ts';
|
|
23
|
+
|
|
24
|
+
const instance: TcxEngineeringDTO = {
|
|
25
|
+
id,
|
|
26
|
+
wizardId,
|
|
27
|
+
engineerId,
|
|
28
|
+
engineerName,
|
|
29
|
+
ticketUrl,
|
|
30
|
+
goLiveDate,
|
|
31
|
+
spec,
|
|
32
|
+
note,
|
|
33
|
+
tasks,
|
|
34
|
+
};
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -6,36 +6,36 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**wizardId** | **string** | Wizard ID | [
|
|
10
|
-
**customerId** | **number** | Customer ID | [
|
|
11
|
-
**instanceId** | **string** | Instance ID | [
|
|
9
|
+
**wizardId** | **string** | Wizard ID | [default to undefined]
|
|
10
|
+
**customerId** | **number** | Customer ID | [default to undefined]
|
|
11
|
+
**instanceId** | **string** | Instance ID | [default to undefined]
|
|
12
12
|
**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
|
|
13
13
|
**endUser** | **string** | End User | [optional] [default to undefined]
|
|
14
14
|
**reseller** | **string** | Reseller | [optional] [default to undefined]
|
|
15
|
-
**company** | **string** | Company Name | [
|
|
16
|
-
**portalStatus** | **string** | Installation Status | [
|
|
17
|
-
**creation** | **string** | Creation Date | [
|
|
15
|
+
**company** | **string** | Company Name | [default to undefined]
|
|
16
|
+
**portalStatus** | **string** | Installation Status | [default to undefined]
|
|
17
|
+
**creation** | **string** | Creation Date | [default to undefined]
|
|
18
18
|
**installType** | **string** | Install Type | [optional] [default to undefined]
|
|
19
|
-
**configType** | **string** | Config Type | [
|
|
19
|
+
**configType** | **string** | Config Type | [default to undefined]
|
|
20
20
|
**fqdn** | **string** | FQDN | [optional] [default to undefined]
|
|
21
21
|
**ipAddress** | **string** | PBX IP Address | [optional] [default to undefined]
|
|
22
22
|
**reservedIpAddress** | **string** | Failover IP Address | [optional] [default to undefined]
|
|
23
23
|
**tcxUrl** | **string** | 3CX Console URL | [optional] [default to undefined]
|
|
24
24
|
**wizardUrl** | **string** | Wizard URL | [optional] [default to undefined]
|
|
25
25
|
**credentialsUrl** | **string** | 3CX Credentials URL | [optional] [default to undefined]
|
|
26
|
-
**price** | **number** | Hosting Price | [
|
|
27
|
-
**offline** | **boolean** | Instance Offline | [
|
|
28
|
-
**failedOver** | **boolean** | Instance Failed Over | [
|
|
29
|
-
**suspended** | **boolean** | Instance Suspended | [
|
|
30
|
-
**supported** | **boolean** | Instance Support Status | [
|
|
31
|
-
**supportLevel** | **string** | Instance Support Level | [
|
|
32
|
-
**supportDescription** | **string** | Instance Support Description | [
|
|
33
|
-
**supportIcon** | **string** | Instance Support Icon | [
|
|
34
|
-
**supportColour** | **string** | Instance Support Colour | [
|
|
26
|
+
**price** | **number** | Hosting Price | [default to undefined]
|
|
27
|
+
**offline** | **boolean** | Instance Offline | [default to undefined]
|
|
28
|
+
**failedOver** | **boolean** | Instance Failed Over | [default to undefined]
|
|
29
|
+
**suspended** | **boolean** | Instance Suspended | [default to undefined]
|
|
30
|
+
**supported** | **boolean** | Instance Support Status | [default to undefined]
|
|
31
|
+
**supportLevel** | **string** | Instance Support Level | [default to undefined]
|
|
32
|
+
**supportDescription** | **string** | Instance Support Description | [default to undefined]
|
|
33
|
+
**supportIcon** | **string** | Instance Support Icon | [default to undefined]
|
|
34
|
+
**supportColour** | **string** | Instance Support Colour | [default to undefined]
|
|
35
35
|
**version** | **string** | 3CX Software Version | [optional] [default to undefined]
|
|
36
36
|
**disk** | **number** | Recordings Disk Size | [optional] [default to undefined]
|
|
37
37
|
**flavour** | **string** | Instance Spec | [optional] [default to undefined]
|
|
38
|
-
**autoFailover** | **boolean** | Auto Failover | [
|
|
38
|
+
**autoFailover** | **boolean** | Auto Failover | [default to undefined]
|
|
39
39
|
**extensions** | **number** | Extensions in Use | [optional] [default to undefined]
|
|
40
40
|
**maxExtensions** | **number** | Max Allowed Extensions | [optional] [default to undefined]
|
|
41
41
|
|
|
@@ -6,10 +6,10 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**results** | [**Array<TcxInstallationModel>**](TcxInstallationModel.md) | Results | [
|
|
10
|
-
**page** | **number** | Page | [
|
|
11
|
-
**perPage** | **number** | Per Page | [
|
|
12
|
-
**totalResults** | **number** | Total Results | [
|
|
9
|
+
**results** | [**Array<TcxInstallationModel>**](TcxInstallationModel.md) | Results | [default to undefined]
|
|
10
|
+
**page** | **number** | Page | [default to undefined]
|
|
11
|
+
**perPage** | **number** | Per Page | [default to undefined]
|
|
12
|
+
**totalResults** | **number** | Total Results | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
package/docs/TcxKeySummaryDTO.md
CHANGED
|
@@ -6,10 +6,10 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**licenceKey** | **string** | Licence Key | [
|
|
9
|
+
**licenceKey** | **string** | Licence Key | [default to undefined]
|
|
10
10
|
**endUser** | **string** | End User | [optional] [default to undefined]
|
|
11
|
-
**sc** | **number** | Simultaneous Calls | [
|
|
12
|
-
**edition** | **string** | Edition | [
|
|
11
|
+
**sc** | **number** | Simultaneous Calls | [default to undefined]
|
|
12
|
+
**edition** | **string** | Edition | [default to undefined]
|
|
13
13
|
**expiry** | **string** | Expiry Date | [optional] [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
package/docs/TcxKeysEntity.md
CHANGED
|
@@ -6,12 +6,12 @@ TcxKeysEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**customerId** | **number** | customerId | [
|
|
11
|
-
**licenceKey** | **string** | licenceKey | [
|
|
12
|
-
**name** | **string** | name | [
|
|
13
|
-
**
|
|
14
|
-
**updatedTime** | **string** | updatedTime | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**customerId** | **number** | customerId | [default to undefined]
|
|
11
|
+
**licenceKey** | **string** | licenceKey | [default to undefined]
|
|
12
|
+
**name** | **string** | name | [default to undefined]
|
|
13
|
+
**itemId** | **number** | orderId | [default to undefined]
|
|
14
|
+
**updatedTime** | **string** | updatedTime | [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -23,7 +23,7 @@ const instance: TcxKeysEntity = {
|
|
|
23
23
|
customerId,
|
|
24
24
|
licenceKey,
|
|
25
25
|
name,
|
|
26
|
-
|
|
26
|
+
itemId,
|
|
27
27
|
updatedTime,
|
|
28
28
|
};
|
|
29
29
|
```
|
|
@@ -6,10 +6,10 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**licenceKey** | **string** | Licence Key | [
|
|
10
|
-
**code** | **string** | Code | [
|
|
11
|
-
**message** | **string** | Error Message | [
|
|
12
|
-
**status** | **string** | Status | [
|
|
9
|
+
**licenceKey** | **string** | Licence Key | [default to undefined]
|
|
10
|
+
**code** | **string** | Code | [default to undefined]
|
|
11
|
+
**message** | **string** | Error Message | [default to undefined]
|
|
12
|
+
**status** | **string** | Status | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -6,17 +6,17 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**key** | **string** | Licence Key | [
|
|
10
|
-
**edition** | **string** | Edition | [
|
|
11
|
-
**sc** | **number** | Simultaneous Calls | [
|
|
12
|
-
**extensions** | **number** | SMB Extensions | [
|
|
13
|
-
**expiry** | **string** | Licence Expiry | [
|
|
14
|
-
**hostingExpiry** | **string** | Hosting Expiry | [
|
|
15
|
-
**nfr** | **boolean** | NFR Licence | [
|
|
16
|
-
**free** | **boolean** | Free Licence | [
|
|
17
|
-
**dead** | **boolean** | Dead Licence | [
|
|
18
|
-
**customerName** | **string** | End User Name | [
|
|
19
|
-
**ygHosted** | **boolean** | Yellowgrid Hosted | [
|
|
9
|
+
**key** | **string** | Licence Key | [default to undefined]
|
|
10
|
+
**edition** | **string** | Edition | [default to undefined]
|
|
11
|
+
**sc** | **number** | Simultaneous Calls | [default to undefined]
|
|
12
|
+
**extensions** | **number** | SMB Extensions | [default to undefined]
|
|
13
|
+
**expiry** | **string** | Licence Expiry | [default to undefined]
|
|
14
|
+
**hostingExpiry** | **string** | Hosting Expiry | [default to undefined]
|
|
15
|
+
**nfr** | **boolean** | NFR Licence | [default to undefined]
|
|
16
|
+
**free** | **boolean** | Free Licence | [default to undefined]
|
|
17
|
+
**dead** | **boolean** | Dead Licence | [default to undefined]
|
|
18
|
+
**customerName** | **string** | End User Name | [default to undefined]
|
|
19
|
+
**ygHosted** | **boolean** | Yellowgrid Hosted | [default to undefined]
|
|
20
20
|
|
|
21
21
|
## Example
|
|
22
22
|
|
package/docs/TcxMacsEntity.md
CHANGED
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**ext** | **string** | Extension Number | [
|
|
11
|
-
**mac** | **string** | MAC Address | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**ext** | **string** | Extension Number | [default to undefined]
|
|
11
|
+
**mac** | **string** | MAC Address | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|