yellowgrid-api-ts 3.2.175-dev.0 → 3.2.175
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 +294 -292
- package/README.md +3 -1
- package/api.ts +87 -1
- package/base.ts +2 -2
- package/common.ts +1 -1
- package/config.json +3 -3
- package/configuration.ts +1 -1
- package/dist/api.d.ts +54 -1
- package/dist/api.js +76 -1
- 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/docs/AccountsApi.md +1 -1
- package/docs/BillingApi.md +1 -1
- package/docs/CRMApi.md +1 -1
- package/docs/Class3CXApi.md +49 -1
- package/docs/Class3CXInstallationWizardApi.md +1 -1
- package/docs/Class3CXInstallationsApi.md +1 -1
- package/docs/Class3CXIntegrationsApi.md +1 -1
- package/docs/Class3CXMultiTenantApi.md +1 -1
- package/docs/CreditStatusDTO.md +25 -0
- package/docs/MyPBXToolsApi.md +1 -1
- package/docs/NumberPortingApi.md +1 -1
- package/docs/OAuth20Api.md +1 -1
- package/docs/OrdersApi.md +1 -1
- package/docs/PricingApi.md +1 -1
- package/docs/ProductsApi.md +1 -1
- package/docs/ProspectDTO.md +4 -0
- package/docs/ProspectsApi.md +1 -1
- package/docs/ProvisioningApi.md +1 -1
- package/docs/SIPTrunksApi.md +1 -1
- package/docs/SMSApi.md +1 -1
- package/docs/ServicesApi.md +1 -1
- package/docs/ShippingApi.md +1 -1
- package/docs/StockManagementApi.md +1 -1
- package/docs/SystemApi.md +1 -1
- package/docs/TicketsApi.md +1 -1
- package/docs/WebhooksApi.md +1 -1
- package/getEnums.php +31 -31
- package/index.ts +1 -1
- package/package.json +1 -1
- package/dist/models/StatusEnum.d.ts +0 -18
- package/dist/models/StatusEnum.js +0 -20
- package/dist/src/apis/AccountsApi.d.ts +0 -258
- package/dist/src/apis/AccountsApi.js +0 -975
- package/dist/src/apis/CRMApi.d.ts +0 -26
- package/dist/src/apis/CRMApi.js +0 -122
- package/dist/src/apis/Class3CXApi.d.ts +0 -44
- package/dist/src/apis/Class3CXApi.js +0 -177
- package/dist/src/apis/Class3CXInstallationWizardApi.d.ts +0 -446
- package/dist/src/apis/Class3CXInstallationWizardApi.js +0 -1740
- package/dist/src/apis/Class3CXInstallationsApi.d.ts +0 -253
- package/dist/src/apis/Class3CXInstallationsApi.js +0 -806
- package/dist/src/apis/Class3CXIntegrationsApi.d.ts +0 -102
- package/dist/src/apis/Class3CXIntegrationsApi.js +0 -386
- package/dist/src/apis/Class3CXMultiTenantApi.d.ts +0 -122
- package/dist/src/apis/Class3CXMultiTenantApi.js +0 -431
- package/dist/src/apis/MyPBXToolsApi.d.ts +0 -32
- package/dist/src/apis/MyPBXToolsApi.js +0 -136
- package/dist/src/apis/OAuth20Api.d.ts +0 -185
- package/dist/src/apis/OAuth20Api.js +0 -507
- package/dist/src/apis/OrdersApi.d.ts +0 -154
- package/dist/src/apis/OrdersApi.js +0 -512
- package/dist/src/apis/PricingApi.d.ts +0 -154
- package/dist/src/apis/PricingApi.js +0 -308
- package/dist/src/apis/ProductsApi.d.ts +0 -135
- package/dist/src/apis/ProductsApi.js +0 -531
- package/dist/src/apis/ProvisioningApi.d.ts +0 -112
- package/dist/src/apis/ProvisioningApi.js +0 -427
- package/dist/src/apis/SIPTrunksApi.d.ts +0 -315
- package/dist/src/apis/SIPTrunksApi.js +0 -1197
- package/dist/src/apis/SMSApi.d.ts +0 -30
- package/dist/src/apis/SMSApi.js +0 -130
- package/dist/src/apis/ServicesApi.d.ts +0 -81
- package/dist/src/apis/ServicesApi.js +0 -386
- package/dist/src/apis/ShippingApi.d.ts +0 -45
- package/dist/src/apis/ShippingApi.js +0 -179
- package/dist/src/apis/StockManagementApi.d.ts +0 -345
- package/dist/src/apis/StockManagementApi.js +0 -1293
- package/dist/src/apis/SystemApi.d.ts +0 -37
- package/dist/src/apis/SystemApi.js +0 -146
- package/dist/src/apis/TicketsApi.d.ts +0 -79
- package/dist/src/apis/TicketsApi.js +0 -360
- package/dist/src/apis/WebhooksApi.d.ts +0 -56
- package/dist/src/apis/WebhooksApi.js +0 -189
- package/dist/src/apis/index.d.ts +0 -21
- package/dist/src/apis/index.js +0 -39
- package/dist/src/index.d.ts +0 -3
- package/dist/src/index.js +0 -21
- package/dist/src/models/AbstractOrderRequestDTO.d.ts +0 -71
- package/dist/src/models/AbstractOrderRequestDTO.js +0 -64
- package/dist/src/models/AccountContactEntity.d.ts +0 -104
- package/dist/src/models/AccountContactEntity.js +0 -73
- package/dist/src/models/AccountContactModel.d.ts +0 -104
- package/dist/src/models/AccountContactModel.js +0 -73
- package/dist/src/models/AccountContactRequestModel.d.ts +0 -80
- package/dist/src/models/AccountContactRequestModel.js +0 -65
- package/dist/src/models/AccountDetailedSummaryDTO.d.ts +0 -89
- package/dist/src/models/AccountDetailedSummaryDTO.js +0 -70
- package/dist/src/models/AccountRequestModel.d.ts +0 -128
- package/dist/src/models/AccountRequestModel.js +0 -81
- package/dist/src/models/AccountSummaryDTO.d.ts +0 -44
- package/dist/src/models/AccountSummaryDTO.js +0 -53
- package/dist/src/models/AccountsResponseModel.d.ts +0 -51
- package/dist/src/models/AccountsResponseModel.js +0 -56
- package/dist/src/models/AddressModel.d.ts +0 -110
- package/dist/src/models/AddressModel.js +0 -75
- package/dist/src/models/AddressRequestModel.d.ts +0 -50
- package/dist/src/models/AddressRequestModel.js +0 -55
- package/dist/src/models/AdminOrderRequestDTO.d.ts +0 -113
- package/dist/src/models/AdminOrderRequestDTO.js +0 -78
- package/dist/src/models/AdminUserModel.d.ts +0 -79
- package/dist/src/models/AdminUserModel.js +0 -72
- package/dist/src/models/AgentHoursGraphModel.d.ts +0 -51
- package/dist/src/models/AgentHoursGraphModel.js +0 -56
- package/dist/src/models/AgentHoursGraphMonthModel.d.ts +0 -38
- package/dist/src/models/AgentHoursGraphMonthModel.js +0 -51
- package/dist/src/models/ApiLogEntity.d.ts +0 -98
- package/dist/src/models/ApiLogEntity.js +0 -71
- package/dist/src/models/AreaCodeModel.d.ts +0 -38
- package/dist/src/models/AreaCodeModel.js +0 -51
- package/dist/src/models/AttachmentModel.d.ts +0 -56
- package/dist/src/models/AttachmentModel.js +0 -57
- package/dist/src/models/AttributeSetEnum.d.ts +0 -38
- package/dist/src/models/AttributeSetEnum.js +0 -51
- package/dist/src/models/AuditLogEntity.d.ts +0 -80
- package/dist/src/models/AuditLogEntity.js +0 -65
- package/dist/src/models/AuthCodeResponseModel.d.ts +0 -44
- package/dist/src/models/AuthCodeResponseModel.js +0 -53
- package/dist/src/models/BasicItemDTO.d.ts +0 -38
- package/dist/src/models/BasicItemDTO.js +0 -51
- package/dist/src/models/BasicProductDTO.d.ts +0 -38
- package/dist/src/models/BasicProductDTO.js +0 -51
- package/dist/src/models/BatchEntity.d.ts +0 -128
- package/dist/src/models/BatchEntity.js +0 -81
- package/dist/src/models/CallBarringModel.d.ts +0 -56
- package/dist/src/models/CallBarringModel.js +0 -57
- package/dist/src/models/ClientDetailsModel.d.ts +0 -68
- package/dist/src/models/ClientDetailsModel.js +0 -61
- package/dist/src/models/ClientModel.d.ts +0 -50
- package/dist/src/models/ClientModel.js +0 -55
- package/dist/src/models/CompanyContractModel.d.ts +0 -56
- package/dist/src/models/CompanyContractModel.js +0 -57
- package/dist/src/models/ContactInfoModel.d.ts +0 -56
- package/dist/src/models/ContactInfoModel.js +0 -57
- package/dist/src/models/ConversationModel.d.ts +0 -75
- package/dist/src/models/ConversationModel.js +0 -64
- package/dist/src/models/CourierPriceEntity.d.ts +0 -86
- package/dist/src/models/CourierPriceEntity.js +0 -67
- package/dist/src/models/CreditAccountEntity.d.ts +0 -152
- package/dist/src/models/CreditAccountEntity.js +0 -89
- package/dist/src/models/CrmContactDTO.d.ts +0 -68
- package/dist/src/models/CrmContactDTO.js +0 -61
- package/dist/src/models/CustomerInformationModel.d.ts +0 -68
- package/dist/src/models/CustomerInformationModel.js +0 -61
- package/dist/src/models/CustomerItemRequestDTO.d.ts +0 -81
- package/dist/src/models/CustomerItemRequestDTO.js +0 -66
- package/dist/src/models/CustomerOrderRequestDTO.d.ts +0 -71
- package/dist/src/models/CustomerOrderRequestDTO.js +0 -64
- package/dist/src/models/CustomerPriceListEnum.d.ts +0 -38
- package/dist/src/models/CustomerPriceListEnum.js +0 -51
- package/dist/src/models/CustomerSummaryReportDTO.d.ts +0 -65
- package/dist/src/models/CustomerSummaryReportDTO.js +0 -62
- package/dist/src/models/DdiRangeRequestModel.d.ts +0 -44
- package/dist/src/models/DdiRangeRequestModel.js +0 -53
- package/dist/src/models/DdiRangesRequestModel.d.ts +0 -33
- package/dist/src/models/DdiRangesRequestModel.js +0 -50
- package/dist/src/models/DetailedItemRequestDTO.d.ts +0 -99
- package/dist/src/models/DetailedItemRequestDTO.js +0 -72
- package/dist/src/models/DetailedOrderRequestDTO.d.ts +0 -71
- package/dist/src/models/DetailedOrderRequestDTO.js +0 -64
- package/dist/src/models/DivertRequestModel.d.ts +0 -38
- package/dist/src/models/DivertRequestModel.js +0 -51
- package/dist/src/models/DivertResponseModel.d.ts +0 -52
- package/dist/src/models/DivertResponseModel.js +0 -61
- package/dist/src/models/EdTechProClientEntity.d.ts +0 -56
- package/dist/src/models/EdTechProClientEntity.js +0 -57
- package/dist/src/models/EdTechProSchoolModel.d.ts +0 -104
- package/dist/src/models/EdTechProSchoolModel.js +0 -73
- package/dist/src/models/EdTechProSchoolsModel.d.ts +0 -51
- package/dist/src/models/EdTechProSchoolsModel.js +0 -56
- package/dist/src/models/EdTechProSetupModel.d.ts +0 -56
- package/dist/src/models/EdTechProSetupModel.js +0 -57
- package/dist/src/models/EventDTO.d.ts +0 -84
- package/dist/src/models/EventDTO.js +0 -73
- package/dist/src/models/EventRequestDTO.d.ts +0 -44
- package/dist/src/models/EventRequestDTO.js +0 -53
- package/dist/src/models/EventSubscriptionModel.d.ts +0 -38
- package/dist/src/models/EventSubscriptionModel.js +0 -51
- package/dist/src/models/EventTypeEnum.d.ts +0 -19
- package/dist/src/models/EventTypeEnum.js +0 -24
- package/dist/src/models/EventUpdateDTO.d.ts +0 -50
- package/dist/src/models/EventUpdateDTO.js +0 -55
- package/dist/src/models/EventUpdateEntity.d.ts +0 -56
- package/dist/src/models/EventUpdateEntity.js +0 -57
- package/dist/src/models/EventUpdateRequestDTO.d.ts +0 -44
- package/dist/src/models/EventUpdateRequestDTO.js +0 -53
- package/dist/src/models/FraudManagementModel.d.ts +0 -38
- package/dist/src/models/FraudManagementModel.js +0 -51
- package/dist/src/models/FreshdeskCompanyTicketsModel.d.ts +0 -51
- package/dist/src/models/FreshdeskCompanyTicketsModel.js +0 -56
- package/dist/src/models/FreshdeskTicketEntity.d.ts +0 -68
- package/dist/src/models/FreshdeskTicketEntity.js +0 -61
- package/dist/src/models/FtpAccountsEntity.d.ts +0 -56
- package/dist/src/models/FtpAccountsEntity.js +0 -57
- package/dist/src/models/GenericFileModel.d.ts +0 -44
- package/dist/src/models/GenericFileModel.js +0 -53
- package/dist/src/models/GetGetPrice200Response.d.ts +0 -32
- package/dist/src/models/GetGetPrice200Response.js +0 -49
- package/dist/src/models/GetGetRecording200Response.d.ts +0 -32
- package/dist/src/models/GetGetRecording200Response.js +0 -49
- package/dist/src/models/HostingChangeResponseModel.d.ts +0 -64
- package/dist/src/models/HostingChangeResponseModel.js +0 -65
- package/dist/src/models/HostingRegionDTO.d.ts +0 -59
- package/dist/src/models/HostingRegionDTO.js +0 -68
- package/dist/src/models/InstanceAutoFailoverEntity.d.ts +0 -56
- package/dist/src/models/InstanceAutoFailoverEntity.js +0 -57
- package/dist/src/models/InstanceDeletionScheduleEntity.d.ts +0 -50
- package/dist/src/models/InstanceDeletionScheduleEntity.js +0 -55
- package/dist/src/models/InstanceEntity.d.ts +0 -152
- package/dist/src/models/InstanceEntity.js +0 -89
- package/dist/src/models/InstanceFailoverEntity.d.ts +0 -92
- package/dist/src/models/InstanceFailoverEntity.js +0 -69
- package/dist/src/models/InstanceMonitoringEntity.d.ts +0 -44
- package/dist/src/models/InstanceMonitoringEntity.js +0 -53
- package/dist/src/models/InstanceMonitoringLogEntity.d.ts +0 -62
- package/dist/src/models/InstanceMonitoringLogEntity.js +0 -59
- package/dist/src/models/InstanceScheduledTasksEntity.d.ts +0 -62
- package/dist/src/models/InstanceScheduledTasksEntity.js +0 -59
- package/dist/src/models/InstanceTcxDetailsEntity.d.ts +0 -86
- package/dist/src/models/InstanceTcxDetailsEntity.js +0 -67
- package/dist/src/models/InstanceUserCredentialsEntity.d.ts +0 -56
- package/dist/src/models/InstanceUserCredentialsEntity.js +0 -57
- package/dist/src/models/ItemDTO.d.ts +0 -117
- package/dist/src/models/ItemDTO.js +0 -78
- package/dist/src/models/ItemDiscountEntity.d.ts +0 -77
- package/dist/src/models/ItemDiscountEntity.js +0 -70
- package/dist/src/models/ItemEntity.d.ts +0 -158
- package/dist/src/models/ItemEntity.js +0 -91
- package/dist/src/models/LinkedOrderEntity.d.ts +0 -38
- package/dist/src/models/LinkedOrderEntity.js +0 -51
- package/dist/src/models/MFARequiredModel.d.ts +0 -38
- package/dist/src/models/MFARequiredModel.js +0 -51
- package/dist/src/models/MonthlyUsageModel.d.ts +0 -38
- package/dist/src/models/MonthlyUsageModel.js +0 -51
- package/dist/src/models/MultiTenantChangeResponseModel.d.ts +0 -70
- package/dist/src/models/MultiTenantChangeResponseModel.js +0 -75
- package/dist/src/models/NavigationModel.d.ts +0 -50
- package/dist/src/models/NavigationModel.js +0 -55
- package/dist/src/models/OfflineInstancesEntity.d.ts +0 -56
- package/dist/src/models/OfflineInstancesEntity.js +0 -57
- package/dist/src/models/OrderEntity.d.ts +0 -374
- package/dist/src/models/OrderEntity.js +0 -163
- package/dist/src/models/OrderRequestModel.d.ts +0 -120
- package/dist/src/models/OrderRequestModel.js +0 -88
- package/dist/src/models/OrderSummariesModel.d.ts +0 -51
- package/dist/src/models/OrderSummariesModel.js +0 -56
- package/dist/src/models/OrderSummaryDTO.d.ts +0 -126
- package/dist/src/models/OrderSummaryDTO.js +0 -83
- package/dist/src/models/OrderTotalModel.d.ts +0 -111
- package/dist/src/models/OrderTotalModel.js +0 -100
- package/dist/src/models/OrderedItemEntity.d.ts +0 -110
- package/dist/src/models/OrderedItemEntity.js +0 -75
- package/dist/src/models/PatchSetTcxWizardCnameRequest.d.ts +0 -32
- package/dist/src/models/PatchSetTcxWizardCnameRequest.js +0 -49
- package/dist/src/models/PatchUpdateAccountContactPasswordRequest.d.ts +0 -32
- package/dist/src/models/PatchUpdateAccountContactPasswordRequest.js +0 -49
- package/dist/src/models/PortalAccountModel.d.ts +0 -171
- package/dist/src/models/PortalAccountModel.js +0 -96
- package/dist/src/models/PortalLoginModel.d.ts +0 -68
- package/dist/src/models/PortalLoginModel.js +0 -61
- package/dist/src/models/PostAddWebhook200Response.d.ts +0 -32
- package/dist/src/models/PostAddWebhook200Response.js +0 -49
- package/dist/src/models/PostGetClientCredentialsRequest.d.ts +0 -32
- package/dist/src/models/PostGetClientCredentialsRequest.js +0 -49
- package/dist/src/models/PostGetProductForCustomerRequest.d.ts +0 -50
- package/dist/src/models/PostGetProductForCustomerRequest.js +0 -55
- package/dist/src/models/PostGetProductRequest.d.ts +0 -44
- package/dist/src/models/PostGetProductRequest.js +0 -53
- package/dist/src/models/PriceListItemModel.d.ts +0 -56
- package/dist/src/models/PriceListItemModel.js +0 -57
- package/dist/src/models/PrizesEntity.d.ts +0 -62
- package/dist/src/models/PrizesEntity.js +0 -59
- package/dist/src/models/ProductPriceListItemModel.d.ts +0 -62
- package/dist/src/models/ProductPriceListItemModel.js +0 -59
- package/dist/src/models/ProductSearchResultsModel.d.ts +0 -33
- package/dist/src/models/ProductSearchResultsModel.js +0 -50
- package/dist/src/models/ProductSerialInfoModel.d.ts +0 -50
- package/dist/src/models/ProductSerialInfoModel.js +0 -55
- package/dist/src/models/ProductSummaryDTO.d.ts +0 -81
- package/dist/src/models/ProductSummaryDTO.js +0 -66
- package/dist/src/models/PromoCodesEntity.d.ts +0 -98
- package/dist/src/models/PromoCodesEntity.js +0 -71
- package/dist/src/models/PromoItemsEntity.d.ts +0 -74
- package/dist/src/models/PromoItemsEntity.js +0 -63
- package/dist/src/models/ProvisioningModel.d.ts +0 -56
- package/dist/src/models/ProvisioningModel.js +0 -57
- package/dist/src/models/ProvisioningRequestEntity.d.ts +0 -44
- package/dist/src/models/ProvisioningRequestEntity.js +0 -53
- package/dist/src/models/RecordingBackupAzureModel.d.ts +0 -50
- package/dist/src/models/RecordingBackupAzureModel.js +0 -55
- package/dist/src/models/RecordingsBackupInfoDTO.d.ts +0 -40
- package/dist/src/models/RecordingsBackupInfoDTO.js +0 -53
- package/dist/src/models/ResourceNotReadyException.d.ts +0 -44
- package/dist/src/models/ResourceNotReadyException.js +0 -53
- package/dist/src/models/RootAccessModel.d.ts +0 -44
- package/dist/src/models/RootAccessModel.js +0 -53
- package/dist/src/models/S3BucketEntity.d.ts +0 -50
- package/dist/src/models/S3BucketEntity.js +0 -55
- package/dist/src/models/ScannedItemModel.d.ts +0 -56
- package/dist/src/models/ScannedItemModel.js +0 -57
- package/dist/src/models/ScopeModel.d.ts +0 -38
- package/dist/src/models/ScopeModel.js +0 -51
- package/dist/src/models/ServiceEnum.d.ts +0 -14
- package/dist/src/models/ServiceEnum.js +0 -19
- package/dist/src/models/ServiceHealthDTO.d.ts +0 -48
- package/dist/src/models/ServiceHealthDTO.js +0 -61
- package/dist/src/models/ServiceHealthEnum.d.ts +0 -19
- package/dist/src/models/ServiceHealthEnum.js +0 -24
- package/dist/src/models/ServiceStatusDTO.d.ts +0 -60
- package/dist/src/models/ServiceStatusDTO.js +0 -65
- package/dist/src/models/ServiceStatusEnum.d.ts +0 -19
- package/dist/src/models/ServiceStatusEnum.js +0 -24
- package/dist/src/models/ShipmentAddressEntity.d.ts +0 -92
- package/dist/src/models/ShipmentAddressEntity.js +0 -69
- package/dist/src/models/ShipmentEntity.d.ts +0 -98
- package/dist/src/models/ShipmentEntity.js +0 -71
- package/dist/src/models/ShipmentItemEntity.d.ts +0 -56
- package/dist/src/models/ShipmentItemEntity.js +0 -57
- package/dist/src/models/ShippingConsignmentModel.d.ts +0 -51
- package/dist/src/models/ShippingConsignmentModel.js +0 -56
- package/dist/src/models/ShippingInformationDTO.d.ts +0 -45
- package/dist/src/models/ShippingInformationDTO.js +0 -54
- package/dist/src/models/ShippingServiceDTO.d.ts +0 -47
- package/dist/src/models/ShippingServiceDTO.js +0 -60
- package/dist/src/models/ShippingServiceModel.d.ts +0 -71
- package/dist/src/models/ShippingServiceModel.js +0 -68
- package/dist/src/models/ShippingServicesModel.d.ts +0 -33
- package/dist/src/models/ShippingServicesModel.js +0 -50
- package/dist/src/models/SipTrunkChangeResponseModel.d.ts +0 -77
- package/dist/src/models/SipTrunkChangeResponseModel.js +0 -78
- package/dist/src/models/SipTrunkCreationRequestModel.d.ts +0 -66
- package/dist/src/models/SipTrunkCreationRequestModel.js +0 -63
- package/dist/src/models/SipTrunkEntity.d.ts +0 -98
- package/dist/src/models/SipTrunkEntity.js +0 -71
- package/dist/src/models/SipTrunksResponseModel.d.ts +0 -51
- package/dist/src/models/SipTrunksResponseModel.js +0 -56
- package/dist/src/models/SmsAccountEntity.d.ts +0 -68
- package/dist/src/models/SmsAccountEntity.js +0 -61
- package/dist/src/models/SmsDataModel.d.ts +0 -33
- package/dist/src/models/SmsDataModel.js +0 -50
- package/dist/src/models/SmsMessageModel.d.ts +0 -44
- package/dist/src/models/SmsMessageModel.js +0 -53
- package/dist/src/models/SmsNumbersEntity.d.ts +0 -38
- package/dist/src/models/SmsNumbersEntity.js +0 -51
- package/dist/src/models/SmsPayloadModel.d.ts +0 -45
- package/dist/src/models/SmsPayloadModel.js +0 -54
- package/dist/src/models/SmsPhoneNumberModel.d.ts +0 -53
- package/dist/src/models/SmsPhoneNumberModel.js +0 -66
- package/dist/src/models/SmsResponseModel.d.ts +0 -67
- package/dist/src/models/SmsResponseModel.js +0 -68
- package/dist/src/models/SmsWhitelistEntity.d.ts +0 -38
- package/dist/src/models/SmsWhitelistEntity.js +0 -51
- package/dist/src/models/StockOrderCourierEntity.d.ts +0 -50
- package/dist/src/models/StockOrderCourierEntity.js +0 -55
- package/dist/src/models/StockOrderDeductionModel.d.ts +0 -50
- package/dist/src/models/StockOrderDeductionModel.js +0 -55
- package/dist/src/models/StockOrderDeductionRequestModel.d.ts +0 -38
- package/dist/src/models/StockOrderDeductionRequestModel.js +0 -51
- package/dist/src/models/StockOrderDeductionsEntity.d.ts +0 -50
- package/dist/src/models/StockOrderDeductionsEntity.js +0 -55
- package/dist/src/models/StockOrderEntity.d.ts +0 -158
- package/dist/src/models/StockOrderEntity.js +0 -91
- package/dist/src/models/StockOrderItemEntity.d.ts +0 -68
- package/dist/src/models/StockOrderItemEntity.js +0 -61
- package/dist/src/models/StockOrderItemModel.d.ts +0 -80
- package/dist/src/models/StockOrderItemModel.js +0 -65
- package/dist/src/models/StockOrderItemRequestModel.d.ts +0 -50
- package/dist/src/models/StockOrderItemRequestModel.js +0 -55
- package/dist/src/models/StockOrderModel.d.ts +0 -137
- package/dist/src/models/StockOrderModel.js +0 -97
- package/dist/src/models/StockOrderProductEntity.d.ts +0 -62
- package/dist/src/models/StockOrderProductEntity.js +0 -59
- package/dist/src/models/StockOrderRequestModel.d.ts +0 -46
- package/dist/src/models/StockOrderRequestModel.js +0 -55
- package/dist/src/models/StockOrderSupplierEntity.d.ts +0 -80
- package/dist/src/models/StockOrderSupplierEntity.js +0 -65
- package/dist/src/models/StockOrderSupplierModel.d.ts +0 -80
- package/dist/src/models/StockOrderSupplierModel.js +0 -65
- package/dist/src/models/StockOrdersModel.d.ts +0 -51
- package/dist/src/models/StockOrdersModel.js +0 -56
- package/dist/src/models/StockProductModel.d.ts +0 -120
- package/dist/src/models/StockProductModel.js +0 -81
- package/dist/src/models/StockProductPriceModel.d.ts +0 -39
- package/dist/src/models/StockProductPriceModel.js +0 -52
- package/dist/src/models/StockProductSummariesModel.d.ts +0 -51
- package/dist/src/models/StockProductSummariesModel.js +0 -56
- package/dist/src/models/StockProductSummaryModel.d.ts +0 -69
- package/dist/src/models/StockProductSummaryModel.js +0 -62
- package/dist/src/models/StockTransactionsEntity.d.ts +0 -74
- package/dist/src/models/StockTransactionsEntity.js +0 -63
- package/dist/src/models/SupplierEntity.d.ts +0 -80
- package/dist/src/models/SupplierEntity.js +0 -65
- package/dist/src/models/SupplierItemEntity.d.ts +0 -74
- package/dist/src/models/SupplierItemEntity.js +0 -63
- package/dist/src/models/TcxBackupEntity.d.ts +0 -80
- package/dist/src/models/TcxBackupEntity.js +0 -65
- package/dist/src/models/TcxBackupModel.d.ts +0 -140
- package/dist/src/models/TcxBackupModel.js +0 -85
- package/dist/src/models/TcxBillingEntity.d.ts +0 -86
- package/dist/src/models/TcxBillingEntity.js +0 -67
- package/dist/src/models/TcxBulkLicenceDetailsModel.d.ts +0 -40
- package/dist/src/models/TcxBulkLicenceDetailsModel.js +0 -53
- package/dist/src/models/TcxDeadLicenceEntity.d.ts +0 -44
- package/dist/src/models/TcxDeadLicenceEntity.js +0 -53
- package/dist/src/models/TcxExtsEntity.d.ts +0 -74
- package/dist/src/models/TcxExtsEntity.js +0 -63
- package/dist/src/models/TcxHostingPricingEntity.d.ts +0 -74
- package/dist/src/models/TcxHostingPricingEntity.js +0 -63
- package/dist/src/models/TcxInstallationDetailsModel.d.ts +0 -106
- package/dist/src/models/TcxInstallationDetailsModel.js +0 -75
- package/dist/src/models/TcxInstallationModel.d.ts +0 -200
- package/dist/src/models/TcxInstallationModel.js +0 -105
- package/dist/src/models/TcxInstallationsModel.d.ts +0 -51
- package/dist/src/models/TcxInstallationsModel.js +0 -56
- package/dist/src/models/TcxKeySummaryDTO.d.ts +0 -56
- package/dist/src/models/TcxKeySummaryDTO.js +0 -57
- package/dist/src/models/TcxKeysEntity.d.ts +0 -62
- package/dist/src/models/TcxKeysEntity.js +0 -59
- package/dist/src/models/TcxLicenceDetailsErrorModel.d.ts +0 -50
- package/dist/src/models/TcxLicenceDetailsErrorModel.js +0 -55
- package/dist/src/models/TcxLicenceDetailsModel.d.ts +0 -92
- package/dist/src/models/TcxLicenceDetailsModel.js +0 -69
- package/dist/src/models/TcxMacsEntity.d.ts +0 -44
- package/dist/src/models/TcxMacsEntity.js +0 -53
- package/dist/src/models/TcxMultiTenantModel.d.ts +0 -118
- package/dist/src/models/TcxMultiTenantModel.js +0 -83
- package/dist/src/models/TcxMultiTenantUserModel.d.ts +0 -44
- package/dist/src/models/TcxMultiTenantUserModel.js +0 -53
- package/dist/src/models/TcxMultiTenantsModel.d.ts +0 -51
- package/dist/src/models/TcxMultiTenantsModel.js +0 -56
- package/dist/src/models/TcxNumbersEntity.d.ts +0 -44
- package/dist/src/models/TcxNumbersEntity.js +0 -53
- package/dist/src/models/TcxOfficeHoursEntity.d.ts +0 -116
- package/dist/src/models/TcxOfficeHoursEntity.js +0 -77
- package/dist/src/models/TcxPhoneModel.d.ts +0 -68
- package/dist/src/models/TcxPhoneModel.js +0 -61
- package/dist/src/models/TcxPhonesEntity.d.ts +0 -62
- package/dist/src/models/TcxPhonesEntity.js +0 -59
- package/dist/src/models/TcxRemoteStorageModel.d.ts +0 -50
- package/dist/src/models/TcxRemoteStorageModel.js +0 -55
- package/dist/src/models/TcxSbcDTO.d.ts +0 -62
- package/dist/src/models/TcxSbcDTO.js +0 -59
- package/dist/src/models/TcxSbcEntity.d.ts +0 -122
- package/dist/src/models/TcxSbcEntity.js +0 -79
- package/dist/src/models/TcxSbcModel.d.ts +0 -122
- package/dist/src/models/TcxSbcModel.js +0 -79
- package/dist/src/models/TcxSetupEntity.d.ts +0 -207
- package/dist/src/models/TcxSetupEntity.js +0 -123
- package/dist/src/models/TcxSetupsModel.d.ts +0 -51
- package/dist/src/models/TcxSetupsModel.js +0 -56
- package/dist/src/models/TcxSipTrunksEntity.d.ts +0 -104
- package/dist/src/models/TcxSipTrunksEntity.js +0 -73
- package/dist/src/models/TcxTemplateXmlEnum.d.ts +0 -38
- package/dist/src/models/TcxTemplateXmlEnum.js +0 -51
- package/dist/src/models/TcxUsersEntity.d.ts +0 -62
- package/dist/src/models/TcxUsersEntity.js +0 -59
- package/dist/src/models/TcxWizardConfigModel.d.ts +0 -39
- package/dist/src/models/TcxWizardConfigModel.js +0 -52
- package/dist/src/models/TcxWizardModel.d.ts +0 -150
- package/dist/src/models/TcxWizardModel.js +0 -114
- package/dist/src/models/TechSupportCompanySummaryDTO.d.ts +0 -57
- package/dist/src/models/TechSupportCompanySummaryDTO.js +0 -58
- package/dist/src/models/TelephonySupportTicketModel.d.ts +0 -94
- package/dist/src/models/TelephonySupportTicketModel.js +0 -71
- package/dist/src/models/TicketSummaryModel.d.ts +0 -74
- package/dist/src/models/TicketSummaryModel.js +0 -63
- package/dist/src/models/TicketTimeDTO.d.ts +0 -80
- package/dist/src/models/TicketTimeDTO.js +0 -65
- package/dist/src/models/TokenResponseModel.d.ts +0 -44
- package/dist/src/models/TokenResponseModel.js +0 -53
- package/dist/src/models/UpdateTypeEnum.d.ts +0 -19
- package/dist/src/models/UpdateTypeEnum.js +0 -24
- package/dist/src/models/UpgradeOrderResponseModel.d.ts +0 -38
- package/dist/src/models/UpgradeOrderResponseModel.js +0 -51
- package/dist/src/models/UpgradeRequestModel.d.ts +0 -66
- package/dist/src/models/UpgradeRequestModel.js +0 -70
- package/dist/src/models/UserEntity.d.ts +0 -98
- package/dist/src/models/UserEntity.js +0 -71
- package/dist/src/models/XeroLogEntity.d.ts +0 -86
- package/dist/src/models/XeroLogEntity.js +0 -67
- package/dist/src/models/index.d.ts +0 -196
- package/dist/src/models/index.js +0 -214
- package/dist/src/runtime.d.ts +0 -184
- package/dist/src/runtime.js +0 -564
package/api.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Yellowgrid
|
|
5
|
-
* Welcome to the Yellowgrid API documentation.
|
|
5
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://bitbucket.org` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 0
|
|
8
8
|
*
|
|
@@ -1666,6 +1666,23 @@ export interface CreditNoteModel {
|
|
|
1666
1666
|
*/
|
|
1667
1667
|
'items'?: Array<CreditNoteItemModel>;
|
|
1668
1668
|
}
|
|
1669
|
+
/**
|
|
1670
|
+
* 3CX Credit Status
|
|
1671
|
+
*/
|
|
1672
|
+
export interface CreditStatusDTO {
|
|
1673
|
+
/**
|
|
1674
|
+
* Currency Code
|
|
1675
|
+
*/
|
|
1676
|
+
'CurrencyCode'?: string | null;
|
|
1677
|
+
/**
|
|
1678
|
+
* Credit Limit
|
|
1679
|
+
*/
|
|
1680
|
+
'CreditLimit'?: number | null;
|
|
1681
|
+
/**
|
|
1682
|
+
* Credit
|
|
1683
|
+
*/
|
|
1684
|
+
'Credit'?: number | null;
|
|
1685
|
+
}
|
|
1669
1686
|
/**
|
|
1670
1687
|
* CRM Activities Response
|
|
1671
1688
|
*/
|
|
@@ -4936,6 +4953,14 @@ export interface ProspectDTO {
|
|
|
4936
4953
|
* Order Count
|
|
4937
4954
|
*/
|
|
4938
4955
|
'orderCount'?: number;
|
|
4956
|
+
/**
|
|
4957
|
+
* 3CX Order Count
|
|
4958
|
+
*/
|
|
4959
|
+
'tcxOrderCount'?: number;
|
|
4960
|
+
/**
|
|
4961
|
+
* Branded Video Count
|
|
4962
|
+
*/
|
|
4963
|
+
'videoCount'?: number;
|
|
4939
4964
|
}
|
|
4940
4965
|
|
|
4941
4966
|
export const ProspectDTOStatusEnum = {
|
|
@@ -12214,6 +12239,36 @@ export const Class3CXApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
12214
12239
|
options: localVarRequestOptions,
|
|
12215
12240
|
};
|
|
12216
12241
|
},
|
|
12242
|
+
/**
|
|
12243
|
+
* Get 3CX Credit Status
|
|
12244
|
+
* @summary Get 3CX Credit Status
|
|
12245
|
+
* @param {*} [options] Override http request option.
|
|
12246
|
+
* @throws {RequiredError}
|
|
12247
|
+
*/
|
|
12248
|
+
getGetTcxCreditStatus: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
12249
|
+
const localVarPath = `/tcx/admin/credit`;
|
|
12250
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
12251
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
12252
|
+
let baseOptions;
|
|
12253
|
+
if (configuration) {
|
|
12254
|
+
baseOptions = configuration.baseOptions;
|
|
12255
|
+
}
|
|
12256
|
+
|
|
12257
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
12258
|
+
const localVarHeaderParameter = {} as any;
|
|
12259
|
+
const localVarQueryParameter = {} as any;
|
|
12260
|
+
|
|
12261
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
12262
|
+
|
|
12263
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
12264
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
12265
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
12266
|
+
|
|
12267
|
+
return {
|
|
12268
|
+
url: toPathString(localVarUrlObj),
|
|
12269
|
+
options: localVarRequestOptions,
|
|
12270
|
+
};
|
|
12271
|
+
},
|
|
12217
12272
|
/**
|
|
12218
12273
|
* Get 3CX Expiring Keys
|
|
12219
12274
|
* @summary Get 3CX Expiring Keys
|
|
@@ -12299,6 +12354,18 @@ export const Class3CXApiFp = function(configuration?: Configuration) {
|
|
|
12299
12354
|
const localVarOperationServerBasePath = operationServerMap['Class3CXApi.getGetLicenceDetails']?.[localVarOperationServerIndex]?.url;
|
|
12300
12355
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12301
12356
|
},
|
|
12357
|
+
/**
|
|
12358
|
+
* Get 3CX Credit Status
|
|
12359
|
+
* @summary Get 3CX Credit Status
|
|
12360
|
+
* @param {*} [options] Override http request option.
|
|
12361
|
+
* @throws {RequiredError}
|
|
12362
|
+
*/
|
|
12363
|
+
async getGetTcxCreditStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreditStatusDTO>> {
|
|
12364
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getGetTcxCreditStatus(options);
|
|
12365
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
12366
|
+
const localVarOperationServerBasePath = operationServerMap['Class3CXApi.getGetTcxCreditStatus']?.[localVarOperationServerIndex]?.url;
|
|
12367
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
12368
|
+
},
|
|
12302
12369
|
/**
|
|
12303
12370
|
* Get 3CX Expiring Keys
|
|
12304
12371
|
* @summary Get 3CX Expiring Keys
|
|
@@ -12343,6 +12410,15 @@ export const Class3CXApiFactory = function (configuration?: Configuration, baseP
|
|
|
12343
12410
|
getGetLicenceDetails(key: string, options?: RawAxiosRequestConfig): AxiosPromise<TcxLicenceDetailsModel> {
|
|
12344
12411
|
return localVarFp.getGetLicenceDetails(key, options).then((request) => request(axios, basePath));
|
|
12345
12412
|
},
|
|
12413
|
+
/**
|
|
12414
|
+
* Get 3CX Credit Status
|
|
12415
|
+
* @summary Get 3CX Credit Status
|
|
12416
|
+
* @param {*} [options] Override http request option.
|
|
12417
|
+
* @throws {RequiredError}
|
|
12418
|
+
*/
|
|
12419
|
+
getGetTcxCreditStatus(options?: RawAxiosRequestConfig): AxiosPromise<CreditStatusDTO> {
|
|
12420
|
+
return localVarFp.getGetTcxCreditStatus(options).then((request) => request(axios, basePath));
|
|
12421
|
+
},
|
|
12346
12422
|
/**
|
|
12347
12423
|
* Get 3CX Expiring Keys
|
|
12348
12424
|
* @summary Get 3CX Expiring Keys
|
|
@@ -12380,6 +12456,16 @@ export class Class3CXApi extends BaseAPI {
|
|
|
12380
12456
|
return Class3CXApiFp(this.configuration).getGetLicenceDetails(key, options).then((request) => request(this.axios, this.basePath));
|
|
12381
12457
|
}
|
|
12382
12458
|
|
|
12459
|
+
/**
|
|
12460
|
+
* Get 3CX Credit Status
|
|
12461
|
+
* @summary Get 3CX Credit Status
|
|
12462
|
+
* @param {*} [options] Override http request option.
|
|
12463
|
+
* @throws {RequiredError}
|
|
12464
|
+
*/
|
|
12465
|
+
public getGetTcxCreditStatus(options?: RawAxiosRequestConfig) {
|
|
12466
|
+
return Class3CXApiFp(this.configuration).getGetTcxCreditStatus(options).then((request) => request(this.axios, this.basePath));
|
|
12467
|
+
}
|
|
12468
|
+
|
|
12383
12469
|
/**
|
|
12384
12470
|
* Get 3CX Expiring Keys
|
|
12385
12471
|
* @summary Get 3CX Expiring Keys
|
package/base.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Yellowgrid
|
|
5
|
-
* Welcome to the Yellowgrid API documentation.
|
|
5
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://bitbucket.org` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 0
|
|
8
8
|
*
|
|
@@ -19,7 +19,7 @@ import type { Configuration } from './configuration';
|
|
|
19
19
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
20
20
|
import globalAxios from 'axios';
|
|
21
21
|
|
|
22
|
-
export const BASE_PATH = "https://
|
|
22
|
+
export const BASE_PATH = "https://bitbucket.org".replace(/\/+$/, "");
|
|
23
23
|
|
|
24
24
|
export const COLLECTION_FORMATS = {
|
|
25
25
|
csv: ",",
|
package/common.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Yellowgrid
|
|
5
|
-
* Welcome to the Yellowgrid API documentation.
|
|
5
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://bitbucket.org` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 0
|
|
8
8
|
*
|
package/config.json
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
{
|
|
2
|
-
"npmName": "yellowgrid-api-ts"
|
|
3
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"npmName": "yellowgrid-api-ts"
|
|
3
|
+
}
|
package/configuration.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
2
|
/**
|
|
3
3
|
* Yellowgrid
|
|
4
|
-
* Welcome to the Yellowgrid API documentation.
|
|
4
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://bitbucket.org` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
5
5
|
*
|
|
6
6
|
* The version of the OpenAPI document: 0
|
|
7
7
|
*
|
package/dist/api.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Yellowgrid
|
|
3
|
-
* Welcome to the Yellowgrid API documentation.
|
|
3
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://bitbucket.org` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 0
|
|
6
6
|
*
|
|
@@ -1643,6 +1643,23 @@ export interface CreditNoteModel {
|
|
|
1643
1643
|
*/
|
|
1644
1644
|
'items'?: Array<CreditNoteItemModel>;
|
|
1645
1645
|
}
|
|
1646
|
+
/**
|
|
1647
|
+
* 3CX Credit Status
|
|
1648
|
+
*/
|
|
1649
|
+
export interface CreditStatusDTO {
|
|
1650
|
+
/**
|
|
1651
|
+
* Currency Code
|
|
1652
|
+
*/
|
|
1653
|
+
'CurrencyCode'?: string | null;
|
|
1654
|
+
/**
|
|
1655
|
+
* Credit Limit
|
|
1656
|
+
*/
|
|
1657
|
+
'CreditLimit'?: number | null;
|
|
1658
|
+
/**
|
|
1659
|
+
* Credit
|
|
1660
|
+
*/
|
|
1661
|
+
'Credit'?: number | null;
|
|
1662
|
+
}
|
|
1646
1663
|
/**
|
|
1647
1664
|
* CRM Activities Response
|
|
1648
1665
|
*/
|
|
@@ -4882,6 +4899,14 @@ export interface ProspectDTO {
|
|
|
4882
4899
|
* Order Count
|
|
4883
4900
|
*/
|
|
4884
4901
|
'orderCount'?: number;
|
|
4902
|
+
/**
|
|
4903
|
+
* 3CX Order Count
|
|
4904
|
+
*/
|
|
4905
|
+
'tcxOrderCount'?: number;
|
|
4906
|
+
/**
|
|
4907
|
+
* Branded Video Count
|
|
4908
|
+
*/
|
|
4909
|
+
'videoCount'?: number;
|
|
4885
4910
|
}
|
|
4886
4911
|
export declare const ProspectDTOStatusEnum: {
|
|
4887
4912
|
readonly NoCallBackSet: "No Call Back Set";
|
|
@@ -10188,6 +10213,13 @@ export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
10188
10213
|
* @throws {RequiredError}
|
|
10189
10214
|
*/
|
|
10190
10215
|
getGetLicenceDetails: (key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10216
|
+
/**
|
|
10217
|
+
* Get 3CX Credit Status
|
|
10218
|
+
* @summary Get 3CX Credit Status
|
|
10219
|
+
* @param {*} [options] Override http request option.
|
|
10220
|
+
* @throws {RequiredError}
|
|
10221
|
+
*/
|
|
10222
|
+
getGetTcxCreditStatus: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
10191
10223
|
/**
|
|
10192
10224
|
* Get 3CX Expiring Keys
|
|
10193
10225
|
* @summary Get 3CX Expiring Keys
|
|
@@ -10216,6 +10248,13 @@ export declare const Class3CXApiFp: (configuration?: Configuration) => {
|
|
|
10216
10248
|
* @throws {RequiredError}
|
|
10217
10249
|
*/
|
|
10218
10250
|
getGetLicenceDetails(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TcxLicenceDetailsModel>>;
|
|
10251
|
+
/**
|
|
10252
|
+
* Get 3CX Credit Status
|
|
10253
|
+
* @summary Get 3CX Credit Status
|
|
10254
|
+
* @param {*} [options] Override http request option.
|
|
10255
|
+
* @throws {RequiredError}
|
|
10256
|
+
*/
|
|
10257
|
+
getGetTcxCreditStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreditStatusDTO>>;
|
|
10219
10258
|
/**
|
|
10220
10259
|
* Get 3CX Expiring Keys
|
|
10221
10260
|
* @summary Get 3CX Expiring Keys
|
|
@@ -10244,6 +10283,13 @@ export declare const Class3CXApiFactory: (configuration?: Configuration, basePat
|
|
|
10244
10283
|
* @throws {RequiredError}
|
|
10245
10284
|
*/
|
|
10246
10285
|
getGetLicenceDetails(key: string, options?: RawAxiosRequestConfig): AxiosPromise<TcxLicenceDetailsModel>;
|
|
10286
|
+
/**
|
|
10287
|
+
* Get 3CX Credit Status
|
|
10288
|
+
* @summary Get 3CX Credit Status
|
|
10289
|
+
* @param {*} [options] Override http request option.
|
|
10290
|
+
* @throws {RequiredError}
|
|
10291
|
+
*/
|
|
10292
|
+
getGetTcxCreditStatus(options?: RawAxiosRequestConfig): AxiosPromise<CreditStatusDTO>;
|
|
10247
10293
|
/**
|
|
10248
10294
|
* Get 3CX Expiring Keys
|
|
10249
10295
|
* @summary Get 3CX Expiring Keys
|
|
@@ -10272,6 +10318,13 @@ export declare class Class3CXApi extends BaseAPI {
|
|
|
10272
10318
|
* @throws {RequiredError}
|
|
10273
10319
|
*/
|
|
10274
10320
|
getGetLicenceDetails(key: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TcxLicenceDetailsModel, any, {}>>;
|
|
10321
|
+
/**
|
|
10322
|
+
* Get 3CX Credit Status
|
|
10323
|
+
* @summary Get 3CX Credit Status
|
|
10324
|
+
* @param {*} [options] Override http request option.
|
|
10325
|
+
* @throws {RequiredError}
|
|
10326
|
+
*/
|
|
10327
|
+
getGetTcxCreditStatus(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreditStatusDTO, any, {}>>;
|
|
10275
10328
|
/**
|
|
10276
10329
|
* Get 3CX Expiring Keys
|
|
10277
10330
|
* @summary Get 3CX Expiring Keys
|
package/dist/api.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Yellowgrid
|
|
6
|
-
* Welcome to the Yellowgrid API documentation.
|
|
6
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://bitbucket.org` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 0
|
|
9
9
|
*
|
|
@@ -4760,6 +4760,40 @@ var Class3CXApiAxiosParamCreator = function (configuration) {
|
|
|
4760
4760
|
});
|
|
4761
4761
|
});
|
|
4762
4762
|
},
|
|
4763
|
+
/**
|
|
4764
|
+
* Get 3CX Credit Status
|
|
4765
|
+
* @summary Get 3CX Credit Status
|
|
4766
|
+
* @param {*} [options] Override http request option.
|
|
4767
|
+
* @throws {RequiredError}
|
|
4768
|
+
*/
|
|
4769
|
+
getGetTcxCreditStatus: function () {
|
|
4770
|
+
var args_1 = [];
|
|
4771
|
+
for (var _i = 0; _i < arguments.length; _i++) {
|
|
4772
|
+
args_1[_i] = arguments[_i];
|
|
4773
|
+
}
|
|
4774
|
+
return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
|
|
4775
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
4776
|
+
if (options === void 0) { options = {}; }
|
|
4777
|
+
return __generator(this, function (_a) {
|
|
4778
|
+
localVarPath = "/tcx/admin/credit";
|
|
4779
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
4780
|
+
if (configuration) {
|
|
4781
|
+
baseOptions = configuration.baseOptions;
|
|
4782
|
+
}
|
|
4783
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
4784
|
+
localVarHeaderParameter = {};
|
|
4785
|
+
localVarQueryParameter = {};
|
|
4786
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
4787
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
4788
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4789
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
4790
|
+
return [2 /*return*/, {
|
|
4791
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
4792
|
+
options: localVarRequestOptions,
|
|
4793
|
+
}];
|
|
4794
|
+
});
|
|
4795
|
+
});
|
|
4796
|
+
},
|
|
4763
4797
|
/**
|
|
4764
4798
|
* Get 3CX Expiring Keys
|
|
4765
4799
|
* @summary Get 3CX Expiring Keys
|
|
@@ -4863,6 +4897,28 @@ var Class3CXApiFp = function (configuration) {
|
|
|
4863
4897
|
});
|
|
4864
4898
|
});
|
|
4865
4899
|
},
|
|
4900
|
+
/**
|
|
4901
|
+
* Get 3CX Credit Status
|
|
4902
|
+
* @summary Get 3CX Credit Status
|
|
4903
|
+
* @param {*} [options] Override http request option.
|
|
4904
|
+
* @throws {RequiredError}
|
|
4905
|
+
*/
|
|
4906
|
+
getGetTcxCreditStatus: function (options) {
|
|
4907
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
4908
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
4909
|
+
var _a, _b, _c;
|
|
4910
|
+
return __generator(this, function (_d) {
|
|
4911
|
+
switch (_d.label) {
|
|
4912
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetTcxCreditStatus(options)];
|
|
4913
|
+
case 1:
|
|
4914
|
+
localVarAxiosArgs = _d.sent();
|
|
4915
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
4916
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['Class3CXApi.getGetTcxCreditStatus']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
4917
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
4918
|
+
}
|
|
4919
|
+
});
|
|
4920
|
+
});
|
|
4921
|
+
},
|
|
4866
4922
|
/**
|
|
4867
4923
|
* Get 3CX Expiring Keys
|
|
4868
4924
|
* @summary Get 3CX Expiring Keys
|
|
@@ -4927,6 +4983,15 @@ var Class3CXApiFactory = function (configuration, basePath, axios) {
|
|
|
4927
4983
|
getGetLicenceDetails: function (key, options) {
|
|
4928
4984
|
return localVarFp.getGetLicenceDetails(key, options).then(function (request) { return request(axios, basePath); });
|
|
4929
4985
|
},
|
|
4986
|
+
/**
|
|
4987
|
+
* Get 3CX Credit Status
|
|
4988
|
+
* @summary Get 3CX Credit Status
|
|
4989
|
+
* @param {*} [options] Override http request option.
|
|
4990
|
+
* @throws {RequiredError}
|
|
4991
|
+
*/
|
|
4992
|
+
getGetTcxCreditStatus: function (options) {
|
|
4993
|
+
return localVarFp.getGetTcxCreditStatus(options).then(function (request) { return request(axios, basePath); });
|
|
4994
|
+
},
|
|
4930
4995
|
/**
|
|
4931
4996
|
* Get 3CX Expiring Keys
|
|
4932
4997
|
* @summary Get 3CX Expiring Keys
|
|
@@ -4968,6 +5033,16 @@ var Class3CXApi = /** @class */ (function (_super) {
|
|
|
4968
5033
|
var _this = this;
|
|
4969
5034
|
return (0, exports.Class3CXApiFp)(this.configuration).getGetLicenceDetails(key, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
4970
5035
|
};
|
|
5036
|
+
/**
|
|
5037
|
+
* Get 3CX Credit Status
|
|
5038
|
+
* @summary Get 3CX Credit Status
|
|
5039
|
+
* @param {*} [options] Override http request option.
|
|
5040
|
+
* @throws {RequiredError}
|
|
5041
|
+
*/
|
|
5042
|
+
Class3CXApi.prototype.getGetTcxCreditStatus = function (options) {
|
|
5043
|
+
var _this = this;
|
|
5044
|
+
return (0, exports.Class3CXApiFp)(this.configuration).getGetTcxCreditStatus(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
5045
|
+
};
|
|
4971
5046
|
/**
|
|
4972
5047
|
* Get 3CX Expiring Keys
|
|
4973
5048
|
* @summary Get 3CX Expiring Keys
|
package/dist/base.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Yellowgrid
|
|
3
|
-
* Welcome to the Yellowgrid API documentation.
|
|
3
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://bitbucket.org` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 0
|
|
6
6
|
*
|
package/dist/base.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Yellowgrid
|
|
6
|
-
* Welcome to the Yellowgrid API documentation.
|
|
6
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://bitbucket.org` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 0
|
|
9
9
|
*
|
|
@@ -30,7 +30,7 @@ var __extends = (this && this.__extends) || (function () {
|
|
|
30
30
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
31
31
|
exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
|
|
32
32
|
var axios_1 = require("axios");
|
|
33
|
-
exports.BASE_PATH = "https://
|
|
33
|
+
exports.BASE_PATH = "https://bitbucket.org".replace(/\/+$/, "");
|
|
34
34
|
exports.COLLECTION_FORMATS = {
|
|
35
35
|
csv: ",",
|
|
36
36
|
ssv: " ",
|
package/dist/common.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Yellowgrid
|
|
3
|
-
* Welcome to the Yellowgrid API documentation.
|
|
3
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://bitbucket.org` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 0
|
|
6
6
|
*
|
package/dist/common.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Yellowgrid
|
|
6
|
-
* Welcome to the Yellowgrid API documentation.
|
|
6
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://bitbucket.org` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 0
|
|
9
9
|
*
|
package/dist/configuration.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Yellowgrid
|
|
3
|
-
* Welcome to the Yellowgrid API documentation.
|
|
3
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://bitbucket.org` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 0
|
|
6
6
|
*
|
package/dist/configuration.js
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* tslint:disable */
|
|
3
3
|
/**
|
|
4
4
|
* Yellowgrid
|
|
5
|
-
* Welcome to the Yellowgrid API documentation.
|
|
5
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://bitbucket.org` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 0
|
|
8
8
|
*
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Yellowgrid
|
|
3
|
-
* Welcome to the Yellowgrid API documentation.
|
|
3
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://bitbucket.org` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 0
|
|
6
6
|
*
|
package/dist/index.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* Yellowgrid
|
|
6
|
-
* Welcome to the Yellowgrid API documentation.
|
|
6
|
+
* Welcome to the Yellowgrid API documentation. This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services. ## Key Features: - **Accounts**: View and manage account details, contacts, client credentials, and verification. - **Provisioning**: Automate setup and configuration of devices and groups. - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration. - **Messaging**: Send SMS messages securely via the messaging gateway. - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup. ## Authentication: The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints. ## Base URL: `https://bitbucket.org` For questions or technical support, please contact support@yellowgrid.co.uk.
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 0
|
|
9
9
|
*
|
package/docs/AccountsApi.md
CHANGED
package/docs/BillingApi.md
CHANGED
package/docs/CRMApi.md
CHANGED
package/docs/Class3CXApi.md
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# Class3CXApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://
|
|
3
|
+
All URIs are relative to *https://bitbucket.org*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**getGetLicenceDetails**](#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details|
|
|
8
|
+
|[**getGetTcxCreditStatus**](#getgettcxcreditstatus) | **GET** /tcx/admin/credit | Get 3CX Credit Status|
|
|
8
9
|
|[**getGetTcxExpiringKeys**](#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring/csv | Get 3CX Expiring Keys|
|
|
9
10
|
|[**postGetBulkLicenceDetails**](#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details|
|
|
10
11
|
|
|
@@ -62,6 +63,53 @@ No authorization required
|
|
|
62
63
|
|
|
63
64
|
[[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)
|
|
64
65
|
|
|
66
|
+
# **getGetTcxCreditStatus**
|
|
67
|
+
> CreditStatusDTO getGetTcxCreditStatus()
|
|
68
|
+
|
|
69
|
+
Get 3CX Credit Status
|
|
70
|
+
|
|
71
|
+
### Example
|
|
72
|
+
|
|
73
|
+
```typescript
|
|
74
|
+
import {
|
|
75
|
+
Class3CXApi,
|
|
76
|
+
Configuration
|
|
77
|
+
} from 'yellowgrid-api-ts';
|
|
78
|
+
|
|
79
|
+
const configuration = new Configuration();
|
|
80
|
+
const apiInstance = new Class3CXApi(configuration);
|
|
81
|
+
|
|
82
|
+
const { status, data } = await apiInstance.getGetTcxCreditStatus();
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### Parameters
|
|
86
|
+
This endpoint does not have any parameters.
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
### Return type
|
|
90
|
+
|
|
91
|
+
**CreditStatusDTO**
|
|
92
|
+
|
|
93
|
+
### Authorization
|
|
94
|
+
|
|
95
|
+
No authorization required
|
|
96
|
+
|
|
97
|
+
### HTTP request headers
|
|
98
|
+
|
|
99
|
+
- **Content-Type**: Not defined
|
|
100
|
+
- **Accept**: application/json
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
### HTTP response details
|
|
104
|
+
| Status code | Description | Response headers |
|
|
105
|
+
|-------------|-------------|------------------|
|
|
106
|
+
|**200** | 3CX Expiring Key CSV | - |
|
|
107
|
+
|**400** | Bad Request | - |
|
|
108
|
+
|**401** | Unauthorised | - |
|
|
109
|
+
|**403** | Access Denied | - |
|
|
110
|
+
|
|
111
|
+
[[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)
|
|
112
|
+
|
|
65
113
|
# **getGetTcxExpiringKeys**
|
|
66
114
|
> string getGetTcxExpiringKeys()
|
|
67
115
|
|