yellowgrid-api-ts 3.2.277 → 3.2.279
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 +32 -0
- package/.openapi-generator/VERSION +1 -1
- package/README.md +66 -0
- package/api.ts +5123 -1849
- package/common.ts +2 -2
- package/dist/api.d.ts +10229 -8273
- package/dist/api.js +3208 -319
- package/dist/models/ReasonEnum.d.ts +18 -0
- package/dist/models/ReasonEnum.js +20 -0
- 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 +10 -10
- package/docs/AccountFinanceDTO.md +10 -10
- package/docs/AccountRequestModel.md +11 -11
- package/docs/AccountSummaryDTO.md +3 -3
- package/docs/AccountsApi.md +48 -0
- 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 +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/BrandedVideoSummaryDTO.md +10 -10
- package/docs/BrandedVideosSummariesModel.md +4 -4
- package/docs/CallBarringModel.md +5 -5
- 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 +3 -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 +2 -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 +2 -2
- package/docs/DetailedOrderRequestDTO.md +4 -4
- 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/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/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/MonthlyUsageModel.md +2 -2
- package/docs/MultiTenantChangeResponseModel.md +4 -4
- 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 +21 -21
- package/docs/NumberPortsModel.md +4 -4
- package/docs/OAuth20Api.md +3 -3
- 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 +55 -0
- package/docs/PartnerDTO.md +10 -10
- package/docs/PasswordSenderDTO.md +2 -2
- package/docs/PasswordSenderEntity.md +7 -7
- package/docs/PortalAccountModel.md +23 -23
- package/docs/PortalLoginModel.md +7 -7
- package/docs/PostGenerateReport200Response.md +8 -8
- package/docs/PriceListItemModel.md +2 -2
- 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/ProductSearchResultsModel.md +1 -1
- package/docs/ProductSerialInfoDTO.md +27 -0
- package/docs/ProductSerialInfoModel.md +3 -3
- package/docs/ProductSummaryDTO.md +2 -2
- package/docs/PromoCodesEntity.md +8 -8
- package/docs/PromoItemModel.md +8 -8
- package/docs/PromoItemsEntity.md +8 -8
- package/docs/PromoModel.md +8 -8
- package/docs/PromoSummariesModel.md +4 -4
- package/docs/PromoSummaryDTO.md +3 -3
- package/docs/ProspectDTO.md +7 -7
- package/docs/ProspectEntity.md +11 -11
- package/docs/ProvisioningModel.md +3 -3
- package/docs/ProvisioningRequestEntity.md +3 -3
- package/docs/RMAApi.md +1749 -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/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/ScannedItemModel.md +1 -1
- package/docs/ScopeModel.md +2 -2
- 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/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 +56 -0
- 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/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 +6 -6
- package/docs/StockProductPriceModel.md +1 -1
- 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/SupplierProductModel.md +3 -3
- package/docs/SupplierProductResultsModel.md +4 -4
- package/docs/SupportTicketModel.md +10 -10
- 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/TcxExtsEntity.md +8 -8
- package/docs/TcxInstallationModel.md +17 -17
- package/docs/TcxInstallationsModel.md +4 -4
- package/docs/TcxKeySummaryDTO.md +3 -3
- 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/TcxNumbersEntity.md +3 -3
- package/docs/TcxOfficeHoursEntity.md +15 -15
- package/docs/TcxPhoneModel.md +6 -6
- package/docs/TcxPhonesEntity.md +6 -6
- package/docs/TcxRemoteStorageModel.md +4 -4
- package/docs/TcxSbcDTO.md +7 -7
- package/docs/TcxSbcEntity.md +16 -16
- package/docs/TcxSbcModel.md +16 -16
- package/docs/TcxSbcResponseDTO.md +2 -2
- package/docs/TcxSetupEntity.md +25 -25
- package/docs/TcxSetupsModel.md +4 -4
- package/docs/TcxSipTrunksEntity.md +13 -13
- package/docs/TcxTemplateXmlEnum.md +2 -2
- package/docs/TcxUsersEntity.md +6 -6
- package/docs/TcxWizardConfigModel.md +2 -2
- package/docs/TcxWizardModel.md +9 -9
- package/docs/TechSupportCompanySummaryDTO.md +5 -5
- package/docs/ThumbnailDTO.md +3 -3
- package/docs/TicketSummaryModel.md +6 -6
- package/docs/TicketTimeDTO.md +9 -9
- package/docs/TicketsApi.md +10 -10
- 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 +13 -13
- package/docs/XeroLogEntity.md +10 -10
- package/git_push.sh +14 -17
- package/models/ReasonEnum.ts +19 -0
- 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,18 @@
|
|
|
1
|
+
export declare const ReasonEnum: {
|
|
2
|
+
readonly DOA: {
|
|
3
|
+
readonly name: "DOA";
|
|
4
|
+
readonly value: 1;
|
|
5
|
+
readonly publicValue: "Dead On Arrival";
|
|
6
|
+
};
|
|
7
|
+
readonly FAULTY: {
|
|
8
|
+
readonly name: "FAULTY";
|
|
9
|
+
readonly value: 2;
|
|
10
|
+
readonly publicValue: "Faulty";
|
|
11
|
+
};
|
|
12
|
+
readonly WORKING: {
|
|
13
|
+
readonly name: "WORKING";
|
|
14
|
+
readonly value: 3;
|
|
15
|
+
readonly publicValue: "Working (Good Condition)";
|
|
16
|
+
};
|
|
17
|
+
};
|
|
18
|
+
export type ReasonEnum = typeof ReasonEnum;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ReasonEnum = void 0;
|
|
4
|
+
exports.ReasonEnum = {
|
|
5
|
+
"DOA": {
|
|
6
|
+
"name": "DOA",
|
|
7
|
+
"value": 1,
|
|
8
|
+
"publicValue": "Dead On Arrival"
|
|
9
|
+
},
|
|
10
|
+
"FAULTY": {
|
|
11
|
+
"name": "FAULTY",
|
|
12
|
+
"value": 2,
|
|
13
|
+
"publicValue": "Faulty"
|
|
14
|
+
},
|
|
15
|
+
"WORKING": {
|
|
16
|
+
"name": "WORKING",
|
|
17
|
+
"value": 3,
|
|
18
|
+
"publicValue": "Working (Good Condition)"
|
|
19
|
+
}
|
|
20
|
+
};
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
export declare const ResolutionEnum: {
|
|
2
|
+
readonly REPLACEMENT: {
|
|
3
|
+
readonly name: "REPLACEMENT";
|
|
4
|
+
readonly value: 1;
|
|
5
|
+
readonly publicValue: "Replacement";
|
|
6
|
+
};
|
|
7
|
+
readonly CREDIT: {
|
|
8
|
+
readonly name: "CREDIT";
|
|
9
|
+
readonly value: 2;
|
|
10
|
+
readonly publicValue: "Credit";
|
|
11
|
+
};
|
|
12
|
+
readonly ADVANCE_REPLACEMENT: {
|
|
13
|
+
readonly name: "ADVANCE_REPLACEMENT";
|
|
14
|
+
readonly value: 3;
|
|
15
|
+
readonly publicValue: "Advance Replacement";
|
|
16
|
+
};
|
|
17
|
+
};
|
|
18
|
+
export type ResolutionEnum = typeof ResolutionEnum;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ResolutionEnum = void 0;
|
|
4
|
+
exports.ResolutionEnum = {
|
|
5
|
+
"REPLACEMENT": {
|
|
6
|
+
"name": "REPLACEMENT",
|
|
7
|
+
"value": 1,
|
|
8
|
+
"publicValue": "Replacement"
|
|
9
|
+
},
|
|
10
|
+
"CREDIT": {
|
|
11
|
+
"name": "CREDIT",
|
|
12
|
+
"value": 2,
|
|
13
|
+
"publicValue": "Credit"
|
|
14
|
+
},
|
|
15
|
+
"ADVANCE_REPLACEMENT": {
|
|
16
|
+
"name": "ADVANCE_REPLACEMENT",
|
|
17
|
+
"value": 3,
|
|
18
|
+
"publicValue": "Advance Replacement"
|
|
19
|
+
}
|
|
20
|
+
};
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
export declare const RmaItemCreditTypeEnum: {
|
|
2
|
+
readonly FULL: {
|
|
3
|
+
readonly name: "FULL";
|
|
4
|
+
readonly value: 100;
|
|
5
|
+
readonly publicValue: "Full (100%)";
|
|
6
|
+
};
|
|
7
|
+
readonly RESTOCKING_FEE: {
|
|
8
|
+
readonly name: "RESTOCKING_FEE";
|
|
9
|
+
readonly value: 85;
|
|
10
|
+
readonly publicValue: "Restocking Fee (85%)";
|
|
11
|
+
};
|
|
12
|
+
};
|
|
13
|
+
export type RmaItemCreditTypeEnum = typeof RmaItemCreditTypeEnum;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.RmaItemCreditTypeEnum = void 0;
|
|
4
|
+
exports.RmaItemCreditTypeEnum = {
|
|
5
|
+
"FULL": {
|
|
6
|
+
"name": "FULL",
|
|
7
|
+
"value": 100,
|
|
8
|
+
"publicValue": "Full (100%)"
|
|
9
|
+
},
|
|
10
|
+
"RESTOCKING_FEE": {
|
|
11
|
+
"name": "RESTOCKING_FEE",
|
|
12
|
+
"value": 85,
|
|
13
|
+
"publicValue": "Restocking Fee (85%)"
|
|
14
|
+
}
|
|
15
|
+
};
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
export declare const RmaItemResolutionEnum: {
|
|
2
|
+
readonly UNRESOLVED: {
|
|
3
|
+
readonly name: "UNRESOLVED";
|
|
4
|
+
readonly value: 1;
|
|
5
|
+
readonly publicValue: "Unresolved";
|
|
6
|
+
};
|
|
7
|
+
readonly REPLACED: {
|
|
8
|
+
readonly name: "REPLACED";
|
|
9
|
+
readonly value: 2;
|
|
10
|
+
readonly publicValue: "Replaced";
|
|
11
|
+
};
|
|
12
|
+
readonly CREDITED: {
|
|
13
|
+
readonly name: "CREDITED";
|
|
14
|
+
readonly value: 3;
|
|
15
|
+
readonly publicValue: "Credited";
|
|
16
|
+
};
|
|
17
|
+
readonly RETURNED: {
|
|
18
|
+
readonly name: "RETURNED";
|
|
19
|
+
readonly value: 4;
|
|
20
|
+
readonly publicValue: "Returned";
|
|
21
|
+
};
|
|
22
|
+
readonly BINNED: {
|
|
23
|
+
readonly name: "BINNED";
|
|
24
|
+
readonly value: 5;
|
|
25
|
+
readonly publicValue: "Binned";
|
|
26
|
+
};
|
|
27
|
+
};
|
|
28
|
+
export type RmaItemResolutionEnum = typeof RmaItemResolutionEnum;
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.RmaItemResolutionEnum = void 0;
|
|
4
|
+
exports.RmaItemResolutionEnum = {
|
|
5
|
+
"UNRESOLVED": {
|
|
6
|
+
"name": "UNRESOLVED",
|
|
7
|
+
"value": 1,
|
|
8
|
+
"publicValue": "Unresolved"
|
|
9
|
+
},
|
|
10
|
+
"REPLACED": {
|
|
11
|
+
"name": "REPLACED",
|
|
12
|
+
"value": 2,
|
|
13
|
+
"publicValue": "Replaced"
|
|
14
|
+
},
|
|
15
|
+
"CREDITED": {
|
|
16
|
+
"name": "CREDITED",
|
|
17
|
+
"value": 3,
|
|
18
|
+
"publicValue": "Credited"
|
|
19
|
+
},
|
|
20
|
+
"RETURNED": {
|
|
21
|
+
"name": "RETURNED",
|
|
22
|
+
"value": 4,
|
|
23
|
+
"publicValue": "Returned"
|
|
24
|
+
},
|
|
25
|
+
"BINNED": {
|
|
26
|
+
"name": "BINNED",
|
|
27
|
+
"value": 5,
|
|
28
|
+
"publicValue": "Binned"
|
|
29
|
+
}
|
|
30
|
+
};
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
export declare const RmaItemStatusEnum: {
|
|
2
|
+
readonly NOT_RECEIVED: {
|
|
3
|
+
readonly name: "NOT_RECEIVED";
|
|
4
|
+
readonly value: 1;
|
|
5
|
+
readonly publicValue: "Not Received";
|
|
6
|
+
};
|
|
7
|
+
readonly IN_PROGRESS: {
|
|
8
|
+
readonly name: "IN_PROGRESS";
|
|
9
|
+
readonly value: 2;
|
|
10
|
+
readonly publicValue: "In Progress";
|
|
11
|
+
};
|
|
12
|
+
readonly RESOLVED: {
|
|
13
|
+
readonly name: "RESOLVED";
|
|
14
|
+
readonly value: 3;
|
|
15
|
+
readonly publicValue: "Resolved";
|
|
16
|
+
};
|
|
17
|
+
};
|
|
18
|
+
export type RmaItemStatusEnum = typeof RmaItemStatusEnum;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.RmaItemStatusEnum = void 0;
|
|
4
|
+
exports.RmaItemStatusEnum = {
|
|
5
|
+
"NOT_RECEIVED": {
|
|
6
|
+
"name": "NOT_RECEIVED",
|
|
7
|
+
"value": 1,
|
|
8
|
+
"publicValue": "Not Received"
|
|
9
|
+
},
|
|
10
|
+
"IN_PROGRESS": {
|
|
11
|
+
"name": "IN_PROGRESS",
|
|
12
|
+
"value": 2,
|
|
13
|
+
"publicValue": "In Progress"
|
|
14
|
+
},
|
|
15
|
+
"RESOLVED": {
|
|
16
|
+
"name": "RESOLVED",
|
|
17
|
+
"value": 3,
|
|
18
|
+
"publicValue": "Resolved"
|
|
19
|
+
}
|
|
20
|
+
};
|
|
@@ -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
|
+
};
|
|
@@ -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
13
|
**shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
|
|
14
|
-
**partShip** | **boolean** | Part Ship Order | [
|
|
15
|
-
**quote** | **boolean** | Quote | [
|
|
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,17 +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 | [
|
|
19
|
+
**firstOrder** | **boolean** | First Order | [default to undefined]
|
|
20
20
|
|
|
21
21
|
## Example
|
|
22
22
|
|
|
@@ -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
|
@@ -18,6 +18,7 @@ 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|
|
|
@@ -786,6 +787,53 @@ No authorization required
|
|
|
786
787
|
|
|
787
788
|
[[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
789
|
|
|
790
|
+
# **getGetDeliveryAddresses**
|
|
791
|
+
> Array<AddressModel> getGetDeliveryAddresses()
|
|
792
|
+
|
|
793
|
+
Get account delivery addresses
|
|
794
|
+
|
|
795
|
+
### Example
|
|
796
|
+
|
|
797
|
+
```typescript
|
|
798
|
+
import {
|
|
799
|
+
AccountsApi,
|
|
800
|
+
Configuration
|
|
801
|
+
} from 'yellowgrid-api-ts';
|
|
802
|
+
|
|
803
|
+
const configuration = new Configuration();
|
|
804
|
+
const apiInstance = new AccountsApi(configuration);
|
|
805
|
+
|
|
806
|
+
const { status, data } = await apiInstance.getGetDeliveryAddresses();
|
|
807
|
+
```
|
|
808
|
+
|
|
809
|
+
### Parameters
|
|
810
|
+
This endpoint does not have any parameters.
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
### Return type
|
|
814
|
+
|
|
815
|
+
**Array<AddressModel>**
|
|
816
|
+
|
|
817
|
+
### Authorization
|
|
818
|
+
|
|
819
|
+
No authorization required
|
|
820
|
+
|
|
821
|
+
### HTTP request headers
|
|
822
|
+
|
|
823
|
+
- **Content-Type**: Not defined
|
|
824
|
+
- **Accept**: application/json
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
### HTTP response details
|
|
828
|
+
| Status code | Description | Response headers |
|
|
829
|
+
|-------------|-------------|------------------|
|
|
830
|
+
|**200** | Account Delivery Addresses | - |
|
|
831
|
+
|**400** | Bad Request | - |
|
|
832
|
+
|**401** | Unauthorised | - |
|
|
833
|
+
|**403** | Access Denied | - |
|
|
834
|
+
|
|
835
|
+
[[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)
|
|
836
|
+
|
|
789
837
|
# **getGetFinanceSettings**
|
|
790
838
|
> AccountFinanceDTO getGetFinanceSettings()
|
|
791
839
|
|
|
@@ -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
|
|