yellowgrid-api-ts 3.2.258 → 3.2.259-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 +415 -362
- package/.openapi-generator/VERSION +1 -1
- package/README.md +114 -2
- package/api.ts +29189 -14751
- package/base.ts +26 -2
- package/common.ts +39 -16
- package/config.json +4 -4
- package/configuration.ts +21 -27
- package/dist/api.d.ts +20573 -8694
- package/dist/api.js +15017 -9599
- package/dist/base.d.ts +25 -1
- package/dist/base.js +21 -2
- package/dist/common.d.ts +36 -5
- package/dist/common.js +39 -17
- package/dist/configuration.d.ts +18 -25
- package/dist/configuration.js +4 -4
- 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/ConnectionTypeEnum.d.ts +17 -7
- package/dist/models/ConnectionTypeEnum.js +17 -7
- package/dist/models/GroupEnum.d.ts +43 -0
- package/dist/models/GroupEnum.js +45 -0
- package/dist/models/ReasonEnum.d.ts +18 -0
- package/dist/models/ReasonEnum.js +20 -0
- package/dist/models/ReportEnum.d.ts +21 -1
- package/dist/models/ReportEnum.js +21 -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/AbstractItemDiscountModel.md +21 -0
- package/docs/AbstractOrderRequestDTO.md +5 -5
- 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 +104 -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 +5 -5
- 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 +5 -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 +65 -10
- 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 +1 -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 +23 -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 +12 -4
- package/docs/CrmContactDTO.md +7 -7
- package/docs/CrmDateActivitiesDTO.md +2 -2
- 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 +2 -2
- package/docs/CustomerListAccountDTO.md +13 -13
- package/docs/CustomerOrderRequestDTO.md +5 -5
- 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 +2 -2
- package/docs/DetailedOrderRequestDTO.md +5 -5
- 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/EmailRequestModel.md +21 -0
- 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/GetDisconnectDDIRequest.md +20 -0
- 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/NumberPortModel.md +51 -0
- 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 +10 -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 +10 -10
- package/docs/OrderTotalModel.md +7 -7
- package/docs/OrderedItemEntity.md +14 -14
- package/docs/OrderedItemModel.md +14 -14
- package/docs/OrdersApi.md +115 -1
- package/docs/PartnerDTO.md +11 -11
- package/docs/PasswordSenderDTO.md +3 -3
- package/docs/PasswordSenderEntity.md +7 -7
- package/docs/PatchApproveRmaRequest.md +20 -0
- package/docs/PatchSetTcxWizardCnameRequest.md +20 -0
- package/docs/PortalAccountModel.md +23 -23
- package/docs/PortalLoginModel.md +7 -7
- package/docs/PostAddAdminNoteRequest.md +20 -0
- package/docs/PostGenerateReport200Response.md +8 -8
- package/docs/PostGetProductRequest.md +24 -0
- package/docs/PriceListItemModel.md +2 -2
- package/docs/PricingApi.md +1 -1
- package/docs/PrinterEntity.md +5 -5
- package/docs/PrizesEntity.md +6 -6
- package/docs/ProductDetailedSummaryDTO.md +4 -4
- package/docs/ProductPriceListItemModel.md +2 -2
- package/docs/ProductPriceModel.md +23 -0
- package/docs/ProductSearchDTO.md +37 -0
- package/docs/ProductSearchResultsModel.md +1 -1
- package/docs/ProductSerialInfoDTO.md +27 -0
- package/docs/ProductSerialInfoModel.md +3 -3
- package/docs/ProductSummaryDTO.md +3 -3
- 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 +9 -9
- 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/PutTransferConnectionRequest.md +20 -0
- package/docs/RMAApi.md +1753 -0
- package/docs/ReasonRequestModel.md +21 -0
- package/docs/RecordingBackupAzureModel.md +4 -4
- package/docs/RecordingsBackupInfoDTO.md +2 -2
- package/docs/RemoteStorageDTO.md +4 -4
- package/docs/ReportRequestDTO.md +3 -3
- package/docs/ReportsApi.md +1 -1
- package/docs/ResolutionRequestModel.md +21 -0
- package/docs/ResourceNotReadyException.md +3 -3
- 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/Sdr.md +66 -0
- 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 +6 -6
- 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/SpecialService.md +40 -0
- 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 +9 -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 +41 -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/TcxHostingPricingEntity.md +35 -0
- package/docs/TcxInstallationDetailsModel.md +45 -0
- package/docs/TcxInstallationModel.md +17 -17
- package/docs/TcxInstallationsModel.md +4 -4
- package/docs/TcxKeySummaryDTO.md +4 -4
- package/docs/TcxKeysEntity.md +6 -6
- 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/TelephonySupportTicketModel.md +41 -0
- 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/UnconnectedSdr.md +68 -0
- 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/hs_err_pid16044.log +249 -0
- package/hs_err_pid44560.log +249 -0
- package/hs_err_pid53988.log +249 -0
- package/hs_err_pid58728.log +40 -0
- package/index.ts +1 -1
- package/models/AgentEnum.ts +49 -0
- package/models/ConnectionTypeEnum.ts +17 -7
- package/models/GroupEnum.ts +44 -0
- package/models/ReasonEnum.ts +19 -0
- package/models/ReportEnum.ts +21 -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 +1 -1
package/docs/AuditLogEntity.md
CHANGED
|
@@ -6,15 +6,15 @@ AuditLogEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**action** | **string** | action | [
|
|
11
|
-
**type** | **string** | type | [
|
|
12
|
-
**identifier** | **string** | identifier | [
|
|
13
|
-
**user** | **string** | user | [
|
|
14
|
-
**timestamp** | **string** | timestamp | [
|
|
15
|
-
**beforeData** | **string** | beforeData | [
|
|
16
|
-
**afterData** | **string** | afterData | [
|
|
17
|
-
**description** | **string** | description | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**action** | **string** | action | [default to undefined]
|
|
11
|
+
**type** | **string** | type | [default to undefined]
|
|
12
|
+
**identifier** | **string** | identifier | [default to undefined]
|
|
13
|
+
**user** | **string** | user | [default to undefined]
|
|
14
|
+
**timestamp** | **string** | timestamp | [default to undefined]
|
|
15
|
+
**beforeData** | **string** | beforeData | [default to undefined]
|
|
16
|
+
**afterData** | **string** | afterData | [default to undefined]
|
|
17
|
+
**description** | **string** | description | [default to undefined]
|
|
18
18
|
|
|
19
19
|
## Example
|
|
20
20
|
|
|
@@ -6,7 +6,7 @@ OAuth Auth Code Response
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | Auth Code | [
|
|
9
|
+
**code** | **string** | Auth Code | [default to undefined]
|
|
10
10
|
**state** | **string** | State | [optional] [default to undefined]
|
|
11
11
|
**redirect_uri** | **string** | Redirect URI | [optional] [default to undefined]
|
|
12
12
|
|
package/docs/AxisDataDTO.md
CHANGED
|
@@ -6,7 +6,7 @@ Graph Axis Data
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**type** | **string** | Type | [
|
|
9
|
+
**type** | **string** | Type | [default to undefined]
|
|
10
10
|
**data** | **Array<string>** | Data | [optional] [default to undefined]
|
|
11
11
|
**name** | **string** | Name | [optional] [default to undefined]
|
|
12
12
|
|
package/docs/BasicItemDTO.md
CHANGED
|
@@ -6,8 +6,8 @@ Basic Order Item
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**sku** | **string** | SKU | [
|
|
10
|
-
**quantity** | **number** | Quantity | [
|
|
9
|
+
**sku** | **string** | SKU | [default to undefined]
|
|
10
|
+
**quantity** | **number** | Quantity | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/BasicProductDTO.md
CHANGED
|
@@ -6,8 +6,8 @@ Basic Product
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**sku** | **string** | SKU | [
|
|
10
|
-
**title** | **string** | Title | [
|
|
9
|
+
**sku** | **string** | SKU | [default to undefined]
|
|
10
|
+
**title** | **string** | Title | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/BatchDTO.md
CHANGED
|
@@ -6,23 +6,23 @@ Batch DTO
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**orderId** | **number** | orderId | [
|
|
11
|
-
**supplierId** | **number** | supplierId | [
|
|
12
|
-
**poNumber** | **string** | poNumber | [
|
|
13
|
-
**carriage** | **number** | carriage | [
|
|
14
|
-
**courier** | **string** | courier | [
|
|
15
|
-
**courierService** | **string** | courierService | [
|
|
16
|
-
**courierReference** | **string** | courierReference | [
|
|
17
|
-
**courierUnique** | **string** | courierUnique | [
|
|
18
|
-
**notes** | **string** | notes | [
|
|
19
|
-
**ordered** | **number** | ordered | [
|
|
20
|
-
**carriagePaid** | **number** | carriagePaid | [
|
|
21
|
-
**carriageRefunded** | **number** | carriageRefunded | [
|
|
22
|
-
**carriageRefundedDue** | **number** | carriageRefundedDue | [
|
|
23
|
-
**netdespatchLabel** | **string** | netdespatchLabel | [
|
|
24
|
-
**courierBoxes** | **number** | courierBoxes | [
|
|
25
|
-
**mac** | **string** | mac | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**orderId** | **number** | orderId | [default to undefined]
|
|
11
|
+
**supplierId** | **number** | supplierId | [default to undefined]
|
|
12
|
+
**poNumber** | **string** | poNumber | [default to undefined]
|
|
13
|
+
**carriage** | **number** | carriage | [default to undefined]
|
|
14
|
+
**courier** | **string** | courier | [default to undefined]
|
|
15
|
+
**courierService** | **string** | courierService | [default to undefined]
|
|
16
|
+
**courierReference** | **string** | courierReference | [default to undefined]
|
|
17
|
+
**courierUnique** | **string** | courierUnique | [default to undefined]
|
|
18
|
+
**notes** | **string** | notes | [default to undefined]
|
|
19
|
+
**ordered** | **number** | ordered | [default to undefined]
|
|
20
|
+
**carriagePaid** | **number** | carriagePaid | [default to undefined]
|
|
21
|
+
**carriageRefunded** | **number** | carriageRefunded | [default to undefined]
|
|
22
|
+
**carriageRefundedDue** | **number** | carriageRefundedDue | [default to undefined]
|
|
23
|
+
**netdespatchLabel** | **string** | netdespatchLabel | [default to undefined]
|
|
24
|
+
**courierBoxes** | **number** | courierBoxes | [default to undefined]
|
|
25
|
+
**mac** | **string** | mac | [default to undefined]
|
|
26
26
|
**shipments** | [**Array<ShipmentDTO>**](ShipmentDTO.md) | Shipments | [optional] [default to undefined]
|
|
27
27
|
**items** | [**Array<OrderedItemModel>**](OrderedItemModel.md) | Items | [optional] [default to undefined]
|
|
28
28
|
**supplier** | [**SupplierModel**](SupplierModel.md) | | [optional] [default to undefined]
|
package/docs/BatchEntity.md
CHANGED
|
@@ -6,23 +6,23 @@ BatchesEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**orderId** | **number** | orderId | [
|
|
11
|
-
**supplierId** | **number** | supplierId | [
|
|
12
|
-
**poNumber** | **string** | poNumber | [
|
|
13
|
-
**carriage** | **number** | carriage | [
|
|
14
|
-
**courier** | **string** | courier | [
|
|
15
|
-
**courierService** | **string** | courierService | [
|
|
16
|
-
**courierReference** | **string** | courierReference | [
|
|
17
|
-
**courierUnique** | **string** | courierUnique | [
|
|
18
|
-
**notes** | **string** | notes | [
|
|
19
|
-
**ordered** | **number** | ordered | [
|
|
20
|
-
**carriagePaid** | **number** | carriagePaid | [
|
|
21
|
-
**carriageRefunded** | **number** | carriageRefunded | [
|
|
22
|
-
**carriageRefundedDue** | **number** | carriageRefundedDue | [
|
|
23
|
-
**netdespatchLabel** | **string** | netdespatchLabel | [
|
|
24
|
-
**courierBoxes** | **number** | courierBoxes | [
|
|
25
|
-
**mac** | **string** | mac | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**orderId** | **number** | orderId | [default to undefined]
|
|
11
|
+
**supplierId** | **number** | supplierId | [default to undefined]
|
|
12
|
+
**poNumber** | **string** | poNumber | [default to undefined]
|
|
13
|
+
**carriage** | **number** | carriage | [default to undefined]
|
|
14
|
+
**courier** | **string** | courier | [default to undefined]
|
|
15
|
+
**courierService** | **string** | courierService | [default to undefined]
|
|
16
|
+
**courierReference** | **string** | courierReference | [default to undefined]
|
|
17
|
+
**courierUnique** | **string** | courierUnique | [default to undefined]
|
|
18
|
+
**notes** | **string** | notes | [default to undefined]
|
|
19
|
+
**ordered** | **number** | ordered | [default to undefined]
|
|
20
|
+
**carriagePaid** | **number** | carriagePaid | [default to undefined]
|
|
21
|
+
**carriageRefunded** | **number** | carriageRefunded | [default to undefined]
|
|
22
|
+
**carriageRefundedDue** | **number** | carriageRefundedDue | [default to undefined]
|
|
23
|
+
**netdespatchLabel** | **string** | netdespatchLabel | [default to undefined]
|
|
24
|
+
**courierBoxes** | **number** | courierBoxes | [default to undefined]
|
|
25
|
+
**mac** | **string** | mac | [default to undefined]
|
|
26
26
|
|
|
27
27
|
## Example
|
|
28
28
|
|
package/docs/BillingApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# BillingApi
|
|
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
|
|------------- | ------------- | -------------|
|
|
@@ -8,6 +8,7 @@ All URIs are relative to *https://bitbucket.org*
|
|
|
8
8
|
|[**deleteAddRecurringCharge**](#deleteaddrecurringcharge) | **DELETE** /billing/customer/recurringCharges | |
|
|
9
9
|
|[**deleteAddServiceToServicePlan**](#deleteaddservicetoserviceplan) | **DELETE** /billing/admin/servicePlan/service | |
|
|
10
10
|
|[**deleteCloseAccount**](#deletecloseaccount) | **DELETE** /billing/customer/customer | |
|
|
11
|
+
|[**deleteDeleteCallTariffId**](#deletedeletecalltariffid) | **DELETE** /billing/admin/callTariffPlan/callTariff/{id} | |
|
|
11
12
|
|[**deleteGetBaseServices**](#deletegetbaseservices) | **DELETE** /billing/admin/baseServices | |
|
|
12
13
|
|[**deleteGetCallTariffPlan**](#deletegetcalltariffplan) | **DELETE** /billing/admin/callTariffPlan | |
|
|
13
14
|
|[**deleteGetPriceGroups**](#deletegetpricegroups) | **DELETE** /billing/admin/priceGroups | |
|
|
@@ -293,6 +294,60 @@ No authorization required
|
|
|
293
294
|
|
|
294
295
|
[[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)
|
|
295
296
|
|
|
297
|
+
# **deleteDeleteCallTariffId**
|
|
298
|
+
> boolean deleteDeleteCallTariffId()
|
|
299
|
+
|
|
300
|
+
Delete Call Tariff By ID
|
|
301
|
+
|
|
302
|
+
### Example
|
|
303
|
+
|
|
304
|
+
```typescript
|
|
305
|
+
import {
|
|
306
|
+
BillingApi,
|
|
307
|
+
Configuration
|
|
308
|
+
} from 'yellowgrid-api-ts';
|
|
309
|
+
|
|
310
|
+
const configuration = new Configuration();
|
|
311
|
+
const apiInstance = new BillingApi(configuration);
|
|
312
|
+
|
|
313
|
+
let id: number; //Call Tariff ID (default to undefined)
|
|
314
|
+
|
|
315
|
+
const { status, data } = await apiInstance.deleteDeleteCallTariffId(
|
|
316
|
+
id
|
|
317
|
+
);
|
|
318
|
+
```
|
|
319
|
+
|
|
320
|
+
### Parameters
|
|
321
|
+
|
|
322
|
+
|Name | Type | Description | Notes|
|
|
323
|
+
|------------- | ------------- | ------------- | -------------|
|
|
324
|
+
| **id** | [**number**] | Call Tariff ID | defaults to undefined|
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
### Return type
|
|
328
|
+
|
|
329
|
+
**boolean**
|
|
330
|
+
|
|
331
|
+
### Authorization
|
|
332
|
+
|
|
333
|
+
No authorization required
|
|
334
|
+
|
|
335
|
+
### HTTP request headers
|
|
336
|
+
|
|
337
|
+
- **Content-Type**: Not defined
|
|
338
|
+
- **Accept**: application/json
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
### HTTP response details
|
|
342
|
+
| Status code | Description | Response headers |
|
|
343
|
+
|-------------|-------------|------------------|
|
|
344
|
+
|**200** | Successful | - |
|
|
345
|
+
|**400** | Bad Request | - |
|
|
346
|
+
|**401** | Unauthorised | - |
|
|
347
|
+
|**403** | Access Denied | - |
|
|
348
|
+
|
|
349
|
+
[[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)
|
|
350
|
+
|
|
296
351
|
# **deleteGetBaseServices**
|
|
297
352
|
> boolean deleteGetBaseServices()
|
|
298
353
|
|
|
@@ -946,7 +1001,7 @@ import {
|
|
|
946
1001
|
const configuration = new Configuration();
|
|
947
1002
|
const apiInstance = new BillingApi(configuration);
|
|
948
1003
|
|
|
949
|
-
let billCustomerId:
|
|
1004
|
+
let billCustomerId: string; //Customer ID (optional) (default to undefined)
|
|
950
1005
|
|
|
951
1006
|
const { status, data } = await apiInstance.getGetBillingCustomerDetails(
|
|
952
1007
|
billCustomerId
|
|
@@ -957,7 +1012,7 @@ const { status, data } = await apiInstance.getGetBillingCustomerDetails(
|
|
|
957
1012
|
|
|
958
1013
|
|Name | Type | Description | Notes|
|
|
959
1014
|
|------------- | ------------- | ------------- | -------------|
|
|
960
|
-
| **billCustomerId** | [**
|
|
1015
|
+
| **billCustomerId** | [**string**] | Customer ID | (optional) defaults to undefined|
|
|
961
1016
|
|
|
962
1017
|
|
|
963
1018
|
### Return type
|
|
@@ -1306,7 +1361,7 @@ import {
|
|
|
1306
1361
|
const configuration = new Configuration();
|
|
1307
1362
|
const apiInstance = new BillingApi(configuration);
|
|
1308
1363
|
|
|
1309
|
-
let type: 'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | '
|
|
1364
|
+
let type: 'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | 'Recurring Charges' | 'SMS' | 'CFD' | 'EdTechPro'; //Connection Type (optional) (default to undefined)
|
|
1310
1365
|
let billCustomerId: number; //Customer ID (optional) (default to undefined)
|
|
1311
1366
|
|
|
1312
1367
|
const { status, data } = await apiInstance.getGetConnections(
|
|
@@ -1319,7 +1374,7 @@ const { status, data } = await apiInstance.getGetConnections(
|
|
|
1319
1374
|
|
|
1320
1375
|
|Name | Type | Description | Notes|
|
|
1321
1376
|
|------------- | ------------- | ------------- | -------------|
|
|
1322
|
-
| **type** | [**'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | '
|
|
1377
|
+
| **type** | [**'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | 'Recurring Charges' | 'SMS' | 'CFD' | 'EdTechPro'**]**Array<'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | 'Recurring Charges' | 'SMS' | 'CFD' | 'EdTechPro'>** | Connection Type | (optional) defaults to undefined|
|
|
1323
1378
|
| **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
|
|
1324
1379
|
|
|
1325
1380
|
|
|
@@ -1665,7 +1720,7 @@ import {
|
|
|
1665
1720
|
const configuration = new Configuration();
|
|
1666
1721
|
const apiInstance = new BillingApi(configuration);
|
|
1667
1722
|
|
|
1668
|
-
let type: 'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | '
|
|
1723
|
+
let type: 'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | 'Recurring Charges' | 'SMS' | 'CFD' | 'EdTechPro'; //Connection Type (optional) (default to undefined)
|
|
1669
1724
|
|
|
1670
1725
|
const { status, data } = await apiInstance.getGetServicesPlanDetails(
|
|
1671
1726
|
type
|
|
@@ -1676,7 +1731,7 @@ const { status, data } = await apiInstance.getGetServicesPlanDetails(
|
|
|
1676
1731
|
|
|
1677
1732
|
|Name | Type | Description | Notes|
|
|
1678
1733
|
|------------- | ------------- | ------------- | -------------|
|
|
1679
|
-
| **type** | [**'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | '
|
|
1734
|
+
| **type** | [**'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | 'Recurring Charges' | 'SMS' | 'CFD' | 'EdTechPro'**]**Array<'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | 'Recurring Charges' | 'SMS' | 'CFD' | 'EdTechPro'>** | Connection Type | (optional) defaults to undefined|
|
|
1680
1735
|
|
|
1681
1736
|
|
|
1682
1737
|
### Return type
|
|
@@ -1859,7 +1914,7 @@ No authorization required
|
|
|
1859
1914
|
[[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)
|
|
1860
1915
|
|
|
1861
1916
|
# **getGetUnconnectedServices**
|
|
1862
|
-
> Array<
|
|
1917
|
+
> Array<UnconnectedSdr> getGetUnconnectedServices()
|
|
1863
1918
|
|
|
1864
1919
|
Get Unconnected Services
|
|
1865
1920
|
|
|
@@ -1883,7 +1938,7 @@ This endpoint does not have any parameters.
|
|
|
1883
1938
|
|
|
1884
1939
|
### Return type
|
|
1885
1940
|
|
|
1886
|
-
**Array<
|
|
1941
|
+
**Array<UnconnectedSdr>**
|
|
1887
1942
|
|
|
1888
1943
|
### Authorization
|
|
1889
1944
|
|
|
@@ -1898,7 +1953,7 @@ No authorization required
|
|
|
1898
1953
|
### HTTP response details
|
|
1899
1954
|
| Status code | Description | Response headers |
|
|
1900
1955
|
|-------------|-------------|------------------|
|
|
1901
|
-
|**200** |
|
|
1956
|
+
|**200** | Unconnected SDR | - |
|
|
1902
1957
|
|**400** | Bad Request | - |
|
|
1903
1958
|
|**401** | Unauthorised | - |
|
|
1904
1959
|
|**403** | Access Denied | - |
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# BrandedVideoSummaryDTO
|
|
2
|
+
|
|
3
|
+
Branded Video Summary
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **number** | ID | [default to undefined]
|
|
10
|
+
**customerId** | **number** | Customer ID | [default to undefined]
|
|
11
|
+
**company** | **string** | Company | [default to undefined]
|
|
12
|
+
**type** | **string** | Type | [default to undefined]
|
|
13
|
+
**video** | **string** | Video | [default to undefined]
|
|
14
|
+
**email** | **string** | Email | [default to undefined]
|
|
15
|
+
**website** | **string** | Website | [default to undefined]
|
|
16
|
+
**telephone** | **string** | Telephone | [default to undefined]
|
|
17
|
+
**invoiceNumber** | **string** | Invoice Number | [optional] [default to undefined]
|
|
18
|
+
**requestDate** | **string** | Date Time | [optional] [default to undefined]
|
|
19
|
+
**dueDate** | **string** | Date Time | [optional] [default to undefined]
|
|
20
|
+
**oneDriveId** | **string** | OneDrive ID | [optional] [default to undefined]
|
|
21
|
+
**status** | **string** | Status | [default to undefined]
|
|
22
|
+
**notes** | **string** | Notes | [default to undefined]
|
|
23
|
+
|
|
24
|
+
## Example
|
|
25
|
+
|
|
26
|
+
```typescript
|
|
27
|
+
import { BrandedVideoSummaryDTO } from 'yellowgrid-api-ts';
|
|
28
|
+
|
|
29
|
+
const instance: BrandedVideoSummaryDTO = {
|
|
30
|
+
id,
|
|
31
|
+
customerId,
|
|
32
|
+
company,
|
|
33
|
+
type,
|
|
34
|
+
video,
|
|
35
|
+
email,
|
|
36
|
+
website,
|
|
37
|
+
telephone,
|
|
38
|
+
invoiceNumber,
|
|
39
|
+
requestDate,
|
|
40
|
+
dueDate,
|
|
41
|
+
oneDriveId,
|
|
42
|
+
status,
|
|
43
|
+
notes,
|
|
44
|
+
};
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|