yellowgrid-api-ts 3.2.187-dev.0 → 3.2.188-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
@@ -311,6 +311,7 @@ Class | Method | HTTP request | Description
311
311
  *StockManagementApi* | [**postUploadStockOrderInvoice**](docs/StockManagementApi.md#postuploadstockorderinvoice) | **POST** /stock/orders/{id}/invoice | Upload Stock Order Supplier Invoice
312
312
  *StockManagementApi* | [**putGetStockProduct**](docs/StockManagementApi.md#putgetstockproduct) | **PUT** /stock/products/{id} | Update Stock Product
313
313
  *StockManagementApi* | [**putReceiveStockOrderItem**](docs/StockManagementApi.md#putreceivestockorderitem) | **PUT** /stock/orders/{order_id}/items/{item_id}/receive | Receive Stock Order Item
314
+ *SuppliersApi* | [**getGetSupplierItem**](docs/SuppliersApi.md#getgetsupplieritem) | **GET** /suppliers/items/{id} | Get Supplier Item
314
315
  *SuppliersApi* | [**getGetSupplierItems**](docs/SuppliersApi.md#getgetsupplieritems) | **GET** /suppliers/items | Get Supplier Items
315
316
  *SystemApi* | [**getLogSearch**](docs/SystemApi.md#getlogsearch) | **GET** /system/logs/api/search | Search for logs
316
317
  *TicketsApi* | [**getCreateTicket**](docs/TicketsApi.md#getcreateticket) | **GET** /tickets/support |
package/api.ts CHANGED
@@ -33797,6 +33797,40 @@ export class StockManagementApi extends BaseAPI {
33797
33797
  */
33798
33798
  export const SuppliersApiAxiosParamCreator = function (configuration?: Configuration) {
33799
33799
  return {
33800
+ /**
33801
+ * Get Supplier Item
33802
+ * @summary Get Supplier Item
33803
+ * @param {string} id ID (SKU)
33804
+ * @param {*} [options] Override http request option.
33805
+ * @throws {RequiredError}
33806
+ */
33807
+ getGetSupplierItem: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
33808
+ // verify required parameter 'id' is not null or undefined
33809
+ assertParamExists('getGetSupplierItem', 'id', id)
33810
+ const localVarPath = `/suppliers/items/{id}`
33811
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
33812
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
33813
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
33814
+ let baseOptions;
33815
+ if (configuration) {
33816
+ baseOptions = configuration.baseOptions;
33817
+ }
33818
+
33819
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
33820
+ const localVarHeaderParameter = {} as any;
33821
+ const localVarQueryParameter = {} as any;
33822
+
33823
+
33824
+
33825
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
33826
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
33827
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
33828
+
33829
+ return {
33830
+ url: toPathString(localVarUrlObj),
33831
+ options: localVarRequestOptions,
33832
+ };
33833
+ },
33800
33834
  /**
33801
33835
  * Get Supplier Items
33802
33836
  * @summary Get Supplier Items
@@ -33852,6 +33886,19 @@ export const SuppliersApiAxiosParamCreator = function (configuration?: Configura
33852
33886
  export const SuppliersApiFp = function(configuration?: Configuration) {
33853
33887
  const localVarAxiosParamCreator = SuppliersApiAxiosParamCreator(configuration)
33854
33888
  return {
33889
+ /**
33890
+ * Get Supplier Item
33891
+ * @summary Get Supplier Item
33892
+ * @param {string} id ID (SKU)
33893
+ * @param {*} [options] Override http request option.
33894
+ * @throws {RequiredError}
33895
+ */
33896
+ async getGetSupplierItem(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SupplierProductModel>> {
33897
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getGetSupplierItem(id, options);
33898
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
33899
+ const localVarOperationServerBasePath = operationServerMap['SuppliersApi.getGetSupplierItem']?.[localVarOperationServerIndex]?.url;
33900
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
33901
+ },
33855
33902
  /**
33856
33903
  * Get Supplier Items
33857
33904
  * @summary Get Supplier Items
@@ -33877,6 +33924,16 @@ export const SuppliersApiFp = function(configuration?: Configuration) {
33877
33924
  export const SuppliersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
33878
33925
  const localVarFp = SuppliersApiFp(configuration)
33879
33926
  return {
33927
+ /**
33928
+ * Get Supplier Item
33929
+ * @summary Get Supplier Item
33930
+ * @param {string} id ID (SKU)
33931
+ * @param {*} [options] Override http request option.
33932
+ * @throws {RequiredError}
33933
+ */
33934
+ getGetSupplierItem(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SupplierProductModel> {
33935
+ return localVarFp.getGetSupplierItem(id, options).then((request) => request(axios, basePath));
33936
+ },
33880
33937
  /**
33881
33938
  * Get Supplier Items
33882
33939
  * @summary Get Supplier Items
@@ -33899,6 +33956,18 @@ export const SuppliersApiFactory = function (configuration?: Configuration, base
33899
33956
  * @extends {BaseAPI}
33900
33957
  */
33901
33958
  export class SuppliersApi extends BaseAPI {
33959
+ /**
33960
+ * Get Supplier Item
33961
+ * @summary Get Supplier Item
33962
+ * @param {string} id ID (SKU)
33963
+ * @param {*} [options] Override http request option.
33964
+ * @throws {RequiredError}
33965
+ * @memberof SuppliersApi
33966
+ */
33967
+ public getGetSupplierItem(id: string, options?: RawAxiosRequestConfig) {
33968
+ return SuppliersApiFp(this.configuration).getGetSupplierItem(id, options).then((request) => request(this.axios, this.basePath));
33969
+ }
33970
+
33902
33971
  /**
33903
33972
  * Get Supplier Items
33904
33973
  * @summary Get Supplier Items
package/dist/api.d.ts CHANGED
@@ -23115,6 +23115,14 @@ export declare class StockManagementApi extends BaseAPI {
23115
23115
  * @export
23116
23116
  */
23117
23117
  export declare const SuppliersApiAxiosParamCreator: (configuration?: Configuration) => {
23118
+ /**
23119
+ * Get Supplier Item
23120
+ * @summary Get Supplier Item
23121
+ * @param {string} id ID (SKU)
23122
+ * @param {*} [options] Override http request option.
23123
+ * @throws {RequiredError}
23124
+ */
23125
+ getGetSupplierItem: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
23118
23126
  /**
23119
23127
  * Get Supplier Items
23120
23128
  * @summary Get Supplier Items
@@ -23131,6 +23139,14 @@ export declare const SuppliersApiAxiosParamCreator: (configuration?: Configurati
23131
23139
  * @export
23132
23140
  */
23133
23141
  export declare const SuppliersApiFp: (configuration?: Configuration) => {
23142
+ /**
23143
+ * Get Supplier Item
23144
+ * @summary Get Supplier Item
23145
+ * @param {string} id ID (SKU)
23146
+ * @param {*} [options] Override http request option.
23147
+ * @throws {RequiredError}
23148
+ */
23149
+ getGetSupplierItem(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SupplierProductModel>>;
23134
23150
  /**
23135
23151
  * Get Supplier Items
23136
23152
  * @summary Get Supplier Items
@@ -23147,6 +23163,14 @@ export declare const SuppliersApiFp: (configuration?: Configuration) => {
23147
23163
  * @export
23148
23164
  */
23149
23165
  export declare const SuppliersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
23166
+ /**
23167
+ * Get Supplier Item
23168
+ * @summary Get Supplier Item
23169
+ * @param {string} id ID (SKU)
23170
+ * @param {*} [options] Override http request option.
23171
+ * @throws {RequiredError}
23172
+ */
23173
+ getGetSupplierItem(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SupplierProductModel>;
23150
23174
  /**
23151
23175
  * Get Supplier Items
23152
23176
  * @summary Get Supplier Items
@@ -23165,6 +23189,15 @@ export declare const SuppliersApiFactory: (configuration?: Configuration, basePa
23165
23189
  * @extends {BaseAPI}
23166
23190
  */
23167
23191
  export declare class SuppliersApi extends BaseAPI {
23192
+ /**
23193
+ * Get Supplier Item
23194
+ * @summary Get Supplier Item
23195
+ * @param {string} id ID (SKU)
23196
+ * @param {*} [options] Override http request option.
23197
+ * @throws {RequiredError}
23198
+ * @memberof SuppliersApi
23199
+ */
23200
+ getGetSupplierItem(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SupplierProductModel, any, {}>>;
23168
23201
  /**
23169
23202
  * Get Supplier Items
23170
23203
  * @summary Get Supplier Items
package/dist/api.js CHANGED
@@ -24246,6 +24246,43 @@ exports.StockManagementApi = StockManagementApi;
24246
24246
  var SuppliersApiAxiosParamCreator = function (configuration) {
24247
24247
  var _this = this;
24248
24248
  return {
24249
+ /**
24250
+ * Get Supplier Item
24251
+ * @summary Get Supplier Item
24252
+ * @param {string} id ID (SKU)
24253
+ * @param {*} [options] Override http request option.
24254
+ * @throws {RequiredError}
24255
+ */
24256
+ getGetSupplierItem: function (id_1) {
24257
+ var args_1 = [];
24258
+ for (var _i = 1; _i < arguments.length; _i++) {
24259
+ args_1[_i - 1] = arguments[_i];
24260
+ }
24261
+ return __awaiter(_this, __spreadArray([id_1], args_1, true), void 0, function (id, options) {
24262
+ var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
24263
+ if (options === void 0) { options = {}; }
24264
+ return __generator(this, function (_a) {
24265
+ // verify required parameter 'id' is not null or undefined
24266
+ (0, common_1.assertParamExists)('getGetSupplierItem', 'id', id);
24267
+ localVarPath = "/suppliers/items/{id}"
24268
+ .replace("{".concat("id", "}"), encodeURIComponent(String(id)));
24269
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
24270
+ if (configuration) {
24271
+ baseOptions = configuration.baseOptions;
24272
+ }
24273
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
24274
+ localVarHeaderParameter = {};
24275
+ localVarQueryParameter = {};
24276
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
24277
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
24278
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
24279
+ return [2 /*return*/, {
24280
+ url: (0, common_1.toPathString)(localVarUrlObj),
24281
+ options: localVarRequestOptions,
24282
+ }];
24283
+ });
24284
+ });
24285
+ },
24249
24286
  /**
24250
24287
  * Get Supplier Items
24251
24288
  * @summary Get Supplier Items
@@ -24301,6 +24338,29 @@ exports.SuppliersApiAxiosParamCreator = SuppliersApiAxiosParamCreator;
24301
24338
  var SuppliersApiFp = function (configuration) {
24302
24339
  var localVarAxiosParamCreator = (0, exports.SuppliersApiAxiosParamCreator)(configuration);
24303
24340
  return {
24341
+ /**
24342
+ * Get Supplier Item
24343
+ * @summary Get Supplier Item
24344
+ * @param {string} id ID (SKU)
24345
+ * @param {*} [options] Override http request option.
24346
+ * @throws {RequiredError}
24347
+ */
24348
+ getGetSupplierItem: function (id, options) {
24349
+ return __awaiter(this, void 0, void 0, function () {
24350
+ var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
24351
+ var _a, _b, _c;
24352
+ return __generator(this, function (_d) {
24353
+ switch (_d.label) {
24354
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getGetSupplierItem(id, options)];
24355
+ case 1:
24356
+ localVarAxiosArgs = _d.sent();
24357
+ localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
24358
+ localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['SuppliersApi.getGetSupplierItem']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
24359
+ return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
24360
+ }
24361
+ });
24362
+ });
24363
+ },
24304
24364
  /**
24305
24365
  * Get Supplier Items
24306
24366
  * @summary Get Supplier Items
@@ -24336,6 +24396,16 @@ exports.SuppliersApiFp = SuppliersApiFp;
24336
24396
  var SuppliersApiFactory = function (configuration, basePath, axios) {
24337
24397
  var localVarFp = (0, exports.SuppliersApiFp)(configuration);
24338
24398
  return {
24399
+ /**
24400
+ * Get Supplier Item
24401
+ * @summary Get Supplier Item
24402
+ * @param {string} id ID (SKU)
24403
+ * @param {*} [options] Override http request option.
24404
+ * @throws {RequiredError}
24405
+ */
24406
+ getGetSupplierItem: function (id, options) {
24407
+ return localVarFp.getGetSupplierItem(id, options).then(function (request) { return request(axios, basePath); });
24408
+ },
24339
24409
  /**
24340
24410
  * Get Supplier Items
24341
24411
  * @summary Get Supplier Items
@@ -24362,6 +24432,18 @@ var SuppliersApi = /** @class */ (function (_super) {
24362
24432
  function SuppliersApi() {
24363
24433
  return _super !== null && _super.apply(this, arguments) || this;
24364
24434
  }
24435
+ /**
24436
+ * Get Supplier Item
24437
+ * @summary Get Supplier Item
24438
+ * @param {string} id ID (SKU)
24439
+ * @param {*} [options] Override http request option.
24440
+ * @throws {RequiredError}
24441
+ * @memberof SuppliersApi
24442
+ */
24443
+ SuppliersApi.prototype.getGetSupplierItem = function (id, options) {
24444
+ var _this = this;
24445
+ return (0, exports.SuppliersApiFp)(this.configuration).getGetSupplierItem(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
24446
+ };
24365
24447
  /**
24366
24448
  * Get Supplier Items
24367
24449
  * @summary Get Supplier Items
@@ -4,8 +4,63 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
+ |[**getGetSupplierItem**](#getgetsupplieritem) | **GET** /suppliers/items/{id} | Get Supplier Item|
7
8
  |[**getGetSupplierItems**](#getgetsupplieritems) | **GET** /suppliers/items | Get Supplier Items|
8
9
 
10
+ # **getGetSupplierItem**
11
+ > SupplierProductModel getGetSupplierItem()
12
+
13
+ Get Supplier Item
14
+
15
+ ### Example
16
+
17
+ ```typescript
18
+ import {
19
+ SuppliersApi,
20
+ Configuration
21
+ } from 'yellowgrid-api-ts';
22
+
23
+ const configuration = new Configuration();
24
+ const apiInstance = new SuppliersApi(configuration);
25
+
26
+ let id: string; //ID (SKU) (default to undefined)
27
+
28
+ const { status, data } = await apiInstance.getGetSupplierItem(
29
+ id
30
+ );
31
+ ```
32
+
33
+ ### Parameters
34
+
35
+ |Name | Type | Description | Notes|
36
+ |------------- | ------------- | ------------- | -------------|
37
+ | **id** | [**string**] | ID (SKU) | defaults to undefined|
38
+
39
+
40
+ ### Return type
41
+
42
+ **SupplierProductModel**
43
+
44
+ ### Authorization
45
+
46
+ No authorization required
47
+
48
+ ### HTTP request headers
49
+
50
+ - **Content-Type**: Not defined
51
+ - **Accept**: application/json
52
+
53
+
54
+ ### HTTP response details
55
+ | Status code | Description | Response headers |
56
+ |-------------|-------------|------------------|
57
+ |**200** | Supplier Item | - |
58
+ |**400** | Bad Request | - |
59
+ |**401** | Unauthorised | - |
60
+ |**403** | Access Denied | - |
61
+
62
+ [[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)
63
+
9
64
  # **getGetSupplierItems**
10
65
  > SupplierProductResultsModel getGetSupplierItems()
11
66
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.2.187-dev.0",
3
+ "version": "3.2.188-dev.0",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {