yellowgrid-api-ts 3.1.13-dev.0 → 3.1.15-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.
- package/.openapi-generator/FILES +2 -2
- package/README.md +3 -1
- package/api.ts +223 -84
- package/dist/api.d.ts +185 -85
- package/dist/api.js +90 -3
- package/docs/AdminOrderRequestDTO.md +1 -1
- package/docs/DetailedItemRequestDTO.md +43 -0
- package/docs/DetailedOrderRequestDTO.md +33 -0
- package/docs/ItemDiscountEntity.md +2 -0
- package/docs/ItemEntity.md +2 -2
- package/docs/OrdersApi.md +57 -2
- package/docs/ProductSummaryDTO.md +2 -0
- package/hs_err_pid58424.log +247 -0
- package/package.json +1 -1
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<
|
|
664
|
+
* @type {Array<DetailedItemRequestDTO>}
|
|
744
665
|
* @memberof AdminOrderRequestDTO
|
|
745
666
|
*/
|
|
746
|
-
'items'?: Array<
|
|
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
|
-
'
|
|
3291
|
+
'licenceKey'?: string;
|
|
3231
3292
|
/**
|
|
3232
3293
|
* addHosting
|
|
3233
3294
|
* @type {number}
|
|
@@ -4688,6 +4749,12 @@ export interface ProductSummaryDTO {
|
|
|
4688
4749
|
* @memberof ProductSummaryDTO
|
|
4689
4750
|
*/
|
|
4690
4751
|
'rrp'?: number | null;
|
|
4752
|
+
/**
|
|
4753
|
+
*
|
|
4754
|
+
* @type {TcxLicenceDetailsModel}
|
|
4755
|
+
* @memberof ProductSummaryDTO
|
|
4756
|
+
*/
|
|
4757
|
+
'licenceDetails'?: TcxLicenceDetailsModel | null;
|
|
4691
4758
|
}
|
|
4692
4759
|
/**
|
|
4693
4760
|
* PromoCodesEntity
|
|
@@ -12755,6 +12822,14 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
12755
12822
|
* @throws {RequiredError}
|
|
12756
12823
|
*/
|
|
12757
12824
|
deleteUpdateOrder: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12825
|
+
/**
|
|
12826
|
+
* Get Editable Order (Admin)
|
|
12827
|
+
* @summary Get Editable Order (Admin)
|
|
12828
|
+
* @param {number} id Order ID
|
|
12829
|
+
* @param {*} [options] Override http request option.
|
|
12830
|
+
* @throws {RequiredError}
|
|
12831
|
+
*/
|
|
12832
|
+
getGetAdminEditableOrder: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
12758
12833
|
/**
|
|
12759
12834
|
* Get Editable Order
|
|
12760
12835
|
* @summary Get Editable Order
|
|
@@ -12829,6 +12904,14 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
12829
12904
|
* @throws {RequiredError}
|
|
12830
12905
|
*/
|
|
12831
12906
|
deleteUpdateOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
12907
|
+
/**
|
|
12908
|
+
* Get Editable Order (Admin)
|
|
12909
|
+
* @summary Get Editable Order (Admin)
|
|
12910
|
+
* @param {number} id Order ID
|
|
12911
|
+
* @param {*} [options] Override http request option.
|
|
12912
|
+
* @throws {RequiredError}
|
|
12913
|
+
*/
|
|
12914
|
+
getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminOrderRequestDTO>>;
|
|
12832
12915
|
/**
|
|
12833
12916
|
* Get Editable Order
|
|
12834
12917
|
* @summary Get Editable Order
|
|
@@ -12836,7 +12919,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
12836
12919
|
* @param {*} [options] Override http request option.
|
|
12837
12920
|
* @throws {RequiredError}
|
|
12838
12921
|
*/
|
|
12839
|
-
getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
12922
|
+
getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DetailedOrderRequestDTO>>;
|
|
12840
12923
|
/**
|
|
12841
12924
|
* Get Orders
|
|
12842
12925
|
* @summary Get Orders
|
|
@@ -12903,6 +12986,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
12903
12986
|
* @throws {RequiredError}
|
|
12904
12987
|
*/
|
|
12905
12988
|
deleteUpdateOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
12989
|
+
/**
|
|
12990
|
+
* Get Editable Order (Admin)
|
|
12991
|
+
* @summary Get Editable Order (Admin)
|
|
12992
|
+
* @param {number} id Order ID
|
|
12993
|
+
* @param {*} [options] Override http request option.
|
|
12994
|
+
* @throws {RequiredError}
|
|
12995
|
+
*/
|
|
12996
|
+
getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminOrderRequestDTO>;
|
|
12906
12997
|
/**
|
|
12907
12998
|
* Get Editable Order
|
|
12908
12999
|
* @summary Get Editable Order
|
|
@@ -12910,7 +13001,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
12910
13001
|
* @param {*} [options] Override http request option.
|
|
12911
13002
|
* @throws {RequiredError}
|
|
12912
13003
|
*/
|
|
12913
|
-
getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
13004
|
+
getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<DetailedOrderRequestDTO>;
|
|
12914
13005
|
/**
|
|
12915
13006
|
* Get Orders
|
|
12916
13007
|
* @summary Get Orders
|
|
@@ -12980,6 +13071,15 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
12980
13071
|
* @memberof OrdersApi
|
|
12981
13072
|
*/
|
|
12982
13073
|
deleteUpdateOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
13074
|
+
/**
|
|
13075
|
+
* Get Editable Order (Admin)
|
|
13076
|
+
* @summary Get Editable Order (Admin)
|
|
13077
|
+
* @param {number} id Order ID
|
|
13078
|
+
* @param {*} [options] Override http request option.
|
|
13079
|
+
* @throws {RequiredError}
|
|
13080
|
+
* @memberof OrdersApi
|
|
13081
|
+
*/
|
|
13082
|
+
getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminOrderRequestDTO, any, {}>>;
|
|
12983
13083
|
/**
|
|
12984
13084
|
* Get Editable Order
|
|
12985
13085
|
* @summary Get Editable Order
|
|
@@ -12988,7 +13088,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
12988
13088
|
* @throws {RequiredError}
|
|
12989
13089
|
* @memberof OrdersApi
|
|
12990
13090
|
*/
|
|
12991
|
-
getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
13091
|
+
getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DetailedOrderRequestDTO, any, {}>>;
|
|
12992
13092
|
/**
|
|
12993
13093
|
* Get Orders
|
|
12994
13094
|
* @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.
|
|
88
|
-
exports.
|
|
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<
|
|
10
|
+
**items** | [**Array<DetailedItemRequestDTO>**](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<TcxSbcDTO>**](TcxSbcDTO.md) | SBCS | [optional] [default to undefined]
|
|
17
|
+
**readOnly** | **boolean** | Read Only (Cannot be edited) | [optional] [default to undefined]
|
|
18
|
+
**title** | **string** | Title | [optional] [default to undefined]
|
|
19
|
+
**itemPrice** | **number** | Price (£) | [optional] [default to undefined]
|
|
20
|
+
**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<DetailedItemRequestDTO>**](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
|
};
|
package/docs/ItemEntity.md
CHANGED
|
@@ -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
|
-
**
|
|
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
|
-
|
|
54
|
+
licenceKey,
|
|
55
55
|
addHosting,
|
|
56
56
|
licenceExpiryDate,
|
|
57
57
|
processDate,
|