yellowgrid-api-ts 3.2.276 → 3.2.278
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 +37 -0
- package/.openapi-generator/VERSION +1 -1
- package/README.md +79 -0
- package/api.ts +6448 -2386
- package/common.ts +2 -2
- package/dist/api.d.ts +5989 -3577
- package/dist/api.js +6189 -2600
- 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 +47 -0
- package/docs/BrandedVideosApi.md +424 -0
- package/docs/BrandedVideosSummariesModel.md +27 -0
- 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 +25 -0
- 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 +51 -0
- 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,21 @@
|
|
|
1
|
+
# EmailRequestModel
|
|
2
|
+
|
|
3
|
+
Email Request Model
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**email** | **string** | Email Address | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { EmailRequestModel } from 'yellowgrid-api-ts';
|
|
15
|
+
|
|
16
|
+
const instance: EmailRequestModel = {
|
|
17
|
+
email,
|
|
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)
|
package/docs/EventDTO.md
CHANGED
|
@@ -6,14 +6,14 @@ Service Event DTO
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**title** | **string** | Service Event Title | [
|
|
10
|
-
**type** | **number** | Service Event Type | [
|
|
11
|
-
**service** | **number** | Service Impacted | [
|
|
12
|
-
**statusName** | **string** | Event Status Description | [
|
|
13
|
-
**typeName** | **string** | Event Type Description | [
|
|
14
|
-
**id** | **number** | Service Event ID | [
|
|
15
|
-
**status** | **number** | Service Event Status | [
|
|
16
|
-
**updates** | [**Array<EventUpdateDTO>**](EventUpdateDTO.md) | Service Event Updates | [
|
|
9
|
+
**title** | **string** | Service Event Title | [default to undefined]
|
|
10
|
+
**type** | **number** | Service Event Type | [default to undefined]
|
|
11
|
+
**service** | **number** | Service Impacted | [default to undefined]
|
|
12
|
+
**statusName** | **string** | Event Status Description | [default to undefined]
|
|
13
|
+
**typeName** | **string** | Event Type Description | [default to undefined]
|
|
14
|
+
**id** | **number** | Service Event ID | [default to undefined]
|
|
15
|
+
**status** | **number** | Service Event Status | [default to undefined]
|
|
16
|
+
**updates** | [**Array<EventUpdateDTO>**](EventUpdateDTO.md) | Service Event Updates | [default to undefined]
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
package/docs/EventRequestDTO.md
CHANGED
|
@@ -6,9 +6,9 @@ Service Event Request DTO
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**title** | **string** | Service Event Title | [
|
|
10
|
-
**type** | **number** | Service Event Type | [
|
|
11
|
-
**service** | **number** | Service Impacted | [
|
|
9
|
+
**title** | **string** | Service Event Title | [default to undefined]
|
|
10
|
+
**type** | **number** | Service Event Type | [default to undefined]
|
|
11
|
+
**service** | **number** | Service Impacted | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -6,8 +6,8 @@ Service Event Subscribption Model
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **string** | id | [
|
|
10
|
-
**email** | **string** | email | [
|
|
9
|
+
**id** | **string** | id | [default to undefined]
|
|
10
|
+
**email** | **string** | email | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/EventUpdateDTO.md
CHANGED
|
@@ -6,10 +6,10 @@ Service Event Update DTO
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**message** | **string** | Service Event Update Message | [
|
|
10
|
-
**type** | **number** | Service Event Update Type | [
|
|
11
|
-
**createdAt** | **string** | Date Time | [
|
|
12
|
-
**typeName** | **string** | Service Event Update Type Description | [
|
|
9
|
+
**message** | **string** | Service Event Update Message | [default to undefined]
|
|
10
|
+
**type** | **number** | Service Event Update Type | [default to undefined]
|
|
11
|
+
**createdAt** | **string** | Date Time | [default to undefined]
|
|
12
|
+
**typeName** | **string** | Service Event Update Type Description | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -6,11 +6,11 @@ Event Update Entity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**eventId** | **number** | eventId | [
|
|
11
|
-
**message** | **string** | message | [
|
|
12
|
-
**type** | **number** | type | [
|
|
13
|
-
**createdAt** | **string** | createdAt | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**eventId** | **number** | eventId | [default to undefined]
|
|
11
|
+
**message** | **string** | message | [default to undefined]
|
|
12
|
+
**type** | **number** | type | [default to undefined]
|
|
13
|
+
**createdAt** | **string** | createdAt | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -6,9 +6,9 @@ Service Event Update Request DTO
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**message** | **string** | Service Event Update Message | [
|
|
10
|
-
**type** | **number** | Service Event Update Type | [
|
|
11
|
-
**createdAt** | **string** | Date Time | [
|
|
9
|
+
**message** | **string** | Service Event Update Message | [default to undefined]
|
|
10
|
+
**type** | **number** | Service Event Update Type | [default to undefined]
|
|
11
|
+
**createdAt** | **string** | Date Time | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
package/docs/ExpiringKeyDTO.md
CHANGED
|
@@ -6,11 +6,11 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**expiryDate** | **string** | Date Time | [
|
|
10
|
-
**licenceKey** | **string** | Licence Key | [
|
|
11
|
-
**edition** | **string** | Edition | [
|
|
12
|
-
**type** | **string** | Type | [
|
|
13
|
-
**partner** | [**PartnerDTO**](PartnerDTO.md) | | [
|
|
9
|
+
**expiryDate** | **string** | Date Time | [default to undefined]
|
|
10
|
+
**licenceKey** | **string** | Licence Key | [default to undefined]
|
|
11
|
+
**edition** | **string** | Edition | [default to undefined]
|
|
12
|
+
**type** | **string** | Type | [default to undefined]
|
|
13
|
+
**partner** | [**PartnerDTO**](PartnerDTO.md) | | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -6,8 +6,8 @@ Fraud Management
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**dailyLimit** | **number** | Daily call spend (£) | [
|
|
10
|
-
**weeklyLimit** | **number** | Monthly call spend (£) | [
|
|
9
|
+
**dailyLimit** | **number** | Daily call spend (£) | [default to 50]
|
|
10
|
+
**weeklyLimit** | **number** | Monthly call spend (£) | [default to 100]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -6,10 +6,10 @@ Freshdesk Company Tickets
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**results** | [**Array<TicketSummaryModel>**](TicketSummaryModel.md) | Results | [
|
|
10
|
-
**page** | **number** | Page | [
|
|
11
|
-
**perPage** | **number** | Per Page | [
|
|
12
|
-
**totalResults** | **number** | Total Results | [
|
|
9
|
+
**results** | [**Array<TicketSummaryModel>**](TicketSummaryModel.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
|
|
|
@@ -6,13 +6,13 @@ FreshdeskTicketsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**subject** | **string** | subject | [
|
|
11
|
-
**companyId** | **number** | companyId | [
|
|
12
|
-
**groupId** | **number** | groupId | [
|
|
13
|
-
**productId** | **number** | productId | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**subject** | **string** | subject | [default to undefined]
|
|
11
|
+
**companyId** | **number** | companyId | [default to undefined]
|
|
12
|
+
**groupId** | **number** | groupId | [default to undefined]
|
|
13
|
+
**productId** | **number** | productId | [default to undefined]
|
|
14
14
|
**statusId** | **number** | status | [optional] [default to undefined]
|
|
15
|
-
**lastUpdated** | **string** | lastUpdated | [
|
|
15
|
+
**lastUpdated** | **string** | lastUpdated | [default to undefined]
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
|
@@ -6,11 +6,11 @@ FtpAccountsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**username** | **string** | username | [
|
|
11
|
-
**password** | **string** | password | [
|
|
12
|
-
**home** | **string** | home | [
|
|
13
|
-
**host** | **string** | host | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**username** | **string** | username | [default to undefined]
|
|
11
|
+
**password** | **string** | password | [default to undefined]
|
|
12
|
+
**home** | **string** | home | [default to undefined]
|
|
13
|
+
**host** | **string** | host | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
package/docs/GenericFileModel.md
CHANGED
|
@@ -6,9 +6,9 @@ Generic File
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**content** | **string** | File Content | [
|
|
10
|
-
**name** | **string** | File Name | [
|
|
11
|
-
**type** | **string** | File Type | [
|
|
9
|
+
**content** | **string** | File Content | [default to undefined]
|
|
10
|
+
**name** | **string** | File Name | [default to undefined]
|
|
11
|
+
**type** | **string** | File Type | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
package/docs/GraphDTO.md
CHANGED
|
@@ -6,13 +6,13 @@ Graph
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**title** | **string** | Title | [
|
|
10
|
-
**xAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | X Axis | [
|
|
11
|
-
**yAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | Y Axis | [
|
|
12
|
-
**legend** | **Array<string>** | Legend | [
|
|
13
|
-
**series** | [**Array<SeriesDTO>**](SeriesDTO.md) | Series | [
|
|
9
|
+
**title** | **string** | Title | [default to undefined]
|
|
10
|
+
**xAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | X Axis | [default to undefined]
|
|
11
|
+
**yAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | Y Axis | [default to undefined]
|
|
12
|
+
**legend** | **Array<string>** | Legend | [default to undefined]
|
|
13
|
+
**series** | [**Array<SeriesDTO>**](SeriesDTO.md) | Series | [default to undefined]
|
|
14
14
|
**currency** | **string** | Currency | [optional] [default to undefined]
|
|
15
|
-
**locale** | **string** | Locale | [
|
|
15
|
+
**locale** | **string** | Locale | [default to undefined]
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
|
@@ -6,11 +6,11 @@ Change Response
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**instanceId** | **string** | ID | [
|
|
10
|
-
**type** | **string** | Type | [
|
|
11
|
-
**progress** | **number** | Progress | [
|
|
12
|
-
**status** | **string** | Status | [
|
|
13
|
-
**provider** | **number** | Hosting Provider | [
|
|
9
|
+
**instanceId** | **string** | ID | [default to undefined]
|
|
10
|
+
**type** | **string** | Type | [default to undefined]
|
|
11
|
+
**progress** | **number** | Progress | [default to undefined]
|
|
12
|
+
**status** | **string** | Status | [default to undefined]
|
|
13
|
+
**provider** | **number** | Hosting Provider | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
package/docs/HostingRegionDTO.md
CHANGED
|
@@ -6,9 +6,9 @@ Hosting Region
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**code** | **string** | Code | [
|
|
10
|
-
**country** | **string** | Country | [
|
|
11
|
-
**continent** | **string** | Continent | [
|
|
9
|
+
**code** | **string** | Code | [default to undefined]
|
|
10
|
+
**country** | **string** | Country | [default to undefined]
|
|
11
|
+
**continent** | **string** | Continent | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -10,12 +10,12 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**failoverIpAddress** | **string** | PBX Failover IP Address | [optional] [default to undefined]
|
|
11
11
|
**instanceId** | **string** | Instance ID | [optional] [default to undefined]
|
|
12
12
|
**project** | **string** | Project ID | [optional] [default to undefined]
|
|
13
|
-
**sshKey** | [**GenericFileModel**](GenericFileModel.md) | | [
|
|
13
|
+
**sshKey** | [**GenericFileModel**](GenericFileModel.md) | | [default to undefined]
|
|
14
14
|
**osPassword** | **string** | Root Password | [optional] [default to undefined]
|
|
15
|
-
**systemOwner** | [**TcxUsersEntity**](TcxUsersEntity.md) | | [
|
|
15
|
+
**systemOwner** | [**TcxUsersEntity**](TcxUsersEntity.md) | | [default to undefined]
|
|
16
16
|
**email** | **string** | Admin Email | [optional] [default to undefined]
|
|
17
17
|
**url** | **string** | 3CX Console URL | [optional] [default to undefined]
|
|
18
|
-
**backup** | [**RemoteStorageDTO**](RemoteStorageDTO.md) | | [
|
|
18
|
+
**backup** | [**RemoteStorageDTO**](RemoteStorageDTO.md) | | [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
|
@@ -6,11 +6,11 @@ InstanceFailoverIpsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**instanceId** | **string** | instanceId | [
|
|
10
|
-
**reservedIp** | **string** | reservedIp | [
|
|
11
|
-
**region** | **string** | region | [
|
|
12
|
-
**price** | **number** | price | [
|
|
13
|
-
**status** | **string** | status | [
|
|
9
|
+
**instanceId** | **string** | instanceId | [default to undefined]
|
|
10
|
+
**reservedIp** | **string** | reservedIp | [default to undefined]
|
|
11
|
+
**region** | **string** | region | [default to undefined]
|
|
12
|
+
**price** | **number** | price | [default to undefined]
|
|
13
|
+
**status** | **string** | status | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -6,10 +6,10 @@ InstanceDeletionScheduleEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**instanceId** | **string** | instanceId | [
|
|
11
|
-
**tcxId** | **number** | tcxId | [
|
|
12
|
-
**dateAdded** | **string** | dateAdded | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**instanceId** | **string** | instanceId | [default to undefined]
|
|
11
|
+
**tcxId** | **number** | tcxId | [default to undefined]
|
|
12
|
+
**dateAdded** | **string** | dateAdded | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
package/docs/InstanceEntity.md
CHANGED
|
@@ -6,27 +6,27 @@ InstancesEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**instanceId** | **string** | instanceId | [
|
|
11
|
-
**project** | **string** | project | [
|
|
12
|
-
**region** | **string** | region | [
|
|
13
|
-
**name** | **string** | name | [
|
|
14
|
-
**hostname** | **string** | hostname | [
|
|
15
|
-
**ipAddress** | **string** | ipAddress | [
|
|
16
|
-
**flavor** | **string** | flavor | [
|
|
17
|
-
**sshPassword** | **string** | sshPassword | [
|
|
18
|
-
**putty** | **string** | putty | [
|
|
19
|
-
**pkcs8** | **string** | pkcs8 | [
|
|
20
|
-
**recordingsPath** | **string** | recordingsPath | [
|
|
21
|
-
**additionalDisk** | **number** | additionalDisk | [
|
|
22
|
-
**ahsayUser** | **string** | ahsayUser | [
|
|
23
|
-
**ahsayPass** | **string** | ahsayPass | [
|
|
24
|
-
**ahsayKey** | **string** | ahsayKey | [
|
|
25
|
-
**scriptsStarted** | **string** | scriptsStarted | [
|
|
26
|
-
**scriptFinished** | **string** | scriptFinished | [
|
|
27
|
-
**creationDate** | **string** | creationDate | [
|
|
28
|
-
**status** | **string** | status | [
|
|
29
|
-
**autoFailover** | **number** | autoFailover | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**instanceId** | **string** | instanceId | [default to undefined]
|
|
11
|
+
**project** | **string** | project | [default to undefined]
|
|
12
|
+
**region** | **string** | region | [default to undefined]
|
|
13
|
+
**name** | **string** | name | [default to undefined]
|
|
14
|
+
**hostname** | **string** | hostname | [default to undefined]
|
|
15
|
+
**ipAddress** | **string** | ipAddress | [default to undefined]
|
|
16
|
+
**flavor** | **string** | flavor | [default to undefined]
|
|
17
|
+
**sshPassword** | **string** | sshPassword | [default to undefined]
|
|
18
|
+
**putty** | **string** | putty | [default to undefined]
|
|
19
|
+
**pkcs8** | **string** | pkcs8 | [default to undefined]
|
|
20
|
+
**recordingsPath** | **string** | recordingsPath | [default to undefined]
|
|
21
|
+
**additionalDisk** | **number** | additionalDisk | [default to undefined]
|
|
22
|
+
**ahsayUser** | **string** | ahsayUser | [default to undefined]
|
|
23
|
+
**ahsayPass** | **string** | ahsayPass | [default to undefined]
|
|
24
|
+
**ahsayKey** | **string** | ahsayKey | [default to undefined]
|
|
25
|
+
**scriptsStarted** | **string** | scriptsStarted | [default to undefined]
|
|
26
|
+
**scriptFinished** | **string** | scriptFinished | [default to undefined]
|
|
27
|
+
**creationDate** | **string** | creationDate | [default to undefined]
|
|
28
|
+
**status** | **string** | status | [default to undefined]
|
|
29
|
+
**autoFailover** | **number** | autoFailover | [default to undefined]
|
|
30
30
|
|
|
31
31
|
## Example
|
|
32
32
|
|
|
@@ -6,17 +6,17 @@ InstanceFailoverEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**creation** | **string** | creation | [
|
|
11
|
-
**instanceId** | **string** | instanceId | [
|
|
12
|
-
**failoverInstanceId** | **string** | failoverInstanceId | [
|
|
13
|
-
**platform** | **string** | platform | [
|
|
14
|
-
**name** | **string** | name | [
|
|
15
|
-
**ipAddress** | **string** | ipAddress | [
|
|
16
|
-
**flavor** | **string** | flavor | [
|
|
17
|
-
**image** | **string** | image | [
|
|
18
|
-
**status** | **string** | status | [
|
|
19
|
-
**failback** | **string** | failback | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**creation** | **string** | creation | [default to undefined]
|
|
11
|
+
**instanceId** | **string** | instanceId | [default to undefined]
|
|
12
|
+
**failoverInstanceId** | **string** | failoverInstanceId | [default to undefined]
|
|
13
|
+
**platform** | **string** | platform | [default to undefined]
|
|
14
|
+
**name** | **string** | name | [default to undefined]
|
|
15
|
+
**ipAddress** | **string** | ipAddress | [default to undefined]
|
|
16
|
+
**flavor** | **string** | flavor | [default to undefined]
|
|
17
|
+
**image** | **string** | image | [default to undefined]
|
|
18
|
+
**status** | **string** | status | [default to undefined]
|
|
19
|
+
**failback** | **string** | failback | [default to undefined]
|
|
20
20
|
|
|
21
21
|
## Example
|
|
22
22
|
|
|
@@ -6,9 +6,9 @@ InstanceMonitoringEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**instanceId** | **string** | instanceId | [
|
|
10
|
-
**port** | **number** | port | [
|
|
11
|
-
**lastConnected** | **string** | lastConnected | [
|
|
9
|
+
**instanceId** | **string** | instanceId | [default to undefined]
|
|
10
|
+
**port** | **number** | port | [default to undefined]
|
|
11
|
+
**lastConnected** | **string** | lastConnected | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -6,12 +6,12 @@ InstanceMonitoringLogEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**instanceId** | **string** | instanceId | [
|
|
11
|
-
**code** | **number** | code | [
|
|
12
|
-
**error** | **string** | error | [
|
|
13
|
-
**date** | **string** | date | [
|
|
14
|
-
**timestamp** | **string** | timestamp | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**instanceId** | **string** | instanceId | [default to undefined]
|
|
11
|
+
**code** | **number** | code | [default to undefined]
|
|
12
|
+
**error** | **string** | error | [default to undefined]
|
|
13
|
+
**date** | **string** | date | [default to undefined]
|
|
14
|
+
**timestamp** | **string** | timestamp | [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -6,12 +6,12 @@ InstanceScheduledTasksEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**instanceId** | **string** | instanceId | [
|
|
11
|
-
**task** | **string** | task | [
|
|
12
|
-
**value** | **string** | value | [
|
|
13
|
-
**time** | **string** | time | [
|
|
14
|
-
**status** | **number** | status | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**instanceId** | **string** | instanceId | [default to undefined]
|
|
11
|
+
**task** | **string** | task | [default to undefined]
|
|
12
|
+
**value** | **string** | value | [default to undefined]
|
|
13
|
+
**time** | **string** | time | [default to undefined]
|
|
14
|
+
**status** | **number** | status | [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -6,16 +6,16 @@ InstanceTcxDetailsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**instanceId** | **string** | instanceId | [
|
|
11
|
-
**version** | **string** | version | [
|
|
12
|
-
**maxSimCalls** | **number** | maxSimCalls | [
|
|
13
|
-
**fqdn** | **string** | fqdn | [
|
|
14
|
-
**productCode** | **string** | productCode | [
|
|
15
|
-
**resellerName** | **string** | resellerName | [
|
|
16
|
-
**licenseKey** | **string** | licenseKey | [
|
|
17
|
-
**adminEMail** | **string** | adminEMail | [
|
|
18
|
-
**expirationDate** | **string** | expirationDate | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**instanceId** | **string** | instanceId | [default to undefined]
|
|
11
|
+
**version** | **string** | version | [default to undefined]
|
|
12
|
+
**maxSimCalls** | **number** | maxSimCalls | [default to undefined]
|
|
13
|
+
**fqdn** | **string** | fqdn | [default to undefined]
|
|
14
|
+
**productCode** | **string** | productCode | [default to undefined]
|
|
15
|
+
**resellerName** | **string** | resellerName | [default to undefined]
|
|
16
|
+
**licenseKey** | **string** | licenseKey | [default to undefined]
|
|
17
|
+
**adminEMail** | **string** | adminEMail | [default to undefined]
|
|
18
|
+
**expirationDate** | **string** | expirationDate | [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
|
@@ -6,11 +6,11 @@ InstanceUserCredentialsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**instanceId** | **string** | instanceId | [
|
|
11
|
-
**username** | **string** | username | [
|
|
12
|
-
**password** | **string** | password | [
|
|
13
|
-
**creationDate** | **string** | creationDate | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**instanceId** | **string** | instanceId | [default to undefined]
|
|
11
|
+
**username** | **string** | username | [default to undefined]
|
|
12
|
+
**password** | **string** | password | [default to undefined]
|
|
13
|
+
**creationDate** | **string** | creationDate | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
package/docs/ItemDTO.md
CHANGED
|
@@ -6,8 +6,8 @@ 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
|
**id** | **number** | ID | [optional] [default to undefined]
|
|
12
12
|
**orderId** | **number** | Order ID | [optional] [default to undefined]
|
|
13
13
|
**title** | **string** | Title | [optional] [default to undefined]
|
|
@@ -6,13 +6,13 @@ ItemDiscountsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**itemId** | **number** | itemId | [
|
|
11
|
-
**priceList** | **string** | priceList | [
|
|
12
|
-
**discount** | **number** | discount | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**itemId** | **number** | itemId | [default to undefined]
|
|
11
|
+
**priceList** | **string** | priceList | [default to undefined]
|
|
12
|
+
**discount** | **number** | discount | [default to undefined]
|
|
13
13
|
**type** | **string** | type | [optional] [default to undefined]
|
|
14
|
-
**description** | **string** | description | [
|
|
15
|
-
**priority** | **number** | priority | [
|
|
14
|
+
**description** | **string** | description | [default to undefined]
|
|
15
|
+
**priority** | **number** | priority | [default to undefined]
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
package/docs/ItemEntity.md
CHANGED
|
@@ -6,27 +6,27 @@ ItemsEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**orderId** | **number** | orderId | [
|
|
11
|
-
**sku** | **string** | sku | [
|
|
12
|
-
**title** | **string** | title | [
|
|
13
|
-
**itemOptions** | **string** | itemOptions | [
|
|
14
|
-
**quantity** | **number** | quantity | [
|
|
15
|
-
**customOption** | **number** | customOption | [
|
|
16
|
-
**itemPrice** | **number** | itemPrice | [
|
|
17
|
-
**itemPriceGbp** | **number** | itemPriceGbp | [
|
|
18
|
-
**itemTax** | **number** | itemTax | [
|
|
19
|
-
**itemTaxGbp** | **number** | itemTaxGbp | [
|
|
20
|
-
**itemShipping** | **number** | itemShipping | [
|
|
21
|
-
**itemShippingGbp** | **number** | itemShippingGbp | [
|
|
22
|
-
**shippingTax** | **number** | shippingTax | [
|
|
23
|
-
**shippingTaxGbp** | **number** | shippingTaxGbp | [
|
|
24
|
-
**customerRefunded** | **number** | customerRefunded | [
|
|
25
|
-
**licenceKey** | **string** | licencekey | [
|
|
26
|
-
**addHosting** | **number** | addHosting | [
|
|
27
|
-
**licenceExpiryDate** | **string** | licenceExpiryDate | [
|
|
28
|
-
**processDate** | **string** | processDate | [
|
|
29
|
-
**promoItem** | **number** | promo | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**orderId** | **number** | orderId | [default to undefined]
|
|
11
|
+
**sku** | **string** | sku | [default to undefined]
|
|
12
|
+
**title** | **string** | title | [default to undefined]
|
|
13
|
+
**itemOptions** | **string** | itemOptions | [default to undefined]
|
|
14
|
+
**quantity** | **number** | quantity | [default to undefined]
|
|
15
|
+
**customOption** | **number** | customOption | [default to undefined]
|
|
16
|
+
**itemPrice** | **number** | itemPrice | [default to undefined]
|
|
17
|
+
**itemPriceGbp** | **number** | itemPriceGbp | [default to undefined]
|
|
18
|
+
**itemTax** | **number** | itemTax | [default to undefined]
|
|
19
|
+
**itemTaxGbp** | **number** | itemTaxGbp | [default to undefined]
|
|
20
|
+
**itemShipping** | **number** | itemShipping | [default to undefined]
|
|
21
|
+
**itemShippingGbp** | **number** | itemShippingGbp | [default to undefined]
|
|
22
|
+
**shippingTax** | **number** | shippingTax | [default to undefined]
|
|
23
|
+
**shippingTaxGbp** | **number** | shippingTaxGbp | [default to undefined]
|
|
24
|
+
**customerRefunded** | **number** | customerRefunded | [default to undefined]
|
|
25
|
+
**licenceKey** | **string** | licencekey | [default to undefined]
|
|
26
|
+
**addHosting** | **number** | addHosting | [default to undefined]
|
|
27
|
+
**licenceExpiryDate** | **string** | licenceExpiryDate | [default to undefined]
|
|
28
|
+
**processDate** | **string** | processDate | [default to undefined]
|
|
29
|
+
**promoItem** | **number** | promo | [default to undefined]
|
|
30
30
|
**tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
|
|
31
31
|
|
|
32
32
|
## Example
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# ItemResolutionRequestModel
|
|
2
|
+
|
|
3
|
+
RMA Item Status Request Model
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**resolution** | **number** | RMA Item Resolution | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ItemResolutionRequestModel } from 'yellowgrid-api-ts';
|
|
15
|
+
|
|
16
|
+
const instance: ItemResolutionRequestModel = {
|
|
17
|
+
resolution,
|
|
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)
|
|
@@ -6,8 +6,8 @@ LinkedOrdersEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**orderId** | **number** | orderId | [
|
|
10
|
-
**linkedOrderId** | **number** | linkedOrderId | [
|
|
9
|
+
**orderId** | **number** | orderId | [default to undefined]
|
|
10
|
+
**linkedOrderId** | **number** | linkedOrderId | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|