@product-live/api-sdk 2.22.0 → 2.23.0

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.
Files changed (40) hide show
  1. package/README.md +79 -3
  2. package/dist/models/CreateJobExecutionDto.d.ts +1 -1
  3. package/dist/models/JobExecutionDto.d.ts +1 -1
  4. package/models/CreateJobDto.ts +1 -1
  5. package/models/CreateJobExecutionDto.ts +2 -2
  6. package/models/CreateTaskDto.ts +1 -1
  7. package/models/CreateVariableDto.ts +1 -1
  8. package/models/FileDto.ts +1 -1
  9. package/models/FindVariablesRequest.ts +1 -1
  10. package/models/GetFiles200Response.ts +1 -1
  11. package/models/GetItems200Response.ts +1 -1
  12. package/models/GetJobExecutionById400Response.ts +1 -1
  13. package/models/GetJobExecutions200Response.ts +1 -1
  14. package/models/GetJobs200Response.ts +1 -1
  15. package/models/GetTasks200Response.ts +1 -1
  16. package/models/GetVariables200Response.ts +1 -1
  17. package/models/HighOrderQuery.ts +1 -1
  18. package/models/ItemDto.ts +1 -1
  19. package/models/ItemFieldDTO.ts +1 -1
  20. package/models/ItemFieldFile.ts +1 -1
  21. package/models/ItemFieldFileData.ts +1 -1
  22. package/models/ItemFieldMultipleSelectWithCommentAndQuantity.ts +1 -1
  23. package/models/ItemFieldMultipleSelectWithCommentAndQuantityData.ts +1 -1
  24. package/models/ItemFieldSimpleNumber.ts +1 -1
  25. package/models/ItemFieldSimpleString.ts +1 -1
  26. package/models/ItemFieldSimpleStringArray.ts +1 -1
  27. package/models/ItemMetadataDTO.ts +1 -1
  28. package/models/JobDto.ts +1 -1
  29. package/models/JobExecutionDto.ts +2 -2
  30. package/models/LowOrderQuery.ts +1 -1
  31. package/models/LowOrderQueryValue.ts +1 -1
  32. package/models/PatchTaskExecutionDto.ts +1 -1
  33. package/models/Query1.ts +1 -1
  34. package/models/TaskDto.ts +1 -1
  35. package/models/TaskExecutionDto.ts +1 -1
  36. package/models/UpdateJobDto.ts +1 -1
  37. package/models/UpdateTaskDto.ts +1 -1
  38. package/models/UpdateVariableDto.ts +1 -1
  39. package/models/VariableDto.ts +1 -1
  40. package/package.json +9 -5
package/README.md CHANGED
@@ -1,4 +1,80 @@
1
- This package was generated by the [OpenAPI Generator](https://openapi-generator.tech) project using the [typescript](https://openapi-generator.tech/docs/generators/typescript) client generator and the OpenAPI [Product-Live API](https://api.product-live.com/-json) document.
1
+ ## @
2
2
 
3
- - Swagger documentation: [api.product-live.com](https://api.product-live.com/)
4
- - Product-Live documentation: [learn.product-live.com](https://learn.product-live.com/)
3
+ This generator creates TypeScript/JavaScript client that utilizes fetch-api.
4
+
5
+ ### Building
6
+
7
+ To build and compile the typescript sources to javascript use:
8
+ ```
9
+ npm install
10
+ npm run build
11
+ ```
12
+
13
+ ### Publishing
14
+
15
+ First build the package then run ```npm publish```
16
+
17
+ ### Consuming
18
+
19
+ Navigate to the folder of your consuming project and run one of the following commands.
20
+
21
+ _published:_
22
+
23
+ ```
24
+ npm install @ --save
25
+ ```
26
+
27
+ _unPublished (not recommended):_
28
+
29
+ ```
30
+ npm install PATH_TO_GENERATED_PACKAGE --save
31
+ ```
32
+
33
+ ### Usage
34
+
35
+ Below code snippet shows exemplary usage of the configuration and the API based
36
+ on the typical `PetStore` example used for OpenAPI.
37
+
38
+ ```
39
+ import * as your_api from 'your_api_package'
40
+
41
+ // Covers all auth methods included in your OpenAPI yaml definition
42
+ const authConfig: your_api.AuthMethodsConfiguration = {
43
+ "api_key": "YOUR_API_KEY"
44
+ }
45
+
46
+ // Implements a simple middleware to modify requests before (`pre`) they are sent
47
+ // and after (`post`) they have been received
48
+ class Test implements your_api.Middleware {
49
+ pre(context: your_api.RequestContext): Promise<your_api.RequestContext> {
50
+ // Modify context here and return
51
+ return Promise.resolve(context);
52
+ }
53
+
54
+ post(context: your_api.ResponseContext): Promise<your_api.ResponseContext> {
55
+ return Promise.resolve(context);
56
+ }
57
+
58
+ }
59
+
60
+ // Create configuration parameter object
61
+ const configurationParameters = {
62
+ httpApi: new your_api.JQueryHttpLibrary(), // Can also be ignored - default is usually fine
63
+ baseServer: your_api.servers[0], // First server is default
64
+ authMethods: authConfig, // No auth is default
65
+ promiseMiddleware: [new Test()],
66
+ }
67
+
68
+ // Convert to actual configuration
69
+ const config = your_api.createConfiguration(configurationParameters);
70
+
71
+ // Use configuration with your_api
72
+ const api = new your_api.PetApi(config);
73
+ your_api.Pet p = new your_api.Pet();
74
+ p.name = "My new pet";
75
+ p.photoUrls = [];
76
+ p.tags = [];
77
+ p.status = "available";
78
+ Promise<your_api.Pet> createdPet = api.addPet(p);
79
+
80
+ ```
@@ -1,6 +1,6 @@
1
1
  export declare class CreateJobExecutionDto {
2
2
  'jobId': string;
3
- 'info': any;
3
+ 'info'?: any;
4
4
  'input'?: {
5
5
  [key: string]: any;
6
6
  };
@@ -1,6 +1,6 @@
1
1
  export declare class JobExecutionDto {
2
2
  'jobId': string;
3
- 'info': any;
3
+ 'info'?: any;
4
4
  'input'?: {
5
5
  [key: string]: any;
6
6
  };
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -14,7 +14,7 @@ import { HttpFile } from '../http/http';
14
14
 
15
15
  export class CreateJobExecutionDto {
16
16
  'jobId': string;
17
- 'info': any;
17
+ 'info'?: any;
18
18
  'input'?: { [key: string]: any; };
19
19
 
20
20
  static readonly discriminator: string | undefined = undefined;
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/models/FileDto.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/models/ItemDto.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/models/JobDto.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -14,7 +14,7 @@ import { HttpFile } from '../http/http';
14
14
 
15
15
  export class JobExecutionDto {
16
16
  'jobId': string;
17
- 'info': any;
17
+ 'info'?: any;
18
18
  'input'?: { [key: string]: any; };
19
19
  'id': string;
20
20
  'object': JobExecutionDtoObjectEnum;
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/models/Query1.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/models/TaskDto.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product-Live API
3
3
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
4
  *
5
- * OpenAPI spec version: 2.22.0
5
+ * OpenAPI spec version: 2.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,15 +1,19 @@
1
1
  {
2
2
  "name": "@product-live/api-sdk",
3
- "version": "2.22.0",
4
- "description": "OpenAPI client for Product-Live API",
5
- "author": "product-live",
3
+ "version": "2.23.0",
4
+ "description": "OpenAPI client for ",
5
+ "author": "OpenAPI-Generator Contributors",
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
9
+ },
6
10
  "keywords": [
7
11
  "fetch",
8
12
  "typescript",
9
13
  "openapi-client",
10
14
  "openapi-generator"
11
15
  ],
12
- "license": "ISC",
16
+ "license": "Unlicense",
13
17
  "main": "./dist/index.js",
14
18
  "type": "commonjs",
15
19
  "exports": {
@@ -32,6 +36,6 @@
32
36
  "typescript": "^4.0",
33
37
  "@types/url-parse": "1.4.4"
34
38
  },
35
- "hash": "ff7181ae28bc68bcf9cada67a7976fcb599fc5e3ca641c20c01cc37f7d4ab3ed",
39
+ "hash": "235a3f3f9f479880d5814b7432b3a0c9ad503e247027d5b79ab8bd98b37869b1",
36
40
  "homepage": "https://api.product-live.com/-json"
37
41
  }