yellowgrid-api-ts 3.2.259 → 3.2.260-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 -365
- package/.openapi-generator/VERSION +1 -1
- package/README.md +111 -2
- package/api.ts +29104 -14672
- 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 +20609 -8738
- package/dist/api.js +14413 -8951
- 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/CategoryEnum.d.ts +103 -0
- package/dist/models/CategoryEnum.js +105 -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 +62 -7
- 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/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/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/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/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/CategoryEnum.ts +104 -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
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
export declare const RmaStatusEnum: {
|
|
2
|
+
readonly OPEN: {
|
|
3
|
+
readonly name: "OPEN";
|
|
4
|
+
readonly value: 1;
|
|
5
|
+
readonly publicValue: "Open";
|
|
6
|
+
};
|
|
7
|
+
readonly AWAITING_ITEMS: {
|
|
8
|
+
readonly name: "AWAITING_ITEMS";
|
|
9
|
+
readonly value: 2;
|
|
10
|
+
readonly publicValue: "Awaiting Items";
|
|
11
|
+
};
|
|
12
|
+
readonly IN_PROGRESS: {
|
|
13
|
+
readonly name: "IN_PROGRESS";
|
|
14
|
+
readonly value: 3;
|
|
15
|
+
readonly publicValue: "In Progress";
|
|
16
|
+
};
|
|
17
|
+
readonly RESOLVED: {
|
|
18
|
+
readonly name: "RESOLVED";
|
|
19
|
+
readonly value: 4;
|
|
20
|
+
readonly publicValue: "Resolved";
|
|
21
|
+
};
|
|
22
|
+
readonly REJECTED: {
|
|
23
|
+
readonly name: "REJECTED";
|
|
24
|
+
readonly value: 5;
|
|
25
|
+
readonly publicValue: "Rejected";
|
|
26
|
+
};
|
|
27
|
+
readonly ARCHIVED: {
|
|
28
|
+
readonly name: "ARCHIVED";
|
|
29
|
+
readonly value: 6;
|
|
30
|
+
readonly publicValue: "Archived";
|
|
31
|
+
};
|
|
32
|
+
};
|
|
33
|
+
export type RmaStatusEnum = typeof RmaStatusEnum;
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.RmaStatusEnum = void 0;
|
|
4
|
+
exports.RmaStatusEnum = {
|
|
5
|
+
"OPEN": {
|
|
6
|
+
"name": "OPEN",
|
|
7
|
+
"value": 1,
|
|
8
|
+
"publicValue": "Open"
|
|
9
|
+
},
|
|
10
|
+
"AWAITING_ITEMS": {
|
|
11
|
+
"name": "AWAITING_ITEMS",
|
|
12
|
+
"value": 2,
|
|
13
|
+
"publicValue": "Awaiting Items"
|
|
14
|
+
},
|
|
15
|
+
"IN_PROGRESS": {
|
|
16
|
+
"name": "IN_PROGRESS",
|
|
17
|
+
"value": 3,
|
|
18
|
+
"publicValue": "In Progress"
|
|
19
|
+
},
|
|
20
|
+
"RESOLVED": {
|
|
21
|
+
"name": "RESOLVED",
|
|
22
|
+
"value": 4,
|
|
23
|
+
"publicValue": "Resolved"
|
|
24
|
+
},
|
|
25
|
+
"REJECTED": {
|
|
26
|
+
"name": "REJECTED",
|
|
27
|
+
"value": 5,
|
|
28
|
+
"publicValue": "Rejected"
|
|
29
|
+
},
|
|
30
|
+
"ARCHIVED": {
|
|
31
|
+
"name": "ARCHIVED",
|
|
32
|
+
"value": 6,
|
|
33
|
+
"publicValue": "Archived"
|
|
34
|
+
}
|
|
35
|
+
};
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# AbstractItemDiscountModel
|
|
2
|
+
|
|
3
|
+
Item Discount
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**description** | **string** | Description | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { AbstractItemDiscountModel } from 'yellowgrid-api-ts';
|
|
15
|
+
|
|
16
|
+
const instance: AbstractItemDiscountModel = {
|
|
17
|
+
description,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -7,12 +7,12 @@ Order Request
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**orderReference** | **string** | Order Reference | [optional] [default to undefined]
|
|
10
|
-
**items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [
|
|
11
|
-
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [
|
|
10
|
+
**items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [default to undefined]
|
|
11
|
+
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [default to undefined]
|
|
12
12
|
**provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
|
|
13
|
-
**shippingAddress** | [**AddressModel**](AddressModel.md) |
|
|
14
|
-
**partShip** | **boolean** | Part Ship Order | [
|
|
15
|
-
**quote** | **boolean** | Quote | [
|
|
13
|
+
**shippingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
|
|
14
|
+
**partShip** | **boolean** | Part Ship Order | [default to undefined]
|
|
15
|
+
**quote** | **boolean** | Quote | [default to undefined]
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
|
@@ -6,9 +6,9 @@ Account Addresses
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**billingAddress** | [**AddressDTO**](AddressDTO.md) | | [
|
|
10
|
-
**shippingAddress** | [**AddressDTO**](AddressDTO.md) | | [
|
|
11
|
-
**previousShippingAddreses** | [**Array<AddressDTO>**](AddressDTO.md) | Addresses | [
|
|
9
|
+
**billingAddress** | [**AddressDTO**](AddressDTO.md) | | [default to undefined]
|
|
10
|
+
**shippingAddress** | [**AddressDTO**](AddressDTO.md) | | [default to undefined]
|
|
11
|
+
**previousShippingAddreses** | [**Array<AddressDTO>**](AddressDTO.md) | Addresses | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -6,19 +6,19 @@ AccountContactsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | ID | [
|
|
10
|
-
**xeroId** | **string** | Account ID | [
|
|
11
|
-
**firstName** | **string** | First Name | [
|
|
12
|
-
**lastName** | **string** | Last Name | [
|
|
13
|
-
**emailAddress** | **string** | Email Address | [
|
|
14
|
-
**telephone** | **string** | Telephone | [
|
|
15
|
-
**accountsEmails** | **boolean** | Receives Accounts Emails | [
|
|
16
|
-
**marketingEmails** | **boolean** | Receives Marketing Emails | [
|
|
17
|
-
**licenceEmails** | **boolean** | Receives 3CX Licence Emails | [
|
|
18
|
-
**telephonyEmails** | **boolean** | Receives Telephony Emails | [
|
|
19
|
-
**despatchEmails** | **boolean** | Receives Despatch Emails | [
|
|
20
|
-
**mainContact** | **boolean** | mainContact | [
|
|
21
|
-
**verified** | **boolean** | Email Verified | [
|
|
9
|
+
**id** | **number** | ID | [default to undefined]
|
|
10
|
+
**xeroId** | **string** | Account ID | [default to undefined]
|
|
11
|
+
**firstName** | **string** | First Name | [default to undefined]
|
|
12
|
+
**lastName** | **string** | Last Name | [default to undefined]
|
|
13
|
+
**emailAddress** | **string** | Email Address | [default to undefined]
|
|
14
|
+
**telephone** | **string** | Telephone | [default to undefined]
|
|
15
|
+
**accountsEmails** | **boolean** | Receives Accounts Emails | [default to undefined]
|
|
16
|
+
**marketingEmails** | **boolean** | Receives Marketing Emails | [default to undefined]
|
|
17
|
+
**licenceEmails** | **boolean** | Receives 3CX Licence Emails | [default to undefined]
|
|
18
|
+
**telephonyEmails** | **boolean** | Receives Telephony Emails | [default to undefined]
|
|
19
|
+
**despatchEmails** | **boolean** | Receives Despatch Emails | [default to undefined]
|
|
20
|
+
**mainContact** | **boolean** | mainContact | [default to undefined]
|
|
21
|
+
**verified** | **boolean** | Email Verified | [default to undefined]
|
|
22
22
|
|
|
23
23
|
## Example
|
|
24
24
|
|
|
@@ -6,19 +6,19 @@ Account Contact Model
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | ID | [
|
|
10
|
-
**xeroId** | **string** | Account ID | [
|
|
11
|
-
**firstName** | **string** | First Name | [
|
|
12
|
-
**lastName** | **string** | Last Name | [
|
|
13
|
-
**emailAddress** | **string** | Email Address | [
|
|
14
|
-
**telephone** | **string** | Telephone | [
|
|
15
|
-
**accountsEmails** | **boolean** | Receives Accounts Emails | [
|
|
16
|
-
**marketingEmails** | **boolean** | Receives Marketing Emails | [
|
|
17
|
-
**licenceEmails** | **boolean** | Receives 3CX Licence Emails | [
|
|
18
|
-
**telephonyEmails** | **boolean** | Receives Telephony Emails | [
|
|
19
|
-
**despatchEmails** | **boolean** | Receives Despatch Emails | [
|
|
20
|
-
**mainContact** | **boolean** | mainContact | [
|
|
21
|
-
**verified** | **boolean** | Email Verified | [
|
|
9
|
+
**id** | **number** | ID | [default to undefined]
|
|
10
|
+
**xeroId** | **string** | Account ID | [default to undefined]
|
|
11
|
+
**firstName** | **string** | First Name | [default to undefined]
|
|
12
|
+
**lastName** | **string** | Last Name | [default to undefined]
|
|
13
|
+
**emailAddress** | **string** | Email Address | [default to undefined]
|
|
14
|
+
**telephone** | **string** | Telephone | [default to undefined]
|
|
15
|
+
**accountsEmails** | **boolean** | Receives Accounts Emails | [default to undefined]
|
|
16
|
+
**marketingEmails** | **boolean** | Receives Marketing Emails | [default to undefined]
|
|
17
|
+
**licenceEmails** | **boolean** | Receives 3CX Licence Emails | [default to undefined]
|
|
18
|
+
**telephonyEmails** | **boolean** | Receives Telephony Emails | [default to undefined]
|
|
19
|
+
**despatchEmails** | **boolean** | Receives Despatch Emails | [default to undefined]
|
|
20
|
+
**mainContact** | **boolean** | mainContact | [default to undefined]
|
|
21
|
+
**verified** | **boolean** | Email Verified | [default to undefined]
|
|
22
22
|
|
|
23
23
|
## Example
|
|
24
24
|
|
|
@@ -6,15 +6,15 @@ New Account Contact Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**firstName** | **string** | First Name | [
|
|
10
|
-
**lastName** | **string** | Last Name | [
|
|
11
|
-
**emailAddress** | **string** | Email Address | [
|
|
12
|
-
**telephone** | **string** | Telephone Number | [
|
|
13
|
-
**accountsEmails** | **boolean** | Receive Accounts Emails | [
|
|
14
|
-
**marketingEmails** | **boolean** | Receive Marketing Emails | [
|
|
15
|
-
**licenceEmails** | **boolean** | Receive 3CX Licence Emails | [
|
|
16
|
-
**telephonyEmails** | **boolean** | Receive SIP Trunk Emails | [
|
|
17
|
-
**despatchEmails** | **boolean** | Receive Despatch Emails | [
|
|
9
|
+
**firstName** | **string** | First Name | [default to undefined]
|
|
10
|
+
**lastName** | **string** | Last Name | [default to undefined]
|
|
11
|
+
**emailAddress** | **string** | Email Address | [default to undefined]
|
|
12
|
+
**telephone** | **string** | Telephone Number | [default to undefined]
|
|
13
|
+
**accountsEmails** | **boolean** | Receive Accounts Emails | [default to undefined]
|
|
14
|
+
**marketingEmails** | **boolean** | Receive Marketing Emails | [default to undefined]
|
|
15
|
+
**licenceEmails** | **boolean** | Receive 3CX Licence Emails | [default to undefined]
|
|
16
|
+
**telephonyEmails** | **boolean** | Receive SIP Trunk Emails | [default to undefined]
|
|
17
|
+
**despatchEmails** | **boolean** | Receive Despatch Emails | [default to undefined]
|
|
18
18
|
|
|
19
19
|
## Example
|
|
20
20
|
|
|
@@ -6,16 +6,17 @@ Account Details
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | ID | [
|
|
10
|
-
**xeroId** | **string** | Xero ID | [
|
|
11
|
-
**company** | **string** | Company | [
|
|
12
|
-
**creditLimit** | **number** | Credit Limit | [
|
|
13
|
-
**contacts** | [**Array<AccountContactModel>**](AccountContactModel.md) | Contacts | [
|
|
14
|
-
**billingAddress** | [**AddressModel**](AddressModel.md) | | [
|
|
15
|
-
**addresses** | [**Array<AddressModel>**](AddressModel.md) | Addresses | [
|
|
16
|
-
**provisioningUrls** | [**Array<ProvisioningModel>**](ProvisioningModel.md) | Provisioning URLs | [
|
|
17
|
-
**onHold** | **boolean** | On Hold | [
|
|
9
|
+
**id** | **number** | ID | [default to undefined]
|
|
10
|
+
**xeroId** | **string** | Xero ID | [default to undefined]
|
|
11
|
+
**company** | **string** | Company | [default to undefined]
|
|
12
|
+
**creditLimit** | **number** | Credit Limit | [default to undefined]
|
|
13
|
+
**contacts** | [**Array<AccountContactModel>**](AccountContactModel.md) | Contacts | [default to undefined]
|
|
14
|
+
**billingAddress** | [**AddressModel**](AddressModel.md) | | [default to undefined]
|
|
15
|
+
**addresses** | [**Array<AddressModel>**](AddressModel.md) | Addresses | [default to undefined]
|
|
16
|
+
**provisioningUrls** | [**Array<ProvisioningModel>**](ProvisioningModel.md) | Provisioning URLs | [default to undefined]
|
|
17
|
+
**onHold** | **boolean** | On Hold | [default to undefined]
|
|
18
18
|
**balance** | **number** | Balance (£) | [optional] [default to undefined]
|
|
19
|
+
**firstOrder** | **boolean** | First Order | [default to undefined]
|
|
19
20
|
|
|
20
21
|
## Example
|
|
21
22
|
|
|
@@ -33,6 +34,7 @@ const instance: AccountDetailedSummaryDTO = {
|
|
|
33
34
|
provisioningUrls,
|
|
34
35
|
onHold,
|
|
35
36
|
balance,
|
|
37
|
+
firstOrder,
|
|
36
38
|
};
|
|
37
39
|
```
|
|
38
40
|
|
|
@@ -6,16 +6,16 @@ Account Finance DTO
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | Account ID | [
|
|
10
|
-
**xeroId** | **string** | Account Xero ID | [
|
|
11
|
-
**accountNumber** | **string** | Account Number | [
|
|
12
|
-
**creditLimit** | **number** | Credit Limit | [
|
|
13
|
-
**balance** | **number** | Balance Used | [
|
|
14
|
-
**overdue** | **number** | Overdue Amount | [
|
|
15
|
-
**onHold** | **boolean** | On Hold | [
|
|
16
|
-
**priceList** | [**CustomerPriceListEnum**](CustomerPriceListEnum.md) | | [
|
|
17
|
-
**sipChannelCost** | **number** | SIP Trunk Channel Cost | [
|
|
18
|
-
**xeroUrl** | **string** | Xero Contact URL | [
|
|
9
|
+
**id** | **number** | Account ID | [default to undefined]
|
|
10
|
+
**xeroId** | **string** | Account Xero ID | [default to undefined]
|
|
11
|
+
**accountNumber** | **string** | Account Number | [default to undefined]
|
|
12
|
+
**creditLimit** | **number** | Credit Limit | [default to undefined]
|
|
13
|
+
**balance** | **number** | Balance Used | [default to undefined]
|
|
14
|
+
**overdue** | **number** | Overdue Amount | [default to undefined]
|
|
15
|
+
**onHold** | **boolean** | On Hold | [default to undefined]
|
|
16
|
+
**priceList** | [**CustomerPriceListEnum**](CustomerPriceListEnum.md) | | [default to undefined]
|
|
17
|
+
**sipChannelCost** | **number** | SIP Trunk Channel Cost | [default to undefined]
|
|
18
|
+
**xeroUrl** | **string** | Xero Contact URL | [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
|
@@ -6,23 +6,23 @@ New Account Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**companyName** | **string** | Company Name | [
|
|
10
|
-
**firstName** | **string** | First Name | [
|
|
11
|
-
**lastName** | **string** | Last Name | [
|
|
12
|
-
**telephone** | **string** | Telephone | [
|
|
13
|
-
**addressLine1** | **string** | Address Line 1 | [
|
|
9
|
+
**companyName** | **string** | Company Name | [default to undefined]
|
|
10
|
+
**firstName** | **string** | First Name | [default to undefined]
|
|
11
|
+
**lastName** | **string** | Last Name | [default to undefined]
|
|
12
|
+
**telephone** | **string** | Telephone | [default to undefined]
|
|
13
|
+
**addressLine1** | **string** | Address Line 1 | [default to undefined]
|
|
14
14
|
**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
|
|
15
|
-
**town** | **string** | Town/City | [
|
|
16
|
-
**postCode** | **string** | Post Code | [
|
|
17
|
-
**country** | **string** | Country ISO | [
|
|
15
|
+
**town** | **string** | Town/City | [default to undefined]
|
|
16
|
+
**postCode** | **string** | Post Code | [default to undefined]
|
|
17
|
+
**country** | **string** | Country ISO | [default to undefined]
|
|
18
18
|
**companyNumber** | **string** | Company Registration Number | [optional] [default to undefined]
|
|
19
19
|
**preferredPbx** | **string** | Preferred PBX | [optional] [default to undefined]
|
|
20
20
|
**vatNumber** | **string** | VAT Number | [optional] [default to undefined]
|
|
21
|
-
**email** | **string** | Email Address | [
|
|
21
|
+
**email** | **string** | Email Address | [default to undefined]
|
|
22
22
|
**source** | **string** | Source | [optional] [default to undefined]
|
|
23
23
|
**creditRequired** | **number** | Credit Limit Required | [optional] [default to undefined]
|
|
24
|
-
**marketing** | **boolean** | Marketing Opt-In | [
|
|
25
|
-
**reseller** | **boolean** | Reseller | [
|
|
24
|
+
**marketing** | **boolean** | Marketing Opt-In | [default to false]
|
|
25
|
+
**reseller** | **boolean** | Reseller | [default to false]
|
|
26
26
|
|
|
27
27
|
## Example
|
|
28
28
|
|
|
@@ -6,9 +6,9 @@ Account Summary
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | ID | [
|
|
10
|
-
**company** | **string** | Company | [
|
|
11
|
-
**xeroId** | **string** | Xero ID | [
|
|
9
|
+
**id** | **number** | ID | [default to undefined]
|
|
10
|
+
**company** | **string** | Company | [default to undefined]
|
|
11
|
+
**xeroId** | **string** | Xero ID | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
package/docs/AccountsApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# AccountsApi
|
|
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
|
|------------- | ------------- | -------------|
|
|
@@ -18,9 +18,11 @@ All URIs are relative to *https://bitbucket.org*
|
|
|
18
18
|
|[**getGetCustomerAccountsList**](#getgetcustomeraccountslist) | **GET** /admin/accounts/customers/list | |
|
|
19
19
|
|[**getGetCustomerKeys**](#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys|
|
|
20
20
|
|[**getGetCustomerMap**](#getgetcustomermap) | **GET** /admin/accounts/customer/map | |
|
|
21
|
+
|[**getGetDeliveryAddresses**](#getgetdeliveryaddresses) | **GET** /accounts/addresses/delivery | |
|
|
21
22
|
|[**getGetFinanceSettings**](#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance | |
|
|
22
23
|
|[**getGetLastAccount**](#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account|
|
|
23
24
|
|[**getGetNewPriceList**](#getgetnewpricelist) | **GET** /admin/accounts/priceList/new | Download New Price List|
|
|
25
|
+
|[**getGetTcxHostingPriceList**](#getgettcxhostingpricelist) | **GET** /admin/accounts/{id}/tcx/hosting/pricelist | |
|
|
24
26
|
|[**getGetTcxPartnerDetails**](#getgettcxpartnerdetails) | **GET** /admin/accounts/{id}/tcx/partner | |
|
|
25
27
|
|[**getVerifyEmailAddress**](#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address|
|
|
26
28
|
|[**patchSetAccountStatus**](#patchsetaccountstatus) | **PATCH** /admin/accounts/{id}/status/{state} | |
|
|
@@ -786,6 +788,53 @@ No authorization required
|
|
|
786
788
|
|
|
787
789
|
[[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)
|
|
788
790
|
|
|
791
|
+
# **getGetDeliveryAddresses**
|
|
792
|
+
> Array<AddressModel> getGetDeliveryAddresses()
|
|
793
|
+
|
|
794
|
+
Get account delivery addresses
|
|
795
|
+
|
|
796
|
+
### Example
|
|
797
|
+
|
|
798
|
+
```typescript
|
|
799
|
+
import {
|
|
800
|
+
AccountsApi,
|
|
801
|
+
Configuration
|
|
802
|
+
} from 'yellowgrid-api-ts';
|
|
803
|
+
|
|
804
|
+
const configuration = new Configuration();
|
|
805
|
+
const apiInstance = new AccountsApi(configuration);
|
|
806
|
+
|
|
807
|
+
const { status, data } = await apiInstance.getGetDeliveryAddresses();
|
|
808
|
+
```
|
|
809
|
+
|
|
810
|
+
### Parameters
|
|
811
|
+
This endpoint does not have any parameters.
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
### Return type
|
|
815
|
+
|
|
816
|
+
**Array<AddressModel>**
|
|
817
|
+
|
|
818
|
+
### Authorization
|
|
819
|
+
|
|
820
|
+
No authorization required
|
|
821
|
+
|
|
822
|
+
### HTTP request headers
|
|
823
|
+
|
|
824
|
+
- **Content-Type**: Not defined
|
|
825
|
+
- **Accept**: application/json
|
|
826
|
+
|
|
827
|
+
|
|
828
|
+
### HTTP response details
|
|
829
|
+
| Status code | Description | Response headers |
|
|
830
|
+
|-------------|-------------|------------------|
|
|
831
|
+
|**200** | Account Delivery Addresses | - |
|
|
832
|
+
|**400** | Bad Request | - |
|
|
833
|
+
|**401** | Unauthorised | - |
|
|
834
|
+
|**403** | Access Denied | - |
|
|
835
|
+
|
|
836
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
837
|
+
|
|
789
838
|
# **getGetFinanceSettings**
|
|
790
839
|
> AccountFinanceDTO getGetFinanceSettings()
|
|
791
840
|
|
|
@@ -941,6 +990,60 @@ No authorization required
|
|
|
941
990
|
|
|
942
991
|
[[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)
|
|
943
992
|
|
|
993
|
+
# **getGetTcxHostingPriceList**
|
|
994
|
+
> GetGetTcxHostingPriceList200Response getGetTcxHostingPriceList()
|
|
995
|
+
|
|
996
|
+
Get Account 3CX Details
|
|
997
|
+
|
|
998
|
+
### Example
|
|
999
|
+
|
|
1000
|
+
```typescript
|
|
1001
|
+
import {
|
|
1002
|
+
AccountsApi,
|
|
1003
|
+
Configuration
|
|
1004
|
+
} from 'yellowgrid-api-ts';
|
|
1005
|
+
|
|
1006
|
+
const configuration = new Configuration();
|
|
1007
|
+
const apiInstance = new AccountsApi(configuration);
|
|
1008
|
+
|
|
1009
|
+
let id: string; //Xero ID (default to undefined)
|
|
1010
|
+
|
|
1011
|
+
const { status, data } = await apiInstance.getGetTcxHostingPriceList(
|
|
1012
|
+
id
|
|
1013
|
+
);
|
|
1014
|
+
```
|
|
1015
|
+
|
|
1016
|
+
### Parameters
|
|
1017
|
+
|
|
1018
|
+
|Name | Type | Description | Notes|
|
|
1019
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1020
|
+
| **id** | [**string**] | Xero ID | defaults to undefined|
|
|
1021
|
+
|
|
1022
|
+
|
|
1023
|
+
### Return type
|
|
1024
|
+
|
|
1025
|
+
**GetGetTcxHostingPriceList200Response**
|
|
1026
|
+
|
|
1027
|
+
### Authorization
|
|
1028
|
+
|
|
1029
|
+
No authorization required
|
|
1030
|
+
|
|
1031
|
+
### HTTP request headers
|
|
1032
|
+
|
|
1033
|
+
- **Content-Type**: Not defined
|
|
1034
|
+
- **Accept**: application/json
|
|
1035
|
+
|
|
1036
|
+
|
|
1037
|
+
### HTTP response details
|
|
1038
|
+
| Status code | Description | Response headers |
|
|
1039
|
+
|-------------|-------------|------------------|
|
|
1040
|
+
|**200** | Account 3CX Hosting Price List | - |
|
|
1041
|
+
|**400** | Bad Request | - |
|
|
1042
|
+
|**401** | Unauthorised | - |
|
|
1043
|
+
|**403** | Access Denied | - |
|
|
1044
|
+
|
|
1045
|
+
[[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)
|
|
1046
|
+
|
|
944
1047
|
# **getGetTcxPartnerDetails**
|
|
945
1048
|
> PartnerDTO getGetTcxPartnerDetails()
|
|
946
1049
|
|
|
@@ -6,10 +6,10 @@ Accounts
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**results** | [**Array<CreditAccountEntity>**](CreditAccountEntity.md) | Results | [
|
|
10
|
-
**page** | **number** | Page | [
|
|
11
|
-
**perPage** | **number** | Per Page | [
|
|
12
|
-
**totalResults** | **number** | Total Results | [
|
|
9
|
+
**results** | [**Array<CreditAccountEntity>**](CreditAccountEntity.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/AddressDTO.md
CHANGED
|
@@ -6,12 +6,15 @@ Address
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**
|
|
10
|
-
**
|
|
11
|
-
**
|
|
12
|
-
**
|
|
13
|
-
**
|
|
14
|
-
**
|
|
9
|
+
**company** | **string** | Company | [optional] [default to undefined]
|
|
10
|
+
**addressLine1** | **string** | Address Line 1 | [default to undefined]
|
|
11
|
+
**addressLine2** | **string** | Address Line 2 | [default to undefined]
|
|
12
|
+
**city** | **string** | City | [default to undefined]
|
|
13
|
+
**region** | **string** | Region | [default to undefined]
|
|
14
|
+
**postalCode** | **string** | Postal Code | [default to undefined]
|
|
15
|
+
**iso** | **string** | Country | [default to undefined]
|
|
16
|
+
**phone** | **string** | Telephone | [optional] [default to undefined]
|
|
17
|
+
**name** | **string** | Name | [optional] [default to undefined]
|
|
15
18
|
|
|
16
19
|
## Example
|
|
17
20
|
|
|
@@ -19,12 +22,15 @@ Name | Type | Description | Notes
|
|
|
19
22
|
import { AddressDTO } from 'yellowgrid-api-ts';
|
|
20
23
|
|
|
21
24
|
const instance: AddressDTO = {
|
|
25
|
+
company,
|
|
22
26
|
addressLine1,
|
|
23
27
|
addressLine2,
|
|
24
28
|
city,
|
|
25
29
|
region,
|
|
26
30
|
postalCode,
|
|
27
31
|
iso,
|
|
32
|
+
phone,
|
|
33
|
+
name,
|
|
28
34
|
};
|
|
29
35
|
```
|
|
30
36
|
|
package/docs/AddressModel.md
CHANGED
|
@@ -6,11 +6,11 @@ Order Address
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**firstName** | **string** | Contact First Name | [
|
|
10
|
-
**lastName** | **string** | Contact Last Name | [
|
|
11
|
-
**fullName** | **string** | Contact Full Name | [
|
|
12
|
-
**telephone** | **string** | Contact Telephone | [
|
|
13
|
-
**vatNumber** | **string** | VAT Number | [
|
|
9
|
+
**firstName** | **string** | Contact First Name | [default to undefined]
|
|
10
|
+
**lastName** | **string** | Contact Last Name | [default to undefined]
|
|
11
|
+
**fullName** | **string** | Contact Full Name | [default to undefined]
|
|
12
|
+
**telephone** | **string** | Contact Telephone | [default to undefined]
|
|
13
|
+
**vatNumber** | **string** | VAT Number | [default to undefined]
|
|
14
14
|
**addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
|
|
15
15
|
**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
|
|
16
16
|
**addressLine3** | **string** | Address Line 3 | [optional] [default to undefined]
|
|
@@ -6,10 +6,10 @@ Address Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**addressLine1** | **string** | Address Line 1 | [
|
|
10
|
-
**addressLine2** | **string** | Address Line 2 | [
|
|
11
|
-
**addressCity** | **string** | City | [
|
|
12
|
-
**addressPostcode** | **string** | Postal Code | [
|
|
9
|
+
**addressLine1** | **string** | Address Line 1 | [default to undefined]
|
|
10
|
+
**addressLine2** | **string** | Address Line 2 | [default to undefined]
|
|
11
|
+
**addressCity** | **string** | City | [default to undefined]
|
|
12
|
+
**addressPostcode** | **string** | Postal Code | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# AdminCustomerRmasModel
|
|
2
|
+
|
|
3
|
+
Admin Customer RMA List Response
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**results** | [**Array<AdminRmaSummaryDTO>**](AdminRmaSummaryDTO.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
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { AdminCustomerRmasModel } from 'yellowgrid-api-ts';
|
|
18
|
+
|
|
19
|
+
const instance: AdminCustomerRmasModel = {
|
|
20
|
+
results,
|
|
21
|
+
page,
|
|
22
|
+
perPage,
|
|
23
|
+
totalResults,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -16,13 +16,13 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**requestedPortDate** | **string** | Requested Port Date | [optional] [default to undefined]
|
|
17
17
|
**asap** | **boolean** | Port Date ASAP | [optional] [default to undefined]
|
|
18
18
|
**comment** | **string** | Comment | [optional] [default to undefined]
|
|
19
|
-
**id** | **number** | Number Port ID | [
|
|
20
|
-
**customerId** | **number** | Reseller ID | [
|
|
21
|
-
**customerName** | **string** | Customer Name | [
|
|
22
|
-
**portDate** | **string** | Porting Date | [
|
|
23
|
-
**numberRanges** | [**Array<NumberPortRangeDTO>**](NumberPortRangeDTO.md) | Number Ranges | [
|
|
24
|
-
**status** | **number** | Status | [
|
|
25
|
-
**statusText** | **string** | Status Text | [
|
|
19
|
+
**id** | **number** | Number Port ID | [default to undefined]
|
|
20
|
+
**customerId** | **number** | Reseller ID | [default to undefined]
|
|
21
|
+
**customerName** | **string** | Customer Name | [default to undefined]
|
|
22
|
+
**portDate** | **string** | Porting Date | [default to undefined]
|
|
23
|
+
**numberRanges** | [**Array<NumberPortRangeDTO>**](NumberPortRangeDTO.md) | Number Ranges | [default to undefined]
|
|
24
|
+
**status** | **number** | Status | [default to undefined]
|
|
25
|
+
**statusText** | **string** | Status Text | [default to undefined]
|
|
26
26
|
**ticketId** | **number** | Ticket ID | [optional] [default to undefined]
|
|
27
27
|
**notes** | [**Array<NumberPortNoteDTO>**](NumberPortNoteDTO.md) | Notes | [optional] [default to undefined]
|
|
28
28
|
**cloas** | [**Array<AttachmentModel>**](AttachmentModel.md) | Attachments | [optional] [default to undefined]
|
|
@@ -7,12 +7,12 @@ Admin Order Request
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**orderReference** | **string** | Order Reference | [optional] [default to undefined]
|
|
10
|
-
**items** | [**Array<DetailedItemRequestDTO>**](DetailedItemRequestDTO.md) | Items | [
|
|
11
|
-
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [
|
|
10
|
+
**items** | [**Array<DetailedItemRequestDTO>**](DetailedItemRequestDTO.md) | Items | [default to undefined]
|
|
11
|
+
**shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [default to undefined]
|
|
12
12
|
**provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
|
|
13
|
-
**shippingAddress** | [**AddressModel**](AddressModel.md) |
|
|
14
|
-
**partShip** | **boolean** | Part Ship Order | [
|
|
15
|
-
**quote** | **boolean** | Quote | [
|
|
13
|
+
**shippingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
|
|
14
|
+
**partShip** | **boolean** | Part Ship Order | [default to undefined]
|
|
15
|
+
**quote** | **boolean** | Quote | [default to undefined]
|
|
16
16
|
**customerId** | **number** | Customer ID | [optional] [default to undefined]
|
|
17
17
|
**contact** | **string** | Contact | [optional] [default to undefined]
|
|
18
18
|
**ignoreOnHold** | **boolean** | Ignore Customer On Hold | [optional] [default to false]
|