@teemill/gfn-catalog 1.4.0 → 2.0.2
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 +6 -28
- package/README.md +3 -3
- package/api.ts +1892 -0
- package/base.ts +86 -0
- package/common.ts +150 -0
- package/configuration.ts +110 -0
- package/dist/api.d.ts +1287 -0
- package/dist/api.js +966 -0
- package/dist/base.d.ts +66 -0
- package/dist/base.js +65 -0
- package/dist/common.d.ts +65 -0
- package/dist/common.js +161 -0
- package/dist/configuration.d.ts +91 -0
- package/dist/configuration.js +43 -0
- package/dist/esm/api.d.ts +1287 -0
- package/dist/esm/api.js +947 -0
- package/dist/esm/base.d.ts +66 -0
- package/dist/esm/{models/AttributeThumbnail.js → base.js} +38 -26
- package/dist/esm/common.d.ts +65 -0
- package/dist/esm/common.js +149 -0
- package/dist/esm/configuration.d.ts +91 -0
- package/dist/esm/configuration.js +39 -0
- package/dist/esm/index.d.ts +13 -3
- package/dist/esm/index.js +13 -3
- package/dist/index.d.ts +13 -3
- package/dist/index.js +15 -5
- package/git_push.sh +57 -0
- package/{dist/models/Stock.d.ts → index.ts} +8 -21
- package/package.json +14 -2
- package/tsconfig.json +4 -6
- package/dist/apis/ProductsApi.d.ts +0 -35
- package/dist/apis/ProductsApi.js +0 -85
- package/dist/apis/StatementsApi.d.ts +0 -48
- package/dist/apis/StatementsApi.js +0 -127
- package/dist/apis/TransactionsApi.d.ts +0 -48
- package/dist/apis/TransactionsApi.js +0 -129
- package/dist/apis/VariantsApi.d.ts +0 -82
- package/dist/apis/VariantsApi.js +0 -229
- package/dist/apis/index.d.ts +0 -4
- package/dist/apis/index.js +0 -22
- package/dist/esm/apis/ProductsApi.d.ts +0 -35
- package/dist/esm/apis/ProductsApi.js +0 -81
- package/dist/esm/apis/StatementsApi.d.ts +0 -48
- package/dist/esm/apis/StatementsApi.js +0 -123
- package/dist/esm/apis/TransactionsApi.d.ts +0 -48
- package/dist/esm/apis/TransactionsApi.js +0 -125
- package/dist/esm/apis/VariantsApi.d.ts +0 -82
- package/dist/esm/apis/VariantsApi.js +0 -225
- package/dist/esm/apis/index.d.ts +0 -4
- package/dist/esm/apis/index.js +0 -6
- package/dist/esm/models/ApiError.d.ts +0 -37
- package/dist/esm/models/ApiError.js +0 -42
- package/dist/esm/models/ApiValidationError.d.ts +0 -39
- package/dist/esm/models/ApiValidationError.js +0 -44
- package/dist/esm/models/Attribute.d.ts +0 -50
- package/dist/esm/models/Attribute.js +0 -49
- package/dist/esm/models/AttributeThumbnail.d.ts +0 -46
- package/dist/esm/models/ExportTransactionsRequest.d.ts +0 -43
- package/dist/esm/models/ExportTransactionsRequest.js +0 -42
- package/dist/esm/models/Image.d.ts +0 -67
- package/dist/esm/models/Image.js +0 -50
- package/dist/esm/models/ListStatements200Response.d.ts +0 -38
- package/dist/esm/models/ListStatements200Response.js +0 -41
- package/dist/esm/models/ListTransactions200Response.d.ts +0 -38
- package/dist/esm/models/ListTransactions200Response.js +0 -41
- package/dist/esm/models/Product.d.ts +0 -67
- package/dist/esm/models/Product.js +0 -52
- package/dist/esm/models/ProductsResponse.d.ts +0 -38
- package/dist/esm/models/ProductsResponse.js +0 -41
- package/dist/esm/models/Statement.d.ts +0 -61
- package/dist/esm/models/Statement.js +0 -60
- package/dist/esm/models/Stock.d.ts +0 -31
- package/dist/esm/models/Stock.js +0 -38
- package/dist/esm/models/StockResponse.d.ts +0 -38
- package/dist/esm/models/StockResponse.js +0 -41
- package/dist/esm/models/Transaction.d.ts +0 -68
- package/dist/esm/models/Transaction.js +0 -61
- package/dist/esm/models/TransactionOrder.d.ts +0 -37
- package/dist/esm/models/TransactionOrder.js +0 -44
- package/dist/esm/models/Variant.d.ts +0 -78
- package/dist/esm/models/Variant.js +0 -61
- package/dist/esm/models/VariantManufacturerOrigin.d.ts +0 -37
- package/dist/esm/models/VariantManufacturerOrigin.js +0 -40
- package/dist/esm/models/VariantProduct.d.ts +0 -37
- package/dist/esm/models/VariantProduct.js +0 -40
- package/dist/esm/models/VariantStock.d.ts +0 -50
- package/dist/esm/models/VariantStock.js +0 -45
- package/dist/esm/models/VariantsResponse.d.ts +0 -38
- package/dist/esm/models/VariantsResponse.js +0 -41
- package/dist/esm/models/index.d.ts +0 -20
- package/dist/esm/models/index.js +0 -22
- package/dist/esm/runtime.d.ts +0 -187
- package/dist/esm/runtime.js +0 -333
- package/dist/models/ApiError.d.ts +0 -37
- package/dist/models/ApiError.js +0 -49
- package/dist/models/ApiValidationError.d.ts +0 -39
- package/dist/models/ApiValidationError.js +0 -51
- package/dist/models/Attribute.d.ts +0 -50
- package/dist/models/Attribute.js +0 -56
- package/dist/models/AttributeThumbnail.d.ts +0 -46
- package/dist/models/AttributeThumbnail.js +0 -55
- package/dist/models/ExportTransactionsRequest.d.ts +0 -43
- package/dist/models/ExportTransactionsRequest.js +0 -49
- package/dist/models/Image.d.ts +0 -67
- package/dist/models/Image.js +0 -57
- package/dist/models/ListStatements200Response.d.ts +0 -38
- package/dist/models/ListStatements200Response.js +0 -48
- package/dist/models/ListTransactions200Response.d.ts +0 -38
- package/dist/models/ListTransactions200Response.js +0 -48
- package/dist/models/Product.d.ts +0 -67
- package/dist/models/Product.js +0 -59
- package/dist/models/ProductsResponse.d.ts +0 -38
- package/dist/models/ProductsResponse.js +0 -48
- package/dist/models/Statement.d.ts +0 -61
- package/dist/models/Statement.js +0 -67
- package/dist/models/Stock.js +0 -45
- package/dist/models/StockResponse.d.ts +0 -38
- package/dist/models/StockResponse.js +0 -48
- package/dist/models/Transaction.d.ts +0 -68
- package/dist/models/Transaction.js +0 -68
- package/dist/models/TransactionOrder.d.ts +0 -37
- package/dist/models/TransactionOrder.js +0 -51
- package/dist/models/Variant.d.ts +0 -78
- package/dist/models/Variant.js +0 -68
- package/dist/models/VariantManufacturerOrigin.d.ts +0 -37
- package/dist/models/VariantManufacturerOrigin.js +0 -47
- package/dist/models/VariantProduct.d.ts +0 -37
- package/dist/models/VariantProduct.js +0 -47
- package/dist/models/VariantStock.d.ts +0 -50
- package/dist/models/VariantStock.js +0 -52
- package/dist/models/VariantsResponse.d.ts +0 -38
- package/dist/models/VariantsResponse.js +0 -48
- package/dist/models/index.d.ts +0 -20
- package/dist/models/index.js +0 -38
- package/dist/runtime.d.ts +0 -187
- package/dist/runtime.js +0 -349
- package/src/apis/ProductsApi.ts +0 -116
- package/src/apis/StatementsApi.ts +0 -177
- package/src/apis/TransactionsApi.ts +0 -180
- package/src/apis/VariantsApi.ts +0 -345
- package/src/apis/index.ts +0 -6
- package/src/index.ts +0 -5
- package/src/models/ApiError.ts +0 -69
- package/src/models/ApiValidationError.ts +0 -70
- package/src/models/Attribute.ts +0 -93
- package/src/models/AttributeThumbnail.ts +0 -80
- package/src/models/ExportTransactionsRequest.ts +0 -76
- package/src/models/Image.ts +0 -108
- package/src/models/ListStatements200Response.ts +0 -75
- package/src/models/ListTransactions200Response.ts +0 -75
- package/src/models/Product.ts +0 -109
- package/src/models/ProductsResponse.ts +0 -75
- package/src/models/Statement.ts +0 -106
- package/src/models/Stock.ts +0 -60
- package/src/models/StockResponse.ts +0 -75
- package/src/models/Transaction.ts +0 -120
- package/src/models/TransactionOrder.ts +0 -70
- package/src/models/Variant.ts +0 -149
- package/src/models/VariantManufacturerOrigin.ts +0 -68
- package/src/models/VariantProduct.ts +0 -68
- package/src/models/VariantStock.ts +0 -91
- package/src/models/VariantsResponse.ts +0 -75
- package/src/models/index.ts +0 -22
- package/src/runtime.ts +0 -441
package/api.ts
ADDED
|
@@ -0,0 +1,1892 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* GFN Catalog API
|
|
5
|
+
* Use this API to access the Global Fulfilment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.0.2
|
|
8
|
+
* Contact: hello@teemill.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
import type { Configuration } from './configuration';
|
|
17
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
18
|
+
import globalAxios from 'axios';
|
|
19
|
+
// Some imports not used depending on template conditions
|
|
20
|
+
// @ts-ignore
|
|
21
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
|
|
22
|
+
import type { RequestArgs } from './base';
|
|
23
|
+
// @ts-ignore
|
|
24
|
+
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @export
|
|
29
|
+
* @interface ApiError
|
|
30
|
+
*/
|
|
31
|
+
export interface ApiError {
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof ApiError
|
|
36
|
+
*/
|
|
37
|
+
'code'?: string;
|
|
38
|
+
/**
|
|
39
|
+
*
|
|
40
|
+
* @type {string}
|
|
41
|
+
* @memberof ApiError
|
|
42
|
+
*/
|
|
43
|
+
'message': string;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
*
|
|
47
|
+
* @export
|
|
48
|
+
* @interface ApiValidationError
|
|
49
|
+
*/
|
|
50
|
+
export interface ApiValidationError {
|
|
51
|
+
/**
|
|
52
|
+
*
|
|
53
|
+
* @type {string}
|
|
54
|
+
* @memberof ApiValidationError
|
|
55
|
+
*/
|
|
56
|
+
'message': string;
|
|
57
|
+
/**
|
|
58
|
+
*
|
|
59
|
+
* @type {{ [key: string]: Array<string>; }}
|
|
60
|
+
* @memberof ApiValidationError
|
|
61
|
+
*/
|
|
62
|
+
'errors': { [key: string]: Array<string>; };
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
*
|
|
66
|
+
* @export
|
|
67
|
+
* @interface Attribute
|
|
68
|
+
*/
|
|
69
|
+
export interface Attribute {
|
|
70
|
+
/**
|
|
71
|
+
* Attribute name
|
|
72
|
+
* @type {string}
|
|
73
|
+
* @memberof Attribute
|
|
74
|
+
*/
|
|
75
|
+
'name': string;
|
|
76
|
+
/**
|
|
77
|
+
* Attribute value
|
|
78
|
+
* @type {string}
|
|
79
|
+
* @memberof Attribute
|
|
80
|
+
*/
|
|
81
|
+
'value': string;
|
|
82
|
+
/**
|
|
83
|
+
*
|
|
84
|
+
* @type {AttributeThumbnail}
|
|
85
|
+
* @memberof Attribute
|
|
86
|
+
*/
|
|
87
|
+
'thumbnail'?: AttributeThumbnail;
|
|
88
|
+
/**
|
|
89
|
+
* Attribute tags
|
|
90
|
+
* @type {Array<string>}
|
|
91
|
+
* @memberof Attribute
|
|
92
|
+
*/
|
|
93
|
+
'tags'?: Array<string>;
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* Attribute thumbnail
|
|
97
|
+
* @export
|
|
98
|
+
* @interface AttributeThumbnail
|
|
99
|
+
*/
|
|
100
|
+
export interface AttributeThumbnail {
|
|
101
|
+
/**
|
|
102
|
+
*
|
|
103
|
+
* @type {string}
|
|
104
|
+
* @memberof AttributeThumbnail
|
|
105
|
+
*/
|
|
106
|
+
'type'?: AttributeThumbnailTypeEnum;
|
|
107
|
+
/**
|
|
108
|
+
*
|
|
109
|
+
* @type {string}
|
|
110
|
+
* @memberof AttributeThumbnail
|
|
111
|
+
*/
|
|
112
|
+
'value'?: string;
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
export const AttributeThumbnailTypeEnum = {
|
|
116
|
+
Text: 'text',
|
|
117
|
+
Color: 'color',
|
|
118
|
+
Image: 'image'
|
|
119
|
+
} as const;
|
|
120
|
+
|
|
121
|
+
export type AttributeThumbnailTypeEnum = typeof AttributeThumbnailTypeEnum[keyof typeof AttributeThumbnailTypeEnum];
|
|
122
|
+
|
|
123
|
+
/**
|
|
124
|
+
*
|
|
125
|
+
* @export
|
|
126
|
+
* @interface ExportTransactionsRequest
|
|
127
|
+
*/
|
|
128
|
+
export interface ExportTransactionsRequest {
|
|
129
|
+
/**
|
|
130
|
+
* The start date for the export
|
|
131
|
+
* @type {string}
|
|
132
|
+
* @memberof ExportTransactionsRequest
|
|
133
|
+
*/
|
|
134
|
+
'start'?: string;
|
|
135
|
+
/**
|
|
136
|
+
* The end date for the export
|
|
137
|
+
* @type {string}
|
|
138
|
+
* @memberof ExportTransactionsRequest
|
|
139
|
+
*/
|
|
140
|
+
'end'?: string;
|
|
141
|
+
/**
|
|
142
|
+
* Include only transactions from this statement
|
|
143
|
+
* @type {string}
|
|
144
|
+
* @memberof ExportTransactionsRequest
|
|
145
|
+
*/
|
|
146
|
+
'statement'?: string;
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* Image description
|
|
150
|
+
* @export
|
|
151
|
+
* @interface Image
|
|
152
|
+
*/
|
|
153
|
+
export interface Image {
|
|
154
|
+
/**
|
|
155
|
+
* Unique object identifier
|
|
156
|
+
* @type {string}
|
|
157
|
+
* @memberof Image
|
|
158
|
+
*/
|
|
159
|
+
'id'?: string;
|
|
160
|
+
/**
|
|
161
|
+
*
|
|
162
|
+
* @type {string}
|
|
163
|
+
* @memberof Image
|
|
164
|
+
*/
|
|
165
|
+
'src'?: string;
|
|
166
|
+
/**
|
|
167
|
+
*
|
|
168
|
+
* @type {string}
|
|
169
|
+
* @memberof Image
|
|
170
|
+
*/
|
|
171
|
+
'alt'?: string;
|
|
172
|
+
/**
|
|
173
|
+
* List of variant Ids
|
|
174
|
+
* @type {Array<string>}
|
|
175
|
+
* @memberof Image
|
|
176
|
+
*/
|
|
177
|
+
'variantIds'?: Array<string>;
|
|
178
|
+
/**
|
|
179
|
+
*
|
|
180
|
+
* @type {number}
|
|
181
|
+
* @memberof Image
|
|
182
|
+
*/
|
|
183
|
+
'sortOrder'?: number;
|
|
184
|
+
/**
|
|
185
|
+
*
|
|
186
|
+
* @type {string}
|
|
187
|
+
* @memberof Image
|
|
188
|
+
*/
|
|
189
|
+
'createdAt'?: string;
|
|
190
|
+
/**
|
|
191
|
+
*
|
|
192
|
+
* @type {string}
|
|
193
|
+
* @memberof Image
|
|
194
|
+
*/
|
|
195
|
+
'updatedAt'?: string;
|
|
196
|
+
}
|
|
197
|
+
/**
|
|
198
|
+
*
|
|
199
|
+
* @export
|
|
200
|
+
* @interface ListStatements200Response
|
|
201
|
+
*/
|
|
202
|
+
export interface ListStatements200Response {
|
|
203
|
+
/**
|
|
204
|
+
*
|
|
205
|
+
* @type {Array<Statement>}
|
|
206
|
+
* @memberof ListStatements200Response
|
|
207
|
+
*/
|
|
208
|
+
'statements'?: Array<Statement>;
|
|
209
|
+
/**
|
|
210
|
+
*
|
|
211
|
+
* @type {number}
|
|
212
|
+
* @memberof ListStatements200Response
|
|
213
|
+
*/
|
|
214
|
+
'nextPageToken'?: number | null;
|
|
215
|
+
}
|
|
216
|
+
/**
|
|
217
|
+
*
|
|
218
|
+
* @export
|
|
219
|
+
* @interface ListTransactions200Response
|
|
220
|
+
*/
|
|
221
|
+
export interface ListTransactions200Response {
|
|
222
|
+
/**
|
|
223
|
+
*
|
|
224
|
+
* @type {Array<Transaction>}
|
|
225
|
+
* @memberof ListTransactions200Response
|
|
226
|
+
*/
|
|
227
|
+
'transactions'?: Array<Transaction>;
|
|
228
|
+
/**
|
|
229
|
+
*
|
|
230
|
+
* @type {number}
|
|
231
|
+
* @memberof ListTransactions200Response
|
|
232
|
+
*/
|
|
233
|
+
'nextPageToken'?: number | null;
|
|
234
|
+
}
|
|
235
|
+
/**
|
|
236
|
+
*
|
|
237
|
+
* @export
|
|
238
|
+
* @interface Product
|
|
239
|
+
*/
|
|
240
|
+
export interface Product {
|
|
241
|
+
/**
|
|
242
|
+
* Unique object identifier
|
|
243
|
+
* @type {string}
|
|
244
|
+
* @memberof Product
|
|
245
|
+
*/
|
|
246
|
+
'id'?: string;
|
|
247
|
+
/**
|
|
248
|
+
* A reference to the resource location
|
|
249
|
+
* @type {string}
|
|
250
|
+
* @memberof Product
|
|
251
|
+
*/
|
|
252
|
+
'ref'?: string;
|
|
253
|
+
/**
|
|
254
|
+
*
|
|
255
|
+
* @type {string}
|
|
256
|
+
* @memberof Product
|
|
257
|
+
*/
|
|
258
|
+
'title': string;
|
|
259
|
+
/**
|
|
260
|
+
*
|
|
261
|
+
* @type {string}
|
|
262
|
+
* @memberof Product
|
|
263
|
+
*/
|
|
264
|
+
'styleCode'?: string;
|
|
265
|
+
/**
|
|
266
|
+
*
|
|
267
|
+
* @type {string}
|
|
268
|
+
* @memberof Product
|
|
269
|
+
*/
|
|
270
|
+
'material'?: string;
|
|
271
|
+
/**
|
|
272
|
+
*
|
|
273
|
+
* @type {string}
|
|
274
|
+
* @memberof Product
|
|
275
|
+
*/
|
|
276
|
+
'description'?: string;
|
|
277
|
+
/**
|
|
278
|
+
*
|
|
279
|
+
* @type {string}
|
|
280
|
+
* @memberof Product
|
|
281
|
+
*/
|
|
282
|
+
'specifications'?: string;
|
|
283
|
+
}
|
|
284
|
+
/**
|
|
285
|
+
*
|
|
286
|
+
* @export
|
|
287
|
+
* @interface ProductsResponse
|
|
288
|
+
*/
|
|
289
|
+
export interface ProductsResponse {
|
|
290
|
+
/**
|
|
291
|
+
*
|
|
292
|
+
* @type {Array<Product>}
|
|
293
|
+
* @memberof ProductsResponse
|
|
294
|
+
*/
|
|
295
|
+
'products'?: Array<Product>;
|
|
296
|
+
/**
|
|
297
|
+
*
|
|
298
|
+
* @type {number}
|
|
299
|
+
* @memberof ProductsResponse
|
|
300
|
+
*/
|
|
301
|
+
'nextPageToken'?: number;
|
|
302
|
+
}
|
|
303
|
+
/**
|
|
304
|
+
*
|
|
305
|
+
* @export
|
|
306
|
+
* @interface Statement
|
|
307
|
+
*/
|
|
308
|
+
export interface Statement {
|
|
309
|
+
/**
|
|
310
|
+
* Unique object identifier
|
|
311
|
+
* @type {string}
|
|
312
|
+
* @memberof Statement
|
|
313
|
+
*/
|
|
314
|
+
'id': string;
|
|
315
|
+
/**
|
|
316
|
+
* A reference to the resource location
|
|
317
|
+
* @type {string}
|
|
318
|
+
* @memberof Statement
|
|
319
|
+
*/
|
|
320
|
+
'ref': string;
|
|
321
|
+
/**
|
|
322
|
+
*
|
|
323
|
+
* @type {number}
|
|
324
|
+
* @memberof Statement
|
|
325
|
+
*/
|
|
326
|
+
'total': number;
|
|
327
|
+
/**
|
|
328
|
+
*
|
|
329
|
+
* @type {string}
|
|
330
|
+
* @memberof Statement
|
|
331
|
+
*/
|
|
332
|
+
'startDate': string;
|
|
333
|
+
/**
|
|
334
|
+
*
|
|
335
|
+
* @type {string}
|
|
336
|
+
* @memberof Statement
|
|
337
|
+
*/
|
|
338
|
+
'endDate': string;
|
|
339
|
+
/**
|
|
340
|
+
*
|
|
341
|
+
* @type {string}
|
|
342
|
+
* @memberof Statement
|
|
343
|
+
*/
|
|
344
|
+
'createdAt': string;
|
|
345
|
+
}
|
|
346
|
+
/**
|
|
347
|
+
*
|
|
348
|
+
* @export
|
|
349
|
+
* @interface Stock
|
|
350
|
+
*/
|
|
351
|
+
export interface Stock {
|
|
352
|
+
/**
|
|
353
|
+
* Current stock level
|
|
354
|
+
* @type {number}
|
|
355
|
+
* @memberof Stock
|
|
356
|
+
*/
|
|
357
|
+
'level'?: number;
|
|
358
|
+
}
|
|
359
|
+
/**
|
|
360
|
+
*
|
|
361
|
+
* @export
|
|
362
|
+
* @interface StockResponse
|
|
363
|
+
*/
|
|
364
|
+
export interface StockResponse {
|
|
365
|
+
/**
|
|
366
|
+
*
|
|
367
|
+
* @type {Array<VariantStock>}
|
|
368
|
+
* @memberof StockResponse
|
|
369
|
+
*/
|
|
370
|
+
'variants'?: Array<VariantStock>;
|
|
371
|
+
/**
|
|
372
|
+
*
|
|
373
|
+
* @type {number}
|
|
374
|
+
* @memberof StockResponse
|
|
375
|
+
*/
|
|
376
|
+
'nextPageToken'?: number;
|
|
377
|
+
}
|
|
378
|
+
/**
|
|
379
|
+
*
|
|
380
|
+
* @export
|
|
381
|
+
* @interface Transaction
|
|
382
|
+
*/
|
|
383
|
+
export interface Transaction {
|
|
384
|
+
/**
|
|
385
|
+
* Unique object identifier
|
|
386
|
+
* @type {string}
|
|
387
|
+
* @memberof Transaction
|
|
388
|
+
*/
|
|
389
|
+
'id': string;
|
|
390
|
+
/**
|
|
391
|
+
* A reference to the resource location
|
|
392
|
+
* @type {string}
|
|
393
|
+
* @memberof Transaction
|
|
394
|
+
*/
|
|
395
|
+
'ref': string;
|
|
396
|
+
/**
|
|
397
|
+
* A reference to the resource location
|
|
398
|
+
* @type {string}
|
|
399
|
+
* @memberof Transaction
|
|
400
|
+
*/
|
|
401
|
+
'statement'?: string;
|
|
402
|
+
/**
|
|
403
|
+
*
|
|
404
|
+
* @type {TransactionOrder}
|
|
405
|
+
* @memberof Transaction
|
|
406
|
+
*/
|
|
407
|
+
'order': TransactionOrder;
|
|
408
|
+
/**
|
|
409
|
+
*
|
|
410
|
+
* @type {TransactionOrder}
|
|
411
|
+
* @memberof Transaction
|
|
412
|
+
*/
|
|
413
|
+
'fulfillment'?: TransactionOrder;
|
|
414
|
+
/**
|
|
415
|
+
*
|
|
416
|
+
* @type {number}
|
|
417
|
+
* @memberof Transaction
|
|
418
|
+
*/
|
|
419
|
+
'total': number;
|
|
420
|
+
/**
|
|
421
|
+
*
|
|
422
|
+
* @type {string}
|
|
423
|
+
* @memberof Transaction
|
|
424
|
+
*/
|
|
425
|
+
'issuedAt': string;
|
|
426
|
+
}
|
|
427
|
+
/**
|
|
428
|
+
*
|
|
429
|
+
* @export
|
|
430
|
+
* @interface TransactionOrder
|
|
431
|
+
*/
|
|
432
|
+
export interface TransactionOrder {
|
|
433
|
+
/**
|
|
434
|
+
* A reference to the resource location
|
|
435
|
+
* @type {string}
|
|
436
|
+
* @memberof TransactionOrder
|
|
437
|
+
*/
|
|
438
|
+
'ref': string;
|
|
439
|
+
/**
|
|
440
|
+
* A reference to the resource location
|
|
441
|
+
* @type {string}
|
|
442
|
+
* @memberof TransactionOrder
|
|
443
|
+
*/
|
|
444
|
+
'project': string;
|
|
445
|
+
}
|
|
446
|
+
/**
|
|
447
|
+
*
|
|
448
|
+
* @export
|
|
449
|
+
* @interface Variant
|
|
450
|
+
*/
|
|
451
|
+
export interface Variant {
|
|
452
|
+
/**
|
|
453
|
+
* Unique object identifier
|
|
454
|
+
* @type {string}
|
|
455
|
+
* @memberof Variant
|
|
456
|
+
*/
|
|
457
|
+
'id'?: string;
|
|
458
|
+
/**
|
|
459
|
+
* A reference to the resource location
|
|
460
|
+
* @type {string}
|
|
461
|
+
* @memberof Variant
|
|
462
|
+
*/
|
|
463
|
+
'ref'?: string;
|
|
464
|
+
/**
|
|
465
|
+
*
|
|
466
|
+
* @type {VariantProduct}
|
|
467
|
+
* @memberof Variant
|
|
468
|
+
*/
|
|
469
|
+
'product'?: VariantProduct;
|
|
470
|
+
/**
|
|
471
|
+
*
|
|
472
|
+
* @type {string}
|
|
473
|
+
* @memberof Variant
|
|
474
|
+
*/
|
|
475
|
+
'sku': string;
|
|
476
|
+
/**
|
|
477
|
+
* Attributes associated to a variant such as Colour and Size. An attribute can have thumbnail type of `text`, `color`, or `image`. Attribute tags are intended for grouping and filtering, e.g. by a group of colours.
|
|
478
|
+
* @type {Array<Attribute>}
|
|
479
|
+
* @memberof Variant
|
|
480
|
+
*/
|
|
481
|
+
'attributes': Array<Attribute>;
|
|
482
|
+
/**
|
|
483
|
+
*
|
|
484
|
+
* @type {VariantManufacturerOrigin}
|
|
485
|
+
* @memberof Variant
|
|
486
|
+
*/
|
|
487
|
+
'manufacturerOrigin'?: VariantManufacturerOrigin;
|
|
488
|
+
/**
|
|
489
|
+
*
|
|
490
|
+
* @type {Stock}
|
|
491
|
+
* @memberof Variant
|
|
492
|
+
*/
|
|
493
|
+
'stock'?: Stock;
|
|
494
|
+
/**
|
|
495
|
+
* Images
|
|
496
|
+
* @type {Array<Image>}
|
|
497
|
+
* @memberof Variant
|
|
498
|
+
*/
|
|
499
|
+
'images'?: Array<Image>;
|
|
500
|
+
}
|
|
501
|
+
/**
|
|
502
|
+
* Where the product was originally produced or manufactured
|
|
503
|
+
* @export
|
|
504
|
+
* @interface VariantManufacturerOrigin
|
|
505
|
+
*/
|
|
506
|
+
export interface VariantManufacturerOrigin {
|
|
507
|
+
/**
|
|
508
|
+
* Country of origin (ISO 3166-1 alpha-2).
|
|
509
|
+
* @type {string}
|
|
510
|
+
* @memberof VariantManufacturerOrigin
|
|
511
|
+
*/
|
|
512
|
+
'country'?: string;
|
|
513
|
+
/**
|
|
514
|
+
* Name of the country of origin
|
|
515
|
+
* @type {string}
|
|
516
|
+
* @memberof VariantManufacturerOrigin
|
|
517
|
+
*/
|
|
518
|
+
'name'?: string;
|
|
519
|
+
}
|
|
520
|
+
/**
|
|
521
|
+
*
|
|
522
|
+
* @export
|
|
523
|
+
* @interface VariantProduct
|
|
524
|
+
*/
|
|
525
|
+
export interface VariantProduct {
|
|
526
|
+
/**
|
|
527
|
+
* Unique object identifier
|
|
528
|
+
* @type {string}
|
|
529
|
+
* @memberof VariantProduct
|
|
530
|
+
*/
|
|
531
|
+
'id'?: string;
|
|
532
|
+
/**
|
|
533
|
+
* A reference to the resource location
|
|
534
|
+
* @type {string}
|
|
535
|
+
* @memberof VariantProduct
|
|
536
|
+
*/
|
|
537
|
+
'ref'?: string;
|
|
538
|
+
}
|
|
539
|
+
/**
|
|
540
|
+
*
|
|
541
|
+
* @export
|
|
542
|
+
* @interface VariantStock
|
|
543
|
+
*/
|
|
544
|
+
export interface VariantStock {
|
|
545
|
+
/**
|
|
546
|
+
* Unique object identifier
|
|
547
|
+
* @type {string}
|
|
548
|
+
* @memberof VariantStock
|
|
549
|
+
*/
|
|
550
|
+
'id'?: string;
|
|
551
|
+
/**
|
|
552
|
+
* A reference to the resource location
|
|
553
|
+
* @type {string}
|
|
554
|
+
* @memberof VariantStock
|
|
555
|
+
*/
|
|
556
|
+
'ref'?: string;
|
|
557
|
+
/**
|
|
558
|
+
* A reference to the resource location
|
|
559
|
+
* @type {string}
|
|
560
|
+
* @memberof VariantStock
|
|
561
|
+
*/
|
|
562
|
+
'productRef'?: string;
|
|
563
|
+
/**
|
|
564
|
+
*
|
|
565
|
+
* @type {Stock}
|
|
566
|
+
* @memberof VariantStock
|
|
567
|
+
*/
|
|
568
|
+
'stock'?: Stock;
|
|
569
|
+
}
|
|
570
|
+
/**
|
|
571
|
+
*
|
|
572
|
+
* @export
|
|
573
|
+
* @interface VariantsResponse
|
|
574
|
+
*/
|
|
575
|
+
export interface VariantsResponse {
|
|
576
|
+
/**
|
|
577
|
+
*
|
|
578
|
+
* @type {Array<Variant>}
|
|
579
|
+
* @memberof VariantsResponse
|
|
580
|
+
*/
|
|
581
|
+
'variants'?: Array<Variant>;
|
|
582
|
+
/**
|
|
583
|
+
*
|
|
584
|
+
* @type {number}
|
|
585
|
+
* @memberof VariantsResponse
|
|
586
|
+
*/
|
|
587
|
+
'nextPageToken'?: number;
|
|
588
|
+
}
|
|
589
|
+
|
|
590
|
+
/**
|
|
591
|
+
* ProductsApi - axios parameter creator
|
|
592
|
+
* @export
|
|
593
|
+
*/
|
|
594
|
+
export const ProductsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
595
|
+
return {
|
|
596
|
+
/**
|
|
597
|
+
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
598
|
+
* @summary List GFN products
|
|
599
|
+
* @param {string} project What project it is
|
|
600
|
+
* @param {number} [pageToken] Page reference token
|
|
601
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
602
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
603
|
+
* @param {string} [search] Search terms to filter based on.
|
|
604
|
+
* @param {*} [options] Override http request option.
|
|
605
|
+
* @throws {RequiredError}
|
|
606
|
+
*/
|
|
607
|
+
listProducts: async (project: string, pageToken?: number, pageSize?: number, fields?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
608
|
+
// verify required parameter 'project' is not null or undefined
|
|
609
|
+
assertParamExists('listProducts', 'project', project)
|
|
610
|
+
const localVarPath = `/v1/gfn/catalog/products`;
|
|
611
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
612
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
613
|
+
let baseOptions;
|
|
614
|
+
if (configuration) {
|
|
615
|
+
baseOptions = configuration.baseOptions;
|
|
616
|
+
}
|
|
617
|
+
|
|
618
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
619
|
+
const localVarHeaderParameter = {} as any;
|
|
620
|
+
const localVarQueryParameter = {} as any;
|
|
621
|
+
|
|
622
|
+
// authentication session-oauth required
|
|
623
|
+
// oauth required
|
|
624
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
625
|
+
|
|
626
|
+
// authentication api-key required
|
|
627
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
628
|
+
|
|
629
|
+
if (project !== undefined) {
|
|
630
|
+
localVarQueryParameter['project'] = project;
|
|
631
|
+
}
|
|
632
|
+
|
|
633
|
+
if (pageToken !== undefined) {
|
|
634
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
635
|
+
}
|
|
636
|
+
|
|
637
|
+
if (pageSize !== undefined) {
|
|
638
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
639
|
+
}
|
|
640
|
+
|
|
641
|
+
if (fields !== undefined) {
|
|
642
|
+
localVarQueryParameter['fields'] = fields;
|
|
643
|
+
}
|
|
644
|
+
|
|
645
|
+
if (search !== undefined) {
|
|
646
|
+
localVarQueryParameter['search'] = search;
|
|
647
|
+
}
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
652
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
653
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
654
|
+
|
|
655
|
+
return {
|
|
656
|
+
url: toPathString(localVarUrlObj),
|
|
657
|
+
options: localVarRequestOptions,
|
|
658
|
+
};
|
|
659
|
+
},
|
|
660
|
+
}
|
|
661
|
+
};
|
|
662
|
+
|
|
663
|
+
/**
|
|
664
|
+
* ProductsApi - functional programming interface
|
|
665
|
+
* @export
|
|
666
|
+
*/
|
|
667
|
+
export const ProductsApiFp = function(configuration?: Configuration) {
|
|
668
|
+
const localVarAxiosParamCreator = ProductsApiAxiosParamCreator(configuration)
|
|
669
|
+
return {
|
|
670
|
+
/**
|
|
671
|
+
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
672
|
+
* @summary List GFN products
|
|
673
|
+
* @param {string} project What project it is
|
|
674
|
+
* @param {number} [pageToken] Page reference token
|
|
675
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
676
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
677
|
+
* @param {string} [search] Search terms to filter based on.
|
|
678
|
+
* @param {*} [options] Override http request option.
|
|
679
|
+
* @throws {RequiredError}
|
|
680
|
+
*/
|
|
681
|
+
async listProducts(project: string, pageToken?: number, pageSize?: number, fields?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>> {
|
|
682
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProducts(project, pageToken, pageSize, fields, search, options);
|
|
683
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
684
|
+
const localVarOperationServerBasePath = operationServerMap['ProductsApi.listProducts']?.[localVarOperationServerIndex]?.url;
|
|
685
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
686
|
+
},
|
|
687
|
+
}
|
|
688
|
+
};
|
|
689
|
+
|
|
690
|
+
/**
|
|
691
|
+
* ProductsApi - factory interface
|
|
692
|
+
* @export
|
|
693
|
+
*/
|
|
694
|
+
export const ProductsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
695
|
+
const localVarFp = ProductsApiFp(configuration)
|
|
696
|
+
return {
|
|
697
|
+
/**
|
|
698
|
+
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
699
|
+
* @summary List GFN products
|
|
700
|
+
* @param {ProductsApiListProductsRequest} requestParameters Request parameters.
|
|
701
|
+
* @param {*} [options] Override http request option.
|
|
702
|
+
* @throws {RequiredError}
|
|
703
|
+
*/
|
|
704
|
+
listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse> {
|
|
705
|
+
return localVarFp.listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.fields, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
706
|
+
},
|
|
707
|
+
};
|
|
708
|
+
};
|
|
709
|
+
|
|
710
|
+
/**
|
|
711
|
+
* Request parameters for listProducts operation in ProductsApi.
|
|
712
|
+
* @export
|
|
713
|
+
* @interface ProductsApiListProductsRequest
|
|
714
|
+
*/
|
|
715
|
+
export interface ProductsApiListProductsRequest {
|
|
716
|
+
/**
|
|
717
|
+
* What project it is
|
|
718
|
+
* @type {string}
|
|
719
|
+
* @memberof ProductsApiListProducts
|
|
720
|
+
*/
|
|
721
|
+
readonly project: string
|
|
722
|
+
|
|
723
|
+
/**
|
|
724
|
+
* Page reference token
|
|
725
|
+
* @type {number}
|
|
726
|
+
* @memberof ProductsApiListProducts
|
|
727
|
+
*/
|
|
728
|
+
readonly pageToken?: number
|
|
729
|
+
|
|
730
|
+
/**
|
|
731
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
732
|
+
* @type {number}
|
|
733
|
+
* @memberof ProductsApiListProducts
|
|
734
|
+
*/
|
|
735
|
+
readonly pageSize?: number
|
|
736
|
+
|
|
737
|
+
/**
|
|
738
|
+
* Filter response fields to only include a subset of the resource.
|
|
739
|
+
* @type {string}
|
|
740
|
+
* @memberof ProductsApiListProducts
|
|
741
|
+
*/
|
|
742
|
+
readonly fields?: string
|
|
743
|
+
|
|
744
|
+
/**
|
|
745
|
+
* Search terms to filter based on.
|
|
746
|
+
* @type {string}
|
|
747
|
+
* @memberof ProductsApiListProducts
|
|
748
|
+
*/
|
|
749
|
+
readonly search?: string
|
|
750
|
+
}
|
|
751
|
+
|
|
752
|
+
/**
|
|
753
|
+
* ProductsApi - object-oriented interface
|
|
754
|
+
* @export
|
|
755
|
+
* @class ProductsApi
|
|
756
|
+
* @extends {BaseAPI}
|
|
757
|
+
*/
|
|
758
|
+
export class ProductsApi extends BaseAPI {
|
|
759
|
+
/**
|
|
760
|
+
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
761
|
+
* @summary List GFN products
|
|
762
|
+
* @param {ProductsApiListProductsRequest} requestParameters Request parameters.
|
|
763
|
+
* @param {*} [options] Override http request option.
|
|
764
|
+
* @throws {RequiredError}
|
|
765
|
+
* @memberof ProductsApi
|
|
766
|
+
*/
|
|
767
|
+
public listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig) {
|
|
768
|
+
return ProductsApiFp(this.configuration).listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.fields, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
769
|
+
}
|
|
770
|
+
}
|
|
771
|
+
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
/**
|
|
775
|
+
* StatementsApi - axios parameter creator
|
|
776
|
+
* @export
|
|
777
|
+
*/
|
|
778
|
+
export const StatementsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
779
|
+
return {
|
|
780
|
+
/**
|
|
781
|
+
* Gets a GFN statement by the given ID.
|
|
782
|
+
* @summary Get a GFN statement
|
|
783
|
+
* @param {string} project What project it is
|
|
784
|
+
* @param {string} statementId
|
|
785
|
+
* @param {*} [options] Override http request option.
|
|
786
|
+
* @throws {RequiredError}
|
|
787
|
+
*/
|
|
788
|
+
getStatement: async (project: string, statementId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
789
|
+
// verify required parameter 'project' is not null or undefined
|
|
790
|
+
assertParamExists('getStatement', 'project', project)
|
|
791
|
+
// verify required parameter 'statementId' is not null or undefined
|
|
792
|
+
assertParamExists('getStatement', 'statementId', statementId)
|
|
793
|
+
const localVarPath = `/v1/gfn/statements/{statementId}`
|
|
794
|
+
.replace(`{${"statementId"}}`, encodeURIComponent(String(statementId)));
|
|
795
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
796
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
797
|
+
let baseOptions;
|
|
798
|
+
if (configuration) {
|
|
799
|
+
baseOptions = configuration.baseOptions;
|
|
800
|
+
}
|
|
801
|
+
|
|
802
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
803
|
+
const localVarHeaderParameter = {} as any;
|
|
804
|
+
const localVarQueryParameter = {} as any;
|
|
805
|
+
|
|
806
|
+
// authentication session-oauth required
|
|
807
|
+
// oauth required
|
|
808
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
809
|
+
|
|
810
|
+
// authentication api-key required
|
|
811
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
812
|
+
|
|
813
|
+
if (project !== undefined) {
|
|
814
|
+
localVarQueryParameter['project'] = project;
|
|
815
|
+
}
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
820
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
821
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
822
|
+
|
|
823
|
+
return {
|
|
824
|
+
url: toPathString(localVarUrlObj),
|
|
825
|
+
options: localVarRequestOptions,
|
|
826
|
+
};
|
|
827
|
+
},
|
|
828
|
+
/**
|
|
829
|
+
* Lists GFN statements available to the project
|
|
830
|
+
* @summary List GFN statements
|
|
831
|
+
* @param {string} project What project it is
|
|
832
|
+
* @param {number} [pageToken] Page reference token
|
|
833
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
834
|
+
* @param {string} [search] Search term used to filter results by
|
|
835
|
+
* @param {*} [options] Override http request option.
|
|
836
|
+
* @throws {RequiredError}
|
|
837
|
+
*/
|
|
838
|
+
listStatements: async (project: string, pageToken?: number, pageSize?: number, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
839
|
+
// verify required parameter 'project' is not null or undefined
|
|
840
|
+
assertParamExists('listStatements', 'project', project)
|
|
841
|
+
const localVarPath = `/v1/gfn/statements`;
|
|
842
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
843
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
844
|
+
let baseOptions;
|
|
845
|
+
if (configuration) {
|
|
846
|
+
baseOptions = configuration.baseOptions;
|
|
847
|
+
}
|
|
848
|
+
|
|
849
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
850
|
+
const localVarHeaderParameter = {} as any;
|
|
851
|
+
const localVarQueryParameter = {} as any;
|
|
852
|
+
|
|
853
|
+
// authentication session-oauth required
|
|
854
|
+
// oauth required
|
|
855
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
856
|
+
|
|
857
|
+
// authentication api-key required
|
|
858
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
859
|
+
|
|
860
|
+
if (project !== undefined) {
|
|
861
|
+
localVarQueryParameter['project'] = project;
|
|
862
|
+
}
|
|
863
|
+
|
|
864
|
+
if (pageToken !== undefined) {
|
|
865
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
866
|
+
}
|
|
867
|
+
|
|
868
|
+
if (pageSize !== undefined) {
|
|
869
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
870
|
+
}
|
|
871
|
+
|
|
872
|
+
if (search !== undefined) {
|
|
873
|
+
localVarQueryParameter['search'] = search;
|
|
874
|
+
}
|
|
875
|
+
|
|
876
|
+
|
|
877
|
+
|
|
878
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
879
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
880
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
881
|
+
|
|
882
|
+
return {
|
|
883
|
+
url: toPathString(localVarUrlObj),
|
|
884
|
+
options: localVarRequestOptions,
|
|
885
|
+
};
|
|
886
|
+
},
|
|
887
|
+
}
|
|
888
|
+
};
|
|
889
|
+
|
|
890
|
+
/**
|
|
891
|
+
* StatementsApi - functional programming interface
|
|
892
|
+
* @export
|
|
893
|
+
*/
|
|
894
|
+
export const StatementsApiFp = function(configuration?: Configuration) {
|
|
895
|
+
const localVarAxiosParamCreator = StatementsApiAxiosParamCreator(configuration)
|
|
896
|
+
return {
|
|
897
|
+
/**
|
|
898
|
+
* Gets a GFN statement by the given ID.
|
|
899
|
+
* @summary Get a GFN statement
|
|
900
|
+
* @param {string} project What project it is
|
|
901
|
+
* @param {string} statementId
|
|
902
|
+
* @param {*} [options] Override http request option.
|
|
903
|
+
* @throws {RequiredError}
|
|
904
|
+
*/
|
|
905
|
+
async getStatement(project: string, statementId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Statement>> {
|
|
906
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getStatement(project, statementId, options);
|
|
907
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
908
|
+
const localVarOperationServerBasePath = operationServerMap['StatementsApi.getStatement']?.[localVarOperationServerIndex]?.url;
|
|
909
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
910
|
+
},
|
|
911
|
+
/**
|
|
912
|
+
* Lists GFN statements available to the project
|
|
913
|
+
* @summary List GFN statements
|
|
914
|
+
* @param {string} project What project it is
|
|
915
|
+
* @param {number} [pageToken] Page reference token
|
|
916
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
917
|
+
* @param {string} [search] Search term used to filter results by
|
|
918
|
+
* @param {*} [options] Override http request option.
|
|
919
|
+
* @throws {RequiredError}
|
|
920
|
+
*/
|
|
921
|
+
async listStatements(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListStatements200Response>> {
|
|
922
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listStatements(project, pageToken, pageSize, search, options);
|
|
923
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
924
|
+
const localVarOperationServerBasePath = operationServerMap['StatementsApi.listStatements']?.[localVarOperationServerIndex]?.url;
|
|
925
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
926
|
+
},
|
|
927
|
+
}
|
|
928
|
+
};
|
|
929
|
+
|
|
930
|
+
/**
|
|
931
|
+
* StatementsApi - factory interface
|
|
932
|
+
* @export
|
|
933
|
+
*/
|
|
934
|
+
export const StatementsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
935
|
+
const localVarFp = StatementsApiFp(configuration)
|
|
936
|
+
return {
|
|
937
|
+
/**
|
|
938
|
+
* Gets a GFN statement by the given ID.
|
|
939
|
+
* @summary Get a GFN statement
|
|
940
|
+
* @param {StatementsApiGetStatementRequest} requestParameters Request parameters.
|
|
941
|
+
* @param {*} [options] Override http request option.
|
|
942
|
+
* @throws {RequiredError}
|
|
943
|
+
*/
|
|
944
|
+
getStatement(requestParameters: StatementsApiGetStatementRequest, options?: RawAxiosRequestConfig): AxiosPromise<Statement> {
|
|
945
|
+
return localVarFp.getStatement(requestParameters.project, requestParameters.statementId, options).then((request) => request(axios, basePath));
|
|
946
|
+
},
|
|
947
|
+
/**
|
|
948
|
+
* Lists GFN statements available to the project
|
|
949
|
+
* @summary List GFN statements
|
|
950
|
+
* @param {StatementsApiListStatementsRequest} requestParameters Request parameters.
|
|
951
|
+
* @param {*} [options] Override http request option.
|
|
952
|
+
* @throws {RequiredError}
|
|
953
|
+
*/
|
|
954
|
+
listStatements(requestParameters: StatementsApiListStatementsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListStatements200Response> {
|
|
955
|
+
return localVarFp.listStatements(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
956
|
+
},
|
|
957
|
+
};
|
|
958
|
+
};
|
|
959
|
+
|
|
960
|
+
/**
|
|
961
|
+
* Request parameters for getStatement operation in StatementsApi.
|
|
962
|
+
* @export
|
|
963
|
+
* @interface StatementsApiGetStatementRequest
|
|
964
|
+
*/
|
|
965
|
+
export interface StatementsApiGetStatementRequest {
|
|
966
|
+
/**
|
|
967
|
+
* What project it is
|
|
968
|
+
* @type {string}
|
|
969
|
+
* @memberof StatementsApiGetStatement
|
|
970
|
+
*/
|
|
971
|
+
readonly project: string
|
|
972
|
+
|
|
973
|
+
/**
|
|
974
|
+
*
|
|
975
|
+
* @type {string}
|
|
976
|
+
* @memberof StatementsApiGetStatement
|
|
977
|
+
*/
|
|
978
|
+
readonly statementId: string
|
|
979
|
+
}
|
|
980
|
+
|
|
981
|
+
/**
|
|
982
|
+
* Request parameters for listStatements operation in StatementsApi.
|
|
983
|
+
* @export
|
|
984
|
+
* @interface StatementsApiListStatementsRequest
|
|
985
|
+
*/
|
|
986
|
+
export interface StatementsApiListStatementsRequest {
|
|
987
|
+
/**
|
|
988
|
+
* What project it is
|
|
989
|
+
* @type {string}
|
|
990
|
+
* @memberof StatementsApiListStatements
|
|
991
|
+
*/
|
|
992
|
+
readonly project: string
|
|
993
|
+
|
|
994
|
+
/**
|
|
995
|
+
* Page reference token
|
|
996
|
+
* @type {number}
|
|
997
|
+
* @memberof StatementsApiListStatements
|
|
998
|
+
*/
|
|
999
|
+
readonly pageToken?: number
|
|
1000
|
+
|
|
1001
|
+
/**
|
|
1002
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1003
|
+
* @type {number}
|
|
1004
|
+
* @memberof StatementsApiListStatements
|
|
1005
|
+
*/
|
|
1006
|
+
readonly pageSize?: number
|
|
1007
|
+
|
|
1008
|
+
/**
|
|
1009
|
+
* Search term used to filter results by
|
|
1010
|
+
* @type {string}
|
|
1011
|
+
* @memberof StatementsApiListStatements
|
|
1012
|
+
*/
|
|
1013
|
+
readonly search?: string
|
|
1014
|
+
}
|
|
1015
|
+
|
|
1016
|
+
/**
|
|
1017
|
+
* StatementsApi - object-oriented interface
|
|
1018
|
+
* @export
|
|
1019
|
+
* @class StatementsApi
|
|
1020
|
+
* @extends {BaseAPI}
|
|
1021
|
+
*/
|
|
1022
|
+
export class StatementsApi extends BaseAPI {
|
|
1023
|
+
/**
|
|
1024
|
+
* Gets a GFN statement by the given ID.
|
|
1025
|
+
* @summary Get a GFN statement
|
|
1026
|
+
* @param {StatementsApiGetStatementRequest} requestParameters Request parameters.
|
|
1027
|
+
* @param {*} [options] Override http request option.
|
|
1028
|
+
* @throws {RequiredError}
|
|
1029
|
+
* @memberof StatementsApi
|
|
1030
|
+
*/
|
|
1031
|
+
public getStatement(requestParameters: StatementsApiGetStatementRequest, options?: RawAxiosRequestConfig) {
|
|
1032
|
+
return StatementsApiFp(this.configuration).getStatement(requestParameters.project, requestParameters.statementId, options).then((request) => request(this.axios, this.basePath));
|
|
1033
|
+
}
|
|
1034
|
+
|
|
1035
|
+
/**
|
|
1036
|
+
* Lists GFN statements available to the project
|
|
1037
|
+
* @summary List GFN statements
|
|
1038
|
+
* @param {StatementsApiListStatementsRequest} requestParameters Request parameters.
|
|
1039
|
+
* @param {*} [options] Override http request option.
|
|
1040
|
+
* @throws {RequiredError}
|
|
1041
|
+
* @memberof StatementsApi
|
|
1042
|
+
*/
|
|
1043
|
+
public listStatements(requestParameters: StatementsApiListStatementsRequest, options?: RawAxiosRequestConfig) {
|
|
1044
|
+
return StatementsApiFp(this.configuration).listStatements(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
1045
|
+
}
|
|
1046
|
+
}
|
|
1047
|
+
|
|
1048
|
+
|
|
1049
|
+
|
|
1050
|
+
/**
|
|
1051
|
+
* TransactionsApi - axios parameter creator
|
|
1052
|
+
* @export
|
|
1053
|
+
*/
|
|
1054
|
+
export const TransactionsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
1055
|
+
return {
|
|
1056
|
+
/**
|
|
1057
|
+
* Exports all GFN transactions available to the project
|
|
1058
|
+
* @summary Export GFN transactions
|
|
1059
|
+
* @param {string} project What project it is
|
|
1060
|
+
* @param {ExportTransactionsRequest} exportTransactionsRequest Period selection data for the export
|
|
1061
|
+
* @param {*} [options] Override http request option.
|
|
1062
|
+
* @throws {RequiredError}
|
|
1063
|
+
*/
|
|
1064
|
+
exportTransactions: async (project: string, exportTransactionsRequest: ExportTransactionsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1065
|
+
// verify required parameter 'project' is not null or undefined
|
|
1066
|
+
assertParamExists('exportTransactions', 'project', project)
|
|
1067
|
+
// verify required parameter 'exportTransactionsRequest' is not null or undefined
|
|
1068
|
+
assertParamExists('exportTransactions', 'exportTransactionsRequest', exportTransactionsRequest)
|
|
1069
|
+
const localVarPath = `/v1/gfn/transactions/export`;
|
|
1070
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1071
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1072
|
+
let baseOptions;
|
|
1073
|
+
if (configuration) {
|
|
1074
|
+
baseOptions = configuration.baseOptions;
|
|
1075
|
+
}
|
|
1076
|
+
|
|
1077
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
1078
|
+
const localVarHeaderParameter = {} as any;
|
|
1079
|
+
const localVarQueryParameter = {} as any;
|
|
1080
|
+
|
|
1081
|
+
// authentication session-oauth required
|
|
1082
|
+
// oauth required
|
|
1083
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1084
|
+
|
|
1085
|
+
// authentication api-key required
|
|
1086
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1087
|
+
|
|
1088
|
+
if (project !== undefined) {
|
|
1089
|
+
localVarQueryParameter['project'] = project;
|
|
1090
|
+
}
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
|
|
1094
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1095
|
+
|
|
1096
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1097
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1098
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1099
|
+
localVarRequestOptions.data = serializeDataIfNeeded(exportTransactionsRequest, localVarRequestOptions, configuration)
|
|
1100
|
+
|
|
1101
|
+
return {
|
|
1102
|
+
url: toPathString(localVarUrlObj),
|
|
1103
|
+
options: localVarRequestOptions,
|
|
1104
|
+
};
|
|
1105
|
+
},
|
|
1106
|
+
/**
|
|
1107
|
+
* Lists all GFN transactions available to the project
|
|
1108
|
+
* @summary List GFN transactions
|
|
1109
|
+
* @param {string} project What project it is
|
|
1110
|
+
* @param {number} [pageToken] Page reference token
|
|
1111
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1112
|
+
* @param {string} [statementId]
|
|
1113
|
+
* @param {*} [options] Override http request option.
|
|
1114
|
+
* @throws {RequiredError}
|
|
1115
|
+
*/
|
|
1116
|
+
listTransactions: async (project: string, pageToken?: number, pageSize?: number, statementId?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1117
|
+
// verify required parameter 'project' is not null or undefined
|
|
1118
|
+
assertParamExists('listTransactions', 'project', project)
|
|
1119
|
+
const localVarPath = `/v1/gfn/transactions`;
|
|
1120
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1121
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1122
|
+
let baseOptions;
|
|
1123
|
+
if (configuration) {
|
|
1124
|
+
baseOptions = configuration.baseOptions;
|
|
1125
|
+
}
|
|
1126
|
+
|
|
1127
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1128
|
+
const localVarHeaderParameter = {} as any;
|
|
1129
|
+
const localVarQueryParameter = {} as any;
|
|
1130
|
+
|
|
1131
|
+
// authentication session-oauth required
|
|
1132
|
+
// oauth required
|
|
1133
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1134
|
+
|
|
1135
|
+
// authentication api-key required
|
|
1136
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1137
|
+
|
|
1138
|
+
if (project !== undefined) {
|
|
1139
|
+
localVarQueryParameter['project'] = project;
|
|
1140
|
+
}
|
|
1141
|
+
|
|
1142
|
+
if (pageToken !== undefined) {
|
|
1143
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
1144
|
+
}
|
|
1145
|
+
|
|
1146
|
+
if (pageSize !== undefined) {
|
|
1147
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
1148
|
+
}
|
|
1149
|
+
|
|
1150
|
+
if (statementId !== undefined) {
|
|
1151
|
+
localVarQueryParameter['statementId'] = statementId;
|
|
1152
|
+
}
|
|
1153
|
+
|
|
1154
|
+
|
|
1155
|
+
|
|
1156
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1157
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1158
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1159
|
+
|
|
1160
|
+
return {
|
|
1161
|
+
url: toPathString(localVarUrlObj),
|
|
1162
|
+
options: localVarRequestOptions,
|
|
1163
|
+
};
|
|
1164
|
+
},
|
|
1165
|
+
}
|
|
1166
|
+
};
|
|
1167
|
+
|
|
1168
|
+
/**
|
|
1169
|
+
* TransactionsApi - functional programming interface
|
|
1170
|
+
* @export
|
|
1171
|
+
*/
|
|
1172
|
+
export const TransactionsApiFp = function(configuration?: Configuration) {
|
|
1173
|
+
const localVarAxiosParamCreator = TransactionsApiAxiosParamCreator(configuration)
|
|
1174
|
+
return {
|
|
1175
|
+
/**
|
|
1176
|
+
* Exports all GFN transactions available to the project
|
|
1177
|
+
* @summary Export GFN transactions
|
|
1178
|
+
* @param {string} project What project it is
|
|
1179
|
+
* @param {ExportTransactionsRequest} exportTransactionsRequest Period selection data for the export
|
|
1180
|
+
* @param {*} [options] Override http request option.
|
|
1181
|
+
* @throws {RequiredError}
|
|
1182
|
+
*/
|
|
1183
|
+
async exportTransactions(project: string, exportTransactionsRequest: ExportTransactionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
1184
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportTransactions(project, exportTransactionsRequest, options);
|
|
1185
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1186
|
+
const localVarOperationServerBasePath = operationServerMap['TransactionsApi.exportTransactions']?.[localVarOperationServerIndex]?.url;
|
|
1187
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1188
|
+
},
|
|
1189
|
+
/**
|
|
1190
|
+
* Lists all GFN transactions available to the project
|
|
1191
|
+
* @summary List GFN transactions
|
|
1192
|
+
* @param {string} project What project it is
|
|
1193
|
+
* @param {number} [pageToken] Page reference token
|
|
1194
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1195
|
+
* @param {string} [statementId]
|
|
1196
|
+
* @param {*} [options] Override http request option.
|
|
1197
|
+
* @throws {RequiredError}
|
|
1198
|
+
*/
|
|
1199
|
+
async listTransactions(project: string, pageToken?: number, pageSize?: number, statementId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTransactions200Response>> {
|
|
1200
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listTransactions(project, pageToken, pageSize, statementId, options);
|
|
1201
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1202
|
+
const localVarOperationServerBasePath = operationServerMap['TransactionsApi.listTransactions']?.[localVarOperationServerIndex]?.url;
|
|
1203
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1204
|
+
},
|
|
1205
|
+
}
|
|
1206
|
+
};
|
|
1207
|
+
|
|
1208
|
+
/**
|
|
1209
|
+
* TransactionsApi - factory interface
|
|
1210
|
+
* @export
|
|
1211
|
+
*/
|
|
1212
|
+
export const TransactionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
1213
|
+
const localVarFp = TransactionsApiFp(configuration)
|
|
1214
|
+
return {
|
|
1215
|
+
/**
|
|
1216
|
+
* Exports all GFN transactions available to the project
|
|
1217
|
+
* @summary Export GFN transactions
|
|
1218
|
+
* @param {TransactionsApiExportTransactionsRequest} requestParameters Request parameters.
|
|
1219
|
+
* @param {*} [options] Override http request option.
|
|
1220
|
+
* @throws {RequiredError}
|
|
1221
|
+
*/
|
|
1222
|
+
exportTransactions(requestParameters: TransactionsApiExportTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
1223
|
+
return localVarFp.exportTransactions(requestParameters.project, requestParameters.exportTransactionsRequest, options).then((request) => request(axios, basePath));
|
|
1224
|
+
},
|
|
1225
|
+
/**
|
|
1226
|
+
* Lists all GFN transactions available to the project
|
|
1227
|
+
* @summary List GFN transactions
|
|
1228
|
+
* @param {TransactionsApiListTransactionsRequest} requestParameters Request parameters.
|
|
1229
|
+
* @param {*} [options] Override http request option.
|
|
1230
|
+
* @throws {RequiredError}
|
|
1231
|
+
*/
|
|
1232
|
+
listTransactions(requestParameters: TransactionsApiListTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListTransactions200Response> {
|
|
1233
|
+
return localVarFp.listTransactions(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.statementId, options).then((request) => request(axios, basePath));
|
|
1234
|
+
},
|
|
1235
|
+
};
|
|
1236
|
+
};
|
|
1237
|
+
|
|
1238
|
+
/**
|
|
1239
|
+
* Request parameters for exportTransactions operation in TransactionsApi.
|
|
1240
|
+
* @export
|
|
1241
|
+
* @interface TransactionsApiExportTransactionsRequest
|
|
1242
|
+
*/
|
|
1243
|
+
export interface TransactionsApiExportTransactionsRequest {
|
|
1244
|
+
/**
|
|
1245
|
+
* What project it is
|
|
1246
|
+
* @type {string}
|
|
1247
|
+
* @memberof TransactionsApiExportTransactions
|
|
1248
|
+
*/
|
|
1249
|
+
readonly project: string
|
|
1250
|
+
|
|
1251
|
+
/**
|
|
1252
|
+
* Period selection data for the export
|
|
1253
|
+
* @type {ExportTransactionsRequest}
|
|
1254
|
+
* @memberof TransactionsApiExportTransactions
|
|
1255
|
+
*/
|
|
1256
|
+
readonly exportTransactionsRequest: ExportTransactionsRequest
|
|
1257
|
+
}
|
|
1258
|
+
|
|
1259
|
+
/**
|
|
1260
|
+
* Request parameters for listTransactions operation in TransactionsApi.
|
|
1261
|
+
* @export
|
|
1262
|
+
* @interface TransactionsApiListTransactionsRequest
|
|
1263
|
+
*/
|
|
1264
|
+
export interface TransactionsApiListTransactionsRequest {
|
|
1265
|
+
/**
|
|
1266
|
+
* What project it is
|
|
1267
|
+
* @type {string}
|
|
1268
|
+
* @memberof TransactionsApiListTransactions
|
|
1269
|
+
*/
|
|
1270
|
+
readonly project: string
|
|
1271
|
+
|
|
1272
|
+
/**
|
|
1273
|
+
* Page reference token
|
|
1274
|
+
* @type {number}
|
|
1275
|
+
* @memberof TransactionsApiListTransactions
|
|
1276
|
+
*/
|
|
1277
|
+
readonly pageToken?: number
|
|
1278
|
+
|
|
1279
|
+
/**
|
|
1280
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1281
|
+
* @type {number}
|
|
1282
|
+
* @memberof TransactionsApiListTransactions
|
|
1283
|
+
*/
|
|
1284
|
+
readonly pageSize?: number
|
|
1285
|
+
|
|
1286
|
+
/**
|
|
1287
|
+
*
|
|
1288
|
+
* @type {string}
|
|
1289
|
+
* @memberof TransactionsApiListTransactions
|
|
1290
|
+
*/
|
|
1291
|
+
readonly statementId?: string
|
|
1292
|
+
}
|
|
1293
|
+
|
|
1294
|
+
/**
|
|
1295
|
+
* TransactionsApi - object-oriented interface
|
|
1296
|
+
* @export
|
|
1297
|
+
* @class TransactionsApi
|
|
1298
|
+
* @extends {BaseAPI}
|
|
1299
|
+
*/
|
|
1300
|
+
export class TransactionsApi extends BaseAPI {
|
|
1301
|
+
/**
|
|
1302
|
+
* Exports all GFN transactions available to the project
|
|
1303
|
+
* @summary Export GFN transactions
|
|
1304
|
+
* @param {TransactionsApiExportTransactionsRequest} requestParameters Request parameters.
|
|
1305
|
+
* @param {*} [options] Override http request option.
|
|
1306
|
+
* @throws {RequiredError}
|
|
1307
|
+
* @memberof TransactionsApi
|
|
1308
|
+
*/
|
|
1309
|
+
public exportTransactions(requestParameters: TransactionsApiExportTransactionsRequest, options?: RawAxiosRequestConfig) {
|
|
1310
|
+
return TransactionsApiFp(this.configuration).exportTransactions(requestParameters.project, requestParameters.exportTransactionsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1311
|
+
}
|
|
1312
|
+
|
|
1313
|
+
/**
|
|
1314
|
+
* Lists all GFN transactions available to the project
|
|
1315
|
+
* @summary List GFN transactions
|
|
1316
|
+
* @param {TransactionsApiListTransactionsRequest} requestParameters Request parameters.
|
|
1317
|
+
* @param {*} [options] Override http request option.
|
|
1318
|
+
* @throws {RequiredError}
|
|
1319
|
+
* @memberof TransactionsApi
|
|
1320
|
+
*/
|
|
1321
|
+
public listTransactions(requestParameters: TransactionsApiListTransactionsRequest, options?: RawAxiosRequestConfig) {
|
|
1322
|
+
return TransactionsApiFp(this.configuration).listTransactions(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.statementId, options).then((request) => request(this.axios, this.basePath));
|
|
1323
|
+
}
|
|
1324
|
+
}
|
|
1325
|
+
|
|
1326
|
+
|
|
1327
|
+
|
|
1328
|
+
/**
|
|
1329
|
+
* VariantsApi - axios parameter creator
|
|
1330
|
+
* @export
|
|
1331
|
+
*/
|
|
1332
|
+
export const VariantsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
1333
|
+
return {
|
|
1334
|
+
/**
|
|
1335
|
+
* Gets the stock level for the GFN variant with the given ID.
|
|
1336
|
+
* @summary Get GFN variant stock
|
|
1337
|
+
* @param {string} project What project it is
|
|
1338
|
+
* @param {string} variantId Variants unique identifier
|
|
1339
|
+
* @param {string} [fulfillmentProjects] Fetch stock levels from specific fulfiller projects
|
|
1340
|
+
* @param {*} [options] Override http request option.
|
|
1341
|
+
* @throws {RequiredError}
|
|
1342
|
+
*/
|
|
1343
|
+
getStock: async (project: string, variantId: string, fulfillmentProjects?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1344
|
+
// verify required parameter 'project' is not null or undefined
|
|
1345
|
+
assertParamExists('getStock', 'project', project)
|
|
1346
|
+
// verify required parameter 'variantId' is not null or undefined
|
|
1347
|
+
assertParamExists('getStock', 'variantId', variantId)
|
|
1348
|
+
const localVarPath = `/v1/gfn/catalog/stock/{variantId}`
|
|
1349
|
+
.replace(`{${"variantId"}}`, encodeURIComponent(String(variantId)));
|
|
1350
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1351
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1352
|
+
let baseOptions;
|
|
1353
|
+
if (configuration) {
|
|
1354
|
+
baseOptions = configuration.baseOptions;
|
|
1355
|
+
}
|
|
1356
|
+
|
|
1357
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1358
|
+
const localVarHeaderParameter = {} as any;
|
|
1359
|
+
const localVarQueryParameter = {} as any;
|
|
1360
|
+
|
|
1361
|
+
// authentication session-oauth required
|
|
1362
|
+
// oauth required
|
|
1363
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1364
|
+
|
|
1365
|
+
// authentication api-key required
|
|
1366
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1367
|
+
|
|
1368
|
+
if (project !== undefined) {
|
|
1369
|
+
localVarQueryParameter['project'] = project;
|
|
1370
|
+
}
|
|
1371
|
+
|
|
1372
|
+
if (fulfillmentProjects !== undefined) {
|
|
1373
|
+
localVarQueryParameter['fulfillmentProjects'] = fulfillmentProjects;
|
|
1374
|
+
}
|
|
1375
|
+
|
|
1376
|
+
|
|
1377
|
+
|
|
1378
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1379
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1380
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1381
|
+
|
|
1382
|
+
return {
|
|
1383
|
+
url: toPathString(localVarUrlObj),
|
|
1384
|
+
options: localVarRequestOptions,
|
|
1385
|
+
};
|
|
1386
|
+
},
|
|
1387
|
+
/**
|
|
1388
|
+
* Gets a GFN variant by the given ID.
|
|
1389
|
+
* @summary Get a GFN variant
|
|
1390
|
+
* @param {string} project What project it is
|
|
1391
|
+
* @param {string} variantId Variants unique identifier
|
|
1392
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1393
|
+
* @param {*} [options] Override http request option.
|
|
1394
|
+
* @throws {RequiredError}
|
|
1395
|
+
*/
|
|
1396
|
+
getVariant: async (project: string, variantId: string, fields?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1397
|
+
// verify required parameter 'project' is not null or undefined
|
|
1398
|
+
assertParamExists('getVariant', 'project', project)
|
|
1399
|
+
// verify required parameter 'variantId' is not null or undefined
|
|
1400
|
+
assertParamExists('getVariant', 'variantId', variantId)
|
|
1401
|
+
const localVarPath = `/v1/gfn/catalog/variants/{variantId}`
|
|
1402
|
+
.replace(`{${"variantId"}}`, encodeURIComponent(String(variantId)));
|
|
1403
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1404
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1405
|
+
let baseOptions;
|
|
1406
|
+
if (configuration) {
|
|
1407
|
+
baseOptions = configuration.baseOptions;
|
|
1408
|
+
}
|
|
1409
|
+
|
|
1410
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1411
|
+
const localVarHeaderParameter = {} as any;
|
|
1412
|
+
const localVarQueryParameter = {} as any;
|
|
1413
|
+
|
|
1414
|
+
// authentication session-oauth required
|
|
1415
|
+
// oauth required
|
|
1416
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1417
|
+
|
|
1418
|
+
// authentication api-key required
|
|
1419
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1420
|
+
|
|
1421
|
+
if (project !== undefined) {
|
|
1422
|
+
localVarQueryParameter['project'] = project;
|
|
1423
|
+
}
|
|
1424
|
+
|
|
1425
|
+
if (fields !== undefined) {
|
|
1426
|
+
localVarQueryParameter['fields'] = fields;
|
|
1427
|
+
}
|
|
1428
|
+
|
|
1429
|
+
|
|
1430
|
+
|
|
1431
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1432
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1433
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1434
|
+
|
|
1435
|
+
return {
|
|
1436
|
+
url: toPathString(localVarUrlObj),
|
|
1437
|
+
options: localVarRequestOptions,
|
|
1438
|
+
};
|
|
1439
|
+
},
|
|
1440
|
+
/**
|
|
1441
|
+
* Lists the stock levels for all GFN variants available to the project.
|
|
1442
|
+
* @summary List GFN variant stock
|
|
1443
|
+
* @param {string} project What project it is
|
|
1444
|
+
* @param {string} [fulfillmentProjects] Fetch stock levels from specific fulfiller projects
|
|
1445
|
+
* @param {number} [pageToken] Page reference token
|
|
1446
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1447
|
+
* @param {string} [search] Search terms to filter based on.
|
|
1448
|
+
* @param {*} [options] Override http request option.
|
|
1449
|
+
* @throws {RequiredError}
|
|
1450
|
+
*/
|
|
1451
|
+
listStock: async (project: string, fulfillmentProjects?: string, pageToken?: number, pageSize?: number, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1452
|
+
// verify required parameter 'project' is not null or undefined
|
|
1453
|
+
assertParamExists('listStock', 'project', project)
|
|
1454
|
+
const localVarPath = `/v1/gfn/catalog/stock`;
|
|
1455
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1456
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1457
|
+
let baseOptions;
|
|
1458
|
+
if (configuration) {
|
|
1459
|
+
baseOptions = configuration.baseOptions;
|
|
1460
|
+
}
|
|
1461
|
+
|
|
1462
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1463
|
+
const localVarHeaderParameter = {} as any;
|
|
1464
|
+
const localVarQueryParameter = {} as any;
|
|
1465
|
+
|
|
1466
|
+
// authentication session-oauth required
|
|
1467
|
+
// oauth required
|
|
1468
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1469
|
+
|
|
1470
|
+
// authentication api-key required
|
|
1471
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1472
|
+
|
|
1473
|
+
if (project !== undefined) {
|
|
1474
|
+
localVarQueryParameter['project'] = project;
|
|
1475
|
+
}
|
|
1476
|
+
|
|
1477
|
+
if (fulfillmentProjects !== undefined) {
|
|
1478
|
+
localVarQueryParameter['fulfillmentProjects'] = fulfillmentProjects;
|
|
1479
|
+
}
|
|
1480
|
+
|
|
1481
|
+
if (pageToken !== undefined) {
|
|
1482
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
1483
|
+
}
|
|
1484
|
+
|
|
1485
|
+
if (pageSize !== undefined) {
|
|
1486
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
1487
|
+
}
|
|
1488
|
+
|
|
1489
|
+
if (search !== undefined) {
|
|
1490
|
+
localVarQueryParameter['search'] = search;
|
|
1491
|
+
}
|
|
1492
|
+
|
|
1493
|
+
|
|
1494
|
+
|
|
1495
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1496
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1497
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1498
|
+
|
|
1499
|
+
return {
|
|
1500
|
+
url: toPathString(localVarUrlObj),
|
|
1501
|
+
options: localVarRequestOptions,
|
|
1502
|
+
};
|
|
1503
|
+
},
|
|
1504
|
+
/**
|
|
1505
|
+
* Lists all GFN variants available to the project. Can be filtered by product ID, SKU, and attribute values using the search parameter.
|
|
1506
|
+
* @summary List GFN variants
|
|
1507
|
+
* @param {string} project What project it is
|
|
1508
|
+
* @param {number} [pageToken] Page reference token
|
|
1509
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1510
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1511
|
+
* @param {string} [search] Search terms to filter based on.
|
|
1512
|
+
* @param {*} [options] Override http request option.
|
|
1513
|
+
* @throws {RequiredError}
|
|
1514
|
+
*/
|
|
1515
|
+
listVariants: async (project: string, pageToken?: number, pageSize?: number, fields?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1516
|
+
// verify required parameter 'project' is not null or undefined
|
|
1517
|
+
assertParamExists('listVariants', 'project', project)
|
|
1518
|
+
const localVarPath = `/v1/gfn/catalog/variants`;
|
|
1519
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1520
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1521
|
+
let baseOptions;
|
|
1522
|
+
if (configuration) {
|
|
1523
|
+
baseOptions = configuration.baseOptions;
|
|
1524
|
+
}
|
|
1525
|
+
|
|
1526
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1527
|
+
const localVarHeaderParameter = {} as any;
|
|
1528
|
+
const localVarQueryParameter = {} as any;
|
|
1529
|
+
|
|
1530
|
+
// authentication session-oauth required
|
|
1531
|
+
// oauth required
|
|
1532
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1533
|
+
|
|
1534
|
+
// authentication api-key required
|
|
1535
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1536
|
+
|
|
1537
|
+
if (project !== undefined) {
|
|
1538
|
+
localVarQueryParameter['project'] = project;
|
|
1539
|
+
}
|
|
1540
|
+
|
|
1541
|
+
if (pageToken !== undefined) {
|
|
1542
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
1543
|
+
}
|
|
1544
|
+
|
|
1545
|
+
if (pageSize !== undefined) {
|
|
1546
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
1547
|
+
}
|
|
1548
|
+
|
|
1549
|
+
if (fields !== undefined) {
|
|
1550
|
+
localVarQueryParameter['fields'] = fields;
|
|
1551
|
+
}
|
|
1552
|
+
|
|
1553
|
+
if (search !== undefined) {
|
|
1554
|
+
localVarQueryParameter['search'] = search;
|
|
1555
|
+
}
|
|
1556
|
+
|
|
1557
|
+
|
|
1558
|
+
|
|
1559
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1560
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1561
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1562
|
+
|
|
1563
|
+
return {
|
|
1564
|
+
url: toPathString(localVarUrlObj),
|
|
1565
|
+
options: localVarRequestOptions,
|
|
1566
|
+
};
|
|
1567
|
+
},
|
|
1568
|
+
}
|
|
1569
|
+
};
|
|
1570
|
+
|
|
1571
|
+
/**
|
|
1572
|
+
* VariantsApi - functional programming interface
|
|
1573
|
+
* @export
|
|
1574
|
+
*/
|
|
1575
|
+
export const VariantsApiFp = function(configuration?: Configuration) {
|
|
1576
|
+
const localVarAxiosParamCreator = VariantsApiAxiosParamCreator(configuration)
|
|
1577
|
+
return {
|
|
1578
|
+
/**
|
|
1579
|
+
* Gets the stock level for the GFN variant with the given ID.
|
|
1580
|
+
* @summary Get GFN variant stock
|
|
1581
|
+
* @param {string} project What project it is
|
|
1582
|
+
* @param {string} variantId Variants unique identifier
|
|
1583
|
+
* @param {string} [fulfillmentProjects] Fetch stock levels from specific fulfiller projects
|
|
1584
|
+
* @param {*} [options] Override http request option.
|
|
1585
|
+
* @throws {RequiredError}
|
|
1586
|
+
*/
|
|
1587
|
+
async getStock(project: string, variantId: string, fulfillmentProjects?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VariantStock>> {
|
|
1588
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getStock(project, variantId, fulfillmentProjects, options);
|
|
1589
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1590
|
+
const localVarOperationServerBasePath = operationServerMap['VariantsApi.getStock']?.[localVarOperationServerIndex]?.url;
|
|
1591
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1592
|
+
},
|
|
1593
|
+
/**
|
|
1594
|
+
* Gets a GFN variant by the given ID.
|
|
1595
|
+
* @summary Get a GFN variant
|
|
1596
|
+
* @param {string} project What project it is
|
|
1597
|
+
* @param {string} variantId Variants unique identifier
|
|
1598
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1599
|
+
* @param {*} [options] Override http request option.
|
|
1600
|
+
* @throws {RequiredError}
|
|
1601
|
+
*/
|
|
1602
|
+
async getVariant(project: string, variantId: string, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Variant>> {
|
|
1603
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getVariant(project, variantId, fields, options);
|
|
1604
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1605
|
+
const localVarOperationServerBasePath = operationServerMap['VariantsApi.getVariant']?.[localVarOperationServerIndex]?.url;
|
|
1606
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1607
|
+
},
|
|
1608
|
+
/**
|
|
1609
|
+
* Lists the stock levels for all GFN variants available to the project.
|
|
1610
|
+
* @summary List GFN variant stock
|
|
1611
|
+
* @param {string} project What project it is
|
|
1612
|
+
* @param {string} [fulfillmentProjects] Fetch stock levels from specific fulfiller projects
|
|
1613
|
+
* @param {number} [pageToken] Page reference token
|
|
1614
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1615
|
+
* @param {string} [search] Search terms to filter based on.
|
|
1616
|
+
* @param {*} [options] Override http request option.
|
|
1617
|
+
* @throws {RequiredError}
|
|
1618
|
+
*/
|
|
1619
|
+
async listStock(project: string, fulfillmentProjects?: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StockResponse>> {
|
|
1620
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listStock(project, fulfillmentProjects, pageToken, pageSize, search, options);
|
|
1621
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1622
|
+
const localVarOperationServerBasePath = operationServerMap['VariantsApi.listStock']?.[localVarOperationServerIndex]?.url;
|
|
1623
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1624
|
+
},
|
|
1625
|
+
/**
|
|
1626
|
+
* Lists all GFN variants available to the project. Can be filtered by product ID, SKU, and attribute values using the search parameter.
|
|
1627
|
+
* @summary List GFN variants
|
|
1628
|
+
* @param {string} project What project it is
|
|
1629
|
+
* @param {number} [pageToken] Page reference token
|
|
1630
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1631
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1632
|
+
* @param {string} [search] Search terms to filter based on.
|
|
1633
|
+
* @param {*} [options] Override http request option.
|
|
1634
|
+
* @throws {RequiredError}
|
|
1635
|
+
*/
|
|
1636
|
+
async listVariants(project: string, pageToken?: number, pageSize?: number, fields?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VariantsResponse>> {
|
|
1637
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listVariants(project, pageToken, pageSize, fields, search, options);
|
|
1638
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1639
|
+
const localVarOperationServerBasePath = operationServerMap['VariantsApi.listVariants']?.[localVarOperationServerIndex]?.url;
|
|
1640
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1641
|
+
},
|
|
1642
|
+
}
|
|
1643
|
+
};
|
|
1644
|
+
|
|
1645
|
+
/**
|
|
1646
|
+
* VariantsApi - factory interface
|
|
1647
|
+
* @export
|
|
1648
|
+
*/
|
|
1649
|
+
export const VariantsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
1650
|
+
const localVarFp = VariantsApiFp(configuration)
|
|
1651
|
+
return {
|
|
1652
|
+
/**
|
|
1653
|
+
* Gets the stock level for the GFN variant with the given ID.
|
|
1654
|
+
* @summary Get GFN variant stock
|
|
1655
|
+
* @param {VariantsApiGetStockRequest} requestParameters Request parameters.
|
|
1656
|
+
* @param {*} [options] Override http request option.
|
|
1657
|
+
* @throws {RequiredError}
|
|
1658
|
+
*/
|
|
1659
|
+
getStock(requestParameters: VariantsApiGetStockRequest, options?: RawAxiosRequestConfig): AxiosPromise<VariantStock> {
|
|
1660
|
+
return localVarFp.getStock(requestParameters.project, requestParameters.variantId, requestParameters.fulfillmentProjects, options).then((request) => request(axios, basePath));
|
|
1661
|
+
},
|
|
1662
|
+
/**
|
|
1663
|
+
* Gets a GFN variant by the given ID.
|
|
1664
|
+
* @summary Get a GFN variant
|
|
1665
|
+
* @param {VariantsApiGetVariantRequest} requestParameters Request parameters.
|
|
1666
|
+
* @param {*} [options] Override http request option.
|
|
1667
|
+
* @throws {RequiredError}
|
|
1668
|
+
*/
|
|
1669
|
+
getVariant(requestParameters: VariantsApiGetVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<Variant> {
|
|
1670
|
+
return localVarFp.getVariant(requestParameters.project, requestParameters.variantId, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
1671
|
+
},
|
|
1672
|
+
/**
|
|
1673
|
+
* Lists the stock levels for all GFN variants available to the project.
|
|
1674
|
+
* @summary List GFN variant stock
|
|
1675
|
+
* @param {VariantsApiListStockRequest} requestParameters Request parameters.
|
|
1676
|
+
* @param {*} [options] Override http request option.
|
|
1677
|
+
* @throws {RequiredError}
|
|
1678
|
+
*/
|
|
1679
|
+
listStock(requestParameters: VariantsApiListStockRequest, options?: RawAxiosRequestConfig): AxiosPromise<StockResponse> {
|
|
1680
|
+
return localVarFp.listStock(requestParameters.project, requestParameters.fulfillmentProjects, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
1681
|
+
},
|
|
1682
|
+
/**
|
|
1683
|
+
* Lists all GFN variants available to the project. Can be filtered by product ID, SKU, and attribute values using the search parameter.
|
|
1684
|
+
* @summary List GFN variants
|
|
1685
|
+
* @param {VariantsApiListVariantsRequest} requestParameters Request parameters.
|
|
1686
|
+
* @param {*} [options] Override http request option.
|
|
1687
|
+
* @throws {RequiredError}
|
|
1688
|
+
*/
|
|
1689
|
+
listVariants(requestParameters: VariantsApiListVariantsRequest, options?: RawAxiosRequestConfig): AxiosPromise<VariantsResponse> {
|
|
1690
|
+
return localVarFp.listVariants(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.fields, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
1691
|
+
},
|
|
1692
|
+
};
|
|
1693
|
+
};
|
|
1694
|
+
|
|
1695
|
+
/**
|
|
1696
|
+
* Request parameters for getStock operation in VariantsApi.
|
|
1697
|
+
* @export
|
|
1698
|
+
* @interface VariantsApiGetStockRequest
|
|
1699
|
+
*/
|
|
1700
|
+
export interface VariantsApiGetStockRequest {
|
|
1701
|
+
/**
|
|
1702
|
+
* What project it is
|
|
1703
|
+
* @type {string}
|
|
1704
|
+
* @memberof VariantsApiGetStock
|
|
1705
|
+
*/
|
|
1706
|
+
readonly project: string
|
|
1707
|
+
|
|
1708
|
+
/**
|
|
1709
|
+
* Variants unique identifier
|
|
1710
|
+
* @type {string}
|
|
1711
|
+
* @memberof VariantsApiGetStock
|
|
1712
|
+
*/
|
|
1713
|
+
readonly variantId: string
|
|
1714
|
+
|
|
1715
|
+
/**
|
|
1716
|
+
* Fetch stock levels from specific fulfiller projects
|
|
1717
|
+
* @type {string}
|
|
1718
|
+
* @memberof VariantsApiGetStock
|
|
1719
|
+
*/
|
|
1720
|
+
readonly fulfillmentProjects?: string
|
|
1721
|
+
}
|
|
1722
|
+
|
|
1723
|
+
/**
|
|
1724
|
+
* Request parameters for getVariant operation in VariantsApi.
|
|
1725
|
+
* @export
|
|
1726
|
+
* @interface VariantsApiGetVariantRequest
|
|
1727
|
+
*/
|
|
1728
|
+
export interface VariantsApiGetVariantRequest {
|
|
1729
|
+
/**
|
|
1730
|
+
* What project it is
|
|
1731
|
+
* @type {string}
|
|
1732
|
+
* @memberof VariantsApiGetVariant
|
|
1733
|
+
*/
|
|
1734
|
+
readonly project: string
|
|
1735
|
+
|
|
1736
|
+
/**
|
|
1737
|
+
* Variants unique identifier
|
|
1738
|
+
* @type {string}
|
|
1739
|
+
* @memberof VariantsApiGetVariant
|
|
1740
|
+
*/
|
|
1741
|
+
readonly variantId: string
|
|
1742
|
+
|
|
1743
|
+
/**
|
|
1744
|
+
* Filter response fields to only include a subset of the resource.
|
|
1745
|
+
* @type {string}
|
|
1746
|
+
* @memberof VariantsApiGetVariant
|
|
1747
|
+
*/
|
|
1748
|
+
readonly fields?: string
|
|
1749
|
+
}
|
|
1750
|
+
|
|
1751
|
+
/**
|
|
1752
|
+
* Request parameters for listStock operation in VariantsApi.
|
|
1753
|
+
* @export
|
|
1754
|
+
* @interface VariantsApiListStockRequest
|
|
1755
|
+
*/
|
|
1756
|
+
export interface VariantsApiListStockRequest {
|
|
1757
|
+
/**
|
|
1758
|
+
* What project it is
|
|
1759
|
+
* @type {string}
|
|
1760
|
+
* @memberof VariantsApiListStock
|
|
1761
|
+
*/
|
|
1762
|
+
readonly project: string
|
|
1763
|
+
|
|
1764
|
+
/**
|
|
1765
|
+
* Fetch stock levels from specific fulfiller projects
|
|
1766
|
+
* @type {string}
|
|
1767
|
+
* @memberof VariantsApiListStock
|
|
1768
|
+
*/
|
|
1769
|
+
readonly fulfillmentProjects?: string
|
|
1770
|
+
|
|
1771
|
+
/**
|
|
1772
|
+
* Page reference token
|
|
1773
|
+
* @type {number}
|
|
1774
|
+
* @memberof VariantsApiListStock
|
|
1775
|
+
*/
|
|
1776
|
+
readonly pageToken?: number
|
|
1777
|
+
|
|
1778
|
+
/**
|
|
1779
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1780
|
+
* @type {number}
|
|
1781
|
+
* @memberof VariantsApiListStock
|
|
1782
|
+
*/
|
|
1783
|
+
readonly pageSize?: number
|
|
1784
|
+
|
|
1785
|
+
/**
|
|
1786
|
+
* Search terms to filter based on.
|
|
1787
|
+
* @type {string}
|
|
1788
|
+
* @memberof VariantsApiListStock
|
|
1789
|
+
*/
|
|
1790
|
+
readonly search?: string
|
|
1791
|
+
}
|
|
1792
|
+
|
|
1793
|
+
/**
|
|
1794
|
+
* Request parameters for listVariants operation in VariantsApi.
|
|
1795
|
+
* @export
|
|
1796
|
+
* @interface VariantsApiListVariantsRequest
|
|
1797
|
+
*/
|
|
1798
|
+
export interface VariantsApiListVariantsRequest {
|
|
1799
|
+
/**
|
|
1800
|
+
* What project it is
|
|
1801
|
+
* @type {string}
|
|
1802
|
+
* @memberof VariantsApiListVariants
|
|
1803
|
+
*/
|
|
1804
|
+
readonly project: string
|
|
1805
|
+
|
|
1806
|
+
/**
|
|
1807
|
+
* Page reference token
|
|
1808
|
+
* @type {number}
|
|
1809
|
+
* @memberof VariantsApiListVariants
|
|
1810
|
+
*/
|
|
1811
|
+
readonly pageToken?: number
|
|
1812
|
+
|
|
1813
|
+
/**
|
|
1814
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1815
|
+
* @type {number}
|
|
1816
|
+
* @memberof VariantsApiListVariants
|
|
1817
|
+
*/
|
|
1818
|
+
readonly pageSize?: number
|
|
1819
|
+
|
|
1820
|
+
/**
|
|
1821
|
+
* Filter response fields to only include a subset of the resource.
|
|
1822
|
+
* @type {string}
|
|
1823
|
+
* @memberof VariantsApiListVariants
|
|
1824
|
+
*/
|
|
1825
|
+
readonly fields?: string
|
|
1826
|
+
|
|
1827
|
+
/**
|
|
1828
|
+
* Search terms to filter based on.
|
|
1829
|
+
* @type {string}
|
|
1830
|
+
* @memberof VariantsApiListVariants
|
|
1831
|
+
*/
|
|
1832
|
+
readonly search?: string
|
|
1833
|
+
}
|
|
1834
|
+
|
|
1835
|
+
/**
|
|
1836
|
+
* VariantsApi - object-oriented interface
|
|
1837
|
+
* @export
|
|
1838
|
+
* @class VariantsApi
|
|
1839
|
+
* @extends {BaseAPI}
|
|
1840
|
+
*/
|
|
1841
|
+
export class VariantsApi extends BaseAPI {
|
|
1842
|
+
/**
|
|
1843
|
+
* Gets the stock level for the GFN variant with the given ID.
|
|
1844
|
+
* @summary Get GFN variant stock
|
|
1845
|
+
* @param {VariantsApiGetStockRequest} requestParameters Request parameters.
|
|
1846
|
+
* @param {*} [options] Override http request option.
|
|
1847
|
+
* @throws {RequiredError}
|
|
1848
|
+
* @memberof VariantsApi
|
|
1849
|
+
*/
|
|
1850
|
+
public getStock(requestParameters: VariantsApiGetStockRequest, options?: RawAxiosRequestConfig) {
|
|
1851
|
+
return VariantsApiFp(this.configuration).getStock(requestParameters.project, requestParameters.variantId, requestParameters.fulfillmentProjects, options).then((request) => request(this.axios, this.basePath));
|
|
1852
|
+
}
|
|
1853
|
+
|
|
1854
|
+
/**
|
|
1855
|
+
* Gets a GFN variant by the given ID.
|
|
1856
|
+
* @summary Get a GFN variant
|
|
1857
|
+
* @param {VariantsApiGetVariantRequest} requestParameters Request parameters.
|
|
1858
|
+
* @param {*} [options] Override http request option.
|
|
1859
|
+
* @throws {RequiredError}
|
|
1860
|
+
* @memberof VariantsApi
|
|
1861
|
+
*/
|
|
1862
|
+
public getVariant(requestParameters: VariantsApiGetVariantRequest, options?: RawAxiosRequestConfig) {
|
|
1863
|
+
return VariantsApiFp(this.configuration).getVariant(requestParameters.project, requestParameters.variantId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
1864
|
+
}
|
|
1865
|
+
|
|
1866
|
+
/**
|
|
1867
|
+
* Lists the stock levels for all GFN variants available to the project.
|
|
1868
|
+
* @summary List GFN variant stock
|
|
1869
|
+
* @param {VariantsApiListStockRequest} requestParameters Request parameters.
|
|
1870
|
+
* @param {*} [options] Override http request option.
|
|
1871
|
+
* @throws {RequiredError}
|
|
1872
|
+
* @memberof VariantsApi
|
|
1873
|
+
*/
|
|
1874
|
+
public listStock(requestParameters: VariantsApiListStockRequest, options?: RawAxiosRequestConfig) {
|
|
1875
|
+
return VariantsApiFp(this.configuration).listStock(requestParameters.project, requestParameters.fulfillmentProjects, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
1876
|
+
}
|
|
1877
|
+
|
|
1878
|
+
/**
|
|
1879
|
+
* Lists all GFN variants available to the project. Can be filtered by product ID, SKU, and attribute values using the search parameter.
|
|
1880
|
+
* @summary List GFN variants
|
|
1881
|
+
* @param {VariantsApiListVariantsRequest} requestParameters Request parameters.
|
|
1882
|
+
* @param {*} [options] Override http request option.
|
|
1883
|
+
* @throws {RequiredError}
|
|
1884
|
+
* @memberof VariantsApi
|
|
1885
|
+
*/
|
|
1886
|
+
public listVariants(requestParameters: VariantsApiListVariantsRequest, options?: RawAxiosRequestConfig) {
|
|
1887
|
+
return VariantsApiFp(this.configuration).listVariants(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.fields, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
1888
|
+
}
|
|
1889
|
+
}
|
|
1890
|
+
|
|
1891
|
+
|
|
1892
|
+
|