@teemill/gtins 0.6.4 → 0.6.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @teemill/gtins@0.6.4
1
+ ## @teemill/gtins@0.6.6
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.4 --save
39
+ npm install @teemill/gtins@0.6.6 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -66,7 +66,7 @@ Class | Method | HTTP request | Description
66
66
  - [GTIN](docs/GTIN.md)
67
67
  - [GTINVariantsInner](docs/GTINVariantsInner.md)
68
68
  - [GTINsResponse](docs/GTINsResponse.md)
69
- - [InlineObject](docs/InlineObject.md)
69
+ - [ImportGtins202Response](docs/ImportGtins202Response.md)
70
70
 
71
71
 
72
72
  <a id="documentation-for-authorization"></a>
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.4
7
+ * The version of the OpenAPI document: 0.6.6
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -23,112 +23,46 @@ import type { RequestArgs } from './base';
23
23
  // @ts-ignore
24
24
  import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
25
25
 
26
- /**
27
- *
28
- * @export
29
- * @interface ApiError
30
- */
31
26
  export interface ApiError {
32
- /**
33
- *
34
- * @type {string}
35
- * @memberof ApiError
36
- */
37
27
  'code'?: string;
38
- /**
39
- *
40
- * @type {string}
41
- * @memberof ApiError
42
- */
43
28
  'message': string;
44
29
  }
45
- /**
46
- *
47
- * @export
48
- * @interface AssignGtinRequest
49
- */
50
30
  export interface AssignGtinRequest {
51
31
  /**
52
32
  * A reference to the resource location
53
- * @type {string}
54
- * @memberof AssignGtinRequest
55
33
  */
56
34
  'variantRef': string;
57
35
  }
58
- /**
59
- *
60
- * @export
61
- * @interface GTIN
62
- */
63
36
  export interface GTIN {
64
37
  /**
65
38
  * The GTIN
66
- * @type {string}
67
- * @memberof GTIN
68
39
  */
69
40
  'number': string;
70
41
  /**
71
42
  * A reference to the resource location
72
- * @type {string}
73
- * @memberof GTIN
74
43
  */
75
44
  'variantRef': string;
76
- /**
77
- *
78
- * @type {Array<GTINVariantsInner>}
79
- * @memberof GTIN
80
- */
81
45
  'variants': Array<GTINVariantsInner>;
82
46
  }
83
- /**
84
- *
85
- * @export
86
- * @interface GTINVariantsInner
87
- */
88
47
  export interface GTINVariantsInner {
89
48
  /**
90
49
  * A reference to the resource location
91
- * @type {string}
92
- * @memberof GTINVariantsInner
93
50
  */
94
51
  'ref': string;
95
52
  }
96
- /**
97
- *
98
- * @export
99
- * @interface GTINsResponse
100
- */
101
53
  export interface GTINsResponse {
102
- /**
103
- *
104
- * @type {Array<GTIN>}
105
- * @memberof GTINsResponse
106
- */
107
54
  'gtins'?: Array<GTIN>;
108
- /**
109
- *
110
- * @type {number}
111
- * @memberof GTINsResponse
112
- */
113
55
  'nextPageToken'?: number | null;
114
56
  }
115
- /**
116
- *
117
- * @export
118
- * @interface InlineObject
119
- */
120
- export interface InlineObject {
57
+ export interface ImportGtins202Response {
121
58
  /**
122
59
  * Id of the GTINs import
123
- * @type {string}
124
- * @memberof InlineObject
125
60
  */
126
61
  'importId'?: string;
127
62
  }
128
63
 
129
64
  /**
130
65
  * GTINsApi - axios parameter creator
131
- * @export
132
66
  */
133
67
  export const GTINsApiAxiosParamCreator = function (configuration?: Configuration) {
134
68
  return {
@@ -441,7 +375,6 @@ export const GTINsApiAxiosParamCreator = function (configuration?: Configuration
441
375
 
442
376
  /**
443
377
  * GTINsApi - functional programming interface
444
- * @export
445
378
  */
446
379
  export const GTINsApiFp = function(configuration?: Configuration) {
447
380
  const localVarAxiosParamCreator = GTINsApiAxiosParamCreator(configuration)
@@ -497,7 +430,7 @@ export const GTINsApiFp = function(configuration?: Configuration) {
497
430
  * @param {*} [options] Override http request option.
498
431
  * @throws {RequiredError}
499
432
  */
500
- async importGtins(project: string, body?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject>> {
433
+ async importGtins(project: string, body?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportGtins202Response>> {
501
434
  const localVarAxiosArgs = await localVarAxiosParamCreator.importGtins(project, body, options);
502
435
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
503
436
  const localVarOperationServerBasePath = operationServerMap['GTINsApi.importGtins']?.[localVarOperationServerIndex]?.url;
@@ -538,7 +471,6 @@ export const GTINsApiFp = function(configuration?: Configuration) {
538
471
 
539
472
  /**
540
473
  * GTINsApi - factory interface
541
- * @export
542
474
  */
543
475
  export const GTINsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
544
476
  const localVarFp = GTINsApiFp(configuration)
@@ -580,7 +512,7 @@ export const GTINsApiFactory = function (configuration?: Configuration, basePath
580
512
  * @param {*} [options] Override http request option.
581
513
  * @throws {RequiredError}
582
514
  */
583
- importGtins(requestParameters: GTINsApiImportGtinsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject> {
515
+ importGtins(requestParameters: GTINsApiImportGtinsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ImportGtins202Response> {
584
516
  return localVarFp.importGtins(requestParameters.project, requestParameters.body, options).then((request) => request(axios, basePath));
585
517
  },
586
518
  /**
@@ -608,156 +540,111 @@ export const GTINsApiFactory = function (configuration?: Configuration, basePath
608
540
 
609
541
  /**
610
542
  * Request parameters for assignGtin operation in GTINsApi.
611
- * @export
612
- * @interface GTINsApiAssignGtinRequest
613
543
  */
614
544
  export interface GTINsApiAssignGtinRequest {
615
545
  /**
616
546
  * What project it is
617
- * @type {string}
618
- * @memberof GTINsApiAssignGtin
619
547
  */
620
548
  readonly project: string
621
549
 
622
550
  /**
623
551
  * GTIN
624
- * @type {string}
625
- * @memberof GTINsApiAssignGtin
626
552
  */
627
553
  readonly gtin: string
628
554
 
629
555
  /**
630
556
  * Assign a GTIN to a variant
631
- * @type {AssignGtinRequest}
632
- * @memberof GTINsApiAssignGtin
633
557
  */
634
558
  readonly assignGtinRequest?: AssignGtinRequest
635
559
  }
636
560
 
637
561
  /**
638
562
  * Request parameters for exportGtins operation in GTINsApi.
639
- * @export
640
- * @interface GTINsApiExportGtinsRequest
641
563
  */
642
564
  export interface GTINsApiExportGtinsRequest {
643
565
  /**
644
566
  * What project it is
645
- * @type {string}
646
- * @memberof GTINsApiExportGtins
647
567
  */
648
568
  readonly project: string
649
569
 
650
570
  /**
651
571
  * GTINs
652
- * @type {string}
653
- * @memberof GTINsApiExportGtins
654
572
  */
655
573
  readonly gtins?: string
656
574
  }
657
575
 
658
576
  /**
659
577
  * Request parameters for getGtin operation in GTINsApi.
660
- * @export
661
- * @interface GTINsApiGetGtinRequest
662
578
  */
663
579
  export interface GTINsApiGetGtinRequest {
664
580
  /**
665
581
  * What project it is
666
- * @type {string}
667
- * @memberof GTINsApiGetGtin
668
582
  */
669
583
  readonly project: string
670
584
 
671
585
  /**
672
586
  * GTIN
673
- * @type {string}
674
- * @memberof GTINsApiGetGtin
675
587
  */
676
588
  readonly gtin: string
677
589
  }
678
590
 
679
591
  /**
680
592
  * Request parameters for importGtins operation in GTINsApi.
681
- * @export
682
- * @interface GTINsApiImportGtinsRequest
683
593
  */
684
594
  export interface GTINsApiImportGtinsRequest {
685
595
  /**
686
596
  * What project it is
687
- * @type {string}
688
- * @memberof GTINsApiImportGtins
689
597
  */
690
598
  readonly project: string
691
599
 
692
600
  /**
693
601
  * A base64 data URL of a CSV file containing GTINs
694
- * @type {string}
695
- * @memberof GTINsApiImportGtins
696
602
  */
697
603
  readonly body?: string
698
604
  }
699
605
 
700
606
  /**
701
607
  * Request parameters for listGtins operation in GTINsApi.
702
- * @export
703
- * @interface GTINsApiListGtinsRequest
704
608
  */
705
609
  export interface GTINsApiListGtinsRequest {
706
610
  /**
707
611
  * What project it is
708
- * @type {string}
709
- * @memberof GTINsApiListGtins
710
612
  */
711
613
  readonly project: string
712
614
 
713
615
  /**
714
616
  * Max page size. This is the maximum page size that will be returned, but it might be smaller.
715
- * @type {number}
716
- * @memberof GTINsApiListGtins
717
617
  */
718
618
  readonly pageSize?: number
719
619
 
720
620
  /**
721
621
  * Page reference token
722
- * @type {number}
723
- * @memberof GTINsApiListGtins
724
622
  */
725
623
  readonly pageToken?: number
726
624
 
727
625
  /**
728
626
  * Search term to filter based on GTIN based on the GTIN
729
- * @type {string}
730
- * @memberof GTINsApiListGtins
731
627
  */
732
628
  readonly search?: string
733
629
  }
734
630
 
735
631
  /**
736
632
  * Request parameters for unassignGtin operation in GTINsApi.
737
- * @export
738
- * @interface GTINsApiUnassignGtinRequest
739
633
  */
740
634
  export interface GTINsApiUnassignGtinRequest {
741
635
  /**
742
636
  * What project it is
743
- * @type {string}
744
- * @memberof GTINsApiUnassignGtin
745
637
  */
746
638
  readonly project: string
747
639
 
748
640
  /**
749
641
  * GTIN
750
- * @type {string}
751
- * @memberof GTINsApiUnassignGtin
752
642
  */
753
643
  readonly gtin: string
754
644
  }
755
645
 
756
646
  /**
757
647
  * GTINsApi - object-oriented interface
758
- * @export
759
- * @class GTINsApi
760
- * @extends {BaseAPI}
761
648
  */
762
649
  export class GTINsApi extends BaseAPI {
763
650
  /**
@@ -766,7 +653,6 @@ export class GTINsApi extends BaseAPI {
766
653
  * @param {GTINsApiAssignGtinRequest} requestParameters Request parameters.
767
654
  * @param {*} [options] Override http request option.
768
655
  * @throws {RequiredError}
769
- * @memberof GTINsApi
770
656
  */
771
657
  public assignGtin(requestParameters: GTINsApiAssignGtinRequest, options?: RawAxiosRequestConfig) {
772
658
  return GTINsApiFp(this.configuration).assignGtin(requestParameters.project, requestParameters.gtin, requestParameters.assignGtinRequest, options).then((request) => request(this.axios, this.basePath));
@@ -778,7 +664,6 @@ export class GTINsApi extends BaseAPI {
778
664
  * @param {GTINsApiExportGtinsRequest} requestParameters Request parameters.
779
665
  * @param {*} [options] Override http request option.
780
666
  * @throws {RequiredError}
781
- * @memberof GTINsApi
782
667
  */
783
668
  public exportGtins(requestParameters: GTINsApiExportGtinsRequest, options?: RawAxiosRequestConfig) {
784
669
  return GTINsApiFp(this.configuration).exportGtins(requestParameters.project, requestParameters.gtins, options).then((request) => request(this.axios, this.basePath));
@@ -790,7 +675,6 @@ export class GTINsApi extends BaseAPI {
790
675
  * @param {GTINsApiGetGtinRequest} requestParameters Request parameters.
791
676
  * @param {*} [options] Override http request option.
792
677
  * @throws {RequiredError}
793
- * @memberof GTINsApi
794
678
  */
795
679
  public getGtin(requestParameters: GTINsApiGetGtinRequest, options?: RawAxiosRequestConfig) {
796
680
  return GTINsApiFp(this.configuration).getGtin(requestParameters.project, requestParameters.gtin, options).then((request) => request(this.axios, this.basePath));
@@ -802,7 +686,6 @@ export class GTINsApi extends BaseAPI {
802
686
  * @param {GTINsApiImportGtinsRequest} requestParameters Request parameters.
803
687
  * @param {*} [options] Override http request option.
804
688
  * @throws {RequiredError}
805
- * @memberof GTINsApi
806
689
  */
807
690
  public importGtins(requestParameters: GTINsApiImportGtinsRequest, options?: RawAxiosRequestConfig) {
808
691
  return GTINsApiFp(this.configuration).importGtins(requestParameters.project, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
@@ -814,7 +697,6 @@ export class GTINsApi extends BaseAPI {
814
697
  * @param {GTINsApiListGtinsRequest} requestParameters Request parameters.
815
698
  * @param {*} [options] Override http request option.
816
699
  * @throws {RequiredError}
817
- * @memberof GTINsApi
818
700
  */
819
701
  public listGtins(requestParameters: GTINsApiListGtinsRequest, options?: RawAxiosRequestConfig) {
820
702
  return GTINsApiFp(this.configuration).listGtins(requestParameters.project, requestParameters.pageSize, requestParameters.pageToken, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
@@ -826,7 +708,6 @@ export class GTINsApi extends BaseAPI {
826
708
  * @param {GTINsApiUnassignGtinRequest} requestParameters Request parameters.
827
709
  * @param {*} [options] Override http request option.
828
710
  * @throws {RequiredError}
829
- * @memberof GTINsApi
830
711
  */
831
712
  public unassignGtin(requestParameters: GTINsApiUnassignGtinRequest, options?: RawAxiosRequestConfig) {
832
713
  return GTINsApiFp(this.configuration).unassignGtin(requestParameters.project, requestParameters.gtin, options).then((request) => request(this.axios, this.basePath));
package/base.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.4
7
+ * The version of the OpenAPI document: 0.6.6
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -21,10 +21,6 @@ import globalAxios from 'axios';
21
21
 
22
22
  export const BASE_PATH = "https://api.podos.io".replace(/\/+$/, "");
23
23
 
24
- /**
25
- *
26
- * @export
27
- */
28
24
  export const COLLECTION_FORMATS = {
29
25
  csv: ",",
30
26
  ssv: " ",
@@ -32,21 +28,11 @@ export const COLLECTION_FORMATS = {
32
28
  pipes: "|",
33
29
  };
34
30
 
35
- /**
36
- *
37
- * @export
38
- * @interface RequestArgs
39
- */
40
31
  export interface RequestArgs {
41
32
  url: string;
42
33
  options: RawAxiosRequestConfig;
43
34
  }
44
35
 
45
- /**
46
- *
47
- * @export
48
- * @class BaseAPI
49
- */
50
36
  export class BaseAPI {
51
37
  protected configuration: Configuration | undefined;
52
38
 
@@ -58,12 +44,6 @@ export class BaseAPI {
58
44
  }
59
45
  };
60
46
 
61
- /**
62
- *
63
- * @export
64
- * @class RequiredError
65
- * @extends {Error}
66
- */
67
47
  export class RequiredError extends Error {
68
48
  constructor(public field: string, msg?: string) {
69
49
  super(msg);
@@ -78,9 +58,5 @@ interface ServerMap {
78
58
  }[];
79
59
  }
80
60
 
81
- /**
82
- *
83
- * @export
84
- */
85
61
  export const operationServerMap: ServerMap = {
86
62
  }
package/common.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.4
7
+ * The version of the OpenAPI document: 0.6.6
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,7 +12,6 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
 
15
-
16
15
  import type { Configuration } from "./configuration";
17
16
  import type { RequestArgs } from "./base";
18
17
  import type { AxiosInstance, AxiosResponse } from 'axios';
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.4
7
+ * The version of the OpenAPI document: 0.6.6
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -28,49 +28,32 @@ export class Configuration {
28
28
  /**
29
29
  * parameter for apiKey security
30
30
  * @param name security name
31
- * @memberof Configuration
32
31
  */
33
32
  apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
34
33
  /**
35
34
  * parameter for basic security
36
- *
37
- * @type {string}
38
- * @memberof Configuration
39
35
  */
40
36
  username?: string;
41
37
  /**
42
38
  * parameter for basic security
43
- *
44
- * @type {string}
45
- * @memberof Configuration
46
39
  */
47
40
  password?: string;
48
41
  /**
49
42
  * parameter for oauth2 security
50
43
  * @param name security name
51
44
  * @param scopes oauth2 scope
52
- * @memberof Configuration
53
45
  */
54
46
  accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
55
47
  /**
56
48
  * override base path
57
- *
58
- * @type {string}
59
- * @memberof Configuration
60
49
  */
61
50
  basePath?: string;
62
51
  /**
63
52
  * override server index
64
- *
65
- * @type {number}
66
- * @memberof Configuration
67
53
  */
68
54
  serverIndex?: number;
69
55
  /**
70
56
  * base options for axios calls
71
- *
72
- * @type {any}
73
- * @memberof Configuration
74
57
  */
75
58
  baseOptions?: any;
76
59
  /**