ultracart_rest_api_v2_typescript 4.0.154 → 4.0.155

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.154
+## ultracart_rest_api_v2_typescript@4.0.155
 
 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.154 --save
+npm install ultracart_rest_api_v2_typescript@4.0.155 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.155 | 05/18/2023 | dw bi - send back the executed SQL |
 | 4.0.154 | 05/04/2023 | item api added methods for items reviews |
 | 4.0.153 | 04/28/2023 | item - pricing tier level flag for exempt from min item count |
 | 4.0.152 | 04/27/2023 | order - expose dual vaulted identifiers |

package/dist/apis/ItemApi.d.ts

@@ -275,7 +275,7 @@ export interface ItemApiInterface {
     getPricingTiers(requestParameters: GetPricingTiersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PricingTiersResponse>;
     /**
      * Retrieve an item review.
-     * @summary get a review
+     * @summary Get a review
      * @param {number} reviewOid The review oid to retrieve.
      * @param {number} merchantItemOid The item oid the review is associated with.
      * @param {*} [options] Override http request option.
@@ -285,12 +285,12 @@ export interface ItemApiInterface {
     getReviewRaw(requestParameters: GetReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemReviewResponse>>;
     /**
      * Retrieve an item review.
-     * get a review
+     * Get a review
      */
     getReview(requestParameters: GetReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemReviewResponse>;
     /**
      * Retrieve item reviews.
-     * @summary get reviews for an item
+     * @summary Get reviews for an item
      * @param {number} merchantItemOid The item oid the review is associated with.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -299,7 +299,7 @@ export interface ItemApiInterface {
     getReviewsRaw(requestParameters: GetReviewsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemReviewsResponse>>;
     /**
      * Retrieve item reviews.
-     * get reviews for an item
+     * Get reviews for an item
      */
     getReviews(requestParameters: GetReviewsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemReviewsResponse>;
     /**
@@ -552,22 +552,22 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
     getPricingTiers(requestParameters?: GetPricingTiersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PricingTiersResponse>;
     /**
      * Retrieve an item review.
-     * get a review
+     * Get a review
      */
     getReviewRaw(requestParameters: GetReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemReviewResponse>>;
     /**
      * Retrieve an item review.
-     * get a review
+     * Get a review
      */
     getReview(requestParameters: GetReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemReviewResponse>;
     /**
      * Retrieve item reviews.
-     * get reviews for an item
+     * Get reviews for an item
      */
     getReviewsRaw(requestParameters: GetReviewsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemReviewsResponse>>;
     /**
      * Retrieve item reviews.
-     * get reviews for an item
+     * Get reviews for an item
      */
     getReviews(requestParameters: GetReviewsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemReviewsResponse>;
     /**

package/dist/apis/ItemApi.js

@@ -715,7 +715,7 @@ var ItemApi = /** @class */ (function (_super) {
     };
     /**
      * Retrieve an item review.
-     * get a review
+     * Get a review
      */
     ItemApi.prototype.getReviewRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -759,7 +759,7 @@ var ItemApi = /** @class */ (function (_super) {
     };
     /**
      * Retrieve an item review.
-     * get a review
+     * Get a review
      */
     ItemApi.prototype.getReview = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -777,7 +777,7 @@ var ItemApi = /** @class */ (function (_super) {
     };
     /**
      * Retrieve item reviews.
-     * get reviews for an item
+     * Get reviews for an item
      */
     ItemApi.prototype.getReviewsRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -818,7 +818,7 @@ var ItemApi = /** @class */ (function (_super) {
     };
     /**
      * Retrieve item reviews.
-     * get reviews for an item
+     * Get reviews for an item
      */
     ItemApi.prototype.getReviews = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {

package/dist/models/AutoOrderItem.d.ts

@@ -60,6 +60,12 @@ export interface AutoOrderItem {
      * @memberof AutoOrderItem
      */
     auto_order_item_oid?: number;
+    /**
+     * Date/time of the first order of this item.  Null if item added to auto order and has not been rebilled yet.
+     * @type {string}
+     * @memberof AutoOrderItem
+     */
+    first_order_dts?: string;
     /**
      * Frequency of the rebill if not a fixed schedule
      * @type {string}
@@ -126,6 +132,12 @@ export interface AutoOrderItem {
      * @memberof AutoOrderItem
      */
     original_quantity?: number;
+    /**
+     * True if paused.  This field is an object instead of a primitive for backwards compatibility.
+     * @type {boolean}
+     * @memberof AutoOrderItem
+     */
+    paused?: boolean;
     /**
      * The PayPal Payer ID tied to this item
      * @type {string}

package/dist/models/AutoOrderItem.js

@@ -52,6 +52,7 @@ function AutoOrderItemFromJSONTyped(json, ignoreDiscriminator) {
         'arbitrary_unit_cost': !(0, runtime_1.exists)(json, 'arbitrary_unit_cost') ? undefined : json['arbitrary_unit_cost'],
         'arbitrary_unit_cost_remaining_orders': !(0, runtime_1.exists)(json, 'arbitrary_unit_cost_remaining_orders') ? undefined : json['arbitrary_unit_cost_remaining_orders'],
         'auto_order_item_oid': !(0, runtime_1.exists)(json, 'auto_order_item_oid') ? undefined : json['auto_order_item_oid'],
+        'first_order_dts': !(0, runtime_1.exists)(json, 'first_order_dts') ? undefined : json['first_order_dts'],
         'frequency': !(0, runtime_1.exists)(json, 'frequency') ? undefined : json['frequency'],
         'future_schedules': !(0, runtime_1.exists)(json, 'future_schedules') ? undefined : (json['future_schedules'].map(AutoOrderItemFutureSchedule_1.AutoOrderItemFutureScheduleFromJSON)),
         'last_order_dts': !(0, runtime_1.exists)(json, 'last_order_dts') ? undefined : json['last_order_dts'],
@@ -63,6 +64,7 @@ function AutoOrderItemFromJSONTyped(json, ignoreDiscriminator) {
         'options': !(0, runtime_1.exists)(json, 'options') ? undefined : (json['options'].map(AutoOrderItemOption_1.AutoOrderItemOptionFromJSON)),
         'original_item_id': !(0, runtime_1.exists)(json, 'original_item_id') ? undefined : json['original_item_id'],
         'original_quantity': !(0, runtime_1.exists)(json, 'original_quantity') ? undefined : json['original_quantity'],
+        'paused': !(0, runtime_1.exists)(json, 'paused') ? undefined : json['paused'],
         'paypal_payer_id': !(0, runtime_1.exists)(json, 'paypal_payer_id') ? undefined : json['paypal_payer_id'],
         'paypal_recurring_payment_profile_id': !(0, runtime_1.exists)(json, 'paypal_recurring_payment_profile_id') ? undefined : json['paypal_recurring_payment_profile_id'],
         'preshipment_notice_sent': !(0, runtime_1.exists)(json, 'preshipment_notice_sent') ? undefined : json['preshipment_notice_sent'],
@@ -87,6 +89,7 @@ function AutoOrderItemToJSON(value) {
         'arbitrary_unit_cost': value.arbitrary_unit_cost,
         'arbitrary_unit_cost_remaining_orders': value.arbitrary_unit_cost_remaining_orders,
         'auto_order_item_oid': value.auto_order_item_oid,
+        'first_order_dts': value.first_order_dts,
         'frequency': value.frequency,
         'future_schedules': value.future_schedules === undefined ? undefined : (value.future_schedules.map(AutoOrderItemFutureSchedule_1.AutoOrderItemFutureScheduleToJSON)),
         'last_order_dts': value.last_order_dts,
@@ -98,6 +101,7 @@ function AutoOrderItemToJSON(value) {
         'options': value.options === undefined ? undefined : (value.options.map(AutoOrderItemOption_1.AutoOrderItemOptionToJSON)),
         'original_item_id': value.original_item_id,
         'original_quantity': value.original_quantity,
+        'paused': value.paused,
         'paypal_payer_id': value.paypal_payer_id,
         'paypal_recurring_payment_profile_id': value.paypal_recurring_payment_profile_id,
         'preshipment_notice_sent': value.preshipment_notice_sent,

package/dist/models/ItemPricingTierLimit.d.ts

@@ -39,6 +39,12 @@ export interface ItemPricingTierLimit {
      * @memberof ItemPricingTierLimit
      */
     multiple_quantity?: number;
+    /**
+     * Payment method validity
+     * @type {Array<string>}
+     * @memberof ItemPricingTierLimit
+     */
+    payment_method_validity?: Array<string>;
 }
 export declare function ItemPricingTierLimitFromJSON(json: any): ItemPricingTierLimit;
 export declare function ItemPricingTierLimitFromJSONTyped(json: any, ignoreDiscriminator: boolean): ItemPricingTierLimit;

package/dist/models/ItemPricingTierLimit.js

@@ -28,6 +28,7 @@ function ItemPricingTierLimitFromJSONTyped(json, ignoreDiscriminator) {
         'exempt_from_minimum_item_count': !(0, runtime_1.exists)(json, 'exempt_from_minimum_item_count') ? undefined : json['exempt_from_minimum_item_count'],
         'individual_order_limit': !(0, runtime_1.exists)(json, 'individual_order_limit') ? undefined : json['individual_order_limit'],
         'multiple_quantity': !(0, runtime_1.exists)(json, 'multiple_quantity') ? undefined : json['multiple_quantity'],
+        'payment_method_validity': !(0, runtime_1.exists)(json, 'payment_method_validity') ? undefined : json['payment_method_validity'],
     };
 }
 exports.ItemPricingTierLimitFromJSONTyped = ItemPricingTierLimitFromJSONTyped;
@@ -43,6 +44,7 @@ function ItemPricingTierLimitToJSON(value) {
         'exempt_from_minimum_item_count': value.exempt_from_minimum_item_count,
         'individual_order_limit': value.individual_order_limit,
         'multiple_quantity': value.multiple_quantity,
+        'payment_method_validity': value.payment_method_validity,
     };
 }
 exports.ItemPricingTierLimitToJSON = ItemPricingTierLimitToJSON;

package/dist/models/ReportDataSet.d.ts

@@ -41,6 +41,12 @@ export interface ReportDataSet {
      * @memberof ReportDataSet
      */
     error_message?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportDataSet
+     */
+    executed_sql?: string;
     /**
      * An identifier that can be used to help match up the returned data set
      * @type {string}

package/dist/models/ReportDataSet.js

@@ -38,6 +38,7 @@ function ReportDataSetFromJSONTyped(json, ignoreDiscriminator) {
         'data_set_uuid': !(0, runtime_1.exists)(json, 'data_set_uuid') ? undefined : json['data_set_uuid'],
         'destination_table_id': !(0, runtime_1.exists)(json, 'destination_table_id') ? undefined : json['destination_table_id'],
         'error_message': !(0, runtime_1.exists)(json, 'error_message') ? undefined : json['error_message'],
+        'executed_sql': !(0, runtime_1.exists)(json, 'executed_sql') ? undefined : json['executed_sql'],
         'for_object_id': !(0, runtime_1.exists)(json, 'for_object_id') ? undefined : json['for_object_id'],
         'for_object_type': !(0, runtime_1.exists)(json, 'for_object_type') ? undefined : json['for_object_type'],
         'initial_pages': !(0, runtime_1.exists)(json, 'initial_pages') ? undefined : (json['initial_pages'].map(ReportDataSetPage_1.ReportDataSetPageFromJSON)),
@@ -64,6 +65,7 @@ function ReportDataSetToJSON(value) {
         'data_set_uuid': value.data_set_uuid,
         'destination_table_id': value.destination_table_id,
         'error_message': value.error_message,
+        'executed_sql': value.executed_sql,
         'for_object_id': value.for_object_id,
         'for_object_type': value.for_object_type,
         'initial_pages': value.initial_pages === undefined ? undefined : (value.initial_pages.map(ReportDataSetPage_1.ReportDataSetPageToJSON)),

package/package.json

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

package/src/apis/ItemApi.ts

@@ -361,7 +361,7 @@ export interface ItemApiInterface {
 
     /**
      * Retrieve an item review. 
-     * @summary get a review
+     * @summary Get a review
      * @param {number} reviewOid The review oid to retrieve.
      * @param {number} merchantItemOid The item oid the review is associated with.
      * @param {*} [options] Override http request option.
@@ -372,13 +372,13 @@ export interface ItemApiInterface {
 
     /**
      * Retrieve an item review. 
-     * get a review
+     * Get a review
      */
     getReview(requestParameters: GetReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemReviewResponse>;
 
     /**
      * Retrieve item reviews. 
-     * @summary get reviews for an item
+     * @summary Get reviews for an item
      * @param {number} merchantItemOid The item oid the review is associated with.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -388,7 +388,7 @@ export interface ItemApiInterface {
 
     /**
      * Retrieve item reviews. 
-     * get reviews for an item
+     * Get reviews for an item
      */
     getReviews(requestParameters: GetReviewsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemReviewsResponse>;
 
@@ -1037,7 +1037,7 @@ export class ItemApi extends runtime.BaseAPI implements ItemApiInterface {
 
     /**
      * Retrieve an item review. 
-     * get a review
+     * Get a review
      */
     async getReviewRaw(requestParameters: GetReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemReviewResponse>> {
         if (requestParameters.reviewOid === null || requestParameters.reviewOid === undefined) {
@@ -1073,7 +1073,7 @@ export class ItemApi extends runtime.BaseAPI implements ItemApiInterface {
 
     /**
      * Retrieve an item review. 
-     * get a review
+     * Get a review
      */
     async getReview(requestParameters: GetReviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemReviewResponse> {
         const response = await this.getReviewRaw(requestParameters, initOverrides);
@@ -1082,7 +1082,7 @@ export class ItemApi extends runtime.BaseAPI implements ItemApiInterface {
 
     /**
      * Retrieve item reviews. 
-     * get reviews for an item
+     * Get reviews for an item
      */
     async getReviewsRaw(requestParameters: GetReviewsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemReviewsResponse>> {
         if (requestParameters.merchantItemOid === null || requestParameters.merchantItemOid === undefined) {
@@ -1114,7 +1114,7 @@ export class ItemApi extends runtime.BaseAPI implements ItemApiInterface {
 
     /**
      * Retrieve item reviews. 
-     * get reviews for an item
+     * Get reviews for an item
      */
     async getReviews(requestParameters: GetReviewsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemReviewsResponse> {
         const response = await this.getReviewsRaw(requestParameters, initOverrides);

package/src/models/AutoOrderItem.ts

@@ -80,6 +80,12 @@ export interface AutoOrderItem {
      * @memberof AutoOrderItem
      */
     auto_order_item_oid?: number;
+    /**
+     * Date/time of the first order of this item.  Null if item added to auto order and has not been rebilled yet.
+     * @type {string}
+     * @memberof AutoOrderItem
+     */
+    first_order_dts?: string;
     /**
      * Frequency of the rebill if not a fixed schedule
      * @type {string}
@@ -146,6 +152,12 @@ export interface AutoOrderItem {
      * @memberof AutoOrderItem
      */
     original_quantity?: number;
+    /**
+     * True if paused.  This field is an object instead of a primitive for backwards compatibility.
+     * @type {boolean}
+     * @memberof AutoOrderItem
+     */
+    paused?: boolean;
     /**
      * The PayPal Payer ID tied to this item
      * @type {string}
@@ -223,6 +235,7 @@ export function AutoOrderItemFromJSONTyped(json: any, ignoreDiscriminator: boole
         'arbitrary_unit_cost': !exists(json, 'arbitrary_unit_cost') ? undefined : json['arbitrary_unit_cost'],
         'arbitrary_unit_cost_remaining_orders': !exists(json, 'arbitrary_unit_cost_remaining_orders') ? undefined : json['arbitrary_unit_cost_remaining_orders'],
         'auto_order_item_oid': !exists(json, 'auto_order_item_oid') ? undefined : json['auto_order_item_oid'],
+        'first_order_dts': !exists(json, 'first_order_dts') ? undefined : json['first_order_dts'],
         'frequency': !exists(json, 'frequency') ? undefined : json['frequency'],
         'future_schedules': !exists(json, 'future_schedules') ? undefined : ((json['future_schedules'] as Array<any>).map(AutoOrderItemFutureScheduleFromJSON)),
         'last_order_dts': !exists(json, 'last_order_dts') ? undefined : json['last_order_dts'],
@@ -234,6 +247,7 @@ export function AutoOrderItemFromJSONTyped(json: any, ignoreDiscriminator: boole
         'options': !exists(json, 'options') ? undefined : ((json['options'] as Array<any>).map(AutoOrderItemOptionFromJSON)),
         'original_item_id': !exists(json, 'original_item_id') ? undefined : json['original_item_id'],
         'original_quantity': !exists(json, 'original_quantity') ? undefined : json['original_quantity'],
+        'paused': !exists(json, 'paused') ? undefined : json['paused'],
         'paypal_payer_id': !exists(json, 'paypal_payer_id') ? undefined : json['paypal_payer_id'],
         'paypal_recurring_payment_profile_id': !exists(json, 'paypal_recurring_payment_profile_id') ? undefined : json['paypal_recurring_payment_profile_id'],
         'preshipment_notice_sent': !exists(json, 'preshipment_notice_sent') ? undefined : json['preshipment_notice_sent'],
@@ -259,6 +273,7 @@ export function AutoOrderItemToJSON(value?: AutoOrderItem | null): any {
         'arbitrary_unit_cost': value.arbitrary_unit_cost,
         'arbitrary_unit_cost_remaining_orders': value.arbitrary_unit_cost_remaining_orders,
         'auto_order_item_oid': value.auto_order_item_oid,
+        'first_order_dts': value.first_order_dts,
         'frequency': value.frequency,
         'future_schedules': value.future_schedules === undefined ? undefined : ((value.future_schedules as Array<any>).map(AutoOrderItemFutureScheduleToJSON)),
         'last_order_dts': value.last_order_dts,
@@ -270,6 +285,7 @@ export function AutoOrderItemToJSON(value?: AutoOrderItem | null): any {
         'options': value.options === undefined ? undefined : ((value.options as Array<any>).map(AutoOrderItemOptionToJSON)),
         'original_item_id': value.original_item_id,
         'original_quantity': value.original_quantity,
+        'paused': value.paused,
         'paypal_payer_id': value.paypal_payer_id,
         'paypal_recurring_payment_profile_id': value.paypal_recurring_payment_profile_id,
         'preshipment_notice_sent': value.preshipment_notice_sent,

package/src/models/ItemPricingTierLimit.ts

@@ -43,6 +43,12 @@ export interface ItemPricingTierLimit {
      * @memberof ItemPricingTierLimit
      */
     multiple_quantity?: number;
+    /**
+     * Payment method validity
+     * @type {Array<string>}
+     * @memberof ItemPricingTierLimit
+     */
+    payment_method_validity?: Array<string>;
 }
 
 export function ItemPricingTierLimitFromJSON(json: any): ItemPricingTierLimit {
@@ -59,6 +65,7 @@ export function ItemPricingTierLimitFromJSONTyped(json: any, ignoreDiscriminator
         'exempt_from_minimum_item_count': !exists(json, 'exempt_from_minimum_item_count') ? undefined : json['exempt_from_minimum_item_count'],
         'individual_order_limit': !exists(json, 'individual_order_limit') ? undefined : json['individual_order_limit'],
         'multiple_quantity': !exists(json, 'multiple_quantity') ? undefined : json['multiple_quantity'],
+        'payment_method_validity': !exists(json, 'payment_method_validity') ? undefined : json['payment_method_validity'],
     };
 }
 
@@ -75,6 +82,7 @@ export function ItemPricingTierLimitToJSON(value?: ItemPricingTierLimit | null):
         'exempt_from_minimum_item_count': value.exempt_from_minimum_item_count,
         'individual_order_limit': value.individual_order_limit,
         'multiple_quantity': value.multiple_quantity,
+        'payment_method_validity': value.payment_method_validity,
     };
 }
 

package/src/models/ReportDataSet.ts

@@ -56,6 +56,12 @@ export interface ReportDataSet {
      * @memberof ReportDataSet
      */
     error_message?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReportDataSet
+     */
+    executed_sql?: string;
     /**
      * An identifier that can be used to help match up the returned data set
      * @type {string}
@@ -150,6 +156,7 @@ export function ReportDataSetFromJSONTyped(json: any, ignoreDiscriminator: boole
         'data_set_uuid': !exists(json, 'data_set_uuid') ? undefined : json['data_set_uuid'],
         'destination_table_id': !exists(json, 'destination_table_id') ? undefined : json['destination_table_id'],
         'error_message': !exists(json, 'error_message') ? undefined : json['error_message'],
+        'executed_sql': !exists(json, 'executed_sql') ? undefined : json['executed_sql'],
         'for_object_id': !exists(json, 'for_object_id') ? undefined : json['for_object_id'],
         'for_object_type': !exists(json, 'for_object_type') ? undefined : json['for_object_type'],
         'initial_pages': !exists(json, 'initial_pages') ? undefined : ((json['initial_pages'] as Array<any>).map(ReportDataSetPageFromJSON)),
@@ -177,6 +184,7 @@ export function ReportDataSetToJSON(value?: ReportDataSet | null): any {
         'data_set_uuid': value.data_set_uuid,
         'destination_table_id': value.destination_table_id,
         'error_message': value.error_message,
+        'executed_sql': value.executed_sql,
         'for_object_id': value.for_object_id,
         'for_object_type': value.for_object_type,
         'initial_pages': value.initial_pages === undefined ? undefined : ((value.initial_pages as Array<any>).map(ReportDataSetPageToJSON)),