ultracart_rest_api_v2_typescript 4.0.192 → 4.0.195
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +1 -0
- package/README.md +5 -2
- package/dist/apis/WorkflowApi.d.ts +24 -1
- package/dist/apis/WorkflowApi.js +56 -0
- package/dist/models/WebhookEventSubscription.d.ts +6 -0
- package/dist/models/WebhookEventSubscription.js +2 -0
- package/dist/models/WorkflowTask.d.ts +7 -0
- package/dist/models/WorkflowTask.js +4 -1
- package/dist/models/WorkflowTasksResponse.d.ts +6 -0
- package/dist/models/WorkflowTasksResponse.js +2 -0
- package/dist/models/WorkflowUserResponse.d.ts +55 -0
- package/dist/models/WorkflowUserResponse.js +54 -0
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/package.json +1 -1
- package/src/apis/WorkflowApi.ts +55 -0
- package/src/models/WebhookEventSubscription.ts +8 -0
- package/src/models/WorkflowTask.ts +10 -1
- package/src/models/WorkflowTasksResponse.ts +8 -0
- package/src/models/WorkflowUserResponse.ts +113 -0
- package/src/models/index.ts +1 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -823,6 +823,7 @@ src/models/WorkflowTaskResponse.ts
|
|
|
823
823
|
src/models/WorkflowTasksRequest.ts
|
|
824
824
|
src/models/WorkflowTasksResponse.ts
|
|
825
825
|
src/models/WorkflowUser.ts
|
|
826
|
+
src/models/WorkflowUserResponse.ts
|
|
826
827
|
src/models/WorkflowUsersResponse.ts
|
|
827
828
|
src/models/index.ts
|
|
828
829
|
src/runtime.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## ultracart_rest_api_v2_typescript@4.0.
|
|
1
|
+
## ultracart_rest_api_v2_typescript@4.0.195
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). 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 ultracart_rest_api_v2_typescript@4.0.
|
|
39
|
+
npm install ultracart_rest_api_v2_typescript@4.0.195 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -54,6 +54,9 @@ Not every change is committed to every SDK.
|
|
|
54
54
|
|
|
55
55
|
| Version | Date | Comments |
|
|
56
56
|
| --: | :-: | --- |
|
|
57
|
+
| 4.0.195 | 01/03/2024 | workflow - add task_context field to task obj |
|
|
58
|
+
| 4.0.194 | 12/15/2023 | bug fix on bad docs breaking yaml schema |
|
|
59
|
+
| 4.0.193 | 12/12/2023 | webhook - added event ruler property |
|
|
57
60
|
| 4.0.192 | 11/21/2023 | coupons - addl support on tiered amount/percent off items |
|
|
58
61
|
| 4.0.191 | 11/20/2023 | coupon - add item tag support to percent off items and free shipping |
|
|
59
62
|
| 4.0.190 | 11/20/2023 | item.google_product_search.color bugfix for bad length validation: 20 to 100 |
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { WorkflowAttachmentUploadUrlResponse, WorkflowGroupsResponse, WorkflowTask, WorkflowTaskResponse, WorkflowTasksRequest, WorkflowTasksResponse, WorkflowUsersResponse } from '../models';
|
|
13
|
+
import { WorkflowAttachmentUploadUrlResponse, WorkflowGroupsResponse, WorkflowTask, WorkflowTaskResponse, WorkflowTasksRequest, WorkflowTasksResponse, WorkflowUserResponse, WorkflowUsersResponse } from '../models';
|
|
14
14
|
export interface GetWorkflowAssignmentGroupsRequest {
|
|
15
15
|
limit?: number;
|
|
16
16
|
offset?: number;
|
|
@@ -79,6 +79,19 @@ export interface WorkflowApiInterface {
|
|
|
79
79
|
* Retrieve a list of users that workflow tasks can be assigned to
|
|
80
80
|
*/
|
|
81
81
|
getWorkflowAssignmentUsers(requestParameters: GetWorkflowAssignmentUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowUsersResponse>;
|
|
82
|
+
/**
|
|
83
|
+
* Retrieve a user object for myself
|
|
84
|
+
* @summary Retrieve a user object for myself
|
|
85
|
+
* @param {*} [options] Override http request option.
|
|
86
|
+
* @throws {RequiredError}
|
|
87
|
+
* @memberof WorkflowApiInterface
|
|
88
|
+
*/
|
|
89
|
+
getWorkflowMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowUserResponse>>;
|
|
90
|
+
/**
|
|
91
|
+
* Retrieve a user object for myself
|
|
92
|
+
* Retrieve a user object for myself
|
|
93
|
+
*/
|
|
94
|
+
getWorkflowMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowUserResponse>;
|
|
82
95
|
/**
|
|
83
96
|
* Retrieve a workflow task
|
|
84
97
|
* @summary Retrieve a workflow task
|
|
@@ -193,6 +206,16 @@ export declare class WorkflowApi extends runtime.BaseAPI implements WorkflowApiI
|
|
|
193
206
|
* Retrieve a list of users that workflow tasks can be assigned to
|
|
194
207
|
*/
|
|
195
208
|
getWorkflowAssignmentUsers(requestParameters?: GetWorkflowAssignmentUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowUsersResponse>;
|
|
209
|
+
/**
|
|
210
|
+
* Retrieve a user object for myself
|
|
211
|
+
* Retrieve a user object for myself
|
|
212
|
+
*/
|
|
213
|
+
getWorkflowMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowUserResponse>>;
|
|
214
|
+
/**
|
|
215
|
+
* Retrieve a user object for myself
|
|
216
|
+
* Retrieve a user object for myself
|
|
217
|
+
*/
|
|
218
|
+
getWorkflowMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowUserResponse>;
|
|
196
219
|
/**
|
|
197
220
|
* Retrieve a workflow task
|
|
198
221
|
* Retrieve a workflow task
|
package/dist/apis/WorkflowApi.js
CHANGED
|
@@ -201,6 +201,62 @@ var WorkflowApi = /** @class */ (function (_super) {
|
|
|
201
201
|
});
|
|
202
202
|
});
|
|
203
203
|
};
|
|
204
|
+
/**
|
|
205
|
+
* Retrieve a user object for myself
|
|
206
|
+
* Retrieve a user object for myself
|
|
207
|
+
*/
|
|
208
|
+
WorkflowApi.prototype.getWorkflowMeRaw = function (initOverrides) {
|
|
209
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
210
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
211
|
+
return __generator(this, function (_c) {
|
|
212
|
+
switch (_c.label) {
|
|
213
|
+
case 0:
|
|
214
|
+
queryParameters = {};
|
|
215
|
+
headerParameters = {};
|
|
216
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
217
|
+
// oauth required
|
|
218
|
+
_a = headerParameters;
|
|
219
|
+
_b = "Authorization";
|
|
220
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["workflow_read"])];
|
|
221
|
+
case 1:
|
|
222
|
+
// oauth required
|
|
223
|
+
_a[_b] = _c.sent();
|
|
224
|
+
_c.label = 2;
|
|
225
|
+
case 2:
|
|
226
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
227
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
228
|
+
}
|
|
229
|
+
return [4 /*yield*/, this.request({
|
|
230
|
+
path: "/workflow/me",
|
|
231
|
+
method: 'GET',
|
|
232
|
+
headers: headerParameters,
|
|
233
|
+
query: queryParameters,
|
|
234
|
+
}, initOverrides)];
|
|
235
|
+
case 3:
|
|
236
|
+
response = _c.sent();
|
|
237
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.WorkflowUserResponseFromJSON)(jsonValue); })];
|
|
238
|
+
}
|
|
239
|
+
});
|
|
240
|
+
});
|
|
241
|
+
};
|
|
242
|
+
/**
|
|
243
|
+
* Retrieve a user object for myself
|
|
244
|
+
* Retrieve a user object for myself
|
|
245
|
+
*/
|
|
246
|
+
WorkflowApi.prototype.getWorkflowMe = function (initOverrides) {
|
|
247
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
248
|
+
var response;
|
|
249
|
+
return __generator(this, function (_a) {
|
|
250
|
+
switch (_a.label) {
|
|
251
|
+
case 0: return [4 /*yield*/, this.getWorkflowMeRaw(initOverrides)];
|
|
252
|
+
case 1:
|
|
253
|
+
response = _a.sent();
|
|
254
|
+
return [4 /*yield*/, response.value()];
|
|
255
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
256
|
+
}
|
|
257
|
+
});
|
|
258
|
+
});
|
|
259
|
+
};
|
|
204
260
|
/**
|
|
205
261
|
* Retrieve a workflow task
|
|
206
262
|
* Retrieve a workflow task
|
|
@@ -45,6 +45,12 @@ export interface WebhookEventSubscription {
|
|
|
45
45
|
* @memberof WebhookEventSubscription
|
|
46
46
|
*/
|
|
47
47
|
event_name?: string;
|
|
48
|
+
/**
|
|
49
|
+
* Optional - Event ruler expression to filter events to. Only events that match this Ruler expression will be transmitted to the webhook.
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof WebhookEventSubscription
|
|
52
|
+
*/
|
|
53
|
+
event_ruler?: string;
|
|
48
54
|
/**
|
|
49
55
|
* The expand string for the notification object. See the individual resource _expand documentation for valid values.
|
|
50
56
|
* @type {string}
|
|
@@ -29,6 +29,7 @@ function WebhookEventSubscriptionFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
29
29
|
'discontinued_flag': !(0, runtime_1.exists)(json, 'discontinued_flag') ? undefined : json['discontinued_flag'],
|
|
30
30
|
'event_description': !(0, runtime_1.exists)(json, 'event_description') ? undefined : json['event_description'],
|
|
31
31
|
'event_name': !(0, runtime_1.exists)(json, 'event_name') ? undefined : json['event_name'],
|
|
32
|
+
'event_ruler': !(0, runtime_1.exists)(json, 'event_ruler') ? undefined : json['event_ruler'],
|
|
32
33
|
'expansion': !(0, runtime_1.exists)(json, 'expansion') ? undefined : json['expansion'],
|
|
33
34
|
'subscribed': !(0, runtime_1.exists)(json, 'subscribed') ? undefined : json['subscribed'],
|
|
34
35
|
'supports_reflow': !(0, runtime_1.exists)(json, 'supports_reflow') ? undefined : json['supports_reflow'],
|
|
@@ -49,6 +50,7 @@ function WebhookEventSubscriptionToJSON(value) {
|
|
|
49
50
|
'discontinued_flag': value.discontinued_flag,
|
|
50
51
|
'event_description': value.event_description,
|
|
51
52
|
'event_name': value.event_name,
|
|
53
|
+
'event_ruler': value.event_ruler,
|
|
52
54
|
'expansion': value.expansion,
|
|
53
55
|
'subscribed': value.subscribed,
|
|
54
56
|
'supports_reflow': value.supports_reflow,
|
|
@@ -133,6 +133,12 @@ export interface WorkflowTask {
|
|
|
133
133
|
* @memberof WorkflowTask
|
|
134
134
|
*/
|
|
135
135
|
status?: WorkflowTaskStatusEnum;
|
|
136
|
+
/**
|
|
137
|
+
* User friendly string of the task context
|
|
138
|
+
* @type {string}
|
|
139
|
+
* @memberof WorkflowTask
|
|
140
|
+
*/
|
|
141
|
+
task_context?: string;
|
|
136
142
|
/**
|
|
137
143
|
* Task Details
|
|
138
144
|
* @type {string}
|
|
@@ -160,6 +166,7 @@ export declare const WorkflowTaskObjectTypeEnum: {
|
|
|
160
166
|
readonly AutoOrder: "auto order";
|
|
161
167
|
readonly Item: "item";
|
|
162
168
|
readonly CustomerProfile: "customer profile";
|
|
169
|
+
readonly Storefront: "storefront";
|
|
163
170
|
};
|
|
164
171
|
export type WorkflowTaskObjectTypeEnum = typeof WorkflowTaskObjectTypeEnum[keyof typeof WorkflowTaskObjectTypeEnum];
|
|
165
172
|
/**
|
|
@@ -26,7 +26,8 @@ exports.WorkflowTaskObjectTypeEnum = {
|
|
|
26
26
|
Order: 'order',
|
|
27
27
|
AutoOrder: 'auto order',
|
|
28
28
|
Item: 'item',
|
|
29
|
-
CustomerProfile: 'customer profile'
|
|
29
|
+
CustomerProfile: 'customer profile',
|
|
30
|
+
Storefront: 'storefront'
|
|
30
31
|
};
|
|
31
32
|
/**
|
|
32
33
|
* @export
|
|
@@ -74,6 +75,7 @@ function WorkflowTaskFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
74
75
|
'object_url': !(0, runtime_1.exists)(json, 'object_url') ? undefined : json['object_url'],
|
|
75
76
|
'priority': !(0, runtime_1.exists)(json, 'priority') ? undefined : json['priority'],
|
|
76
77
|
'status': !(0, runtime_1.exists)(json, 'status') ? undefined : json['status'],
|
|
78
|
+
'task_context': !(0, runtime_1.exists)(json, 'task_context') ? undefined : json['task_context'],
|
|
77
79
|
'task_details': !(0, runtime_1.exists)(json, 'task_details') ? undefined : json['task_details'],
|
|
78
80
|
'task_name': !(0, runtime_1.exists)(json, 'task_name') ? undefined : json['task_name'],
|
|
79
81
|
'workflow_task_uuid': !(0, runtime_1.exists)(json, 'workflow_task_uuid') ? undefined : json['workflow_task_uuid'],
|
|
@@ -107,6 +109,7 @@ function WorkflowTaskToJSON(value) {
|
|
|
107
109
|
'object_url': value.object_url,
|
|
108
110
|
'priority': value.priority,
|
|
109
111
|
'status': value.status,
|
|
112
|
+
'task_context': value.task_context,
|
|
110
113
|
'task_details': value.task_details,
|
|
111
114
|
'task_name': value.task_name,
|
|
112
115
|
'workflow_task_uuid': value.workflow_task_uuid,
|
|
@@ -37,6 +37,12 @@ export interface WorkflowTasksResponse {
|
|
|
37
37
|
* @memberof WorkflowTasksResponse
|
|
38
38
|
*/
|
|
39
39
|
success?: boolean;
|
|
40
|
+
/**
|
|
41
|
+
* User friendly string of the task context if querying for a specific object type/id
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof WorkflowTasksResponse
|
|
44
|
+
*/
|
|
45
|
+
task_context?: string;
|
|
40
46
|
/**
|
|
41
47
|
* tasks
|
|
42
48
|
* @type {Array<WorkflowTask>}
|
|
@@ -31,6 +31,7 @@ function WorkflowTasksResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
31
31
|
'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
|
|
32
32
|
'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
|
|
33
33
|
'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
|
|
34
|
+
'task_context': !(0, runtime_1.exists)(json, 'task_context') ? undefined : json['task_context'],
|
|
34
35
|
'tasks': !(0, runtime_1.exists)(json, 'tasks') ? undefined : (json['tasks'].map(WorkflowTask_1.WorkflowTaskFromJSON)),
|
|
35
36
|
'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
|
|
36
37
|
};
|
|
@@ -47,6 +48,7 @@ function WorkflowTasksResponseToJSON(value) {
|
|
|
47
48
|
'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
|
|
48
49
|
'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
|
|
49
50
|
'success': value.success,
|
|
51
|
+
'task_context': value.task_context,
|
|
50
52
|
'tasks': value.tasks === undefined ? undefined : (value.tasks.map(WorkflowTask_1.WorkflowTaskToJSON)),
|
|
51
53
|
'warning': (0, Warning_1.WarningToJSON)(value.warning),
|
|
52
54
|
};
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* UltraCart Rest API V2
|
|
3
|
+
* UltraCart REST API Version 2
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
|
6
|
+
* Contact: support@ultracart.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { ModelError } from './ModelError';
|
|
13
|
+
import { ResponseMetadata } from './ResponseMetadata';
|
|
14
|
+
import { Warning } from './Warning';
|
|
15
|
+
import { WorkflowUser } from './WorkflowUser';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface WorkflowUserResponse
|
|
20
|
+
*/
|
|
21
|
+
export interface WorkflowUserResponse {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {ModelError}
|
|
25
|
+
* @memberof WorkflowUserResponse
|
|
26
|
+
*/
|
|
27
|
+
error?: ModelError;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {ResponseMetadata}
|
|
31
|
+
* @memberof WorkflowUserResponse
|
|
32
|
+
*/
|
|
33
|
+
metadata?: ResponseMetadata;
|
|
34
|
+
/**
|
|
35
|
+
* Indicates if API call was successful
|
|
36
|
+
* @type {boolean}
|
|
37
|
+
* @memberof WorkflowUserResponse
|
|
38
|
+
*/
|
|
39
|
+
success?: boolean;
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @type {WorkflowUser}
|
|
43
|
+
* @memberof WorkflowUserResponse
|
|
44
|
+
*/
|
|
45
|
+
user?: WorkflowUser;
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @type {Warning}
|
|
49
|
+
* @memberof WorkflowUserResponse
|
|
50
|
+
*/
|
|
51
|
+
warning?: Warning;
|
|
52
|
+
}
|
|
53
|
+
export declare function WorkflowUserResponseFromJSON(json: any): WorkflowUserResponse;
|
|
54
|
+
export declare function WorkflowUserResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowUserResponse;
|
|
55
|
+
export declare function WorkflowUserResponseToJSON(value?: WorkflowUserResponse | null): any;
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* UltraCart Rest API V2
|
|
6
|
+
* UltraCart REST API Version 2
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2.0.0
|
|
9
|
+
* Contact: support@ultracart.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.WorkflowUserResponseToJSON = exports.WorkflowUserResponseFromJSONTyped = exports.WorkflowUserResponseFromJSON = void 0;
|
|
17
|
+
var runtime_1 = require("../runtime");
|
|
18
|
+
var ModelError_1 = require("./ModelError");
|
|
19
|
+
var ResponseMetadata_1 = require("./ResponseMetadata");
|
|
20
|
+
var Warning_1 = require("./Warning");
|
|
21
|
+
var WorkflowUser_1 = require("./WorkflowUser");
|
|
22
|
+
function WorkflowUserResponseFromJSON(json) {
|
|
23
|
+
return WorkflowUserResponseFromJSONTyped(json, false);
|
|
24
|
+
}
|
|
25
|
+
exports.WorkflowUserResponseFromJSON = WorkflowUserResponseFromJSON;
|
|
26
|
+
function WorkflowUserResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
27
|
+
if ((json === undefined) || (json === null)) {
|
|
28
|
+
return json;
|
|
29
|
+
}
|
|
30
|
+
return {
|
|
31
|
+
'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
|
|
32
|
+
'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
|
|
33
|
+
'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
|
|
34
|
+
'user': !(0, runtime_1.exists)(json, 'user') ? undefined : (0, WorkflowUser_1.WorkflowUserFromJSON)(json['user']),
|
|
35
|
+
'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
|
|
36
|
+
};
|
|
37
|
+
}
|
|
38
|
+
exports.WorkflowUserResponseFromJSONTyped = WorkflowUserResponseFromJSONTyped;
|
|
39
|
+
function WorkflowUserResponseToJSON(value) {
|
|
40
|
+
if (value === undefined) {
|
|
41
|
+
return undefined;
|
|
42
|
+
}
|
|
43
|
+
if (value === null) {
|
|
44
|
+
return null;
|
|
45
|
+
}
|
|
46
|
+
return {
|
|
47
|
+
'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
|
|
48
|
+
'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
|
|
49
|
+
'success': value.success,
|
|
50
|
+
'user': (0, WorkflowUser_1.WorkflowUserToJSON)(value.user),
|
|
51
|
+
'warning': (0, Warning_1.WarningToJSON)(value.warning),
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
exports.WorkflowUserResponseToJSON = WorkflowUserResponseToJSON;
|
package/dist/models/index.d.ts
CHANGED
package/dist/models/index.js
CHANGED
|
@@ -814,4 +814,5 @@ __exportStar(require("./WorkflowTaskResponse"), exports);
|
|
|
814
814
|
__exportStar(require("./WorkflowTasksRequest"), exports);
|
|
815
815
|
__exportStar(require("./WorkflowTasksResponse"), exports);
|
|
816
816
|
__exportStar(require("./WorkflowUser"), exports);
|
|
817
|
+
__exportStar(require("./WorkflowUserResponse"), exports);
|
|
817
818
|
__exportStar(require("./WorkflowUsersResponse"), exports);
|
package/package.json
CHANGED
package/src/apis/WorkflowApi.ts
CHANGED
|
@@ -36,6 +36,9 @@ import {
|
|
|
36
36
|
WorkflowTasksResponse,
|
|
37
37
|
WorkflowTasksResponseFromJSON,
|
|
38
38
|
WorkflowTasksResponseToJSON,
|
|
39
|
+
WorkflowUserResponse,
|
|
40
|
+
WorkflowUserResponseFromJSON,
|
|
41
|
+
WorkflowUserResponseToJSON,
|
|
39
42
|
WorkflowUsersResponse,
|
|
40
43
|
WorkflowUsersResponseFromJSON,
|
|
41
44
|
WorkflowUsersResponseToJSON,
|
|
@@ -121,6 +124,21 @@ export interface WorkflowApiInterface {
|
|
|
121
124
|
*/
|
|
122
125
|
getWorkflowAssignmentUsers(requestParameters: GetWorkflowAssignmentUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowUsersResponse>;
|
|
123
126
|
|
|
127
|
+
/**
|
|
128
|
+
* Retrieve a user object for myself
|
|
129
|
+
* @summary Retrieve a user object for myself
|
|
130
|
+
* @param {*} [options] Override http request option.
|
|
131
|
+
* @throws {RequiredError}
|
|
132
|
+
* @memberof WorkflowApiInterface
|
|
133
|
+
*/
|
|
134
|
+
getWorkflowMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowUserResponse>>;
|
|
135
|
+
|
|
136
|
+
/**
|
|
137
|
+
* Retrieve a user object for myself
|
|
138
|
+
* Retrieve a user object for myself
|
|
139
|
+
*/
|
|
140
|
+
getWorkflowMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowUserResponse>;
|
|
141
|
+
|
|
124
142
|
/**
|
|
125
143
|
* Retrieve a workflow task
|
|
126
144
|
* @summary Retrieve a workflow task
|
|
@@ -319,6 +337,43 @@ export class WorkflowApi extends runtime.BaseAPI implements WorkflowApiInterface
|
|
|
319
337
|
return await response.value();
|
|
320
338
|
}
|
|
321
339
|
|
|
340
|
+
/**
|
|
341
|
+
* Retrieve a user object for myself
|
|
342
|
+
* Retrieve a user object for myself
|
|
343
|
+
*/
|
|
344
|
+
async getWorkflowMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowUserResponse>> {
|
|
345
|
+
const queryParameters: any = {};
|
|
346
|
+
|
|
347
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
348
|
+
|
|
349
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
350
|
+
// oauth required
|
|
351
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["workflow_read"]);
|
|
352
|
+
}
|
|
353
|
+
|
|
354
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
355
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
356
|
+
}
|
|
357
|
+
|
|
358
|
+
const response = await this.request({
|
|
359
|
+
path: `/workflow/me`,
|
|
360
|
+
method: 'GET',
|
|
361
|
+
headers: headerParameters,
|
|
362
|
+
query: queryParameters,
|
|
363
|
+
}, initOverrides);
|
|
364
|
+
|
|
365
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowUserResponseFromJSON(jsonValue));
|
|
366
|
+
}
|
|
367
|
+
|
|
368
|
+
/**
|
|
369
|
+
* Retrieve a user object for myself
|
|
370
|
+
* Retrieve a user object for myself
|
|
371
|
+
*/
|
|
372
|
+
async getWorkflowMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowUserResponse> {
|
|
373
|
+
const response = await this.getWorkflowMeRaw(initOverrides);
|
|
374
|
+
return await response.value();
|
|
375
|
+
}
|
|
376
|
+
|
|
322
377
|
/**
|
|
323
378
|
* Retrieve a workflow task
|
|
324
379
|
* Retrieve a workflow task
|
|
@@ -49,6 +49,12 @@ export interface WebhookEventSubscription {
|
|
|
49
49
|
* @memberof WebhookEventSubscription
|
|
50
50
|
*/
|
|
51
51
|
event_name?: string;
|
|
52
|
+
/**
|
|
53
|
+
* Optional - Event ruler expression to filter events to. Only events that match this Ruler expression will be transmitted to the webhook.
|
|
54
|
+
* @type {string}
|
|
55
|
+
* @memberof WebhookEventSubscription
|
|
56
|
+
*/
|
|
57
|
+
event_ruler?: string;
|
|
52
58
|
/**
|
|
53
59
|
* The expand string for the notification object. See the individual resource _expand documentation for valid values.
|
|
54
60
|
* @type {string}
|
|
@@ -90,6 +96,7 @@ export function WebhookEventSubscriptionFromJSONTyped(json: any, ignoreDiscrimin
|
|
|
90
96
|
'discontinued_flag': !exists(json, 'discontinued_flag') ? undefined : json['discontinued_flag'],
|
|
91
97
|
'event_description': !exists(json, 'event_description') ? undefined : json['event_description'],
|
|
92
98
|
'event_name': !exists(json, 'event_name') ? undefined : json['event_name'],
|
|
99
|
+
'event_ruler': !exists(json, 'event_ruler') ? undefined : json['event_ruler'],
|
|
93
100
|
'expansion': !exists(json, 'expansion') ? undefined : json['expansion'],
|
|
94
101
|
'subscribed': !exists(json, 'subscribed') ? undefined : json['subscribed'],
|
|
95
102
|
'supports_reflow': !exists(json, 'supports_reflow') ? undefined : json['supports_reflow'],
|
|
@@ -111,6 +118,7 @@ export function WebhookEventSubscriptionToJSON(value?: WebhookEventSubscription
|
|
|
111
118
|
'discontinued_flag': value.discontinued_flag,
|
|
112
119
|
'event_description': value.event_description,
|
|
113
120
|
'event_name': value.event_name,
|
|
121
|
+
'event_ruler': value.event_ruler,
|
|
114
122
|
'expansion': value.expansion,
|
|
115
123
|
'subscribed': value.subscribed,
|
|
116
124
|
'supports_reflow': value.supports_reflow,
|
|
@@ -158,6 +158,12 @@ export interface WorkflowTask {
|
|
|
158
158
|
* @memberof WorkflowTask
|
|
159
159
|
*/
|
|
160
160
|
status?: WorkflowTaskStatusEnum;
|
|
161
|
+
/**
|
|
162
|
+
* User friendly string of the task context
|
|
163
|
+
* @type {string}
|
|
164
|
+
* @memberof WorkflowTask
|
|
165
|
+
*/
|
|
166
|
+
task_context?: string;
|
|
161
167
|
/**
|
|
162
168
|
* Task Details
|
|
163
169
|
* @type {string}
|
|
@@ -186,7 +192,8 @@ export const WorkflowTaskObjectTypeEnum = {
|
|
|
186
192
|
Order: 'order',
|
|
187
193
|
AutoOrder: 'auto order',
|
|
188
194
|
Item: 'item',
|
|
189
|
-
CustomerProfile: 'customer profile'
|
|
195
|
+
CustomerProfile: 'customer profile',
|
|
196
|
+
Storefront: 'storefront'
|
|
190
197
|
} as const;
|
|
191
198
|
export type WorkflowTaskObjectTypeEnum = typeof WorkflowTaskObjectTypeEnum[keyof typeof WorkflowTaskObjectTypeEnum];
|
|
192
199
|
|
|
@@ -242,6 +249,7 @@ export function WorkflowTaskFromJSONTyped(json: any, ignoreDiscriminator: boolea
|
|
|
242
249
|
'object_url': !exists(json, 'object_url') ? undefined : json['object_url'],
|
|
243
250
|
'priority': !exists(json, 'priority') ? undefined : json['priority'],
|
|
244
251
|
'status': !exists(json, 'status') ? undefined : json['status'],
|
|
252
|
+
'task_context': !exists(json, 'task_context') ? undefined : json['task_context'],
|
|
245
253
|
'task_details': !exists(json, 'task_details') ? undefined : json['task_details'],
|
|
246
254
|
'task_name': !exists(json, 'task_name') ? undefined : json['task_name'],
|
|
247
255
|
'workflow_task_uuid': !exists(json, 'workflow_task_uuid') ? undefined : json['workflow_task_uuid'],
|
|
@@ -276,6 +284,7 @@ export function WorkflowTaskToJSON(value?: WorkflowTask | null): any {
|
|
|
276
284
|
'object_url': value.object_url,
|
|
277
285
|
'priority': value.priority,
|
|
278
286
|
'status': value.status,
|
|
287
|
+
'task_context': value.task_context,
|
|
279
288
|
'task_details': value.task_details,
|
|
280
289
|
'task_name': value.task_name,
|
|
281
290
|
'workflow_task_uuid': value.workflow_task_uuid,
|
|
@@ -62,6 +62,12 @@ export interface WorkflowTasksResponse {
|
|
|
62
62
|
* @memberof WorkflowTasksResponse
|
|
63
63
|
*/
|
|
64
64
|
success?: boolean;
|
|
65
|
+
/**
|
|
66
|
+
* User friendly string of the task context if querying for a specific object type/id
|
|
67
|
+
* @type {string}
|
|
68
|
+
* @memberof WorkflowTasksResponse
|
|
69
|
+
*/
|
|
70
|
+
task_context?: string;
|
|
65
71
|
/**
|
|
66
72
|
* tasks
|
|
67
73
|
* @type {Array<WorkflowTask>}
|
|
@@ -89,6 +95,7 @@ export function WorkflowTasksResponseFromJSONTyped(json: any, ignoreDiscriminato
|
|
|
89
95
|
'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
|
|
90
96
|
'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
|
|
91
97
|
'success': !exists(json, 'success') ? undefined : json['success'],
|
|
98
|
+
'task_context': !exists(json, 'task_context') ? undefined : json['task_context'],
|
|
92
99
|
'tasks': !exists(json, 'tasks') ? undefined : ((json['tasks'] as Array<any>).map(WorkflowTaskFromJSON)),
|
|
93
100
|
'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
|
|
94
101
|
};
|
|
@@ -106,6 +113,7 @@ export function WorkflowTasksResponseToJSON(value?: WorkflowTasksResponse | null
|
|
|
106
113
|
'error': ModelErrorToJSON(value.error),
|
|
107
114
|
'metadata': ResponseMetadataToJSON(value.metadata),
|
|
108
115
|
'success': value.success,
|
|
116
|
+
'task_context': value.task_context,
|
|
109
117
|
'tasks': value.tasks === undefined ? undefined : ((value.tasks as Array<any>).map(WorkflowTaskToJSON)),
|
|
110
118
|
'warning': WarningToJSON(value.warning),
|
|
111
119
|
};
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* UltraCart Rest API V2
|
|
5
|
+
* UltraCart REST API Version 2
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.0.0
|
|
8
|
+
* Contact: support@ultracart.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { exists, mapValues } from '../runtime';
|
|
16
|
+
import {
|
|
17
|
+
ModelError,
|
|
18
|
+
ModelErrorFromJSON,
|
|
19
|
+
ModelErrorFromJSONTyped,
|
|
20
|
+
ModelErrorToJSON,
|
|
21
|
+
} from './ModelError';
|
|
22
|
+
import {
|
|
23
|
+
ResponseMetadata,
|
|
24
|
+
ResponseMetadataFromJSON,
|
|
25
|
+
ResponseMetadataFromJSONTyped,
|
|
26
|
+
ResponseMetadataToJSON,
|
|
27
|
+
} from './ResponseMetadata';
|
|
28
|
+
import {
|
|
29
|
+
Warning,
|
|
30
|
+
WarningFromJSON,
|
|
31
|
+
WarningFromJSONTyped,
|
|
32
|
+
WarningToJSON,
|
|
33
|
+
} from './Warning';
|
|
34
|
+
import {
|
|
35
|
+
WorkflowUser,
|
|
36
|
+
WorkflowUserFromJSON,
|
|
37
|
+
WorkflowUserFromJSONTyped,
|
|
38
|
+
WorkflowUserToJSON,
|
|
39
|
+
} from './WorkflowUser';
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
*
|
|
43
|
+
* @export
|
|
44
|
+
* @interface WorkflowUserResponse
|
|
45
|
+
*/
|
|
46
|
+
export interface WorkflowUserResponse {
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @type {ModelError}
|
|
50
|
+
* @memberof WorkflowUserResponse
|
|
51
|
+
*/
|
|
52
|
+
error?: ModelError;
|
|
53
|
+
/**
|
|
54
|
+
*
|
|
55
|
+
* @type {ResponseMetadata}
|
|
56
|
+
* @memberof WorkflowUserResponse
|
|
57
|
+
*/
|
|
58
|
+
metadata?: ResponseMetadata;
|
|
59
|
+
/**
|
|
60
|
+
* Indicates if API call was successful
|
|
61
|
+
* @type {boolean}
|
|
62
|
+
* @memberof WorkflowUserResponse
|
|
63
|
+
*/
|
|
64
|
+
success?: boolean;
|
|
65
|
+
/**
|
|
66
|
+
*
|
|
67
|
+
* @type {WorkflowUser}
|
|
68
|
+
* @memberof WorkflowUserResponse
|
|
69
|
+
*/
|
|
70
|
+
user?: WorkflowUser;
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
* @type {Warning}
|
|
74
|
+
* @memberof WorkflowUserResponse
|
|
75
|
+
*/
|
|
76
|
+
warning?: Warning;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
export function WorkflowUserResponseFromJSON(json: any): WorkflowUserResponse {
|
|
80
|
+
return WorkflowUserResponseFromJSONTyped(json, false);
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
export function WorkflowUserResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowUserResponse {
|
|
84
|
+
if ((json === undefined) || (json === null)) {
|
|
85
|
+
return json;
|
|
86
|
+
}
|
|
87
|
+
return {
|
|
88
|
+
|
|
89
|
+
'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
|
|
90
|
+
'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
|
|
91
|
+
'success': !exists(json, 'success') ? undefined : json['success'],
|
|
92
|
+
'user': !exists(json, 'user') ? undefined : WorkflowUserFromJSON(json['user']),
|
|
93
|
+
'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
|
|
94
|
+
};
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
export function WorkflowUserResponseToJSON(value?: WorkflowUserResponse | null): any {
|
|
98
|
+
if (value === undefined) {
|
|
99
|
+
return undefined;
|
|
100
|
+
}
|
|
101
|
+
if (value === null) {
|
|
102
|
+
return null;
|
|
103
|
+
}
|
|
104
|
+
return {
|
|
105
|
+
|
|
106
|
+
'error': ModelErrorToJSON(value.error),
|
|
107
|
+
'metadata': ResponseMetadataToJSON(value.metadata),
|
|
108
|
+
'success': value.success,
|
|
109
|
+
'user': WorkflowUserToJSON(value.user),
|
|
110
|
+
'warning': WarningToJSON(value.warning),
|
|
111
|
+
};
|
|
112
|
+
}
|
|
113
|
+
|
package/src/models/index.ts
CHANGED