yellowgrid-api-ts 3.2.83-dev.0 → 3.2.87-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/README.md +1 -0
- package/api.ts +82 -0
- package/dist/api.d.ts +45 -0
- package/dist/api.js +90 -3
- package/docs/OrdersApi.md +55 -0
- package/docs/ShippingRequestDTO.md +2 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -160,6 +160,7 @@ Class | Method | HTTP request | Description
|
|
|
160
160
|
*OrdersApi* | [**getGetEditableOrder**](docs/OrdersApi.md#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)
|
|
161
161
|
*OrdersApi* | [**getGetItemSerialInfo**](docs/OrdersApi.md#getgetitemserialinfo) | **GET** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)
|
|
162
162
|
*OrdersApi* | [**getGetOrderPdf**](docs/OrdersApi.md#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF
|
|
163
|
+
*OrdersApi* | [**getGetOrderSummary**](docs/OrdersApi.md#getgetordersummary) | **GET** /admin/orders/{id}/summary | Get Order Summary (Admin)
|
|
163
164
|
*OrdersApi* | [**getGetOrders**](docs/OrdersApi.md#getgetorders) | **GET** /orders | Get Orders (Beta)
|
|
164
165
|
*OrdersApi* | [**postAddOrderNote**](docs/OrdersApi.md#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note
|
|
165
166
|
*OrdersApi* | [**postCreateAdminOrder**](docs/OrdersApi.md#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)
|
package/api.ts
CHANGED
|
@@ -7287,6 +7287,12 @@ export interface ShippingRequestDTO {
|
|
|
7287
7287
|
* @memberof ShippingRequestDTO
|
|
7288
7288
|
*/
|
|
7289
7289
|
'boxes'?: number;
|
|
7290
|
+
/**
|
|
7291
|
+
* Printer
|
|
7292
|
+
* @type {number}
|
|
7293
|
+
* @memberof ShippingRequestDTO
|
|
7294
|
+
*/
|
|
7295
|
+
'printer'?: ShippingRequestDTOPrinterEnum | null;
|
|
7290
7296
|
}
|
|
7291
7297
|
|
|
7292
7298
|
export const ShippingRequestDTOCourierEnum = {
|
|
@@ -7296,6 +7302,13 @@ export const ShippingRequestDTOCourierEnum = {
|
|
|
7296
7302
|
} as const;
|
|
7297
7303
|
|
|
7298
7304
|
export type ShippingRequestDTOCourierEnum = typeof ShippingRequestDTOCourierEnum[keyof typeof ShippingRequestDTOCourierEnum];
|
|
7305
|
+
export const ShippingRequestDTOPrinterEnum = {
|
|
7306
|
+
NUMBER_1: 1,
|
|
7307
|
+
NUMBER_2: 2,
|
|
7308
|
+
NUMBER_3: 3
|
|
7309
|
+
} as const;
|
|
7310
|
+
|
|
7311
|
+
export type ShippingRequestDTOPrinterEnum = typeof ShippingRequestDTOPrinterEnum[keyof typeof ShippingRequestDTOPrinterEnum];
|
|
7299
7312
|
|
|
7300
7313
|
/**
|
|
7301
7314
|
* Shipping Service
|
|
@@ -20101,6 +20114,40 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
20101
20114
|
|
|
20102
20115
|
|
|
20103
20116
|
|
|
20117
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20118
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20119
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
20120
|
+
|
|
20121
|
+
return {
|
|
20122
|
+
url: toPathString(localVarUrlObj),
|
|
20123
|
+
options: localVarRequestOptions,
|
|
20124
|
+
};
|
|
20125
|
+
},
|
|
20126
|
+
/**
|
|
20127
|
+
* Get Order Summary (Admin)
|
|
20128
|
+
* @summary Get Order Summary (Admin)
|
|
20129
|
+
* @param {number} id Order ID
|
|
20130
|
+
* @param {*} [options] Override http request option.
|
|
20131
|
+
* @throws {RequiredError}
|
|
20132
|
+
*/
|
|
20133
|
+
getGetOrderSummary: async (id: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
20134
|
+
// verify required parameter 'id' is not null or undefined
|
|
20135
|
+
assertParamExists('getGetOrderSummary', 'id', id)
|
|
20136
|
+
const localVarPath = `/admin/orders/{id}/summary`
|
|
20137
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
20138
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20139
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
20140
|
+
let baseOptions;
|
|
20141
|
+
if (configuration) {
|
|
20142
|
+
baseOptions = configuration.baseOptions;
|
|
20143
|
+
}
|
|
20144
|
+
|
|
20145
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
20146
|
+
const localVarHeaderParameter = {} as any;
|
|
20147
|
+
const localVarQueryParameter = {} as any;
|
|
20148
|
+
|
|
20149
|
+
|
|
20150
|
+
|
|
20104
20151
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20105
20152
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20106
20153
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -20918,6 +20965,19 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
20918
20965
|
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getGetOrderPdf']?.[localVarOperationServerIndex]?.url;
|
|
20919
20966
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
20920
20967
|
},
|
|
20968
|
+
/**
|
|
20969
|
+
* Get Order Summary (Admin)
|
|
20970
|
+
* @summary Get Order Summary (Admin)
|
|
20971
|
+
* @param {number} id Order ID
|
|
20972
|
+
* @param {*} [options] Override http request option.
|
|
20973
|
+
* @throws {RequiredError}
|
|
20974
|
+
*/
|
|
20975
|
+
async getGetOrderSummary(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderSummaryDTO>> {
|
|
20976
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getGetOrderSummary(id, options);
|
|
20977
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
20978
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getGetOrderSummary']?.[localVarOperationServerIndex]?.url;
|
|
20979
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
20980
|
+
},
|
|
20921
20981
|
/**
|
|
20922
20982
|
* Get Orders (Beta)
|
|
20923
20983
|
* @summary Get Orders (Beta)
|
|
@@ -21250,6 +21310,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
21250
21310
|
getGetOrderPdf(id: number, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
21251
21311
|
return localVarFp.getGetOrderPdf(id, options).then((request) => request(axios, basePath));
|
|
21252
21312
|
},
|
|
21313
|
+
/**
|
|
21314
|
+
* Get Order Summary (Admin)
|
|
21315
|
+
* @summary Get Order Summary (Admin)
|
|
21316
|
+
* @param {number} id Order ID
|
|
21317
|
+
* @param {*} [options] Override http request option.
|
|
21318
|
+
* @throws {RequiredError}
|
|
21319
|
+
*/
|
|
21320
|
+
getGetOrderSummary(id: number, options?: RawAxiosRequestConfig): AxiosPromise<OrderSummaryDTO> {
|
|
21321
|
+
return localVarFp.getGetOrderSummary(id, options).then((request) => request(axios, basePath));
|
|
21322
|
+
},
|
|
21253
21323
|
/**
|
|
21254
21324
|
* Get Orders (Beta)
|
|
21255
21325
|
* @summary Get Orders (Beta)
|
|
@@ -21550,6 +21620,18 @@ export class OrdersApi extends BaseAPI {
|
|
|
21550
21620
|
return OrdersApiFp(this.configuration).getGetOrderPdf(id, options).then((request) => request(this.axios, this.basePath));
|
|
21551
21621
|
}
|
|
21552
21622
|
|
|
21623
|
+
/**
|
|
21624
|
+
* Get Order Summary (Admin)
|
|
21625
|
+
* @summary Get Order Summary (Admin)
|
|
21626
|
+
* @param {number} id Order ID
|
|
21627
|
+
* @param {*} [options] Override http request option.
|
|
21628
|
+
* @throws {RequiredError}
|
|
21629
|
+
* @memberof OrdersApi
|
|
21630
|
+
*/
|
|
21631
|
+
public getGetOrderSummary(id: number, options?: RawAxiosRequestConfig) {
|
|
21632
|
+
return OrdersApiFp(this.configuration).getGetOrderSummary(id, options).then((request) => request(this.axios, this.basePath));
|
|
21633
|
+
}
|
|
21634
|
+
|
|
21553
21635
|
/**
|
|
21554
21636
|
* Get Orders (Beta)
|
|
21555
21637
|
* @summary Get Orders (Beta)
|
package/dist/api.d.ts
CHANGED
|
@@ -7233,6 +7233,12 @@ export interface ShippingRequestDTO {
|
|
|
7233
7233
|
* @memberof ShippingRequestDTO
|
|
7234
7234
|
*/
|
|
7235
7235
|
'boxes'?: number;
|
|
7236
|
+
/**
|
|
7237
|
+
* Printer
|
|
7238
|
+
* @type {number}
|
|
7239
|
+
* @memberof ShippingRequestDTO
|
|
7240
|
+
*/
|
|
7241
|
+
'printer'?: ShippingRequestDTOPrinterEnum | null;
|
|
7236
7242
|
}
|
|
7237
7243
|
export declare const ShippingRequestDTOCourierEnum: {
|
|
7238
7244
|
readonly Dpd: "DPD";
|
|
@@ -7240,6 +7246,12 @@ export declare const ShippingRequestDTOCourierEnum: {
|
|
|
7240
7246
|
readonly Pops: "POPS";
|
|
7241
7247
|
};
|
|
7242
7248
|
export type ShippingRequestDTOCourierEnum = typeof ShippingRequestDTOCourierEnum[keyof typeof ShippingRequestDTOCourierEnum];
|
|
7249
|
+
export declare const ShippingRequestDTOPrinterEnum: {
|
|
7250
|
+
readonly NUMBER_1: 1;
|
|
7251
|
+
readonly NUMBER_2: 2;
|
|
7252
|
+
readonly NUMBER_3: 3;
|
|
7253
|
+
};
|
|
7254
|
+
export type ShippingRequestDTOPrinterEnum = typeof ShippingRequestDTOPrinterEnum[keyof typeof ShippingRequestDTOPrinterEnum];
|
|
7243
7255
|
/**
|
|
7244
7256
|
* Shipping Service
|
|
7245
7257
|
* @export
|
|
@@ -15562,6 +15574,14 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
15562
15574
|
* @throws {RequiredError}
|
|
15563
15575
|
*/
|
|
15564
15576
|
getGetOrderPdf: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15577
|
+
/**
|
|
15578
|
+
* Get Order Summary (Admin)
|
|
15579
|
+
* @summary Get Order Summary (Admin)
|
|
15580
|
+
* @param {number} id Order ID
|
|
15581
|
+
* @param {*} [options] Override http request option.
|
|
15582
|
+
* @throws {RequiredError}
|
|
15583
|
+
*/
|
|
15584
|
+
getGetOrderSummary: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15565
15585
|
/**
|
|
15566
15586
|
* Get Orders (Beta)
|
|
15567
15587
|
* @summary Get Orders (Beta)
|
|
@@ -15794,6 +15814,14 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
15794
15814
|
* @throws {RequiredError}
|
|
15795
15815
|
*/
|
|
15796
15816
|
getGetOrderPdf(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
15817
|
+
/**
|
|
15818
|
+
* Get Order Summary (Admin)
|
|
15819
|
+
* @summary Get Order Summary (Admin)
|
|
15820
|
+
* @param {number} id Order ID
|
|
15821
|
+
* @param {*} [options] Override http request option.
|
|
15822
|
+
* @throws {RequiredError}
|
|
15823
|
+
*/
|
|
15824
|
+
getGetOrderSummary(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderSummaryDTO>>;
|
|
15797
15825
|
/**
|
|
15798
15826
|
* Get Orders (Beta)
|
|
15799
15827
|
* @summary Get Orders (Beta)
|
|
@@ -16026,6 +16054,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
16026
16054
|
* @throws {RequiredError}
|
|
16027
16055
|
*/
|
|
16028
16056
|
getGetOrderPdf(id: number, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
16057
|
+
/**
|
|
16058
|
+
* Get Order Summary (Admin)
|
|
16059
|
+
* @summary Get Order Summary (Admin)
|
|
16060
|
+
* @param {number} id Order ID
|
|
16061
|
+
* @param {*} [options] Override http request option.
|
|
16062
|
+
* @throws {RequiredError}
|
|
16063
|
+
*/
|
|
16064
|
+
getGetOrderSummary(id: number, options?: RawAxiosRequestConfig): AxiosPromise<OrderSummaryDTO>;
|
|
16029
16065
|
/**
|
|
16030
16066
|
* Get Orders (Beta)
|
|
16031
16067
|
* @summary Get Orders (Beta)
|
|
@@ -16268,6 +16304,15 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
16268
16304
|
* @memberof OrdersApi
|
|
16269
16305
|
*/
|
|
16270
16306
|
getGetOrderPdf(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
|
|
16307
|
+
/**
|
|
16308
|
+
* Get Order Summary (Admin)
|
|
16309
|
+
* @summary Get Order Summary (Admin)
|
|
16310
|
+
* @param {number} id Order ID
|
|
16311
|
+
* @param {*} [options] Override http request option.
|
|
16312
|
+
* @throws {RequiredError}
|
|
16313
|
+
* @memberof OrdersApi
|
|
16314
|
+
*/
|
|
16315
|
+
getGetOrderSummary(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSummaryDTO, any, {}>>;
|
|
16271
16316
|
/**
|
|
16272
16317
|
* Get Orders (Beta)
|
|
16273
16318
|
* @summary Get Orders (Beta)
|
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.ServicesApi = exports.ServicesApiFactory = exports.ServicesApiFp = exports.ServicesApiAxiosParamCreator = exports.SMSApi = exports.SMSApiFactory = exports.SMSApiFp = 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 = void 0;
|
|
87
|
+
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.ShippingRequestDTOPrinterEnum = exports.ShippingRequestDTOCourierEnum = exports.ShipmentRequestDTOCourierEnum = exports.ShipmentDTOCourierEnum = exports.ServiceStatusDTOStatusEnum = exports.ServiceHealthDTOGlobalStatusEnum = exports.OrderTotalModelCurrencyEnum = exports.OrderRequestModelSchoolTypeEnum = exports.OrderRequestModelLicenceTypeEnum = exports.MultiTenantChangeResponseModelTypeEnum = exports.ItemDiscountEntityTypeEnum = exports.HostingRegionDTOCodeEnum = exports.HostingChangeResponseModelTypeEnum = exports.EventDTOStatusEnum = exports.DivertResponseModelStatusEnum = exports.AuditLogEntityTypeEnum = exports.AuditLogEntityActionEnum = exports.AdminUserModelRoleEnum = void 0;
|
|
88
|
+
exports.PostSendPriceListFormatEnum = exports.PostSendPriceListTypeEnum = exports.GetGetPriceListCategoryEnum = exports.GetGetPriceListFormatEnum = exports.GetGetPriceListTypeEnum = exports.PricingApi = exports.PricingApiFactory = exports.PricingApiFp = exports.PricingApiAxiosParamCreator = exports.PostPrintShippingLabelPrinterEnum = 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.NumberPortingApi = exports.NumberPortingApiFactory = exports.NumberPortingApiFp = exports.NumberPortingApiAxiosParamCreator = 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 = exports.Class3CXIntegrationsApiFp = exports.Class3CXIntegrationsApiAxiosParamCreator = exports.PostResizeInstanceSizeEnum = exports.PostFailoverInstanceTypeEnum = exports.GetGetInstallationsInstallTypeEnum = exports.GetGetInstallationsHostingEnum = exports.GetGetInstallationsStatusEnum = exports.Class3CXInstallationsApi = exports.Class3CXInstallationsApiFactory = 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.ServicesApi = exports.ServicesApiFactory = exports.ServicesApiFp = exports.ServicesApiAxiosParamCreator = exports.SMSApi = exports.SMSApiFactory = exports.SMSApiFp = 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 = void 0;
|
|
90
90
|
var axios_1 = require("axios");
|
|
91
91
|
// Some imports not used depending on template conditions
|
|
92
92
|
// @ts-ignore
|
|
@@ -295,6 +295,11 @@ exports.ShippingRequestDTOCourierEnum = {
|
|
|
295
295
|
ChorltonPallet: 'Chorlton Pallet',
|
|
296
296
|
Pops: 'POPS'
|
|
297
297
|
};
|
|
298
|
+
exports.ShippingRequestDTOPrinterEnum = {
|
|
299
|
+
NUMBER_1: 1,
|
|
300
|
+
NUMBER_2: 2,
|
|
301
|
+
NUMBER_3: 3
|
|
302
|
+
};
|
|
298
303
|
exports.ShippingServiceDTOCourierEnum = {
|
|
299
304
|
Dpd: 'DPD',
|
|
300
305
|
ChorltonPallet: 'Chorlton Pallet',
|
|
@@ -10161,6 +10166,43 @@ var OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
10161
10166
|
});
|
|
10162
10167
|
});
|
|
10163
10168
|
},
|
|
10169
|
+
/**
|
|
10170
|
+
* Get Order Summary (Admin)
|
|
10171
|
+
* @summary Get Order Summary (Admin)
|
|
10172
|
+
* @param {number} id Order ID
|
|
10173
|
+
* @param {*} [options] Override http request option.
|
|
10174
|
+
* @throws {RequiredError}
|
|
10175
|
+
*/
|
|
10176
|
+
getGetOrderSummary: function (id_1) {
|
|
10177
|
+
var args_1 = [];
|
|
10178
|
+
for (var _i = 1; _i < arguments.length; _i++) {
|
|
10179
|
+
args_1[_i - 1] = arguments[_i];
|
|
10180
|
+
}
|
|
10181
|
+
return __awaiter(_this, __spreadArray([id_1], args_1, true), void 0, function (id, options) {
|
|
10182
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
10183
|
+
if (options === void 0) { options = {}; }
|
|
10184
|
+
return __generator(this, function (_a) {
|
|
10185
|
+
// verify required parameter 'id' is not null or undefined
|
|
10186
|
+
(0, common_1.assertParamExists)('getGetOrderSummary', 'id', id);
|
|
10187
|
+
localVarPath = "/admin/orders/{id}/summary"
|
|
10188
|
+
.replace("{".concat("id", "}"), encodeURIComponent(String(id)));
|
|
10189
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
10190
|
+
if (configuration) {
|
|
10191
|
+
baseOptions = configuration.baseOptions;
|
|
10192
|
+
}
|
|
10193
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
10194
|
+
localVarHeaderParameter = {};
|
|
10195
|
+
localVarQueryParameter = {};
|
|
10196
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
10197
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10198
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
10199
|
+
return [2 /*return*/, {
|
|
10200
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
10201
|
+
options: localVarRequestOptions,
|
|
10202
|
+
}];
|
|
10203
|
+
});
|
|
10204
|
+
});
|
|
10205
|
+
},
|
|
10164
10206
|
/**
|
|
10165
10207
|
* Get Orders (Beta)
|
|
10166
10208
|
* @summary Get Orders (Beta)
|
|
@@ -11071,6 +11113,29 @@ var OrdersApiFp = function (configuration) {
|
|
|
11071
11113
|
});
|
|
11072
11114
|
});
|
|
11073
11115
|
},
|
|
11116
|
+
/**
|
|
11117
|
+
* Get Order Summary (Admin)
|
|
11118
|
+
* @summary Get Order Summary (Admin)
|
|
11119
|
+
* @param {number} id Order ID
|
|
11120
|
+
* @param {*} [options] Override http request option.
|
|
11121
|
+
* @throws {RequiredError}
|
|
11122
|
+
*/
|
|
11123
|
+
getGetOrderSummary: function (id, options) {
|
|
11124
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
11125
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
11126
|
+
var _a, _b, _c;
|
|
11127
|
+
return __generator(this, function (_d) {
|
|
11128
|
+
switch (_d.label) {
|
|
11129
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetOrderSummary(id, options)];
|
|
11130
|
+
case 1:
|
|
11131
|
+
localVarAxiosArgs = _d.sent();
|
|
11132
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
11133
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.getGetOrderSummary']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
11134
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
11135
|
+
}
|
|
11136
|
+
});
|
|
11137
|
+
});
|
|
11138
|
+
},
|
|
11074
11139
|
/**
|
|
11075
11140
|
* Get Orders (Beta)
|
|
11076
11141
|
* @summary Get Orders (Beta)
|
|
@@ -11563,6 +11628,16 @@ var OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
11563
11628
|
getGetOrderPdf: function (id, options) {
|
|
11564
11629
|
return localVarFp.getGetOrderPdf(id, options).then(function (request) { return request(axios, basePath); });
|
|
11565
11630
|
},
|
|
11631
|
+
/**
|
|
11632
|
+
* Get Order Summary (Admin)
|
|
11633
|
+
* @summary Get Order Summary (Admin)
|
|
11634
|
+
* @param {number} id Order ID
|
|
11635
|
+
* @param {*} [options] Override http request option.
|
|
11636
|
+
* @throws {RequiredError}
|
|
11637
|
+
*/
|
|
11638
|
+
getGetOrderSummary: function (id, options) {
|
|
11639
|
+
return localVarFp.getGetOrderSummary(id, options).then(function (request) { return request(axios, basePath); });
|
|
11640
|
+
},
|
|
11566
11641
|
/**
|
|
11567
11642
|
* Get Orders (Beta)
|
|
11568
11643
|
* @summary Get Orders (Beta)
|
|
@@ -11867,6 +11942,18 @@ var OrdersApi = /** @class */ (function (_super) {
|
|
|
11867
11942
|
var _this = this;
|
|
11868
11943
|
return (0, exports.OrdersApiFp)(this.configuration).getGetOrderPdf(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
11869
11944
|
};
|
|
11945
|
+
/**
|
|
11946
|
+
* Get Order Summary (Admin)
|
|
11947
|
+
* @summary Get Order Summary (Admin)
|
|
11948
|
+
* @param {number} id Order ID
|
|
11949
|
+
* @param {*} [options] Override http request option.
|
|
11950
|
+
* @throws {RequiredError}
|
|
11951
|
+
* @memberof OrdersApi
|
|
11952
|
+
*/
|
|
11953
|
+
OrdersApi.prototype.getGetOrderSummary = function (id, options) {
|
|
11954
|
+
var _this = this;
|
|
11955
|
+
return (0, exports.OrdersApiFp)(this.configuration).getGetOrderSummary(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
11956
|
+
};
|
|
11870
11957
|
/**
|
|
11871
11958
|
* Get Orders (Beta)
|
|
11872
11959
|
* @summary Get Orders (Beta)
|
package/docs/OrdersApi.md
CHANGED
|
@@ -12,6 +12,7 @@ All URIs are relative to *https://api.yellowgrid.local*
|
|
|
12
12
|
|[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)|
|
|
13
13
|
|[**getGetItemSerialInfo**](#getgetitemserialinfo) | **GET** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)|
|
|
14
14
|
|[**getGetOrderPdf**](#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF|
|
|
15
|
+
|[**getGetOrderSummary**](#getgetordersummary) | **GET** /admin/orders/{id}/summary | Get Order Summary (Admin)|
|
|
15
16
|
|[**getGetOrders**](#getgetorders) | **GET** /orders | Get Orders (Beta)|
|
|
16
17
|
|[**postAddOrderNote**](#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note|
|
|
17
18
|
|[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
|
|
@@ -473,6 +474,60 @@ No authorization required
|
|
|
473
474
|
|
|
474
475
|
[[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)
|
|
475
476
|
|
|
477
|
+
# **getGetOrderSummary**
|
|
478
|
+
> OrderSummaryDTO getGetOrderSummary()
|
|
479
|
+
|
|
480
|
+
Get Order Summary (Admin)
|
|
481
|
+
|
|
482
|
+
### Example
|
|
483
|
+
|
|
484
|
+
```typescript
|
|
485
|
+
import {
|
|
486
|
+
OrdersApi,
|
|
487
|
+
Configuration
|
|
488
|
+
} from 'yellowgrid-api-ts';
|
|
489
|
+
|
|
490
|
+
const configuration = new Configuration();
|
|
491
|
+
const apiInstance = new OrdersApi(configuration);
|
|
492
|
+
|
|
493
|
+
let id: number; //Order ID (default to undefined)
|
|
494
|
+
|
|
495
|
+
const { status, data } = await apiInstance.getGetOrderSummary(
|
|
496
|
+
id
|
|
497
|
+
);
|
|
498
|
+
```
|
|
499
|
+
|
|
500
|
+
### Parameters
|
|
501
|
+
|
|
502
|
+
|Name | Type | Description | Notes|
|
|
503
|
+
|------------- | ------------- | ------------- | -------------|
|
|
504
|
+
| **id** | [**number**] | Order ID | defaults to undefined|
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
### Return type
|
|
508
|
+
|
|
509
|
+
**OrderSummaryDTO**
|
|
510
|
+
|
|
511
|
+
### Authorization
|
|
512
|
+
|
|
513
|
+
No authorization required
|
|
514
|
+
|
|
515
|
+
### HTTP request headers
|
|
516
|
+
|
|
517
|
+
- **Content-Type**: Not defined
|
|
518
|
+
- **Accept**: application/json
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
### HTTP response details
|
|
522
|
+
| Status code | Description | Response headers |
|
|
523
|
+
|-------------|-------------|------------------|
|
|
524
|
+
|**200** | Order Summary | - |
|
|
525
|
+
|**400** | Bad Request | - |
|
|
526
|
+
|**401** | Unauthorised | - |
|
|
527
|
+
|**403** | Access Denied | - |
|
|
528
|
+
|
|
529
|
+
[[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)
|
|
530
|
+
|
|
476
531
|
# **getGetOrders**
|
|
477
532
|
> OrderSummariesModel getGetOrders()
|
|
478
533
|
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**courier** | **string** | Courier | [optional] [default to undefined]
|
|
9
9
|
**service** | **string** | Courier Service | [optional] [default to undefined]
|
|
10
10
|
**boxes** | **number** | Boxes | [optional] [default to undefined]
|
|
11
|
+
**printer** | **number** | Printer | [optional] [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,6 +19,7 @@ const instance: ShippingRequestDTO = {
|
|
|
18
19
|
courier,
|
|
19
20
|
service,
|
|
20
21
|
boxes,
|
|
22
|
+
printer,
|
|
21
23
|
};
|
|
22
24
|
```
|
|
23
25
|
|