yellowgrid-api-ts

v3.2.97

Published

2 days ago

OpenAPI client for yellowgrid-api-ts

0High
0Medium
0Low

yg-david

adamalbison

axios typescript openapi-client openapi-generator yellowgrid-api-ts

yellowgrid-api-ts@0

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

Node.js
Webpack
Browserify

Language level

ES5 - you must have a Promises/A+ library installed
ES6

Module system

CommonJS
ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install yellowgrid-api-ts@0 --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to https://bitbucket.org

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AccountsApi | deleteDeleteClientCredentials | DELETE /accounts/me/contacts/credentials/{id} | Delete client credentials AccountsApi | deleteUpdateAccountContact | DELETE /accounts/me/contacts/{email} | Delete Account Contact AccountsApi | getGetAccount | GET /accounts/me | Get Account AccountsApi | getGetAccountContacts | GET /accounts/me/contacts | Get Account Contacts AccountsApi | getGetAccountDetailedSummary | GET /accounts/{id}/summary | Get Account Detailed Summary AccountsApi | getGetAccounts | GET /accounts | Get Accounts AccountsApi | getGetClientCredentials | GET /accounts/me/contacts/credentials | Get user's client credentials AccountsApi | getGetCustomerKeys | GET /accounts/me/tcx/keys | Get 3CX Keys AccountsApi | getVerifyEmailAddress | GET /accounts/contacts/verify | Verify account email address AccountsApi | patchSetTcxWizardCname | PATCH /accounts/me/cname | AccountsApi | patchUpdateAccountContactPassword | PATCH /accounts/contacts/password | Update Account Password AccountsApi | postGetAccountContacts | POST /accounts/me/contacts | Add Account Contact AccountsApi | postGetAccounts | POST /accounts | Create a new customer account AccountsApi | postGetAdminAccount | POST /admin/me | Get Admin Account AccountsApi | postGetClientCredentials | POST /accounts/me/contacts/credentials | Create client credentials AccountsApi | postSendEmailVerificationEmail | POST /accounts/contacts/verify/{email} | Send email verification email AccountsApi | postSendPasswordReset | POST /accounts/contacts/password/reset | Send password reset email AccountsApi | postSubmitResellerApplication | POST /accounts/reseller | Submit reseller application AccountsApi | putUpdateAccountContact | PUT /accounts/me/contacts/{email} | Update Account Contact CRMApi | getSearchByPhone | GET /crm/contact/search | Class3CXApi | getGetLicenceDetails | GET /tcx/licences/details | Get 3CX Licence Details Class3CXApi | postGetBulkLicenceDetails | POST /tcx/licences/bulk/details | Get bulk 3CX Licence Details Class3CXInstallationWizardApi | deleteAddExtensions | DELETE /tcx/wizards/extensions | Delete 3CX Installation Wizard Extensions Class3CXInstallationWizardApi | deleteAddNumbers | DELETE /tcx/wizards/numbers | Delete 3CX Installation Wizard Numbers Class3CXInstallationWizardApi | deleteAddPhones | DELETE /tcx/wizards/phones | Delete 3CX Installation Wizard Phone Class3CXInstallationWizardApi | deleteAddSbcs | DELETE /tcx/wizards/sbcs | Delete 3CX Installation Wizard SBCs Class3CXInstallationWizardApi | deleteGetWizard | DELETE /tcx/wizards | Delete 3CX Installation Wizard Class3CXInstallationWizardApi | getAddPhones | GET /tcx/wizards/phones | Get phones on linked order and MAC addresses Class3CXInstallationWizardApi | getGetAreaCodesTcxWizard | GET /tcx/wizards/sip/trunks/area/codes | Get UK National Area Codes Class3CXInstallationWizardApi | getGetDdisTcxWizard | GET /tcx/wizards/sip/trunks/{id}/ddis | Get SIP Trunk DDIs Class3CXInstallationWizardApi | getGetHostingPrice | GET /tcx/wizards/price | Get Hosting Price Class3CXInstallationWizardApi | getGetHostingRegions | GET /tcx/wizards/regions | Get 3CX Hosting Regions Class3CXInstallationWizardApi | getGetInstallStatus | GET /tcx/wizard/build/status | Get 3CX Instance Install Status Class3CXInstallationWizardApi | getGetInstanceInstallStatus | GET /tcx/wizards/instances/build/status | Get 3CX Instance Install Status Class3CXInstallationWizardApi | getGetPbxIpAddress | GET /tcx/wizards/instances/ip | Get PBX IP Address Class3CXInstallationWizardApi | getGetSipTrunkTcxWizard | GET /tcx/wizards/sip/trunks/{id} | Get SIP Trunk Class3CXInstallationWizardApi | getGetSipTrunksTcxWizard | GET /tcx/wizards/sip/trunks | Get SIP Trunks Class3CXInstallationWizardApi | getGetWizard | GET /tcx/wizards | Get 3CX Installation Wizard Class3CXInstallationWizardApi | patchAddExtensions | PATCH /tcx/wizards/extensions | Update 3CX Installation Wizard Extensions Class3CXInstallationWizardApi | patchAddNumbers | PATCH /tcx/wizards/numbers | Update 3CX Installation Wizard Numbers Class3CXInstallationWizardApi | patchAddPhones | PATCH /tcx/wizards/phones | Update 3CX Installation Wizard Phones Class3CXInstallationWizardApi | patchAddSbcs | PATCH /tcx/wizards/sbcs | Update 3CX Installation Wizard SBCs Class3CXInstallationWizardApi | patchGetWizard | PATCH /tcx/wizards | Update 3CX Installation Wizard Class3CXInstallationWizardApi | postAddExtensions | POST /tcx/wizards/extensions | Add Extensions To 3CX Installation Wizard Class3CXInstallationWizardApi | postAddNumbers | POST /tcx/wizards/numbers | Add Numbers To 3CX Installation Wizard Class3CXInstallationWizardApi | postAddPhones | POST /tcx/wizards/phones | Add Phones To 3CX Installation Wizard Class3CXInstallationWizardApi | postAddSbcs | POST /tcx/wizards/sbcs | Add SBCs To 3CX Installation Wizard Class3CXInstallationWizardApi | postBuildInstance | POST /tcx/wizards/instances/build | Build Instance From 3CX Installation Wizard Class3CXInstallationWizardApi | postBuildInstanceFromWizard | POST /tcx/wizard/build | Start 3CX Installation Build Process Class3CXInstallationWizardApi | postCreateInstance | POST /tcx/wizards/instances/create | Create Instance From 3CX Installation Wizard Class3CXInstallationWizardApi | postCreateInstanceFromWizard | POST /tcx/wizard/create | Create Hosted Instance From 3CX Installation Wizard Config Class3CXInstallationWizardApi | postGetDdisTcxWizard | POST /tcx/wizards/sip/trunks/{id}/ddis | Add SIP Trunk DDIs Class3CXInstallationWizardApi | postGetRequestedDdisTcxWizard | POST /tcx/wizards/sip/trunks/changes/ddis | Get Requested DDIs Class3CXInstallationWizardApi | postGetSipTrunksTcxWizard | POST /tcx/wizards/sip/trunks | Create New SIP Trunk Class3CXInstallationWizardApi | postTrackChangeTcxWizard | POST /tcx/wizards/sip/trunks/changes/track | Track SIP Trunk Change Request Class3CXInstallationWizardApi | postUploadBackup | POST /tcx/wizards/backup | Class3CXInstallationsApi | getGetDetails | GET /tcx/installations/{wizard_id}/details | Get 3CX Installation Details Class3CXInstallationsApi | getGetInstallations | GET /tcx/installations | Get 3CX Installations Class3CXInstallationsApi | patchChangeInstanceOwner | PATCH /tcx/installations/{instance_id}/owner | Change instance owner Class3CXInstallationsApi | patchUpdateAutoFailover | PATCH /tcx/installations/{instance_id}/failover/auto | Update 3CX Instance Auto Failover Class3CXInstallationsApi | postAddDisk | POST /tcx/installations/{instance_id}/disk | Add additional disk on 3CX Instance Class3CXInstallationsApi | postCreateSshUser | POST /tcx/installations/{instance_id}/create/user/root | Create a root user Class3CXInstallationsApi | postDeleteInstance | POST /tcx/installations/{instance_id}/delete | Delete 3CX Instance Class3CXInstallationsApi | postExtendDisk | POST /tcx/installations/{instance_id}/disk/extend | Extend additional disk on 3CX Instance Class3CXInstallationsApi | postFailoverInstance | POST /tcx/installations/{instance_id}/failover | Failover 3CX Instance Class3CXInstallationsApi | postInstallTcxSbc | POST /tcx/installations/sbcs/{sbc_id}/install | Install 3CX SBC Class3CXInstallationsApi | postRebootInstance | POST /tcx/installations/{instance_id}/reboot | Reboot 3CX Instance Class3CXInstallationsApi | postResizeInstance | POST /tcx/installations/{instance_id}/resize | Resize 3CX Instance Class3CXInstallationsApi | postRestartServices | POST /tcx/installations/{instance_id}/services/restart | Restart 3CX Services Class3CXInstallationsApi | postScheduledReboot | POST /tcx/installations/{instance_id}/reboot/scheduled | Reboot Instance Class3CXInstallationsApi | postSuspendInstance | POST /tcx/installations/{instance_id}/suspend | Suspend 3CX Instance Class3CXInstallationsApi | postTestLoginCredentials | POST /tcx/installations/{instance_id}/tests/login | Test 3CX Login Credentials Class3CXInstallationsApi | postUnsuspendInstance | POST /tcx/installations/{instance_id}/unsuspend | Unsuspend 3CX Instance Class3CXInstallationsApi | postUpgradeDebian | POST /tcx/installations/{instance_id}/debian/upgrade | Install OS update on 3CX Instance Class3CXInstallationsApi | putGetDetails | PUT /tcx/installations/{wizard_id}/details | Update 3CX Installation Details Class3CXIntegrationsApi | getGetPrice | GET /tcx/integrations/edtechpro/prices | Class3CXIntegrationsApi | getGetSchools | GET /tcx/integrations/edtechpro/schools | Class3CXIntegrationsApi | getGetTrusts | GET /tcx/integrations/edtechpro/trusts | Class3CXIntegrationsApi | patchUpdateEtpOrderReference | PATCH /tcx/integrations/edtechpro/{clientId}/schools/{schoolId}/orderReference | Class3CXIntegrationsApi | postOrderEdTechPro | POST /tcx/integrations/edtechpro/orders | Class3CXIntegrationsApi | postUpgradeEdTechPro | POST /tcx/integrations/edtechpro/upgrades | Class3CXMultiTenantApi | deleteGetTenant | DELETE /tcx/mt/tenants/{reference} | Delete 3CX MT Tenant Class3CXMultiTenantApi | getGetAdminTenants | GET /tcx/mt/admin/tenants | Get 3CX MT Tenants Class3CXMultiTenantApi | getGetTenant | GET /tcx/mt/tenants/{reference} | Get 3CX MT Tenant Class3CXMultiTenantApi | getGetTenants | GET /tcx/mt/tenants | Get 3CX MT Tenants Class3CXMultiTenantApi | postAddMtDdi | POST /tcx/mt/ddis | Add 3CX MT DDI Class3CXMultiTenantApi | postGetMtNewDdis | POST /tcx/mt/changes/ddis | Get 3CX MT New DDIs Class3CXMultiTenantApi | postGetTenants | POST /tcx/mt/tenants | Add 3CX MT Tenant Class3CXMultiTenantApi | postTrackMtChange | POST /tcx/mt/changes/track | Track 3CX MT Change MyPBXToolsApi | getGetRecording | GET /mypbxtools/recordings | Fetch recording from a 3CX instance NumberPortingApi | deleteGetAdminNumberPort | DELETE /admin/sip/numbers/ports/{id} | NumberPortingApi | getCreateNumberPort | GET /sip/numbers/ports | NumberPortingApi | getGetAdminNumberPort | GET /admin/sip/numbers/ports/{id} | NumberPortingApi | getGetAdminNumberPorts | GET /admin/sip/numbers/ports | NumberPortingApi | getUpdateNumberPort | GET /sip/numbers/ports/{id} | NumberPortingApi | patchCancelAdminNumberPort | PATCH /admin/sip/numbers/ports/{id}/cancel | NumberPortingApi | patchCloseAdminNumberPort | PATCH /admin/sip/numbers/ports/{id}/close | NumberPortingApi | postAddAdminNote | POST /admin/sip/numbers/ports/{id}/notes | NumberPortingApi | postCreateNumberPort | POST /sip/numbers/ports | NumberPortingApi | postSubmitNumberPort | POST /sip/numbers/ports/{id}/submit | NumberPortingApi | postUpdateNumberPort | POST /sip/numbers/ports/{id} | NumberPortingApi | putGetAdminNumberPort | PUT /admin/sip/numbers/ports/{id} | OAuth20Api | getGetMfaQrCode | GET /oauth2/qr/code | Get MFA QR Code OAuth20Api | getGetScopes | GET /oauth2/scopes | Get Scopes OAuth20Api | postAccessToken | POST /oauth2/access_token | Validates client credentials and returns access token OAuth20Api | postAuthorise | POST /oauth2/authorise | Get OAuth2.0 Auth Code OAuth20Api | postGetIdentity | POST /oauth2/me | Get Token Identity OAuth20Api | postPortalLogin | POST /oauth2/portal/login | Portal Login OrdersApi | deleteDeleteBatch | DELETE /admin/orders/{id}/batches/{batch_id} | OrdersApi | deleteUpdateOrder | DELETE /orders/{id} | Delete Orders (Beta) OrdersApi | deleteUpdateShipment | DELETE /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Delete Shipment (Admin) OrdersApi | getGetAdminEditableOrder | GET /admin/orders/{id}/views/editable | Get Editable Order (Admin) OrdersApi | getGetAdminOrderDetails | GET /admin/orders/{id}/details | Get Order Details (Admin) OrdersApi | getGetCommercialInvoice | GET /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/pdf | Get Commercial Invoice PDF OrdersApi | getGetEditableOrder | GET /orders/{id}/views/editable | Get Editable Order (Beta) OrdersApi | getGetItemSerialInfo | GET /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin) OrdersApi | getGetOrderPdf | GET /orders/{id}/pdf | Download Order PDF OrdersApi | getGetOrderSummary | GET /admin/orders/{id}/summary | Get Order Summary (Admin) OrdersApi | getGetOrders | GET /orders | Get Orders (Beta) OrdersApi | patchCompleteOrder | PATCH /admin/orders/{id}/complete | Mark Order As Complete (Admin) OrdersApi | postAddOrderNote | POST /admin/orders/{id}/notes | Add Order Note OrdersApi | postCreateAdminOrder | POST /admin/orders | Create An Order (Admin) OrdersApi | postCreateConsignment | POST /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment OrdersApi | postCreateShipment | POST /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin) OrdersApi | postGetOrders | POST /orders | Create An Order (Beta) OrdersApi | postIssueCredit | POST /admin/orders/{id}/credit | Issue Credit (Admin) OrdersApi | postPrintShippingLabel | POST /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label OrdersApi | postProcessTcxLicences | POST /admin/orders/{id}/batches/{batch_id}/licences/process | Process 3CX Licences (Admin) OrdersApi | postSendOrderEmail | POST /admin/orders/{id}/email/send | Send Order Email OrdersApi | postSendShipmentEmail | POST /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/send/email | Send Shipment Email (Admin) OrdersApi | postSendSupplierEmail | POST /admin/orders/{id}/batches/{batch_id}/email/send | Send Supplier Email OrdersApi | postSplitOrder | POST /admin/orders/{id}/split | Split Order OrdersApi | putAllocateItems | PUT /admin/orders/{id}/items/allocate | Allocate Items To Supplier OrdersApi | putUpdateAdminOrder | PUT /admin/orders/{id} | Update An Order (Admin) OrdersApi | putUpdateBatchItem | PUT /admin/orders/{id}/batches/{batch_id}/items/{item_id} | Update Batch Item (Admin) OrdersApi | putUpdateOrder | PUT /orders/{id} | Update An Order (Beta) OrdersApi | putUpdatePaymentStatus | PUT /admin/orders/{id}/paid | Change Payment Status (Admin) OrdersApi | putUpdateShipment | PUT /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Update Shipment (Admin) PricingApi | getGetPriceList | GET /finance/pricing/lists | Get Price List PricingApi | postSendPriceList | POST /finance/pricing/lists/send | Send Price List ProductsApi | getGetAttributeSets | GET /products/attributes | Get Attribute Sets ProductsApi | getGetCustomerPriceLists | GET /products/prices/lists | Get Customer Price Lists ProductsApi | getGetLegacyStockList | GET /products/stock/legacy | Get Current Stock & Pricing ProductsApi | getGetProducts | GET /products | Get Products ProductsApi | getGetStockList | GET /products/stock | Get Current Stock & Pricing ProductsApi | getGetTcxTemplates | GET /products/attributes/tcx/templates | Get 3CX Templates ProductsApi | getSearchProducts | GET /products/search | Search Products ProductsApi | patchAddQuantityToStock | PATCH /products/{sku}/stock/add | Add Item Quantity To Stock ProductsApi | postGetProduct | POST /products/{sku} | Get Product ProductsApi | postGetProductForCustomer | POST /admin/products/{sku} | Get Product For Customer ProvisioningApi | deleteAddFanvilMac | DELETE /provisioning/fanvil/groups/{id}/macs/{mac} | Remove MAC address from DB and FDPS group ProvisioningApi | deleteDeleteFanvilGroup | DELETE /provisioning/fanvil/groups/{id} | Delete group from DB and FDPS ProvisioningApi | getGetFanvilEncryptionKey | GET /provisioning/fanvil/groups/{id}/macs/{mac}/key | Get group Fanvil encryption key ProvisioningApi | getGetFanvilGroupMacs | GET /provisioning/fanvil/groups/{id}/macs | Get MAC addresses on group at FDPS ProvisioningApi | getGetGroups | GET /provisioning/groups | Get all provisioning groups or filter by customer ID ProvisioningApi | postAddFanvilGroup | POST /provisioning/fanvil/groups | Add group to DB and FDPS ProvisioningApi | postAddFanvilMac | POST /provisioning/fanvil/groups/{id}/macs/{mac} | Add MAC address to DB and FDPS group SIPTrunksApi | deleteGetSipTrunk | DELETE /sip/trunks/{id} | Delete SIP Trunk SIPTrunksApi | getCanDivert | GET /sip/trunks/{id}/diverts/allowed | SIP Trunk Diverts Allowed SIPTrunksApi | getGetAddress | GET /sip/trunks/{id}/address | Get SIP Trunk Address SIPTrunksApi | getGetAdminSipTrunks | GET /sip/trunks/admin | SIPTrunksApi | getGetAreaCodes | GET /sip/trunks/area/codes | Get UK National Area Codes SIPTrunksApi | getGetCliFlexibility | GET /sip/trunks/{id}/cli/flexibility | Get SIP Trunk CLI Flexibility Status SIPTrunksApi | getGetDdis | GET /sip/trunks/{id}/ddis | Get SIP Trunk DDIs SIPTrunksApi | getGetDiverts | GET /sip/trunks/{id}/diverts | Get SIP Trunk Diverts SIPTrunksApi | getGetSipTrunk | GET /sip/trunks/{id} | Get SIP Trunk SIPTrunksApi | getGetSipTrunks | GET /sip/trunks | Get SIP Trunks SIPTrunksApi | patchGetCliFlexibility | PATCH /sip/trunks/{id}/cli/flexibility | Update Get SIP Trunk CLI Flexibility Status SIPTrunksApi | patchSetAsAvailable | PATCH /sip/trunks/{id}/available | Set a SIP trunk as 'AVAILABLE' for repurposing SIPTrunksApi | patchSetOwnership | PATCH /sip/trunks/{id}/owner | Change SIP Trunk Owner SIPTrunksApi | patchUpdateChannelCount | PATCH /sip/trunks/{id}/channels | Increase SIP Trunk Channels SIPTrunksApi | patchUpdateCompanyName | PATCH /sip/trunks/{id}/company | Update SIP Trunk Company Name SIPTrunksApi | patchUpdateMainTrunkNumber | PATCH /sip/trunks/{id}/number | Update SIP Trunk Main Trunk Number SIPTrunksApi | patchUpdatePbxIPAddress | PATCH /sip/trunks/{id}/pbx/ip | Update SIP Trunk PBX IP Address SIPTrunksApi | postGetDdis | POST /sip/trunks/{id}/ddis | Add SIP Trunk DDIs SIPTrunksApi | postGetRequestedDdis | POST /sip/trunks/changes/ddis | Get Requested DDIs SIPTrunksApi | postGetSipTrunks | POST /sip/trunks | Create New SIP Trunk SIPTrunksApi | postTrackChange | POST /sip/trunks/changes/track | Track SIP Trunk Change Request SIPTrunksApi | putGetAddress | PUT /sip/trunks/{id}/address | Update SIP Trunk Address SIPTrunksApi | putGetDiverts | PUT /sip/trunks/{id}/diverts | Update SIP Trunk Diverts SMSApi | postCreateSmsAccount | POST /messaging/sms/account | Create SMS Account SMSApi | postSendSms | POST /messaging/sms/send | ServicesApi | deleteUnsubscribe | DELETE /services/events/unsubscribe | ServicesApi | getGetServiceHealth | GET /services/health | ServicesApi | patchArchiveEvent | PATCH /services/events/{id}/archive | ServicesApi | patchUpdateEvent | PATCH /services/events/{id} | ServicesApi | postCreateEvent | POST /services/events | ServicesApi | postCreateEventUpdate | POST /services/events/{id}/updates | ServicesApi | postSubscribe | POST /services/events/subscribe | ShippingApi | postGetAdminShippingServices | POST /admin/shipping/services | Get Shipping Services ShippingApi | postGetShippingServices | POST /shipping/services | Get Shipping Services StockManagementApi | deleteDeleteStockOrder | DELETE /stock/orders/{id} | Delete Stock Order StockManagementApi | deleteDeleteStockOrderDeduction | DELETE /stock/orders/{order_id}/deductions/{deduction_id} | Delete Stock Order Deduction StockManagementApi | deleteDeleteStockOrderItem | DELETE /stock/orders/{order_id}/items/{item_id} | Delete Stock Order Item StockManagementApi | deleteGetStockProduct | DELETE /stock/products/{id} | Delete Stock Product StockManagementApi | getDeleteStockOrder | GET /stock/orders/{id} | Get Stock Order StockManagementApi | getGetProductDetails | GET /stock/products/{sku}/details | Get Product Details StockManagementApi | getGetStockOrderPurchaseOrder | GET /stock/orders/{id}/po | Get Stock Order Purchase Order StockManagementApi | getGetStockOrderSupplierEmail | GET /stock/orders/{id}/supplier/email | Get Stock Product Supplier Email mailto StockManagementApi | getGetStockOrders | GET /stock/orders | Get Stock Orders StockManagementApi | getGetStockProduct | GET /stock/products/{id} | Get Stock Product StockManagementApi | getGetStockProductSuppliers | GET /stock/suppliers | Get Stock Product Suppliers StockManagementApi | getGetStockProducts | GET /stock/products | Get Stock Products StockManagementApi | getGetStockSupplierProducts | GET /stock/suppliers/{id}/products | Get Stock Supplier's Products StockManagementApi | getUploadStockOrderInvoice | GET /stock/orders/{id}/invoice | Get Stock Order Supplier Invoice StockManagementApi | patchDeleteStockOrder | PATCH /stock/orders/{id} | Update Stock Order StockManagementApi | patchDeleteStockOrderDeduction | PATCH /stock/orders/{order_id}/deductions/{deduction_id} | Update Stock Order Deduction StockManagementApi | patchDeleteStockOrderItem | PATCH /stock/orders/{order_id}/items/{item_id} | Update Stock Order Item StockManagementApi | postAddStockOrderDeduction | POST /stock/orders/{id}/deductions | Add Stock Order Deductions StockManagementApi | postAddStockOrderItem | POST /stock/orders/{id}/items | Add Stock Order Items StockManagementApi | postGetStockOrders | POST /stock/orders | Create New Stock Order StockManagementApi | postGetStockProducts | POST /stock/products | Create Stock Product StockManagementApi | postUploadStockOrderInvoice | POST /stock/orders/{id}/invoice | Upload Stock Order Supplier Invoice StockManagementApi | putGetStockProduct | PUT /stock/products/{id} | Update Stock Product StockManagementApi | putReceiveStockOrderItem | PUT /stock/orders/{order_id}/items/{item_id}/receive | Receive Stock Order Item SystemApi | getLogSearch | GET /system/logs/api/search | Search for logs TicketsApi | getCreateTicket | GET /tickets/support | TicketsApi | getGetTicket | GET /tickets/support/{id} | TicketsApi | patchCloseTicket | PATCH /tickets/support/{id}/close | TicketsApi | postCreateTicket | POST /tickets/support | TicketsApi | postTicketReply | POST /tickets/support/{id}/reply | WebhooksApi | deleteRevokeWebhook | DELETE /webhooks/delete | Delete an authenticated webhook URL WebhooksApi | postAddWebhook | POST /webhooks/add | Create an authenticated webhook URL

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

oauth2

Type: OAuth
Flow: application
Authorization URL:
Scopes:
*****: All scopes (admin only)
fdps: Fanvil Redirection Server (FDPS)
scope: A Test Scope
portal: Yellowgrid Portal Endpoints
tcx_wizard: 3CX Installation Wizard
accounts.read: Accounts (Read)
accounts.write: Accounts (Write)
number_porting.read: Number Porting (Read)
number_porting.write: Number Porting (Write)
pricing.read: Pricing (Read)
orders.read: Orders (Read)
orders.write: Orders (Write)
products.read: Products (Read)
provisioning.read: Provisioning (Read)
provisioning.write: Provisioning (Write)
sms.read: Sms (Read)
sms.write: Sms (Write)
trunks.read: Trunks (Read)
trunks.write: Trunks (Write)
tcx_integrations.read: 3CX Integrations (Read)
tcx_integrations.write: 3CX Integrations (Write)
tcx_licence_details.read: 3CX Licence Details (Read)
tcx_installations.read: 3CX Installations (Read)
tcx_installations.write: 3CX Installations (Write)
tcx_mt.read: 3CX Multi-Tenant (Read)
tcx_mt.write: 3CX Multi-Tenant (Write)
tickets.read: Tickets (Read)
tickets.write: Tickets (Write)

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme