yellowgrid-api-ts 3.2.24-dev.0 → 3.2.24

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 (239) hide show
  1. package/.openapi-generator/FILES +2 -7
  2. package/.openapi-generator/VERSION +1 -1
  3. package/.openapi-generator-ignore +0 -0
  4. package/README.md +1 -17
  5. package/api.ts +3868 -1541
  6. package/base.ts +25 -1
  7. package/common.ts +43 -6
  8. package/config.json +3 -3
  9. package/configuration.ts +19 -25
  10. package/dist/api.d.ts +3675 -772
  11. package/dist/api.js +567 -1344
  12. package/dist/base.d.ts +25 -1
  13. package/dist/base.js +20 -1
  14. package/dist/common.d.ts +38 -1
  15. package/dist/common.js +38 -1
  16. package/dist/configuration.d.ts +18 -25
  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 -0
  48. package/docs/Class3CXInstallationsApi.md +0 -0
  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/FraudManagementModel.md +0 -0
  75. package/docs/FreshdeskCompanyTicketsModel.md +0 -0
  76. package/docs/FreshdeskTicketEntity.md +0 -0
  77. package/docs/FtpAccountsEntity.md +0 -0
  78. package/docs/GenericFileModel.md +0 -0
  79. package/docs/GetGetPrice200Response.md +0 -0
  80. package/docs/GetGetRecording200Response.md +0 -0
  81. package/docs/HostingChangeResponseModel.md +0 -0
  82. package/docs/HostingRegionDTO.md +0 -0
  83. package/docs/InstanceAutoFailoverEntity.md +0 -0
  84. package/docs/InstanceDeletionScheduleEntity.md +0 -0
  85. package/docs/InstanceEntity.md +0 -0
  86. package/docs/InstanceFailoverEntity.md +0 -0
  87. package/docs/InstanceMonitoringEntity.md +0 -0
  88. package/docs/InstanceMonitoringLogEntity.md +0 -0
  89. package/docs/InstanceScheduledTasksEntity.md +0 -0
  90. package/docs/InstanceTcxDetailsEntity.md +0 -0
  91. package/docs/InstanceUserCredentialsEntity.md +0 -0
  92. package/docs/ItemDTO.md +0 -0
  93. package/docs/ItemDiscountEntity.md +0 -0
  94. package/docs/ItemEntity.md +0 -0
  95. package/docs/LinkedOrderEntity.md +0 -0
  96. package/docs/MFARequiredModel.md +0 -0
  97. package/docs/MonthlyUsageModel.md +0 -0
  98. package/docs/MultiTenantChangeResponseModel.md +0 -0
  99. package/docs/MyPBXToolsApi.md +0 -0
  100. package/docs/NavigationModel.md +0 -0
  101. package/docs/OAuth20Api.md +3 -3
  102. package/docs/OfflineInstancesEntity.md +0 -0
  103. package/docs/OrderEntity.md +0 -0
  104. package/docs/OrderRequestModel.md +0 -0
  105. package/docs/OrderSummariesModel.md +0 -0
  106. package/docs/OrderSummaryDTO.md +0 -0
  107. package/docs/OrderTotalModel.md +0 -0
  108. package/docs/OrderedItemEntity.md +0 -0
  109. package/docs/OrdersApi.md +0 -0
  110. package/docs/PatchSetTcxWizardCnameRequest.md +0 -0
  111. package/docs/PatchUpdateAccountContactPasswordRequest.md +0 -0
  112. package/docs/PortalAccountModel.md +0 -0
  113. package/docs/PortalLoginModel.md +0 -0
  114. package/docs/PostAddWebhook200Response.md +0 -0
  115. package/docs/PostGetClientCredentialsRequest.md +0 -0
  116. package/docs/PostGetProductForCustomerRequest.md +0 -0
  117. package/docs/PostGetProductRequest.md +0 -0
  118. package/docs/PriceListItemModel.md +0 -0
  119. package/docs/PricingApi.md +0 -0
  120. package/docs/PrizesEntity.md +0 -0
  121. package/docs/ProductPriceListItemModel.md +0 -0
  122. package/docs/ProductSearchResultsModel.md +0 -0
  123. package/docs/ProductSerialInfoModel.md +0 -0
  124. package/docs/ProductSummaryDTO.md +0 -0
  125. package/docs/ProductsApi.md +0 -0
  126. package/docs/PromoCodesEntity.md +0 -0
  127. package/docs/PromoItemsEntity.md +0 -0
  128. package/docs/ProvisioningApi.md +0 -0
  129. package/docs/ProvisioningModel.md +0 -0
  130. package/docs/ProvisioningRequestEntity.md +0 -0
  131. package/docs/RecordingBackupAzureModel.md +0 -0
  132. package/docs/RecordingsBackupInfoDTO.md +0 -0
  133. package/docs/ResourceNotReadyException.md +0 -0
  134. package/docs/RootAccessModel.md +0 -0
  135. package/docs/S3BucketEntity.md +0 -0
  136. package/docs/SIPTrunksApi.md +0 -0
  137. package/docs/SMSApi.md +0 -0
  138. package/docs/ScannedItemModel.md +0 -0
  139. package/docs/ScopeModel.md +0 -0
  140. package/docs/ShipmentAddressEntity.md +0 -0
  141. package/docs/ShipmentEntity.md +0 -0
  142. package/docs/ShipmentItemEntity.md +0 -0
  143. package/docs/ShippingApi.md +0 -0
  144. package/docs/ShippingConsignmentModel.md +0 -0
  145. package/docs/ShippingInformationDTO.md +0 -0
  146. package/docs/ShippingServiceDTO.md +0 -0
  147. package/docs/ShippingServiceModel.md +0 -0
  148. package/docs/ShippingServicesModel.md +0 -0
  149. package/docs/SipTrunkChangeResponseModel.md +0 -0
  150. package/docs/SipTrunkCreationRequestModel.md +0 -0
  151. package/docs/SipTrunkEntity.md +0 -0
  152. package/docs/SipTrunksResponseModel.md +0 -0
  153. package/docs/SmsAccountEntity.md +0 -0
  154. package/docs/SmsDataModel.md +0 -0
  155. package/docs/SmsMessageModel.md +0 -0
  156. package/docs/SmsNumbersEntity.md +0 -0
  157. package/docs/SmsPayloadModel.md +0 -0
  158. package/docs/SmsPhoneNumberModel.md +0 -0
  159. package/docs/SmsResponseModel.md +0 -0
  160. package/docs/SmsWhitelistEntity.md +0 -0
  161. package/docs/StockManagementApi.md +0 -0
  162. package/docs/StockOrderCourierEntity.md +0 -0
  163. package/docs/StockOrderDeductionModel.md +0 -0
  164. package/docs/StockOrderDeductionRequestModel.md +0 -0
  165. package/docs/StockOrderDeductionsEntity.md +0 -0
  166. package/docs/StockOrderEntity.md +0 -0
  167. package/docs/StockOrderItemEntity.md +0 -0
  168. package/docs/StockOrderItemModel.md +0 -0
  169. package/docs/StockOrderItemRequestModel.md +0 -0
  170. package/docs/StockOrderModel.md +0 -0
  171. package/docs/StockOrderProductEntity.md +0 -0
  172. package/docs/StockOrderRequestModel.md +0 -0
  173. package/docs/StockOrderSupplierEntity.md +0 -0
  174. package/docs/StockOrderSupplierModel.md +0 -0
  175. package/docs/StockOrdersModel.md +0 -0
  176. package/docs/StockProductModel.md +0 -0
  177. package/docs/StockProductPriceModel.md +0 -0
  178. package/docs/StockProductSummariesModel.md +0 -0
  179. package/docs/StockProductSummaryModel.md +0 -0
  180. package/docs/StockTransactionsEntity.md +0 -0
  181. package/docs/SupplierEntity.md +0 -0
  182. package/docs/SupplierItemEntity.md +0 -0
  183. package/docs/SystemApi.md +0 -0
  184. package/docs/TcxBackupEntity.md +0 -0
  185. package/docs/TcxBackupModel.md +0 -0
  186. package/docs/TcxBillingEntity.md +0 -0
  187. package/docs/TcxBulkLicenceDetailsModel.md +0 -0
  188. package/docs/TcxDeadLicenceEntity.md +0 -0
  189. package/docs/TcxExtsEntity.md +0 -0
  190. package/docs/TcxHostingPricingEntity.md +0 -0
  191. package/docs/TcxInstallationDetailsModel.md +0 -0
  192. package/docs/TcxInstallationModel.md +0 -0
  193. package/docs/TcxInstallationsModel.md +0 -0
  194. package/docs/TcxKeySummaryDTO.md +0 -0
  195. package/docs/TcxKeysEntity.md +0 -0
  196. package/docs/TcxLicenceDetailsErrorModel.md +0 -0
  197. package/docs/TcxLicenceDetailsModel.md +0 -0
  198. package/docs/TcxMacsEntity.md +0 -0
  199. package/docs/TcxMultiTenantModel.md +0 -0
  200. package/docs/TcxMultiTenantUserModel.md +0 -0
  201. package/docs/TcxMultiTenantsModel.md +0 -0
  202. package/docs/TcxNumbersEntity.md +0 -0
  203. package/docs/TcxOfficeHoursEntity.md +0 -0
  204. package/docs/TcxPhoneModel.md +0 -0
  205. package/docs/TcxPhonesEntity.md +0 -0
  206. package/docs/TcxRemoteStorageModel.md +0 -0
  207. package/docs/TcxSbcDTO.md +0 -0
  208. package/docs/TcxSbcEntity.md +0 -0
  209. package/docs/TcxSbcModel.md +0 -0
  210. package/docs/TcxSetupEntity.md +0 -0
  211. package/docs/TcxSetupsModel.md +0 -0
  212. package/docs/TcxSipTrunksEntity.md +0 -0
  213. package/docs/TcxTemplateXmlEnum.md +0 -0
  214. package/docs/TcxUsersEntity.md +0 -0
  215. package/docs/TcxWizardConfigModel.md +0 -0
  216. package/docs/TcxWizardModel.md +0 -0
  217. package/docs/TechSupportCompanySummaryDTO.md +0 -0
  218. package/docs/{SupportTicketModel.md → TelephonySupportTicketModel.md} +3 -3
  219. package/docs/TicketSummaryModel.md +0 -0
  220. package/docs/TicketTimeDTO.md +0 -0
  221. package/docs/TicketsApi.md +8 -8
  222. package/docs/TokenResponseModel.md +0 -0
  223. package/docs/UpgradeOrderResponseModel.md +0 -0
  224. package/docs/UpgradeRequestModel.md +0 -0
  225. package/docs/UserEntity.md +0 -0
  226. package/docs/WebhooksApi.md +0 -0
  227. package/docs/XeroLogEntity.md +0 -0
  228. package/git_push.sh +0 -0
  229. package/index.ts +1 -1
  230. package/openapitools.json +1 -1
  231. package/package.json +1 -1
  232. package/tsconfig.json +0 -0
  233. package/docs/NumberPortDTO.md +0 -51
  234. package/docs/NumberPortEntity.md +0 -47
  235. package/docs/NumberPortModel.md +0 -51
  236. package/docs/NumberPortRangeDTO.md +0 -33
  237. package/docs/NumberPortRangeRequestDTO.md +0 -27
  238. package/docs/NumberPortingApi.md +0 -658
  239. package/docs/NumberPortsModel.md +0 -27
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,22 +12,42 @@
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
+ */
15
19
  export declare const COLLECTION_FORMATS: {
16
20
  csv: string;
17
21
  ssv: string;
18
22
  tsv: string;
19
23
  pipes: string;
20
24
  };
25
+ /**
26
+ *
27
+ * @export
28
+ * @interface RequestArgs
29
+ */
21
30
  export interface RequestArgs {
22
31
  url: string;
23
32
  options: RawAxiosRequestConfig;
24
33
  }
34
+ /**
35
+ *
36
+ * @export
37
+ * @class BaseAPI
38
+ */
25
39
  export declare class BaseAPI {
26
40
  protected basePath: string;
27
41
  protected axios: AxiosInstance;
28
42
  protected configuration: Configuration | undefined;
29
43
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
30
44
  }
45
+ /**
46
+ *
47
+ * @export
48
+ * @class RequiredError
49
+ * @extends {Error}
50
+ */
31
51
  export declare class RequiredError extends Error {
32
52
  field: string;
33
53
  constructor(field: string, msg?: string);
@@ -38,5 +58,9 @@ interface ServerMap {
38
58
  description: string;
39
59
  }[];
40
60
  }
61
+ /**
62
+ *
63
+ * @export
64
+ */
41
65
  export declare const operationServerMap: ServerMap;
42
66
  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,12 +31,21 @@ 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
+ */
34
38
  exports.COLLECTION_FORMATS = {
35
39
  csv: ",",
36
40
  ssv: " ",
37
41
  tsv: "\t",
38
42
  pipes: "|",
39
43
  };
44
+ /**
45
+ *
46
+ * @export
47
+ * @class BaseAPI
48
+ */
40
49
  var BaseAPI = /** @class */ (function () {
41
50
  function BaseAPI(configuration, basePath, axios) {
42
51
  if (basePath === void 0) { basePath = exports.BASE_PATH; }
@@ -53,6 +62,12 @@ var BaseAPI = /** @class */ (function () {
53
62
  }());
54
63
  exports.BaseAPI = BaseAPI;
55
64
  ;
65
+ /**
66
+ *
67
+ * @export
68
+ * @class RequiredError
69
+ * @extends {Error}
70
+ */
56
71
  var RequiredError = /** @class */ (function (_super) {
57
72
  __extends(RequiredError, _super);
58
73
  function RequiredError(field, msg) {
@@ -64,4 +79,8 @@ var RequiredError = /** @class */ (function (_super) {
64
79
  return RequiredError;
65
80
  }(Error));
66
81
  exports.RequiredError = RequiredError;
82
+ /**
83
+ *
84
+ * @export
85
+ */
67
86
  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,17 +12,54 @@
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
+ */
15
19
  export declare const DUMMY_BASE_URL = "https://example.com";
16
20
  /**
17
21
  *
18
22
  * @throws {RequiredError}
23
+ * @export
19
24
  */
20
25
  export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
26
+ /**
27
+ *
28
+ * @export
29
+ */
21
30
  export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
31
+ /**
32
+ *
33
+ * @export
34
+ */
22
35
  export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
36
+ /**
37
+ *
38
+ * @export
39
+ */
23
40
  export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
41
+ /**
42
+ *
43
+ * @export
44
+ */
24
45
  export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
46
+ /**
47
+ *
48
+ * @export
49
+ */
25
50
  export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
51
+ /**
52
+ *
53
+ * @export
54
+ */
26
55
  export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
56
+ /**
57
+ *
58
+ * @export
59
+ */
27
60
  export declare const toPathString: (url: URL) => string;
61
+ /**
62
+ *
63
+ * @export
64
+ */
28
65
  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,10 +62,15 @@ 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
+ */
65
69
  exports.DUMMY_BASE_URL = 'https://example.com';
66
70
  /**
67
71
  *
68
72
  * @throws {RequiredError}
73
+ * @export
69
74
  */
70
75
  var assertParamExists = function (functionName, paramName, paramValue) {
71
76
  if (paramValue === null || paramValue === undefined) {
@@ -73,6 +78,10 @@ var assertParamExists = function (functionName, paramName, paramValue) {
73
78
  }
74
79
  };
75
80
  exports.assertParamExists = assertParamExists;
81
+ /**
82
+ *
83
+ * @export
84
+ */
76
85
  var setApiKeyToObject = function (object, keyParamName, configuration) {
77
86
  return __awaiter(this, void 0, void 0, function () {
78
87
  var localVarApiKeyValue, _a;
@@ -99,12 +108,20 @@ var setApiKeyToObject = function (object, keyParamName, configuration) {
99
108
  });
100
109
  };
101
110
  exports.setApiKeyToObject = setApiKeyToObject;
111
+ /**
112
+ *
113
+ * @export
114
+ */
102
115
  var setBasicAuthToObject = function (object, configuration) {
103
116
  if (configuration && (configuration.username || configuration.password)) {
104
117
  object["auth"] = { username: configuration.username, password: configuration.password };
105
118
  }
106
119
  };
107
120
  exports.setBasicAuthToObject = setBasicAuthToObject;
121
+ /**
122
+ *
123
+ * @export
124
+ */
108
125
  var setBearerAuthToObject = function (object, configuration) {
109
126
  return __awaiter(this, void 0, void 0, function () {
110
127
  var accessToken, _a;
@@ -131,6 +148,10 @@ var setBearerAuthToObject = function (object, configuration) {
131
148
  });
132
149
  };
133
150
  exports.setBearerAuthToObject = setBearerAuthToObject;
151
+ /**
152
+ *
153
+ * @export
154
+ */
134
155
  var setOAuthToObject = function (object, name, scopes, configuration) {
135
156
  return __awaiter(this, void 0, void 0, function () {
136
157
  var localVarAccessTokenValue, _a;
@@ -180,6 +201,10 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key) {
180
201
  }
181
202
  }
182
203
  }
204
+ /**
205
+ *
206
+ * @export
207
+ */
183
208
  var setSearchParams = function (url) {
184
209
  var objects = [];
185
210
  for (var _i = 1; _i < arguments.length; _i++) {
@@ -190,6 +215,10 @@ var setSearchParams = function (url) {
190
215
  url.search = searchParams.toString();
191
216
  };
192
217
  exports.setSearchParams = setSearchParams;
218
+ /**
219
+ *
220
+ * @export
221
+ */
193
222
  var serializeDataIfNeeded = function (value, requestOptions, configuration) {
194
223
  var nonString = typeof value !== 'string';
195
224
  var needsSerialization = nonString && configuration && configuration.isJsonMime
@@ -200,10 +229,18 @@ var serializeDataIfNeeded = function (value, requestOptions, configuration) {
200
229
  : (value || "");
201
230
  };
202
231
  exports.serializeDataIfNeeded = serializeDataIfNeeded;
232
+ /**
233
+ *
234
+ * @export
235
+ */
203
236
  var toPathString = function (url) {
204
237
  return url.pathname + url.search + url.hash;
205
238
  };
206
239
  exports.toPathString = toPathString;
240
+ /**
241
+ *
242
+ * @export
243
+ */
207
244
  var createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
208
245
  return function (axios, basePath) {
209
246
  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,23 +9,11 @@
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
- }
23
12
  export interface ConfigurationParameters {
24
13
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
25
14
  username?: string;
26
15
  password?: string;
27
16
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
28
- awsv4?: AWSv4Configuration;
29
17
  basePath?: string;
30
18
  serverIndex?: number;
31
19
  baseOptions?: any;
@@ -35,43 +23,49 @@ export declare class Configuration {
35
23
  /**
36
24
  * parameter for apiKey security
37
25
  * @param name security name
26
+ * @memberof Configuration
38
27
  */
39
28
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
40
29
  /**
41
30
  * parameter for basic security
31
+ *
32
+ * @type {string}
33
+ * @memberof Configuration
42
34
  */
43
35
  username?: string;
44
36
  /**
45
37
  * parameter for basic security
38
+ *
39
+ * @type {string}
40
+ * @memberof Configuration
46
41
  */
47
42
  password?: string;
48
43
  /**
49
44
  * parameter for oauth2 security
50
45
  * @param name security name
51
46
  * @param scopes oauth2 scope
52
- */
53
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
54
- /**
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
62
47
  * @memberof Configuration
63
48
  */
64
- awsv4?: AWSv4Configuration;
49
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
65
50
  /**
66
51
  * override base path
52
+ *
53
+ * @type {string}
54
+ * @memberof Configuration
67
55
  */
68
56
  basePath?: string;
69
57
  /**
70
58
  * override server index
59
+ *
60
+ * @type {number}
61
+ * @memberof Configuration
71
62
  */
72
63
  serverIndex?: number;
73
64
  /**
74
65
  * base options for axios calls
66
+ *
67
+ * @type {any}
68
+ * @memberof Configuration
75
69
  */
76
70
  baseOptions?: any;
77
71
  /**
@@ -95,4 +89,3 @@ export declare class Configuration {
95
89
  */
96
90
  isJsonMime(mime: string): boolean;
97
91
  }
98
- export {};
@@ -1,8 +1,9 @@
1
1
  "use strict";
2
2
  /* tslint:disable */
3
+ /* eslint-disable */
3
4
  /**
4
5
  * Yellowgrid
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.
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
7
  *
7
8
  * The version of the OpenAPI document: 0
8
9
  *
@@ -32,7 +33,6 @@ var Configuration = /** @class */ (function () {
32
33
  this.username = param.username;
33
34
  this.password = param.password;
34
35
  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
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
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/ItemDTO.md CHANGED
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes