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

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 (59) hide show
  1. package/.openapi-generator/FILES +264 -261
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +12 -2
  4. package/api.ts +977 -4827
  5. package/base.ts +2 -26
  6. package/common.ts +16 -39
  7. package/config.json +3 -3
  8. package/configuration.ts +25 -19
  9. package/dist/api.d.ts +390 -4420
  10. package/dist/api.js +933 -485
  11. package/dist/base.d.ts +1 -25
  12. package/dist/base.js +2 -21
  13. package/dist/common.d.ts +5 -36
  14. package/dist/common.js +17 -39
  15. package/dist/configuration.d.ts +25 -18
  16. package/dist/configuration.js +2 -2
  17. package/dist/index.d.ts +1 -1
  18. package/dist/index.js +1 -1
  19. package/dist/models/ScheduledTaskEnum.d.ts +33 -0
  20. package/dist/models/ScheduledTaskEnum.js +35 -0
  21. package/docs/AccountsApi.md +1 -1
  22. package/docs/CRMApi.md +1 -1
  23. package/docs/Class3CXApi.md +1 -1
  24. package/docs/Class3CXInstallationWizardApi.md +1 -1
  25. package/docs/Class3CXInstallationsApi.md +348 -5
  26. package/docs/Class3CXIntegrationsApi.md +1 -1
  27. package/docs/Class3CXMultiTenantApi.md +1 -1
  28. package/docs/InstallationDetailsDTO.md +39 -0
  29. package/docs/MyPBXToolsApi.md +1 -1
  30. package/docs/NumberPortingApi.md +1 -1
  31. package/docs/OAuth20Api.md +1 -1
  32. package/docs/OrdersApi.md +122 -2
  33. package/docs/PricingApi.md +1 -1
  34. package/docs/ProductSummaryDTO.md +2 -0
  35. package/docs/ProductsApi.md +1 -1
  36. package/docs/ProvisioningApi.md +1 -1
  37. package/docs/RemoteStorageDTO.md +27 -0
  38. package/docs/SIPTrunksApi.md +1 -1
  39. package/docs/SMSApi.md +1 -1
  40. package/docs/ServicesApi.md +1 -1
  41. package/docs/ShippingApi.md +1 -1
  42. package/docs/StockManagementApi.md +1 -1
  43. package/docs/SystemApi.md +1 -1
  44. package/docs/TcxSbcDTO.md +4 -0
  45. package/docs/TcxSbcResponseDTO.md +23 -0
  46. package/docs/TicketsApi.md +1 -1
  47. package/docs/WebhooksApi.md +1 -1
  48. package/getEnums.php +31 -31
  49. package/index.ts +1 -1
  50. package/models/ScheduledTaskEnum.ts +34 -0
  51. package/openapitools.json +1 -1
  52. package/package.json +2 -2
  53. package/docs/NumberPortModel.md +0 -51
  54. package/docs/TcxInstallationDetailsModel.md +0 -45
  55. package/docs/TelephonySupportTicketModel.md +0 -41
  56. package/hs_err_pid16044.log +0 -249
  57. package/hs_err_pid44560.log +0 -249
  58. package/hs_err_pid53988.log +0 -249
  59. package/hs_err_pid58728.log +0 -40
@@ -1,25 +1,31 @@
1
1
  # Class3CXInstallationsApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**getGetDetails**](#getgetdetails) | **GET** /tcx/installations/{wizard_id}/details | Get 3CX Installation Details|
8
8
  |[**getGetInstallations**](#getgetinstallations) | **GET** /tcx/installations | Get 3CX Installations|
9
+ |[**patchChangeInstanceOwner**](#patchchangeinstanceowner) | **PATCH** /tcx/installations/{instance_id}/owner | Change instance owner|
9
10
  |[**patchUpdateAutoFailover**](#patchupdateautofailover) | **PATCH** /tcx/installations/{instance_id}/failover/auto | Update 3CX Instance Auto Failover|
10
11
  |[**postAddDisk**](#postadddisk) | **POST** /tcx/installations/{instance_id}/disk | Add additional disk on 3CX Instance|
11
12
  |[**postCreateSshUser**](#postcreatesshuser) | **POST** /tcx/installations/{instance_id}/create/user/root | Create a root user|
12
13
  |[**postDeleteInstance**](#postdeleteinstance) | **POST** /tcx/installations/{instance_id}/delete | Delete 3CX Instance|
13
14
  |[**postExtendDisk**](#postextenddisk) | **POST** /tcx/installations/{instance_id}/disk/extend | Extend additional disk on 3CX Instance|
14
15
  |[**postFailoverInstance**](#postfailoverinstance) | **POST** /tcx/installations/{instance_id}/failover | Failover 3CX Instance|
16
+ |[**postInstallTcxSbc**](#postinstalltcxsbc) | **POST** /tcx/installations/sbcs/{sbc_id}/install | Install 3CX SBC|
15
17
  |[**postRebootInstance**](#postrebootinstance) | **POST** /tcx/installations/{instance_id}/reboot | Reboot 3CX Instance|
16
18
  |[**postResizeInstance**](#postresizeinstance) | **POST** /tcx/installations/{instance_id}/resize | Resize 3CX Instance|
19
+ |[**postRestartServices**](#postrestartservices) | **POST** /tcx/installations/{instance_id}/services/restart | Restart 3CX Services|
20
+ |[**postScheduledReboot**](#postscheduledreboot) | **POST** /tcx/installations/{instance_id}/reboot/scheduled | Reboot Instance|
17
21
  |[**postSuspendInstance**](#postsuspendinstance) | **POST** /tcx/installations/{instance_id}/suspend | Suspend 3CX Instance|
22
+ |[**postTestLoginCredentials**](#posttestlogincredentials) | **POST** /tcx/installations/{instance_id}/tests/login | Test 3CX Login Credentials|
18
23
  |[**postUnsuspendInstance**](#postunsuspendinstance) | **POST** /tcx/installations/{instance_id}/unsuspend | Unsuspend 3CX Instance|
19
24
  |[**postUpgradeDebian**](#postupgradedebian) | **POST** /tcx/installations/{instance_id}/debian/upgrade | Install OS update on 3CX Instance|
25
+ |[**putGetDetails**](#putgetdetails) | **PUT** /tcx/installations/{wizard_id}/details | Update 3CX Installation Details|
20
26
 
21
27
  # **getGetDetails**
22
- > TcxInstallationDetailsModel getGetDetails()
28
+ > InstallationDetailsDTO getGetDetails()
23
29
 
24
30
  Get 3CX Installation Details
25
31
 
@@ -50,7 +56,7 @@ const { status, data } = await apiInstance.getGetDetails(
50
56
 
51
57
  ### Return type
52
58
 
53
- **TcxInstallationDetailsModel**
59
+ **InstallationDetailsDTO**
54
60
 
55
61
  ### Authorization
56
62
 
@@ -144,6 +150,63 @@ No authorization required
144
150
 
145
151
  [[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)
146
152
 
153
+ # **patchChangeInstanceOwner**
154
+ > patchChangeInstanceOwner()
155
+
156
+ Change instance owner
157
+
158
+ ### Example
159
+
160
+ ```typescript
161
+ import {
162
+ Class3CXInstallationsApi,
163
+ Configuration
164
+ } from 'yellowgrid-api-ts';
165
+
166
+ const configuration = new Configuration();
167
+ const apiInstance = new Class3CXInstallationsApi(configuration);
168
+
169
+ let instanceId: string; //Instance ID (default to undefined)
170
+ let customerId: number; //Customer ID (default to undefined)
171
+
172
+ const { status, data } = await apiInstance.patchChangeInstanceOwner(
173
+ instanceId,
174
+ customerId
175
+ );
176
+ ```
177
+
178
+ ### Parameters
179
+
180
+ |Name | Type | Description | Notes|
181
+ |------------- | ------------- | ------------- | -------------|
182
+ | **instanceId** | [**string**] | Instance ID | defaults to undefined|
183
+ | **customerId** | [**number**] | Customer ID | defaults to undefined|
184
+
185
+
186
+ ### Return type
187
+
188
+ void (empty response body)
189
+
190
+ ### Authorization
191
+
192
+ No authorization required
193
+
194
+ ### HTTP request headers
195
+
196
+ - **Content-Type**: Not defined
197
+ - **Accept**: Not defined
198
+
199
+
200
+ ### HTTP response details
201
+ | Status code | Description | Response headers |
202
+ |-------------|-------------|------------------|
203
+ |**200** | No Response | - |
204
+ |**400** | Bad Request | - |
205
+ |**401** | Unauthorised | - |
206
+ |**403** | Access Denied | - |
207
+
208
+ [[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)
209
+
147
210
  # **patchUpdateAutoFailover**
148
211
  > patchUpdateAutoFailover()
149
212
 
@@ -387,7 +450,7 @@ const apiInstance = new Class3CXInstallationsApi(configuration);
387
450
 
388
451
  let instanceId: string; //Instance ID (default to undefined)
389
452
  let gigabytes: number; //Disk Space (GB) (default to undefined)
390
- let schedule: string; //Scheduled Task (Date & Time) (default to undefined)
453
+ let schedule: string; //Scheduled Task (Date & Time) (optional) (default to undefined)
391
454
 
392
455
  const { status, data } = await apiInstance.postExtendDisk(
393
456
  instanceId,
@@ -402,7 +465,7 @@ const { status, data } = await apiInstance.postExtendDisk(
402
465
  |------------- | ------------- | ------------- | -------------|
403
466
  | **instanceId** | [**string**] | Instance ID | defaults to undefined|
404
467
  | **gigabytes** | [**number**] | Disk Space (GB) | defaults to undefined|
405
- | **schedule** | [**string**] | Scheduled Task (Date & Time) | defaults to undefined|
468
+ | **schedule** | [**string**] | Scheduled Task (Date & Time) | (optional) defaults to undefined|
406
469
 
407
470
 
408
471
  ### Return type
@@ -486,6 +549,60 @@ No authorization required
486
549
 
487
550
  [[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)
488
551
 
552
+ # **postInstallTcxSbc**
553
+ > TcxSbcResponseDTO postInstallTcxSbc()
554
+
555
+ Install 3CX SBC
556
+
557
+ ### Example
558
+
559
+ ```typescript
560
+ import {
561
+ Class3CXInstallationsApi,
562
+ Configuration
563
+ } from 'yellowgrid-api-ts';
564
+
565
+ const configuration = new Configuration();
566
+ const apiInstance = new Class3CXInstallationsApi(configuration);
567
+
568
+ let sbcId: number; //SBC ID (default to undefined)
569
+
570
+ const { status, data } = await apiInstance.postInstallTcxSbc(
571
+ sbcId
572
+ );
573
+ ```
574
+
575
+ ### Parameters
576
+
577
+ |Name | Type | Description | Notes|
578
+ |------------- | ------------- | ------------- | -------------|
579
+ | **sbcId** | [**number**] | SBC ID | defaults to undefined|
580
+
581
+
582
+ ### Return type
583
+
584
+ **TcxSbcResponseDTO**
585
+
586
+ ### Authorization
587
+
588
+ No authorization required
589
+
590
+ ### HTTP request headers
591
+
592
+ - **Content-Type**: Not defined
593
+ - **Accept**: application/json
594
+
595
+
596
+ ### HTTP response details
597
+ | Status code | Description | Response headers |
598
+ |-------------|-------------|------------------|
599
+ |**200** | 3CX SBC Install Response | - |
600
+ |**400** | Bad Request | - |
601
+ |**401** | Unauthorised | - |
602
+ |**403** | Access Denied | - |
603
+
604
+ [[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)
605
+
489
606
  # **postRebootInstance**
490
607
  > postRebootInstance()
491
608
 
@@ -576,6 +693,120 @@ const { status, data } = await apiInstance.postResizeInstance(
576
693
  | **schedule** | [**string**] | Scheduled Task (Date & Time) | (optional) defaults to undefined|
577
694
 
578
695
 
696
+ ### Return type
697
+
698
+ void (empty response body)
699
+
700
+ ### Authorization
701
+
702
+ No authorization required
703
+
704
+ ### HTTP request headers
705
+
706
+ - **Content-Type**: Not defined
707
+ - **Accept**: Not defined
708
+
709
+
710
+ ### HTTP response details
711
+ | Status code | Description | Response headers |
712
+ |-------------|-------------|------------------|
713
+ |**200** | No Response | - |
714
+ |**400** | Bad Request | - |
715
+ |**401** | Unauthorised | - |
716
+ |**403** | Access Denied | - |
717
+
718
+ [[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)
719
+
720
+ # **postRestartServices**
721
+ > postRestartServices()
722
+
723
+ Restart 3CX Services
724
+
725
+ ### Example
726
+
727
+ ```typescript
728
+ import {
729
+ Class3CXInstallationsApi,
730
+ Configuration
731
+ } from 'yellowgrid-api-ts';
732
+
733
+ const configuration = new Configuration();
734
+ const apiInstance = new Class3CXInstallationsApi(configuration);
735
+
736
+ let instanceId: string; //Instance ID (default to undefined)
737
+ let schedule: string; //Scheduled Task (Date & Time) (optional) (default to undefined)
738
+
739
+ const { status, data } = await apiInstance.postRestartServices(
740
+ instanceId,
741
+ schedule
742
+ );
743
+ ```
744
+
745
+ ### Parameters
746
+
747
+ |Name | Type | Description | Notes|
748
+ |------------- | ------------- | ------------- | -------------|
749
+ | **instanceId** | [**string**] | Instance ID | defaults to undefined|
750
+ | **schedule** | [**string**] | Scheduled Task (Date & Time) | (optional) defaults to undefined|
751
+
752
+
753
+ ### Return type
754
+
755
+ void (empty response body)
756
+
757
+ ### Authorization
758
+
759
+ No authorization required
760
+
761
+ ### HTTP request headers
762
+
763
+ - **Content-Type**: Not defined
764
+ - **Accept**: Not defined
765
+
766
+
767
+ ### HTTP response details
768
+ | Status code | Description | Response headers |
769
+ |-------------|-------------|------------------|
770
+ |**200** | No Response | - |
771
+ |**400** | Bad Request | - |
772
+ |**401** | Unauthorised | - |
773
+ |**403** | Access Denied | - |
774
+
775
+ [[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)
776
+
777
+ # **postScheduledReboot**
778
+ > postScheduledReboot()
779
+
780
+ Reboot Instance
781
+
782
+ ### Example
783
+
784
+ ```typescript
785
+ import {
786
+ Class3CXInstallationsApi,
787
+ Configuration
788
+ } from 'yellowgrid-api-ts';
789
+
790
+ const configuration = new Configuration();
791
+ const apiInstance = new Class3CXInstallationsApi(configuration);
792
+
793
+ let instanceId: string; //Instance ID (default to undefined)
794
+ let schedule: string; //Scheduled Task (Date & Time) (optional) (default to undefined)
795
+
796
+ const { status, data } = await apiInstance.postScheduledReboot(
797
+ instanceId,
798
+ schedule
799
+ );
800
+ ```
801
+
802
+ ### Parameters
803
+
804
+ |Name | Type | Description | Notes|
805
+ |------------- | ------------- | ------------- | -------------|
806
+ | **instanceId** | [**string**] | Instance ID | defaults to undefined|
807
+ | **schedule** | [**string**] | Scheduled Task (Date & Time) | (optional) defaults to undefined|
808
+
809
+
579
810
  ### Return type
580
811
 
581
812
  void (empty response body)
@@ -633,6 +864,60 @@ const { status, data } = await apiInstance.postSuspendInstance(
633
864
  | **schedule** | [**string**] | Scheduled Task (Date & Time) | (optional) defaults to undefined|
634
865
 
635
866
 
867
+ ### Return type
868
+
869
+ void (empty response body)
870
+
871
+ ### Authorization
872
+
873
+ No authorization required
874
+
875
+ ### HTTP request headers
876
+
877
+ - **Content-Type**: Not defined
878
+ - **Accept**: Not defined
879
+
880
+
881
+ ### HTTP response details
882
+ | Status code | Description | Response headers |
883
+ |-------------|-------------|------------------|
884
+ |**200** | No Response | - |
885
+ |**400** | Bad Request | - |
886
+ |**401** | Unauthorised | - |
887
+ |**403** | Access Denied | - |
888
+
889
+ [[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)
890
+
891
+ # **postTestLoginCredentials**
892
+ > postTestLoginCredentials()
893
+
894
+ Test 3CX Login Credentials
895
+
896
+ ### Example
897
+
898
+ ```typescript
899
+ import {
900
+ Class3CXInstallationsApi,
901
+ Configuration
902
+ } from 'yellowgrid-api-ts';
903
+
904
+ const configuration = new Configuration();
905
+ const apiInstance = new Class3CXInstallationsApi(configuration);
906
+
907
+ let instanceId: string; //Instance ID (default to undefined)
908
+
909
+ const { status, data } = await apiInstance.postTestLoginCredentials(
910
+ instanceId
911
+ );
912
+ ```
913
+
914
+ ### Parameters
915
+
916
+ |Name | Type | Description | Notes|
917
+ |------------- | ------------- | ------------- | -------------|
918
+ | **instanceId** | [**string**] | Instance ID | defaults to undefined|
919
+
920
+
636
921
  ### Return type
637
922
 
638
923
  void (empty response body)
@@ -768,3 +1053,61 @@ No authorization required
768
1053
 
769
1054
  [[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
1055
 
1056
+ # **putGetDetails**
1057
+ > InstallationDetailsDTO putGetDetails()
1058
+
1059
+ Update 3CX Installation Details
1060
+
1061
+ ### Example
1062
+
1063
+ ```typescript
1064
+ import {
1065
+ Class3CXInstallationsApi,
1066
+ Configuration,
1067
+ InstallationDetailsDTO
1068
+ } from 'yellowgrid-api-ts';
1069
+
1070
+ const configuration = new Configuration();
1071
+ const apiInstance = new Class3CXInstallationsApi(configuration);
1072
+
1073
+ let wizardId: number; //Wizard ID (default to undefined)
1074
+ let installationDetailsDTO: InstallationDetailsDTO; //Installation Details (optional)
1075
+
1076
+ const { status, data } = await apiInstance.putGetDetails(
1077
+ wizardId,
1078
+ installationDetailsDTO
1079
+ );
1080
+ ```
1081
+
1082
+ ### Parameters
1083
+
1084
+ |Name | Type | Description | Notes|
1085
+ |------------- | ------------- | ------------- | -------------|
1086
+ | **installationDetailsDTO** | **InstallationDetailsDTO**| Installation Details | |
1087
+ | **wizardId** | [**number**] | Wizard ID | defaults to undefined|
1088
+
1089
+
1090
+ ### Return type
1091
+
1092
+ **InstallationDetailsDTO**
1093
+
1094
+ ### Authorization
1095
+
1096
+ No authorization required
1097
+
1098
+ ### HTTP request headers
1099
+
1100
+ - **Content-Type**: application/json
1101
+ - **Accept**: application/json
1102
+
1103
+
1104
+ ### HTTP response details
1105
+ | Status code | Description | Response headers |
1106
+ |-------------|-------------|------------------|
1107
+ |**200** | Installation Details | - |
1108
+ |**400** | Bad Request | - |
1109
+ |**401** | Unauthorised | - |
1110
+ |**403** | Access Denied | - |
1111
+
1112
+ [[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)
1113
+
@@ -1,6 +1,6 @@
1
1
  # Class3CXIntegrationsApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -1,6 +1,6 @@
1
1
  # Class3CXMultiTenantApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -0,0 +1,39 @@
1
+ # InstallationDetailsDTO
2
+
3
+ Installation Passwords
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **ipAddress** | **string** | PBX IP Address | [optional] [default to undefined]
10
+ **failoverIpAddress** | **string** | PBX Failover IP Address | [optional] [default to undefined]
11
+ **instanceId** | **string** | Instance ID | [optional] [default to undefined]
12
+ **project** | **string** | Project ID | [optional] [default to undefined]
13
+ **sshKey** | [**GenericFileModel**](GenericFileModel.md) | | [optional] [default to undefined]
14
+ **osPassword** | **string** | Root Password | [optional] [default to undefined]
15
+ **systemOwner** | [**TcxUsersEntity**](TcxUsersEntity.md) | | [optional] [default to undefined]
16
+ **email** | **string** | Admin Email | [optional] [default to undefined]
17
+ **url** | **string** | 3CX Console URL | [optional] [default to undefined]
18
+ **backup** | [**RemoteStorageDTO**](RemoteStorageDTO.md) | | [optional] [default to undefined]
19
+
20
+ ## Example
21
+
22
+ ```typescript
23
+ import { InstallationDetailsDTO } from 'yellowgrid-api-ts';
24
+
25
+ const instance: InstallationDetailsDTO = {
26
+ ipAddress,
27
+ failoverIpAddress,
28
+ instanceId,
29
+ project,
30
+ sshKey,
31
+ osPassword,
32
+ systemOwner,
33
+ email,
34
+ url,
35
+ backup,
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)
@@ -1,6 +1,6 @@
1
1
  # MyPBXToolsApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -1,6 +1,6 @@
1
1
  # NumberPortingApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -1,6 +1,6 @@
1
1
  # OAuth20Api
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
package/docs/OrdersApi.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # OrdersApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -9,6 +9,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
9
9
  |[**deleteUpdateShipment**](#deleteupdateshipment) | **DELETE** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Delete Shipment (Admin)|
10
10
  |[**getGetAdminEditableOrder**](#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)|
11
11
  |[**getGetAdminOrderDetails**](#getgetadminorderdetails) | **GET** /admin/orders/{id}/details | Get Order Details (Admin)|
12
+ |[**getGetCommercialInvoice**](#getgetcommercialinvoice) | **GET** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/pdf | Get Commercial Invoice PDF|
12
13
  |[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)|
13
14
  |[**getGetItemSerialInfo**](#getgetitemserialinfo) | **GET** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)|
14
15
  |[**getGetOrderPdf**](#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF|
@@ -22,6 +23,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
22
23
  |[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
23
24
  |[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
24
25
  |[**postPrintShippingLabel**](#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label|
26
+ |[**postProcessTcxLicences**](#postprocesstcxlicences) | **POST** /admin/orders/{id}/batches/{batch_id}/licences/process | Process 3CX Licences (Admin)|
25
27
  |[**postSendOrderEmail**](#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email|
26
28
  |[**postSendShipmentEmail**](#postsendshipmentemail) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/send/email | Send Shipment Email (Admin)|
27
29
  |[**postSendSupplierEmail**](#postsendsupplieremail) | **POST** /admin/orders/{id}/batches/{batch_id}/email/send | Send Supplier Email|
@@ -312,6 +314,66 @@ No authorization required
312
314
 
313
315
  [[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)
314
316
 
317
+ # **getGetCommercialInvoice**
318
+ > File getGetCommercialInvoice()
319
+
320
+ Get Commercial Invoice PDF
321
+
322
+ ### Example
323
+
324
+ ```typescript
325
+ import {
326
+ OrdersApi,
327
+ Configuration
328
+ } from 'yellowgrid-api-ts';
329
+
330
+ const configuration = new Configuration();
331
+ const apiInstance = new OrdersApi(configuration);
332
+
333
+ let id: number; //Order ID (default to undefined)
334
+ let batchId: number; //Batch ID (default to undefined)
335
+ let shipmentId: number; //Shipment ID (default to undefined)
336
+
337
+ const { status, data } = await apiInstance.getGetCommercialInvoice(
338
+ id,
339
+ batchId,
340
+ shipmentId
341
+ );
342
+ ```
343
+
344
+ ### Parameters
345
+
346
+ |Name | Type | Description | Notes|
347
+ |------------- | ------------- | ------------- | -------------|
348
+ | **id** | [**number**] | Order ID | defaults to undefined|
349
+ | **batchId** | [**number**] | Batch ID | defaults to undefined|
350
+ | **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
351
+
352
+
353
+ ### Return type
354
+
355
+ **File**
356
+
357
+ ### Authorization
358
+
359
+ No authorization required
360
+
361
+ ### HTTP request headers
362
+
363
+ - **Content-Type**: Not defined
364
+ - **Accept**: application/pdf
365
+
366
+
367
+ ### HTTP response details
368
+ | Status code | Description | Response headers |
369
+ |-------------|-------------|------------------|
370
+ |**200** | Order PDF | - |
371
+ |**400** | Bad Request | - |
372
+ |**401** | Unauthorised | - |
373
+ |**403** | Access Denied | - |
374
+
375
+ [[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)
376
+
315
377
  # **getGetEditableOrder**
316
378
  > DetailedOrderRequestDTO getGetEditableOrder()
317
379
 
@@ -1058,13 +1120,71 @@ No authorization required
1058
1120
  ### HTTP request headers
1059
1121
 
1060
1122
  - **Content-Type**: Not defined
1061
- - **Accept**: text/html, application/json
1123
+ - **Accept**: text/html
1062
1124
 
1063
1125
 
1064
1126
  ### HTTP response details
1065
1127
  | Status code | Description | Response headers |
1066
1128
  |-------------|-------------|------------------|
1067
1129
  |**200** | Shipping Label | - |
1130
+ |**204** | No Response | - |
1131
+ |**400** | Bad Request | - |
1132
+ |**401** | Unauthorised | - |
1133
+ |**403** | Access Denied | - |
1134
+
1135
+ [[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)
1136
+
1137
+ # **postProcessTcxLicences**
1138
+ > OrderDetailsDTO postProcessTcxLicences()
1139
+
1140
+ Process 3CX Licences (Admin)
1141
+
1142
+ ### Example
1143
+
1144
+ ```typescript
1145
+ import {
1146
+ OrdersApi,
1147
+ Configuration
1148
+ } from 'yellowgrid-api-ts';
1149
+
1150
+ const configuration = new Configuration();
1151
+ const apiInstance = new OrdersApi(configuration);
1152
+
1153
+ let id: number; //Order ID (default to undefined)
1154
+ let batchId: number; //Batch ID (default to undefined)
1155
+
1156
+ const { status, data } = await apiInstance.postProcessTcxLicences(
1157
+ id,
1158
+ batchId
1159
+ );
1160
+ ```
1161
+
1162
+ ### Parameters
1163
+
1164
+ |Name | Type | Description | Notes|
1165
+ |------------- | ------------- | ------------- | -------------|
1166
+ | **id** | [**number**] | Order ID | defaults to undefined|
1167
+ | **batchId** | [**number**] | Batch ID | defaults to undefined|
1168
+
1169
+
1170
+ ### Return type
1171
+
1172
+ **OrderDetailsDTO**
1173
+
1174
+ ### Authorization
1175
+
1176
+ No authorization required
1177
+
1178
+ ### HTTP request headers
1179
+
1180
+ - **Content-Type**: Not defined
1181
+ - **Accept**: application/json
1182
+
1183
+
1184
+ ### HTTP response details
1185
+ | Status code | Description | Response headers |
1186
+ |-------------|-------------|------------------|
1187
+ |**200** | Order Details | - |
1068
1188
  |**400** | Bad Request | - |
1069
1189
  |**401** | Unauthorised | - |
1070
1190
  |**403** | Access Denied | - |
@@ -1,6 +1,6 @@
1
1
  # PricingApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
10
10
  **title** | **string** | Title | [optional] [default to undefined]
11
11
  **quantity** | **number** | Stock Quantity | [optional] [default to undefined]
12
12
  **stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
13
+ **dueDate** | **string** | Date Time | [optional] [default to undefined]
13
14
  **price** | **number** | Price | [optional] [default to undefined]
14
15
  **cartonSize** | **number** | Carton Size | [optional] [default to undefined]
15
16
  **rrp** | **number** | RRP Price | [optional] [default to undefined]
@@ -26,6 +27,7 @@ const instance: ProductSummaryDTO = {
26
27
  title,
27
28
  quantity,
28
29
  stockProduct,
30
+ dueDate,
29
31
  price,
30
32
  cartonSize,
31
33
  rrp,