yellowgrid-api-ts 3.1.8-dev.0 → 3.1.9-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 CHANGED
@@ -138,7 +138,6 @@ 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)
142
141
  *OrdersApi* | [**getGetEditableOrder**](docs/OrdersApi.md#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order
143
142
  *OrdersApi* | [**getGetOrders**](docs/OrdersApi.md#getgetorders) | **GET** /orders | Get Orders
144
143
  *OrdersApi* | [**postCreateAdminOrder**](docs/OrdersApi.md#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)
package/api.ts CHANGED
@@ -16234,40 +16234,6 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
16234
16234
 
16235
16235
 
16236
16236
 
16237
- setSearchParams(localVarUrlObj, localVarQueryParameter);
16238
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
16239
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
16240
-
16241
- return {
16242
- url: toPathString(localVarUrlObj),
16243
- options: localVarRequestOptions,
16244
- };
16245
- },
16246
- /**
16247
- * Get Editable Order (Admin)
16248
- * @summary Get Editable Order (Admin)
16249
- * @param {number} id Order ID
16250
- * @param {*} [options] Override http request option.
16251
- * @throws {RequiredError}
16252
- */
16253
- getGetAdminEditableOrder: async (id: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
16254
- // verify required parameter 'id' is not null or undefined
16255
- assertParamExists('getGetAdminEditableOrder', 'id', id)
16256
- const localVarPath = `/admin/orders/{id}/views/editable`
16257
- .replace(`{${"id"}}`, encodeURIComponent(String(id)));
16258
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
16259
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
16260
- let baseOptions;
16261
- if (configuration) {
16262
- baseOptions = configuration.baseOptions;
16263
- }
16264
-
16265
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
16266
- const localVarHeaderParameter = {} as any;
16267
- const localVarQueryParameter = {} as any;
16268
-
16269
-
16270
-
16271
16237
  setSearchParams(localVarUrlObj, localVarQueryParameter);
16272
16238
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
16273
16239
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -16563,19 +16529,6 @@ export const OrdersApiFp = function(configuration?: Configuration) {
16563
16529
  const localVarOperationServerBasePath = operationServerMap['OrdersApi.deleteUpdateOrder']?.[localVarOperationServerIndex]?.url;
16564
16530
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
16565
16531
  },
16566
- /**
16567
- * Get Editable Order (Admin)
16568
- * @summary Get Editable Order (Admin)
16569
- * @param {number} id Order ID
16570
- * @param {*} [options] Override http request option.
16571
- * @throws {RequiredError}
16572
- */
16573
- async getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminOrderRequestDTO>> {
16574
- const localVarAxiosArgs = await localVarAxiosParamCreator.getGetAdminEditableOrder(id, options);
16575
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
16576
- const localVarOperationServerBasePath = operationServerMap['OrdersApi.getGetAdminEditableOrder']?.[localVarOperationServerIndex]?.url;
16577
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
16578
- },
16579
16532
  /**
16580
16533
  * Get Editable Order
16581
16534
  * @summary Get Editable Order
@@ -16583,7 +16536,7 @@ export const OrdersApiFp = function(configuration?: Configuration) {
16583
16536
  * @param {*} [options] Override http request option.
16584
16537
  * @throws {RequiredError}
16585
16538
  */
16586
- async getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomerOrderRequestDTO>> {
16539
+ async getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminOrderRequestDTO>> {
16587
16540
  const localVarAxiosArgs = await localVarAxiosParamCreator.getGetEditableOrder(id, options);
16588
16541
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
16589
16542
  const localVarOperationServerBasePath = operationServerMap['OrdersApi.getGetEditableOrder']?.[localVarOperationServerIndex]?.url;
@@ -16686,16 +16639,6 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
16686
16639
  deleteUpdateOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
16687
16640
  return localVarFp.deleteUpdateOrder(id, options).then((request) => request(axios, basePath));
16688
16641
  },
16689
- /**
16690
- * Get Editable Order (Admin)
16691
- * @summary Get Editable Order (Admin)
16692
- * @param {number} id Order ID
16693
- * @param {*} [options] Override http request option.
16694
- * @throws {RequiredError}
16695
- */
16696
- getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminOrderRequestDTO> {
16697
- return localVarFp.getGetAdminEditableOrder(id, options).then((request) => request(axios, basePath));
16698
- },
16699
16642
  /**
16700
16643
  * Get Editable Order
16701
16644
  * @summary Get Editable Order
@@ -16703,7 +16646,7 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
16703
16646
  * @param {*} [options] Override http request option.
16704
16647
  * @throws {RequiredError}
16705
16648
  */
16706
- getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<CustomerOrderRequestDTO> {
16649
+ getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminOrderRequestDTO> {
16707
16650
  return localVarFp.getGetEditableOrder(id, options).then((request) => request(axios, basePath));
16708
16651
  },
16709
16652
  /**
@@ -16790,18 +16733,6 @@ export class OrdersApi extends BaseAPI {
16790
16733
  return OrdersApiFp(this.configuration).deleteUpdateOrder(id, options).then((request) => request(this.axios, this.basePath));
16791
16734
  }
16792
16735
 
16793
- /**
16794
- * Get Editable Order (Admin)
16795
- * @summary Get Editable Order (Admin)
16796
- * @param {number} id Order ID
16797
- * @param {*} [options] Override http request option.
16798
- * @throws {RequiredError}
16799
- * @memberof OrdersApi
16800
- */
16801
- public getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig) {
16802
- return OrdersApiFp(this.configuration).getGetAdminEditableOrder(id, options).then((request) => request(this.axios, this.basePath));
16803
- }
16804
-
16805
16736
  /**
16806
16737
  * Get Editable Order
16807
16738
  * @summary Get Editable Order
package/dist/api.d.ts CHANGED
@@ -12663,14 +12663,6 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
12663
12663
  * @throws {RequiredError}
12664
12664
  */
12665
12665
  deleteUpdateOrder: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12666
- /**
12667
- * Get Editable Order (Admin)
12668
- * @summary Get Editable Order (Admin)
12669
- * @param {number} id Order ID
12670
- * @param {*} [options] Override http request option.
12671
- * @throws {RequiredError}
12672
- */
12673
- getGetAdminEditableOrder: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12674
12666
  /**
12675
12667
  * Get Editable Order
12676
12668
  * @summary Get Editable Order
@@ -12745,14 +12737,6 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
12745
12737
  * @throws {RequiredError}
12746
12738
  */
12747
12739
  deleteUpdateOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
12748
- /**
12749
- * Get Editable Order (Admin)
12750
- * @summary Get Editable Order (Admin)
12751
- * @param {number} id Order ID
12752
- * @param {*} [options] Override http request option.
12753
- * @throws {RequiredError}
12754
- */
12755
- getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminOrderRequestDTO>>;
12756
12740
  /**
12757
12741
  * Get Editable Order
12758
12742
  * @summary Get Editable Order
@@ -12760,7 +12744,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
12760
12744
  * @param {*} [options] Override http request option.
12761
12745
  * @throws {RequiredError}
12762
12746
  */
12763
- getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomerOrderRequestDTO>>;
12747
+ getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminOrderRequestDTO>>;
12764
12748
  /**
12765
12749
  * Get Orders
12766
12750
  * @summary Get Orders
@@ -12827,14 +12811,6 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
12827
12811
  * @throws {RequiredError}
12828
12812
  */
12829
12813
  deleteUpdateOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
12830
- /**
12831
- * Get Editable Order (Admin)
12832
- * @summary Get Editable Order (Admin)
12833
- * @param {number} id Order ID
12834
- * @param {*} [options] Override http request option.
12835
- * @throws {RequiredError}
12836
- */
12837
- getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminOrderRequestDTO>;
12838
12814
  /**
12839
12815
  * Get Editable Order
12840
12816
  * @summary Get Editable Order
@@ -12842,7 +12818,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
12842
12818
  * @param {*} [options] Override http request option.
12843
12819
  * @throws {RequiredError}
12844
12820
  */
12845
- getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<CustomerOrderRequestDTO>;
12821
+ getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminOrderRequestDTO>;
12846
12822
  /**
12847
12823
  * Get Orders
12848
12824
  * @summary Get Orders
@@ -12912,15 +12888,6 @@ export declare class OrdersApi extends BaseAPI {
12912
12888
  * @memberof OrdersApi
12913
12889
  */
12914
12890
  deleteUpdateOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
12915
- /**
12916
- * Get Editable Order (Admin)
12917
- * @summary Get Editable Order (Admin)
12918
- * @param {number} id Order ID
12919
- * @param {*} [options] Override http request option.
12920
- * @throws {RequiredError}
12921
- * @memberof OrdersApi
12922
- */
12923
- getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminOrderRequestDTO, any, {}>>;
12924
12891
  /**
12925
12892
  * Get Editable Order
12926
12893
  * @summary Get Editable Order
@@ -12929,7 +12896,7 @@ export declare class OrdersApi extends BaseAPI {
12929
12896
  * @throws {RequiredError}
12930
12897
  * @memberof OrdersApi
12931
12898
  */
12932
- getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomerOrderRequestDTO, any, {}>>;
12899
+ getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminOrderRequestDTO, any, {}>>;
12933
12900
  /**
12934
12901
  * Get Orders
12935
12902
  * @summary Get Orders
package/dist/api.js CHANGED
@@ -8179,43 +8179,6 @@ var OrdersApiAxiosParamCreator = function (configuration) {
8179
8179
  });
8180
8180
  });
8181
8181
  },
8182
- /**
8183
- * Get Editable Order (Admin)
8184
- * @summary Get Editable Order (Admin)
8185
- * @param {number} id Order ID
8186
- * @param {*} [options] Override http request option.
8187
- * @throws {RequiredError}
8188
- */
8189
- getGetAdminEditableOrder: function (id_1) {
8190
- var args_1 = [];
8191
- for (var _i = 1; _i < arguments.length; _i++) {
8192
- args_1[_i - 1] = arguments[_i];
8193
- }
8194
- return __awaiter(_this, __spreadArray([id_1], args_1, true), void 0, function (id, options) {
8195
- var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
8196
- if (options === void 0) { options = {}; }
8197
- return __generator(this, function (_a) {
8198
- // verify required parameter 'id' is not null or undefined
8199
- (0, common_1.assertParamExists)('getGetAdminEditableOrder', 'id', id);
8200
- localVarPath = "/admin/orders/{id}/views/editable"
8201
- .replace("{".concat("id", "}"), encodeURIComponent(String(id)));
8202
- localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
8203
- if (configuration) {
8204
- baseOptions = configuration.baseOptions;
8205
- }
8206
- localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
8207
- localVarHeaderParameter = {};
8208
- localVarQueryParameter = {};
8209
- (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
8210
- headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8211
- localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
8212
- return [2 /*return*/, {
8213
- url: (0, common_1.toPathString)(localVarUrlObj),
8214
- options: localVarRequestOptions,
8215
- }];
8216
- });
8217
- });
8218
- },
8219
8182
  /**
8220
8183
  * Get Editable Order
8221
8184
  * @summary Get Editable Order
@@ -8515,29 +8478,6 @@ var OrdersApiFp = function (configuration) {
8515
8478
  });
8516
8479
  });
8517
8480
  },
8518
- /**
8519
- * Get Editable Order (Admin)
8520
- * @summary Get Editable Order (Admin)
8521
- * @param {number} id Order ID
8522
- * @param {*} [options] Override http request option.
8523
- * @throws {RequiredError}
8524
- */
8525
- getGetAdminEditableOrder: function (id, options) {
8526
- return __awaiter(this, void 0, void 0, function () {
8527
- var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
8528
- var _a, _b, _c;
8529
- return __generator(this, function (_d) {
8530
- switch (_d.label) {
8531
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetAdminEditableOrder(id, options)];
8532
- case 1:
8533
- localVarAxiosArgs = _d.sent();
8534
- localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
8535
- localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.getGetAdminEditableOrder']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
8536
- return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
8537
- }
8538
- });
8539
- });
8540
- },
8541
8481
  /**
8542
8482
  * Get Editable Order
8543
8483
  * @summary Get Editable Order
@@ -8708,16 +8648,6 @@ var OrdersApiFactory = function (configuration, basePath, axios) {
8708
8648
  deleteUpdateOrder: function (id, options) {
8709
8649
  return localVarFp.deleteUpdateOrder(id, options).then(function (request) { return request(axios, basePath); });
8710
8650
  },
8711
- /**
8712
- * Get Editable Order (Admin)
8713
- * @summary Get Editable Order (Admin)
8714
- * @param {number} id Order ID
8715
- * @param {*} [options] Override http request option.
8716
- * @throws {RequiredError}
8717
- */
8718
- getGetAdminEditableOrder: function (id, options) {
8719
- return localVarFp.getGetAdminEditableOrder(id, options).then(function (request) { return request(axios, basePath); });
8720
- },
8721
8651
  /**
8722
8652
  * Get Editable Order
8723
8653
  * @summary Get Editable Order
@@ -8816,18 +8746,6 @@ var OrdersApi = /** @class */ (function (_super) {
8816
8746
  var _this = this;
8817
8747
  return (0, exports.OrdersApiFp)(this.configuration).deleteUpdateOrder(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
8818
8748
  };
8819
- /**
8820
- * Get Editable Order (Admin)
8821
- * @summary Get Editable Order (Admin)
8822
- * @param {number} id Order ID
8823
- * @param {*} [options] Override http request option.
8824
- * @throws {RequiredError}
8825
- * @memberof OrdersApi
8826
- */
8827
- OrdersApi.prototype.getGetAdminEditableOrder = function (id, options) {
8828
- var _this = this;
8829
- return (0, exports.OrdersApiFp)(this.configuration).getGetAdminEditableOrder(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
8830
- };
8831
8749
  /**
8832
8750
  * Get Editable Order
8833
8751
  * @summary Get Editable Order
package/docs/OrdersApi.md CHANGED
@@ -5,7 +5,6 @@ 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)|
9
8
  |[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order|
10
9
  |[**getGetOrders**](#getgetorders) | **GET** /orders | Get Orders|
11
10
  |[**postCreateAdminOrder**](#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)|
@@ -67,62 +66,8 @@ No authorization required
67
66
 
68
67
  [[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)
69
68
 
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 Summary | - |
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
-
124
69
  # **getGetEditableOrder**
125
- > CustomerOrderRequestDTO getGetEditableOrder()
70
+ > AdminOrderRequestDTO getGetEditableOrder()
126
71
 
127
72
  Get Editable Order
128
73
 
@@ -153,7 +98,7 @@ const { status, data } = await apiInstance.getGetEditableOrder(
153
98
 
154
99
  ### Return type
155
100
 
156
- **CustomerOrderRequestDTO**
101
+ **AdminOrderRequestDTO**
157
102
 
158
103
  ### Authorization
159
104
 
@@ -168,7 +113,7 @@ No authorization required
168
113
  ### HTTP response details
169
114
  | Status code | Description | Response headers |
170
115
  |-------------|-------------|------------------|
171
- |**200** | Order Summary | - |
116
+ |**200** | Order Request | - |
172
117
  |**400** | Bad Request | - |
173
118
  |**401** | Unauthorised | - |
174
119
  |**403** | Access Denied | - |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.1.8-dev.0",
3
+ "version": "3.1.9-dev.0",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {