ultracart_rest_api_v2_typescript 4.0.204 → 4.0.206
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 +4 -2
- package/dist/apis/WorkflowApi.d.ts +24 -1
- package/dist/apis/WorkflowApi.js +56 -0
- package/dist/models/ChannelPartnerOrder.d.ts +6 -0
- package/dist/models/ChannelPartnerOrder.js +2 -0
- package/dist/models/WorkflowTaskOpenCountResponse.d.ts +54 -0
- package/dist/models/WorkflowTaskOpenCountResponse.js +53 -0
- package/dist/models/WorkflowUsersResponse.d.ts +6 -0
- package/dist/models/WorkflowUsersResponse.js +2 -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/ChannelPartnerOrder.ts +8 -0
- package/src/models/WorkflowTaskOpenCountResponse.ts +107 -0
- package/src/models/WorkflowUsersResponse.ts +8 -0
- package/src/models/index.ts +1 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -857,6 +857,7 @@ src/models/WorkflowGroupsResponse.ts
|
|
|
857
857
|
src/models/WorkflowNote.ts
|
|
858
858
|
src/models/WorkflowTask.ts
|
|
859
859
|
src/models/WorkflowTaskHistory.ts
|
|
860
|
+
src/models/WorkflowTaskOpenCountResponse.ts
|
|
860
861
|
src/models/WorkflowTaskResponse.ts
|
|
861
862
|
src/models/WorkflowTaskTagsResponse.ts
|
|
862
863
|
src/models/WorkflowTasksRequest.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.206
|
|
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.206 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
|
|
|
54
54
|
|
|
55
55
|
| Version | Date | Comments |
|
|
56
56
|
| --: | :-: | --- |
|
|
57
|
+
| 4.0.206 | 03/25/2024 | added sales_rep_code to Channel partner order |
|
|
58
|
+
| 4.0.205 | 03/19/2024 | workflow task - method to obtain open task count |
|
|
57
59
|
| 4.0.204 | 03/19/2024 | workflow task - addl status values, expiration_dts, and system task type |
|
|
58
60
|
| 4.0.203 | 03/15/2024 | workflow - getWorkflowAgentWebsocketAuthorization method added |
|
|
59
61
|
| 4.0.202 | 03/08/2024 | added getWorkflowTaskTags method |
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { WorkflowAgentAuthResponse, WorkflowAttachmentUploadUrlResponse, WorkflowGroupsResponse, WorkflowTask, WorkflowTaskResponse, WorkflowTaskTagsResponse, WorkflowTasksRequest, WorkflowTasksResponse, WorkflowUserResponse, WorkflowUsersResponse } from '../models';
|
|
13
|
+
import { WorkflowAgentAuthResponse, WorkflowAttachmentUploadUrlResponse, WorkflowGroupsResponse, WorkflowTask, WorkflowTaskOpenCountResponse, WorkflowTaskResponse, WorkflowTaskTagsResponse, WorkflowTasksRequest, WorkflowTasksResponse, WorkflowUserResponse, WorkflowUsersResponse } from '../models';
|
|
14
14
|
export interface GetWorkflowAssignmentGroupsRequest {
|
|
15
15
|
limit?: number;
|
|
16
16
|
offset?: number;
|
|
@@ -148,6 +148,19 @@ export interface WorkflowApiInterface {
|
|
|
148
148
|
* Retrieve a workflow task by object type and id
|
|
149
149
|
*/
|
|
150
150
|
getWorkflowTaskByObjectType(requestParameters: GetWorkflowTaskByObjectTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTasksResponse>;
|
|
151
|
+
/**
|
|
152
|
+
* Retrieve workflow task open count
|
|
153
|
+
* @summary Retrieve workflow task open count
|
|
154
|
+
* @param {*} [options] Override http request option.
|
|
155
|
+
* @throws {RequiredError}
|
|
156
|
+
* @memberof WorkflowApiInterface
|
|
157
|
+
*/
|
|
158
|
+
getWorkflowTaskOpenCountRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowTaskOpenCountResponse>>;
|
|
159
|
+
/**
|
|
160
|
+
* Retrieve workflow task open count
|
|
161
|
+
* Retrieve workflow task open count
|
|
162
|
+
*/
|
|
163
|
+
getWorkflowTaskOpenCount(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTaskOpenCountResponse>;
|
|
151
164
|
/**
|
|
152
165
|
* Retrieves a unique list of all the existing workflow task tags.
|
|
153
166
|
* @summary Get a list of existing workflow task tags
|
|
@@ -282,6 +295,16 @@ export declare class WorkflowApi extends runtime.BaseAPI implements WorkflowApiI
|
|
|
282
295
|
* Retrieve a workflow task by object type and id
|
|
283
296
|
*/
|
|
284
297
|
getWorkflowTaskByObjectType(requestParameters: GetWorkflowTaskByObjectTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTasksResponse>;
|
|
298
|
+
/**
|
|
299
|
+
* Retrieve workflow task open count
|
|
300
|
+
* Retrieve workflow task open count
|
|
301
|
+
*/
|
|
302
|
+
getWorkflowTaskOpenCountRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowTaskOpenCountResponse>>;
|
|
303
|
+
/**
|
|
304
|
+
* Retrieve workflow task open count
|
|
305
|
+
* Retrieve workflow task open count
|
|
306
|
+
*/
|
|
307
|
+
getWorkflowTaskOpenCount(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTaskOpenCountResponse>;
|
|
285
308
|
/**
|
|
286
309
|
* Retrieves a unique list of all the existing workflow task tags.
|
|
287
310
|
* Get a list of existing workflow task tags
|
package/dist/apis/WorkflowApi.js
CHANGED
|
@@ -493,6 +493,62 @@ var WorkflowApi = /** @class */ (function (_super) {
|
|
|
493
493
|
});
|
|
494
494
|
});
|
|
495
495
|
};
|
|
496
|
+
/**
|
|
497
|
+
* Retrieve workflow task open count
|
|
498
|
+
* Retrieve workflow task open count
|
|
499
|
+
*/
|
|
500
|
+
WorkflowApi.prototype.getWorkflowTaskOpenCountRaw = function (initOverrides) {
|
|
501
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
502
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
503
|
+
return __generator(this, function (_c) {
|
|
504
|
+
switch (_c.label) {
|
|
505
|
+
case 0:
|
|
506
|
+
queryParameters = {};
|
|
507
|
+
headerParameters = {};
|
|
508
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
509
|
+
// oauth required
|
|
510
|
+
_a = headerParameters;
|
|
511
|
+
_b = "Authorization";
|
|
512
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["workflow_read"])];
|
|
513
|
+
case 1:
|
|
514
|
+
// oauth required
|
|
515
|
+
_a[_b] = _c.sent();
|
|
516
|
+
_c.label = 2;
|
|
517
|
+
case 2:
|
|
518
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
519
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
520
|
+
}
|
|
521
|
+
return [4 /*yield*/, this.request({
|
|
522
|
+
path: "/workflow/tasks/open_count",
|
|
523
|
+
method: 'GET',
|
|
524
|
+
headers: headerParameters,
|
|
525
|
+
query: queryParameters,
|
|
526
|
+
}, initOverrides)];
|
|
527
|
+
case 3:
|
|
528
|
+
response = _c.sent();
|
|
529
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.WorkflowTaskOpenCountResponseFromJSON)(jsonValue); })];
|
|
530
|
+
}
|
|
531
|
+
});
|
|
532
|
+
});
|
|
533
|
+
};
|
|
534
|
+
/**
|
|
535
|
+
* Retrieve workflow task open count
|
|
536
|
+
* Retrieve workflow task open count
|
|
537
|
+
*/
|
|
538
|
+
WorkflowApi.prototype.getWorkflowTaskOpenCount = function (initOverrides) {
|
|
539
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
540
|
+
var response;
|
|
541
|
+
return __generator(this, function (_a) {
|
|
542
|
+
switch (_a.label) {
|
|
543
|
+
case 0: return [4 /*yield*/, this.getWorkflowTaskOpenCountRaw(initOverrides)];
|
|
544
|
+
case 1:
|
|
545
|
+
response = _a.sent();
|
|
546
|
+
return [4 /*yield*/, response.value()];
|
|
547
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
548
|
+
}
|
|
549
|
+
});
|
|
550
|
+
});
|
|
551
|
+
};
|
|
496
552
|
/**
|
|
497
553
|
* Retrieves a unique list of all the existing workflow task tags.
|
|
498
554
|
* Get a list of existing workflow task tags
|
|
@@ -353,6 +353,12 @@ export interface ChannelPartnerOrder {
|
|
|
353
353
|
* @memberof ChannelPartnerOrder
|
|
354
354
|
*/
|
|
355
355
|
rotating_transaction_gateway_code?: string;
|
|
356
|
+
/**
|
|
357
|
+
* Sales rep code
|
|
358
|
+
* @type {string}
|
|
359
|
+
* @memberof ChannelPartnerOrder
|
|
360
|
+
*/
|
|
361
|
+
sales_rep_code?: string;
|
|
356
362
|
/**
|
|
357
363
|
* Screen branding theme code
|
|
358
364
|
* @type {string}
|
|
@@ -98,6 +98,7 @@ function ChannelPartnerOrderFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
98
98
|
'payment_method': !(0, runtime_1.exists)(json, 'payment_method') ? undefined : json['payment_method'],
|
|
99
99
|
'purchase_order_number': !(0, runtime_1.exists)(json, 'purchase_order_number') ? undefined : json['purchase_order_number'],
|
|
100
100
|
'rotating_transaction_gateway_code': !(0, runtime_1.exists)(json, 'rotating_transaction_gateway_code') ? undefined : json['rotating_transaction_gateway_code'],
|
|
101
|
+
'sales_rep_code': !(0, runtime_1.exists)(json, 'sales_rep_code') ? undefined : json['sales_rep_code'],
|
|
101
102
|
'screen_branding_theme_code': !(0, runtime_1.exists)(json, 'screen_branding_theme_code') ? undefined : json['screen_branding_theme_code'],
|
|
102
103
|
'ship_on_date': !(0, runtime_1.exists)(json, 'ship_on_date') ? undefined : json['ship_on_date'],
|
|
103
104
|
'ship_to_residential': !(0, runtime_1.exists)(json, 'ship_to_residential') ? undefined : json['ship_to_residential'],
|
|
@@ -189,6 +190,7 @@ function ChannelPartnerOrderToJSON(value) {
|
|
|
189
190
|
'payment_method': value.payment_method,
|
|
190
191
|
'purchase_order_number': value.purchase_order_number,
|
|
191
192
|
'rotating_transaction_gateway_code': value.rotating_transaction_gateway_code,
|
|
193
|
+
'sales_rep_code': value.sales_rep_code,
|
|
192
194
|
'screen_branding_theme_code': value.screen_branding_theme_code,
|
|
193
195
|
'ship_on_date': value.ship_on_date,
|
|
194
196
|
'ship_to_residential': value.ship_to_residential,
|
|
@@ -0,0 +1,54 @@
|
|
|
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
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
* @interface WorkflowTaskOpenCountResponse
|
|
19
|
+
*/
|
|
20
|
+
export interface WorkflowTaskOpenCountResponse {
|
|
21
|
+
/**
|
|
22
|
+
*
|
|
23
|
+
* @type {ModelError}
|
|
24
|
+
* @memberof WorkflowTaskOpenCountResponse
|
|
25
|
+
*/
|
|
26
|
+
error?: ModelError;
|
|
27
|
+
/**
|
|
28
|
+
*
|
|
29
|
+
* @type {ResponseMetadata}
|
|
30
|
+
* @memberof WorkflowTaskOpenCountResponse
|
|
31
|
+
*/
|
|
32
|
+
metadata?: ResponseMetadata;
|
|
33
|
+
/**
|
|
34
|
+
* Open Task Count
|
|
35
|
+
* @type {number}
|
|
36
|
+
* @memberof WorkflowTaskOpenCountResponse
|
|
37
|
+
*/
|
|
38
|
+
open_count?: number;
|
|
39
|
+
/**
|
|
40
|
+
* Indicates if API call was successful
|
|
41
|
+
* @type {boolean}
|
|
42
|
+
* @memberof WorkflowTaskOpenCountResponse
|
|
43
|
+
*/
|
|
44
|
+
success?: boolean;
|
|
45
|
+
/**
|
|
46
|
+
*
|
|
47
|
+
* @type {Warning}
|
|
48
|
+
* @memberof WorkflowTaskOpenCountResponse
|
|
49
|
+
*/
|
|
50
|
+
warning?: Warning;
|
|
51
|
+
}
|
|
52
|
+
export declare function WorkflowTaskOpenCountResponseFromJSON(json: any): WorkflowTaskOpenCountResponse;
|
|
53
|
+
export declare function WorkflowTaskOpenCountResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowTaskOpenCountResponse;
|
|
54
|
+
export declare function WorkflowTaskOpenCountResponseToJSON(value?: WorkflowTaskOpenCountResponse | null): any;
|
|
@@ -0,0 +1,53 @@
|
|
|
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.WorkflowTaskOpenCountResponseToJSON = exports.WorkflowTaskOpenCountResponseFromJSONTyped = exports.WorkflowTaskOpenCountResponseFromJSON = 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
|
+
function WorkflowTaskOpenCountResponseFromJSON(json) {
|
|
22
|
+
return WorkflowTaskOpenCountResponseFromJSONTyped(json, false);
|
|
23
|
+
}
|
|
24
|
+
exports.WorkflowTaskOpenCountResponseFromJSON = WorkflowTaskOpenCountResponseFromJSON;
|
|
25
|
+
function WorkflowTaskOpenCountResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
26
|
+
if ((json === undefined) || (json === null)) {
|
|
27
|
+
return json;
|
|
28
|
+
}
|
|
29
|
+
return {
|
|
30
|
+
'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
|
|
31
|
+
'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
|
|
32
|
+
'open_count': !(0, runtime_1.exists)(json, 'open_count') ? undefined : json['open_count'],
|
|
33
|
+
'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
|
|
34
|
+
'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
exports.WorkflowTaskOpenCountResponseFromJSONTyped = WorkflowTaskOpenCountResponseFromJSONTyped;
|
|
38
|
+
function WorkflowTaskOpenCountResponseToJSON(value) {
|
|
39
|
+
if (value === undefined) {
|
|
40
|
+
return undefined;
|
|
41
|
+
}
|
|
42
|
+
if (value === null) {
|
|
43
|
+
return null;
|
|
44
|
+
}
|
|
45
|
+
return {
|
|
46
|
+
'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
|
|
47
|
+
'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
|
|
48
|
+
'open_count': value.open_count,
|
|
49
|
+
'success': value.success,
|
|
50
|
+
'warning': (0, Warning_1.WarningToJSON)(value.warning),
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
exports.WorkflowTaskOpenCountResponseToJSON = WorkflowTaskOpenCountResponseToJSON;
|
|
@@ -31,6 +31,12 @@ export interface WorkflowUsersResponse {
|
|
|
31
31
|
* @memberof WorkflowUsersResponse
|
|
32
32
|
*/
|
|
33
33
|
metadata?: ResponseMetadata;
|
|
34
|
+
/**
|
|
35
|
+
* User ID of myself
|
|
36
|
+
* @type {number}
|
|
37
|
+
* @memberof WorkflowUsersResponse
|
|
38
|
+
*/
|
|
39
|
+
my_user_id?: number;
|
|
34
40
|
/**
|
|
35
41
|
* Indicates if API call was successful
|
|
36
42
|
* @type {boolean}
|
|
@@ -30,6 +30,7 @@ function WorkflowUsersResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
30
30
|
return {
|
|
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
|
+
'my_user_id': !(0, runtime_1.exists)(json, 'my_user_id') ? undefined : json['my_user_id'],
|
|
33
34
|
'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
|
|
34
35
|
'users': !(0, runtime_1.exists)(json, 'users') ? undefined : (json['users'].map(WorkflowUser_1.WorkflowUserFromJSON)),
|
|
35
36
|
'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
|
|
@@ -46,6 +47,7 @@ function WorkflowUsersResponseToJSON(value) {
|
|
|
46
47
|
return {
|
|
47
48
|
'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
|
|
48
49
|
'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
|
|
50
|
+
'my_user_id': value.my_user_id,
|
|
49
51
|
'success': value.success,
|
|
50
52
|
'users': value.users === undefined ? undefined : (value.users.map(WorkflowUser_1.WorkflowUserToJSON)),
|
|
51
53
|
'warning': (0, Warning_1.WarningToJSON)(value.warning),
|
package/dist/models/index.d.ts
CHANGED
|
@@ -830,6 +830,7 @@ export * from './WorkflowGroupsResponse';
|
|
|
830
830
|
export * from './WorkflowNote';
|
|
831
831
|
export * from './WorkflowTask';
|
|
832
832
|
export * from './WorkflowTaskHistory';
|
|
833
|
+
export * from './WorkflowTaskOpenCountResponse';
|
|
833
834
|
export * from './WorkflowTaskResponse';
|
|
834
835
|
export * from './WorkflowTaskTagsResponse';
|
|
835
836
|
export * from './WorkflowTasksRequest';
|
package/dist/models/index.js
CHANGED
|
@@ -848,6 +848,7 @@ __exportStar(require("./WorkflowGroupsResponse"), exports);
|
|
|
848
848
|
__exportStar(require("./WorkflowNote"), exports);
|
|
849
849
|
__exportStar(require("./WorkflowTask"), exports);
|
|
850
850
|
__exportStar(require("./WorkflowTaskHistory"), exports);
|
|
851
|
+
__exportStar(require("./WorkflowTaskOpenCountResponse"), exports);
|
|
851
852
|
__exportStar(require("./WorkflowTaskResponse"), exports);
|
|
852
853
|
__exportStar(require("./WorkflowTaskTagsResponse"), exports);
|
|
853
854
|
__exportStar(require("./WorkflowTasksRequest"), exports);
|
package/package.json
CHANGED
package/src/apis/WorkflowApi.ts
CHANGED
|
@@ -30,6 +30,9 @@ import {
|
|
|
30
30
|
WorkflowTask,
|
|
31
31
|
WorkflowTaskFromJSON,
|
|
32
32
|
WorkflowTaskToJSON,
|
|
33
|
+
WorkflowTaskOpenCountResponse,
|
|
34
|
+
WorkflowTaskOpenCountResponseFromJSON,
|
|
35
|
+
WorkflowTaskOpenCountResponseToJSON,
|
|
33
36
|
WorkflowTaskResponse,
|
|
34
37
|
WorkflowTaskResponseFromJSON,
|
|
35
38
|
WorkflowTaskResponseToJSON,
|
|
@@ -209,6 +212,21 @@ export interface WorkflowApiInterface {
|
|
|
209
212
|
*/
|
|
210
213
|
getWorkflowTaskByObjectType(requestParameters: GetWorkflowTaskByObjectTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTasksResponse>;
|
|
211
214
|
|
|
215
|
+
/**
|
|
216
|
+
* Retrieve workflow task open count
|
|
217
|
+
* @summary Retrieve workflow task open count
|
|
218
|
+
* @param {*} [options] Override http request option.
|
|
219
|
+
* @throws {RequiredError}
|
|
220
|
+
* @memberof WorkflowApiInterface
|
|
221
|
+
*/
|
|
222
|
+
getWorkflowTaskOpenCountRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowTaskOpenCountResponse>>;
|
|
223
|
+
|
|
224
|
+
/**
|
|
225
|
+
* Retrieve workflow task open count
|
|
226
|
+
* Retrieve workflow task open count
|
|
227
|
+
*/
|
|
228
|
+
getWorkflowTaskOpenCount(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTaskOpenCountResponse>;
|
|
229
|
+
|
|
212
230
|
/**
|
|
213
231
|
* Retrieves a unique list of all the existing workflow task tags.
|
|
214
232
|
* @summary Get a list of existing workflow task tags
|
|
@@ -574,6 +592,43 @@ export class WorkflowApi extends runtime.BaseAPI implements WorkflowApiInterface
|
|
|
574
592
|
return await response.value();
|
|
575
593
|
}
|
|
576
594
|
|
|
595
|
+
/**
|
|
596
|
+
* Retrieve workflow task open count
|
|
597
|
+
* Retrieve workflow task open count
|
|
598
|
+
*/
|
|
599
|
+
async getWorkflowTaskOpenCountRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowTaskOpenCountResponse>> {
|
|
600
|
+
const queryParameters: any = {};
|
|
601
|
+
|
|
602
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
603
|
+
|
|
604
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
605
|
+
// oauth required
|
|
606
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["workflow_read"]);
|
|
607
|
+
}
|
|
608
|
+
|
|
609
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
610
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
611
|
+
}
|
|
612
|
+
|
|
613
|
+
const response = await this.request({
|
|
614
|
+
path: `/workflow/tasks/open_count`,
|
|
615
|
+
method: 'GET',
|
|
616
|
+
headers: headerParameters,
|
|
617
|
+
query: queryParameters,
|
|
618
|
+
}, initOverrides);
|
|
619
|
+
|
|
620
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowTaskOpenCountResponseFromJSON(jsonValue));
|
|
621
|
+
}
|
|
622
|
+
|
|
623
|
+
/**
|
|
624
|
+
* Retrieve workflow task open count
|
|
625
|
+
* Retrieve workflow task open count
|
|
626
|
+
*/
|
|
627
|
+
async getWorkflowTaskOpenCount(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowTaskOpenCountResponse> {
|
|
628
|
+
const response = await this.getWorkflowTaskOpenCountRaw(initOverrides);
|
|
629
|
+
return await response.value();
|
|
630
|
+
}
|
|
631
|
+
|
|
577
632
|
/**
|
|
578
633
|
* Retrieves a unique list of all the existing workflow task tags.
|
|
579
634
|
* Get a list of existing workflow task tags
|
|
@@ -368,6 +368,12 @@ export interface ChannelPartnerOrder {
|
|
|
368
368
|
* @memberof ChannelPartnerOrder
|
|
369
369
|
*/
|
|
370
370
|
rotating_transaction_gateway_code?: string;
|
|
371
|
+
/**
|
|
372
|
+
* Sales rep code
|
|
373
|
+
* @type {string}
|
|
374
|
+
* @memberof ChannelPartnerOrder
|
|
375
|
+
*/
|
|
376
|
+
sales_rep_code?: string;
|
|
371
377
|
/**
|
|
372
378
|
* Screen branding theme code
|
|
373
379
|
* @type {string}
|
|
@@ -600,6 +606,7 @@ export function ChannelPartnerOrderFromJSONTyped(json: any, ignoreDiscriminator:
|
|
|
600
606
|
'payment_method': !exists(json, 'payment_method') ? undefined : json['payment_method'],
|
|
601
607
|
'purchase_order_number': !exists(json, 'purchase_order_number') ? undefined : json['purchase_order_number'],
|
|
602
608
|
'rotating_transaction_gateway_code': !exists(json, 'rotating_transaction_gateway_code') ? undefined : json['rotating_transaction_gateway_code'],
|
|
609
|
+
'sales_rep_code': !exists(json, 'sales_rep_code') ? undefined : json['sales_rep_code'],
|
|
603
610
|
'screen_branding_theme_code': !exists(json, 'screen_branding_theme_code') ? undefined : json['screen_branding_theme_code'],
|
|
604
611
|
'ship_on_date': !exists(json, 'ship_on_date') ? undefined : json['ship_on_date'],
|
|
605
612
|
'ship_to_residential': !exists(json, 'ship_to_residential') ? undefined : json['ship_to_residential'],
|
|
@@ -692,6 +699,7 @@ export function ChannelPartnerOrderToJSON(value?: ChannelPartnerOrder | null): a
|
|
|
692
699
|
'payment_method': value.payment_method,
|
|
693
700
|
'purchase_order_number': value.purchase_order_number,
|
|
694
701
|
'rotating_transaction_gateway_code': value.rotating_transaction_gateway_code,
|
|
702
|
+
'sales_rep_code': value.sales_rep_code,
|
|
695
703
|
'screen_branding_theme_code': value.screen_branding_theme_code,
|
|
696
704
|
'ship_on_date': value.ship_on_date,
|
|
697
705
|
'ship_to_residential': value.ship_to_residential,
|
|
@@ -0,0 +1,107 @@
|
|
|
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
|
+
|
|
35
|
+
/**
|
|
36
|
+
*
|
|
37
|
+
* @export
|
|
38
|
+
* @interface WorkflowTaskOpenCountResponse
|
|
39
|
+
*/
|
|
40
|
+
export interface WorkflowTaskOpenCountResponse {
|
|
41
|
+
/**
|
|
42
|
+
*
|
|
43
|
+
* @type {ModelError}
|
|
44
|
+
* @memberof WorkflowTaskOpenCountResponse
|
|
45
|
+
*/
|
|
46
|
+
error?: ModelError;
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @type {ResponseMetadata}
|
|
50
|
+
* @memberof WorkflowTaskOpenCountResponse
|
|
51
|
+
*/
|
|
52
|
+
metadata?: ResponseMetadata;
|
|
53
|
+
/**
|
|
54
|
+
* Open Task Count
|
|
55
|
+
* @type {number}
|
|
56
|
+
* @memberof WorkflowTaskOpenCountResponse
|
|
57
|
+
*/
|
|
58
|
+
open_count?: number;
|
|
59
|
+
/**
|
|
60
|
+
* Indicates if API call was successful
|
|
61
|
+
* @type {boolean}
|
|
62
|
+
* @memberof WorkflowTaskOpenCountResponse
|
|
63
|
+
*/
|
|
64
|
+
success?: boolean;
|
|
65
|
+
/**
|
|
66
|
+
*
|
|
67
|
+
* @type {Warning}
|
|
68
|
+
* @memberof WorkflowTaskOpenCountResponse
|
|
69
|
+
*/
|
|
70
|
+
warning?: Warning;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export function WorkflowTaskOpenCountResponseFromJSON(json: any): WorkflowTaskOpenCountResponse {
|
|
74
|
+
return WorkflowTaskOpenCountResponseFromJSONTyped(json, false);
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export function WorkflowTaskOpenCountResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowTaskOpenCountResponse {
|
|
78
|
+
if ((json === undefined) || (json === null)) {
|
|
79
|
+
return json;
|
|
80
|
+
}
|
|
81
|
+
return {
|
|
82
|
+
|
|
83
|
+
'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
|
|
84
|
+
'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
|
|
85
|
+
'open_count': !exists(json, 'open_count') ? undefined : json['open_count'],
|
|
86
|
+
'success': !exists(json, 'success') ? undefined : json['success'],
|
|
87
|
+
'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
|
|
88
|
+
};
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export function WorkflowTaskOpenCountResponseToJSON(value?: WorkflowTaskOpenCountResponse | null): any {
|
|
92
|
+
if (value === undefined) {
|
|
93
|
+
return undefined;
|
|
94
|
+
}
|
|
95
|
+
if (value === null) {
|
|
96
|
+
return null;
|
|
97
|
+
}
|
|
98
|
+
return {
|
|
99
|
+
|
|
100
|
+
'error': ModelErrorToJSON(value.error),
|
|
101
|
+
'metadata': ResponseMetadataToJSON(value.metadata),
|
|
102
|
+
'open_count': value.open_count,
|
|
103
|
+
'success': value.success,
|
|
104
|
+
'warning': WarningToJSON(value.warning),
|
|
105
|
+
};
|
|
106
|
+
}
|
|
107
|
+
|
|
@@ -56,6 +56,12 @@ export interface WorkflowUsersResponse {
|
|
|
56
56
|
* @memberof WorkflowUsersResponse
|
|
57
57
|
*/
|
|
58
58
|
metadata?: ResponseMetadata;
|
|
59
|
+
/**
|
|
60
|
+
* User ID of myself
|
|
61
|
+
* @type {number}
|
|
62
|
+
* @memberof WorkflowUsersResponse
|
|
63
|
+
*/
|
|
64
|
+
my_user_id?: number;
|
|
59
65
|
/**
|
|
60
66
|
* Indicates if API call was successful
|
|
61
67
|
* @type {boolean}
|
|
@@ -88,6 +94,7 @@ export function WorkflowUsersResponseFromJSONTyped(json: any, ignoreDiscriminato
|
|
|
88
94
|
|
|
89
95
|
'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
|
|
90
96
|
'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
|
|
97
|
+
'my_user_id': !exists(json, 'my_user_id') ? undefined : json['my_user_id'],
|
|
91
98
|
'success': !exists(json, 'success') ? undefined : json['success'],
|
|
92
99
|
'users': !exists(json, 'users') ? undefined : ((json['users'] as Array<any>).map(WorkflowUserFromJSON)),
|
|
93
100
|
'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
|
|
@@ -105,6 +112,7 @@ export function WorkflowUsersResponseToJSON(value?: WorkflowUsersResponse | null
|
|
|
105
112
|
|
|
106
113
|
'error': ModelErrorToJSON(value.error),
|
|
107
114
|
'metadata': ResponseMetadataToJSON(value.metadata),
|
|
115
|
+
'my_user_id': value.my_user_id,
|
|
108
116
|
'success': value.success,
|
|
109
117
|
'users': value.users === undefined ? undefined : ((value.users as Array<any>).map(WorkflowUserToJSON)),
|
|
110
118
|
'warning': WarningToJSON(value.warning),
|
package/src/models/index.ts
CHANGED
|
@@ -832,6 +832,7 @@ export * from './WorkflowGroupsResponse';
|
|
|
832
832
|
export * from './WorkflowNote';
|
|
833
833
|
export * from './WorkflowTask';
|
|
834
834
|
export * from './WorkflowTaskHistory';
|
|
835
|
+
export * from './WorkflowTaskOpenCountResponse';
|
|
835
836
|
export * from './WorkflowTaskResponse';
|
|
836
837
|
export * from './WorkflowTaskTagsResponse';
|
|
837
838
|
export * from './WorkflowTasksRequest';
|