@teemill/gtins 0.6.1 → 0.6.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +47 -2
- package/api.ts +10 -10
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -3
- package/dist/api.d.ts +10 -10
- package/dist/api.js +4 -4
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +2 -2
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +10 -10
- package/dist/esm/api.js +4 -4
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +2 -2
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/ApiError.md +22 -0
- package/docs/AssignGtinRequest.md +20 -0
- package/docs/GTIN.md +24 -0
- package/docs/GTINVariantsInner.md +20 -0
- package/docs/GTINsApi.md +376 -0
- package/docs/GTINsResponse.md +22 -0
- package/docs/InlineObject.md +20 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/gtins@0.6.
|
|
1
|
+
## @teemill/gtins@0.6.3
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/gtins@0.6.
|
|
39
|
+
npm install @teemill/gtins@0.6.3 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -44,3 +44,48 @@ _unPublished (not recommended):_
|
|
|
44
44
|
```
|
|
45
45
|
npm install PATH_TO_GENERATED_PACKAGE --save
|
|
46
46
|
```
|
|
47
|
+
|
|
48
|
+
### Documentation for API Endpoints
|
|
49
|
+
|
|
50
|
+
All URIs are relative to *https://api.podos.io*
|
|
51
|
+
|
|
52
|
+
Class | Method | HTTP request | Description
|
|
53
|
+
------------ | ------------- | ------------- | -------------
|
|
54
|
+
*GTINsApi* | [**assignGtin**](docs/GTINsApi.md#assigngtin) | **POST** /v1/gtins/{gtin}/assign | Assign GTIN
|
|
55
|
+
*GTINsApi* | [**exportGtins**](docs/GTINsApi.md#exportgtins) | **GET** /v1/gtins/export | Export GTINs
|
|
56
|
+
*GTINsApi* | [**getGtin**](docs/GTINsApi.md#getgtin) | **GET** /v1/gtins/{gtin} | Get GTIN
|
|
57
|
+
*GTINsApi* | [**importGtins**](docs/GTINsApi.md#importgtins) | **POST** /v1/gtins/import | Import GTINs
|
|
58
|
+
*GTINsApi* | [**listGtins**](docs/GTINsApi.md#listgtins) | **GET** /v1/gtins | List gtins
|
|
59
|
+
*GTINsApi* | [**unassignGtin**](docs/GTINsApi.md#unassigngtin) | **POST** /v1/gtins/{gtin}/unassign | Unassign GTIN
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
### Documentation For Models
|
|
63
|
+
|
|
64
|
+
- [ApiError](docs/ApiError.md)
|
|
65
|
+
- [AssignGtinRequest](docs/AssignGtinRequest.md)
|
|
66
|
+
- [GTIN](docs/GTIN.md)
|
|
67
|
+
- [GTINVariantsInner](docs/GTINVariantsInner.md)
|
|
68
|
+
- [GTINsResponse](docs/GTINsResponse.md)
|
|
69
|
+
- [InlineObject](docs/InlineObject.md)
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
<a id="documentation-for-authorization"></a>
|
|
73
|
+
## Documentation For Authorization
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
Authentication schemes defined for the API:
|
|
77
|
+
<a id="api-key"></a>
|
|
78
|
+
### api-key
|
|
79
|
+
|
|
80
|
+
- **Type**: API key
|
|
81
|
+
- **API key parameter name**: Authorization
|
|
82
|
+
- **Location**: HTTP header
|
|
83
|
+
|
|
84
|
+
<a id="session-oauth"></a>
|
|
85
|
+
### session-oauth
|
|
86
|
+
|
|
87
|
+
- **Type**: OAuth
|
|
88
|
+
- **Flow**: password
|
|
89
|
+
- **Authorization URL**:
|
|
90
|
+
- **Scopes**: N/A
|
|
91
|
+
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GTINs API
|
|
5
5
|
* Manage GTINs
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.6.
|
|
7
|
+
* The version of the OpenAPI document: 0.6.3
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -115,13 +115,13 @@ export interface GTINsResponse {
|
|
|
115
115
|
/**
|
|
116
116
|
*
|
|
117
117
|
* @export
|
|
118
|
-
* @interface
|
|
118
|
+
* @interface InlineObject
|
|
119
119
|
*/
|
|
120
|
-
export interface
|
|
120
|
+
export interface InlineObject {
|
|
121
121
|
/**
|
|
122
122
|
* Id of the GTINs import
|
|
123
123
|
* @type {string}
|
|
124
|
-
* @memberof
|
|
124
|
+
* @memberof InlineObject
|
|
125
125
|
*/
|
|
126
126
|
'importId'?: string;
|
|
127
127
|
}
|
|
@@ -285,7 +285,7 @@ export const GTINsApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
285
285
|
* Initiates a GTINs import from a CSV file. The result will be available as a notification in the dashboard.
|
|
286
286
|
* @summary Import GTINs
|
|
287
287
|
* @param {string} project What project it is
|
|
288
|
-
* @param {string} [body] A data URL of a CSV file containing GTINs
|
|
288
|
+
* @param {string} [body] A base64 data URL of a CSV file containing GTINs
|
|
289
289
|
* @param {*} [options] Override http request option.
|
|
290
290
|
* @throws {RequiredError}
|
|
291
291
|
*/
|
|
@@ -317,7 +317,7 @@ export const GTINsApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
317
317
|
|
|
318
318
|
|
|
319
319
|
|
|
320
|
-
localVarHeaderParameter['Content-Type'] = 'text/
|
|
320
|
+
localVarHeaderParameter['Content-Type'] = 'text/plain; charset=utf-8';
|
|
321
321
|
|
|
322
322
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
323
323
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -493,11 +493,11 @@ export const GTINsApiFp = function(configuration?: Configuration) {
|
|
|
493
493
|
* Initiates a GTINs import from a CSV file. The result will be available as a notification in the dashboard.
|
|
494
494
|
* @summary Import GTINs
|
|
495
495
|
* @param {string} project What project it is
|
|
496
|
-
* @param {string} [body] A data URL of a CSV file containing GTINs
|
|
496
|
+
* @param {string} [body] A base64 data URL of a CSV file containing GTINs
|
|
497
497
|
* @param {*} [options] Override http request option.
|
|
498
498
|
* @throws {RequiredError}
|
|
499
499
|
*/
|
|
500
|
-
async importGtins(project: string, body?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
500
|
+
async importGtins(project: string, body?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject>> {
|
|
501
501
|
const localVarAxiosArgs = await localVarAxiosParamCreator.importGtins(project, body, options);
|
|
502
502
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
503
503
|
const localVarOperationServerBasePath = operationServerMap['GTINsApi.importGtins']?.[localVarOperationServerIndex]?.url;
|
|
@@ -580,7 +580,7 @@ export const GTINsApiFactory = function (configuration?: Configuration, basePath
|
|
|
580
580
|
* @param {*} [options] Override http request option.
|
|
581
581
|
* @throws {RequiredError}
|
|
582
582
|
*/
|
|
583
|
-
importGtins(requestParameters: GTINsApiImportGtinsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
583
|
+
importGtins(requestParameters: GTINsApiImportGtinsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject> {
|
|
584
584
|
return localVarFp.importGtins(requestParameters.project, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
585
585
|
},
|
|
586
586
|
/**
|
|
@@ -690,7 +690,7 @@ export interface GTINsApiImportGtinsRequest {
|
|
|
690
690
|
readonly project: string
|
|
691
691
|
|
|
692
692
|
/**
|
|
693
|
-
* A data URL of a CSV file containing GTINs
|
|
693
|
+
* A base64 data URL of a CSV file containing GTINs
|
|
694
694
|
* @type {string}
|
|
695
695
|
* @memberof GTINsApiImportGtins
|
|
696
696
|
*/
|
package/base.ts
CHANGED
package/common.ts
CHANGED
package/configuration.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GTINs API
|
|
5
5
|
* Manage GTINs
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.6.
|
|
7
|
+
* The version of the OpenAPI document: 0.6.3
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -90,11 +90,10 @@ export class Configuration {
|
|
|
90
90
|
this.basePath = param.basePath;
|
|
91
91
|
this.serverIndex = param.serverIndex;
|
|
92
92
|
this.baseOptions = {
|
|
93
|
+
...param.baseOptions,
|
|
93
94
|
headers: {
|
|
94
95
|
...param.baseOptions?.headers,
|
|
95
|
-
'User-Agent': "OpenAPI-Generator/0.6.1/typescript-axios"
|
|
96
96
|
},
|
|
97
|
-
...param.baseOptions
|
|
98
97
|
};
|
|
99
98
|
this.formDataCtor = param.formDataCtor;
|
|
100
99
|
}
|
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GTINs API
|
|
3
3
|
* Manage GTINs
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.6.
|
|
5
|
+
* The version of the OpenAPI document: 0.6.3
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -105,13 +105,13 @@ export interface GTINsResponse {
|
|
|
105
105
|
/**
|
|
106
106
|
*
|
|
107
107
|
* @export
|
|
108
|
-
* @interface
|
|
108
|
+
* @interface InlineObject
|
|
109
109
|
*/
|
|
110
|
-
export interface
|
|
110
|
+
export interface InlineObject {
|
|
111
111
|
/**
|
|
112
112
|
* Id of the GTINs import
|
|
113
113
|
* @type {string}
|
|
114
|
-
* @memberof
|
|
114
|
+
* @memberof InlineObject
|
|
115
115
|
*/
|
|
116
116
|
'importId'?: string;
|
|
117
117
|
}
|
|
@@ -152,7 +152,7 @@ export declare const GTINsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
152
152
|
* Initiates a GTINs import from a CSV file. The result will be available as a notification in the dashboard.
|
|
153
153
|
* @summary Import GTINs
|
|
154
154
|
* @param {string} project What project it is
|
|
155
|
-
* @param {string} [body] A data URL of a CSV file containing GTINs
|
|
155
|
+
* @param {string} [body] A base64 data URL of a CSV file containing GTINs
|
|
156
156
|
* @param {*} [options] Override http request option.
|
|
157
157
|
* @throws {RequiredError}
|
|
158
158
|
*/
|
|
@@ -215,11 +215,11 @@ export declare const GTINsApiFp: (configuration?: Configuration) => {
|
|
|
215
215
|
* Initiates a GTINs import from a CSV file. The result will be available as a notification in the dashboard.
|
|
216
216
|
* @summary Import GTINs
|
|
217
217
|
* @param {string} project What project it is
|
|
218
|
-
* @param {string} [body] A data URL of a CSV file containing GTINs
|
|
218
|
+
* @param {string} [body] A base64 data URL of a CSV file containing GTINs
|
|
219
219
|
* @param {*} [options] Override http request option.
|
|
220
220
|
* @throws {RequiredError}
|
|
221
221
|
*/
|
|
222
|
-
importGtins(project: string, body?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
222
|
+
importGtins(project: string, body?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject>>;
|
|
223
223
|
/**
|
|
224
224
|
* List GTINs
|
|
225
225
|
* @summary List gtins
|
|
@@ -277,7 +277,7 @@ export declare const GTINsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
277
277
|
* @param {*} [options] Override http request option.
|
|
278
278
|
* @throws {RequiredError}
|
|
279
279
|
*/
|
|
280
|
-
importGtins(requestParameters: GTINsApiImportGtinsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
280
|
+
importGtins(requestParameters: GTINsApiImportGtinsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject>;
|
|
281
281
|
/**
|
|
282
282
|
* List GTINs
|
|
283
283
|
* @summary List gtins
|
|
@@ -371,7 +371,7 @@ export interface GTINsApiImportGtinsRequest {
|
|
|
371
371
|
*/
|
|
372
372
|
readonly project: string;
|
|
373
373
|
/**
|
|
374
|
-
* A data URL of a CSV file containing GTINs
|
|
374
|
+
* A base64 data URL of a CSV file containing GTINs
|
|
375
375
|
* @type {string}
|
|
376
376
|
* @memberof GTINsApiImportGtins
|
|
377
377
|
*/
|
|
@@ -469,7 +469,7 @@ export declare class GTINsApi extends BaseAPI {
|
|
|
469
469
|
* @throws {RequiredError}
|
|
470
470
|
* @memberof GTINsApi
|
|
471
471
|
*/
|
|
472
|
-
importGtins(requestParameters: GTINsApiImportGtinsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
472
|
+
importGtins(requestParameters: GTINsApiImportGtinsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineObject, any>>;
|
|
473
473
|
/**
|
|
474
474
|
* List GTINs
|
|
475
475
|
* @summary List gtins
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* GTINs API
|
|
6
6
|
* Manage GTINs
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 0.6.
|
|
8
|
+
* The version of the OpenAPI document: 0.6.3
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -162,7 +162,7 @@ const GTINsApiAxiosParamCreator = function (configuration) {
|
|
|
162
162
|
* Initiates a GTINs import from a CSV file. The result will be available as a notification in the dashboard.
|
|
163
163
|
* @summary Import GTINs
|
|
164
164
|
* @param {string} project What project it is
|
|
165
|
-
* @param {string} [body] A data URL of a CSV file containing GTINs
|
|
165
|
+
* @param {string} [body] A base64 data URL of a CSV file containing GTINs
|
|
166
166
|
* @param {*} [options] Override http request option.
|
|
167
167
|
* @throws {RequiredError}
|
|
168
168
|
*/
|
|
@@ -187,7 +187,7 @@ const GTINsApiAxiosParamCreator = function (configuration) {
|
|
|
187
187
|
if (project !== undefined) {
|
|
188
188
|
localVarQueryParameter['project'] = project;
|
|
189
189
|
}
|
|
190
|
-
localVarHeaderParameter['Content-Type'] = 'text/
|
|
190
|
+
localVarHeaderParameter['Content-Type'] = 'text/plain; charset=utf-8';
|
|
191
191
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
192
192
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
193
193
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -351,7 +351,7 @@ const GTINsApiFp = function (configuration) {
|
|
|
351
351
|
* Initiates a GTINs import from a CSV file. The result will be available as a notification in the dashboard.
|
|
352
352
|
* @summary Import GTINs
|
|
353
353
|
* @param {string} project What project it is
|
|
354
|
-
* @param {string} [body] A data URL of a CSV file containing GTINs
|
|
354
|
+
* @param {string} [body] A base64 data URL of a CSV file containing GTINs
|
|
355
355
|
* @param {*} [options] Override http request option.
|
|
356
356
|
* @throws {RequiredError}
|
|
357
357
|
*/
|
package/dist/base.d.ts
CHANGED
package/dist/base.js
CHANGED
package/dist/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GTINs API
|
|
3
3
|
* Manage GTINs
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.6.
|
|
5
|
+
* The version of the OpenAPI document: 0.6.3
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
|
|
|
62
62
|
*
|
|
63
63
|
* @export
|
|
64
64
|
*/
|
|
65
|
-
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T
|
|
65
|
+
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|
package/dist/common.js
CHANGED
package/dist/configuration.d.ts
CHANGED
package/dist/configuration.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* GTINs API
|
|
6
6
|
* Manage GTINs
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 0.6.
|
|
8
|
+
* The version of the OpenAPI document: 0.6.3
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -23,7 +23,7 @@ class Configuration {
|
|
|
23
23
|
this.accessToken = param.accessToken;
|
|
24
24
|
this.basePath = param.basePath;
|
|
25
25
|
this.serverIndex = param.serverIndex;
|
|
26
|
-
this.baseOptions = Object.assign({ headers: Object.assign(
|
|
26
|
+
this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
|
|
27
27
|
this.formDataCtor = param.formDataCtor;
|
|
28
28
|
}
|
|
29
29
|
/**
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GTINs API
|
|
3
3
|
* Manage GTINs
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.6.
|
|
5
|
+
* The version of the OpenAPI document: 0.6.3
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -105,13 +105,13 @@ export interface GTINsResponse {
|
|
|
105
105
|
/**
|
|
106
106
|
*
|
|
107
107
|
* @export
|
|
108
|
-
* @interface
|
|
108
|
+
* @interface InlineObject
|
|
109
109
|
*/
|
|
110
|
-
export interface
|
|
110
|
+
export interface InlineObject {
|
|
111
111
|
/**
|
|
112
112
|
* Id of the GTINs import
|
|
113
113
|
* @type {string}
|
|
114
|
-
* @memberof
|
|
114
|
+
* @memberof InlineObject
|
|
115
115
|
*/
|
|
116
116
|
'importId'?: string;
|
|
117
117
|
}
|
|
@@ -152,7 +152,7 @@ export declare const GTINsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
152
152
|
* Initiates a GTINs import from a CSV file. The result will be available as a notification in the dashboard.
|
|
153
153
|
* @summary Import GTINs
|
|
154
154
|
* @param {string} project What project it is
|
|
155
|
-
* @param {string} [body] A data URL of a CSV file containing GTINs
|
|
155
|
+
* @param {string} [body] A base64 data URL of a CSV file containing GTINs
|
|
156
156
|
* @param {*} [options] Override http request option.
|
|
157
157
|
* @throws {RequiredError}
|
|
158
158
|
*/
|
|
@@ -215,11 +215,11 @@ export declare const GTINsApiFp: (configuration?: Configuration) => {
|
|
|
215
215
|
* Initiates a GTINs import from a CSV file. The result will be available as a notification in the dashboard.
|
|
216
216
|
* @summary Import GTINs
|
|
217
217
|
* @param {string} project What project it is
|
|
218
|
-
* @param {string} [body] A data URL of a CSV file containing GTINs
|
|
218
|
+
* @param {string} [body] A base64 data URL of a CSV file containing GTINs
|
|
219
219
|
* @param {*} [options] Override http request option.
|
|
220
220
|
* @throws {RequiredError}
|
|
221
221
|
*/
|
|
222
|
-
importGtins(project: string, body?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
222
|
+
importGtins(project: string, body?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject>>;
|
|
223
223
|
/**
|
|
224
224
|
* List GTINs
|
|
225
225
|
* @summary List gtins
|
|
@@ -277,7 +277,7 @@ export declare const GTINsApiFactory: (configuration?: Configuration, basePath?:
|
|
|
277
277
|
* @param {*} [options] Override http request option.
|
|
278
278
|
* @throws {RequiredError}
|
|
279
279
|
*/
|
|
280
|
-
importGtins(requestParameters: GTINsApiImportGtinsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
280
|
+
importGtins(requestParameters: GTINsApiImportGtinsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject>;
|
|
281
281
|
/**
|
|
282
282
|
* List GTINs
|
|
283
283
|
* @summary List gtins
|
|
@@ -371,7 +371,7 @@ export interface GTINsApiImportGtinsRequest {
|
|
|
371
371
|
*/
|
|
372
372
|
readonly project: string;
|
|
373
373
|
/**
|
|
374
|
-
* A data URL of a CSV file containing GTINs
|
|
374
|
+
* A base64 data URL of a CSV file containing GTINs
|
|
375
375
|
* @type {string}
|
|
376
376
|
* @memberof GTINsApiImportGtins
|
|
377
377
|
*/
|
|
@@ -469,7 +469,7 @@ export declare class GTINsApi extends BaseAPI {
|
|
|
469
469
|
* @throws {RequiredError}
|
|
470
470
|
* @memberof GTINsApi
|
|
471
471
|
*/
|
|
472
|
-
importGtins(requestParameters: GTINsApiImportGtinsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
472
|
+
importGtins(requestParameters: GTINsApiImportGtinsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineObject, any>>;
|
|
473
473
|
/**
|
|
474
474
|
* List GTINs
|
|
475
475
|
* @summary List gtins
|
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GTINs API
|
|
5
5
|
* Manage GTINs
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.6.
|
|
7
|
+
* The version of the OpenAPI document: 0.6.3
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -159,7 +159,7 @@ export const GTINsApiAxiosParamCreator = function (configuration) {
|
|
|
159
159
|
* Initiates a GTINs import from a CSV file. The result will be available as a notification in the dashboard.
|
|
160
160
|
* @summary Import GTINs
|
|
161
161
|
* @param {string} project What project it is
|
|
162
|
-
* @param {string} [body] A data URL of a CSV file containing GTINs
|
|
162
|
+
* @param {string} [body] A base64 data URL of a CSV file containing GTINs
|
|
163
163
|
* @param {*} [options] Override http request option.
|
|
164
164
|
* @throws {RequiredError}
|
|
165
165
|
*/
|
|
@@ -184,7 +184,7 @@ export const GTINsApiAxiosParamCreator = function (configuration) {
|
|
|
184
184
|
if (project !== undefined) {
|
|
185
185
|
localVarQueryParameter['project'] = project;
|
|
186
186
|
}
|
|
187
|
-
localVarHeaderParameter['Content-Type'] = 'text/
|
|
187
|
+
localVarHeaderParameter['Content-Type'] = 'text/plain; charset=utf-8';
|
|
188
188
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
189
189
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
190
190
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -347,7 +347,7 @@ export const GTINsApiFp = function (configuration) {
|
|
|
347
347
|
* Initiates a GTINs import from a CSV file. The result will be available as a notification in the dashboard.
|
|
348
348
|
* @summary Import GTINs
|
|
349
349
|
* @param {string} project What project it is
|
|
350
|
-
* @param {string} [body] A data URL of a CSV file containing GTINs
|
|
350
|
+
* @param {string} [body] A base64 data URL of a CSV file containing GTINs
|
|
351
351
|
* @param {*} [options] Override http request option.
|
|
352
352
|
* @throws {RequiredError}
|
|
353
353
|
*/
|
package/dist/esm/base.d.ts
CHANGED
package/dist/esm/base.js
CHANGED
package/dist/esm/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GTINs API
|
|
3
3
|
* Manage GTINs
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.6.
|
|
5
|
+
* The version of the OpenAPI document: 0.6.3
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
|
|
|
62
62
|
*
|
|
63
63
|
* @export
|
|
64
64
|
*/
|
|
65
|
-
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T
|
|
65
|
+
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|
package/dist/esm/common.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GTINs API
|
|
5
5
|
* Manage GTINs
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.6.
|
|
7
|
+
* The version of the OpenAPI document: 0.6.3
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -20,7 +20,7 @@ export class Configuration {
|
|
|
20
20
|
this.accessToken = param.accessToken;
|
|
21
21
|
this.basePath = param.basePath;
|
|
22
22
|
this.serverIndex = param.serverIndex;
|
|
23
|
-
this.baseOptions = Object.assign({ headers: Object.assign(
|
|
23
|
+
this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
|
|
24
24
|
this.formDataCtor = param.formDataCtor;
|
|
25
25
|
}
|
|
26
26
|
/**
|
package/dist/esm/index.d.ts
CHANGED
package/dist/esm/index.js
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
package/docs/ApiError.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiError
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**code** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ApiError } from '@teemill/gtins';
|
|
15
|
+
|
|
16
|
+
const instance: ApiError = {
|
|
17
|
+
code,
|
|
18
|
+
message,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# AssignGtinRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**variantRef** | **string** | A reference to the resource location | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { AssignGtinRequest } from '@teemill/gtins';
|
|
14
|
+
|
|
15
|
+
const instance: AssignGtinRequest = {
|
|
16
|
+
variantRef,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/GTIN.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# GTIN
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**number** | **string** | The GTIN | [default to undefined]
|
|
9
|
+
**variantRef** | **string** | A reference to the resource location | [default to undefined]
|
|
10
|
+
**variants** | [**Array<GTINVariantsInner>**](GTINVariantsInner.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { GTIN } from '@teemill/gtins';
|
|
16
|
+
|
|
17
|
+
const instance: GTIN = {
|
|
18
|
+
number,
|
|
19
|
+
variantRef,
|
|
20
|
+
variants,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# GTINVariantsInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**ref** | **string** | A reference to the resource location | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { GTINVariantsInner } from '@teemill/gtins';
|
|
14
|
+
|
|
15
|
+
const instance: GTINVariantsInner = {
|
|
16
|
+
ref,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/GTINsApi.md
ADDED
|
@@ -0,0 +1,376 @@
|
|
|
1
|
+
# GTINsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.podos.io*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**assignGtin**](#assigngtin) | **POST** /v1/gtins/{gtin}/assign | Assign GTIN|
|
|
8
|
+
|[**exportGtins**](#exportgtins) | **GET** /v1/gtins/export | Export GTINs|
|
|
9
|
+
|[**getGtin**](#getgtin) | **GET** /v1/gtins/{gtin} | Get GTIN|
|
|
10
|
+
|[**importGtins**](#importgtins) | **POST** /v1/gtins/import | Import GTINs|
|
|
11
|
+
|[**listGtins**](#listgtins) | **GET** /v1/gtins | List gtins|
|
|
12
|
+
|[**unassignGtin**](#unassigngtin) | **POST** /v1/gtins/{gtin}/unassign | Unassign GTIN|
|
|
13
|
+
|
|
14
|
+
# **assignGtin**
|
|
15
|
+
> GTIN assignGtin()
|
|
16
|
+
|
|
17
|
+
Assign a GTIN to a variant
|
|
18
|
+
|
|
19
|
+
### Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import {
|
|
23
|
+
GTINsApi,
|
|
24
|
+
Configuration,
|
|
25
|
+
AssignGtinRequest
|
|
26
|
+
} from '@teemill/gtins';
|
|
27
|
+
|
|
28
|
+
const configuration = new Configuration();
|
|
29
|
+
const apiInstance = new GTINsApi(configuration);
|
|
30
|
+
|
|
31
|
+
let project: string; //What project it is (default to undefined)
|
|
32
|
+
let gtin: string; //GTIN (default to undefined)
|
|
33
|
+
let assignGtinRequest: AssignGtinRequest; //Assign a GTIN to a variant (optional)
|
|
34
|
+
|
|
35
|
+
const { status, data } = await apiInstance.assignGtin(
|
|
36
|
+
project,
|
|
37
|
+
gtin,
|
|
38
|
+
assignGtinRequest
|
|
39
|
+
);
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### Parameters
|
|
43
|
+
|
|
44
|
+
|Name | Type | Description | Notes|
|
|
45
|
+
|------------- | ------------- | ------------- | -------------|
|
|
46
|
+
| **assignGtinRequest** | **AssignGtinRequest**| Assign a GTIN to a variant | |
|
|
47
|
+
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
48
|
+
| **gtin** | [**string**] | GTIN | defaults to undefined|
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
### Return type
|
|
52
|
+
|
|
53
|
+
**GTIN**
|
|
54
|
+
|
|
55
|
+
### Authorization
|
|
56
|
+
|
|
57
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
58
|
+
|
|
59
|
+
### HTTP request headers
|
|
60
|
+
|
|
61
|
+
- **Content-Type**: application/json
|
|
62
|
+
- **Accept**: application/json
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
### HTTP response details
|
|
66
|
+
| Status code | Description | Response headers |
|
|
67
|
+
|-------------|-------------|------------------|
|
|
68
|
+
|**200** | GTIN | - |
|
|
69
|
+
|**400** | Failed validation. | - |
|
|
70
|
+
|**401** | Not authorised to access this resource. | - |
|
|
71
|
+
|**403** | Refuse to authorize. | - |
|
|
72
|
+
|**404** | Resource not found. | - |
|
|
73
|
+
|**500** | Unknown server error. | - |
|
|
74
|
+
|
|
75
|
+
[[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)
|
|
76
|
+
|
|
77
|
+
# **exportGtins**
|
|
78
|
+
> File exportGtins()
|
|
79
|
+
|
|
80
|
+
Export a CSV of a project\'s GTINs
|
|
81
|
+
|
|
82
|
+
### Example
|
|
83
|
+
|
|
84
|
+
```typescript
|
|
85
|
+
import {
|
|
86
|
+
GTINsApi,
|
|
87
|
+
Configuration
|
|
88
|
+
} from '@teemill/gtins';
|
|
89
|
+
|
|
90
|
+
const configuration = new Configuration();
|
|
91
|
+
const apiInstance = new GTINsApi(configuration);
|
|
92
|
+
|
|
93
|
+
let project: string; //What project it is (default to undefined)
|
|
94
|
+
let gtins: string; //GTINs (optional) (default to undefined)
|
|
95
|
+
|
|
96
|
+
const { status, data } = await apiInstance.exportGtins(
|
|
97
|
+
project,
|
|
98
|
+
gtins
|
|
99
|
+
);
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### Parameters
|
|
103
|
+
|
|
104
|
+
|Name | Type | Description | Notes|
|
|
105
|
+
|------------- | ------------- | ------------- | -------------|
|
|
106
|
+
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
107
|
+
| **gtins** | [**string**] | GTINs | (optional) defaults to undefined|
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
### Return type
|
|
111
|
+
|
|
112
|
+
**File**
|
|
113
|
+
|
|
114
|
+
### Authorization
|
|
115
|
+
|
|
116
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
117
|
+
|
|
118
|
+
### HTTP request headers
|
|
119
|
+
|
|
120
|
+
- **Content-Type**: Not defined
|
|
121
|
+
- **Accept**: text/csv; charset=utf-8, application/json
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
### HTTP response details
|
|
125
|
+
| Status code | Description | Response headers |
|
|
126
|
+
|-------------|-------------|------------------|
|
|
127
|
+
|**200** | Returns the CSV export | - |
|
|
128
|
+
|**202** | GTINs export started | - |
|
|
129
|
+
|**400** | Failed validation. | - |
|
|
130
|
+
|**401** | Not authorised to access this resource. | - |
|
|
131
|
+
|**403** | Refuse to authorize. | - |
|
|
132
|
+
|**404** | Resource not found. | - |
|
|
133
|
+
|**500** | Unknown server error. | - |
|
|
134
|
+
|
|
135
|
+
[[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)
|
|
136
|
+
|
|
137
|
+
# **getGtin**
|
|
138
|
+
> GTIN getGtin()
|
|
139
|
+
|
|
140
|
+
Get a GTIN
|
|
141
|
+
|
|
142
|
+
### Example
|
|
143
|
+
|
|
144
|
+
```typescript
|
|
145
|
+
import {
|
|
146
|
+
GTINsApi,
|
|
147
|
+
Configuration
|
|
148
|
+
} from '@teemill/gtins';
|
|
149
|
+
|
|
150
|
+
const configuration = new Configuration();
|
|
151
|
+
const apiInstance = new GTINsApi(configuration);
|
|
152
|
+
|
|
153
|
+
let project: string; //What project it is (default to undefined)
|
|
154
|
+
let gtin: string; //GTIN (default to undefined)
|
|
155
|
+
|
|
156
|
+
const { status, data } = await apiInstance.getGtin(
|
|
157
|
+
project,
|
|
158
|
+
gtin
|
|
159
|
+
);
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### Parameters
|
|
163
|
+
|
|
164
|
+
|Name | Type | Description | Notes|
|
|
165
|
+
|------------- | ------------- | ------------- | -------------|
|
|
166
|
+
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
167
|
+
| **gtin** | [**string**] | GTIN | defaults to undefined|
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
### Return type
|
|
171
|
+
|
|
172
|
+
**GTIN**
|
|
173
|
+
|
|
174
|
+
### Authorization
|
|
175
|
+
|
|
176
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
177
|
+
|
|
178
|
+
### HTTP request headers
|
|
179
|
+
|
|
180
|
+
- **Content-Type**: Not defined
|
|
181
|
+
- **Accept**: application/json
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
### HTTP response details
|
|
185
|
+
| Status code | Description | Response headers |
|
|
186
|
+
|-------------|-------------|------------------|
|
|
187
|
+
|**200** | GTIN | - |
|
|
188
|
+
|**401** | Not authorised to access this resource. | - |
|
|
189
|
+
|**403** | Refuse to authorize. | - |
|
|
190
|
+
|**404** | Resource not found. | - |
|
|
191
|
+
|**500** | Unknown server error. | - |
|
|
192
|
+
|
|
193
|
+
[[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)
|
|
194
|
+
|
|
195
|
+
# **importGtins**
|
|
196
|
+
> InlineObject importGtins()
|
|
197
|
+
|
|
198
|
+
Initiates a GTINs import from a CSV file. The result will be available as a notification in the dashboard.
|
|
199
|
+
|
|
200
|
+
### Example
|
|
201
|
+
|
|
202
|
+
```typescript
|
|
203
|
+
import {
|
|
204
|
+
GTINsApi,
|
|
205
|
+
Configuration
|
|
206
|
+
} from '@teemill/gtins';
|
|
207
|
+
|
|
208
|
+
const configuration = new Configuration();
|
|
209
|
+
const apiInstance = new GTINsApi(configuration);
|
|
210
|
+
|
|
211
|
+
let project: string; //What project it is (default to undefined)
|
|
212
|
+
let body: string; //A base64 data URL of a CSV file containing GTINs (optional)
|
|
213
|
+
|
|
214
|
+
const { status, data } = await apiInstance.importGtins(
|
|
215
|
+
project,
|
|
216
|
+
body
|
|
217
|
+
);
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
### Parameters
|
|
221
|
+
|
|
222
|
+
|Name | Type | Description | Notes|
|
|
223
|
+
|------------- | ------------- | ------------- | -------------|
|
|
224
|
+
| **body** | **string**| A base64 data URL of a CSV file containing GTINs | |
|
|
225
|
+
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
### Return type
|
|
229
|
+
|
|
230
|
+
**InlineObject**
|
|
231
|
+
|
|
232
|
+
### Authorization
|
|
233
|
+
|
|
234
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
235
|
+
|
|
236
|
+
### HTTP request headers
|
|
237
|
+
|
|
238
|
+
- **Content-Type**: text/plain; charset=utf-8
|
|
239
|
+
- **Accept**: application/json
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
### HTTP response details
|
|
243
|
+
| Status code | Description | Response headers |
|
|
244
|
+
|-------------|-------------|------------------|
|
|
245
|
+
|**202** | CSV file was accepted | - |
|
|
246
|
+
|**400** | Failed validation. | - |
|
|
247
|
+
|**401** | Not authorised to access this resource. | - |
|
|
248
|
+
|**403** | Refuse to authorize. | - |
|
|
249
|
+
|**404** | Resource not found. | - |
|
|
250
|
+
|**500** | Unknown server error. | - |
|
|
251
|
+
|
|
252
|
+
[[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)
|
|
253
|
+
|
|
254
|
+
# **listGtins**
|
|
255
|
+
> GTINsResponse listGtins()
|
|
256
|
+
|
|
257
|
+
List GTINs
|
|
258
|
+
|
|
259
|
+
### Example
|
|
260
|
+
|
|
261
|
+
```typescript
|
|
262
|
+
import {
|
|
263
|
+
GTINsApi,
|
|
264
|
+
Configuration
|
|
265
|
+
} from '@teemill/gtins';
|
|
266
|
+
|
|
267
|
+
const configuration = new Configuration();
|
|
268
|
+
const apiInstance = new GTINsApi(configuration);
|
|
269
|
+
|
|
270
|
+
let project: string; //What project it is (default to undefined)
|
|
271
|
+
let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
|
|
272
|
+
let pageToken: number; //Page reference token (optional) (default to 1)
|
|
273
|
+
let search: string; //Search term to filter based on GTIN based on the GTIN (optional) (default to undefined)
|
|
274
|
+
|
|
275
|
+
const { status, data } = await apiInstance.listGtins(
|
|
276
|
+
project,
|
|
277
|
+
pageSize,
|
|
278
|
+
pageToken,
|
|
279
|
+
search
|
|
280
|
+
);
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
### Parameters
|
|
284
|
+
|
|
285
|
+
|Name | Type | Description | Notes|
|
|
286
|
+
|------------- | ------------- | ------------- | -------------|
|
|
287
|
+
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
288
|
+
| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
|
|
289
|
+
| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
|
|
290
|
+
| **search** | [**string**] | Search term to filter based on GTIN based on the GTIN | (optional) defaults to undefined|
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
### Return type
|
|
294
|
+
|
|
295
|
+
**GTINsResponse**
|
|
296
|
+
|
|
297
|
+
### Authorization
|
|
298
|
+
|
|
299
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
300
|
+
|
|
301
|
+
### HTTP request headers
|
|
302
|
+
|
|
303
|
+
- **Content-Type**: Not defined
|
|
304
|
+
- **Accept**: application/json
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
### HTTP response details
|
|
308
|
+
| Status code | Description | Response headers |
|
|
309
|
+
|-------------|-------------|------------------|
|
|
310
|
+
|**200** | List of GTINs | - |
|
|
311
|
+
|**401** | Not authorised to access this resource. | - |
|
|
312
|
+
|**403** | Refuse to authorize. | - |
|
|
313
|
+
|**404** | Resource not found. | - |
|
|
314
|
+
|**500** | Unknown server error. | - |
|
|
315
|
+
|
|
316
|
+
[[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)
|
|
317
|
+
|
|
318
|
+
# **unassignGtin**
|
|
319
|
+
> unassignGtin()
|
|
320
|
+
|
|
321
|
+
Unassign a GTIN from a variant
|
|
322
|
+
|
|
323
|
+
### Example
|
|
324
|
+
|
|
325
|
+
```typescript
|
|
326
|
+
import {
|
|
327
|
+
GTINsApi,
|
|
328
|
+
Configuration
|
|
329
|
+
} from '@teemill/gtins';
|
|
330
|
+
|
|
331
|
+
const configuration = new Configuration();
|
|
332
|
+
const apiInstance = new GTINsApi(configuration);
|
|
333
|
+
|
|
334
|
+
let project: string; //What project it is (default to undefined)
|
|
335
|
+
let gtin: string; //GTIN (default to undefined)
|
|
336
|
+
|
|
337
|
+
const { status, data } = await apiInstance.unassignGtin(
|
|
338
|
+
project,
|
|
339
|
+
gtin
|
|
340
|
+
);
|
|
341
|
+
```
|
|
342
|
+
|
|
343
|
+
### Parameters
|
|
344
|
+
|
|
345
|
+
|Name | Type | Description | Notes|
|
|
346
|
+
|------------- | ------------- | ------------- | -------------|
|
|
347
|
+
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
348
|
+
| **gtin** | [**string**] | GTIN | defaults to undefined|
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
### Return type
|
|
352
|
+
|
|
353
|
+
void (empty response body)
|
|
354
|
+
|
|
355
|
+
### Authorization
|
|
356
|
+
|
|
357
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
358
|
+
|
|
359
|
+
### HTTP request headers
|
|
360
|
+
|
|
361
|
+
- **Content-Type**: Not defined
|
|
362
|
+
- **Accept**: application/json
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
### HTTP response details
|
|
366
|
+
| Status code | Description | Response headers |
|
|
367
|
+
|-------------|-------------|------------------|
|
|
368
|
+
|**204** | GTIN unassigned | - |
|
|
369
|
+
|**400** | Failed validation. | - |
|
|
370
|
+
|**401** | Not authorised to access this resource. | - |
|
|
371
|
+
|**403** | Refuse to authorize. | - |
|
|
372
|
+
|**404** | Resource not found. | - |
|
|
373
|
+
|**500** | Unknown server error. | - |
|
|
374
|
+
|
|
375
|
+
[[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)
|
|
376
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# GTINsResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**gtins** | [**Array<GTIN>**](GTIN.md) | | [optional] [default to undefined]
|
|
9
|
+
**nextPageToken** | **number** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { GTINsResponse } from '@teemill/gtins';
|
|
15
|
+
|
|
16
|
+
const instance: GTINsResponse = {
|
|
17
|
+
gtins,
|
|
18
|
+
nextPageToken,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# InlineObject
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**importId** | **string** | Id of the GTINs import | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { InlineObject } from '@teemill/gtins';
|
|
14
|
+
|
|
15
|
+
const instance: InlineObject = {
|
|
16
|
+
importId,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/index.ts
CHANGED