@teemill/blog 0.3.1 → 0.3.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 CHANGED
@@ -1,4 +1,4 @@
1
- ## @teemill/blog@0.3.1
1
+ ## @teemill/blog@0.3.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/blog@0.3.1 --save
39
+ npm install @teemill/blog@0.3.3 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
package/api.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Blog API
5
5
  * Read and write blogs on the PodOS platform.
6
6
  *
7
- * The version of the OpenAPI document: 0.3.1
7
+ * The version of the OpenAPI document: 0.3.3
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -23,173 +23,41 @@ 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 Blog
49
- */
50
30
  export interface Blog {
51
- /**
52
- *
53
- * @type {string}
54
- * @memberof Blog
55
- */
56
31
  'id': string;
57
- /**
58
- *
59
- * @type {string}
60
- * @memberof Blog
61
- */
62
32
  'title': string;
63
- /**
64
- *
65
- * @type {string}
66
- * @memberof Blog
67
- */
68
33
  'slug': string;
69
- /**
70
- *
71
- * @type {string}
72
- * @memberof Blog
73
- */
74
34
  'description': string;
75
- /**
76
- *
77
- * @type {Array<string>}
78
- * @memberof Blog
79
- */
80
35
  'tags'?: Array<string>;
81
- /**
82
- *
83
- * @type {string}
84
- * @memberof Blog
85
- */
86
36
  'metaImage': string | null;
87
- /**
88
- *
89
- * @type {BlogListingType}
90
- * @memberof Blog
91
- */
92
37
  'type': BlogListingType;
93
- /**
94
- *
95
- * @type {string}
96
- * @memberof Blog
97
- */
98
38
  'publishedAt': string | null;
99
- /**
100
- *
101
- * @type {string}
102
- * @memberof Blog
103
- */
104
39
  'createdAt': string;
105
- /**
106
- *
107
- * @type {string}
108
- * @memberof Blog
109
- */
110
40
  'updatedAt': string;
111
- /**
112
- *
113
- * @type {string}
114
- * @memberof Blog
115
- */
116
41
  'content': string;
117
42
  }
118
43
 
119
44
 
120
- /**
121
- *
122
- * @export
123
- * @interface BlogListing
124
- */
125
45
  export interface BlogListing {
126
- /**
127
- *
128
- * @type {string}
129
- * @memberof BlogListing
130
- */
131
46
  'id': string;
132
- /**
133
- *
134
- * @type {string}
135
- * @memberof BlogListing
136
- */
137
47
  'title': string;
138
- /**
139
- *
140
- * @type {string}
141
- * @memberof BlogListing
142
- */
143
48
  'slug': string;
144
- /**
145
- *
146
- * @type {string}
147
- * @memberof BlogListing
148
- */
149
49
  'description': string;
150
- /**
151
- *
152
- * @type {Array<string>}
153
- * @memberof BlogListing
154
- */
155
50
  'tags'?: Array<string>;
156
- /**
157
- *
158
- * @type {string}
159
- * @memberof BlogListing
160
- */
161
51
  'metaImage': string | null;
162
- /**
163
- *
164
- * @type {BlogListingType}
165
- * @memberof BlogListing
166
- */
167
52
  'type': BlogListingType;
168
- /**
169
- *
170
- * @type {string}
171
- * @memberof BlogListing
172
- */
173
53
  'publishedAt': string | null;
174
- /**
175
- *
176
- * @type {string}
177
- * @memberof BlogListing
178
- */
179
54
  'createdAt': string;
180
- /**
181
- *
182
- * @type {string}
183
- * @memberof BlogListing
184
- */
185
55
  'updatedAt': string;
186
56
  }
187
57
 
188
58
 
189
59
  /**
190
60
  * The type of blog. Project blogs are only visible to the project. Platform blogs are visible to all clients of the platform. Requires the Platform module to be installed. Parent platform blogs are published by the parent platform of the current project.
191
- * @export
192
- * @enum {string}
193
61
  */
194
62
 
195
63
  export const BlogListingType = {
@@ -201,58 +69,16 @@ export const BlogListingType = {
201
69
  export type BlogListingType = typeof BlogListingType[keyof typeof BlogListingType];
202
70
 
203
71
 
204
- /**
205
- *
206
- * @export
207
- * @interface CreateBlogRequest
208
- */
209
72
  export interface CreateBlogRequest {
210
- /**
211
- *
212
- * @type {string}
213
- * @memberof CreateBlogRequest
214
- */
215
73
  'title': string;
216
- /**
217
- *
218
- * @type {string}
219
- * @memberof CreateBlogRequest
220
- */
221
74
  'content': string;
222
- /**
223
- *
224
- * @type {string}
225
- * @memberof CreateBlogRequest
226
- */
227
75
  'slug': string;
228
- /**
229
- *
230
- * @type {string}
231
- * @memberof CreateBlogRequest
232
- */
233
76
  'description': string;
234
- /**
235
- *
236
- * @type {Array<string>}
237
- * @memberof CreateBlogRequest
238
- */
239
77
  'tags'?: Array<string>;
240
- /**
241
- *
242
- * @type {string}
243
- * @memberof CreateBlogRequest
244
- */
245
78
  'metaImage': string;
246
- /**
247
- *
248
- * @type {boolean}
249
- * @memberof CreateBlogRequest
250
- */
251
79
  'published'?: boolean;
252
80
  /**
253
81
  * The type of blog. Project blogs are only visible to the project. Platform blogs are visible to all clients of the project\'s platform. Requires the Platform module to be installed.
254
- * @type {string}
255
- * @memberof CreateBlogRequest
256
82
  */
257
83
  'type': CreateBlogRequestTypeEnum;
258
84
  }
@@ -264,72 +90,21 @@ export const CreateBlogRequestTypeEnum = {
264
90
 
265
91
  export type CreateBlogRequestTypeEnum = typeof CreateBlogRequestTypeEnum[keyof typeof CreateBlogRequestTypeEnum];
266
92
 
267
- /**
268
- *
269
- * @export
270
- * @interface ListBlogsResponse
271
- */
272
93
  export interface ListBlogsResponse {
273
- /**
274
- *
275
- * @type {Array<BlogListing>}
276
- * @memberof ListBlogsResponse
277
- */
278
94
  'blogs': Array<BlogListing>;
279
95
  }
280
- /**
281
- *
282
- * @export
283
- * @interface UpdateBlogRequest
284
- */
285
96
  export interface UpdateBlogRequest {
286
- /**
287
- *
288
- * @type {string}
289
- * @memberof UpdateBlogRequest
290
- */
291
97
  'title'?: string;
292
- /**
293
- *
294
- * @type {string}
295
- * @memberof UpdateBlogRequest
296
- */
297
98
  'content'?: string;
298
- /**
299
- *
300
- * @type {string}
301
- * @memberof UpdateBlogRequest
302
- */
303
99
  'slug'?: string;
304
- /**
305
- *
306
- * @type {string}
307
- * @memberof UpdateBlogRequest
308
- */
309
100
  'description'?: string;
310
- /**
311
- *
312
- * @type {Array<string>}
313
- * @memberof UpdateBlogRequest
314
- */
315
101
  'tags'?: Array<string>;
316
- /**
317
- *
318
- * @type {string}
319
- * @memberof UpdateBlogRequest
320
- */
321
102
  'metaImage'?: string;
322
- /**
323
- *
324
- * @type {boolean}
325
- * @memberof UpdateBlogRequest
326
- */
327
103
  'published'?: boolean;
328
104
  }
329
105
 
330
106
  /**
331
107
  * BlogApi - axios parameter creator
332
- * @export
333
108
  */
334
109
  export const BlogApiAxiosParamCreator = function (configuration?: Configuration) {
335
110
  return {
@@ -602,7 +377,6 @@ export const BlogApiAxiosParamCreator = function (configuration?: Configuration)
602
377
 
603
378
  /**
604
379
  * BlogApi - functional programming interface
605
- * @export
606
380
  */
607
381
  export const BlogApiFp = function(configuration?: Configuration) {
608
382
  const localVarAxiosParamCreator = BlogApiAxiosParamCreator(configuration)
@@ -686,7 +460,6 @@ export const BlogApiFp = function(configuration?: Configuration) {
686
460
 
687
461
  /**
688
462
  * BlogApi - factory interface
689
- * @export
690
463
  */
691
464
  export const BlogApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
692
465
  const localVarFp = BlogApiFp(configuration)
@@ -746,142 +519,71 @@ export const BlogApiFactory = function (configuration?: Configuration, basePath?
746
519
 
747
520
  /**
748
521
  * Request parameters for createBlog operation in BlogApi.
749
- * @export
750
- * @interface BlogApiCreateBlogRequest
751
522
  */
752
523
  export interface BlogApiCreateBlogRequest {
753
- /**
754
- *
755
- * @type {string}
756
- * @memberof BlogApiCreateBlog
757
- */
758
524
  readonly project: string
759
525
 
760
- /**
761
- *
762
- * @type {CreateBlogRequest}
763
- * @memberof BlogApiCreateBlog
764
- */
765
526
  readonly createBlogRequest: CreateBlogRequest
766
527
  }
767
528
 
768
529
  /**
769
530
  * Request parameters for deleteBlog operation in BlogApi.
770
- * @export
771
- * @interface BlogApiDeleteBlogRequest
772
531
  */
773
532
  export interface BlogApiDeleteBlogRequest {
774
- /**
775
- *
776
- * @type {string}
777
- * @memberof BlogApiDeleteBlog
778
- */
779
533
  readonly project: string
780
534
 
781
- /**
782
- *
783
- * @type {string}
784
- * @memberof BlogApiDeleteBlog
785
- */
786
535
  readonly blogId: string
787
536
  }
788
537
 
789
538
  /**
790
539
  * Request parameters for getBlog operation in BlogApi.
791
- * @export
792
- * @interface BlogApiGetBlogRequest
793
540
  */
794
541
  export interface BlogApiGetBlogRequest {
795
- /**
796
- *
797
- * @type {string}
798
- * @memberof BlogApiGetBlog
799
- */
800
542
  readonly project: string
801
543
 
802
- /**
803
- *
804
- * @type {string}
805
- * @memberof BlogApiGetBlog
806
- */
807
544
  readonly blogId: string
808
545
  }
809
546
 
810
547
  /**
811
548
  * Request parameters for listBlogs operation in BlogApi.
812
- * @export
813
- * @interface BlogApiListBlogsRequest
814
549
  */
815
550
  export interface BlogApiListBlogsRequest {
816
- /**
817
- *
818
- * @type {string}
819
- * @memberof BlogApiListBlogs
820
- */
821
551
  readonly project: string
822
552
 
823
553
  /**
824
554
  * Max page size. This is the maximum page size that will be returned, but it might be smaller.
825
- * @type {number}
826
- * @memberof BlogApiListBlogs
827
555
  */
828
556
  readonly pageSize?: number
829
557
 
830
558
  /**
831
559
  * Page reference token
832
- * @type {number}
833
- * @memberof BlogApiListBlogs
834
560
  */
835
561
  readonly pageToken?: number
836
562
 
837
563
  /**
838
564
  * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
839
- * @type {Array<string>}
840
- * @memberof BlogApiListBlogs
841
565
  */
842
566
  readonly sortBy?: Array<string>
843
567
 
844
568
  /**
845
569
  * Search term to filter results
846
- * @type {string}
847
- * @memberof BlogApiListBlogs
848
570
  */
849
571
  readonly search?: string
850
572
  }
851
573
 
852
574
  /**
853
575
  * Request parameters for updateBlog operation in BlogApi.
854
- * @export
855
- * @interface BlogApiUpdateBlogRequest
856
576
  */
857
577
  export interface BlogApiUpdateBlogRequest {
858
- /**
859
- *
860
- * @type {string}
861
- * @memberof BlogApiUpdateBlog
862
- */
863
578
  readonly project: string
864
579
 
865
- /**
866
- *
867
- * @type {string}
868
- * @memberof BlogApiUpdateBlog
869
- */
870
580
  readonly blogId: string
871
581
 
872
- /**
873
- *
874
- * @type {UpdateBlogRequest}
875
- * @memberof BlogApiUpdateBlog
876
- */
877
582
  readonly updateBlogRequest: UpdateBlogRequest
878
583
  }
879
584
 
880
585
  /**
881
586
  * BlogApi - object-oriented interface
882
- * @export
883
- * @class BlogApi
884
- * @extends {BaseAPI}
885
587
  */
886
588
  export class BlogApi extends BaseAPI {
887
589
  /**
@@ -890,7 +592,6 @@ export class BlogApi extends BaseAPI {
890
592
  * @param {BlogApiCreateBlogRequest} requestParameters Request parameters.
891
593
  * @param {*} [options] Override http request option.
892
594
  * @throws {RequiredError}
893
- * @memberof BlogApi
894
595
  */
895
596
  public createBlog(requestParameters: BlogApiCreateBlogRequest, options?: RawAxiosRequestConfig) {
896
597
  return BlogApiFp(this.configuration).createBlog(requestParameters.project, requestParameters.createBlogRequest, options).then((request) => request(this.axios, this.basePath));
@@ -902,7 +603,6 @@ export class BlogApi extends BaseAPI {
902
603
  * @param {BlogApiDeleteBlogRequest} requestParameters Request parameters.
903
604
  * @param {*} [options] Override http request option.
904
605
  * @throws {RequiredError}
905
- * @memberof BlogApi
906
606
  */
907
607
  public deleteBlog(requestParameters: BlogApiDeleteBlogRequest, options?: RawAxiosRequestConfig) {
908
608
  return BlogApiFp(this.configuration).deleteBlog(requestParameters.project, requestParameters.blogId, options).then((request) => request(this.axios, this.basePath));
@@ -914,7 +614,6 @@ export class BlogApi extends BaseAPI {
914
614
  * @param {BlogApiGetBlogRequest} requestParameters Request parameters.
915
615
  * @param {*} [options] Override http request option.
916
616
  * @throws {RequiredError}
917
- * @memberof BlogApi
918
617
  */
919
618
  public getBlog(requestParameters: BlogApiGetBlogRequest, options?: RawAxiosRequestConfig) {
920
619
  return BlogApiFp(this.configuration).getBlog(requestParameters.project, requestParameters.blogId, options).then((request) => request(this.axios, this.basePath));
@@ -926,7 +625,6 @@ export class BlogApi extends BaseAPI {
926
625
  * @param {BlogApiListBlogsRequest} requestParameters Request parameters.
927
626
  * @param {*} [options] Override http request option.
928
627
  * @throws {RequiredError}
929
- * @memberof BlogApi
930
628
  */
931
629
  public listBlogs(requestParameters: BlogApiListBlogsRequest, options?: RawAxiosRequestConfig) {
932
630
  return BlogApiFp(this.configuration).listBlogs(requestParameters.project, requestParameters.pageSize, requestParameters.pageToken, requestParameters.sortBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
@@ -938,7 +636,6 @@ export class BlogApi extends BaseAPI {
938
636
  * @param {BlogApiUpdateBlogRequest} requestParameters Request parameters.
939
637
  * @param {*} [options] Override http request option.
940
638
  * @throws {RequiredError}
941
- * @memberof BlogApi
942
639
  */
943
640
  public updateBlog(requestParameters: BlogApiUpdateBlogRequest, options?: RawAxiosRequestConfig) {
944
641
  return BlogApiFp(this.configuration).updateBlog(requestParameters.project, requestParameters.blogId, requestParameters.updateBlogRequest, options).then((request) => request(this.axios, this.basePath));
package/base.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Blog API
5
5
  * Read and write blogs on the PodOS platform.
6
6
  *
7
- * The version of the OpenAPI document: 0.3.1
7
+ * The version of the OpenAPI document: 0.3.3
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://localhost:8080".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
  * Blog API
5
5
  * Read and write blogs on the PodOS platform.
6
6
  *
7
- * The version of the OpenAPI document: 0.3.1
7
+ * The version of the OpenAPI document: 0.3.3
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
  * Blog API
5
5
  * Read and write blogs on the PodOS platform.
6
6
  *
7
- * The version of the OpenAPI document: 0.3.1
7
+ * The version of the OpenAPI document: 0.3.3
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
  /**