yellowgrid-api-ts 3.0.79

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.
Files changed (201) hide show
  1. package/.openapi-generator/FILES +189 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +385 -0
  5. package/api.ts +20310 -0
  6. package/base.ts +86 -0
  7. package/common.ts +150 -0
  8. package/config.json +3 -0
  9. package/configuration.ts +115 -0
  10. package/dist/api.d.ts +14136 -0
  11. package/dist/api.js +14123 -0
  12. package/dist/base.d.ts +66 -0
  13. package/dist/base.js +86 -0
  14. package/dist/common.d.ts +65 -0
  15. package/dist/common.js +253 -0
  16. package/dist/configuration.d.ts +91 -0
  17. package/dist/configuration.js +57 -0
  18. package/dist/index.d.ts +13 -0
  19. package/dist/index.js +31 -0
  20. package/docs/AccountContactEntity.md +45 -0
  21. package/docs/AccountContactModel.md +45 -0
  22. package/docs/AccountContactRequestModel.md +37 -0
  23. package/docs/AccountRequestModel.md +53 -0
  24. package/docs/AccountSummaryDTO.md +25 -0
  25. package/docs/AccountsApi.md +948 -0
  26. package/docs/AccountsResponseModel.md +27 -0
  27. package/docs/AddressModel.md +45 -0
  28. package/docs/AddressRequestModel.md +27 -0
  29. package/docs/AgentHoursGraphModel.md +27 -0
  30. package/docs/AgentHoursGraphMonthModel.md +23 -0
  31. package/docs/ApiLogEntity.md +43 -0
  32. package/docs/AreaCodeModel.md +23 -0
  33. package/docs/AttachmentModel.md +29 -0
  34. package/docs/AttributeSetEnum.md +23 -0
  35. package/docs/AuthCodeResponseModel.md +25 -0
  36. package/docs/BatchEntity.md +53 -0
  37. package/docs/CallBarringModel.md +29 -0
  38. package/docs/Class3CXApi.md +172 -0
  39. package/docs/Class3CXInstallationWizardApi.md +1355 -0
  40. package/docs/Class3CXInstallationsApi.md +651 -0
  41. package/docs/Class3CXIntegrationsApi.md +344 -0
  42. package/docs/Class3CXMultiTenantApi.md +404 -0
  43. package/docs/ClientDetailsModel.md +35 -0
  44. package/docs/ClientModel.md +27 -0
  45. package/docs/CompanyContractModel.md +29 -0
  46. package/docs/ContactInfoModel.md +29 -0
  47. package/docs/ConversationModel.md +35 -0
  48. package/docs/CreditAccountEntity.md +61 -0
  49. package/docs/CustomerInformationModel.md +33 -0
  50. package/docs/CustomerPriceListEnum.md +23 -0
  51. package/docs/CustomerSummaryReportDTO.md +31 -0
  52. package/docs/DdiRangeRequestModel.md +25 -0
  53. package/docs/DdiRangesRequestModel.md +21 -0
  54. package/docs/DivertRequestModel.md +23 -0
  55. package/docs/DivertResponseModel.md +25 -0
  56. package/docs/EdTechProClientEntity.md +29 -0
  57. package/docs/EdTechProSchoolModel.md +47 -0
  58. package/docs/EdTechProSchoolsModel.md +27 -0
  59. package/docs/EdTechProSetupModel.md +29 -0
  60. package/docs/FraudManagementModel.md +23 -0
  61. package/docs/FreshdeskCompanyTicketsModel.md +27 -0
  62. package/docs/FreshdeskTicketEntity.md +33 -0
  63. package/docs/FtpAccountsEntity.md +29 -0
  64. package/docs/GenericFileModel.md +25 -0
  65. package/docs/GetGetPasswordHash200Response.md +20 -0
  66. package/docs/GetGetPrice200Response.md +20 -0
  67. package/docs/GetGetRecording200Response.md +20 -0
  68. package/docs/HostingChangeResponseModel.md +29 -0
  69. package/docs/InstanceAutoFailoverEntity.md +29 -0
  70. package/docs/InstanceDeletionScheduleEntity.md +27 -0
  71. package/docs/InstanceEntity.md +59 -0
  72. package/docs/InstanceFailoverEntity.md +41 -0
  73. package/docs/InstanceMonitoringEntity.md +25 -0
  74. package/docs/InstanceMonitoringLogEntity.md +31 -0
  75. package/docs/InstanceScheduledTasksEntity.md +31 -0
  76. package/docs/InstanceTcxDetailsEntity.md +39 -0
  77. package/docs/InstanceUserCredentialsEntity.md +29 -0
  78. package/docs/ItemDTO.md +41 -0
  79. package/docs/ItemEntity.md +61 -0
  80. package/docs/MFARequiredModel.md +23 -0
  81. package/docs/MonthlyUsageModel.md +23 -0
  82. package/docs/MultiTenantChangeResponseModel.md +27 -0
  83. package/docs/MyPBXToolsApi.md +65 -0
  84. package/docs/NavigationModel.md +27 -0
  85. package/docs/OAuth20Api.md +368 -0
  86. package/docs/OfflineInstancesEntity.md +29 -0
  87. package/docs/OrderEntity.md +135 -0
  88. package/docs/OrderRequestModel.md +45 -0
  89. package/docs/OrderSummariesModel.md +27 -0
  90. package/docs/OrderSummaryDTO.md +43 -0
  91. package/docs/OrderTotalModel.md +33 -0
  92. package/docs/OrderedItemEntity.md +47 -0
  93. package/docs/OrdersApi.md +135 -0
  94. package/docs/PatchSetTcxWizardCnameRequest.md +20 -0
  95. package/docs/PatchUpdateAccountContactPasswordRequest.md +20 -0
  96. package/docs/PortalAccountModel.md +67 -0
  97. package/docs/PortalLoginModel.md +33 -0
  98. package/docs/PostAddWebhook200Response.md +20 -0
  99. package/docs/PostGetClientCredentialsRequest.md +20 -0
  100. package/docs/PriceListItemModel.md +29 -0
  101. package/docs/PricingApi.md +138 -0
  102. package/docs/PrizesEntity.md +31 -0
  103. package/docs/ProductSearchResultsModel.md +21 -0
  104. package/docs/ProductSerialInfoModel.md +27 -0
  105. package/docs/ProductSummaryModel.md +31 -0
  106. package/docs/ProductsApi.md +315 -0
  107. package/docs/PromoCodesEntity.md +43 -0
  108. package/docs/PromoItemsEntity.md +35 -0
  109. package/docs/ProvisioningApi.md +402 -0
  110. package/docs/ProvisioningEntity.md +29 -0
  111. package/docs/ProvisioningRequestEntity.md +25 -0
  112. package/docs/ResourceNotReadyException.md +25 -0
  113. package/docs/RootAccessModel.md +25 -0
  114. package/docs/SIPTrunksApi.md +1258 -0
  115. package/docs/SMSApi.md +66 -0
  116. package/docs/ScannedItemModel.md +29 -0
  117. package/docs/ScopeModel.md +23 -0
  118. package/docs/ShipmentAddressEntity.md +41 -0
  119. package/docs/ShipmentEntity.md +43 -0
  120. package/docs/ShipmentItemEntity.md +29 -0
  121. package/docs/SipTrunkChangeResponseModel.md +29 -0
  122. package/docs/SipTrunkCreationRequestModel.md +31 -0
  123. package/docs/SipTrunkEntity.md +43 -0
  124. package/docs/SipTrunksResponseModel.md +27 -0
  125. package/docs/SmsAccountEntity.md +33 -0
  126. package/docs/SmsDataModel.md +21 -0
  127. package/docs/SmsMessageModel.md +25 -0
  128. package/docs/SmsNumbersEntity.md +23 -0
  129. package/docs/SmsPayloadModel.md +25 -0
  130. package/docs/SmsPhoneNumberModel.md +23 -0
  131. package/docs/SmsResponseModel.md +29 -0
  132. package/docs/SmsWhitelistEntity.md +23 -0
  133. package/docs/StockManagementApi.md +1380 -0
  134. package/docs/StockOrderCourierEntity.md +27 -0
  135. package/docs/StockOrderDeductionModel.md +27 -0
  136. package/docs/StockOrderDeductionRequestModel.md +23 -0
  137. package/docs/StockOrderDeductionsEntity.md +27 -0
  138. package/docs/StockOrderEntity.md +63 -0
  139. package/docs/StockOrderItemEntity.md +33 -0
  140. package/docs/StockOrderItemModel.md +37 -0
  141. package/docs/StockOrderItemRequestModel.md +27 -0
  142. package/docs/StockOrderModel.md +49 -0
  143. package/docs/StockOrderProductEntity.md +31 -0
  144. package/docs/StockOrderRequestModel.md +25 -0
  145. package/docs/StockOrderSupplierEntity.md +37 -0
  146. package/docs/StockOrderSupplierModel.md +37 -0
  147. package/docs/StockOrdersModel.md +27 -0
  148. package/docs/StockProductModel.md +49 -0
  149. package/docs/StockProductPriceModel.md +23 -0
  150. package/docs/StockProductSummariesModel.md +27 -0
  151. package/docs/StockProductSummaryModel.md +33 -0
  152. package/docs/StockTransactionsEntity.md +35 -0
  153. package/docs/SupplierEntity.md +37 -0
  154. package/docs/SupplierItemEntity.md +35 -0
  155. package/docs/SystemApi.md +80 -0
  156. package/docs/TcxBackupEntity.md +37 -0
  157. package/docs/TcxBackupModel.md +55 -0
  158. package/docs/TcxBillingEntity.md +39 -0
  159. package/docs/TcxBulkLicenceDetailsModel.md +23 -0
  160. package/docs/TcxDeadLicenceEntity.md +25 -0
  161. package/docs/TcxExtsEntity.md +35 -0
  162. package/docs/TcxHostingPricingEntity.md +35 -0
  163. package/docs/TcxInstallationDetailsModel.md +45 -0
  164. package/docs/TcxInstallationModel.md +75 -0
  165. package/docs/TcxInstallationsModel.md +27 -0
  166. package/docs/TcxKeySummaryDTO.md +29 -0
  167. package/docs/TcxKeysEntity.md +31 -0
  168. package/docs/TcxLicenceDetailsErrorModel.md +27 -0
  169. package/docs/TcxLicenceDetailsModel.md +41 -0
  170. package/docs/TcxMacsEntity.md +25 -0
  171. package/docs/TcxMultiTenantModel.md +47 -0
  172. package/docs/TcxMultiTenantUserModel.md +25 -0
  173. package/docs/TcxMultiTenantsModel.md +27 -0
  174. package/docs/TcxNumbersEntity.md +25 -0
  175. package/docs/TcxOfficeHoursEntity.md +49 -0
  176. package/docs/TcxPhoneModel.md +32 -0
  177. package/docs/TcxPhonesEntity.md +31 -0
  178. package/docs/TcxSbcEntity.md +51 -0
  179. package/docs/TcxSetupEntity.md +71 -0
  180. package/docs/TcxSetupsModel.md +27 -0
  181. package/docs/TcxSipTrunksEntity.md +45 -0
  182. package/docs/TcxTemplateXmlEnum.md +23 -0
  183. package/docs/TcxUsersEntity.md +31 -0
  184. package/docs/TcxWizardConfigModel.md +23 -0
  185. package/docs/TcxWizardModel.md +47 -0
  186. package/docs/TechSupportCompanySummaryDTO.md +29 -0
  187. package/docs/TelephonySupportTicketModel.md +41 -0
  188. package/docs/TicketSummaryModel.md +35 -0
  189. package/docs/TicketTimeDTO.md +36 -0
  190. package/docs/TicketsApi.md +300 -0
  191. package/docs/TokenResponseModel.md +25 -0
  192. package/docs/UpgradeOrderResponseModel.md +23 -0
  193. package/docs/UpgradeRequestModel.md +27 -0
  194. package/docs/UserEntity.md +39 -0
  195. package/docs/WebhooksApi.md +117 -0
  196. package/docs/XeroLogEntity.md +39 -0
  197. package/git_push.sh +57 -0
  198. package/index.ts +18 -0
  199. package/openapitools.json +7 -0
  200. package/package.json +31 -0
  201. package/tsconfig.json +21 -0
@@ -0,0 +1,189 @@
1
+ .gitignore
2
+ .npmignore
3
+ .openapi-generator-ignore
4
+ README.md
5
+ api.ts
6
+ base.ts
7
+ common.ts
8
+ configuration.ts
9
+ docs/AccountContactEntity.md
10
+ docs/AccountContactModel.md
11
+ docs/AccountContactRequestModel.md
12
+ docs/AccountRequestModel.md
13
+ docs/AccountSummaryDTO.md
14
+ docs/AccountsApi.md
15
+ docs/AccountsResponseModel.md
16
+ docs/AddressModel.md
17
+ docs/AddressRequestModel.md
18
+ docs/AgentHoursGraphModel.md
19
+ docs/AgentHoursGraphMonthModel.md
20
+ docs/ApiLogEntity.md
21
+ docs/AreaCodeModel.md
22
+ docs/AttachmentModel.md
23
+ docs/AttributeSetEnum.md
24
+ docs/AuthCodeResponseModel.md
25
+ docs/BatchEntity.md
26
+ docs/CallBarringModel.md
27
+ docs/Class3CXApi.md
28
+ docs/Class3CXInstallationWizardApi.md
29
+ docs/Class3CXInstallationsApi.md
30
+ docs/Class3CXIntegrationsApi.md
31
+ docs/Class3CXMultiTenantApi.md
32
+ docs/ClientDetailsModel.md
33
+ docs/ClientModel.md
34
+ docs/CompanyContractModel.md
35
+ docs/ContactInfoModel.md
36
+ docs/ConversationModel.md
37
+ docs/CreditAccountEntity.md
38
+ docs/CustomerInformationModel.md
39
+ docs/CustomerPriceListEnum.md
40
+ docs/CustomerSummaryReportDTO.md
41
+ docs/DdiRangeRequestModel.md
42
+ docs/DdiRangesRequestModel.md
43
+ docs/DivertRequestModel.md
44
+ docs/DivertResponseModel.md
45
+ docs/EdTechProClientEntity.md
46
+ docs/EdTechProSchoolModel.md
47
+ docs/EdTechProSchoolsModel.md
48
+ docs/EdTechProSetupModel.md
49
+ docs/FraudManagementModel.md
50
+ docs/FreshdeskCompanyTicketsModel.md
51
+ docs/FreshdeskTicketEntity.md
52
+ docs/FtpAccountsEntity.md
53
+ docs/GenericFileModel.md
54
+ docs/GetGetPasswordHash200Response.md
55
+ docs/GetGetPrice200Response.md
56
+ docs/GetGetRecording200Response.md
57
+ docs/HostingChangeResponseModel.md
58
+ docs/InstanceAutoFailoverEntity.md
59
+ docs/InstanceDeletionScheduleEntity.md
60
+ docs/InstanceEntity.md
61
+ docs/InstanceFailoverEntity.md
62
+ docs/InstanceMonitoringEntity.md
63
+ docs/InstanceMonitoringLogEntity.md
64
+ docs/InstanceScheduledTasksEntity.md
65
+ docs/InstanceTcxDetailsEntity.md
66
+ docs/InstanceUserCredentialsEntity.md
67
+ docs/ItemDTO.md
68
+ docs/ItemEntity.md
69
+ docs/MFARequiredModel.md
70
+ docs/MonthlyUsageModel.md
71
+ docs/MultiTenantChangeResponseModel.md
72
+ docs/MyPBXToolsApi.md
73
+ docs/NavigationModel.md
74
+ docs/OAuth20Api.md
75
+ docs/OfflineInstancesEntity.md
76
+ docs/OrderEntity.md
77
+ docs/OrderRequestModel.md
78
+ docs/OrderSummariesModel.md
79
+ docs/OrderSummaryDTO.md
80
+ docs/OrderTotalModel.md
81
+ docs/OrderedItemEntity.md
82
+ docs/OrdersApi.md
83
+ docs/PatchSetTcxWizardCnameRequest.md
84
+ docs/PatchUpdateAccountContactPasswordRequest.md
85
+ docs/PortalAccountModel.md
86
+ docs/PortalLoginModel.md
87
+ docs/PostAddWebhook200Response.md
88
+ docs/PostGetClientCredentialsRequest.md
89
+ docs/PriceListItemModel.md
90
+ docs/PricingApi.md
91
+ docs/PrizesEntity.md
92
+ docs/ProductSearchResultsModel.md
93
+ docs/ProductSerialInfoModel.md
94
+ docs/ProductSummaryModel.md
95
+ docs/ProductsApi.md
96
+ docs/PromoCodesEntity.md
97
+ docs/PromoItemsEntity.md
98
+ docs/ProvisioningApi.md
99
+ docs/ProvisioningEntity.md
100
+ docs/ProvisioningRequestEntity.md
101
+ docs/ResourceNotReadyException.md
102
+ docs/RootAccessModel.md
103
+ docs/SIPTrunksApi.md
104
+ docs/SMSApi.md
105
+ docs/ScannedItemModel.md
106
+ docs/ScopeModel.md
107
+ docs/ShipmentAddressEntity.md
108
+ docs/ShipmentEntity.md
109
+ docs/ShipmentItemEntity.md
110
+ docs/SipTrunkChangeResponseModel.md
111
+ docs/SipTrunkCreationRequestModel.md
112
+ docs/SipTrunkEntity.md
113
+ docs/SipTrunksResponseModel.md
114
+ docs/SmsAccountEntity.md
115
+ docs/SmsDataModel.md
116
+ docs/SmsMessageModel.md
117
+ docs/SmsNumbersEntity.md
118
+ docs/SmsPayloadModel.md
119
+ docs/SmsPhoneNumberModel.md
120
+ docs/SmsResponseModel.md
121
+ docs/SmsWhitelistEntity.md
122
+ docs/StockManagementApi.md
123
+ docs/StockOrderCourierEntity.md
124
+ docs/StockOrderDeductionModel.md
125
+ docs/StockOrderDeductionRequestModel.md
126
+ docs/StockOrderDeductionsEntity.md
127
+ docs/StockOrderEntity.md
128
+ docs/StockOrderItemEntity.md
129
+ docs/StockOrderItemModel.md
130
+ docs/StockOrderItemRequestModel.md
131
+ docs/StockOrderModel.md
132
+ docs/StockOrderProductEntity.md
133
+ docs/StockOrderRequestModel.md
134
+ docs/StockOrderSupplierEntity.md
135
+ docs/StockOrderSupplierModel.md
136
+ docs/StockOrdersModel.md
137
+ docs/StockProductModel.md
138
+ docs/StockProductPriceModel.md
139
+ docs/StockProductSummariesModel.md
140
+ docs/StockProductSummaryModel.md
141
+ docs/StockTransactionsEntity.md
142
+ docs/SupplierEntity.md
143
+ docs/SupplierItemEntity.md
144
+ docs/SystemApi.md
145
+ docs/TcxBackupEntity.md
146
+ docs/TcxBackupModel.md
147
+ docs/TcxBillingEntity.md
148
+ docs/TcxBulkLicenceDetailsModel.md
149
+ docs/TcxDeadLicenceEntity.md
150
+ docs/TcxExtsEntity.md
151
+ docs/TcxHostingPricingEntity.md
152
+ docs/TcxInstallationDetailsModel.md
153
+ docs/TcxInstallationModel.md
154
+ docs/TcxInstallationsModel.md
155
+ docs/TcxKeySummaryDTO.md
156
+ docs/TcxKeysEntity.md
157
+ docs/TcxLicenceDetailsErrorModel.md
158
+ docs/TcxLicenceDetailsModel.md
159
+ docs/TcxMacsEntity.md
160
+ docs/TcxMultiTenantModel.md
161
+ docs/TcxMultiTenantUserModel.md
162
+ docs/TcxMultiTenantsModel.md
163
+ docs/TcxNumbersEntity.md
164
+ docs/TcxOfficeHoursEntity.md
165
+ docs/TcxPhoneModel.md
166
+ docs/TcxPhonesEntity.md
167
+ docs/TcxSbcEntity.md
168
+ docs/TcxSetupEntity.md
169
+ docs/TcxSetupsModel.md
170
+ docs/TcxSipTrunksEntity.md
171
+ docs/TcxTemplateXmlEnum.md
172
+ docs/TcxUsersEntity.md
173
+ docs/TcxWizardConfigModel.md
174
+ docs/TcxWizardModel.md
175
+ docs/TechSupportCompanySummaryDTO.md
176
+ docs/TelephonySupportTicketModel.md
177
+ docs/TicketSummaryModel.md
178
+ docs/TicketTimeDTO.md
179
+ docs/TicketsApi.md
180
+ docs/TokenResponseModel.md
181
+ docs/UpgradeOrderResponseModel.md
182
+ docs/UpgradeRequestModel.md
183
+ docs/UserEntity.md
184
+ docs/WebhooksApi.md
185
+ docs/XeroLogEntity.md
186
+ git_push.sh
187
+ index.ts
188
+ package.json
189
+ tsconfig.json
@@ -0,0 +1 @@
1
+ 7.14.0
@@ -0,0 +1,23 @@
1
+ # OpenAPI Generator Ignore
2
+ # Generated by openapi-generator https://github.com/openapitools/openapi-generator
3
+
4
+ # Use this file to prevent files from being overwritten by the generator.
5
+ # The patterns follow closely to .gitignore or .dockerignore.
6
+
7
+ # As an example, the C# client generator defines ApiClient.cs.
8
+ # You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
9
+ #ApiClient.cs
10
+
11
+ # You can match any string of characters against a directory, file or extension with a single asterisk (*):
12
+ #foo/*/qux
13
+ # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
14
+
15
+ # You can recursively match patterns against a directory, file or extension with a double asterisk (**):
16
+ #foo/**/qux
17
+ # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
18
+
19
+ # You can also negate patterns with an exclamation (!).
20
+ # For example, you can ignore all files in a docs folder with the file extension .md:
21
+ #docs/*.md
22
+ # Then explicitly reverse the ignore rule for a single file:
23
+ #!docs/README.md
package/README.md ADDED
@@ -0,0 +1,385 @@
1
+ ## yellowgrid-api-ts@0
2
+
3
+ This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
+
5
+ Environment
6
+ * Node.js
7
+ * Webpack
8
+ * Browserify
9
+
10
+ Language level
11
+ * ES5 - you must have a Promises/A+ library installed
12
+ * ES6
13
+
14
+ Module system
15
+ * CommonJS
16
+ * ES6 module system
17
+
18
+ It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
19
+
20
+ ### Building
21
+
22
+ To build and compile the typescript sources to javascript use:
23
+ ```
24
+ npm install
25
+ npm run build
26
+ ```
27
+
28
+ ### Publishing
29
+
30
+ First build the package then run `npm publish`
31
+
32
+ ### Consuming
33
+
34
+ navigate to the folder of your consuming project and run one of the following commands.
35
+
36
+ _published:_
37
+
38
+ ```
39
+ npm install yellowgrid-api-ts@0 --save
40
+ ```
41
+
42
+ _unPublished (not recommended):_
43
+
44
+ ```
45
+ npm install PATH_TO_GENERATED_PACKAGE --save
46
+ ```
47
+
48
+ ### Documentation for API Endpoints
49
+
50
+ All URIs are relative to *http://api.yellowgrid.local*
51
+
52
+ Class | Method | HTTP request | Description
53
+ ------------ | ------------- | ------------- | -------------
54
+ *AccountsApi* | [**deleteDeleteClientCredentials**](docs/AccountsApi.md#deletedeleteclientcredentials) | **DELETE** /accounts/me/contacts/credentials/{id} | Delete client credentials
55
+ *AccountsApi* | [**deleteUpdateAccountContact**](docs/AccountsApi.md#deleteupdateaccountcontact) | **DELETE** /accounts/me/contacts/{email} | Delete Account Contact
56
+ *AccountsApi* | [**getGetAccount**](docs/AccountsApi.md#getgetaccount) | **GET** /accounts/me | Get Account
57
+ *AccountsApi* | [**getGetAccountContacts**](docs/AccountsApi.md#getgetaccountcontacts) | **GET** /accounts/me/contacts | Get Account Contacts
58
+ *AccountsApi* | [**getGetAccounts**](docs/AccountsApi.md#getgetaccounts) | **GET** /accounts | Get Accounts
59
+ *AccountsApi* | [**getGetClientCredentials**](docs/AccountsApi.md#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials
60
+ *AccountsApi* | [**getGetCustomerKeys**](docs/AccountsApi.md#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys
61
+ *AccountsApi* | [**getVerifyEmailAddress**](docs/AccountsApi.md#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address
62
+ *AccountsApi* | [**patchSetTcxWizardCname**](docs/AccountsApi.md#patchsettcxwizardcname) | **PATCH** /accounts/me/cname |
63
+ *AccountsApi* | [**patchUpdateAccountContactPassword**](docs/AccountsApi.md#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password
64
+ *AccountsApi* | [**postGetAccountContacts**](docs/AccountsApi.md#postgetaccountcontacts) | **POST** /accounts/me/contacts | Add Account Contact
65
+ *AccountsApi* | [**postGetAccounts**](docs/AccountsApi.md#postgetaccounts) | **POST** /accounts | Create new customer account
66
+ *AccountsApi* | [**postGetClientCredentials**](docs/AccountsApi.md#postgetclientcredentials) | **POST** /accounts/me/contacts/credentials | Create client credentials
67
+ *AccountsApi* | [**postSendEmailVerificationEmail**](docs/AccountsApi.md#postsendemailverificationemail) | **POST** /accounts/contacts/verify/{email} | Send email verification email
68
+ *AccountsApi* | [**postSendPasswordReset**](docs/AccountsApi.md#postsendpasswordreset) | **POST** /accounts/contacts/password/reset | Send password reset email
69
+ *AccountsApi* | [**postSubmitResellerApplication**](docs/AccountsApi.md#postsubmitresellerapplication) | **POST** /accounts/reseller | Submit reseller application
70
+ *AccountsApi* | [**putUpdateAccountContact**](docs/AccountsApi.md#putupdateaccountcontact) | **PUT** /accounts/me/contacts/{email} | Update Account Contact
71
+ *Class3CXApi* | [**getGetLicenceDetails**](docs/Class3CXApi.md#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details
72
+ *Class3CXApi* | [**getGetPasswordHash**](docs/Class3CXApi.md#getgetpasswordhash) | **GET** /tcx/pwd2hash | Convert a password to a hashed 3CX password
73
+ *Class3CXApi* | [**postGetBulkLicenceDetails**](docs/Class3CXApi.md#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details
74
+ *Class3CXInstallationWizardApi* | [**deleteAddExtensions**](docs/Class3CXInstallationWizardApi.md#deleteaddextensions) | **DELETE** /tcx/wizards/extensions | Delete 3CX Installation Wizard Extensions
75
+ *Class3CXInstallationWizardApi* | [**deleteAddNumbers**](docs/Class3CXInstallationWizardApi.md#deleteaddnumbers) | **DELETE** /tcx/wizards/numbers | Delete 3CX Installation Wizard Numbers
76
+ *Class3CXInstallationWizardApi* | [**deleteAddPhones**](docs/Class3CXInstallationWizardApi.md#deleteaddphones) | **DELETE** /tcx/wizards/phones | Delete 3CX Installation Wizard Phone
77
+ *Class3CXInstallationWizardApi* | [**deleteAddSbcs**](docs/Class3CXInstallationWizardApi.md#deleteaddsbcs) | **DELETE** /tcx/wizards/sbcs | Delete 3CX Installation Wizard SBCs
78
+ *Class3CXInstallationWizardApi* | [**deleteGetWizard**](docs/Class3CXInstallationWizardApi.md#deletegetwizard) | **DELETE** /tcx/wizards | Delete 3CX Installation Wizard
79
+ *Class3CXInstallationWizardApi* | [**getAddPhones**](docs/Class3CXInstallationWizardApi.md#getaddphones) | **GET** /tcx/wizards/phones | Get phones on linked order and MAC addresses
80
+ *Class3CXInstallationWizardApi* | [**getGetHostingPrice**](docs/Class3CXInstallationWizardApi.md#getgethostingprice) | **GET** /tcx/wizards/price | Get Hosting Price
81
+ *Class3CXInstallationWizardApi* | [**getGetInstallStatus**](docs/Class3CXInstallationWizardApi.md#getgetinstallstatus) | **GET** /tcx/wizard/build/status | Get 3CX Instance Install Status
82
+ *Class3CXInstallationWizardApi* | [**getGetInstanceInstallStatus**](docs/Class3CXInstallationWizardApi.md#getgetinstanceinstallstatus) | **GET** /tcx/wizards/instances/build/status | Get 3CX Instance Install Status
83
+ *Class3CXInstallationWizardApi* | [**getGetPbxIpAddress**](docs/Class3CXInstallationWizardApi.md#getgetpbxipaddress) | **GET** /tcx/wizards/instances/ip | Get PBX IP Address
84
+ *Class3CXInstallationWizardApi* | [**getGetWizard**](docs/Class3CXInstallationWizardApi.md#getgetwizard) | **GET** /tcx/wizards | Get 3CX Installation Wizard
85
+ *Class3CXInstallationWizardApi* | [**patchAddExtensions**](docs/Class3CXInstallationWizardApi.md#patchaddextensions) | **PATCH** /tcx/wizards/extensions | Update 3CX Installation Wizard Extensions
86
+ *Class3CXInstallationWizardApi* | [**patchAddNumbers**](docs/Class3CXInstallationWizardApi.md#patchaddnumbers) | **PATCH** /tcx/wizards/numbers | Update 3CX Installation Wizard Numbers
87
+ *Class3CXInstallationWizardApi* | [**patchAddPhones**](docs/Class3CXInstallationWizardApi.md#patchaddphones) | **PATCH** /tcx/wizards/phones | Update 3CX Installation Wizard Phones
88
+ *Class3CXInstallationWizardApi* | [**patchAddSbcs**](docs/Class3CXInstallationWizardApi.md#patchaddsbcs) | **PATCH** /tcx/wizards/sbcs | Update 3CX Installation Wizard SBCs
89
+ *Class3CXInstallationWizardApi* | [**patchGetWizard**](docs/Class3CXInstallationWizardApi.md#patchgetwizard) | **PATCH** /tcx/wizards | Update 3CX Installation Wizard
90
+ *Class3CXInstallationWizardApi* | [**postAddExtensions**](docs/Class3CXInstallationWizardApi.md#postaddextensions) | **POST** /tcx/wizards/extensions | Add Extensions To 3CX Installation Wizard
91
+ *Class3CXInstallationWizardApi* | [**postAddNumbers**](docs/Class3CXInstallationWizardApi.md#postaddnumbers) | **POST** /tcx/wizards/numbers | Add Numbers To 3CX Installation Wizard
92
+ *Class3CXInstallationWizardApi* | [**postAddPhones**](docs/Class3CXInstallationWizardApi.md#postaddphones) | **POST** /tcx/wizards/phones | Add Phones To 3CX Installation Wizard
93
+ *Class3CXInstallationWizardApi* | [**postAddSbcs**](docs/Class3CXInstallationWizardApi.md#postaddsbcs) | **POST** /tcx/wizards/sbcs | Add SBCs To 3CX Installation Wizard
94
+ *Class3CXInstallationWizardApi* | [**postBuildInstance**](docs/Class3CXInstallationWizardApi.md#postbuildinstance) | **POST** /tcx/wizards/instances/build | Build Instance From 3CX Installation Wizard
95
+ *Class3CXInstallationWizardApi* | [**postBuildInstanceFromWizard**](docs/Class3CXInstallationWizardApi.md#postbuildinstancefromwizard) | **POST** /tcx/wizard/build | Start 3CX Installation Build Process
96
+ *Class3CXInstallationWizardApi* | [**postCreateInstance**](docs/Class3CXInstallationWizardApi.md#postcreateinstance) | **POST** /tcx/wizards/instances/create | Create Instance From 3CX Installation Wizard
97
+ *Class3CXInstallationWizardApi* | [**postCreateInstanceFromWizard**](docs/Class3CXInstallationWizardApi.md#postcreateinstancefromwizard) | **POST** /tcx/wizard/create | Create Hosted Instance From 3CX Installation Wizard Config
98
+ *Class3CXInstallationWizardApi* | [**postUploadBackup**](docs/Class3CXInstallationWizardApi.md#postuploadbackup) | **POST** /tcx/wizards/backup |
99
+ *Class3CXInstallationsApi* | [**getGetDetails**](docs/Class3CXInstallationsApi.md#getgetdetails) | **GET** /tcx/installations/{wizard_id}/details | Get 3CX Installation Details
100
+ *Class3CXInstallationsApi* | [**getGetInstallations**](docs/Class3CXInstallationsApi.md#getgetinstallations) | **GET** /tcx/installations | Get 3CX Installations
101
+ *Class3CXInstallationsApi* | [**postCreateSshUser**](docs/Class3CXInstallationsApi.md#postcreatesshuser) | **POST** /tcx/installations/{instance_id}/create/user/root | Create a root user
102
+ *Class3CXInstallationsApi* | [**postDeleteInstance**](docs/Class3CXInstallationsApi.md#postdeleteinstance) | **POST** /tcx/installations/{instance_id}/delete | Delete 3CX Instance
103
+ *Class3CXInstallationsApi* | [**postExtendDisk**](docs/Class3CXInstallationsApi.md#postextenddisk) | **POST** /tcx/installations/{instance_id}/disk/extend | Extend additional disk on 3CX Instance
104
+ *Class3CXInstallationsApi* | [**postFailoverInstance**](docs/Class3CXInstallationsApi.md#postfailoverinstance) | **POST** /tcx/installations/{instance_id}/failover | Failover 3CX Instance
105
+ *Class3CXInstallationsApi* | [**postRebootInstance**](docs/Class3CXInstallationsApi.md#postrebootinstance) | **POST** /tcx/installations/{instance_id}/reboot | Reboot 3CX Instance
106
+ *Class3CXInstallationsApi* | [**postResizeInstance**](docs/Class3CXInstallationsApi.md#postresizeinstance) | **POST** /tcx/installations/{instance_id}/resize | Resize 3CX Instance
107
+ *Class3CXInstallationsApi* | [**postSuspendInstance**](docs/Class3CXInstallationsApi.md#postsuspendinstance) | **POST** /tcx/installations/{instance_id}/suspend | Suspend 3CX Instance
108
+ *Class3CXInstallationsApi* | [**postUnsuspendInstance**](docs/Class3CXInstallationsApi.md#postunsuspendinstance) | **POST** /tcx/installations/{instance_id}/unsuspend | Unsuspend 3CX Instance
109
+ *Class3CXInstallationsApi* | [**postUpgradeDebian**](docs/Class3CXInstallationsApi.md#postupgradedebian) | **POST** /tcx/installations/{instance_id}/debian/upgrade | Install OS update on 3CX Instance
110
+ *Class3CXIntegrationsApi* | [**getGetPrice**](docs/Class3CXIntegrationsApi.md#getgetprice) | **GET** /tcx/integrations/edtechpro/prices |
111
+ *Class3CXIntegrationsApi* | [**getGetSchools**](docs/Class3CXIntegrationsApi.md#getgetschools) | **GET** /tcx/integrations/edtechpro/schools |
112
+ *Class3CXIntegrationsApi* | [**getGetTrusts**](docs/Class3CXIntegrationsApi.md#getgettrusts) | **GET** /tcx/integrations/edtechpro/trusts |
113
+ *Class3CXIntegrationsApi* | [**patchUpdateEtpOrderReference**](docs/Class3CXIntegrationsApi.md#patchupdateetporderreference) | **PATCH** /tcx/integrations/edtechpro/{clientId}/schools/{schoolId}/orderReference |
114
+ *Class3CXIntegrationsApi* | [**postOrderEdTechPro**](docs/Class3CXIntegrationsApi.md#postorderedtechpro) | **POST** /tcx/integrations/edtechpro/orders |
115
+ *Class3CXIntegrationsApi* | [**postUpgradeEdTechPro**](docs/Class3CXIntegrationsApi.md#postupgradeedtechpro) | **POST** /tcx/integrations/edtechpro/upgrades |
116
+ *Class3CXMultiTenantApi* | [**deleteGetTenant**](docs/Class3CXMultiTenantApi.md#deletegettenant) | **DELETE** /tcx/mt/tenants/{reference} | Delete 3CX MT Tenant
117
+ *Class3CXMultiTenantApi* | [**getGetTenant**](docs/Class3CXMultiTenantApi.md#getgettenant) | **GET** /tcx/mt/tenants/{reference} | Get 3CX MT Tenant
118
+ *Class3CXMultiTenantApi* | [**getGetTenants**](docs/Class3CXMultiTenantApi.md#getgettenants) | **GET** /tcx/mt/tenants | Get 3CX MT Tenants
119
+ *Class3CXMultiTenantApi* | [**postAddMtDdi**](docs/Class3CXMultiTenantApi.md#postaddmtddi) | **POST** /tcx/mt/ddis | Add 3CX MT DDI
120
+ *Class3CXMultiTenantApi* | [**postGetMtNewDdis**](docs/Class3CXMultiTenantApi.md#postgetmtnewddis) | **POST** /tcx/mt/changes/ddis | Get 3CX MT New DDIs
121
+ *Class3CXMultiTenantApi* | [**postGetTenants**](docs/Class3CXMultiTenantApi.md#postgettenants) | **POST** /tcx/mt/tenants | Add 3CX MT Tenant
122
+ *Class3CXMultiTenantApi* | [**postTrackMtChange**](docs/Class3CXMultiTenantApi.md#posttrackmtchange) | **POST** /tcx/mt/changes/track | Track 3CX MT Change
123
+ *MyPBXToolsApi* | [**getGetRecording**](docs/MyPBXToolsApi.md#getgetrecording) | **GET** /mypbxtools/recordings | Fetch recording from a 3CX instance
124
+ *OAuth20Api* | [**getGetMfaQrCode**](docs/OAuth20Api.md#getgetmfaqrcode) | **GET** /oauth2/qr/code | Get MFA QR Code
125
+ *OAuth20Api* | [**getGetScopes**](docs/OAuth20Api.md#getgetscopes) | **GET** /oauth2/scopes | Get Scopes
126
+ *OAuth20Api* | [**postAccessToken**](docs/OAuth20Api.md#postaccesstoken) | **POST** /oauth2/access_token | Validates client credentials and returns access token
127
+ *OAuth20Api* | [**postAuthorise**](docs/OAuth20Api.md#postauthorise) | **POST** /oauth2/authorise | Get OAuth2.0 Auth Code
128
+ *OAuth20Api* | [**postGetIdentity**](docs/OAuth20Api.md#postgetidentity) | **POST** /oauth2/me | Get Token Identity
129
+ *OAuth20Api* | [**postPortalLogin**](docs/OAuth20Api.md#postportallogin) | **POST** /oauth2/portal/login | Portal Login
130
+ *OrdersApi* | [**deleteDeleteOrder**](docs/OrdersApi.md#deletedeleteorder) | **DELETE** /orders/{id} |
131
+ *OrdersApi* | [**getGetOrders**](docs/OrdersApi.md#getgetorders) | **GET** /orders | Get Orders
132
+ *PricingApi* | [**getGetPriceList**](docs/PricingApi.md#getgetpricelist) | **GET** /finance/pricing/lists | Get Price List
133
+ *PricingApi* | [**postSendPriceList**](docs/PricingApi.md#postsendpricelist) | **POST** /finance/pricing/lists/send | Send Price List
134
+ *ProductsApi* | [**getGetAttributeSets**](docs/ProductsApi.md#getgetattributesets) | **GET** /products/attributes | Get Attribute Sets
135
+ *ProductsApi* | [**getGetCustomerPriceLists**](docs/ProductsApi.md#getgetcustomerpricelists) | **GET** /products/prices/lists | Get Customer Price Lists
136
+ *ProductsApi* | [**getGetLegacyStockList**](docs/ProductsApi.md#getgetlegacystocklist) | **GET** /products/stock/legacy | Get Current Stock & Pricing
137
+ *ProductsApi* | [**getGetProducts**](docs/ProductsApi.md#getgetproducts) | **GET** /products/search | Get Products
138
+ *ProductsApi* | [**getGetStockList**](docs/ProductsApi.md#getgetstocklist) | **GET** /products/stock | Get Current Stock & Pricing
139
+ *ProductsApi* | [**getGetTcxTemplates**](docs/ProductsApi.md#getgettcxtemplates) | **GET** /products/attributes/tcx/templates | Get 3CX Templates
140
+ *ProvisioningApi* | [**deleteAddFanvilMac**](docs/ProvisioningApi.md#deleteaddfanvilmac) | **DELETE** /provisioning/fanvil/groups/{id}/macs/{mac} | Remove MAC address from DB and FDPS group
141
+ *ProvisioningApi* | [**deleteDeleteFanvilGroup**](docs/ProvisioningApi.md#deletedeletefanvilgroup) | **DELETE** /provisioning/fanvil/groups/{id} | Delete group from DB and FDPS
142
+ *ProvisioningApi* | [**getGetFanvilEncryptionKey**](docs/ProvisioningApi.md#getgetfanvilencryptionkey) | **GET** /provisioning/fanvil/groups/{id}/macs/{mac}/key | Get group Fanvil encryption key
143
+ *ProvisioningApi* | [**getGetFanvilGroupMacs**](docs/ProvisioningApi.md#getgetfanvilgroupmacs) | **GET** /provisioning/fanvil/groups/{id}/macs | Get MAC addresses on group at FDPS
144
+ *ProvisioningApi* | [**getGetGroups**](docs/ProvisioningApi.md#getgetgroups) | **GET** /provisioning/groups | Get all provisioning groups or filter by customer ID
145
+ *ProvisioningApi* | [**postAddFanvilGroup**](docs/ProvisioningApi.md#postaddfanvilgroup) | **POST** /provisioning/fanvil/groups | Add group to DB and FDPS
146
+ *ProvisioningApi* | [**postAddFanvilMac**](docs/ProvisioningApi.md#postaddfanvilmac) | **POST** /provisioning/fanvil/groups/{id}/macs/{mac} | Add MAC address to DB and FDPS group
147
+ *SIPTrunksApi* | [**deleteGetSipTrunk**](docs/SIPTrunksApi.md#deletegetsiptrunk) | **DELETE** /sip/trunks/{id} | Delete SIP Trunk
148
+ *SIPTrunksApi* | [**getCanDivert**](docs/SIPTrunksApi.md#getcandivert) | **GET** /sip/trunks/{id}/diverts/allowed | SIP Trunk Diverts Allowed
149
+ *SIPTrunksApi* | [**getGetAddress**](docs/SIPTrunksApi.md#getgetaddress) | **GET** /sip/trunks/{id}/address | Get SIP Trunk Address
150
+ *SIPTrunksApi* | [**getGetAreaCodes**](docs/SIPTrunksApi.md#getgetareacodes) | **GET** /sip/trunks/area/codes | Get UK National Area Codes
151
+ *SIPTrunksApi* | [**getGetCliFlexibility**](docs/SIPTrunksApi.md#getgetcliflexibility) | **GET** /sip/trunks/{id}/cli/flexibility | Get SIP Trunk CLI Flexibility Status
152
+ *SIPTrunksApi* | [**getGetDdis**](docs/SIPTrunksApi.md#getgetddis) | **GET** /sip/trunks/{id}/ddis | Get SIP Trunk DDIs
153
+ *SIPTrunksApi* | [**getGetDiverts**](docs/SIPTrunksApi.md#getgetdiverts) | **GET** /sip/trunks/{id}/diverts | Get SIP Trunk Diverts
154
+ *SIPTrunksApi* | [**getGetSipTrunk**](docs/SIPTrunksApi.md#getgetsiptrunk) | **GET** /sip/trunks/{id} | Get SIP Trunk
155
+ *SIPTrunksApi* | [**getGetSipTrunks**](docs/SIPTrunksApi.md#getgetsiptrunks) | **GET** /sip/trunks | Get SIP Trunks
156
+ *SIPTrunksApi* | [**patchGetCliFlexibility**](docs/SIPTrunksApi.md#patchgetcliflexibility) | **PATCH** /sip/trunks/{id}/cli/flexibility | Update Get SIP Trunk CLI Flexibility Status
157
+ *SIPTrunksApi* | [**patchSetAsAvailable**](docs/SIPTrunksApi.md#patchsetasavailable) | **PATCH** /sip/trunks/{id}/available | Set a SIP trunk as \'AVAILABLE\' for repurposing
158
+ *SIPTrunksApi* | [**patchSetOwnership**](docs/SIPTrunksApi.md#patchsetownership) | **PATCH** /sip/trunks/{id}/owner | Change SIP Trunk Owner
159
+ *SIPTrunksApi* | [**patchUpdateChannelCount**](docs/SIPTrunksApi.md#patchupdatechannelcount) | **PATCH** /sip/trunks/{id}/channels | Increase SIP Trunk Channels
160
+ *SIPTrunksApi* | [**patchUpdateCompanyName**](docs/SIPTrunksApi.md#patchupdatecompanyname) | **PATCH** /sip/trunks/{id}/company | Update SIP Trunk Company Name
161
+ *SIPTrunksApi* | [**patchUpdateMainTrunkNumber**](docs/SIPTrunksApi.md#patchupdatemaintrunknumber) | **PATCH** /sip/trunks/{id}/number | Update SIP Trunk Main Trunk Number
162
+ *SIPTrunksApi* | [**patchUpdatePbxIPAddress**](docs/SIPTrunksApi.md#patchupdatepbxipaddress) | **PATCH** /sip/trunks/{id}/pbx/ip | Update SIP Trunk PBX IP Address
163
+ *SIPTrunksApi* | [**postGetDdis**](docs/SIPTrunksApi.md#postgetddis) | **POST** /sip/trunks/{id}/ddis | Add SIP Trunk DDIs
164
+ *SIPTrunksApi* | [**postGetRequestedDdis**](docs/SIPTrunksApi.md#postgetrequestedddis) | **POST** /sip/trunks/changes/ddis | Get Requested DDIs
165
+ *SIPTrunksApi* | [**postGetSipTrunks**](docs/SIPTrunksApi.md#postgetsiptrunks) | **POST** /sip/trunks | Create New SIP Trunk
166
+ *SIPTrunksApi* | [**postTrackChange**](docs/SIPTrunksApi.md#posttrackchange) | **POST** /sip/trunks/changes/track | Track SIP Trunk Change Request
167
+ *SIPTrunksApi* | [**putGetAddress**](docs/SIPTrunksApi.md#putgetaddress) | **PUT** /sip/trunks/{id}/address | Update SIP Trunk Address
168
+ *SIPTrunksApi* | [**putGetDiverts**](docs/SIPTrunksApi.md#putgetdiverts) | **PUT** /sip/trunks/{id}/diverts | Update SIP Trunk Diverts
169
+ *SMSApi* | [**postSendSms**](docs/SMSApi.md#postsendsms) | **POST** /messaging/sms/send |
170
+ *StockManagementApi* | [**deleteDeleteStockOrder**](docs/StockManagementApi.md#deletedeletestockorder) | **DELETE** /stock/orders/{id} | Delete Stock Order
171
+ *StockManagementApi* | [**deleteDeleteStockOrderDeduction**](docs/StockManagementApi.md#deletedeletestockorderdeduction) | **DELETE** /stock/orders/{order_id}/deductions/{deduction_id} | Delete Stock Order Deduction
172
+ *StockManagementApi* | [**deleteDeleteStockOrderItem**](docs/StockManagementApi.md#deletedeletestockorderitem) | **DELETE** /stock/orders/{order_id}/items/{item_id} | Delete Stock Order Item
173
+ *StockManagementApi* | [**deleteGetStockProduct**](docs/StockManagementApi.md#deletegetstockproduct) | **DELETE** /stock/products/{id} | Delete Stock Product
174
+ *StockManagementApi* | [**getDeleteStockOrder**](docs/StockManagementApi.md#getdeletestockorder) | **GET** /stock/orders/{id} | Get Stock Order
175
+ *StockManagementApi* | [**getGetProductDetails**](docs/StockManagementApi.md#getgetproductdetails) | **GET** /stock/products/{sku}/details | Get Product Details
176
+ *StockManagementApi* | [**getGetStockOrderPurchaseOrder**](docs/StockManagementApi.md#getgetstockorderpurchaseorder) | **GET** /stock/orders/{id}/po | Get Stock Order Purchase Order
177
+ *StockManagementApi* | [**getGetStockOrderSupplierEmail**](docs/StockManagementApi.md#getgetstockordersupplieremail) | **GET** /stock/orders/{id}/supplier/email | Get Stock Product Supplier Email mailto
178
+ *StockManagementApi* | [**getGetStockOrders**](docs/StockManagementApi.md#getgetstockorders) | **GET** /stock/orders | Get Stock Orders
179
+ *StockManagementApi* | [**getGetStockProduct**](docs/StockManagementApi.md#getgetstockproduct) | **GET** /stock/products/{id} | Get Stock Product
180
+ *StockManagementApi* | [**getGetStockProductSuppliers**](docs/StockManagementApi.md#getgetstockproductsuppliers) | **GET** /stock/suppliers | Get Stock Product Suppliers
181
+ *StockManagementApi* | [**getGetStockProducts**](docs/StockManagementApi.md#getgetstockproducts) | **GET** /stock/products | Get Stock Products
182
+ *StockManagementApi* | [**getGetStockSupplierProducts**](docs/StockManagementApi.md#getgetstocksupplierproducts) | **GET** /stock/suppliers/{id}/products | Get Stock Supplier\'s Products
183
+ *StockManagementApi* | [**getUploadStockOrderInvoice**](docs/StockManagementApi.md#getuploadstockorderinvoice) | **GET** /stock/orders/{id}/invoice | Get Stock Order Supplier Invoice
184
+ *StockManagementApi* | [**patchDeleteStockOrder**](docs/StockManagementApi.md#patchdeletestockorder) | **PATCH** /stock/orders/{id} | Update Stock Order
185
+ *StockManagementApi* | [**patchDeleteStockOrderDeduction**](docs/StockManagementApi.md#patchdeletestockorderdeduction) | **PATCH** /stock/orders/{order_id}/deductions/{deduction_id} | Update Stock Order Deduction
186
+ *StockManagementApi* | [**patchDeleteStockOrderItem**](docs/StockManagementApi.md#patchdeletestockorderitem) | **PATCH** /stock/orders/{order_id}/items/{item_id} | Update Stock Order Item
187
+ *StockManagementApi* | [**postAddStockOrderDeduction**](docs/StockManagementApi.md#postaddstockorderdeduction) | **POST** /stock/orders/{id}/deductions | Add Stock Order Deductions
188
+ *StockManagementApi* | [**postAddStockOrderItem**](docs/StockManagementApi.md#postaddstockorderitem) | **POST** /stock/orders/{id}/items | Add Stock Order Items
189
+ *StockManagementApi* | [**postGetStockOrders**](docs/StockManagementApi.md#postgetstockorders) | **POST** /stock/orders | Create New Stock Order
190
+ *StockManagementApi* | [**postGetStockProducts**](docs/StockManagementApi.md#postgetstockproducts) | **POST** /stock/products | Create Stock Product
191
+ *StockManagementApi* | [**postUploadStockOrderInvoice**](docs/StockManagementApi.md#postuploadstockorderinvoice) | **POST** /stock/orders/{id}/invoice | Upload Stock Order Supplier Invoice
192
+ *StockManagementApi* | [**putGetStockProduct**](docs/StockManagementApi.md#putgetstockproduct) | **PUT** /stock/products/{id} | Update Stock Product
193
+ *StockManagementApi* | [**putReceiveStockOrderItem**](docs/StockManagementApi.md#putreceivestockorderitem) | **PUT** /stock/orders/{order_id}/items/{item_id}/receive | Receive Stock Order Item
194
+ *SystemApi* | [**getLogSearch**](docs/SystemApi.md#getlogsearch) | **GET** /system/logs/api/search | Search for logs
195
+ *TicketsApi* | [**getCreateTicket**](docs/TicketsApi.md#getcreateticket) | **GET** /tickets/support |
196
+ *TicketsApi* | [**getGetTicket**](docs/TicketsApi.md#getgetticket) | **GET** /tickets/support/{id} |
197
+ *TicketsApi* | [**patchCloseTicket**](docs/TicketsApi.md#patchcloseticket) | **PATCH** /tickets/support/{id}/close |
198
+ *TicketsApi* | [**postCreateTicket**](docs/TicketsApi.md#postcreateticket) | **POST** /tickets/support |
199
+ *TicketsApi* | [**postTicketReply**](docs/TicketsApi.md#postticketreply) | **POST** /tickets/support/{id}/reply |
200
+ *WebhooksApi* | [**deleteRevokeWebhook**](docs/WebhooksApi.md#deleterevokewebhook) | **DELETE** /webhooks/delete | Delete an authenticated webhook URL
201
+ *WebhooksApi* | [**postAddWebhook**](docs/WebhooksApi.md#postaddwebhook) | **POST** /webhooks/add | Create an authenticated webhook URL
202
+
203
+
204
+ ### Documentation For Models
205
+
206
+ - [AccountContactEntity](docs/AccountContactEntity.md)
207
+ - [AccountContactModel](docs/AccountContactModel.md)
208
+ - [AccountContactRequestModel](docs/AccountContactRequestModel.md)
209
+ - [AccountRequestModel](docs/AccountRequestModel.md)
210
+ - [AccountSummaryDTO](docs/AccountSummaryDTO.md)
211
+ - [AccountsResponseModel](docs/AccountsResponseModel.md)
212
+ - [AddressModel](docs/AddressModel.md)
213
+ - [AddressRequestModel](docs/AddressRequestModel.md)
214
+ - [AgentHoursGraphModel](docs/AgentHoursGraphModel.md)
215
+ - [AgentHoursGraphMonthModel](docs/AgentHoursGraphMonthModel.md)
216
+ - [ApiLogEntity](docs/ApiLogEntity.md)
217
+ - [AreaCodeModel](docs/AreaCodeModel.md)
218
+ - [AttachmentModel](docs/AttachmentModel.md)
219
+ - [AttributeSetEnum](docs/AttributeSetEnum.md)
220
+ - [AuthCodeResponseModel](docs/AuthCodeResponseModel.md)
221
+ - [BatchEntity](docs/BatchEntity.md)
222
+ - [CallBarringModel](docs/CallBarringModel.md)
223
+ - [ClientDetailsModel](docs/ClientDetailsModel.md)
224
+ - [ClientModel](docs/ClientModel.md)
225
+ - [CompanyContractModel](docs/CompanyContractModel.md)
226
+ - [ContactInfoModel](docs/ContactInfoModel.md)
227
+ - [ConversationModel](docs/ConversationModel.md)
228
+ - [CreditAccountEntity](docs/CreditAccountEntity.md)
229
+ - [CustomerInformationModel](docs/CustomerInformationModel.md)
230
+ - [CustomerPriceListEnum](docs/CustomerPriceListEnum.md)
231
+ - [CustomerSummaryReportDTO](docs/CustomerSummaryReportDTO.md)
232
+ - [DdiRangeRequestModel](docs/DdiRangeRequestModel.md)
233
+ - [DdiRangesRequestModel](docs/DdiRangesRequestModel.md)
234
+ - [DivertRequestModel](docs/DivertRequestModel.md)
235
+ - [DivertResponseModel](docs/DivertResponseModel.md)
236
+ - [EdTechProClientEntity](docs/EdTechProClientEntity.md)
237
+ - [EdTechProSchoolModel](docs/EdTechProSchoolModel.md)
238
+ - [EdTechProSchoolsModel](docs/EdTechProSchoolsModel.md)
239
+ - [EdTechProSetupModel](docs/EdTechProSetupModel.md)
240
+ - [FraudManagementModel](docs/FraudManagementModel.md)
241
+ - [FreshdeskCompanyTicketsModel](docs/FreshdeskCompanyTicketsModel.md)
242
+ - [FreshdeskTicketEntity](docs/FreshdeskTicketEntity.md)
243
+ - [FtpAccountsEntity](docs/FtpAccountsEntity.md)
244
+ - [GenericFileModel](docs/GenericFileModel.md)
245
+ - [GetGetPasswordHash200Response](docs/GetGetPasswordHash200Response.md)
246
+ - [GetGetPrice200Response](docs/GetGetPrice200Response.md)
247
+ - [GetGetRecording200Response](docs/GetGetRecording200Response.md)
248
+ - [HostingChangeResponseModel](docs/HostingChangeResponseModel.md)
249
+ - [InstanceAutoFailoverEntity](docs/InstanceAutoFailoverEntity.md)
250
+ - [InstanceDeletionScheduleEntity](docs/InstanceDeletionScheduleEntity.md)
251
+ - [InstanceEntity](docs/InstanceEntity.md)
252
+ - [InstanceFailoverEntity](docs/InstanceFailoverEntity.md)
253
+ - [InstanceMonitoringEntity](docs/InstanceMonitoringEntity.md)
254
+ - [InstanceMonitoringLogEntity](docs/InstanceMonitoringLogEntity.md)
255
+ - [InstanceScheduledTasksEntity](docs/InstanceScheduledTasksEntity.md)
256
+ - [InstanceTcxDetailsEntity](docs/InstanceTcxDetailsEntity.md)
257
+ - [InstanceUserCredentialsEntity](docs/InstanceUserCredentialsEntity.md)
258
+ - [ItemDTO](docs/ItemDTO.md)
259
+ - [ItemEntity](docs/ItemEntity.md)
260
+ - [MFARequiredModel](docs/MFARequiredModel.md)
261
+ - [MonthlyUsageModel](docs/MonthlyUsageModel.md)
262
+ - [MultiTenantChangeResponseModel](docs/MultiTenantChangeResponseModel.md)
263
+ - [NavigationModel](docs/NavigationModel.md)
264
+ - [OfflineInstancesEntity](docs/OfflineInstancesEntity.md)
265
+ - [OrderEntity](docs/OrderEntity.md)
266
+ - [OrderRequestModel](docs/OrderRequestModel.md)
267
+ - [OrderSummariesModel](docs/OrderSummariesModel.md)
268
+ - [OrderSummaryDTO](docs/OrderSummaryDTO.md)
269
+ - [OrderTotalModel](docs/OrderTotalModel.md)
270
+ - [OrderedItemEntity](docs/OrderedItemEntity.md)
271
+ - [PatchSetTcxWizardCnameRequest](docs/PatchSetTcxWizardCnameRequest.md)
272
+ - [PatchUpdateAccountContactPasswordRequest](docs/PatchUpdateAccountContactPasswordRequest.md)
273
+ - [PortalAccountModel](docs/PortalAccountModel.md)
274
+ - [PortalLoginModel](docs/PortalLoginModel.md)
275
+ - [PostAddWebhook200Response](docs/PostAddWebhook200Response.md)
276
+ - [PostGetClientCredentialsRequest](docs/PostGetClientCredentialsRequest.md)
277
+ - [PriceListItemModel](docs/PriceListItemModel.md)
278
+ - [PrizesEntity](docs/PrizesEntity.md)
279
+ - [ProductSearchResultsModel](docs/ProductSearchResultsModel.md)
280
+ - [ProductSerialInfoModel](docs/ProductSerialInfoModel.md)
281
+ - [ProductSummaryModel](docs/ProductSummaryModel.md)
282
+ - [PromoCodesEntity](docs/PromoCodesEntity.md)
283
+ - [PromoItemsEntity](docs/PromoItemsEntity.md)
284
+ - [ProvisioningEntity](docs/ProvisioningEntity.md)
285
+ - [ProvisioningRequestEntity](docs/ProvisioningRequestEntity.md)
286
+ - [ResourceNotReadyException](docs/ResourceNotReadyException.md)
287
+ - [RootAccessModel](docs/RootAccessModel.md)
288
+ - [ScannedItemModel](docs/ScannedItemModel.md)
289
+ - [ScopeModel](docs/ScopeModel.md)
290
+ - [ShipmentAddressEntity](docs/ShipmentAddressEntity.md)
291
+ - [ShipmentEntity](docs/ShipmentEntity.md)
292
+ - [ShipmentItemEntity](docs/ShipmentItemEntity.md)
293
+ - [SipTrunkChangeResponseModel](docs/SipTrunkChangeResponseModel.md)
294
+ - [SipTrunkCreationRequestModel](docs/SipTrunkCreationRequestModel.md)
295
+ - [SipTrunkEntity](docs/SipTrunkEntity.md)
296
+ - [SipTrunksResponseModel](docs/SipTrunksResponseModel.md)
297
+ - [SmsAccountEntity](docs/SmsAccountEntity.md)
298
+ - [SmsDataModel](docs/SmsDataModel.md)
299
+ - [SmsMessageModel](docs/SmsMessageModel.md)
300
+ - [SmsNumbersEntity](docs/SmsNumbersEntity.md)
301
+ - [SmsPayloadModel](docs/SmsPayloadModel.md)
302
+ - [SmsPhoneNumberModel](docs/SmsPhoneNumberModel.md)
303
+ - [SmsResponseModel](docs/SmsResponseModel.md)
304
+ - [SmsWhitelistEntity](docs/SmsWhitelistEntity.md)
305
+ - [StockOrderCourierEntity](docs/StockOrderCourierEntity.md)
306
+ - [StockOrderDeductionModel](docs/StockOrderDeductionModel.md)
307
+ - [StockOrderDeductionRequestModel](docs/StockOrderDeductionRequestModel.md)
308
+ - [StockOrderDeductionsEntity](docs/StockOrderDeductionsEntity.md)
309
+ - [StockOrderEntity](docs/StockOrderEntity.md)
310
+ - [StockOrderItemEntity](docs/StockOrderItemEntity.md)
311
+ - [StockOrderItemModel](docs/StockOrderItemModel.md)
312
+ - [StockOrderItemRequestModel](docs/StockOrderItemRequestModel.md)
313
+ - [StockOrderModel](docs/StockOrderModel.md)
314
+ - [StockOrderProductEntity](docs/StockOrderProductEntity.md)
315
+ - [StockOrderRequestModel](docs/StockOrderRequestModel.md)
316
+ - [StockOrderSupplierEntity](docs/StockOrderSupplierEntity.md)
317
+ - [StockOrderSupplierModel](docs/StockOrderSupplierModel.md)
318
+ - [StockOrdersModel](docs/StockOrdersModel.md)
319
+ - [StockProductModel](docs/StockProductModel.md)
320
+ - [StockProductPriceModel](docs/StockProductPriceModel.md)
321
+ - [StockProductSummariesModel](docs/StockProductSummariesModel.md)
322
+ - [StockProductSummaryModel](docs/StockProductSummaryModel.md)
323
+ - [StockTransactionsEntity](docs/StockTransactionsEntity.md)
324
+ - [SupplierEntity](docs/SupplierEntity.md)
325
+ - [SupplierItemEntity](docs/SupplierItemEntity.md)
326
+ - [TcxBackupEntity](docs/TcxBackupEntity.md)
327
+ - [TcxBackupModel](docs/TcxBackupModel.md)
328
+ - [TcxBillingEntity](docs/TcxBillingEntity.md)
329
+ - [TcxBulkLicenceDetailsModel](docs/TcxBulkLicenceDetailsModel.md)
330
+ - [TcxDeadLicenceEntity](docs/TcxDeadLicenceEntity.md)
331
+ - [TcxExtsEntity](docs/TcxExtsEntity.md)
332
+ - [TcxHostingPricingEntity](docs/TcxHostingPricingEntity.md)
333
+ - [TcxInstallationDetailsModel](docs/TcxInstallationDetailsModel.md)
334
+ - [TcxInstallationModel](docs/TcxInstallationModel.md)
335
+ - [TcxInstallationsModel](docs/TcxInstallationsModel.md)
336
+ - [TcxKeySummaryDTO](docs/TcxKeySummaryDTO.md)
337
+ - [TcxKeysEntity](docs/TcxKeysEntity.md)
338
+ - [TcxLicenceDetailsErrorModel](docs/TcxLicenceDetailsErrorModel.md)
339
+ - [TcxLicenceDetailsModel](docs/TcxLicenceDetailsModel.md)
340
+ - [TcxMacsEntity](docs/TcxMacsEntity.md)
341
+ - [TcxMultiTenantModel](docs/TcxMultiTenantModel.md)
342
+ - [TcxMultiTenantUserModel](docs/TcxMultiTenantUserModel.md)
343
+ - [TcxMultiTenantsModel](docs/TcxMultiTenantsModel.md)
344
+ - [TcxNumbersEntity](docs/TcxNumbersEntity.md)
345
+ - [TcxOfficeHoursEntity](docs/TcxOfficeHoursEntity.md)
346
+ - [TcxPhoneModel](docs/TcxPhoneModel.md)
347
+ - [TcxPhonesEntity](docs/TcxPhonesEntity.md)
348
+ - [TcxSbcEntity](docs/TcxSbcEntity.md)
349
+ - [TcxSetupEntity](docs/TcxSetupEntity.md)
350
+ - [TcxSetupsModel](docs/TcxSetupsModel.md)
351
+ - [TcxSipTrunksEntity](docs/TcxSipTrunksEntity.md)
352
+ - [TcxTemplateXmlEnum](docs/TcxTemplateXmlEnum.md)
353
+ - [TcxUsersEntity](docs/TcxUsersEntity.md)
354
+ - [TcxWizardConfigModel](docs/TcxWizardConfigModel.md)
355
+ - [TcxWizardModel](docs/TcxWizardModel.md)
356
+ - [TechSupportCompanySummaryDTO](docs/TechSupportCompanySummaryDTO.md)
357
+ - [TelephonySupportTicketModel](docs/TelephonySupportTicketModel.md)
358
+ - [TicketSummaryModel](docs/TicketSummaryModel.md)
359
+ - [TicketTimeDTO](docs/TicketTimeDTO.md)
360
+ - [TokenResponseModel](docs/TokenResponseModel.md)
361
+ - [UpgradeOrderResponseModel](docs/UpgradeOrderResponseModel.md)
362
+ - [UpgradeRequestModel](docs/UpgradeRequestModel.md)
363
+ - [UserEntity](docs/UserEntity.md)
364
+ - [XeroLogEntity](docs/XeroLogEntity.md)
365
+
366
+
367
+ <a id="documentation-for-authorization"></a>
368
+ ## Documentation For Authorization
369
+
370
+
371
+ Authentication schemes defined for the API:
372
+ <a id="oauth2"></a>
373
+ ### oauth2
374
+
375
+ - **Type**: OAuth
376
+ - **Flow**: application
377
+ - **Authorization URL**:
378
+ - **Scopes**:
379
+ - *****: All scopes (admin only)
380
+ - **fdps**: Fanvil Redirection Server (FDPS)
381
+ - **scope**: A Test Scope
382
+ - **portal**: Yellowgrid Portal Endpoints
383
+ - **tcx_wizard**: 3CX Installation Wizard
384
+ - **sms**: SMS Gateway
385
+