yellowgrid-api-ts 3.2.170-dev.0 → 3.2.171-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 (44) hide show
  1. package/.openapi-generator/FILES +25 -3
  2. package/README.md +54 -3
  3. package/api.ts +3303 -464
  4. package/dist/api.d.ts +1951 -213
  5. package/dist/api.js +2693 -273
  6. package/docs/AbstractItemDiscountModel.md +21 -0
  7. package/docs/AccountAddressesDTO.md +25 -0
  8. package/docs/AccountFinanceDTO.md +37 -0
  9. package/docs/AccountsApi.md +1427 -53
  10. package/docs/AddressDTO.md +31 -0
  11. package/docs/AdminUserModel.md +2 -0
  12. package/docs/CRMApi.md +120 -0
  13. package/docs/Class3CXApi.md +48 -0
  14. package/docs/Class3CXInstallationsApi.md +55 -0
  15. package/docs/CreateCrmNoteBody.md +20 -0
  16. package/docs/CreditAccountEntity.md +4 -0
  17. package/docs/CrmActivitiesResponseDTO.md +23 -0
  18. package/docs/CrmActivityDTO.md +33 -0
  19. package/docs/CrmDateActivitiesDTO.md +23 -0
  20. package/docs/CrmNoteEntity.md +39 -0
  21. package/docs/CrmNoteModel.md +39 -0
  22. package/docs/CustomerListAccountDTO.md +45 -0
  23. package/docs/NumberPortAdminNoteBody.md +20 -0
  24. package/docs/NumberPortingApi.md +5 -5
  25. package/docs/OAuth20Api.md +48 -0
  26. package/docs/PartnerDTO.md +39 -0
  27. package/docs/PatchUpdateAccountCnameRequest.md +20 -0
  28. package/docs/PatchUpdateAccountCompanyNumberRequest.md +20 -0
  29. package/docs/PatchUpdateAccountPhoneRequest.md +20 -0
  30. package/docs/PatchUpdateAccountVatNumberRequest.md +20 -0
  31. package/docs/PatchUpdateCreditLimitRequest.md +20 -0
  32. package/docs/PatchUpdatePriceListRequest.md +20 -0
  33. package/docs/PatchUpdateSipChannelCostRequest.md +20 -0
  34. package/docs/PatchUpdateTcxHostingPriceListRequest.md +20 -0
  35. package/docs/PatchUpdateTcxPartnerIdRequest.md +20 -0
  36. package/docs/PortalAccountModel.md +4 -2
  37. package/docs/PostSendWelcomeEmailRequest.md +20 -0
  38. package/docs/ProductSearchDTO.md +37 -0
  39. package/docs/ProductSummaryDTO.md +2 -0
  40. package/docs/ProductsApi.md +10 -10
  41. package/docs/ProspectDTO.md +2 -0
  42. package/docs/RecordingBackupAzureModel.md +2 -0
  43. package/docs/TableHistoryEntity.md +35 -0
  44. package/package.json +1 -1
@@ -0,0 +1,39 @@
1
+ # PartnerDTO
2
+
3
+ 3CX Partner Details
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **partnerId** | **string** | 3CX Partner ID | [optional] [default to undefined]
10
+ **companyName** | **string** | 3CX Partner Company Name | [optional] [default to undefined]
11
+ **contactName** | **string** | 3CX Partner Contact Name | [optional] [default to undefined]
12
+ **contactPhone** | **string** | 3CX Partner Contact Phone | [optional] [default to undefined]
13
+ **contactEmail** | **string** | 3CX Partner Contact Email | [optional] [default to undefined]
14
+ **partnerLevel** | **string** | 3CX Partner Level | [optional] [default to undefined]
15
+ **licenceDiscountPercent** | **number** | 3CX Partner Licence Discount Percent | [optional] [default to undefined]
16
+ **hostingDisountPercent** | **number** | 3CX Partner Hosting Discount Percent | [optional] [default to undefined]
17
+ **hostingPriceListId** | **number** | 3CX Hosting Price List ID | [optional] [default to undefined]
18
+ **installationUrl** | **string** | 3CX Installation URL | [optional] [default to undefined]
19
+
20
+ ## Example
21
+
22
+ ```typescript
23
+ import { PartnerDTO } from 'yellowgrid-api-ts';
24
+
25
+ const instance: PartnerDTO = {
26
+ partnerId,
27
+ companyName,
28
+ contactName,
29
+ contactPhone,
30
+ contactEmail,
31
+ partnerLevel,
32
+ licenceDiscountPercent,
33
+ hostingDisountPercent,
34
+ hostingPriceListId,
35
+ installationUrl,
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,20 @@
1
+ # PatchUpdateAccountCnameRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **cname** | **string** | CNAME | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PatchUpdateAccountCnameRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PatchUpdateAccountCnameRequest = {
16
+ cname,
17
+ };
18
+ ```
19
+
20
+ [[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,20 @@
1
+ # PatchUpdateAccountCompanyNumberRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **companyNumber** | **string** | Company Number | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PatchUpdateAccountCompanyNumberRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PatchUpdateAccountCompanyNumberRequest = {
16
+ companyNumber,
17
+ };
18
+ ```
19
+
20
+ [[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,20 @@
1
+ # PatchUpdateAccountPhoneRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **phone** | **string** | Phone | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PatchUpdateAccountPhoneRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PatchUpdateAccountPhoneRequest = {
16
+ phone,
17
+ };
18
+ ```
19
+
20
+ [[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,20 @@
1
+ # PatchUpdateAccountVatNumberRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **vatNumber** | **string** | VAT Number | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PatchUpdateAccountVatNumberRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PatchUpdateAccountVatNumberRequest = {
16
+ vatNumber,
17
+ };
18
+ ```
19
+
20
+ [[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,20 @@
1
+ # PatchUpdateCreditLimitRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **creditLimit** | **number** | Credit Limit | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PatchUpdateCreditLimitRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PatchUpdateCreditLimitRequest = {
16
+ creditLimit,
17
+ };
18
+ ```
19
+
20
+ [[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,20 @@
1
+ # PatchUpdatePriceListRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **priceList** | **string** | Price List | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PatchUpdatePriceListRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PatchUpdatePriceListRequest = {
16
+ priceList,
17
+ };
18
+ ```
19
+
20
+ [[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,20 @@
1
+ # PatchUpdateSipChannelCostRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **channelCost** | **number** | SIP Channel Cost | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PatchUpdateSipChannelCostRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PatchUpdateSipChannelCostRequest = {
16
+ channelCost,
17
+ };
18
+ ```
19
+
20
+ [[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,20 @@
1
+ # PatchUpdateTcxHostingPriceListRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **priceList** | **string** | Price List | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PatchUpdateTcxHostingPriceListRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PatchUpdateTcxHostingPriceListRequest = {
16
+ priceList,
17
+ };
18
+ ```
19
+
20
+ [[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,20 @@
1
+ # PatchUpdateTcxPartnerIdRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **partnerId** | **string** | Set Account 3CX Partner ID | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PatchUpdateTcxPartnerIdRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PatchUpdateTcxPartnerIdRequest = {
16
+ partnerId,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -27,9 +27,10 @@ Name | Type | Description | Notes
27
27
  **resellerId** | **string** | 3CX Reseller ID | [optional] [default to undefined]
28
28
  **creationDate** | **string** | Creation Date | [optional] [default to undefined]
29
29
  **prizePromo** | **boolean** | Prize Promo Enabled | [optional] [default to undefined]
30
+ **portalAccess** | **boolean** | Portal Access | [optional] [default to undefined]
31
+ **cname** | **string** | Wizard CNAME | [optional] [default to undefined]
30
32
  **directDebitMandate** | **boolean** | Active Direct Debit Mandate | [optional] [default to undefined]
31
33
  **navigation** | [**Array<NavigationModel>**](NavigationModel.md) | Portal Navigation | [optional] [default to undefined]
32
- **cname** | **string** | Wizard CNAME | [optional] [default to undefined]
33
34
 
34
35
  ## Example
35
36
 
@@ -58,9 +59,10 @@ const instance: PortalAccountModel = {
58
59
  resellerId,
59
60
  creationDate,
60
61
  prizePromo,
62
+ portalAccess,
63
+ cname,
61
64
  directDebitMandate,
62
65
  navigation,
63
- cname,
64
66
  };
65
67
  ```
66
68
 
@@ -0,0 +1,20 @@
1
+ # PostSendWelcomeEmailRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **email** | **string** | email | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PostSendWelcomeEmailRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PostSendWelcomeEmailRequest = {
16
+ email,
17
+ };
18
+ ```
19
+
20
+ [[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
+ # ProductSearchDTO
2
+
3
+ Product Search
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
+ **licenceKey** | **string** | Licence Key | [optional] [default to undefined]
12
+ **hosting** | **boolean** | Hosting | [optional] [default to undefined]
13
+ **tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
14
+ **renewalYears** | **number** | 3CX Renewal Years | [optional] [default to undefined]
15
+ **orderId** | **number** | Order ID | [optional] [default to undefined]
16
+ **items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [optional] [default to undefined]
17
+ **discount** | **number** | Discount | [optional] [default to undefined]
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ import { ProductSearchDTO } from 'yellowgrid-api-ts';
23
+
24
+ const instance: ProductSearchDTO = {
25
+ sku,
26
+ quantity,
27
+ licenceKey,
28
+ hosting,
29
+ tcxSalesCode,
30
+ renewalYears,
31
+ orderId,
32
+ items,
33
+ discount,
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)
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
16
16
  **rrp** | **number** | RRP Price | [optional] [default to undefined]
17
17
  **licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) | | [optional] [default to undefined]
18
18
  **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
19
+ **discounts** | [**Array<AbstractItemDiscountModel>**](AbstractItemDiscountModel.md) | Applied Discounts | [optional] [default to undefined]
19
20
 
20
21
  ## Example
21
22
 
@@ -33,6 +34,7 @@ const instance: ProductSummaryDTO = {
33
34
  rrp,
34
35
  licenceDetails,
35
36
  hosting,
37
+ discounts,
36
38
  };
37
39
  ```
38
40
 
@@ -422,7 +422,7 @@ No authorization required
422
422
  [[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)
423
423
 
424
424
  # **postGetProduct**
425
- > ProductSummaryDTO postGetProduct(postGetProductForCustomerRequest)
425
+ > ProductSummaryDTO postGetProduct()
426
426
 
427
427
  Get Product
428
428
 
@@ -432,18 +432,18 @@ Get Product
432
432
  import {
433
433
  ProductsApi,
434
434
  Configuration,
435
- PostGetProductForCustomerRequest
435
+ ProductSearchDTO
436
436
  } from 'yellowgrid-api-ts';
437
437
 
438
438
  const configuration = new Configuration();
439
439
  const apiInstance = new ProductsApi(configuration);
440
440
 
441
441
  let sku: string; //Product SKU (default to undefined)
442
- let postGetProductForCustomerRequest: PostGetProductForCustomerRequest; //Product search criteria
442
+ let productSearchDTO: ProductSearchDTO; //Product Search Info (optional)
443
443
 
444
444
  const { status, data } = await apiInstance.postGetProduct(
445
445
  sku,
446
- postGetProductForCustomerRequest
446
+ productSearchDTO
447
447
  );
448
448
  ```
449
449
 
@@ -451,7 +451,7 @@ const { status, data } = await apiInstance.postGetProduct(
451
451
 
452
452
  |Name | Type | Description | Notes|
453
453
  |------------- | ------------- | ------------- | -------------|
454
- | **postGetProductForCustomerRequest** | **PostGetProductForCustomerRequest**| Product search criteria | |
454
+ | **productSearchDTO** | **ProductSearchDTO**| Product Search Info | |
455
455
  | **sku** | [**string**] | Product SKU | defaults to undefined|
456
456
 
457
457
 
@@ -480,7 +480,7 @@ No authorization required
480
480
  [[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)
481
481
 
482
482
  # **postGetProductForCustomer**
483
- > ProductSummaryDTO postGetProductForCustomer(postGetProductForCustomerRequest)
483
+ > ProductSummaryDTO postGetProductForCustomer()
484
484
 
485
485
  Get Product For Customer
486
486
 
@@ -490,7 +490,7 @@ Get Product For Customer
490
490
  import {
491
491
  ProductsApi,
492
492
  Configuration,
493
- PostGetProductForCustomerRequest
493
+ ProductSearchDTO
494
494
  } from 'yellowgrid-api-ts';
495
495
 
496
496
  const configuration = new Configuration();
@@ -498,12 +498,12 @@ const apiInstance = new ProductsApi(configuration);
498
498
 
499
499
  let customerId: number; //Customer ID (default to undefined)
500
500
  let sku: string; //Product SKU (default to undefined)
501
- let postGetProductForCustomerRequest: PostGetProductForCustomerRequest; //Product search criteria
501
+ let productSearchDTO: ProductSearchDTO; //Product Search Info (optional)
502
502
 
503
503
  const { status, data } = await apiInstance.postGetProductForCustomer(
504
504
  customerId,
505
505
  sku,
506
- postGetProductForCustomerRequest
506
+ productSearchDTO
507
507
  );
508
508
  ```
509
509
 
@@ -511,7 +511,7 @@ const { status, data } = await apiInstance.postGetProductForCustomer(
511
511
 
512
512
  |Name | Type | Description | Notes|
513
513
  |------------- | ------------- | ------------- | -------------|
514
- | **postGetProductForCustomerRequest** | **PostGetProductForCustomerRequest**| Product search criteria | |
514
+ | **productSearchDTO** | **ProductSearchDTO**| Product Search Info | |
515
515
  | **customerId** | [**number**] | Customer ID | defaults to undefined|
516
516
  | **sku** | [**string**] | Product SKU | defaults to undefined|
517
517
 
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
13
13
  **xeroId** | **string** | Xero ID | [optional] [default to undefined]
14
14
  **removed** | **boolean** | Removed From Prospects | [optional] [default to undefined]
15
15
  **status** | **string** | Status | [optional] [default to undefined]
16
+ **orderCount** | **number** | Order Count | [optional] [default to undefined]
16
17
 
17
18
  ## Example
18
19
 
@@ -27,6 +28,7 @@ const instance: ProspectDTO = {
27
28
  xeroId,
28
29
  removed,
29
30
  status,
31
+ orderCount,
30
32
  };
31
33
  ```
32
34
 
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
9
9
  **name** | **string** | Storage Account Name | [optional] [default to undefined]
10
10
  **key** | **string** | Storage Account Key | [optional] [default to undefined]
11
11
  **connection_string** | **string** | Storage Account Connection String | [optional] [default to undefined]
12
+ **sasUrl** | **string** | SAS Url | [optional] [default to undefined]
12
13
  **recordings_path** | **string** | Recordings Path | [optional] [default to undefined]
13
14
 
14
15
  ## Example
@@ -20,6 +21,7 @@ const instance: RecordingBackupAzureModel = {
20
21
  name,
21
22
  key,
22
23
  connection_string,
24
+ sasUrl,
23
25
  recordings_path,
24
26
  };
25
27
  ```
@@ -0,0 +1,35 @@
1
+ # TableHistoryEntity
2
+
3
+ TableAttribsEntity
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **ownerId** | **string** | ownerId | [optional] [default to undefined]
10
+ **dbTable** | **string** | table | [optional] [default to undefined]
11
+ **orderingField** | **string** | orderingField | [optional] [default to undefined]
12
+ **asc** | **number** | asc | [optional] [default to undefined]
13
+ **perPage** | **number** | perPage | [optional] [default to undefined]
14
+ **currPage** | **number** | currPage | [optional] [default to undefined]
15
+ **filter** | **string** | filter | [optional] [default to undefined]
16
+ **page** | **number** | page | [optional] [default to undefined]
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import { TableHistoryEntity } from 'yellowgrid-api-ts';
22
+
23
+ const instance: TableHistoryEntity = {
24
+ ownerId,
25
+ dbTable,
26
+ orderingField,
27
+ asc,
28
+ perPage,
29
+ currPage,
30
+ filter,
31
+ page,
32
+ };
33
+ ```
34
+
35
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.2.170-dev.0",
3
+ "version": "3.2.171-dev.0",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {