yellowgrid-api-ts 3.1.13-dev.0 → 3.1.14-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.
@@ -1,6 +1,5 @@
1
1
  .gitignore
2
2
  .npmignore
3
- .openapi-generator-ignore
4
3
  README.md
5
4
  api.ts
6
5
  base.ts
@@ -17,7 +16,6 @@ docs/AccountsApi.md
17
16
  docs/AccountsResponseModel.md
18
17
  docs/AddressModel.md
19
18
  docs/AddressRequestModel.md
20
- docs/AdminItemRequestDTO.md
21
19
  docs/AdminOrderRequestDTO.md
22
20
  docs/AdminUserModel.md
23
21
  docs/AgentHoursGraphModel.md
@@ -52,6 +50,8 @@ docs/CustomerPriceListEnum.md
52
50
  docs/CustomerSummaryReportDTO.md
53
51
  docs/DdiRangeRequestModel.md
54
52
  docs/DdiRangesRequestModel.md
53
+ docs/DetailedItemRequestDTO.md
54
+ docs/DetailedOrderRequestDTO.md
55
55
  docs/DivertRequestModel.md
56
56
  docs/DivertResponseModel.md
57
57
  docs/EdTechProClientEntity.md
package/README.md CHANGED
@@ -138,6 +138,7 @@ Class | Method | HTTP request | Description
138
138
  *OAuth20Api* | [**postGetIdentity**](docs/OAuth20Api.md#postgetidentity) | **POST** /oauth2/me | Get Token Identity
139
139
  *OAuth20Api* | [**postPortalLogin**](docs/OAuth20Api.md#postportallogin) | **POST** /oauth2/portal/login | Portal Login
140
140
  *OrdersApi* | [**deleteUpdateOrder**](docs/OrdersApi.md#deleteupdateorder) | **DELETE** /orders/{id} | Delete Orders
141
+ *OrdersApi* | [**getGetAdminEditableOrder**](docs/OrdersApi.md#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)
141
142
  *OrdersApi* | [**getGetEditableOrder**](docs/OrdersApi.md#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order
142
143
  *OrdersApi* | [**getGetOrders**](docs/OrdersApi.md#getgetorders) | **GET** /orders | Get Orders
143
144
  *OrdersApi* | [**postCreateAdminOrder**](docs/OrdersApi.md#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)
@@ -231,7 +232,6 @@ Class | Method | HTTP request | Description
231
232
  - [AccountsResponseModel](docs/AccountsResponseModel.md)
232
233
  - [AddressModel](docs/AddressModel.md)
233
234
  - [AddressRequestModel](docs/AddressRequestModel.md)
234
- - [AdminItemRequestDTO](docs/AdminItemRequestDTO.md)
235
235
  - [AdminOrderRequestDTO](docs/AdminOrderRequestDTO.md)
236
236
  - [AdminUserModel](docs/AdminUserModel.md)
237
237
  - [AgentHoursGraphModel](docs/AgentHoursGraphModel.md)
@@ -260,6 +260,8 @@ Class | Method | HTTP request | Description
260
260
  - [CustomerSummaryReportDTO](docs/CustomerSummaryReportDTO.md)
261
261
  - [DdiRangeRequestModel](docs/DdiRangeRequestModel.md)
262
262
  - [DdiRangesRequestModel](docs/DdiRangesRequestModel.md)
263
+ - [DetailedItemRequestDTO](docs/DetailedItemRequestDTO.md)
264
+ - [DetailedOrderRequestDTO](docs/DetailedOrderRequestDTO.md)
263
265
  - [DivertRequestModel](docs/DivertRequestModel.md)
264
266
  - [DivertResponseModel](docs/DivertResponseModel.md)
265
267
  - [EdTechProClientEntity](docs/EdTechProClientEntity.md)
package/api.ts CHANGED
@@ -657,85 +657,6 @@ export interface AddressRequestModel {
657
657
  */
658
658
  'addressPostcode'?: string;
659
659
  }
660
- /**
661
- * Admin Order Item Request
662
- * @export
663
- * @interface AdminItemRequestDTO
664
- */
665
- export interface AdminItemRequestDTO {
666
- /**
667
- * SKU
668
- * @type {string}
669
- * @memberof AdminItemRequestDTO
670
- */
671
- 'sku'?: string;
672
- /**
673
- * Quantity
674
- * @type {number}
675
- * @memberof AdminItemRequestDTO
676
- */
677
- 'quantity'?: number;
678
- /**
679
- * ID
680
- * @type {number}
681
- * @memberof AdminItemRequestDTO
682
- */
683
- 'id'?: number | null;
684
- /**
685
- * 3CX Licence Key
686
- * @type {string}
687
- * @memberof AdminItemRequestDTO
688
- */
689
- 'licenceKey'?: string | null;
690
- /**
691
- * 3CX Hosting
692
- * @type {boolean}
693
- * @memberof AdminItemRequestDTO
694
- */
695
- 'hosting'?: boolean | null;
696
- /**
697
- * Date Time
698
- * @type {string}
699
- * @memberof AdminItemRequestDTO
700
- */
701
- 'processDate'?: string;
702
- /**
703
- * 3CX Sales Code
704
- * @type {string}
705
- * @memberof AdminItemRequestDTO
706
- */
707
- 'tcxSalesCode'?: string | null;
708
- /**
709
- * SBCS
710
- * @type {Array<TcxSbcDTO>}
711
- * @memberof AdminItemRequestDTO
712
- */
713
- 'sbcs'?: Array<TcxSbcDTO>;
714
- /**
715
- * Read Only (Cannot be edited)
716
- * @type {boolean}
717
- * @memberof AdminItemRequestDTO
718
- */
719
- 'readOnly'?: boolean;
720
- /**
721
- * Title
722
- * @type {string}
723
- * @memberof AdminItemRequestDTO
724
- */
725
- 'title'?: string | null;
726
- /**
727
- * Price (£)
728
- * @type {number}
729
- * @memberof AdminItemRequestDTO
730
- */
731
- 'itemPrice'?: number | null;
732
- /**
733
- * Additional Discount
734
- * @type {number}
735
- * @memberof AdminItemRequestDTO
736
- */
737
- 'additionalDiscount'?: number | null;
738
- }
739
660
  /**
740
661
  * Admin Order Request
741
662
  * @export
@@ -750,10 +671,10 @@ export interface AdminOrderRequestDTO {
750
671
  'orderReference'?: string | null;
751
672
  /**
752
673
  * Items
753
- * @type {Array<AdminItemRequestDTO>}
674
+ * @type {Array<DetailedItemRequestDTO>}
754
675
  * @memberof AdminOrderRequestDTO
755
676
  */
756
- 'items'?: Array<AdminItemRequestDTO>;
677
+ 'items'?: Array<DetailedItemRequestDTO>;
757
678
  /**
758
679
  *
759
680
  * @type {ShippingServiceDTO}
@@ -1999,6 +1920,134 @@ export interface DdiRangesRequestModel {
1999
1920
  */
2000
1921
  'ranges'?: Array<DdiRangeRequestModel>;
2001
1922
  }
1923
+ /**
1924
+ * Detailed Order Item Request
1925
+ * @export
1926
+ * @interface DetailedItemRequestDTO
1927
+ */
1928
+ export interface DetailedItemRequestDTO {
1929
+ /**
1930
+ * SKU
1931
+ * @type {string}
1932
+ * @memberof DetailedItemRequestDTO
1933
+ */
1934
+ 'sku'?: string;
1935
+ /**
1936
+ * Quantity
1937
+ * @type {number}
1938
+ * @memberof DetailedItemRequestDTO
1939
+ */
1940
+ 'quantity'?: number;
1941
+ /**
1942
+ * ID
1943
+ * @type {number}
1944
+ * @memberof DetailedItemRequestDTO
1945
+ */
1946
+ 'id'?: number | null;
1947
+ /**
1948
+ * 3CX Licence Key
1949
+ * @type {string}
1950
+ * @memberof DetailedItemRequestDTO
1951
+ */
1952
+ 'licenceKey'?: string | null;
1953
+ /**
1954
+ * 3CX Hosting
1955
+ * @type {boolean}
1956
+ * @memberof DetailedItemRequestDTO
1957
+ */
1958
+ 'hosting'?: boolean | null;
1959
+ /**
1960
+ * Date Time
1961
+ * @type {string}
1962
+ * @memberof DetailedItemRequestDTO
1963
+ */
1964
+ 'processDate'?: string;
1965
+ /**
1966
+ * 3CX Sales Code
1967
+ * @type {string}
1968
+ * @memberof DetailedItemRequestDTO
1969
+ */
1970
+ 'tcxSalesCode'?: string | null;
1971
+ /**
1972
+ * SBCS
1973
+ * @type {Array<TcxSbcDTO>}
1974
+ * @memberof DetailedItemRequestDTO
1975
+ */
1976
+ 'sbcs'?: Array<TcxSbcDTO>;
1977
+ /**
1978
+ * Read Only (Cannot be edited)
1979
+ * @type {boolean}
1980
+ * @memberof DetailedItemRequestDTO
1981
+ */
1982
+ 'readOnly'?: boolean;
1983
+ /**
1984
+ * Title
1985
+ * @type {string}
1986
+ * @memberof DetailedItemRequestDTO
1987
+ */
1988
+ 'title'?: string | null;
1989
+ /**
1990
+ * Price (£)
1991
+ * @type {number}
1992
+ * @memberof DetailedItemRequestDTO
1993
+ */
1994
+ 'itemPrice'?: number | null;
1995
+ /**
1996
+ * Additional Discount
1997
+ * @type {number}
1998
+ * @memberof DetailedItemRequestDTO
1999
+ */
2000
+ 'additionalDiscount'?: number | null;
2001
+ }
2002
+ /**
2003
+ * Detailed Order Request
2004
+ * @export
2005
+ * @interface DetailedOrderRequestDTO
2006
+ */
2007
+ export interface DetailedOrderRequestDTO {
2008
+ /**
2009
+ * Order Reference
2010
+ * @type {string}
2011
+ * @memberof DetailedOrderRequestDTO
2012
+ */
2013
+ 'orderReference'?: string | null;
2014
+ /**
2015
+ * Items
2016
+ * @type {Array<DetailedItemRequestDTO>}
2017
+ * @memberof DetailedOrderRequestDTO
2018
+ */
2019
+ 'items'?: Array<DetailedItemRequestDTO>;
2020
+ /**
2021
+ *
2022
+ * @type {ShippingServiceDTO}
2023
+ * @memberof DetailedOrderRequestDTO
2024
+ */
2025
+ 'shippingService'?: ShippingServiceDTO;
2026
+ /**
2027
+ * Provisioning URL
2028
+ * @type {string}
2029
+ * @memberof DetailedOrderRequestDTO
2030
+ */
2031
+ 'provisioningUrl'?: string | null;
2032
+ /**
2033
+ *
2034
+ * @type {AddressModel}
2035
+ * @memberof DetailedOrderRequestDTO
2036
+ */
2037
+ 'shippingAddress'?: AddressModel;
2038
+ /**
2039
+ * Part Ship Order
2040
+ * @type {boolean}
2041
+ * @memberof DetailedOrderRequestDTO
2042
+ */
2043
+ 'partShip'?: boolean;
2044
+ /**
2045
+ * Quote
2046
+ * @type {boolean}
2047
+ * @memberof DetailedOrderRequestDTO
2048
+ */
2049
+ 'quote'?: boolean;
2050
+ }
2002
2051
  /**
2003
2052
  * Divert Request
2004
2053
  * @export
@@ -3129,6 +3178,12 @@ export interface ItemDiscountEntity {
3129
3178
  * @memberof ItemDiscountEntity
3130
3179
  */
3131
3180
  'discount'?: number;
3181
+ /**
3182
+ * type
3183
+ * @type {string}
3184
+ * @memberof ItemDiscountEntity
3185
+ */
3186
+ 'type'?: ItemDiscountEntityTypeEnum | null;
3132
3187
  /**
3133
3188
  * description
3134
3189
  * @type {string}
@@ -3142,6 +3197,15 @@ export interface ItemDiscountEntity {
3142
3197
  */
3143
3198
  'priority'?: number;
3144
3199
  }
3200
+
3201
+ export const ItemDiscountEntityTypeEnum = {
3202
+ TcxPhones: 'TCX_PHONES',
3203
+ PhoneBulk: 'PHONE_BULK',
3204
+ Additional: 'ADDITIONAL'
3205
+ } as const;
3206
+
3207
+ export type ItemDiscountEntityTypeEnum = typeof ItemDiscountEntityTypeEnum[keyof typeof ItemDiscountEntityTypeEnum];
3208
+
3145
3209
  /**
3146
3210
  * ItemsEntity
3147
3211
  * @export
@@ -3249,7 +3313,7 @@ export interface ItemEntity {
3249
3313
  * @type {string}
3250
3314
  * @memberof ItemEntity
3251
3315
  */
3252
- 'licencekey'?: string;
3316
+ 'licenceKey'?: string;
3253
3317
  /**
3254
3318
  * addHosting
3255
3319
  * @type {number}
@@ -16326,6 +16390,40 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
16326
16390
 
16327
16391
 
16328
16392
 
16393
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
16394
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
16395
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
16396
+
16397
+ return {
16398
+ url: toPathString(localVarUrlObj),
16399
+ options: localVarRequestOptions,
16400
+ };
16401
+ },
16402
+ /**
16403
+ * Get Editable Order (Admin)
16404
+ * @summary Get Editable Order (Admin)
16405
+ * @param {number} id Order ID
16406
+ * @param {*} [options] Override http request option.
16407
+ * @throws {RequiredError}
16408
+ */
16409
+ getGetAdminEditableOrder: async (id: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
16410
+ // verify required parameter 'id' is not null or undefined
16411
+ assertParamExists('getGetAdminEditableOrder', 'id', id)
16412
+ const localVarPath = `/admin/orders/{id}/views/editable`
16413
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
16414
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
16415
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
16416
+ let baseOptions;
16417
+ if (configuration) {
16418
+ baseOptions = configuration.baseOptions;
16419
+ }
16420
+
16421
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
16422
+ const localVarHeaderParameter = {} as any;
16423
+ const localVarQueryParameter = {} as any;
16424
+
16425
+
16426
+
16329
16427
  setSearchParams(localVarUrlObj, localVarQueryParameter);
16330
16428
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
16331
16429
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -16621,6 +16719,19 @@ export const OrdersApiFp = function(configuration?: Configuration) {
16621
16719
  const localVarOperationServerBasePath = operationServerMap['OrdersApi.deleteUpdateOrder']?.[localVarOperationServerIndex]?.url;
16622
16720
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
16623
16721
  },
16722
+ /**
16723
+ * Get Editable Order (Admin)
16724
+ * @summary Get Editable Order (Admin)
16725
+ * @param {number} id Order ID
16726
+ * @param {*} [options] Override http request option.
16727
+ * @throws {RequiredError}
16728
+ */
16729
+ async getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminOrderRequestDTO>> {
16730
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getGetAdminEditableOrder(id, options);
16731
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
16732
+ const localVarOperationServerBasePath = operationServerMap['OrdersApi.getGetAdminEditableOrder']?.[localVarOperationServerIndex]?.url;
16733
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
16734
+ },
16624
16735
  /**
16625
16736
  * Get Editable Order
16626
16737
  * @summary Get Editable Order
@@ -16628,7 +16739,7 @@ export const OrdersApiFp = function(configuration?: Configuration) {
16628
16739
  * @param {*} [options] Override http request option.
16629
16740
  * @throws {RequiredError}
16630
16741
  */
16631
- async getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminOrderRequestDTO>> {
16742
+ async getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DetailedOrderRequestDTO>> {
16632
16743
  const localVarAxiosArgs = await localVarAxiosParamCreator.getGetEditableOrder(id, options);
16633
16744
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
16634
16745
  const localVarOperationServerBasePath = operationServerMap['OrdersApi.getGetEditableOrder']?.[localVarOperationServerIndex]?.url;
@@ -16731,6 +16842,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
16731
16842
  deleteUpdateOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
16732
16843
  return localVarFp.deleteUpdateOrder(id, options).then((request) => request(axios, basePath));
16733
16844
  },
16845
+ /**
16846
+ * Get Editable Order (Admin)
16847
+ * @summary Get Editable Order (Admin)
16848
+ * @param {number} id Order ID
16849
+ * @param {*} [options] Override http request option.
16850
+ * @throws {RequiredError}
16851
+ */
16852
+ getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminOrderRequestDTO> {
16853
+ return localVarFp.getGetAdminEditableOrder(id, options).then((request) => request(axios, basePath));
16854
+ },
16734
16855
  /**
16735
16856
  * Get Editable Order
16736
16857
  * @summary Get Editable Order
@@ -16738,7 +16859,7 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
16738
16859
  * @param {*} [options] Override http request option.
16739
16860
  * @throws {RequiredError}
16740
16861
  */
16741
- getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminOrderRequestDTO> {
16862
+ getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<DetailedOrderRequestDTO> {
16742
16863
  return localVarFp.getGetEditableOrder(id, options).then((request) => request(axios, basePath));
16743
16864
  },
16744
16865
  /**
@@ -16825,6 +16946,18 @@ export class OrdersApi extends BaseAPI {
16825
16946
  return OrdersApiFp(this.configuration).deleteUpdateOrder(id, options).then((request) => request(this.axios, this.basePath));
16826
16947
  }
16827
16948
 
16949
+ /**
16950
+ * Get Editable Order (Admin)
16951
+ * @summary Get Editable Order (Admin)
16952
+ * @param {number} id Order ID
16953
+ * @param {*} [options] Override http request option.
16954
+ * @throws {RequiredError}
16955
+ * @memberof OrdersApi
16956
+ */
16957
+ public getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig) {
16958
+ return OrdersApiFp(this.configuration).getGetAdminEditableOrder(id, options).then((request) => request(this.axios, this.basePath));
16959
+ }
16960
+
16828
16961
  /**
16829
16962
  * Get Editable Order
16830
16963
  * @summary Get Editable Order
package/dist/api.d.ts CHANGED
@@ -647,85 +647,6 @@ export interface AddressRequestModel {
647
647
  */
648
648
  'addressPostcode'?: string;
649
649
  }
650
- /**
651
- * Admin Order Item Request
652
- * @export
653
- * @interface AdminItemRequestDTO
654
- */
655
- export interface AdminItemRequestDTO {
656
- /**
657
- * SKU
658
- * @type {string}
659
- * @memberof AdminItemRequestDTO
660
- */
661
- 'sku'?: string;
662
- /**
663
- * Quantity
664
- * @type {number}
665
- * @memberof AdminItemRequestDTO
666
- */
667
- 'quantity'?: number;
668
- /**
669
- * ID
670
- * @type {number}
671
- * @memberof AdminItemRequestDTO
672
- */
673
- 'id'?: number | null;
674
- /**
675
- * 3CX Licence Key
676
- * @type {string}
677
- * @memberof AdminItemRequestDTO
678
- */
679
- 'licenceKey'?: string | null;
680
- /**
681
- * 3CX Hosting
682
- * @type {boolean}
683
- * @memberof AdminItemRequestDTO
684
- */
685
- 'hosting'?: boolean | null;
686
- /**
687
- * Date Time
688
- * @type {string}
689
- * @memberof AdminItemRequestDTO
690
- */
691
- 'processDate'?: string;
692
- /**
693
- * 3CX Sales Code
694
- * @type {string}
695
- * @memberof AdminItemRequestDTO
696
- */
697
- 'tcxSalesCode'?: string | null;
698
- /**
699
- * SBCS
700
- * @type {Array<TcxSbcDTO>}
701
- * @memberof AdminItemRequestDTO
702
- */
703
- 'sbcs'?: Array<TcxSbcDTO>;
704
- /**
705
- * Read Only (Cannot be edited)
706
- * @type {boolean}
707
- * @memberof AdminItemRequestDTO
708
- */
709
- 'readOnly'?: boolean;
710
- /**
711
- * Title
712
- * @type {string}
713
- * @memberof AdminItemRequestDTO
714
- */
715
- 'title'?: string | null;
716
- /**
717
- * Price (£)
718
- * @type {number}
719
- * @memberof AdminItemRequestDTO
720
- */
721
- 'itemPrice'?: number | null;
722
- /**
723
- * Additional Discount
724
- * @type {number}
725
- * @memberof AdminItemRequestDTO
726
- */
727
- 'additionalDiscount'?: number | null;
728
- }
729
650
  /**
730
651
  * Admin Order Request
731
652
  * @export
@@ -740,10 +661,10 @@ export interface AdminOrderRequestDTO {
740
661
  'orderReference'?: string | null;
741
662
  /**
742
663
  * Items
743
- * @type {Array<AdminItemRequestDTO>}
664
+ * @type {Array<DetailedItemRequestDTO>}
744
665
  * @memberof AdminOrderRequestDTO
745
666
  */
746
- 'items'?: Array<AdminItemRequestDTO>;
667
+ 'items'?: Array<DetailedItemRequestDTO>;
747
668
  /**
748
669
  *
749
670
  * @type {ShippingServiceDTO}
@@ -1986,6 +1907,134 @@ export interface DdiRangesRequestModel {
1986
1907
  */
1987
1908
  'ranges'?: Array<DdiRangeRequestModel>;
1988
1909
  }
1910
+ /**
1911
+ * Detailed Order Item Request
1912
+ * @export
1913
+ * @interface DetailedItemRequestDTO
1914
+ */
1915
+ export interface DetailedItemRequestDTO {
1916
+ /**
1917
+ * SKU
1918
+ * @type {string}
1919
+ * @memberof DetailedItemRequestDTO
1920
+ */
1921
+ 'sku'?: string;
1922
+ /**
1923
+ * Quantity
1924
+ * @type {number}
1925
+ * @memberof DetailedItemRequestDTO
1926
+ */
1927
+ 'quantity'?: number;
1928
+ /**
1929
+ * ID
1930
+ * @type {number}
1931
+ * @memberof DetailedItemRequestDTO
1932
+ */
1933
+ 'id'?: number | null;
1934
+ /**
1935
+ * 3CX Licence Key
1936
+ * @type {string}
1937
+ * @memberof DetailedItemRequestDTO
1938
+ */
1939
+ 'licenceKey'?: string | null;
1940
+ /**
1941
+ * 3CX Hosting
1942
+ * @type {boolean}
1943
+ * @memberof DetailedItemRequestDTO
1944
+ */
1945
+ 'hosting'?: boolean | null;
1946
+ /**
1947
+ * Date Time
1948
+ * @type {string}
1949
+ * @memberof DetailedItemRequestDTO
1950
+ */
1951
+ 'processDate'?: string;
1952
+ /**
1953
+ * 3CX Sales Code
1954
+ * @type {string}
1955
+ * @memberof DetailedItemRequestDTO
1956
+ */
1957
+ 'tcxSalesCode'?: string | null;
1958
+ /**
1959
+ * SBCS
1960
+ * @type {Array<TcxSbcDTO>}
1961
+ * @memberof DetailedItemRequestDTO
1962
+ */
1963
+ 'sbcs'?: Array<TcxSbcDTO>;
1964
+ /**
1965
+ * Read Only (Cannot be edited)
1966
+ * @type {boolean}
1967
+ * @memberof DetailedItemRequestDTO
1968
+ */
1969
+ 'readOnly'?: boolean;
1970
+ /**
1971
+ * Title
1972
+ * @type {string}
1973
+ * @memberof DetailedItemRequestDTO
1974
+ */
1975
+ 'title'?: string | null;
1976
+ /**
1977
+ * Price (£)
1978
+ * @type {number}
1979
+ * @memberof DetailedItemRequestDTO
1980
+ */
1981
+ 'itemPrice'?: number | null;
1982
+ /**
1983
+ * Additional Discount
1984
+ * @type {number}
1985
+ * @memberof DetailedItemRequestDTO
1986
+ */
1987
+ 'additionalDiscount'?: number | null;
1988
+ }
1989
+ /**
1990
+ * Detailed Order Request
1991
+ * @export
1992
+ * @interface DetailedOrderRequestDTO
1993
+ */
1994
+ export interface DetailedOrderRequestDTO {
1995
+ /**
1996
+ * Order Reference
1997
+ * @type {string}
1998
+ * @memberof DetailedOrderRequestDTO
1999
+ */
2000
+ 'orderReference'?: string | null;
2001
+ /**
2002
+ * Items
2003
+ * @type {Array<DetailedItemRequestDTO>}
2004
+ * @memberof DetailedOrderRequestDTO
2005
+ */
2006
+ 'items'?: Array<DetailedItemRequestDTO>;
2007
+ /**
2008
+ *
2009
+ * @type {ShippingServiceDTO}
2010
+ * @memberof DetailedOrderRequestDTO
2011
+ */
2012
+ 'shippingService'?: ShippingServiceDTO;
2013
+ /**
2014
+ * Provisioning URL
2015
+ * @type {string}
2016
+ * @memberof DetailedOrderRequestDTO
2017
+ */
2018
+ 'provisioningUrl'?: string | null;
2019
+ /**
2020
+ *
2021
+ * @type {AddressModel}
2022
+ * @memberof DetailedOrderRequestDTO
2023
+ */
2024
+ 'shippingAddress'?: AddressModel;
2025
+ /**
2026
+ * Part Ship Order
2027
+ * @type {boolean}
2028
+ * @memberof DetailedOrderRequestDTO
2029
+ */
2030
+ 'partShip'?: boolean;
2031
+ /**
2032
+ * Quote
2033
+ * @type {boolean}
2034
+ * @memberof DetailedOrderRequestDTO
2035
+ */
2036
+ 'quote'?: boolean;
2037
+ }
1989
2038
  /**
1990
2039
  * Divert Request
1991
2040
  * @export
@@ -3107,6 +3156,12 @@ export interface ItemDiscountEntity {
3107
3156
  * @memberof ItemDiscountEntity
3108
3157
  */
3109
3158
  'discount'?: number;
3159
+ /**
3160
+ * type
3161
+ * @type {string}
3162
+ * @memberof ItemDiscountEntity
3163
+ */
3164
+ 'type'?: ItemDiscountEntityTypeEnum | null;
3110
3165
  /**
3111
3166
  * description
3112
3167
  * @type {string}
@@ -3120,6 +3175,12 @@ export interface ItemDiscountEntity {
3120
3175
  */
3121
3176
  'priority'?: number;
3122
3177
  }
3178
+ export declare const ItemDiscountEntityTypeEnum: {
3179
+ readonly TcxPhones: "TCX_PHONES";
3180
+ readonly PhoneBulk: "PHONE_BULK";
3181
+ readonly Additional: "ADDITIONAL";
3182
+ };
3183
+ export type ItemDiscountEntityTypeEnum = typeof ItemDiscountEntityTypeEnum[keyof typeof ItemDiscountEntityTypeEnum];
3123
3184
  /**
3124
3185
  * ItemsEntity
3125
3186
  * @export
@@ -3227,7 +3288,7 @@ export interface ItemEntity {
3227
3288
  * @type {string}
3228
3289
  * @memberof ItemEntity
3229
3290
  */
3230
- 'licencekey'?: string;
3291
+ 'licenceKey'?: string;
3231
3292
  /**
3232
3293
  * addHosting
3233
3294
  * @type {number}
@@ -12755,6 +12816,14 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
12755
12816
  * @throws {RequiredError}
12756
12817
  */
12757
12818
  deleteUpdateOrder: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12819
+ /**
12820
+ * Get Editable Order (Admin)
12821
+ * @summary Get Editable Order (Admin)
12822
+ * @param {number} id Order ID
12823
+ * @param {*} [options] Override http request option.
12824
+ * @throws {RequiredError}
12825
+ */
12826
+ getGetAdminEditableOrder: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12758
12827
  /**
12759
12828
  * Get Editable Order
12760
12829
  * @summary Get Editable Order
@@ -12829,6 +12898,14 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
12829
12898
  * @throws {RequiredError}
12830
12899
  */
12831
12900
  deleteUpdateOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
12901
+ /**
12902
+ * Get Editable Order (Admin)
12903
+ * @summary Get Editable Order (Admin)
12904
+ * @param {number} id Order ID
12905
+ * @param {*} [options] Override http request option.
12906
+ * @throws {RequiredError}
12907
+ */
12908
+ getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminOrderRequestDTO>>;
12832
12909
  /**
12833
12910
  * Get Editable Order
12834
12911
  * @summary Get Editable Order
@@ -12836,7 +12913,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
12836
12913
  * @param {*} [options] Override http request option.
12837
12914
  * @throws {RequiredError}
12838
12915
  */
12839
- getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminOrderRequestDTO>>;
12916
+ getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DetailedOrderRequestDTO>>;
12840
12917
  /**
12841
12918
  * Get Orders
12842
12919
  * @summary Get Orders
@@ -12903,6 +12980,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
12903
12980
  * @throws {RequiredError}
12904
12981
  */
12905
12982
  deleteUpdateOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
12983
+ /**
12984
+ * Get Editable Order (Admin)
12985
+ * @summary Get Editable Order (Admin)
12986
+ * @param {number} id Order ID
12987
+ * @param {*} [options] Override http request option.
12988
+ * @throws {RequiredError}
12989
+ */
12990
+ getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminOrderRequestDTO>;
12906
12991
  /**
12907
12992
  * Get Editable Order
12908
12993
  * @summary Get Editable Order
@@ -12910,7 +12995,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
12910
12995
  * @param {*} [options] Override http request option.
12911
12996
  * @throws {RequiredError}
12912
12997
  */
12913
- getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminOrderRequestDTO>;
12998
+ getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<DetailedOrderRequestDTO>;
12914
12999
  /**
12915
13000
  * Get Orders
12916
13001
  * @summary Get Orders
@@ -12980,6 +13065,15 @@ export declare class OrdersApi extends BaseAPI {
12980
13065
  * @memberof OrdersApi
12981
13066
  */
12982
13067
  deleteUpdateOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
13068
+ /**
13069
+ * Get Editable Order (Admin)
13070
+ * @summary Get Editable Order (Admin)
13071
+ * @param {number} id Order ID
13072
+ * @param {*} [options] Override http request option.
13073
+ * @throws {RequiredError}
13074
+ * @memberof OrdersApi
13075
+ */
13076
+ getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminOrderRequestDTO, any, {}>>;
12983
13077
  /**
12984
13078
  * Get Editable Order
12985
13079
  * @summary Get Editable Order
@@ -12988,7 +13082,7 @@ export declare class OrdersApi extends BaseAPI {
12988
13082
  * @throws {RequiredError}
12989
13083
  * @memberof OrdersApi
12990
13084
  */
12991
- getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminOrderRequestDTO, any, {}>>;
13085
+ getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DetailedOrderRequestDTO, any, {}>>;
12992
13086
  /**
12993
13087
  * Get Orders
12994
13088
  * @summary Get Orders
package/dist/api.js CHANGED
@@ -84,9 +84,9 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
84
84
  return to.concat(ar || Array.prototype.slice.call(from));
85
85
  };
86
86
  Object.defineProperty(exports, "__esModule", { value: true });
87
- exports.Class3CXIntegrationsApiFactory = exports.Class3CXIntegrationsApiFp = exports.Class3CXIntegrationsApiAxiosParamCreator = exports.PostResizeInstanceSizeEnum = exports.PostFailoverInstanceTypeEnum = exports.GetGetInstallationsInstallTypeEnum = exports.GetGetInstallationsHostingEnum = exports.GetGetInstallationsStatusEnum = exports.Class3CXInstallationsApi = exports.Class3CXInstallationsApiFactory = exports.Class3CXInstallationsApiFp = exports.Class3CXInstallationsApiAxiosParamCreator = exports.Class3CXInstallationWizardApi = exports.Class3CXInstallationWizardApiFactory = exports.Class3CXInstallationWizardApiFp = exports.Class3CXInstallationWizardApiAxiosParamCreator = exports.Class3CXApi = exports.Class3CXApiFactory = exports.Class3CXApiFp = exports.Class3CXApiAxiosParamCreator = exports.CRMApi = exports.CRMApiFactory = exports.CRMApiFp = exports.CRMApiAxiosParamCreator = exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.UpgradeRequestModelSchoolTypeEnum = exports.UpgradeRequestModelLicenceTypeEnum = exports.TcxWizardModelInstallationStatusEnum = exports.TcxWizardModelInstallTypeEnum = exports.TcxSetupEntityRegionEnum = exports.TcxSetupEntityInstallTypeEnum = exports.TcxMultiTenantModelPackageEnum = exports.StockOrderModelPaidEnum = exports.StockOrderModelDeliveryMethodEnum = exports.SmsResponseModelEventTypeEnum = exports.SmsPhoneNumberModelStatusEnum = exports.SipTrunkChangeResponseModelTypeEnum = exports.ShippingServiceModelCourierEnum = exports.ShippingServiceDTOCourierEnum = exports.OrderTotalModelCurrencyEnum = exports.OrderRequestModelSchoolTypeEnum = exports.OrderRequestModelLicenceTypeEnum = exports.MultiTenantChangeResponseModelTypeEnum = exports.HostingRegionDTOCodeEnum = exports.HostingChangeResponseModelTypeEnum = exports.DivertResponseModelStatusEnum = exports.AdminUserModelRoleEnum = void 0;
88
- exports.SMSApiAxiosParamCreator = exports.SIPTrunksApi = exports.SIPTrunksApiFactory = exports.SIPTrunksApiFp = exports.SIPTrunksApiAxiosParamCreator = exports.ProvisioningApi = exports.ProvisioningApiFactory = exports.ProvisioningApiFp = exports.ProvisioningApiAxiosParamCreator = exports.GetGetLegacyStockListFormatEnum = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.PostSendPriceListCategoryEnum = exports.PostSendPriceListFormatEnum = exports.PostSendPriceListTypeEnum = exports.GetGetPriceListCategoryEnum = exports.GetGetPriceListFormatEnum = exports.GetGetPriceListTypeEnum = exports.PricingApi = exports.PricingApiFactory = exports.PricingApiFp = exports.PricingApiAxiosParamCreator = exports.GetGetOrdersFilterEnum = exports.GetGetOrdersStatusEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.PostAuthoriseScopeEnum = exports.PostAccessTokenTokenExchangeTypeEnum = exports.PostAccessTokenScopeEnum = exports.PostAccessTokenGrantTypeEnum = exports.OAuth20Api = exports.OAuth20ApiFactory = exports.OAuth20ApiFp = exports.OAuth20ApiAxiosParamCreator = exports.MyPBXToolsApi = exports.MyPBXToolsApiFactory = exports.MyPBXToolsApiFp = exports.MyPBXToolsApiAxiosParamCreator = exports.GetGetTenantsStatusEnum = exports.Class3CXMultiTenantApi = exports.Class3CXMultiTenantApiFactory = exports.Class3CXMultiTenantApiFp = exports.Class3CXMultiTenantApiAxiosParamCreator = exports.GetGetPriceSchoolTypeEnum = exports.GetGetPriceLicenceTypeEnum = exports.Class3CXIntegrationsApi = void 0;
89
- exports.PostAddWebhookWebhookUriEnum = exports.WebhooksApi = exports.WebhooksApiFactory = exports.WebhooksApiFp = exports.WebhooksApiAxiosParamCreator = exports.TicketsApi = exports.TicketsApiFactory = exports.TicketsApiFp = exports.TicketsApiAxiosParamCreator = exports.SystemApi = exports.SystemApiFactory = exports.SystemApiFp = exports.SystemApiAxiosParamCreator = exports.StockManagementApi = exports.StockManagementApiFactory = exports.StockManagementApiFp = exports.StockManagementApiAxiosParamCreator = exports.ShippingApi = exports.ShippingApiFactory = exports.ShippingApiFp = exports.ShippingApiAxiosParamCreator = exports.SMSApi = exports.SMSApiFactory = exports.SMSApiFp = void 0;
87
+ exports.Class3CXIntegrationsApiFp = exports.Class3CXIntegrationsApiAxiosParamCreator = exports.PostResizeInstanceSizeEnum = exports.PostFailoverInstanceTypeEnum = exports.GetGetInstallationsInstallTypeEnum = exports.GetGetInstallationsHostingEnum = exports.GetGetInstallationsStatusEnum = exports.Class3CXInstallationsApi = exports.Class3CXInstallationsApiFactory = exports.Class3CXInstallationsApiFp = exports.Class3CXInstallationsApiAxiosParamCreator = exports.Class3CXInstallationWizardApi = exports.Class3CXInstallationWizardApiFactory = exports.Class3CXInstallationWizardApiFp = exports.Class3CXInstallationWizardApiAxiosParamCreator = exports.Class3CXApi = exports.Class3CXApiFactory = exports.Class3CXApiFp = exports.Class3CXApiAxiosParamCreator = exports.CRMApi = exports.CRMApiFactory = exports.CRMApiFp = exports.CRMApiAxiosParamCreator = exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.UpgradeRequestModelSchoolTypeEnum = exports.UpgradeRequestModelLicenceTypeEnum = exports.TcxWizardModelInstallationStatusEnum = exports.TcxWizardModelInstallTypeEnum = exports.TcxSetupEntityRegionEnum = exports.TcxSetupEntityInstallTypeEnum = exports.TcxMultiTenantModelPackageEnum = exports.StockOrderModelPaidEnum = exports.StockOrderModelDeliveryMethodEnum = exports.SmsResponseModelEventTypeEnum = exports.SmsPhoneNumberModelStatusEnum = exports.SipTrunkChangeResponseModelTypeEnum = exports.ShippingServiceModelCourierEnum = exports.ShippingServiceDTOCourierEnum = exports.OrderTotalModelCurrencyEnum = exports.OrderRequestModelSchoolTypeEnum = exports.OrderRequestModelLicenceTypeEnum = exports.MultiTenantChangeResponseModelTypeEnum = exports.ItemDiscountEntityTypeEnum = exports.HostingRegionDTOCodeEnum = exports.HostingChangeResponseModelTypeEnum = exports.DivertResponseModelStatusEnum = exports.AdminUserModelRoleEnum = void 0;
88
+ exports.SIPTrunksApi = exports.SIPTrunksApiFactory = exports.SIPTrunksApiFp = exports.SIPTrunksApiAxiosParamCreator = exports.ProvisioningApi = exports.ProvisioningApiFactory = exports.ProvisioningApiFp = exports.ProvisioningApiAxiosParamCreator = exports.GetGetLegacyStockListFormatEnum = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.PostSendPriceListCategoryEnum = exports.PostSendPriceListFormatEnum = exports.PostSendPriceListTypeEnum = exports.GetGetPriceListCategoryEnum = exports.GetGetPriceListFormatEnum = exports.GetGetPriceListTypeEnum = exports.PricingApi = exports.PricingApiFactory = exports.PricingApiFp = exports.PricingApiAxiosParamCreator = exports.GetGetOrdersFilterEnum = exports.GetGetOrdersStatusEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.PostAuthoriseScopeEnum = exports.PostAccessTokenTokenExchangeTypeEnum = exports.PostAccessTokenScopeEnum = exports.PostAccessTokenGrantTypeEnum = exports.OAuth20Api = exports.OAuth20ApiFactory = exports.OAuth20ApiFp = exports.OAuth20ApiAxiosParamCreator = exports.MyPBXToolsApi = exports.MyPBXToolsApiFactory = exports.MyPBXToolsApiFp = exports.MyPBXToolsApiAxiosParamCreator = exports.GetGetTenantsStatusEnum = exports.Class3CXMultiTenantApi = exports.Class3CXMultiTenantApiFactory = exports.Class3CXMultiTenantApiFp = exports.Class3CXMultiTenantApiAxiosParamCreator = exports.GetGetPriceSchoolTypeEnum = exports.GetGetPriceLicenceTypeEnum = exports.Class3CXIntegrationsApi = exports.Class3CXIntegrationsApiFactory = void 0;
89
+ exports.PostAddWebhookWebhookUriEnum = exports.WebhooksApi = exports.WebhooksApiFactory = exports.WebhooksApiFp = exports.WebhooksApiAxiosParamCreator = exports.TicketsApi = exports.TicketsApiFactory = exports.TicketsApiFp = exports.TicketsApiAxiosParamCreator = exports.SystemApi = exports.SystemApiFactory = exports.SystemApiFp = exports.SystemApiAxiosParamCreator = exports.StockManagementApi = exports.StockManagementApiFactory = exports.StockManagementApiFp = exports.StockManagementApiAxiosParamCreator = exports.ShippingApi = exports.ShippingApiFactory = exports.ShippingApiFp = exports.ShippingApiAxiosParamCreator = exports.SMSApi = exports.SMSApiFactory = exports.SMSApiFp = exports.SMSApiAxiosParamCreator = void 0;
90
90
  var axios_1 = require("axios");
91
91
  // Some imports not used depending on template conditions
92
92
  // @ts-ignore
@@ -119,6 +119,11 @@ exports.HostingRegionDTOCodeEnum = {
119
119
  UsEastVa1: 'US-EAST-VA-1',
120
120
  UsWestOr1: 'US-WEST-OR-1'
121
121
  };
122
+ exports.ItemDiscountEntityTypeEnum = {
123
+ TcxPhones: 'TCX_PHONES',
124
+ PhoneBulk: 'PHONE_BULK',
125
+ Additional: 'ADDITIONAL'
126
+ };
122
127
  exports.MultiTenantChangeResponseModelTypeEnum = {
123
128
  NewTrunk: 'New Trunk',
124
129
  AvailableTrunk: 'Available Trunk',
@@ -8179,6 +8184,43 @@ var OrdersApiAxiosParamCreator = function (configuration) {
8179
8184
  });
8180
8185
  });
8181
8186
  },
8187
+ /**
8188
+ * Get Editable Order (Admin)
8189
+ * @summary Get Editable Order (Admin)
8190
+ * @param {number} id Order ID
8191
+ * @param {*} [options] Override http request option.
8192
+ * @throws {RequiredError}
8193
+ */
8194
+ getGetAdminEditableOrder: function (id_1) {
8195
+ var args_1 = [];
8196
+ for (var _i = 1; _i < arguments.length; _i++) {
8197
+ args_1[_i - 1] = arguments[_i];
8198
+ }
8199
+ return __awaiter(_this, __spreadArray([id_1], args_1, true), void 0, function (id, options) {
8200
+ var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
8201
+ if (options === void 0) { options = {}; }
8202
+ return __generator(this, function (_a) {
8203
+ // verify required parameter 'id' is not null or undefined
8204
+ (0, common_1.assertParamExists)('getGetAdminEditableOrder', 'id', id);
8205
+ localVarPath = "/admin/orders/{id}/views/editable"
8206
+ .replace("{".concat("id", "}"), encodeURIComponent(String(id)));
8207
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
8208
+ if (configuration) {
8209
+ baseOptions = configuration.baseOptions;
8210
+ }
8211
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
8212
+ localVarHeaderParameter = {};
8213
+ localVarQueryParameter = {};
8214
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
8215
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8216
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
8217
+ return [2 /*return*/, {
8218
+ url: (0, common_1.toPathString)(localVarUrlObj),
8219
+ options: localVarRequestOptions,
8220
+ }];
8221
+ });
8222
+ });
8223
+ },
8182
8224
  /**
8183
8225
  * Get Editable Order
8184
8226
  * @summary Get Editable Order
@@ -8478,6 +8520,29 @@ var OrdersApiFp = function (configuration) {
8478
8520
  });
8479
8521
  });
8480
8522
  },
8523
+ /**
8524
+ * Get Editable Order (Admin)
8525
+ * @summary Get Editable Order (Admin)
8526
+ * @param {number} id Order ID
8527
+ * @param {*} [options] Override http request option.
8528
+ * @throws {RequiredError}
8529
+ */
8530
+ getGetAdminEditableOrder: function (id, options) {
8531
+ return __awaiter(this, void 0, void 0, function () {
8532
+ var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
8533
+ var _a, _b, _c;
8534
+ return __generator(this, function (_d) {
8535
+ switch (_d.label) {
8536
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetAdminEditableOrder(id, options)];
8537
+ case 1:
8538
+ localVarAxiosArgs = _d.sent();
8539
+ localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
8540
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.getGetAdminEditableOrder']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
8541
+ return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
8542
+ }
8543
+ });
8544
+ });
8545
+ },
8481
8546
  /**
8482
8547
  * Get Editable Order
8483
8548
  * @summary Get Editable Order
@@ -8648,6 +8713,16 @@ var OrdersApiFactory = function (configuration, basePath, axios) {
8648
8713
  deleteUpdateOrder: function (id, options) {
8649
8714
  return localVarFp.deleteUpdateOrder(id, options).then(function (request) { return request(axios, basePath); });
8650
8715
  },
8716
+ /**
8717
+ * Get Editable Order (Admin)
8718
+ * @summary Get Editable Order (Admin)
8719
+ * @param {number} id Order ID
8720
+ * @param {*} [options] Override http request option.
8721
+ * @throws {RequiredError}
8722
+ */
8723
+ getGetAdminEditableOrder: function (id, options) {
8724
+ return localVarFp.getGetAdminEditableOrder(id, options).then(function (request) { return request(axios, basePath); });
8725
+ },
8651
8726
  /**
8652
8727
  * Get Editable Order
8653
8728
  * @summary Get Editable Order
@@ -8746,6 +8821,18 @@ var OrdersApi = /** @class */ (function (_super) {
8746
8821
  var _this = this;
8747
8822
  return (0, exports.OrdersApiFp)(this.configuration).deleteUpdateOrder(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
8748
8823
  };
8824
+ /**
8825
+ * Get Editable Order (Admin)
8826
+ * @summary Get Editable Order (Admin)
8827
+ * @param {number} id Order ID
8828
+ * @param {*} [options] Override http request option.
8829
+ * @throws {RequiredError}
8830
+ * @memberof OrdersApi
8831
+ */
8832
+ OrdersApi.prototype.getGetAdminEditableOrder = function (id, options) {
8833
+ var _this = this;
8834
+ return (0, exports.OrdersApiFp)(this.configuration).getGetAdminEditableOrder(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
8835
+ };
8749
8836
  /**
8750
8837
  * Get Editable Order
8751
8838
  * @summary Get Editable Order
@@ -7,7 +7,7 @@ Admin Order Request
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **orderReference** | **string** | Order Reference | [optional] [default to undefined]
10
- **items** | [**Array&lt;AdminItemRequestDTO&gt;**](AdminItemRequestDTO.md) | Items | [optional] [default to undefined]
10
+ **items** | [**Array&lt;DetailedItemRequestDTO&gt;**](DetailedItemRequestDTO.md) | Items | [optional] [default to undefined]
11
11
  **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) | | [optional] [default to undefined]
12
12
  **provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
13
13
  **shippingAddress** | [**AddressModel**](AddressModel.md) | | [optional] [default to undefined]
@@ -0,0 +1,43 @@
1
+ # DetailedItemRequestDTO
2
+
3
+ Detailed 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&lt;TcxSbcDTO&gt;**](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
+ **additionalDiscount** | **number** | Additional Discount | [optional] [default to undefined]
21
+
22
+ ## Example
23
+
24
+ ```typescript
25
+ import { DetailedItemRequestDTO } from 'yellowgrid-api-ts';
26
+
27
+ const instance: DetailedItemRequestDTO = {
28
+ sku,
29
+ quantity,
30
+ id,
31
+ licenceKey,
32
+ hosting,
33
+ processDate,
34
+ tcxSalesCode,
35
+ sbcs,
36
+ readOnly,
37
+ title,
38
+ itemPrice,
39
+ additionalDiscount,
40
+ };
41
+ ```
42
+
43
+ [[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,33 @@
1
+ # DetailedOrderRequestDTO
2
+
3
+ Detailed Order Request
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **orderReference** | **string** | Order Reference | [optional] [default to undefined]
10
+ **items** | [**Array&lt;DetailedItemRequestDTO&gt;**](DetailedItemRequestDTO.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 { DetailedOrderRequestDTO } from 'yellowgrid-api-ts';
21
+
22
+ const instance: DetailedOrderRequestDTO = {
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)
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
10
10
  **itemId** | **number** | itemId | [optional] [default to undefined]
11
11
  **priceList** | **string** | priceList | [optional] [default to undefined]
12
12
  **discount** | **number** | discount | [optional] [default to undefined]
13
+ **type** | **string** | type | [optional] [default to undefined]
13
14
  **description** | **string** | description | [optional] [default to undefined]
14
15
  **priority** | **number** | priority | [optional] [default to undefined]
15
16
 
@@ -23,6 +24,7 @@ const instance: ItemDiscountEntity = {
23
24
  itemId,
24
25
  priceList,
25
26
  discount,
27
+ type,
26
28
  description,
27
29
  priority,
28
30
  };
@@ -22,7 +22,7 @@ Name | Type | Description | Notes
22
22
  **shippingTax** | **number** | shippingTax | [optional] [default to undefined]
23
23
  **shippingTaxGbp** | **number** | shippingTaxGbp | [optional] [default to undefined]
24
24
  **customerRefunded** | **number** | customerRefunded | [optional] [default to undefined]
25
- **licencekey** | **string** | licencekey | [optional] [default to undefined]
25
+ **licenceKey** | **string** | licencekey | [optional] [default to undefined]
26
26
  **addHosting** | **number** | addHosting | [optional] [default to undefined]
27
27
  **licenceExpiryDate** | **string** | licenceExpiryDate | [optional] [default to undefined]
28
28
  **processDate** | **string** | processDate | [optional] [default to undefined]
@@ -51,7 +51,7 @@ const instance: ItemEntity = {
51
51
  shippingTax,
52
52
  shippingTaxGbp,
53
53
  customerRefunded,
54
- licencekey,
54
+ licenceKey,
55
55
  addHosting,
56
56
  licenceExpiryDate,
57
57
  processDate,
package/docs/OrdersApi.md CHANGED
@@ -5,6 +5,7 @@ All URIs are relative to *http://api.yellowgrid.local*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**deleteUpdateOrder**](#deleteupdateorder) | **DELETE** /orders/{id} | Delete Orders|
8
+ |[**getGetAdminEditableOrder**](#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)|
8
9
  |[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order|
9
10
  |[**getGetOrders**](#getgetorders) | **GET** /orders | Get Orders|
10
11
  |[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
@@ -66,8 +67,62 @@ No authorization required
66
67
 
67
68
  [[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)
68
69
 
70
+ # **getGetAdminEditableOrder**
71
+ > AdminOrderRequestDTO getGetAdminEditableOrder()
72
+
73
+ Get Editable Order (Admin)
74
+
75
+ ### Example
76
+
77
+ ```typescript
78
+ import {
79
+ OrdersApi,
80
+ Configuration
81
+ } from 'yellowgrid-api-ts';
82
+
83
+ const configuration = new Configuration();
84
+ const apiInstance = new OrdersApi(configuration);
85
+
86
+ let id: number; //Order ID (default to undefined)
87
+
88
+ const { status, data } = await apiInstance.getGetAdminEditableOrder(
89
+ id
90
+ );
91
+ ```
92
+
93
+ ### Parameters
94
+
95
+ |Name | Type | Description | Notes|
96
+ |------------- | ------------- | ------------- | -------------|
97
+ | **id** | [**number**] | Order ID | defaults to undefined|
98
+
99
+
100
+ ### Return type
101
+
102
+ **AdminOrderRequestDTO**
103
+
104
+ ### Authorization
105
+
106
+ No authorization required
107
+
108
+ ### HTTP request headers
109
+
110
+ - **Content-Type**: Not defined
111
+ - **Accept**: application/json
112
+
113
+
114
+ ### HTTP response details
115
+ | Status code | Description | Response headers |
116
+ |-------------|-------------|------------------|
117
+ |**200** | Order Request | - |
118
+ |**400** | Bad Request | - |
119
+ |**401** | Unauthorised | - |
120
+ |**403** | Access Denied | - |
121
+
122
+ [[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)
123
+
69
124
  # **getGetEditableOrder**
70
- > AdminOrderRequestDTO getGetEditableOrder()
125
+ > DetailedOrderRequestDTO getGetEditableOrder()
71
126
 
72
127
  Get Editable Order
73
128
 
@@ -98,7 +153,7 @@ const { status, data } = await apiInstance.getGetEditableOrder(
98
153
 
99
154
  ### Return type
100
155
 
101
- **AdminOrderRequestDTO**
156
+ **DetailedOrderRequestDTO**
102
157
 
103
158
  ### Authorization
104
159
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.1.13-dev.0",
3
+ "version": "3.1.14-dev.0",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {