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

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 (57) hide show
  1. package/.openapi-generator/FILES +195 -213
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +7 -33
  4. package/api.ts +254 -1792
  5. package/base.ts +1 -1
  6. package/common.ts +5 -5
  7. package/config.json +3 -3
  8. package/configuration.ts +1 -1
  9. package/dist/api.d.ts +150 -1310
  10. package/dist/api.js +208 -1060
  11. package/dist/base.d.ts +1 -1
  12. package/dist/base.js +1 -1
  13. package/dist/common.d.ts +1 -1
  14. package/dist/common.js +1 -1
  15. package/dist/configuration.d.ts +1 -1
  16. package/dist/configuration.js +1 -1
  17. package/dist/index.d.ts +1 -1
  18. package/dist/index.js +1 -1
  19. package/docs/AccountsApi.md +0 -103
  20. package/docs/AddressModel.md +0 -2
  21. package/docs/Class3CXApi.md +55 -0
  22. package/docs/ClientDetailsModel.md +2 -0
  23. package/docs/{ShippingServicesModel.md → GetGetPasswordHash200Response.md} +5 -5
  24. package/docs/ItemDTO.md +4 -12
  25. package/docs/ItemEntity.md +0 -2
  26. package/docs/OrderSummaryDTO.md +0 -8
  27. package/docs/OrderTotalModel.md +0 -2
  28. package/docs/OrdersApi.md +4 -301
  29. package/docs/ProductSearchResultsModel.md +1 -1
  30. package/docs/{ProductSummaryDTO.md → ProductSummaryModel.md} +3 -5
  31. package/docs/ProductsApi.md +43 -164
  32. package/docs/ProvisioningApi.md +4 -4
  33. package/docs/{ProvisioningModel.md → ProvisioningEntity.md} +3 -3
  34. package/docs/ShipmentEntity.md +2 -2
  35. package/docs/StockManagementApi.md +2 -2
  36. package/docs/TcxSbcModel.md +1 -1
  37. package/index.ts +1 -1
  38. package/openapitools.json +1 -1
  39. package/package.json +1 -1
  40. package/docs/AbstractOrderRequestDTO.md +0 -33
  41. package/docs/AccountDetailedSummaryDTO.md +0 -39
  42. package/docs/AdminItemRequestDTO.md +0 -39
  43. package/docs/AdminOrderRequestDTO.md +0 -45
  44. package/docs/AdminUserModel.md +0 -29
  45. package/docs/BasicItemDTO.md +0 -23
  46. package/docs/BasicProductDTO.md +0 -23
  47. package/docs/CourierPriceEntity.md +0 -39
  48. package/docs/CustomerItemRequestDTO.md +0 -35
  49. package/docs/CustomerOrderRequestDTO.md +0 -33
  50. package/docs/LinkedOrderEntity.md +0 -23
  51. package/docs/PostGetProductForCustomerRequest.md +0 -24
  52. package/docs/ShippingApi.md +0 -63
  53. package/docs/ShippingConsignmentModel.md +0 -26
  54. package/docs/ShippingInformationDTO.md +0 -25
  55. package/docs/ShippingServiceDTO.md +0 -23
  56. package/docs/ShippingServiceModel.md +0 -31
  57. package/docs/TcxSbcDTO.md +0 -31
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
  *
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
  *
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
  *
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
  *
@@ -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
  *
@@ -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
  *
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
  *
@@ -8,7 +8,6 @@ All URIs are relative to *http://api.yellowgrid.local*
8
8
  |[**deleteUpdateAccountContact**](#deleteupdateaccountcontact) | **DELETE** /accounts/me/contacts/{email} | Delete Account Contact|
9
9
  |[**getGetAccount**](#getgetaccount) | **GET** /accounts/me | Get Account|
10
10
  |[**getGetAccountContacts**](#getgetaccountcontacts) | **GET** /accounts/me/contacts | Get Account Contacts|
11
- |[**getGetAccountDetailedSummary**](#getgetaccountdetailedsummary) | **GET** /accounts/{id}/summary | Get Account Detailed Summary|
12
11
  |[**getGetAccounts**](#getgetaccounts) | **GET** /accounts | Get Accounts|
13
12
  |[**getGetClientCredentials**](#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials|
14
13
  |[**getGetCustomerKeys**](#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys|
@@ -17,7 +16,6 @@ All URIs are relative to *http://api.yellowgrid.local*
17
16
  |[**patchUpdateAccountContactPassword**](#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password|
18
17
  |[**postGetAccountContacts**](#postgetaccountcontacts) | **POST** /accounts/me/contacts | Add Account Contact|
19
18
  |[**postGetAccounts**](#postgetaccounts) | **POST** /accounts | Create new customer account|
20
- |[**postGetAdminAccount**](#postgetadminaccount) | **POST** /admin/me | Get Admin Account|
21
19
  |[**postGetClientCredentials**](#postgetclientcredentials) | **POST** /accounts/me/contacts/credentials | Create client credentials|
22
20
  |[**postSendEmailVerificationEmail**](#postsendemailverificationemail) | **POST** /accounts/contacts/verify/{email} | Send email verification email|
23
21
  |[**postSendPasswordReset**](#postsendpasswordreset) | **POST** /accounts/contacts/password/reset | Send password reset email|
@@ -233,60 +231,6 @@ No authorization required
233
231
 
234
232
  [[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)
235
233
 
236
- # **getGetAccountDetailedSummary**
237
- > AccountDetailedSummaryDTO getGetAccountDetailedSummary()
238
-
239
- Get Account Detailed Summary
240
-
241
- ### Example
242
-
243
- ```typescript
244
- import {
245
- AccountsApi,
246
- Configuration
247
- } from 'yellowgrid-api-ts';
248
-
249
- const configuration = new Configuration();
250
- const apiInstance = new AccountsApi(configuration);
251
-
252
- let id: number; //Customer ID (default to undefined)
253
-
254
- const { status, data } = await apiInstance.getGetAccountDetailedSummary(
255
- id
256
- );
257
- ```
258
-
259
- ### Parameters
260
-
261
- |Name | Type | Description | Notes|
262
- |------------- | ------------- | ------------- | -------------|
263
- | **id** | [**number**] | Customer ID | defaults to undefined|
264
-
265
-
266
- ### Return type
267
-
268
- **AccountDetailedSummaryDTO**
269
-
270
- ### Authorization
271
-
272
- No authorization required
273
-
274
- ### HTTP request headers
275
-
276
- - **Content-Type**: Not defined
277
- - **Accept**: application/json
278
-
279
-
280
- ### HTTP response details
281
- | Status code | Description | Response headers |
282
- |-------------|-------------|------------------|
283
- |**200** | Account Detailed Summary | - |
284
- |**400** | Bad Request | - |
285
- |**401** | Unauthorised | - |
286
- |**403** | Access Denied | - |
287
-
288
- [[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)
289
-
290
234
  # **getGetAccounts**
291
235
  > AccountsResponseModel getGetAccounts()
292
236
 
@@ -721,53 +665,6 @@ No authorization required
721
665
 
722
666
  [[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)
723
667
 
724
- # **postGetAdminAccount**
725
- > AdminUserModel postGetAdminAccount()
726
-
727
- Get Admin Account
728
-
729
- ### Example
730
-
731
- ```typescript
732
- import {
733
- AccountsApi,
734
- Configuration
735
- } from 'yellowgrid-api-ts';
736
-
737
- const configuration = new Configuration();
738
- const apiInstance = new AccountsApi(configuration);
739
-
740
- const { status, data } = await apiInstance.postGetAdminAccount();
741
- ```
742
-
743
- ### Parameters
744
- This endpoint does not have any parameters.
745
-
746
-
747
- ### Return type
748
-
749
- **AdminUserModel**
750
-
751
- ### Authorization
752
-
753
- No authorization required
754
-
755
- ### HTTP request headers
756
-
757
- - **Content-Type**: Not defined
758
- - **Accept**: application/json
759
-
760
-
761
- ### HTTP response details
762
- | Status code | Description | Response headers |
763
- |-------------|-------------|------------------|
764
- |**200** | Admin User | - |
765
- |**400** | Bad Request | - |
766
- |**401** | Unauthorised | - |
767
- |**403** | Access Denied | - |
768
-
769
- [[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)
770
-
771
668
  # **postGetClientCredentials**
772
669
  > ClientModel postGetClientCredentials()
773
670
 
@@ -19,7 +19,6 @@ Name | Type | Description | Notes
19
19
  **postalCode** | **string** | Postal Code | [optional] [default to undefined]
20
20
  **iso** | **string** | Country | [optional] [default to undefined]
21
21
  **company** | **string** | Company | [optional] [default to undefined]
22
- **_default** | **boolean** | Default | [optional] [default to undefined]
23
22
 
24
23
  ## Example
25
24
 
@@ -40,7 +39,6 @@ const instance: AddressModel = {
40
39
  postalCode,
41
40
  iso,
42
41
  company,
43
- _default,
44
42
  };
45
43
  ```
46
44
 
@@ -5,6 +5,7 @@ All URIs are relative to *http://api.yellowgrid.local*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**getGetLicenceDetails**](#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details|
8
+ |[**getGetPasswordHash**](#getgetpasswordhash) | **GET** /tcx/pwd2hash | Convert a password to a hashed 3CX password|
8
9
  |[**postGetBulkLicenceDetails**](#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details|
9
10
 
10
11
  # **getGetLicenceDetails**
@@ -61,6 +62,60 @@ No authorization required
61
62
 
62
63
  [[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)
63
64
 
65
+ # **getGetPasswordHash**
66
+ > GetGetPasswordHash200Response getGetPasswordHash()
67
+
68
+ Generate a 3CX hashed password for 3CX installation
69
+
70
+ ### Example
71
+
72
+ ```typescript
73
+ import {
74
+ Class3CXApi,
75
+ Configuration
76
+ } from 'yellowgrid-api-ts';
77
+
78
+ const configuration = new Configuration();
79
+ const apiInstance = new Class3CXApi(configuration);
80
+
81
+ let password: string; //Desired 3CX web access password (default to undefined)
82
+
83
+ const { status, data } = await apiInstance.getGetPasswordHash(
84
+ password
85
+ );
86
+ ```
87
+
88
+ ### Parameters
89
+
90
+ |Name | Type | Description | Notes|
91
+ |------------- | ------------- | ------------- | -------------|
92
+ | **password** | [**string**] | Desired 3CX web access password | defaults to undefined|
93
+
94
+
95
+ ### Return type
96
+
97
+ **GetGetPasswordHash200Response**
98
+
99
+ ### Authorization
100
+
101
+ No authorization required
102
+
103
+ ### HTTP request headers
104
+
105
+ - **Content-Type**: Not defined
106
+ - **Accept**: application/json
107
+
108
+
109
+ ### HTTP response details
110
+ | Status code | Description | Response headers |
111
+ |-------------|-------------|------------------|
112
+ |**200** | Password Hash | - |
113
+ |**400** | Bad Request | - |
114
+ |**401** | Unauthorised | - |
115
+ |**403** | Access Denied | - |
116
+
117
+ [[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)
118
+
64
119
  # **postGetBulkLicenceDetails**
65
120
  > TcxBulkLicenceDetailsModel postGetBulkLicenceDetails()
66
121
 
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
13
13
  **xeroId** | **string** | Xero ID | [optional] [default to undefined]
14
14
  **firstName** | **string** | User First Name | [optional] [default to undefined]
15
15
  **lastName** | **string** | User Last Name | [optional] [default to undefined]
16
+ **image** | **string** | User Profile Picture | [optional] [default to undefined]
16
17
 
17
18
  ## Example
18
19
 
@@ -27,6 +28,7 @@ const instance: ClientDetailsModel = {
27
28
  xeroId,
28
29
  firstName,
29
30
  lastName,
31
+ image,
30
32
  };
31
33
  ```
32
34
 
@@ -1,19 +1,19 @@
1
- # ShippingServicesModel
1
+ # GetGetPasswordHash200Response
2
2
 
3
3
 
4
4
  ## Properties
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **services** | [**Array<ShippingServiceModel>**](ShippingServiceModel.md) | Services | [optional] [default to undefined]
8
+ **hash** | **string** | | [optional] [default to undefined]
9
9
 
10
10
  ## Example
11
11
 
12
12
  ```typescript
13
- import { ShippingServicesModel } from 'yellowgrid-api-ts';
13
+ import { GetGetPasswordHash200Response } from 'yellowgrid-api-ts';
14
14
 
15
- const instance: ShippingServicesModel = {
16
- services,
15
+ const instance: GetGetPasswordHash200Response = {
16
+ hash,
17
17
  };
18
18
  ```
19
19
 
package/docs/ItemDTO.md CHANGED
@@ -6,21 +6,17 @@ Order Item
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **sku** | **string** | SKU | [optional] [default to undefined]
10
- **quantity** | **number** | Quantity | [optional] [default to undefined]
11
9
  **id** | **number** | ID | [optional] [default to undefined]
12
10
  **orderId** | **number** | Order ID | [optional] [default to undefined]
13
11
  **title** | **string** | Title | [optional] [default to undefined]
12
+ **sku** | **string** | SKU | [optional] [default to undefined]
13
+ **quantity** | **number** | Quantity | [optional] [default to undefined]
14
14
  **price** | **number** | Price | [optional] [default to undefined]
15
15
  **licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
16
16
  **licenceExpiry** | **string** | Date Time | [optional] [default to undefined]
17
17
  **processDate** | **string** | Date Time | [optional] [default to undefined]
18
- **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
19
18
  **promoItem** | **boolean** | Promo Item | [optional] [default to undefined]
20
19
  **refunded** | **number** | Refunded | [optional] [default to undefined]
21
- **sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCs | [optional] [default to undefined]
22
- **readonly** | **boolean** | Readonly | [optional] [default to undefined]
23
- **tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
24
20
 
25
21
  ## Example
26
22
 
@@ -28,21 +24,17 @@ Name | Type | Description | Notes
28
24
  import { ItemDTO } from 'yellowgrid-api-ts';
29
25
 
30
26
  const instance: ItemDTO = {
31
- sku,
32
- quantity,
33
27
  id,
34
28
  orderId,
35
29
  title,
30
+ sku,
31
+ quantity,
36
32
  price,
37
33
  licenceKey,
38
34
  licenceExpiry,
39
35
  processDate,
40
- hosting,
41
36
  promoItem,
42
37
  refunded,
43
- sbcs,
44
- readonly,
45
- tcxSalesCode,
46
38
  };
47
39
  ```
48
40
 
@@ -27,7 +27,6 @@ Name | Type | Description | Notes
27
27
  **licenceExpiryDate** | **string** | licenceExpiryDate | [optional] [default to undefined]
28
28
  **processDate** | **string** | processDate | [optional] [default to undefined]
29
29
  **promoItem** | **number** | promo | [optional] [default to undefined]
30
- **tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
31
30
 
32
31
  ## Example
33
32
 
@@ -56,7 +55,6 @@ const instance: ItemEntity = {
56
55
  licenceExpiryDate,
57
56
  processDate,
58
57
  promoItem,
59
- tcxSalesCode,
60
58
  };
61
59
  ```
62
60
 
@@ -9,7 +9,6 @@ Name | Type | Description | Notes
9
9
  **id** | **number** | ID | [optional] [default to undefined]
10
10
  **reference** | **string** | Reference | [optional] [default to undefined]
11
11
  **invoiceNumber** | **string** | Invoice Number | [optional] [default to undefined]
12
- **invoiceId** | **string** | Invoice ID | [optional] [default to undefined]
13
12
  **orderDate** | **string** | Date Time | [optional] [default to undefined]
14
13
  **paid** | **boolean** | Paid | [optional] [default to undefined]
15
14
  **complete** | **boolean** | Complete | [optional] [default to undefined]
@@ -19,9 +18,6 @@ Name | Type | Description | Notes
19
18
  **items** | [**Array<ItemDTO>**](ItemDTO.md) | Items | [optional] [default to undefined]
20
19
  **carriageCharge** | **number** | Carriage Charge | [optional] [default to undefined]
21
20
  **fulfillable** | **boolean** | Fulfillable | [optional] [default to undefined]
22
- **provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
23
- **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
24
- **readonly** | **boolean** | Readonly | [optional] [default to undefined]
25
21
 
26
22
  ## Example
27
23
 
@@ -32,7 +28,6 @@ const instance: OrderSummaryDTO = {
32
28
  id,
33
29
  reference,
34
30
  invoiceNumber,
35
- invoiceId,
36
31
  orderDate,
37
32
  paid,
38
33
  complete,
@@ -42,9 +37,6 @@ const instance: OrderSummaryDTO = {
42
37
  items,
43
38
  carriageCharge,
44
39
  fulfillable,
45
- provisioningUrl,
46
- shippingService,
47
- readonly,
48
40
  };
49
41
  ```
50
42
 
@@ -13,7 +13,6 @@ Name | Type | Description | Notes
13
13
  **vatRate** | **number** | VAT Rate | [optional] [default to undefined]
14
14
  **credit** | **number** | Credit | [optional] [default to undefined]
15
15
  **currency** | **string** | Currency | [optional] [default to undefined]
16
- **delivery** | **number** | Delivery | [optional] [default to undefined]
17
16
 
18
17
  ## Example
19
18
 
@@ -28,7 +27,6 @@ const instance: OrderTotalModel = {
28
27
  vatRate,
29
28
  credit,
30
29
  currency,
31
- delivery,
32
30
  };
33
31
  ```
34
32