yellowgrid-api-ts 3.2.28 → 3.2.29-dev.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (255) hide show
  1. package/.openapi-generator/FILES +9 -1
  2. package/.openapi-generator/VERSION +1 -1
  3. package/.openapi-generator-ignore +0 -0
  4. package/README.md +14 -2
  5. package/api.ts +665 -3785
  6. package/base.ts +1 -25
  7. package/common.ts +2 -39
  8. package/config.json +3 -3
  9. package/configuration.ts +25 -19
  10. package/dist/api.d.ts +411 -3709
  11. package/dist/api.js +592 -573
  12. package/dist/base.d.ts +1 -25
  13. package/dist/base.js +1 -20
  14. package/dist/common.d.ts +1 -38
  15. package/dist/common.js +1 -38
  16. package/dist/configuration.d.ts +25 -18
  17. package/dist/configuration.js +2 -2
  18. package/dist/index.d.ts +1 -1
  19. package/dist/index.js +1 -1
  20. package/docs/AbstractOrderRequestDTO.md +0 -0
  21. package/docs/AccountContactEntity.md +0 -0
  22. package/docs/AccountContactModel.md +0 -0
  23. package/docs/AccountContactRequestModel.md +0 -0
  24. package/docs/AccountDetailedSummaryDTO.md +0 -0
  25. package/docs/AccountRequestModel.md +0 -0
  26. package/docs/AccountSummaryDTO.md +0 -0
  27. package/docs/AccountsApi.md +0 -0
  28. package/docs/AccountsResponseModel.md +0 -0
  29. package/docs/AddressModel.md +0 -0
  30. package/docs/AddressRequestModel.md +0 -0
  31. package/docs/AdminOrderRequestDTO.md +0 -0
  32. package/docs/AdminUserModel.md +0 -0
  33. package/docs/AgentHoursGraphModel.md +0 -0
  34. package/docs/AgentHoursGraphMonthModel.md +0 -0
  35. package/docs/ApiLogEntity.md +0 -0
  36. package/docs/AreaCodeModel.md +0 -0
  37. package/docs/AttachmentModel.md +0 -0
  38. package/docs/AttributeSetEnum.md +0 -0
  39. package/docs/AuditLogEntity.md +0 -0
  40. package/docs/AuthCodeResponseModel.md +0 -0
  41. package/docs/BasicItemDTO.md +0 -0
  42. package/docs/BasicProductDTO.md +0 -0
  43. package/docs/BatchEntity.md +0 -0
  44. package/docs/CRMApi.md +0 -0
  45. package/docs/CallBarringModel.md +0 -0
  46. package/docs/Class3CXApi.md +0 -0
  47. package/docs/Class3CXInstallationWizardApi.md +0 -56
  48. package/docs/Class3CXInstallationsApi.md +0 -58
  49. package/docs/Class3CXIntegrationsApi.md +0 -0
  50. package/docs/Class3CXMultiTenantApi.md +0 -0
  51. package/docs/ClientDetailsModel.md +0 -0
  52. package/docs/ClientModel.md +0 -0
  53. package/docs/CompanyContractModel.md +0 -0
  54. package/docs/ContactInfoModel.md +0 -0
  55. package/docs/ConversationModel.md +0 -0
  56. package/docs/CourierPriceEntity.md +0 -0
  57. package/docs/CreditAccountEntity.md +0 -0
  58. package/docs/CrmContactDTO.md +0 -0
  59. package/docs/CustomerInformationModel.md +0 -0
  60. package/docs/CustomerItemRequestDTO.md +0 -0
  61. package/docs/CustomerOrderRequestDTO.md +0 -0
  62. package/docs/CustomerPriceListEnum.md +0 -0
  63. package/docs/CustomerSummaryReportDTO.md +0 -0
  64. package/docs/DdiRangeRequestModel.md +0 -0
  65. package/docs/DdiRangesRequestModel.md +0 -0
  66. package/docs/DetailedItemRequestDTO.md +0 -0
  67. package/docs/DetailedOrderRequestDTO.md +0 -0
  68. package/docs/DivertRequestModel.md +0 -0
  69. package/docs/DivertResponseModel.md +0 -0
  70. package/docs/EdTechProClientEntity.md +0 -0
  71. package/docs/EdTechProSchoolModel.md +0 -0
  72. package/docs/EdTechProSchoolsModel.md +0 -0
  73. package/docs/EdTechProSetupModel.md +0 -0
  74. package/docs/EventDTO.md +35 -0
  75. package/docs/EventRequestDTO.md +25 -0
  76. package/docs/EventSubscriptionModel.md +23 -0
  77. package/docs/EventUpdateDTO.md +27 -0
  78. package/docs/EventUpdateEntity.md +29 -0
  79. package/docs/EventUpdateRequestDTO.md +23 -0
  80. package/docs/FraudManagementModel.md +0 -0
  81. package/docs/FreshdeskCompanyTicketsModel.md +0 -0
  82. package/docs/FreshdeskTicketEntity.md +0 -0
  83. package/docs/FtpAccountsEntity.md +0 -0
  84. package/docs/GenericFileModel.md +0 -0
  85. package/docs/GetGetPrice200Response.md +0 -0
  86. package/docs/GetGetRecording200Response.md +0 -0
  87. package/docs/HostingChangeResponseModel.md +0 -0
  88. package/docs/HostingRegionDTO.md +0 -0
  89. package/docs/IncidentDTO.md +35 -0
  90. package/docs/IncidentRequestDTO.md +25 -0
  91. package/docs/IncidentSubscriptionModel.md +23 -0
  92. package/docs/IncidentUpdateDTO.md +27 -0
  93. package/docs/IncidentUpdateEntity.md +29 -0
  94. package/docs/IncidentUpdateRequestDTO.md +23 -0
  95. package/docs/InstanceAutoFailoverEntity.md +0 -0
  96. package/docs/InstanceDeletionScheduleEntity.md +0 -0
  97. package/docs/InstanceEntity.md +0 -2
  98. package/docs/InstanceFailoverEntity.md +0 -0
  99. package/docs/InstanceMonitoringEntity.md +0 -0
  100. package/docs/InstanceMonitoringLogEntity.md +0 -0
  101. package/docs/InstanceScheduledTasksEntity.md +0 -0
  102. package/docs/InstanceTcxDetailsEntity.md +0 -0
  103. package/docs/InstanceUserCredentialsEntity.md +0 -0
  104. package/docs/ItemDTO.md +0 -0
  105. package/docs/ItemDiscountEntity.md +0 -0
  106. package/docs/ItemEntity.md +0 -0
  107. package/docs/LinkedOrderEntity.md +0 -0
  108. package/docs/MFARequiredModel.md +0 -0
  109. package/docs/MonthlyUsageModel.md +0 -0
  110. package/docs/MultiTenantChangeResponseModel.md +0 -0
  111. package/docs/MyPBXToolsApi.md +0 -0
  112. package/docs/NavigationModel.md +0 -0
  113. package/docs/NumberPortDTO.md +51 -0
  114. package/docs/NumberPortEntity.md +47 -0
  115. package/docs/NumberPortModel.md +51 -0
  116. package/docs/NumberPortRangeDTO.md +33 -0
  117. package/docs/NumberPortRangeRequestDTO.md +27 -0
  118. package/docs/NumberPortingApi.md +658 -0
  119. package/docs/NumberPortsModel.md +27 -0
  120. package/docs/OAuth20Api.md +0 -0
  121. package/docs/OfflineInstancesEntity.md +0 -0
  122. package/docs/OrderEntity.md +0 -0
  123. package/docs/OrderRequestModel.md +0 -0
  124. package/docs/OrderSummariesModel.md +0 -0
  125. package/docs/OrderSummaryDTO.md +0 -0
  126. package/docs/OrderTotalModel.md +0 -0
  127. package/docs/OrderedItemEntity.md +0 -0
  128. package/docs/OrdersApi.md +0 -0
  129. package/docs/PatchSetTcxWizardCnameRequest.md +0 -0
  130. package/docs/PatchUpdateAccountContactPasswordRequest.md +0 -0
  131. package/docs/PortalAccountModel.md +0 -0
  132. package/docs/PortalLoginModel.md +0 -0
  133. package/docs/PostAddWebhook200Response.md +0 -0
  134. package/docs/PostGetClientCredentialsRequest.md +0 -0
  135. package/docs/PostGetProductForCustomerRequest.md +0 -0
  136. package/docs/PostGetProductRequest.md +0 -0
  137. package/docs/PriceListItemModel.md +0 -0
  138. package/docs/PricingApi.md +0 -0
  139. package/docs/PrizesEntity.md +0 -0
  140. package/docs/ProductPriceListItemModel.md +0 -0
  141. package/docs/ProductSearchResultsModel.md +0 -0
  142. package/docs/ProductSerialInfoModel.md +0 -0
  143. package/docs/ProductSummaryDTO.md +0 -0
  144. package/docs/ProductsApi.md +0 -0
  145. package/docs/PromoCodesEntity.md +0 -0
  146. package/docs/PromoItemsEntity.md +0 -0
  147. package/docs/ProvisioningApi.md +0 -0
  148. package/docs/ProvisioningModel.md +0 -0
  149. package/docs/ProvisioningRequestEntity.md +0 -0
  150. package/docs/RecordingBackupAzureModel.md +0 -0
  151. package/docs/RecordingsBackupInfoDTO.md +0 -0
  152. package/docs/ResourceNotReadyException.md +0 -0
  153. package/docs/RootAccessModel.md +0 -0
  154. package/docs/S3BucketEntity.md +0 -0
  155. package/docs/SIPTrunksApi.md +0 -0
  156. package/docs/SMSApi.md +0 -0
  157. package/docs/ScannedItemModel.md +0 -0
  158. package/docs/ScopeModel.md +0 -0
  159. package/docs/ServiceHealthDTO.md +23 -0
  160. package/docs/ServiceStatusDTO.md +27 -0
  161. package/docs/ServicesApi.md +330 -0
  162. package/docs/ShipmentAddressEntity.md +0 -0
  163. package/docs/ShipmentEntity.md +0 -0
  164. package/docs/ShipmentItemEntity.md +0 -0
  165. package/docs/ShippingApi.md +0 -0
  166. package/docs/ShippingConsignmentModel.md +0 -0
  167. package/docs/ShippingInformationDTO.md +0 -0
  168. package/docs/ShippingServiceDTO.md +0 -0
  169. package/docs/ShippingServiceModel.md +0 -0
  170. package/docs/ShippingServicesModel.md +0 -0
  171. package/docs/SipTrunkChangeResponseModel.md +0 -0
  172. package/docs/SipTrunkCreationRequestModel.md +0 -0
  173. package/docs/SipTrunkEntity.md +0 -0
  174. package/docs/SipTrunksResponseModel.md +0 -0
  175. package/docs/SmsAccountEntity.md +0 -0
  176. package/docs/SmsDataModel.md +0 -0
  177. package/docs/SmsMessageModel.md +0 -0
  178. package/docs/SmsNumbersEntity.md +0 -0
  179. package/docs/SmsPayloadModel.md +0 -0
  180. package/docs/SmsPhoneNumberModel.md +0 -0
  181. package/docs/SmsResponseModel.md +0 -0
  182. package/docs/SmsWhitelistEntity.md +0 -0
  183. package/docs/StockManagementApi.md +0 -0
  184. package/docs/StockOrderCourierEntity.md +0 -0
  185. package/docs/StockOrderDeductionModel.md +0 -0
  186. package/docs/StockOrderDeductionRequestModel.md +0 -0
  187. package/docs/StockOrderDeductionsEntity.md +0 -0
  188. package/docs/StockOrderEntity.md +0 -0
  189. package/docs/StockOrderItemEntity.md +0 -0
  190. package/docs/StockOrderItemModel.md +0 -0
  191. package/docs/StockOrderItemRequestModel.md +0 -0
  192. package/docs/StockOrderModel.md +0 -0
  193. package/docs/StockOrderProductEntity.md +0 -0
  194. package/docs/StockOrderRequestModel.md +0 -0
  195. package/docs/StockOrderSupplierEntity.md +0 -0
  196. package/docs/StockOrderSupplierModel.md +0 -0
  197. package/docs/StockOrdersModel.md +0 -0
  198. package/docs/StockProductModel.md +0 -0
  199. package/docs/StockProductPriceModel.md +0 -0
  200. package/docs/StockProductSummariesModel.md +0 -0
  201. package/docs/StockProductSummaryModel.md +0 -0
  202. package/docs/StockTransactionsEntity.md +0 -0
  203. package/docs/SupplierEntity.md +0 -0
  204. package/docs/SupplierItemEntity.md +0 -0
  205. package/docs/SupportTicketModel.md +41 -0
  206. package/docs/SystemApi.md +0 -0
  207. package/docs/TcxBackupEntity.md +0 -0
  208. package/docs/TcxBackupModel.md +0 -0
  209. package/docs/TcxBillingEntity.md +0 -0
  210. package/docs/TcxBulkLicenceDetailsModel.md +0 -0
  211. package/docs/TcxDeadLicenceEntity.md +0 -0
  212. package/docs/TcxExtsEntity.md +0 -0
  213. package/docs/TcxHostingPricingEntity.md +0 -0
  214. package/docs/TcxInstallationDetailsModel.md +0 -0
  215. package/docs/TcxInstallationModel.md +0 -2
  216. package/docs/TcxInstallationsModel.md +0 -0
  217. package/docs/TcxKeySummaryDTO.md +0 -0
  218. package/docs/TcxKeysEntity.md +0 -0
  219. package/docs/TcxLicenceDetailsErrorModel.md +0 -0
  220. package/docs/TcxLicenceDetailsModel.md +0 -0
  221. package/docs/TcxMacsEntity.md +0 -0
  222. package/docs/TcxMultiTenantModel.md +0 -0
  223. package/docs/TcxMultiTenantUserModel.md +0 -0
  224. package/docs/TcxMultiTenantsModel.md +0 -0
  225. package/docs/TcxNumbersEntity.md +0 -0
  226. package/docs/TcxOfficeHoursEntity.md +0 -0
  227. package/docs/TcxPhoneModel.md +0 -0
  228. package/docs/TcxPhonesEntity.md +0 -0
  229. package/docs/TcxRemoteStorageModel.md +0 -0
  230. package/docs/TcxSbcDTO.md +0 -0
  231. package/docs/TcxSbcEntity.md +0 -0
  232. package/docs/TcxSbcModel.md +0 -0
  233. package/docs/TcxSetupEntity.md +0 -0
  234. package/docs/TcxSetupsModel.md +0 -0
  235. package/docs/TcxSipTrunksEntity.md +0 -0
  236. package/docs/TcxTemplateXmlEnum.md +0 -0
  237. package/docs/TcxUsersEntity.md +0 -0
  238. package/docs/TcxWizardConfigModel.md +0 -0
  239. package/docs/TcxWizardModel.md +0 -0
  240. package/docs/TechSupportCompanySummaryDTO.md +0 -0
  241. package/docs/TelephonySupportTicketModel.md +0 -0
  242. package/docs/TicketSummaryModel.md +0 -0
  243. package/docs/TicketTimeDTO.md +0 -0
  244. package/docs/TicketsApi.md +0 -0
  245. package/docs/TokenResponseModel.md +0 -0
  246. package/docs/UpgradeOrderResponseModel.md +0 -0
  247. package/docs/UpgradeRequestModel.md +0 -0
  248. package/docs/UserEntity.md +0 -0
  249. package/docs/WebhooksApi.md +0 -0
  250. package/docs/XeroLogEntity.md +0 -0
  251. package/git_push.sh +0 -0
  252. package/index.ts +1 -1
  253. package/openapitools.json +1 -1
  254. package/package.json +1 -1
  255. package/tsconfig.json +0 -0
package/dist/base.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Yellowgrid
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: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
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: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
4
4
  *
5
5
  * The version of the OpenAPI document: 0
6
6
  *
@@ -12,42 +12,22 @@
12
12
  import type { Configuration } from './configuration';
13
13
  import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  export declare const BASE_PATH: string;
15
- /**
16
- *
17
- * @export
18
- */
19
15
  export declare const COLLECTION_FORMATS: {
20
16
  csv: string;
21
17
  ssv: string;
22
18
  tsv: string;
23
19
  pipes: string;
24
20
  };
25
- /**
26
- *
27
- * @export
28
- * @interface RequestArgs
29
- */
30
21
  export interface RequestArgs {
31
22
  url: string;
32
23
  options: RawAxiosRequestConfig;
33
24
  }
34
- /**
35
- *
36
- * @export
37
- * @class BaseAPI
38
- */
39
25
  export declare class BaseAPI {
40
26
  protected basePath: string;
41
27
  protected axios: AxiosInstance;
42
28
  protected configuration: Configuration | undefined;
43
29
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
44
30
  }
45
- /**
46
- *
47
- * @export
48
- * @class RequiredError
49
- * @extends {Error}
50
- */
51
31
  export declare class RequiredError extends Error {
52
32
  field: string;
53
33
  constructor(field: string, msg?: string);
@@ -58,9 +38,5 @@ interface ServerMap {
58
38
  description: string;
59
39
  }[];
60
40
  }
61
- /**
62
- *
63
- * @export
64
- */
65
41
  export declare const operationServerMap: ServerMap;
66
42
  export {};
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. 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: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
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: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
7
7
  *
8
8
  * The version of the OpenAPI document: 0
9
9
  *
@@ -31,21 +31,12 @@ 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
33
  exports.BASE_PATH = "http://api.yellowgrid.local".replace(/\/+$/, "");
34
- /**
35
- *
36
- * @export
37
- */
38
34
  exports.COLLECTION_FORMATS = {
39
35
  csv: ",",
40
36
  ssv: " ",
41
37
  tsv: "\t",
42
38
  pipes: "|",
43
39
  };
44
- /**
45
- *
46
- * @export
47
- * @class BaseAPI
48
- */
49
40
  var BaseAPI = /** @class */ (function () {
50
41
  function BaseAPI(configuration, basePath, axios) {
51
42
  if (basePath === void 0) { basePath = exports.BASE_PATH; }
@@ -62,12 +53,6 @@ var BaseAPI = /** @class */ (function () {
62
53
  }());
63
54
  exports.BaseAPI = BaseAPI;
64
55
  ;
65
- /**
66
- *
67
- * @export
68
- * @class RequiredError
69
- * @extends {Error}
70
- */
71
56
  var RequiredError = /** @class */ (function (_super) {
72
57
  __extends(RequiredError, _super);
73
58
  function RequiredError(field, msg) {
@@ -79,8 +64,4 @@ var RequiredError = /** @class */ (function (_super) {
79
64
  return RequiredError;
80
65
  }(Error));
81
66
  exports.RequiredError = RequiredError;
82
- /**
83
- *
84
- * @export
85
- */
86
67
  exports.operationServerMap = {};
package/dist/common.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Yellowgrid
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: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
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: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
4
4
  *
5
5
  * The version of the OpenAPI document: 0
6
6
  *
@@ -12,54 +12,17 @@
12
12
  import type { Configuration } from "./configuration";
13
13
  import type { RequestArgs } from "./base";
14
14
  import type { AxiosInstance, AxiosResponse } from 'axios';
15
- /**
16
- *
17
- * @export
18
- */
19
15
  export declare const DUMMY_BASE_URL = "https://example.com";
20
16
  /**
21
17
  *
22
18
  * @throws {RequiredError}
23
- * @export
24
19
  */
25
20
  export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
26
- /**
27
- *
28
- * @export
29
- */
30
21
  export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
31
- /**
32
- *
33
- * @export
34
- */
35
22
  export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
36
- /**
37
- *
38
- * @export
39
- */
40
23
  export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
41
- /**
42
- *
43
- * @export
44
- */
45
24
  export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
46
- /**
47
- *
48
- * @export
49
- */
50
25
  export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
51
- /**
52
- *
53
- * @export
54
- */
55
26
  export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
56
- /**
57
- *
58
- * @export
59
- */
60
27
  export declare const toPathString: (url: URL) => string;
61
- /**
62
- *
63
- * @export
64
- */
65
28
  export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
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. 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: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
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: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
7
7
  *
8
8
  * The version of the OpenAPI document: 0
9
9
  *
@@ -62,15 +62,10 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
62
62
  Object.defineProperty(exports, "__esModule", { value: true });
63
63
  exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
64
64
  var base_1 = require("./base");
65
- /**
66
- *
67
- * @export
68
- */
69
65
  exports.DUMMY_BASE_URL = 'https://example.com';
70
66
  /**
71
67
  *
72
68
  * @throws {RequiredError}
73
- * @export
74
69
  */
75
70
  var assertParamExists = function (functionName, paramName, paramValue) {
76
71
  if (paramValue === null || paramValue === undefined) {
@@ -78,10 +73,6 @@ var assertParamExists = function (functionName, paramName, paramValue) {
78
73
  }
79
74
  };
80
75
  exports.assertParamExists = assertParamExists;
81
- /**
82
- *
83
- * @export
84
- */
85
76
  var setApiKeyToObject = function (object, keyParamName, configuration) {
86
77
  return __awaiter(this, void 0, void 0, function () {
87
78
  var localVarApiKeyValue, _a;
@@ -108,20 +99,12 @@ var setApiKeyToObject = function (object, keyParamName, configuration) {
108
99
  });
109
100
  };
110
101
  exports.setApiKeyToObject = setApiKeyToObject;
111
- /**
112
- *
113
- * @export
114
- */
115
102
  var setBasicAuthToObject = function (object, configuration) {
116
103
  if (configuration && (configuration.username || configuration.password)) {
117
104
  object["auth"] = { username: configuration.username, password: configuration.password };
118
105
  }
119
106
  };
120
107
  exports.setBasicAuthToObject = setBasicAuthToObject;
121
- /**
122
- *
123
- * @export
124
- */
125
108
  var setBearerAuthToObject = function (object, configuration) {
126
109
  return __awaiter(this, void 0, void 0, function () {
127
110
  var accessToken, _a;
@@ -148,10 +131,6 @@ var setBearerAuthToObject = function (object, configuration) {
148
131
  });
149
132
  };
150
133
  exports.setBearerAuthToObject = setBearerAuthToObject;
151
- /**
152
- *
153
- * @export
154
- */
155
134
  var setOAuthToObject = function (object, name, scopes, configuration) {
156
135
  return __awaiter(this, void 0, void 0, function () {
157
136
  var localVarAccessTokenValue, _a;
@@ -201,10 +180,6 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key) {
201
180
  }
202
181
  }
203
182
  }
204
- /**
205
- *
206
- * @export
207
- */
208
183
  var setSearchParams = function (url) {
209
184
  var objects = [];
210
185
  for (var _i = 1; _i < arguments.length; _i++) {
@@ -215,10 +190,6 @@ var setSearchParams = function (url) {
215
190
  url.search = searchParams.toString();
216
191
  };
217
192
  exports.setSearchParams = setSearchParams;
218
- /**
219
- *
220
- * @export
221
- */
222
193
  var serializeDataIfNeeded = function (value, requestOptions, configuration) {
223
194
  var nonString = typeof value !== 'string';
224
195
  var needsSerialization = nonString && configuration && configuration.isJsonMime
@@ -229,18 +200,10 @@ var serializeDataIfNeeded = function (value, requestOptions, configuration) {
229
200
  : (value || "");
230
201
  };
231
202
  exports.serializeDataIfNeeded = serializeDataIfNeeded;
232
- /**
233
- *
234
- * @export
235
- */
236
203
  var toPathString = function (url) {
237
204
  return url.pathname + url.search + url.hash;
238
205
  };
239
206
  exports.toPathString = toPathString;
240
- /**
241
- *
242
- * @export
243
- */
244
207
  var createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
245
208
  return function (axios, basePath) {
246
209
  var _a;
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Yellowgrid
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: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
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: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
4
4
  *
5
5
  * The version of the OpenAPI document: 0
6
6
  *
@@ -9,11 +9,23 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ interface AWSv4Configuration {
13
+ options?: {
14
+ region?: string;
15
+ service?: string;
16
+ };
17
+ credentials?: {
18
+ accessKeyId?: string;
19
+ secretAccessKey?: string;
20
+ sessionToken?: string;
21
+ };
22
+ }
12
23
  export interface ConfigurationParameters {
13
24
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
14
25
  username?: string;
15
26
  password?: string;
16
27
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
28
+ awsv4?: AWSv4Configuration;
17
29
  basePath?: string;
18
30
  serverIndex?: number;
19
31
  baseOptions?: any;
@@ -23,49 +35,43 @@ export declare class Configuration {
23
35
  /**
24
36
  * parameter for apiKey security
25
37
  * @param name security name
26
- * @memberof Configuration
27
38
  */
28
39
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
29
40
  /**
30
41
  * parameter for basic security
31
- *
32
- * @type {string}
33
- * @memberof Configuration
34
42
  */
35
43
  username?: string;
36
44
  /**
37
45
  * parameter for basic security
38
- *
39
- * @type {string}
40
- * @memberof Configuration
41
46
  */
42
47
  password?: string;
43
48
  /**
44
49
  * parameter for oauth2 security
45
50
  * @param name security name
46
51
  * @param scopes oauth2 scope
47
- * @memberof Configuration
48
52
  */
49
53
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
50
54
  /**
51
- * override base path
52
- *
53
- * @type {string}
55
+ * parameter for aws4 signature security
56
+ * @param {Object} AWS4Signature - AWS4 Signature security
57
+ * @param {string} options.region - aws region
58
+ * @param {string} options.service - name of the service.
59
+ * @param {string} credentials.accessKeyId - aws access key id
60
+ * @param {string} credentials.secretAccessKey - aws access key
61
+ * @param {string} credentials.sessionToken - aws session token
54
62
  * @memberof Configuration
55
63
  */
64
+ awsv4?: AWSv4Configuration;
65
+ /**
66
+ * override base path
67
+ */
56
68
  basePath?: string;
57
69
  /**
58
70
  * override server index
59
- *
60
- * @type {number}
61
- * @memberof Configuration
62
71
  */
63
72
  serverIndex?: number;
64
73
  /**
65
74
  * base options for axios calls
66
- *
67
- * @type {any}
68
- * @memberof Configuration
69
75
  */
70
76
  baseOptions?: any;
71
77
  /**
@@ -89,3 +95,4 @@ export declare class Configuration {
89
95
  */
90
96
  isJsonMime(mime: string): boolean;
91
97
  }
98
+ export {};
@@ -1,9 +1,8 @@
1
1
  "use strict";
2
2
  /* tslint:disable */
3
- /* eslint-disable */
4
3
  /**
5
4
  * Yellowgrid
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: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
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: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
7
6
  *
8
7
  * The version of the OpenAPI document: 0
9
8
  *
@@ -33,6 +32,7 @@ var Configuration = /** @class */ (function () {
33
32
  this.username = param.username;
34
33
  this.password = param.password;
35
34
  this.accessToken = param.accessToken;
35
+ this.awsv4 = param.awsv4;
36
36
  this.basePath = param.basePath;
37
37
  this.serverIndex = param.serverIndex;
38
38
  this.baseOptions = __assign(__assign({}, param.baseOptions), { headers: __assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
package/dist/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Yellowgrid
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: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
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: `http://api.yellowgrid.local` 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. 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: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
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: `http://api.yellowgrid.local` For questions or technical support, please contact support@yellowgrid.co.uk.
7
7
  *
8
8
  * The version of the OpenAPI document: 0
9
9
  *
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
package/docs/CRMApi.md CHANGED
File without changes
File without changes
File without changes
@@ -36,7 +36,6 @@ All URIs are relative to *http://api.yellowgrid.local*
36
36
  |[**postGetDdisTcxWizard**](#postgetddistcxwizard) | **POST** /tcx/wizards/sip/trunks/{id}/ddis | Add SIP Trunk DDIs|
37
37
  |[**postGetRequestedDdisTcxWizard**](#postgetrequestedddistcxwizard) | **POST** /tcx/wizards/sip/trunks/changes/ddis | Get Requested DDIs|
38
38
  |[**postGetSipTrunksTcxWizard**](#postgetsiptrunkstcxwizard) | **POST** /tcx/wizards/sip/trunks | Create New SIP Trunk|
39
- |[**postTrackChangeTcxWizard**](#posttrackchangetcxwizard) | **POST** /tcx/wizards/sip/trunks/changes/track | Track SIP Trunk Change Request|
40
39
  |[**postUploadBackup**](#postuploadbackup) | **POST** /tcx/wizards/backup | |
41
40
 
42
41
  # **deleteAddExtensions**
@@ -1714,61 +1713,6 @@ const { status, data } = await apiInstance.postGetSipTrunksTcxWizard(
1714
1713
  | **sipTrunkCreationRequestModel** | **SipTrunkCreationRequestModel**| New SIP Trunk Request | |
1715
1714
 
1716
1715
 
1717
- ### Return type
1718
-
1719
- **SipTrunkChangeResponseModel**
1720
-
1721
- ### Authorization
1722
-
1723
- No authorization required
1724
-
1725
- ### HTTP request headers
1726
-
1727
- - **Content-Type**: application/json
1728
- - **Accept**: application/json
1729
-
1730
-
1731
- ### HTTP response details
1732
- | Status code | Description | Response headers |
1733
- |-------------|-------------|------------------|
1734
- |**200** | Change Response | - |
1735
- |**400** | Bad Request | - |
1736
- |**401** | Unauthorised | - |
1737
- |**403** | Access Denied | - |
1738
-
1739
- [[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)
1740
-
1741
- # **postTrackChangeTcxWizard**
1742
- > SipTrunkChangeResponseModel postTrackChangeTcxWizard()
1743
-
1744
- Track SIP Trunk Change Request
1745
-
1746
- ### Example
1747
-
1748
- ```typescript
1749
- import {
1750
- Class3CXInstallationWizardApi,
1751
- Configuration,
1752
- SipTrunkChangeResponseModel
1753
- } from 'yellowgrid-api-ts';
1754
-
1755
- const configuration = new Configuration();
1756
- const apiInstance = new Class3CXInstallationWizardApi(configuration);
1757
-
1758
- let sipTrunkChangeResponseModel: SipTrunkChangeResponseModel; //Change Request (optional)
1759
-
1760
- const { status, data } = await apiInstance.postTrackChangeTcxWizard(
1761
- sipTrunkChangeResponseModel
1762
- );
1763
- ```
1764
-
1765
- ### Parameters
1766
-
1767
- |Name | Type | Description | Notes|
1768
- |------------- | ------------- | ------------- | -------------|
1769
- | **sipTrunkChangeResponseModel** | **SipTrunkChangeResponseModel**| Change Request | |
1770
-
1771
-
1772
1716
  ### Return type
1773
1717
 
1774
1718
  **SipTrunkChangeResponseModel**
@@ -6,7 +6,6 @@ All URIs are relative to *http://api.yellowgrid.local*
6
6
  |------------- | ------------- | -------------|
7
7
  |[**getGetDetails**](#getgetdetails) | **GET** /tcx/installations/{wizard_id}/details | Get 3CX Installation Details|
8
8
  |[**getGetInstallations**](#getgetinstallations) | **GET** /tcx/installations | Get 3CX Installations|
9
- |[**patchUpdateAutoFailover**](#patchupdateautofailover) | **PATCH** /tcx/installations/{instance_id}/failover/auto | Update 3CX Instance Auto Failover|
10
9
  |[**postCreateSshUser**](#postcreatesshuser) | **POST** /tcx/installations/{instance_id}/create/user/root | Create a root user|
11
10
  |[**postDeleteInstance**](#postdeleteinstance) | **POST** /tcx/installations/{instance_id}/delete | Delete 3CX Instance|
12
11
  |[**postExtendDisk**](#postextenddisk) | **POST** /tcx/installations/{instance_id}/disk/extend | Extend additional disk on 3CX Instance|
@@ -143,63 +142,6 @@ No authorization required
143
142
 
144
143
  [[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)
145
144
 
146
- # **patchUpdateAutoFailover**
147
- > patchUpdateAutoFailover()
148
-
149
- Update 3CX Instance Auto Failover
150
-
151
- ### Example
152
-
153
- ```typescript
154
- import {
155
- Class3CXInstallationsApi,
156
- Configuration
157
- } from 'yellowgrid-api-ts';
158
-
159
- const configuration = new Configuration();
160
- const apiInstance = new Class3CXInstallationsApi(configuration);
161
-
162
- let instanceId: string; //Instance ID (default to undefined)
163
- let enable: boolean; //Enable (default to undefined)
164
-
165
- const { status, data } = await apiInstance.patchUpdateAutoFailover(
166
- instanceId,
167
- enable
168
- );
169
- ```
170
-
171
- ### Parameters
172
-
173
- |Name | Type | Description | Notes|
174
- |------------- | ------------- | ------------- | -------------|
175
- | **instanceId** | [**string**] | Instance ID | defaults to undefined|
176
- | **enable** | [**boolean**] | Enable | defaults to undefined|
177
-
178
-
179
- ### Return type
180
-
181
- void (empty response body)
182
-
183
- ### Authorization
184
-
185
- No authorization required
186
-
187
- ### HTTP request headers
188
-
189
- - **Content-Type**: Not defined
190
- - **Accept**: Not defined
191
-
192
-
193
- ### HTTP response details
194
- | Status code | Description | Response headers |
195
- |-------------|-------------|------------------|
196
- |**200** | No Response | - |
197
- |**400** | Bad Request | - |
198
- |**401** | Unauthorised | - |
199
- |**403** | Access Denied | - |
200
-
201
- [[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)
202
-
203
145
  # **postCreateSshUser**
204
146
  > RootAccessModel postCreateSshUser()
205
147
 
File without changes
File without changes
File without changes
File without changes