yellowgrid-api-ts 3.2.236 → 3.2.237
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 +4 -0
- package/README.md +7 -0
- package/api.ts +369 -0
- package/dist/api.d.ts +204 -0
- package/dist/api.js +380 -1
- package/docs/SupplierItemModel.md +2 -0
- package/docs/SupplierItemsResultsDTO.md +21 -0
- package/docs/SupplierProductModel.md +25 -0
- package/docs/SupplierProductResultsModel.md +27 -0
- package/docs/SuppliersApi.md +230 -0
- package/package.json +1 -1
|
@@ -0,0 +1,230 @@
|
|
|
1
|
+
# SuppliersApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://bitbucket.org*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getGetSupplierItem**](#getgetsupplieritem) | **GET** /suppliers/items/{id} | Get Supplier Item|
|
|
8
|
+
|[**getGetSupplierItems**](#getgetsupplieritems) | **GET** /suppliers/items | Get Supplier Items|
|
|
9
|
+
|[**getGetSuppliers**](#getgetsuppliers) | **GET** /suppliers | Get Suppliers|
|
|
10
|
+
|[**putGetSupplierItem**](#putgetsupplieritem) | **PUT** /suppliers/items/{id} | Update Supplier Product|
|
|
11
|
+
|
|
12
|
+
# **getGetSupplierItem**
|
|
13
|
+
> SupplierProductModel getGetSupplierItem()
|
|
14
|
+
|
|
15
|
+
Get Supplier Item
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import {
|
|
21
|
+
SuppliersApi,
|
|
22
|
+
Configuration
|
|
23
|
+
} from 'yellowgrid-api-ts';
|
|
24
|
+
|
|
25
|
+
const configuration = new Configuration();
|
|
26
|
+
const apiInstance = new SuppliersApi(configuration);
|
|
27
|
+
|
|
28
|
+
let id: string; //ID (SKU) (default to undefined)
|
|
29
|
+
|
|
30
|
+
const { status, data } = await apiInstance.getGetSupplierItem(
|
|
31
|
+
id
|
|
32
|
+
);
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Parameters
|
|
36
|
+
|
|
37
|
+
|Name | Type | Description | Notes|
|
|
38
|
+
|------------- | ------------- | ------------- | -------------|
|
|
39
|
+
| **id** | [**string**] | ID (SKU) | defaults to undefined|
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
### Return type
|
|
43
|
+
|
|
44
|
+
**SupplierProductModel**
|
|
45
|
+
|
|
46
|
+
### Authorization
|
|
47
|
+
|
|
48
|
+
No authorization required
|
|
49
|
+
|
|
50
|
+
### HTTP request headers
|
|
51
|
+
|
|
52
|
+
- **Content-Type**: Not defined
|
|
53
|
+
- **Accept**: application/json
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
### HTTP response details
|
|
57
|
+
| Status code | Description | Response headers |
|
|
58
|
+
|-------------|-------------|------------------|
|
|
59
|
+
|**200** | Supplier Item | - |
|
|
60
|
+
|**400** | Bad Request | - |
|
|
61
|
+
|**401** | Unauthorised | - |
|
|
62
|
+
|**403** | Access Denied | - |
|
|
63
|
+
|
|
64
|
+
[[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)
|
|
65
|
+
|
|
66
|
+
# **getGetSupplierItems**
|
|
67
|
+
> SupplierProductResultsModel getGetSupplierItems()
|
|
68
|
+
|
|
69
|
+
Get Supplier Items
|
|
70
|
+
|
|
71
|
+
### Example
|
|
72
|
+
|
|
73
|
+
```typescript
|
|
74
|
+
import {
|
|
75
|
+
SuppliersApi,
|
|
76
|
+
Configuration
|
|
77
|
+
} from 'yellowgrid-api-ts';
|
|
78
|
+
|
|
79
|
+
const configuration = new Configuration();
|
|
80
|
+
const apiInstance = new SuppliersApi(configuration);
|
|
81
|
+
|
|
82
|
+
let pageSize: number; //Number Of Results (optional) (default to 20)
|
|
83
|
+
let page: number; //Page Number (optional) (default to 1)
|
|
84
|
+
let search: string; //Search (optional) (default to undefined)
|
|
85
|
+
|
|
86
|
+
const { status, data } = await apiInstance.getGetSupplierItems(
|
|
87
|
+
pageSize,
|
|
88
|
+
page,
|
|
89
|
+
search
|
|
90
|
+
);
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### Parameters
|
|
94
|
+
|
|
95
|
+
|Name | Type | Description | Notes|
|
|
96
|
+
|------------- | ------------- | ------------- | -------------|
|
|
97
|
+
| **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
|
|
98
|
+
| **page** | [**number**] | Page Number | (optional) defaults to 1|
|
|
99
|
+
| **search** | [**string**] | Search | (optional) defaults to undefined|
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
### Return type
|
|
103
|
+
|
|
104
|
+
**SupplierProductResultsModel**
|
|
105
|
+
|
|
106
|
+
### Authorization
|
|
107
|
+
|
|
108
|
+
No authorization required
|
|
109
|
+
|
|
110
|
+
### HTTP request headers
|
|
111
|
+
|
|
112
|
+
- **Content-Type**: Not defined
|
|
113
|
+
- **Accept**: application/json
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
### HTTP response details
|
|
117
|
+
| Status code | Description | Response headers |
|
|
118
|
+
|-------------|-------------|------------------|
|
|
119
|
+
|**200** | Supplier Items | - |
|
|
120
|
+
|**400** | Bad Request | - |
|
|
121
|
+
|**401** | Unauthorised | - |
|
|
122
|
+
|**403** | Access Denied | - |
|
|
123
|
+
|
|
124
|
+
[[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)
|
|
125
|
+
|
|
126
|
+
# **getGetSuppliers**
|
|
127
|
+
> Array<SupplierModel> getGetSuppliers()
|
|
128
|
+
|
|
129
|
+
Get Suppliers
|
|
130
|
+
|
|
131
|
+
### Example
|
|
132
|
+
|
|
133
|
+
```typescript
|
|
134
|
+
import {
|
|
135
|
+
SuppliersApi,
|
|
136
|
+
Configuration
|
|
137
|
+
} from 'yellowgrid-api-ts';
|
|
138
|
+
|
|
139
|
+
const configuration = new Configuration();
|
|
140
|
+
const apiInstance = new SuppliersApi(configuration);
|
|
141
|
+
|
|
142
|
+
const { status, data } = await apiInstance.getGetSuppliers();
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
### Parameters
|
|
146
|
+
This endpoint does not have any parameters.
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
### Return type
|
|
150
|
+
|
|
151
|
+
**Array<SupplierModel>**
|
|
152
|
+
|
|
153
|
+
### Authorization
|
|
154
|
+
|
|
155
|
+
No authorization required
|
|
156
|
+
|
|
157
|
+
### HTTP request headers
|
|
158
|
+
|
|
159
|
+
- **Content-Type**: Not defined
|
|
160
|
+
- **Accept**: application/json
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
### HTTP response details
|
|
164
|
+
| Status code | Description | Response headers |
|
|
165
|
+
|-------------|-------------|------------------|
|
|
166
|
+
|**200** | Suppliers | - |
|
|
167
|
+
|**400** | Bad Request | - |
|
|
168
|
+
|**401** | Unauthorised | - |
|
|
169
|
+
|**403** | Access Denied | - |
|
|
170
|
+
|
|
171
|
+
[[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)
|
|
172
|
+
|
|
173
|
+
# **putGetSupplierItem**
|
|
174
|
+
> SupplierProductModel putGetSupplierItem()
|
|
175
|
+
|
|
176
|
+
Update Supplier Product
|
|
177
|
+
|
|
178
|
+
### Example
|
|
179
|
+
|
|
180
|
+
```typescript
|
|
181
|
+
import {
|
|
182
|
+
SuppliersApi,
|
|
183
|
+
Configuration,
|
|
184
|
+
SupplierProductModel
|
|
185
|
+
} from 'yellowgrid-api-ts';
|
|
186
|
+
|
|
187
|
+
const configuration = new Configuration();
|
|
188
|
+
const apiInstance = new SuppliersApi(configuration);
|
|
189
|
+
|
|
190
|
+
let id: string; //ID (SKU) (default to undefined)
|
|
191
|
+
let supplierProductModel: SupplierProductModel; //Supplier Product (optional)
|
|
192
|
+
|
|
193
|
+
const { status, data } = await apiInstance.putGetSupplierItem(
|
|
194
|
+
id,
|
|
195
|
+
supplierProductModel
|
|
196
|
+
);
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
### Parameters
|
|
200
|
+
|
|
201
|
+
|Name | Type | Description | Notes|
|
|
202
|
+
|------------- | ------------- | ------------- | -------------|
|
|
203
|
+
| **supplierProductModel** | **SupplierProductModel**| Supplier Product | |
|
|
204
|
+
| **id** | [**string**] | ID (SKU) | defaults to undefined|
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
### Return type
|
|
208
|
+
|
|
209
|
+
**SupplierProductModel**
|
|
210
|
+
|
|
211
|
+
### Authorization
|
|
212
|
+
|
|
213
|
+
No authorization required
|
|
214
|
+
|
|
215
|
+
### HTTP request headers
|
|
216
|
+
|
|
217
|
+
- **Content-Type**: application/json
|
|
218
|
+
- **Accept**: application/json
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
### HTTP response details
|
|
222
|
+
| Status code | Description | Response headers |
|
|
223
|
+
|-------------|-------------|------------------|
|
|
224
|
+
|**200** | Supplier Product Model | - |
|
|
225
|
+
|**400** | Bad Request | - |
|
|
226
|
+
|**401** | Unauthorised | - |
|
|
227
|
+
|**403** | Access Denied | - |
|
|
228
|
+
|
|
229
|
+
[[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)
|
|
230
|
+
|