yellowgrid-api-ts 3.2.263 → 3.2.264-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 +418 -365
- package/.openapi-generator/VERSION +1 -1
- package/README.md +116 -3
- package/api.ts +9150 -3168
- package/base.ts +2 -2
- package/common.ts +3 -3
- package/config.json +4 -4
- package/configuration.ts +1 -1
- package/dist/api.d.ts +11794 -8215
- package/dist/api.js +14313 -9048
- package/dist/base.d.ts +1 -1
- package/dist/base.js +2 -2
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/AgentEnum.d.ts +48 -0
- package/dist/models/AgentEnum.js +50 -0
- package/dist/models/CategoryEnum.d.ts +108 -0
- package/dist/models/CategoryEnum.js +110 -0
- package/dist/models/ConnectionTypeEnum.d.ts +17 -7
- package/dist/models/ConnectionTypeEnum.js +17 -7
- package/dist/models/ReasonEnum.d.ts +18 -0
- package/dist/models/ReasonEnum.js +20 -0
- package/dist/models/ReportEnum.d.ts +11 -1
- package/dist/models/ReportEnum.js +11 -1
- package/dist/models/ResolutionEnum.d.ts +18 -0
- package/dist/models/ResolutionEnum.js +20 -0
- package/dist/models/RmaItemCreditTypeEnum.d.ts +13 -0
- package/dist/models/RmaItemCreditTypeEnum.js +15 -0
- package/dist/models/RmaItemResolutionEnum.d.ts +28 -0
- package/dist/models/RmaItemResolutionEnum.js +30 -0
- package/dist/models/RmaItemStatusEnum.d.ts +18 -0
- package/dist/models/RmaItemStatusEnum.js +20 -0
- package/dist/models/RmaStatusEnum.d.ts +33 -0
- package/dist/models/RmaStatusEnum.js +35 -0
- package/docs/AbstractOrderRequestDTO.md +4 -4
- package/docs/AccountAddressesDTO.md +3 -3
- package/docs/AccountContactEntity.md +13 -13
- package/docs/AccountContactModel.md +13 -13
- package/docs/AccountContactRequestModel.md +9 -9
- package/docs/AccountDetailedSummaryDTO.md +11 -9
- package/docs/AccountFinanceDTO.md +10 -10
- package/docs/AccountRequestModel.md +11 -11
- package/docs/AccountSummaryDTO.md +3 -3
- package/docs/AccountsApi.md +159 -1
- package/docs/AccountsResponseModel.md +4 -4
- package/docs/AddressDTO.md +12 -6
- package/docs/AddressModel.md +5 -5
- package/docs/AddressRequestModel.md +4 -4
- package/docs/AdminCustomerRmasModel.md +27 -0
- package/docs/AdminNumberPortDTO.md +7 -7
- package/docs/AdminOrderRequestDTO.md +4 -4
- package/docs/AdminRmaDTO.md +67 -0
- package/docs/AdminRmaItemDTO.md +51 -0
- package/docs/AdminRmaNoteDTO.md +27 -0
- package/docs/AdminRmaSummaryDTO.md +39 -0
- package/docs/AdminUserModel.md +7 -5
- package/docs/AgentHoursGraphModel.md +4 -4
- package/docs/AgentHoursGraphMonthModel.md +2 -2
- package/docs/ApiLogEntity.md +12 -12
- package/docs/AreaCodeModel.md +2 -2
- package/docs/AttachmentModel.md +5 -5
- package/docs/AttributeSetEnum.md +2 -2
- package/docs/AuditLogEntity.md +9 -9
- package/docs/AuthCodeResponseModel.md +1 -1
- package/docs/AxisDataDTO.md +1 -1
- package/docs/BasicItemDTO.md +2 -2
- package/docs/BasicProductDTO.md +2 -2
- package/docs/BatchDTO.md +17 -17
- package/docs/BatchEntity.md +17 -17
- package/docs/BillingApi.md +63 -5
- package/docs/BrandedVideoSummaryDTO.md +47 -0
- package/docs/BrandedVideosApi.md +424 -0
- package/docs/BrandedVideosSummariesModel.md +27 -0
- package/docs/CRMApi.md +60 -1
- package/docs/CallBarringModel.md +5 -5
- package/docs/CallJournalRequestModel.md +35 -0
- package/docs/Class3CXApi.md +49 -1
- package/docs/Class3CXInstallationWizardApi.md +385 -1
- package/docs/Class3CXInstallationsApi.md +1 -1
- package/docs/Class3CXIntegrationsApi.md +53 -1
- package/docs/Class3CXMultiTenantApi.md +1 -1
- package/docs/ClientDetailsModel.md +7 -7
- package/docs/ClientModel.md +4 -4
- package/docs/CollectionDateDTO.md +27 -0
- package/docs/CollectionDatesRequestDTO.md +23 -0
- package/docs/CompanyContractModel.md +5 -5
- package/docs/ContactInfoModel.md +5 -5
- package/docs/ConversationModel.md +8 -8
- package/docs/CourierPriceEntity.md +10 -10
- package/docs/CreditAccountEntity.md +25 -23
- package/docs/CreditNoteDTO.md +5 -1
- package/docs/CreditNoteEntity.md +5 -5
- package/docs/CreditNoteItemDTO.md +3 -1
- package/docs/CreditNoteItemEntity.md +7 -5
- package/docs/CreditNoteItemModel.md +7 -5
- package/docs/CreditNoteModel.md +5 -5
- package/docs/CrmActivitiesResponseDTO.md +2 -2
- package/docs/CrmActivityDTO.md +11 -3
- package/docs/CrmContactDTO.md +7 -7
- package/docs/CrmDateActivitiesDTO.md +1 -1
- package/docs/CrmNoteEntity.md +10 -10
- package/docs/CrmNoteModel.md +10 -10
- package/docs/CustomerCoordinatesDTO.md +5 -5
- package/docs/CustomerInformationModel.md +4 -4
- package/docs/CustomerItemRequestDTO.md +4 -2
- package/docs/CustomerListAccountDTO.md +13 -13
- package/docs/CustomerOrderRequestDTO.md +4 -4
- package/docs/CustomerPriceListEnum.md +2 -2
- package/docs/CustomerRmasModel.md +27 -0
- package/docs/CustomerSummaryReportDTO.md +6 -6
- package/docs/DdiRangeRequestModel.md +3 -3
- package/docs/DdiRangesRequestModel.md +1 -1
- package/docs/DetailedItemRequestDTO.md +4 -2
- package/docs/DetailedOrderRequestDTO.md +4 -4
- package/docs/DeviceModel.md +25 -0
- package/docs/DivertRequestModel.md +1 -1
- package/docs/DivertResponseModel.md +2 -2
- package/docs/EdTechProClientEntity.md +4 -4
- package/docs/EdTechProSchoolModel.md +11 -11
- package/docs/EdTechProSchoolsModel.md +4 -4
- package/docs/EdTechProSetupModel.md +5 -5
- package/docs/{PostSplitOrderRequest.md → EmailRequestModel.md} +6 -5
- package/docs/EngineeredWizardRequestModel.md +25 -0
- package/docs/EventDTO.md +8 -8
- package/docs/EventRequestDTO.md +3 -3
- package/docs/EventSubscriptionModel.md +2 -2
- package/docs/EventUpdateDTO.md +4 -4
- package/docs/EventUpdateEntity.md +5 -5
- package/docs/EventUpdateRequestDTO.md +3 -3
- package/docs/ExpiringKeyDTO.md +5 -5
- package/docs/FraudManagementModel.md +2 -2
- package/docs/FreshdeskCompanyTicketsModel.md +4 -4
- package/docs/FreshdeskTicketEntity.md +6 -6
- package/docs/FtpAccountsEntity.md +5 -5
- package/docs/GenericFileModel.md +3 -3
- package/docs/GetGetTcxHostingPriceList200Response.md +20 -0
- package/docs/GraphDTO.md +6 -6
- package/docs/HostingChangeResponseModel.md +5 -5
- package/docs/HostingRegionDTO.md +3 -3
- package/docs/InstallationDetailsDTO.md +3 -3
- package/docs/InstanceAutoFailoverEntity.md +5 -5
- package/docs/InstanceDeletionScheduleEntity.md +4 -4
- package/docs/InstanceEntity.md +21 -21
- package/docs/InstanceFailoverEntity.md +11 -11
- package/docs/InstanceMonitoringEntity.md +3 -3
- package/docs/InstanceMonitoringLogEntity.md +6 -6
- package/docs/InstanceScheduledTasksEntity.md +6 -6
- package/docs/InstanceTcxDetailsEntity.md +10 -10
- package/docs/InstanceUserCredentialsEntity.md +5 -5
- package/docs/ItemDTO.md +2 -2
- package/docs/ItemDiscountEntity.md +6 -6
- package/docs/ItemEntity.md +21 -21
- package/docs/ItemResolutionRequestModel.md +21 -0
- package/docs/LinkedOrderEntity.md +2 -2
- package/docs/MFARequiredModel.md +2 -2
- package/docs/MacAddressDTO.md +2 -2
- package/docs/MacAddressRequestModel.md +21 -0
- package/docs/MiscApi.md +1 -1
- package/docs/MonthlyUsageModel.md +2 -2
- package/docs/MultiTenantChangeResponseModel.md +4 -4
- package/docs/MyPBXToolsApi.md +1 -1
- package/docs/NameRequestModel.md +21 -0
- package/docs/NavigationModel.md +4 -4
- package/docs/NoteRequestModel.md +21 -0
- package/docs/NumberPortDTO.md +7 -7
- package/docs/NumberPortNoteDTO.md +5 -5
- package/docs/NumberPortRangeDTO.md +2 -2
- package/docs/NumberPortingApi.md +22 -22
- package/docs/NumberPortsModel.md +4 -4
- package/docs/OAuth20Api.md +5 -5
- package/docs/OfflineInstancesEntity.md +5 -5
- package/docs/OrderDTO.md +3 -3
- package/docs/OrderDetailsDTO.md +14 -10
- package/docs/OrderEntity.md +56 -56
- package/docs/OrderItemDTO.md +2 -2
- package/docs/OrderRequestModel.md +6 -6
- package/docs/OrderSummariesModel.md +4 -4
- package/docs/OrderSummaryDTO.md +12 -10
- package/docs/OrderTotalModel.md +7 -7
- package/docs/OrderedItemEntity.md +14 -14
- package/docs/OrderedItemModel.md +14 -14
- package/docs/OrdersApi.md +119 -6
- package/docs/PartnerDTO.md +12 -10
- package/docs/PasswordSenderDTO.md +2 -2
- package/docs/PasswordSenderEntity.md +7 -7
- package/docs/PatchApproveRmaRequest.md +20 -0
- package/docs/PortalAccountModel.md +25 -23
- package/docs/PortalLoginModel.md +7 -7
- package/docs/PostGenerateReport200Response.md +8 -8
- package/docs/PriceListItemModel.md +2 -2
- package/docs/PricingApi.md +5 -5
- package/docs/PrinterEntity.md +5 -5
- package/docs/PrizesEntity.md +6 -6
- package/docs/ProductDetailedSummaryDTO.md +2 -2
- package/docs/ProductPriceListItemModel.md +2 -2
- package/docs/{StockProductPriceModel.md → ProductPriceModel.md} +5 -5
- package/docs/ProductSearchResultsModel.md +1 -1
- package/docs/ProductSerialInfoDTO.md +27 -0
- package/docs/ProductSerialInfoModel.md +3 -3
- package/docs/ProductSummaryDTO.md +2 -2
- package/docs/ProductsApi.md +1 -1
- package/docs/PromoCodesEntity.md +13 -13
- package/docs/PromoItemModel.md +35 -0
- package/docs/PromoItemsEntity.md +8 -8
- package/docs/PromoModel.md +45 -0
- package/docs/PromoSummariesModel.md +27 -0
- package/docs/PromoSummaryDTO.md +31 -0
- package/docs/PromotionsApi.md +241 -0
- package/docs/ProspectDTO.md +7 -7
- package/docs/ProspectEntity.md +11 -11
- package/docs/ProspectsApi.md +1 -1
- package/docs/ProvisioningApi.md +1 -1
- package/docs/ProvisioningModel.md +3 -3
- package/docs/ProvisioningRequestEntity.md +3 -3
- package/docs/RMAApi.md +1753 -0
- package/docs/ReasonRequestModel.md +21 -0
- package/docs/RecordingBackupAzureModel.md +4 -4
- package/docs/RemoteStorageDTO.md +4 -4
- package/docs/ReportRequestDTO.md +1 -1
- package/docs/ReportsApi.md +1 -1
- package/docs/RequestDTO.md +29 -0
- package/docs/ResolutionRequestModel.md +21 -0
- package/docs/ResourceNotReadyException.md +3 -3
- package/docs/ResponseDTO.md +27 -0
- package/docs/RmaCollectionDTO.md +27 -0
- package/docs/RmaCreditItemRequestDTO.md +25 -0
- package/docs/RmaDTO.md +47 -0
- package/docs/RmaItemDTO.md +35 -0
- package/docs/RmaItemRequestDTO.md +25 -0
- package/docs/RmaOrderDTO.md +33 -0
- package/docs/RmaOrderItemDTO.md +37 -0
- package/docs/RmaOrderSummaryDTO.md +25 -0
- package/docs/RmaReplacementOrderItemDTO.md +23 -0
- package/docs/RmaReplacementOrderRequestDTO.md +21 -0
- package/docs/RmaRequestDTO.md +36 -0
- package/docs/RmaReturnDTO.md +31 -0
- package/docs/RmaSummaryDTO.md +31 -0
- package/docs/RmaSummaryItemDTO.md +23 -0
- package/docs/RootAccessModel.md +3 -3
- package/docs/S3BucketEntity.md +4 -4
- package/docs/SIPTrunksApi.md +1 -1
- package/docs/SMSApi.md +1 -1
- package/docs/ScannedItemModel.md +1 -1
- package/docs/ScopeModel.md +2 -2
- package/docs/SearchSchoolModel.md +35 -0
- package/docs/SerialNumberRequestModel.md +21 -0
- package/docs/SeriesDTO.md +3 -3
- package/docs/ServiceHealthDTO.md +2 -2
- package/docs/ServiceStatusDTO.md +4 -4
- package/docs/ServicesApi.md +1 -1
- package/docs/ShipmentAddressEntity.md +11 -11
- package/docs/ShipmentDTO.md +4 -4
- package/docs/ShipmentEntity.md +12 -12
- package/docs/ShipmentItemDTO.md +2 -2
- package/docs/ShipmentItemEntity.md +5 -5
- package/docs/ShipmentItemModel.md +5 -5
- package/docs/ShipmentModel.md +12 -12
- package/docs/ShipmentRequestDTO.md +4 -4
- package/docs/ShippingApi.md +57 -1
- package/docs/ShippingConsignmentModel.md +4 -4
- package/docs/ShippingInformationDTO.md +3 -3
- package/docs/ShippingRequestDTO.md +3 -3
- package/docs/ShippingServiceDTO.md +2 -2
- package/docs/ShippingServiceModel.md +4 -4
- package/docs/ShippingServicesModel.md +1 -1
- package/docs/SipTrunkChangeResponseModel.md +5 -5
- package/docs/SipTrunkCreationRequestModel.md +6 -6
- package/docs/SipTrunkEntity.md +12 -12
- package/docs/SipTrunksResponseModel.md +4 -4
- package/docs/SmsAccountDTO.md +6 -6
- package/docs/SmsAccountEntity.md +6 -6
- package/docs/SmsAccountRequestDTO.md +5 -5
- package/docs/SmsDataModel.md +1 -1
- package/docs/SmsMessageModel.md +3 -3
- package/docs/SmsNumbersEntity.md +2 -2
- package/docs/SmsPayloadModel.md +3 -3
- package/docs/SmsPhoneNumberModel.md +1 -1
- package/docs/SmsResponseModel.md +3 -3
- package/docs/SmsWhitelistEntity.md +2 -2
- package/docs/StockManagementApi.md +1 -1
- package/docs/StockOrderCourierEntity.md +4 -4
- package/docs/StockOrderDeductionModel.md +4 -4
- package/docs/StockOrderDeductionRequestModel.md +2 -2
- package/docs/StockOrderDeductionsEntity.md +4 -4
- package/docs/StockOrderEntity.md +22 -22
- package/docs/StockOrderItemEntity.md +7 -7
- package/docs/StockOrderItemModel.md +7 -7
- package/docs/StockOrderItemRequestModel.md +4 -4
- package/docs/StockOrderModel.md +14 -14
- package/docs/StockOrderProductEntity.md +6 -6
- package/docs/StockOrderRequestModel.md +3 -3
- package/docs/StockOrderSupplierEntity.md +9 -9
- package/docs/StockOrderSupplierModel.md +9 -9
- package/docs/StockOrdersModel.md +4 -4
- package/docs/StockProductModel.md +11 -9
- package/docs/StockProductSummariesModel.md +4 -4
- package/docs/StockProductSummaryModel.md +6 -6
- package/docs/StockReportItemModel.md +6 -6
- package/docs/StockReportModel.md +5 -5
- package/docs/StockTransactionsEntity.md +8 -8
- package/docs/SupplierEntity.md +9 -9
- package/docs/SupplierItemEntity.md +8 -8
- package/docs/SupplierItemModel.md +8 -8
- package/docs/SupplierItemsResultsDTO.md +1 -1
- package/docs/SupplierModel.md +9 -9
- package/docs/SupplierProductDTO.md +43 -0
- package/docs/SupplierProductModel.md +3 -3
- package/docs/SupplierProductResultsModel.md +4 -4
- package/docs/SuppliersApi.md +57 -1
- package/docs/SupportTicketModel.md +10 -10
- package/docs/SystemApi.md +1 -1
- package/docs/TableDTO.md +3 -3
- package/docs/TableDataDTO.md +1 -1
- package/docs/TableHistoryEntity.md +8 -8
- package/docs/TableRowDTO.md +1 -1
- package/docs/TcxBackupEntity.md +9 -9
- package/docs/TcxBackupModel.md +9 -9
- package/docs/TcxBillingEntity.md +10 -10
- package/docs/TcxBulkLicenceDetailsModel.md +2 -2
- package/docs/TcxDeadLicenceEntity.md +3 -3
- package/docs/TcxEngineerTaskDTO.md +29 -0
- package/docs/TcxEngineeringDTO.md +37 -0
- package/docs/TcxInstallationModel.md +17 -17
- package/docs/TcxInstallationsModel.md +4 -4
- package/docs/TcxKeySummaryDTO.md +3 -3
- package/docs/TcxKeysEntity.md +7 -7
- package/docs/TcxLicenceDetailsErrorModel.md +4 -4
- package/docs/TcxLicenceDetailsModel.md +11 -11
- package/docs/TcxMacsEntity.md +3 -3
- package/docs/TcxMultiTenantModel.md +7 -7
- package/docs/TcxMultiTenantUserModel.md +3 -3
- package/docs/TcxMultiTenantsModel.md +4 -4
- package/docs/TcxRemoteStorageModel.md +4 -4
- package/docs/TcxSbcDTO.md +7 -7
- package/docs/TcxSbcResponseDTO.md +2 -2
- package/docs/TcxSetupsModel.md +4 -4
- package/docs/TcxSummaryDTO.md +23 -0
- package/docs/TcxTemplateXmlEnum.md +2 -2
- package/docs/TcxUsersEntity.md +6 -6
- package/docs/TcxWizardConfigModel.md +2 -2
- package/docs/TcxWizardModel.md +2 -0
- package/docs/TechSupportCompanySummaryDTO.md +5 -5
- package/docs/ThumbnailDTO.md +25 -0
- package/docs/TicketSummaryModel.md +6 -6
- package/docs/TicketTimeDTO.md +9 -9
- package/docs/TicketsApi.md +11 -11
- package/docs/TokenResponseModel.md +3 -3
- package/docs/UpgradeOrderResponseModel.md +2 -2
- package/docs/UpgradeRequestModel.md +4 -4
- package/docs/UserEntity.md +10 -10
- package/docs/VideoRequestEntity.md +51 -0
- package/docs/WebhooksApi.md +1 -1
- package/docs/XeroLogEntity.md +10 -10
- package/getEnums.php +31 -31
- package/git_push.sh +14 -17
- package/index.ts +1 -1
- package/models/AgentEnum.ts +49 -0
- package/models/CategoryEnum.ts +109 -0
- package/models/ConnectionTypeEnum.ts +17 -7
- package/models/ReasonEnum.ts +19 -0
- package/models/ReportEnum.ts +11 -1
- package/models/ResolutionEnum.ts +19 -0
- package/models/RmaItemCreditTypeEnum.ts +14 -0
- package/models/RmaItemResolutionEnum.ts +29 -0
- package/models/RmaItemStatusEnum.ts +19 -0
- package/models/RmaStatusEnum.ts +34 -0
- package/openapitools.json +1 -1
- package/package.json +2 -2
|
@@ -12,14 +12,14 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**price** | **number** | Price Per User | [optional] [default to undefined]
|
|
13
13
|
**username** | **string** | Admin Username | [optional] [default to undefined]
|
|
14
14
|
**password** | **string** | Admin Password | [optional] [default to undefined]
|
|
15
|
-
**companyName** | **string** | Tenant Name | [
|
|
16
|
-
**address1** | **string** | Address Line 1 | [
|
|
17
|
-
**address2** | **string** | Address Line 2 | [
|
|
18
|
-
**city** | **string** | City | [
|
|
19
|
-
**postalCode** | **string** | Postal Code | [
|
|
15
|
+
**companyName** | **string** | Tenant Name | [default to undefined]
|
|
16
|
+
**address1** | **string** | Address Line 1 | [default to undefined]
|
|
17
|
+
**address2** | **string** | Address Line 2 | [default to undefined]
|
|
18
|
+
**city** | **string** | City | [default to undefined]
|
|
19
|
+
**postalCode** | **string** | Postal Code | [default to undefined]
|
|
20
20
|
**mainNumber** | **string** | Tenant Main Number | [optional] [default to undefined]
|
|
21
|
-
**numbers** | **Array<string>** | Tenant Numbers | [
|
|
22
|
-
**users** | [**Array<TcxMultiTenantUserModel>**](TcxMultiTenantUserModel.md) | Tenant Users | [
|
|
21
|
+
**numbers** | **Array<string>** | Tenant Numbers | [default to undefined]
|
|
22
|
+
**users** | [**Array<TcxMultiTenantUserModel>**](TcxMultiTenantUserModel.md) | Tenant Users | [default to undefined]
|
|
23
23
|
|
|
24
24
|
## Example
|
|
25
25
|
|
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**firstName** | **string** | User Name | [
|
|
10
|
-
**lastName** | **string** | User Surname | [
|
|
11
|
-
**email** | **string** | User Email Address | [
|
|
9
|
+
**firstName** | **string** | User Name | [default to undefined]
|
|
10
|
+
**lastName** | **string** | User Surname | [default to undefined]
|
|
11
|
+
**email** | **string** | User Email Address | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -6,10 +6,10 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**results** | [**Array<TcxMultiTenantModel>**](TcxMultiTenantModel.md) | Results | [
|
|
10
|
-
**page** | **number** | Page | [
|
|
11
|
-
**perPage** | **number** | Per Page | [
|
|
12
|
-
**totalResults** | **number** | Total Results | [
|
|
9
|
+
**results** | [**Array<TcxMultiTenantModel>**](TcxMultiTenantModel.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,10 +6,10 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**name** | **string** | name | [
|
|
10
|
-
**region** | **string** | region | [
|
|
11
|
-
**accessKeyId** | **string** | accessKeyId | [
|
|
12
|
-
**secretAccessKey** | **string** | secretAccessKey | [
|
|
9
|
+
**name** | **string** | name | [default to undefined]
|
|
10
|
+
**region** | **string** | region | [default to undefined]
|
|
11
|
+
**accessKeyId** | **string** | accessKeyId | [default to undefined]
|
|
12
|
+
**secretAccessKey** | **string** | secretAccessKey | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
package/docs/TcxSbcDTO.md
CHANGED
|
@@ -7,13 +7,13 @@ SBC Data
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**id** | **number** | ID | [optional] [default to undefined]
|
|
10
|
-
**ipAddress** | **string** | LAN IP Address | [
|
|
11
|
-
**defaultGateway** | **string** | LAN Default Gateway | [
|
|
12
|
-
**netmask** | **string** | LAN Subnet Mask | [
|
|
13
|
-
**dns** | **string** | DNS | [
|
|
14
|
-
**tcxUrl** | **string** | 3CX URL | [
|
|
15
|
-
**tcxKey** | **string** | 3CX SBC Key | [
|
|
16
|
-
**configured** | **boolean** | 3CX SBC Configured | [
|
|
10
|
+
**ipAddress** | **string** | LAN IP Address | [default to undefined]
|
|
11
|
+
**defaultGateway** | **string** | LAN Default Gateway | [default to undefined]
|
|
12
|
+
**netmask** | **string** | LAN Subnet Mask | [default to undefined]
|
|
13
|
+
**dns** | **string** | DNS | [default to undefined]
|
|
14
|
+
**tcxUrl** | **string** | 3CX URL | [default to undefined]
|
|
15
|
+
**tcxKey** | **string** | 3CX SBC Key | [default to undefined]
|
|
16
|
+
**configured** | **boolean** | 3CX SBC Configured | [default to undefined]
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**status** | **string** | Status | [
|
|
10
|
-
**message** | **string** | Message | [
|
|
9
|
+
**status** | **string** | Status | [default to undefined]
|
|
10
|
+
**message** | **string** | Message | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/TcxSetupsModel.md
CHANGED
|
@@ -6,10 +6,10 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**results** | [**Array<TcxSetupEntity>**](TcxSetupEntity.md) | Results | [
|
|
10
|
-
**page** | **number** | Page | [
|
|
11
|
-
**perPage** | **number** | Per Page | [
|
|
12
|
-
**totalResults** | **number** | Total Results | [
|
|
9
|
+
**results** | [**Array<TcxSetupEntity>**](TcxSetupEntity.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
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# TcxSummaryDTO
|
|
2
|
+
|
|
3
|
+
3CX Wizard Summary
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **number** | Wizard ID | [default to undefined]
|
|
10
|
+
**licenceKey** | **string** | Licence Key | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { TcxSummaryDTO } from 'yellowgrid-api-ts';
|
|
16
|
+
|
|
17
|
+
const instance: TcxSummaryDTO = {
|
|
18
|
+
id,
|
|
19
|
+
licenceKey,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[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 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | Attribute ID | [
|
|
10
|
-
**name** | **string** | Template Filename | [
|
|
9
|
+
**id** | **number** | Attribute ID | [default to undefined]
|
|
10
|
+
**name** | **string** | Template Filename | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/TcxUsersEntity.md
CHANGED
|
@@ -6,12 +6,12 @@ TcxUsersEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**instanceId** | **string** | instanceId | [
|
|
11
|
-
**extension** | **string** | extension | [
|
|
12
|
-
**username** | **string** | username | [
|
|
13
|
-
**password** | **string** | password | [
|
|
14
|
-
**secret** | **string** | secret | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**instanceId** | **string** | instanceId | [default to undefined]
|
|
11
|
+
**extension** | **string** | extension | [default to undefined]
|
|
12
|
+
**username** | **string** | username | [default to undefined]
|
|
13
|
+
**password** | **string** | password | [default to undefined]
|
|
14
|
+
**secret** | **string** | secret | [default to undefined]
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**logo** | [**GenericFileModel**](GenericFileModel.md) | | [
|
|
10
|
-
**hex** | **string** | Hex Colour | [
|
|
9
|
+
**logo** | [**GenericFileModel**](GenericFileModel.md) | | [default to undefined]
|
|
10
|
+
**hex** | **string** | Hex Colour | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/TcxWizardModel.md
CHANGED
|
@@ -18,6 +18,7 @@ Name | Type | Description | Notes
|
|
|
18
18
|
**sbcs** | [**Array<TcxSbcModel>**](TcxSbcModel.md) | | [optional] [default to undefined]
|
|
19
19
|
**sipTrunk** | [**TcxSipTrunksEntity**](TcxSipTrunksEntity.md) | | [optional] [default to undefined]
|
|
20
20
|
**installationStatus** | **string** | | [optional] [default to undefined]
|
|
21
|
+
**engineering** | [**TcxEngineeringDTO**](TcxEngineeringDTO.md) | | [optional] [default to undefined]
|
|
21
22
|
**setup** | [**TcxSetupEntity**](TcxSetupEntity.md) | | [optional] [default to undefined]
|
|
22
23
|
**endUserView** | **boolean** | End User Wizard View | [optional] [default to undefined]
|
|
23
24
|
|
|
@@ -39,6 +40,7 @@ const instance: TcxWizardModel = {
|
|
|
39
40
|
sbcs,
|
|
40
41
|
sipTrunk,
|
|
41
42
|
installationStatus,
|
|
43
|
+
engineering,
|
|
42
44
|
setup,
|
|
43
45
|
endUserView,
|
|
44
46
|
};
|
|
@@ -6,11 +6,11 @@ Tech Support Company Summary
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**companyId** | **number** | Company ID | [
|
|
10
|
-
**companyName** | **string** | Company Name | [
|
|
11
|
-
**contract** | [**CompanyContractModel**](CompanyContractModel.md) | | [
|
|
12
|
-
**reportUrl** | **string** | Report URL | [
|
|
13
|
-
**monthlyReportEmailAddress** | **string** | Monthly Report Email Address | [
|
|
9
|
+
**companyId** | **number** | Company ID | [default to undefined]
|
|
10
|
+
**companyName** | **string** | Company Name | [default to undefined]
|
|
11
|
+
**contract** | [**CompanyContractModel**](CompanyContractModel.md) | | [default to undefined]
|
|
12
|
+
**reportUrl** | **string** | Report URL | [default to undefined]
|
|
13
|
+
**monthlyReportEmailAddress** | **string** | Monthly Report Email Address | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# ThumbnailDTO
|
|
2
|
+
|
|
3
|
+
Thumbnail
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | ID | [default to undefined]
|
|
10
|
+
**name** | **string** | Name | [default to undefined]
|
|
11
|
+
**url** | **string** | URL | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ThumbnailDTO } from 'yellowgrid-api-ts';
|
|
17
|
+
|
|
18
|
+
const instance: ThumbnailDTO = {
|
|
19
|
+
id,
|
|
20
|
+
name,
|
|
21
|
+
url,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[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,13 +6,13 @@ Ticket Summary Model
|
|
|
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
|
**statusText** | **string** | Status Text | [optional] [default to undefined]
|
|
17
17
|
|
|
18
18
|
## Example
|
package/docs/TicketTimeDTO.md
CHANGED
|
@@ -5,15 +5,15 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**ticketId** | **number** | Ticket ID | [
|
|
9
|
-
**ticketUrl** | **string** | Ticket URL | [
|
|
10
|
-
**created** | **string** | Date Time | [
|
|
11
|
-
**contactName** | **string** | Contact Name | [
|
|
12
|
-
**agentName** | **string** | Agent Name | [
|
|
13
|
-
**status** | **string** | Status | [
|
|
14
|
-
**subject** | **string** | Ticket Subject | [
|
|
15
|
-
**supportBankTime** | **string** | Support Bank Time | [
|
|
16
|
-
**fixedPriceTime** | **string** | Fixed Price Time | [
|
|
8
|
+
**ticketId** | **number** | Ticket ID | [default to undefined]
|
|
9
|
+
**ticketUrl** | **string** | Ticket URL | [default to undefined]
|
|
10
|
+
**created** | **string** | Date Time | [default to undefined]
|
|
11
|
+
**contactName** | **string** | Contact Name | [default to undefined]
|
|
12
|
+
**agentName** | **string** | Agent Name | [default to undefined]
|
|
13
|
+
**status** | **string** | Status | [default to undefined]
|
|
14
|
+
**subject** | **string** | Ticket Subject | [default to undefined]
|
|
15
|
+
**supportBankTime** | **string** | Support Bank Time | [default to undefined]
|
|
16
|
+
**fixedPriceTime** | **string** | Fixed Price Time | [default to undefined]
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
package/docs/TicketsApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# TicketsApi
|
|
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
|
|------------- | ------------- | -------------|
|
|
@@ -194,9 +194,9 @@ import {
|
|
|
194
194
|
const configuration = new Configuration();
|
|
195
195
|
const apiInstance = new TicketsApi(configuration);
|
|
196
196
|
|
|
197
|
-
let subject: string; //Ticket Subject (
|
|
198
|
-
let message: string; //Ticket Message (
|
|
199
|
-
let attachments: Array<File>; //Attachments (up to 20MB combined) (
|
|
197
|
+
let subject: string; //Ticket Subject (default to undefined)
|
|
198
|
+
let message: string; //Ticket Message (default to undefined)
|
|
199
|
+
let attachments: Array<File>; //Attachments (up to 20MB combined) (default to undefined)
|
|
200
200
|
|
|
201
201
|
const { status, data } = await apiInstance.postCreateTicket(
|
|
202
202
|
subject,
|
|
@@ -209,9 +209,9 @@ const { status, data } = await apiInstance.postCreateTicket(
|
|
|
209
209
|
|
|
210
210
|
|Name | Type | Description | Notes|
|
|
211
211
|
|------------- | ------------- | ------------- | -------------|
|
|
212
|
-
| **subject** | [**string**] | Ticket Subject |
|
|
213
|
-
| **message** | [**string**] | Ticket Message |
|
|
214
|
-
| **attachments** | **Array<File>** | Attachments (up to 20MB combined) |
|
|
212
|
+
| **subject** | [**string**] | Ticket Subject | defaults to undefined|
|
|
213
|
+
| **message** | [**string**] | Ticket Message | defaults to undefined|
|
|
214
|
+
| **attachments** | **Array<File>** | Attachments (up to 20MB combined) | defaults to undefined|
|
|
215
215
|
|
|
216
216
|
|
|
217
217
|
### Return type
|
|
@@ -255,8 +255,8 @@ const configuration = new Configuration();
|
|
|
255
255
|
const apiInstance = new TicketsApi(configuration);
|
|
256
256
|
|
|
257
257
|
let id: number; //Ticket ID (default to undefined)
|
|
258
|
-
let body: string; //Reply Body (
|
|
259
|
-
let attachments: Array<File>; //Attachments (up to 20MB combined) (
|
|
258
|
+
let body: string; //Reply Body (default to undefined)
|
|
259
|
+
let attachments: Array<File>; //Attachments (up to 20MB combined) (default to undefined)
|
|
260
260
|
|
|
261
261
|
const { status, data } = await apiInstance.postTicketReply(
|
|
262
262
|
id,
|
|
@@ -270,8 +270,8 @@ const { status, data } = await apiInstance.postTicketReply(
|
|
|
270
270
|
|Name | Type | Description | Notes|
|
|
271
271
|
|------------- | ------------- | ------------- | -------------|
|
|
272
272
|
| **id** | [**number**] | Ticket ID | defaults to undefined|
|
|
273
|
-
| **body** | [**string**] | Reply Body |
|
|
274
|
-
| **attachments** | **Array<File>** | Attachments (up to 20MB combined) |
|
|
273
|
+
| **body** | [**string**] | Reply Body | defaults to undefined|
|
|
274
|
+
| **attachments** | **Array<File>** | Attachments (up to 20MB combined) | defaults to undefined|
|
|
275
275
|
|
|
276
276
|
|
|
277
277
|
### Return type
|
|
@@ -6,9 +6,9 @@ OAuth Token Response
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**token_type** | **string** | Access Token Type | [
|
|
10
|
-
**expires_in** | **number** | Seconds until expiry | [
|
|
11
|
-
**access_token** | **string** | Access Token | [
|
|
9
|
+
**token_type** | **string** | Access Token Type | [default to 'Bearer']
|
|
10
|
+
**expires_in** | **number** | Seconds until expiry | [default to undefined]
|
|
11
|
+
**access_token** | **string** | Access Token | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -6,8 +6,8 @@ EdTechPro Upgrade Response
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**message** | **string** | Response Message | [
|
|
10
|
-
**templateUrl** | **string** | Integration Template URL | [
|
|
9
|
+
**message** | **string** | Response Message | [default to undefined]
|
|
10
|
+
**templateUrl** | **string** | Integration Template URL | [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -6,10 +6,10 @@ EdTechPro Upgrade Request
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**clientId** | **number** | Client/Trust ID | [
|
|
10
|
-
**schoolId** | **number** | School Id | [
|
|
11
|
-
**licenceType** | **string** | Licence Type | [
|
|
12
|
-
**schoolType** | **string** | School Type | [
|
|
9
|
+
**clientId** | **number** | Client/Trust ID | [default to undefined]
|
|
10
|
+
**schoolId** | **number** | School Id | [default to undefined]
|
|
11
|
+
**licenceType** | **string** | Licence Type | [default to undefined]
|
|
12
|
+
**schoolType** | **string** | School Type | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
package/docs/UserEntity.md
CHANGED
|
@@ -6,16 +6,16 @@ UsersEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**realName** | **string** | realName | [
|
|
11
|
-
**extNo** | **number** | extNo | [
|
|
12
|
-
**username** | **string** | username | [
|
|
13
|
-
**password** | **string** | password | [
|
|
14
|
-
**email** | **string** | email | [
|
|
15
|
-
**mobile** | **string** | mobile | [
|
|
16
|
-
**level** | **number** | level | [
|
|
17
|
-
**active** | **number** | active | [
|
|
18
|
-
**image** | **string** | image | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**realName** | **string** | realName | [default to undefined]
|
|
11
|
+
**extNo** | **number** | extNo | [default to undefined]
|
|
12
|
+
**username** | **string** | username | [default to undefined]
|
|
13
|
+
**password** | **string** | password | [default to undefined]
|
|
14
|
+
**email** | **string** | email | [default to undefined]
|
|
15
|
+
**mobile** | **string** | mobile | [default to undefined]
|
|
16
|
+
**level** | **number** | level | [default to undefined]
|
|
17
|
+
**active** | **number** | active | [default to undefined]
|
|
18
|
+
**image** | **string** | image | [default to undefined]
|
|
19
19
|
**primaryHex** | **number** | primaryHex | [optional] [default to undefined]
|
|
20
20
|
**secondaryHex** | **number** | secondaryHex | [optional] [default to undefined]
|
|
21
21
|
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# VideoRequestEntity
|
|
2
|
+
|
|
3
|
+
VideoRequestsEntity
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**userId** | **number** | userId | [default to undefined]
|
|
11
|
+
**type** | **string** | type | [default to undefined]
|
|
12
|
+
**status** | **string** | status | [default to undefined]
|
|
13
|
+
**video** | **string** | video | [default to undefined]
|
|
14
|
+
**company** | **string** | company | [default to undefined]
|
|
15
|
+
**email** | **string** | email | [default to undefined]
|
|
16
|
+
**website** | **string** | website | [default to undefined]
|
|
17
|
+
**telephone** | **string** | telephone | [default to undefined]
|
|
18
|
+
**notes** | **string** | notes | [default to undefined]
|
|
19
|
+
**requestDate** | **string** | requestDate | [default to undefined]
|
|
20
|
+
**dueDate** | **string** | dueDate | [default to undefined]
|
|
21
|
+
**invId** | **string** | invId | [optional] [default to undefined]
|
|
22
|
+
**invNo** | **string** | invNo | [optional] [default to undefined]
|
|
23
|
+
**onedriveId** | **string** | onedriveId | [optional] [default to undefined]
|
|
24
|
+
**thumbnailId** | **string** | thumbnailId | [default to undefined]
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
import { VideoRequestEntity } from 'yellowgrid-api-ts';
|
|
30
|
+
|
|
31
|
+
const instance: VideoRequestEntity = {
|
|
32
|
+
id,
|
|
33
|
+
userId,
|
|
34
|
+
type,
|
|
35
|
+
status,
|
|
36
|
+
video,
|
|
37
|
+
company,
|
|
38
|
+
email,
|
|
39
|
+
website,
|
|
40
|
+
telephone,
|
|
41
|
+
notes,
|
|
42
|
+
requestDate,
|
|
43
|
+
dueDate,
|
|
44
|
+
invId,
|
|
45
|
+
invNo,
|
|
46
|
+
onedriveId,
|
|
47
|
+
thumbnailId,
|
|
48
|
+
};
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
[[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/WebhooksApi.md
CHANGED
package/docs/XeroLogEntity.md
CHANGED
|
@@ -6,16 +6,16 @@ XeroLogEntity
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **number** | id | [
|
|
10
|
-
**url** | **string** | url | [
|
|
11
|
-
**method** | **string** | method | [
|
|
12
|
-
**response** | **number** | response | [
|
|
13
|
-
**retry** | **number** | retry | [
|
|
14
|
-
**minuteLimit** | **number** | minuteLimit | [
|
|
15
|
-
**dayLimit** | **number** | dayLimit | [
|
|
16
|
-
**requester** | **number** | requester | [
|
|
17
|
-
**timestamp** | **string** | timestamp | [
|
|
18
|
-
**clientId** | **string** | clientId | [
|
|
9
|
+
**id** | **number** | id | [default to undefined]
|
|
10
|
+
**url** | **string** | url | [default to undefined]
|
|
11
|
+
**method** | **string** | method | [default to undefined]
|
|
12
|
+
**response** | **number** | response | [default to undefined]
|
|
13
|
+
**retry** | **number** | retry | [default to undefined]
|
|
14
|
+
**minuteLimit** | **number** | minuteLimit | [default to undefined]
|
|
15
|
+
**dayLimit** | **number** | dayLimit | [default to undefined]
|
|
16
|
+
**requester** | **number** | requester | [default to undefined]
|
|
17
|
+
**timestamp** | **string** | timestamp | [default to undefined]
|
|
18
|
+
**clientId** | **string** | clientId | [default to undefined]
|
|
19
19
|
|
|
20
20
|
## Example
|
|
21
21
|
|
package/getEnums.php
CHANGED
|
@@ -1,31 +1,31 @@
|
|
|
1
|
-
<?php
|
|
2
|
-
|
|
3
|
-
use App\Contracts\Enums\PublicEnumInterface;
|
|
4
|
-
|
|
5
|
-
require_once __DIR__."/../../../../vendor/autoload.php";
|
|
6
|
-
|
|
7
|
-
$dir = __DIR__."/models";
|
|
8
|
-
if (!is_dir($dir)) {
|
|
9
|
-
mkdir($dir);
|
|
10
|
-
}
|
|
11
|
-
foreach (\App\Enums\Router\PublicEnumEnum::cases() as $publicEnum) {
|
|
12
|
-
$ref = new ReflectionEnum($publicEnum->value);
|
|
13
|
-
$cases = [];
|
|
14
|
-
foreach ($ref->getCases() as $c) {
|
|
15
|
-
/** @var BackedEnum $enum */
|
|
16
|
-
$enum = $c->getEnum()->getName();
|
|
17
|
-
$value = $c->getBackingValue();
|
|
18
|
-
/** @var PublicEnumInterface $case */
|
|
19
|
-
$case = $enum::from($value);
|
|
20
|
-
$cases[$c->getName()] = [
|
|
21
|
-
"name" => $case->name,
|
|
22
|
-
"value" => $case->value,
|
|
23
|
-
"publicValue" => $case->getPublicValue()
|
|
24
|
-
];
|
|
25
|
-
}
|
|
26
|
-
$enumName = $ref->getShortName();
|
|
27
|
-
$enumString = json_encode($cases, JSON_PRETTY_PRINT);
|
|
28
|
-
$content = "export const $enumName = $enumString as const;".
|
|
29
|
-
"\n\n export type $enumName = typeof $enumName;";
|
|
30
|
-
file_put_contents("$dir/$enumName.ts", $content);
|
|
31
|
-
}
|
|
1
|
+
<?php
|
|
2
|
+
|
|
3
|
+
use App\Contracts\Enums\PublicEnumInterface;
|
|
4
|
+
|
|
5
|
+
require_once __DIR__."/../../../../vendor/autoload.php";
|
|
6
|
+
|
|
7
|
+
$dir = __DIR__."/models";
|
|
8
|
+
if (!is_dir($dir)) {
|
|
9
|
+
mkdir($dir);
|
|
10
|
+
}
|
|
11
|
+
foreach (\App\Enums\Router\PublicEnumEnum::cases() as $publicEnum) {
|
|
12
|
+
$ref = new ReflectionEnum($publicEnum->value);
|
|
13
|
+
$cases = [];
|
|
14
|
+
foreach ($ref->getCases() as $c) {
|
|
15
|
+
/** @var BackedEnum $enum */
|
|
16
|
+
$enum = $c->getEnum()->getName();
|
|
17
|
+
$value = $c->getBackingValue();
|
|
18
|
+
/** @var PublicEnumInterface $case */
|
|
19
|
+
$case = $enum::from($value);
|
|
20
|
+
$cases[$c->getName()] = [
|
|
21
|
+
"name" => $case->name,
|
|
22
|
+
"value" => $case->value,
|
|
23
|
+
"publicValue" => $case->getPublicValue()
|
|
24
|
+
];
|
|
25
|
+
}
|
|
26
|
+
$enumName = $ref->getShortName();
|
|
27
|
+
$enumString = json_encode($cases, JSON_PRETTY_PRINT);
|
|
28
|
+
$content = "export const $enumName = $enumString as const;".
|
|
29
|
+
"\n\n export type $enumName = typeof $enumName;";
|
|
30
|
+
file_put_contents("$dir/$enumName.ts", $content);
|
|
31
|
+
}
|
package/git_push.sh
CHANGED
|
@@ -8,24 +8,24 @@ git_repo_id=$2
|
|
|
8
8
|
release_note=$3
|
|
9
9
|
git_host=$4
|
|
10
10
|
|
|
11
|
-
if [ "$git_host"
|
|
11
|
+
if [ -z "${git_host}" ]; then
|
|
12
12
|
git_host="github.com"
|
|
13
|
-
echo "[INFO] No command line input provided. Set \$git_host to $git_host"
|
|
13
|
+
echo "[INFO] No command line input provided. Set \${git_host} to ${git_host}"
|
|
14
14
|
fi
|
|
15
15
|
|
|
16
|
-
if [ "$git_user_id"
|
|
16
|
+
if [ -z "${git_user_id}" ]; then
|
|
17
17
|
git_user_id="GIT_USER_ID"
|
|
18
|
-
echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
|
|
18
|
+
echo "[INFO] No command line input provided. Set \${git_user_id} to ${git_user_id}"
|
|
19
19
|
fi
|
|
20
20
|
|
|
21
|
-
if [ "$git_repo_id"
|
|
21
|
+
if [ -z "${git_repo_id}" ]; then
|
|
22
22
|
git_repo_id="GIT_REPO_ID"
|
|
23
|
-
echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
|
|
23
|
+
echo "[INFO] No command line input provided. Set \${git_repo_id} to ${git_repo_id}"
|
|
24
24
|
fi
|
|
25
25
|
|
|
26
|
-
if [ "$release_note"
|
|
26
|
+
if [ -z "${release_note}" ]; then
|
|
27
27
|
release_note="Minor update"
|
|
28
|
-
echo "[INFO] No command line input provided. Set \$release_note to $release_note"
|
|
28
|
+
echo "[INFO] No command line input provided. Set \${release_note} to ${release_note}"
|
|
29
29
|
fi
|
|
30
30
|
|
|
31
31
|
# Initialize the local directory as a Git repository
|
|
@@ -35,19 +35,16 @@ git init
|
|
|
35
35
|
git add .
|
|
36
36
|
|
|
37
37
|
# Commits the tracked changes and prepares them to be pushed to a remote repository.
|
|
38
|
-
git commit -m "$release_note"
|
|
38
|
+
git commit -m "${release_note}"
|
|
39
39
|
|
|
40
40
|
# Sets the new remote
|
|
41
|
-
|
|
42
|
-
if [ "$
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
|
|
46
|
-
git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
|
|
41
|
+
if [ -z "$(git remote)" ]; then # git remote not defined
|
|
42
|
+
if [ -z "${GIT_TOKEN:-}" ]; then
|
|
43
|
+
echo "[INFO] \${GIT_TOKEN} (environment variable) is not set. Using the git credential in your environment."
|
|
44
|
+
git remote add origin "https://${git_host}/${git_user_id}/${git_repo_id}.git"
|
|
47
45
|
else
|
|
48
|
-
git remote add origin https://${git_user_id}
|
|
46
|
+
git remote add origin "https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git"
|
|
49
47
|
fi
|
|
50
|
-
|
|
51
48
|
fi
|
|
52
49
|
|
|
53
50
|
git pull origin master
|