yellowgrid-api-ts 3.1.7 → 3.1.8-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 (55) hide show
  1. package/.openapi-generator/FILES +214 -197
  2. package/README.md +34 -7
  3. package/api.ts +1874 -251
  4. package/base.ts +1 -1
  5. package/common.ts +1 -1
  6. package/config.json +3 -3
  7. package/configuration.ts +1 -1
  8. package/dist/api.d.ts +1355 -146
  9. package/dist/api.js +1135 -197
  10. package/dist/base.d.ts +1 -1
  11. package/dist/base.js +1 -1
  12. package/dist/common.d.ts +1 -1
  13. package/dist/common.js +1 -1
  14. package/dist/configuration.d.ts +1 -1
  15. package/dist/configuration.js +1 -1
  16. package/dist/index.d.ts +1 -1
  17. package/dist/index.js +1 -1
  18. package/docs/AbstractOrderRequestDTO.md +33 -0
  19. package/docs/AccountDetailedSummaryDTO.md +39 -0
  20. package/docs/AccountsApi.md +103 -0
  21. package/docs/AddressModel.md +2 -0
  22. package/docs/AdminItemRequestDTO.md +41 -0
  23. package/docs/AdminOrderRequestDTO.md +45 -0
  24. package/docs/AdminUserModel.md +29 -0
  25. package/docs/BasicItemDTO.md +23 -0
  26. package/docs/BasicProductDTO.md +23 -0
  27. package/docs/Class3CXApi.md +0 -55
  28. package/docs/ClientDetailsModel.md +0 -2
  29. package/docs/CourierPriceEntity.md +39 -0
  30. package/docs/CustomerItemRequestDTO.md +37 -0
  31. package/docs/CustomerOrderRequestDTO.md +33 -0
  32. package/docs/ItemDTO.md +12 -4
  33. package/docs/ItemEntity.md +2 -0
  34. package/docs/LinkedOrderEntity.md +23 -0
  35. package/docs/OrderSummaryDTO.md +8 -0
  36. package/docs/OrderTotalModel.md +2 -0
  37. package/docs/OrdersApi.md +356 -4
  38. package/docs/PostGetProductForCustomerRequest.md +24 -0
  39. package/docs/ProductSearchResultsModel.md +1 -1
  40. package/docs/{ProductSummaryModel.md → ProductSummaryDTO.md} +5 -3
  41. package/docs/ProductsApi.md +164 -43
  42. package/docs/ProvisioningApi.md +4 -4
  43. package/docs/{ProvisioningEntity.md → ProvisioningModel.md} +3 -3
  44. package/docs/ShipmentEntity.md +2 -2
  45. package/docs/ShippingApi.md +63 -0
  46. package/docs/ShippingConsignmentModel.md +26 -0
  47. package/docs/ShippingInformationDTO.md +25 -0
  48. package/docs/ShippingServiceDTO.md +23 -0
  49. package/docs/ShippingServiceModel.md +31 -0
  50. package/docs/{GetGetPasswordHash200Response.md → ShippingServicesModel.md} +5 -5
  51. package/docs/StockManagementApi.md +2 -2
  52. package/docs/TcxSbcDTO.md +31 -0
  53. package/docs/TcxSbcModel.md +1 -1
  54. package/index.ts +1 -1
  55. package/package.json +1 -1
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
  *
@@ -0,0 +1,33 @@
1
+ # AbstractOrderRequestDTO
2
+
3
+ Order Request
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **orderReference** | **string** | Order Reference | [optional] [default to undefined]
10
+ **items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [optional] [default to undefined]
11
+ **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
12
+ **provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
13
+ **shippingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
14
+ **partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
15
+ **quote** | **boolean** | Quote | [optional] [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { AbstractOrderRequestDTO } from 'yellowgrid-api-ts';
21
+
22
+ const instance: AbstractOrderRequestDTO = {
23
+ orderReference,
24
+ items,
25
+ shippingService,
26
+ provisioningUrl,
27
+ shippingAddress,
28
+ partShip,
29
+ quote,
30
+ };
31
+ ```
32
+
33
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,39 @@
1
+ # AccountDetailedSummaryDTO
2
+
3
+ Account Details
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | ID | [optional] [default to undefined]
10
+ **xeroId** | **string** | Xero ID | [optional] [default to undefined]
11
+ **company** | **string** | Company | [optional] [default to undefined]
12
+ **creditLimit** | **number** | Credit Limit | [optional] [default to undefined]
13
+ **contacts** | [**Array<AccountContactModel>**](AccountContactModel.md) | Contacts | [optional] [default to undefined]
14
+ **billingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
15
+ **addresses** | [**Array<AddressModel>**](AddressModel.md) | Addresses | [optional] [default to undefined]
16
+ **provisioningUrls** | [**Array<ProvisioningModel>**](ProvisioningModel.md) | Provisioning URLs | [optional] [default to undefined]
17
+ **onHold** | **boolean** | On Hold | [optional] [default to undefined]
18
+ **balance** | **number** | Balance (£) | [optional] [default to undefined]
19
+
20
+ ## Example
21
+
22
+ ```typescript
23
+ import { AccountDetailedSummaryDTO } from 'yellowgrid-api-ts';
24
+
25
+ const instance: AccountDetailedSummaryDTO = {
26
+ id,
27
+ xeroId,
28
+ company,
29
+ creditLimit,
30
+ contacts,
31
+ billingAddress,
32
+ addresses,
33
+ provisioningUrls,
34
+ onHold,
35
+ balance,
36
+ };
37
+ ```
38
+
39
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -8,6 +8,7 @@ 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|
11
12
  |[**getGetAccounts**](#getgetaccounts) | **GET** /accounts | Get Accounts|
12
13
  |[**getGetClientCredentials**](#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials|
13
14
  |[**getGetCustomerKeys**](#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys|
@@ -16,6 +17,7 @@ All URIs are relative to *http://api.yellowgrid.local*
16
17
  |[**patchUpdateAccountContactPassword**](#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password|
17
18
  |[**postGetAccountContacts**](#postgetaccountcontacts) | **POST** /accounts/me/contacts | Add Account Contact|
18
19
  |[**postGetAccounts**](#postgetaccounts) | **POST** /accounts | Create new customer account|
20
+ |[**postGetAdminAccount**](#postgetadminaccount) | **POST** /admin/me | Get Admin Account|
19
21
  |[**postGetClientCredentials**](#postgetclientcredentials) | **POST** /accounts/me/contacts/credentials | Create client credentials|
20
22
  |[**postSendEmailVerificationEmail**](#postsendemailverificationemail) | **POST** /accounts/contacts/verify/{email} | Send email verification email|
21
23
  |[**postSendPasswordReset**](#postsendpasswordreset) | **POST** /accounts/contacts/password/reset | Send password reset email|
@@ -231,6 +233,60 @@ No authorization required
231
233
 
232
234
  [[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)
233
235
 
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
+
234
290
  # **getGetAccounts**
235
291
  > AccountsResponseModel getGetAccounts()
236
292
 
@@ -665,6 +721,53 @@ No authorization required
665
721
 
666
722
  [[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)
667
723
 
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
+
668
771
  # **postGetClientCredentials**
669
772
  > ClientModel postGetClientCredentials()
670
773
 
@@ -19,6 +19,7 @@ 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]
22
23
 
23
24
  ## Example
24
25
 
@@ -39,6 +40,7 @@ const instance: AddressModel = {
39
40
  postalCode,
40
41
  iso,
41
42
  company,
43
+ _default,
42
44
  };
43
45
  ```
44
46
 
@@ -0,0 +1,41 @@
1
+ # AdminItemRequestDTO
2
+
3
+ Admin Order Item Request
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **sku** | **string** | SKU | [optional] [default to undefined]
10
+ **quantity** | **number** | Quantity | [optional] [default to undefined]
11
+ **id** | **number** | ID | [optional] [default to undefined]
12
+ **licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
13
+ **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
14
+ **processDate** | **string** | Date Time | [optional] [default to undefined]
15
+ **tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
16
+ **sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCS | [optional] [default to undefined]
17
+ **readOnly** | **boolean** | Read Only (Cannot be edited) | [optional] [default to undefined]
18
+ **title** | **string** | Title | [optional] [default to undefined]
19
+ **itemPrice** | **number** | Price (£) | [optional] [default to undefined]
20
+
21
+ ## Example
22
+
23
+ ```typescript
24
+ import { AdminItemRequestDTO } from 'yellowgrid-api-ts';
25
+
26
+ const instance: AdminItemRequestDTO = {
27
+ sku,
28
+ quantity,
29
+ id,
30
+ licenceKey,
31
+ hosting,
32
+ processDate,
33
+ tcxSalesCode,
34
+ sbcs,
35
+ readOnly,
36
+ title,
37
+ itemPrice,
38
+ };
39
+ ```
40
+
41
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,45 @@
1
+ # AdminOrderRequestDTO
2
+
3
+ Admin Order Request
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **orderReference** | **string** | Order Reference | [optional] [default to undefined]
10
+ **items** | [**Array<AdminItemRequestDTO>**](AdminItemRequestDTO.md) | Items | [optional] [default to undefined]
11
+ **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
12
+ **provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
13
+ **shippingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
14
+ **partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
15
+ **quote** | **boolean** | Quote | [optional] [default to undefined]
16
+ **customerId** | **number** | Customer ID | [optional] [default to undefined]
17
+ **contact** | **string** | Contact | [optional] [default to undefined]
18
+ **ignoreOnHold** | **boolean** | Ignore Customer On Hold | [optional] [default to false]
19
+ **ignoreCreditLimit** | **boolean** | Ignore Customer Credit Limit | [optional] [default to false]
20
+ **includeNfrPromos** | **boolean** | Include NFR Promos | [optional] [default to false]
21
+ **carriageCharge** | **number** | Carriage Charge | [optional] [default to undefined]
22
+
23
+ ## Example
24
+
25
+ ```typescript
26
+ import { AdminOrderRequestDTO } from 'yellowgrid-api-ts';
27
+
28
+ const instance: AdminOrderRequestDTO = {
29
+ orderReference,
30
+ items,
31
+ shippingService,
32
+ provisioningUrl,
33
+ shippingAddress,
34
+ partShip,
35
+ quote,
36
+ customerId,
37
+ contact,
38
+ ignoreOnHold,
39
+ ignoreCreditLimit,
40
+ includeNfrPromos,
41
+ carriageCharge,
42
+ };
43
+ ```
44
+
45
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,29 @@
1
+ # AdminUserModel
2
+
3
+ Admin User
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **firstName** | **string** | First Name | [optional] [default to undefined]
10
+ **lastName** | **string** | Last Name | [optional] [default to undefined]
11
+ **avatar** | **string** | Avatar | [optional] [default to undefined]
12
+ **role** | **number** | Role | [optional] [default to undefined]
13
+ **email** | **string** | Email | [optional] [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { AdminUserModel } from 'yellowgrid-api-ts';
19
+
20
+ const instance: AdminUserModel = {
21
+ firstName,
22
+ lastName,
23
+ avatar,
24
+ role,
25
+ email,
26
+ };
27
+ ```
28
+
29
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,23 @@
1
+ # BasicItemDTO
2
+
3
+ Basic Order Item
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **sku** | **string** | SKU | [optional] [default to undefined]
10
+ **quantity** | **number** | Quantity | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { BasicItemDTO } from 'yellowgrid-api-ts';
16
+
17
+ const instance: BasicItemDTO = {
18
+ sku,
19
+ quantity,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,23 @@
1
+ # BasicProductDTO
2
+
3
+ Basic Product
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **sku** | **string** | SKU | [optional] [default to undefined]
10
+ **title** | **string** | Title | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { BasicProductDTO } from 'yellowgrid-api-ts';
16
+
17
+ const instance: BasicProductDTO = {
18
+ sku,
19
+ title,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -5,7 +5,6 @@ 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|
9
8
  |[**postGetBulkLicenceDetails**](#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details|
10
9
 
11
10
  # **getGetLicenceDetails**
@@ -62,60 +61,6 @@ No authorization required
62
61
 
63
62
  [[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)
64
63
 
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
-
119
64
  # **postGetBulkLicenceDetails**
120
65
  > TcxBulkLicenceDetailsModel postGetBulkLicenceDetails()
121
66
 
@@ -13,7 +13,6 @@ 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]
17
16
 
18
17
  ## Example
19
18
 
@@ -28,7 +27,6 @@ const instance: ClientDetailsModel = {
28
27
  xeroId,
29
28
  firstName,
30
29
  lastName,
31
- image,
32
30
  };
33
31
  ```
34
32
 
@@ -0,0 +1,39 @@
1
+ # CourierPriceEntity
2
+
3
+ CourierPricesEntity
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | id | [optional] [default to undefined]
10
+ **courier** | **string** | courier | [optional] [default to undefined]
11
+ **destinationIso** | **string** | destinationIso | [optional] [default to undefined]
12
+ **serviceDescription** | **string** | serviceDescription | [optional] [default to undefined]
13
+ **flatRate** | **number** | flatRate | [optional] [default to undefined]
14
+ **initialBox** | **number** | initialBox | [optional] [default to undefined]
15
+ **initialKg** | **number** | initialKg | [optional] [default to undefined]
16
+ **perBox** | **number** | perBox | [optional] [default to undefined]
17
+ **perKg** | **number** | perKg | [optional] [default to undefined]
18
+ **maxKg** | **number** | maxKg | [optional] [default to undefined]
19
+
20
+ ## Example
21
+
22
+ ```typescript
23
+ import { CourierPriceEntity } from 'yellowgrid-api-ts';
24
+
25
+ const instance: CourierPriceEntity = {
26
+ id,
27
+ courier,
28
+ destinationIso,
29
+ serviceDescription,
30
+ flatRate,
31
+ initialBox,
32
+ initialKg,
33
+ perBox,
34
+ perKg,
35
+ maxKg,
36
+ };
37
+ ```
38
+
39
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,37 @@
1
+ # CustomerItemRequestDTO
2
+
3
+ Order Item Request
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **sku** | **string** | SKU | [optional] [default to undefined]
10
+ **quantity** | **number** | Quantity | [optional] [default to undefined]
11
+ **id** | **number** | ID | [optional] [default to undefined]
12
+ **licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
13
+ **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
14
+ **processDate** | **string** | Date Time | [optional] [default to undefined]
15
+ **tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
16
+ **sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCS | [optional] [default to undefined]
17
+ **readOnly** | **boolean** | Read Only (Cannot be edited) | [optional] [default to undefined]
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ import { CustomerItemRequestDTO } from 'yellowgrid-api-ts';
23
+
24
+ const instance: CustomerItemRequestDTO = {
25
+ sku,
26
+ quantity,
27
+ id,
28
+ licenceKey,
29
+ hosting,
30
+ processDate,
31
+ tcxSalesCode,
32
+ sbcs,
33
+ readOnly,
34
+ };
35
+ ```
36
+
37
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)