ultracart_rest_api_v2_typescript 4.0.192 → 4.0.194

package/.openapi-generator/FILES

@@ -823,6 +823,7 @@ src/models/WorkflowTaskResponse.ts
 src/models/WorkflowTasksRequest.ts
 src/models/WorkflowTasksResponse.ts
 src/models/WorkflowUser.ts
+src/models/WorkflowUserResponse.ts
 src/models/WorkflowUsersResponse.ts
 src/models/index.ts
 src/runtime.ts

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.192
+## ultracart_rest_api_v2_typescript@4.0.194
 
 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:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.0.192 --save
+npm install ultracart_rest_api_v2_typescript@4.0.194 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.194 | 12/15/2023 | bug fix on bad docs breaking yaml schema |
+| 4.0.193 | 12/12/2023 | webhook - added event ruler property |
 | 4.0.192 | 11/21/2023 | coupons - addl support on tiered amount/percent off items |
 | 4.0.191 | 11/20/2023 | coupon - add item tag support to percent off items and free shipping |
 | 4.0.190 | 11/20/2023 | item.google_product_search.color bugfix for bad length validation: 20 to 100 |

package/dist/apis/WorkflowApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { WorkflowAttachmentUploadUrlResponse, WorkflowGroupsResponse, WorkflowTask, WorkflowTaskResponse, WorkflowTasksRequest, WorkflowTasksResponse, WorkflowUsersResponse } from '../models';
+import { WorkflowAttachmentUploadUrlResponse, WorkflowGroupsResponse, WorkflowTask, WorkflowTaskResponse, WorkflowTasksRequest, WorkflowTasksResponse, WorkflowUserResponse, WorkflowUsersResponse } from '../models';
 export interface GetWorkflowAssignmentGroupsRequest {
     limit?: number;
     offset?: number;
@@ -79,6 +79,19 @@ export interface WorkflowApiInterface {
      * Retrieve a list of users that workflow tasks can be assigned to
      */
     getWorkflowAssignmentUsers(requestParameters: GetWorkflowAssignmentUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowUsersResponse>;
+    /**
+     * Retrieve a user object for myself
+     * @summary Retrieve a user object for myself
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApiInterface
+     */
+    getWorkflowMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowUserResponse>>;
+    /**
+     * Retrieve a user object for myself
+     * Retrieve a user object for myself
+     */
+    getWorkflowMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowUserResponse>;
     /**
      * Retrieve a workflow task
      * @summary Retrieve a workflow task
@@ -193,6 +206,16 @@ export declare class WorkflowApi extends runtime.BaseAPI implements WorkflowApiI
      * Retrieve a list of users that workflow tasks can be assigned to
      */
     getWorkflowAssignmentUsers(requestParameters?: GetWorkflowAssignmentUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowUsersResponse>;
+    /**
+     * Retrieve a user object for myself
+     * Retrieve a user object for myself
+     */
+    getWorkflowMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowUserResponse>>;
+    /**
+     * Retrieve a user object for myself
+     * Retrieve a user object for myself
+     */
+    getWorkflowMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowUserResponse>;
     /**
      * Retrieve a workflow task
      * Retrieve a workflow task

package/dist/apis/WorkflowApi.js

@@ -201,6 +201,62 @@ var WorkflowApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Retrieve a user object for myself
+     * Retrieve a user object for myself
+     */
+    WorkflowApi.prototype.getWorkflowMeRaw = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["workflow_read"])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/workflow/me",
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.WorkflowUserResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieve a user object for myself
+     * Retrieve a user object for myself
+     */
+    WorkflowApi.prototype.getWorkflowMe = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getWorkflowMeRaw(initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Retrieve a workflow task
      * Retrieve a workflow task

package/dist/models/WebhookEventSubscription.d.ts

@@ -45,6 +45,12 @@ export interface WebhookEventSubscription {
      * @memberof WebhookEventSubscription
      */
     event_name?: string;
+    /**
+     * Optional - Event ruler expression to filter events to.  Only events that match this Ruler expression will be transmitted to the webhook.
+     * @type {string}
+     * @memberof WebhookEventSubscription
+     */
+    event_ruler?: string;
     /**
      * The expand string for the notification object.  See the individual resource _expand documentation for valid values.
      * @type {string}

package/dist/models/WebhookEventSubscription.js

@@ -29,6 +29,7 @@ function WebhookEventSubscriptionFromJSONTyped(json, ignoreDiscriminator) {
         'discontinued_flag': !(0, runtime_1.exists)(json, 'discontinued_flag') ? undefined : json['discontinued_flag'],
         'event_description': !(0, runtime_1.exists)(json, 'event_description') ? undefined : json['event_description'],
         'event_name': !(0, runtime_1.exists)(json, 'event_name') ? undefined : json['event_name'],
+        'event_ruler': !(0, runtime_1.exists)(json, 'event_ruler') ? undefined : json['event_ruler'],
         'expansion': !(0, runtime_1.exists)(json, 'expansion') ? undefined : json['expansion'],
         'subscribed': !(0, runtime_1.exists)(json, 'subscribed') ? undefined : json['subscribed'],
         'supports_reflow': !(0, runtime_1.exists)(json, 'supports_reflow') ? undefined : json['supports_reflow'],
@@ -49,6 +50,7 @@ function WebhookEventSubscriptionToJSON(value) {
         'discontinued_flag': value.discontinued_flag,
         'event_description': value.event_description,
         'event_name': value.event_name,
+        'event_ruler': value.event_ruler,
         'expansion': value.expansion,
         'subscribed': value.subscribed,
         'supports_reflow': value.supports_reflow,

package/dist/models/WorkflowUserResponse.d.ts

@@ -0,0 +1,55 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ModelError } from './ModelError';
+import { ResponseMetadata } from './ResponseMetadata';
+import { Warning } from './Warning';
+import { WorkflowUser } from './WorkflowUser';
+/**
+ *
+ * @export
+ * @interface WorkflowUserResponse
+ */
+export interface WorkflowUserResponse {
+    /**
+     *
+     * @type {ModelError}
+     * @memberof WorkflowUserResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof WorkflowUserResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof WorkflowUserResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {WorkflowUser}
+     * @memberof WorkflowUserResponse
+     */
+    user?: WorkflowUser;
+    /**
+     *
+     * @type {Warning}
+     * @memberof WorkflowUserResponse
+     */
+    warning?: Warning;
+}
+export declare function WorkflowUserResponseFromJSON(json: any): WorkflowUserResponse;
+export declare function WorkflowUserResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowUserResponse;
+export declare function WorkflowUserResponseToJSON(value?: WorkflowUserResponse | null): any;

package/dist/models/WorkflowUserResponse.js

@@ -0,0 +1,54 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowUserResponseToJSON = exports.WorkflowUserResponseFromJSONTyped = exports.WorkflowUserResponseFromJSON = void 0;
+var runtime_1 = require("../runtime");
+var ModelError_1 = require("./ModelError");
+var ResponseMetadata_1 = require("./ResponseMetadata");
+var Warning_1 = require("./Warning");
+var WorkflowUser_1 = require("./WorkflowUser");
+function WorkflowUserResponseFromJSON(json) {
+    return WorkflowUserResponseFromJSONTyped(json, false);
+}
+exports.WorkflowUserResponseFromJSON = WorkflowUserResponseFromJSON;
+function WorkflowUserResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
+        'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
+        'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
+        'user': !(0, runtime_1.exists)(json, 'user') ? undefined : (0, WorkflowUser_1.WorkflowUserFromJSON)(json['user']),
+        'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
+    };
+}
+exports.WorkflowUserResponseFromJSONTyped = WorkflowUserResponseFromJSONTyped;
+function WorkflowUserResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
+        'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
+        'success': value.success,
+        'user': (0, WorkflowUser_1.WorkflowUserToJSON)(value.user),
+        'warning': (0, Warning_1.WarningToJSON)(value.warning),
+    };
+}
+exports.WorkflowUserResponseToJSON = WorkflowUserResponseToJSON;

package/dist/models/index.d.ts

@@ -796,4 +796,5 @@ export * from './WorkflowTaskResponse';
 export * from './WorkflowTasksRequest';
 export * from './WorkflowTasksResponse';
 export * from './WorkflowUser';
+export * from './WorkflowUserResponse';
 export * from './WorkflowUsersResponse';

package/dist/models/index.js

@@ -814,4 +814,5 @@ __exportStar(require("./WorkflowTaskResponse"), exports);
 __exportStar(require("./WorkflowTasksRequest"), exports);
 __exportStar(require("./WorkflowTasksResponse"), exports);
 __exportStar(require("./WorkflowUser"), exports);
+__exportStar(require("./WorkflowUserResponse"), exports);
 __exportStar(require("./WorkflowUsersResponse"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.0.192",
+  "version": "4.0.194",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/apis/WorkflowApi.ts

@@ -36,6 +36,9 @@ import {
     WorkflowTasksResponse,
     WorkflowTasksResponseFromJSON,
     WorkflowTasksResponseToJSON,
+    WorkflowUserResponse,
+    WorkflowUserResponseFromJSON,
+    WorkflowUserResponseToJSON,
     WorkflowUsersResponse,
     WorkflowUsersResponseFromJSON,
     WorkflowUsersResponseToJSON,
@@ -121,6 +124,21 @@ export interface WorkflowApiInterface {
      */
     getWorkflowAssignmentUsers(requestParameters: GetWorkflowAssignmentUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowUsersResponse>;
 
+    /**
+     * Retrieve a user object for myself 
+     * @summary Retrieve a user object for myself
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowApiInterface
+     */
+    getWorkflowMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowUserResponse>>;
+
+    /**
+     * Retrieve a user object for myself 
+     * Retrieve a user object for myself
+     */
+    getWorkflowMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowUserResponse>;
+
     /**
      * Retrieve a workflow task 
      * @summary Retrieve a workflow task
@@ -319,6 +337,43 @@ export class WorkflowApi extends runtime.BaseAPI implements WorkflowApiInterface
         return await response.value();
     }
 
+    /**
+     * Retrieve a user object for myself 
+     * Retrieve a user object for myself
+     */
+    async getWorkflowMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowUserResponse>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["workflow_read"]);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const response = await this.request({
+            path: `/workflow/me`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowUserResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve a user object for myself 
+     * Retrieve a user object for myself
+     */
+    async getWorkflowMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowUserResponse> {
+        const response = await this.getWorkflowMeRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Retrieve a workflow task 
      * Retrieve a workflow task

package/src/models/WebhookEventSubscription.ts

@@ -49,6 +49,12 @@ export interface WebhookEventSubscription {
      * @memberof WebhookEventSubscription
      */
     event_name?: string;
+    /**
+     * Optional - Event ruler expression to filter events to.  Only events that match this Ruler expression will be transmitted to the webhook.
+     * @type {string}
+     * @memberof WebhookEventSubscription
+     */
+    event_ruler?: string;
     /**
      * The expand string for the notification object.  See the individual resource _expand documentation for valid values.
      * @type {string}
@@ -90,6 +96,7 @@ export function WebhookEventSubscriptionFromJSONTyped(json: any, ignoreDiscrimin
         'discontinued_flag': !exists(json, 'discontinued_flag') ? undefined : json['discontinued_flag'],
         'event_description': !exists(json, 'event_description') ? undefined : json['event_description'],
         'event_name': !exists(json, 'event_name') ? undefined : json['event_name'],
+        'event_ruler': !exists(json, 'event_ruler') ? undefined : json['event_ruler'],
         'expansion': !exists(json, 'expansion') ? undefined : json['expansion'],
         'subscribed': !exists(json, 'subscribed') ? undefined : json['subscribed'],
         'supports_reflow': !exists(json, 'supports_reflow') ? undefined : json['supports_reflow'],
@@ -111,6 +118,7 @@ export function WebhookEventSubscriptionToJSON(value?: WebhookEventSubscription
         'discontinued_flag': value.discontinued_flag,
         'event_description': value.event_description,
         'event_name': value.event_name,
+        'event_ruler': value.event_ruler,
         'expansion': value.expansion,
         'subscribed': value.subscribed,
         'supports_reflow': value.supports_reflow,

package/src/models/WorkflowUserResponse.ts

@@ -0,0 +1,113 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    ModelError,
+    ModelErrorFromJSON,
+    ModelErrorFromJSONTyped,
+    ModelErrorToJSON,
+} from './ModelError';
+import {
+    ResponseMetadata,
+    ResponseMetadataFromJSON,
+    ResponseMetadataFromJSONTyped,
+    ResponseMetadataToJSON,
+} from './ResponseMetadata';
+import {
+    Warning,
+    WarningFromJSON,
+    WarningFromJSONTyped,
+    WarningToJSON,
+} from './Warning';
+import {
+    WorkflowUser,
+    WorkflowUserFromJSON,
+    WorkflowUserFromJSONTyped,
+    WorkflowUserToJSON,
+} from './WorkflowUser';
+
+/**
+ * 
+ * @export
+ * @interface WorkflowUserResponse
+ */
+export interface WorkflowUserResponse {
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof WorkflowUserResponse
+     */
+    error?: ModelError;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof WorkflowUserResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof WorkflowUserResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {WorkflowUser}
+     * @memberof WorkflowUserResponse
+     */
+    user?: WorkflowUser;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof WorkflowUserResponse
+     */
+    warning?: Warning;
+}
+
+export function WorkflowUserResponseFromJSON(json: any): WorkflowUserResponse {
+    return WorkflowUserResponseFromJSONTyped(json, false);
+}
+
+export function WorkflowUserResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowUserResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
+        'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
+        'success': !exists(json, 'success') ? undefined : json['success'],
+        'user': !exists(json, 'user') ? undefined : WorkflowUserFromJSON(json['user']),
+        'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
+    };
+}
+
+export function WorkflowUserResponseToJSON(value?: WorkflowUserResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'error': ModelErrorToJSON(value.error),
+        'metadata': ResponseMetadataToJSON(value.metadata),
+        'success': value.success,
+        'user': WorkflowUserToJSON(value.user),
+        'warning': WarningToJSON(value.warning),
+    };
+}
+

package/src/models/index.ts

@@ -798,4 +798,5 @@ export * from './WorkflowTaskResponse';
 export * from './WorkflowTasksRequest';
 export * from './WorkflowTasksResponse';
 export * from './WorkflowUser';
+export * from './WorkflowUserResponse';
 export * from './WorkflowUsersResponse';