ultracart_rest_api_v2_typescript 4.1.122 → 4.1.124

package/.openapi-generator/FILES

@@ -465,6 +465,9 @@ src/models/CustomerEDI.ts
 src/models/CustomerEditorValues.ts
 src/models/CustomerEmail.ts
 src/models/CustomerEmailListChanges.ts
+src/models/CustomerEmailSuppressionRequest.ts
+src/models/CustomerEmailSuppressionResponse.ts
+src/models/CustomerEmailSuppressionResult.ts
 src/models/CustomerLoyalty.ts
 src/models/CustomerLoyaltyLedger.ts
 src/models/CustomerLoyaltyRedemption.ts
@@ -612,6 +615,7 @@ src/models/EmailStepStatRequest.ts
 src/models/EmailStepStatResponse.ts
 src/models/EmailStepWaitingRequest.ts
 src/models/EmailStepWaitingResponse.ts
+src/models/EmailSuppressionSurfaces.ts
 src/models/EmailTemplate.ts
 src/models/EmailTemplatesResponse.ts
 src/models/EmailThirdPartyList.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.122
+## ultracart_rest_api_v2_typescript@4.1.124
 
 Every API method call has a sample for every language SDK.  See https://github.com/UltraCart/sdk_samples
 
 Installation
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.1.122 --save
+npm install ultracart_rest_api_v2_typescript@4.1.124 --save
 ```
 
 ```typescript
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.124 | 08/04/2026 | customer - method to remove customer profile from email suppression |
+| 4.1.123 | 08/04/2026 | customer - method to remove customer profile from email suppression |
 | 4.1.122 | 07/29/2026 | auto order api - new methods for payment information and rebill |
 | 4.1.121 | 07/15/2026 | storefront - parameter to include details on dispatch log methods |
 | 4.1.120 | 07/15/2026 | storefront - parameter to include details on dispatch log methods |

package/dist/apis/CustomerApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { AdjustInternalCertificateRequest, AdjustInternalCertificateResponse, BaseResponse, Customer, CustomerEditorValues, CustomerEmailListChanges, CustomerMagicLinkResponse, CustomerMergeRequest, CustomerQuery, CustomerResponse, CustomerStoreCreditAddRequest, CustomerStoreCreditResponse, CustomerWishListItem, CustomerWishListItemResponse, CustomerWishListItemsResponse, CustomersResponse, DataTablesServerSideResponse, EmailListsResponse, EmailVerifyTokenRequest, EmailVerifyTokenResponse, EmailVerifyTokenValidateRequest, EmailVerifyTokenValidateResponse, LookupRequest, LookupResponse, QuickBooksOnlineCustomersResponse } from '../models';
+import { AdjustInternalCertificateRequest, AdjustInternalCertificateResponse, BaseResponse, Customer, CustomerEditorValues, CustomerEmailListChanges, CustomerEmailSuppressionRequest, CustomerEmailSuppressionResponse, CustomerMagicLinkResponse, CustomerMergeRequest, CustomerQuery, CustomerResponse, CustomerStoreCreditAddRequest, CustomerStoreCreditResponse, CustomerWishListItem, CustomerWishListItemResponse, CustomerWishListItemsResponse, CustomersResponse, DataTablesServerSideResponse, EmailListsResponse, EmailVerifyTokenRequest, EmailVerifyTokenResponse, EmailVerifyTokenValidateRequest, EmailVerifyTokenValidateResponse, LookupRequest, LookupResponse, QuickBooksOnlineCustomersResponse } from '../models';
 export interface AddCustomerStoreCreditRequest {
     customerProfileOid: number;
     storeCreditRequest: CustomerStoreCreditAddRequest;
@@ -134,6 +134,10 @@ export interface UpdateCustomerEmailListsRequest {
     customerProfileOid: number;
     listChanges: CustomerEmailListChanges;
 }
+export interface UpdateCustomerEmailSuppressionRequest {
+    customerProfileOid: number;
+    suppressionChanges: CustomerEmailSuppressionRequest;
+}
 export interface UpdateWishListItemRequest {
     customerProfileOid: number;
     customerWishlistItemOid: number;
@@ -539,6 +543,21 @@ export interface CustomerApiInterface {
      * Update email list subscriptions for a customer
      */
     updateCustomerEmailLists(requestParameters: UpdateCustomerEmailListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomerEmailListChanges>;
+    /**
+     * Clears global unsubscribe, spam complaint and/or bounce suppression for a customer.  This method is clear-only and cannot set a suppression flag.  Clearing a suppression removes the send gate but does not subscribe the customer to any email list -- list membership survives a global unsubscribe untouched, so the customer\'s original lists become deliverable again with no further action.  Returns 200 with a warning if the flags were cleared but an upstream ESP suppression removal failed; the profile was still modified in that case.
+     * @summary Clear email suppression for a customer
+     * @param {number} customerProfileOid The customer profile oid
+     * @param {CustomerEmailSuppressionRequest} suppressionChanges Suppression changes
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApiInterface
+     */
+    updateCustomerEmailSuppressionRaw(requestParameters: UpdateCustomerEmailSuppressionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomerEmailSuppressionResponse>>;
+    /**
+     * Clears global unsubscribe, spam complaint and/or bounce suppression for a customer.  This method is clear-only and cannot set a suppression flag.  Clearing a suppression removes the send gate but does not subscribe the customer to any email list -- list membership survives a global unsubscribe untouched, so the customer\'s original lists become deliverable again with no further action.  Returns 200 with a warning if the flags were cleared but an upstream ESP suppression removal failed; the profile was still modified in that case.
+     * Clear email suppression for a customer
+     */
+    updateCustomerEmailSuppression(requestParameters: UpdateCustomerEmailSuppressionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomerEmailSuppressionResponse>;
     /**
      * Update a customer wishlist item
      * @summary Update a customer wishlist item
@@ -812,6 +831,16 @@ export declare class CustomerApi extends runtime.BaseAPI implements CustomerApiI
      * Update email list subscriptions for a customer
      */
     updateCustomerEmailLists(requestParameters: UpdateCustomerEmailListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomerEmailListChanges>;
+    /**
+     * Clears global unsubscribe, spam complaint and/or bounce suppression for a customer.  This method is clear-only and cannot set a suppression flag.  Clearing a suppression removes the send gate but does not subscribe the customer to any email list -- list membership survives a global unsubscribe untouched, so the customer\'s original lists become deliverable again with no further action.  Returns 200 with a warning if the flags were cleared but an upstream ESP suppression removal failed; the profile was still modified in that case.
+     * Clear email suppression for a customer
+     */
+    updateCustomerEmailSuppressionRaw(requestParameters: UpdateCustomerEmailSuppressionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomerEmailSuppressionResponse>>;
+    /**
+     * Clears global unsubscribe, spam complaint and/or bounce suppression for a customer.  This method is clear-only and cannot set a suppression flag.  Clearing a suppression removes the send gate but does not subscribe the customer to any email list -- list membership survives a global unsubscribe untouched, so the customer\'s original lists become deliverable again with no further action.  Returns 200 with a warning if the flags were cleared but an upstream ESP suppression removal failed; the profile was still modified in that case.
+     * Clear email suppression for a customer
+     */
+    updateCustomerEmailSuppression(requestParameters: UpdateCustomerEmailSuppressionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomerEmailSuppressionResponse>;
     /**
      * Update a customer wishlist item
      * Update a customer wishlist item

package/dist/apis/CustomerApi.js

@@ -1675,6 +1675,70 @@ var CustomerApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Clears global unsubscribe, spam complaint and/or bounce suppression for a customer.  This method is clear-only and cannot set a suppression flag.  Clearing a suppression removes the send gate but does not subscribe the customer to any email list -- list membership survives a global unsubscribe untouched, so the customer\'s original lists become deliverable again with no further action.  Returns 200 with a warning if the flags were cleared but an upstream ESP suppression removal failed; the profile was still modified in that case.
+     * Clear email suppression for a customer
+     */
+    CustomerApi.prototype.updateCustomerEmailSuppressionRaw = function (requestParameters, 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:
+                        if (requestParameters.customerProfileOid === null || requestParameters.customerProfileOid === undefined) {
+                            throw new runtime.RequiredError('customerProfileOid', 'Required parameter requestParameters.customerProfileOid was null or undefined when calling updateCustomerEmailSuppression.');
+                        }
+                        if (requestParameters.suppressionChanges === null || requestParameters.suppressionChanges === undefined) {
+                            throw new runtime.RequiredError('suppressionChanges', 'Required parameter requestParameters.suppressionChanges was null or undefined when calling updateCustomerEmailSuppression.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["customer_write"])];
+                    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: "/customer/customers/{customer_profile_oid}/email_suppression".replace("{".concat("customer_profile_oid", "}"), encodeURIComponent(String(requestParameters.customerProfileOid))),
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.CustomerEmailSuppressionRequestToJSON)(requestParameters.suppressionChanges),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.CustomerEmailSuppressionResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Clears global unsubscribe, spam complaint and/or bounce suppression for a customer.  This method is clear-only and cannot set a suppression flag.  Clearing a suppression removes the send gate but does not subscribe the customer to any email list -- list membership survives a global unsubscribe untouched, so the customer\'s original lists become deliverable again with no further action.  Returns 200 with a warning if the flags were cleared but an upstream ESP suppression removal failed; the profile was still modified in that case.
+     * Clear email suppression for a customer
+     */
+    CustomerApi.prototype.updateCustomerEmailSuppression = function (requestParameters, 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.updateCustomerEmailSuppressionRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Update a customer wishlist item
      * Update a customer wishlist item

package/dist/models/CustomerEmailSuppressionRequest.d.ts

@@ -0,0 +1,67 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface CustomerEmailSuppressionRequest
+ */
+export interface CustomerEmailSuppressionRequest {
+    /**
+     * Clear bounce suppression for this address.  Bounce has no per-customer flag; it exists only on the suppression tables.
+     * @type {boolean}
+     * @memberof CustomerEmailSuppressionRequest
+     */
+    clear_bounce?: boolean;
+    /**
+     * Clear the global unsubscribe flag.  No-op if it is already clear.
+     * @type {boolean}
+     * @memberof CustomerEmailSuppressionRequest
+     */
+    clear_global_unsubscribe?: boolean;
+    /**
+     * Clear the spam complaint flag.  Requires a reason.  No-op if it is already clear.
+     * @type {boolean}
+     * @memberof CustomerEmailSuppressionRequest
+     */
+    clear_spam_complaint?: boolean;
+    /**
+     * How the customer communicated consent.
+     * @type {string}
+     * @memberof CustomerEmailSuppressionRequest
+     */
+    consent_source?: CustomerEmailSuppressionRequestConsentSourceEnum;
+    /**
+     * Justification for the clear.  Required when clearing a spam complaint.  Retained on the audit record.
+     * @type {string}
+     * @memberof CustomerEmailSuppressionRequest
+     */
+    reason?: string;
+}
+/**
+ * @export
+ */
+export declare const CustomerEmailSuppressionRequestConsentSourceEnum: {
+    readonly Phone: "phone";
+    readonly Email: "email";
+    readonly Chat: "chat";
+    readonly InPerson: "in_person";
+    readonly Written: "written";
+    readonly Other: "other";
+};
+export type CustomerEmailSuppressionRequestConsentSourceEnum = typeof CustomerEmailSuppressionRequestConsentSourceEnum[keyof typeof CustomerEmailSuppressionRequestConsentSourceEnum];
+/**
+ * Check if a given object implements the CustomerEmailSuppressionRequest interface.
+ */
+export declare function instanceOfCustomerEmailSuppressionRequest(value: object): boolean;
+export declare function CustomerEmailSuppressionRequestFromJSON(json: any): CustomerEmailSuppressionRequest;
+export declare function CustomerEmailSuppressionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomerEmailSuppressionRequest;
+export declare function CustomerEmailSuppressionRequestToJSON(value?: CustomerEmailSuppressionRequest | null): any;

package/dist/models/CustomerEmailSuppressionRequest.js

@@ -0,0 +1,69 @@
+"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.CustomerEmailSuppressionRequestToJSON = exports.CustomerEmailSuppressionRequestFromJSONTyped = exports.CustomerEmailSuppressionRequestFromJSON = exports.instanceOfCustomerEmailSuppressionRequest = exports.CustomerEmailSuppressionRequestConsentSourceEnum = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * @export
+ */
+exports.CustomerEmailSuppressionRequestConsentSourceEnum = {
+    Phone: 'phone',
+    Email: 'email',
+    Chat: 'chat',
+    InPerson: 'in_person',
+    Written: 'written',
+    Other: 'other'
+};
+/**
+ * Check if a given object implements the CustomerEmailSuppressionRequest interface.
+ */
+function instanceOfCustomerEmailSuppressionRequest(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfCustomerEmailSuppressionRequest = instanceOfCustomerEmailSuppressionRequest;
+function CustomerEmailSuppressionRequestFromJSON(json) {
+    return CustomerEmailSuppressionRequestFromJSONTyped(json, false);
+}
+exports.CustomerEmailSuppressionRequestFromJSON = CustomerEmailSuppressionRequestFromJSON;
+function CustomerEmailSuppressionRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'clear_bounce': !(0, runtime_1.exists)(json, 'clear_bounce') ? undefined : json['clear_bounce'],
+        'clear_global_unsubscribe': !(0, runtime_1.exists)(json, 'clear_global_unsubscribe') ? undefined : json['clear_global_unsubscribe'],
+        'clear_spam_complaint': !(0, runtime_1.exists)(json, 'clear_spam_complaint') ? undefined : json['clear_spam_complaint'],
+        'consent_source': !(0, runtime_1.exists)(json, 'consent_source') ? undefined : json['consent_source'],
+        'reason': !(0, runtime_1.exists)(json, 'reason') ? undefined : json['reason'],
+    };
+}
+exports.CustomerEmailSuppressionRequestFromJSONTyped = CustomerEmailSuppressionRequestFromJSONTyped;
+function CustomerEmailSuppressionRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'clear_bounce': value.clear_bounce,
+        'clear_global_unsubscribe': value.clear_global_unsubscribe,
+        'clear_spam_complaint': value.clear_spam_complaint,
+        'consent_source': value.consent_source,
+        'reason': value.reason,
+    };
+}
+exports.CustomerEmailSuppressionRequestToJSON = CustomerEmailSuppressionRequestToJSON;

package/dist/models/CustomerEmailSuppressionResponse.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 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 { CustomerEmailSuppressionResult } from './CustomerEmailSuppressionResult';
+import { ModelError } from './ModelError';
+import { ResponseMetadata } from './ResponseMetadata';
+import { Warning } from './Warning';
+/**
+ *
+ * @export
+ * @interface CustomerEmailSuppressionResponse
+ */
+export interface CustomerEmailSuppressionResponse {
+    /**
+     *
+     * @type {CustomerEmailSuppressionResult}
+     * @memberof CustomerEmailSuppressionResponse
+     */
+    email_suppression?: CustomerEmailSuppressionResult;
+    /**
+     *
+     * @type {ModelError}
+     * @memberof CustomerEmailSuppressionResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof CustomerEmailSuppressionResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof CustomerEmailSuppressionResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof CustomerEmailSuppressionResponse
+     */
+    warning?: Warning;
+}
+/**
+ * Check if a given object implements the CustomerEmailSuppressionResponse interface.
+ */
+export declare function instanceOfCustomerEmailSuppressionResponse(value: object): boolean;
+export declare function CustomerEmailSuppressionResponseFromJSON(json: any): CustomerEmailSuppressionResponse;
+export declare function CustomerEmailSuppressionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomerEmailSuppressionResponse;
+export declare function CustomerEmailSuppressionResponseToJSON(value?: CustomerEmailSuppressionResponse | null): any;

package/dist/models/CustomerEmailSuppressionResponse.js

@@ -0,0 +1,62 @@
+"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.CustomerEmailSuppressionResponseToJSON = exports.CustomerEmailSuppressionResponseFromJSONTyped = exports.CustomerEmailSuppressionResponseFromJSON = exports.instanceOfCustomerEmailSuppressionResponse = void 0;
+var runtime_1 = require("../runtime");
+var CustomerEmailSuppressionResult_1 = require("./CustomerEmailSuppressionResult");
+var ModelError_1 = require("./ModelError");
+var ResponseMetadata_1 = require("./ResponseMetadata");
+var Warning_1 = require("./Warning");
+/**
+ * Check if a given object implements the CustomerEmailSuppressionResponse interface.
+ */
+function instanceOfCustomerEmailSuppressionResponse(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfCustomerEmailSuppressionResponse = instanceOfCustomerEmailSuppressionResponse;
+function CustomerEmailSuppressionResponseFromJSON(json) {
+    return CustomerEmailSuppressionResponseFromJSONTyped(json, false);
+}
+exports.CustomerEmailSuppressionResponseFromJSON = CustomerEmailSuppressionResponseFromJSON;
+function CustomerEmailSuppressionResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'email_suppression': !(0, runtime_1.exists)(json, 'email_suppression') ? undefined : (0, CustomerEmailSuppressionResult_1.CustomerEmailSuppressionResultFromJSON)(json['email_suppression']),
+        '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'],
+        'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
+    };
+}
+exports.CustomerEmailSuppressionResponseFromJSONTyped = CustomerEmailSuppressionResponseFromJSONTyped;
+function CustomerEmailSuppressionResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'email_suppression': (0, CustomerEmailSuppressionResult_1.CustomerEmailSuppressionResultToJSON)(value.email_suppression),
+        'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
+        'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
+        'success': value.success,
+        'warning': (0, Warning_1.WarningToJSON)(value.warning),
+    };
+}
+exports.CustomerEmailSuppressionResponseToJSON = CustomerEmailSuppressionResponseToJSON;

package/dist/models/CustomerEmailSuppressionResult.d.ts

@@ -0,0 +1,98 @@
+/**
+ * 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 { EmailSuppressionSurfaces } from './EmailSuppressionSurfaces';
+/**
+ *
+ * @export
+ * @interface CustomerEmailSuppressionResult
+ */
+export interface CustomerEmailSuppressionResult {
+    /**
+     * True only if this call actually removed bounce suppression.  Bounce has no per-customer flag, so there is no corresponding state field.
+     * @type {boolean}
+     * @memberof CustomerEmailSuppressionResult
+     */
+    bounce_cleared?: boolean;
+    /**
+     * The customer profile oid that was operated on
+     * @type {number}
+     * @memberof CustomerEmailSuppressionResult
+     */
+    customer_profile_oid?: number;
+    /**
+     * The email address that was operated on
+     * @type {string}
+     * @memberof CustomerEmailSuppressionResult
+     */
+    email?: string;
+    /**
+     * True only if every requested suppression surface was successfully cleared.  When false, see esp_warning -- the profile was still modified.
+     * @type {boolean}
+     * @memberof CustomerEmailSuppressionResult
+     */
+    esp_suppression_removed?: boolean;
+    /**
+     * Human readable explanation when esp_suppression_removed is false.  Suitable for display to a support agent.
+     * @type {string}
+     * @memberof CustomerEmailSuppressionResult
+     */
+    esp_warning?: string;
+    /**
+     * True only if this call actually changed the global unsubscribe flag.  False if it was already clear.
+     * @type {boolean}
+     * @memberof CustomerEmailSuppressionResult
+     */
+    global_unsubscribe_cleared?: boolean;
+    /**
+     * Global unsubscribe state AFTER this call
+     * @type {boolean}
+     * @memberof CustomerEmailSuppressionResult
+     */
+    global_unsubscribed?: boolean;
+    /**
+     * Global unsubscribe timestamp after this call.  Nulled when cleared; the prior value is retained on the audit record.
+     * @type {string}
+     * @memberof CustomerEmailSuppressionResult
+     */
+    global_unsubscribed_dts?: string;
+    /**
+     * Spam complaint state AFTER this call
+     * @type {boolean}
+     * @memberof CustomerEmailSuppressionResult
+     */
+    spam_complaint?: boolean;
+    /**
+     * True only if this call actually changed the spam complaint flag.  False if it was already clear.
+     * @type {boolean}
+     * @memberof CustomerEmailSuppressionResult
+     */
+    spam_complaint_cleared?: boolean;
+    /**
+     * Spam complaint timestamp after this call.  Nulled when cleared; the prior value is retained on the audit record.
+     * @type {string}
+     * @memberof CustomerEmailSuppressionResult
+     */
+    spam_complaint_dts?: string;
+    /**
+     *
+     * @type {EmailSuppressionSurfaces}
+     * @memberof CustomerEmailSuppressionResult
+     */
+    suppression_surfaces?: EmailSuppressionSurfaces;
+}
+/**
+ * Check if a given object implements the CustomerEmailSuppressionResult interface.
+ */
+export declare function instanceOfCustomerEmailSuppressionResult(value: object): boolean;
+export declare function CustomerEmailSuppressionResultFromJSON(json: any): CustomerEmailSuppressionResult;
+export declare function CustomerEmailSuppressionResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomerEmailSuppressionResult;
+export declare function CustomerEmailSuppressionResultToJSON(value?: CustomerEmailSuppressionResult | null): any;

package/dist/models/CustomerEmailSuppressionResult.js

@@ -0,0 +1,73 @@
+"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.CustomerEmailSuppressionResultToJSON = exports.CustomerEmailSuppressionResultFromJSONTyped = exports.CustomerEmailSuppressionResultFromJSON = exports.instanceOfCustomerEmailSuppressionResult = void 0;
+var runtime_1 = require("../runtime");
+var EmailSuppressionSurfaces_1 = require("./EmailSuppressionSurfaces");
+/**
+ * Check if a given object implements the CustomerEmailSuppressionResult interface.
+ */
+function instanceOfCustomerEmailSuppressionResult(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfCustomerEmailSuppressionResult = instanceOfCustomerEmailSuppressionResult;
+function CustomerEmailSuppressionResultFromJSON(json) {
+    return CustomerEmailSuppressionResultFromJSONTyped(json, false);
+}
+exports.CustomerEmailSuppressionResultFromJSON = CustomerEmailSuppressionResultFromJSON;
+function CustomerEmailSuppressionResultFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'bounce_cleared': !(0, runtime_1.exists)(json, 'bounce_cleared') ? undefined : json['bounce_cleared'],
+        'customer_profile_oid': !(0, runtime_1.exists)(json, 'customer_profile_oid') ? undefined : json['customer_profile_oid'],
+        'email': !(0, runtime_1.exists)(json, 'email') ? undefined : json['email'],
+        'esp_suppression_removed': !(0, runtime_1.exists)(json, 'esp_suppression_removed') ? undefined : json['esp_suppression_removed'],
+        'esp_warning': !(0, runtime_1.exists)(json, 'esp_warning') ? undefined : json['esp_warning'],
+        'global_unsubscribe_cleared': !(0, runtime_1.exists)(json, 'global_unsubscribe_cleared') ? undefined : json['global_unsubscribe_cleared'],
+        'global_unsubscribed': !(0, runtime_1.exists)(json, 'global_unsubscribed') ? undefined : json['global_unsubscribed'],
+        'global_unsubscribed_dts': !(0, runtime_1.exists)(json, 'global_unsubscribed_dts') ? undefined : json['global_unsubscribed_dts'],
+        'spam_complaint': !(0, runtime_1.exists)(json, 'spam_complaint') ? undefined : json['spam_complaint'],
+        'spam_complaint_cleared': !(0, runtime_1.exists)(json, 'spam_complaint_cleared') ? undefined : json['spam_complaint_cleared'],
+        'spam_complaint_dts': !(0, runtime_1.exists)(json, 'spam_complaint_dts') ? undefined : json['spam_complaint_dts'],
+        'suppression_surfaces': !(0, runtime_1.exists)(json, 'suppression_surfaces') ? undefined : (0, EmailSuppressionSurfaces_1.EmailSuppressionSurfacesFromJSON)(json['suppression_surfaces']),
+    };
+}
+exports.CustomerEmailSuppressionResultFromJSONTyped = CustomerEmailSuppressionResultFromJSONTyped;
+function CustomerEmailSuppressionResultToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'bounce_cleared': value.bounce_cleared,
+        'customer_profile_oid': value.customer_profile_oid,
+        'email': value.email,
+        'esp_suppression_removed': value.esp_suppression_removed,
+        'esp_warning': value.esp_warning,
+        'global_unsubscribe_cleared': value.global_unsubscribe_cleared,
+        'global_unsubscribed': value.global_unsubscribed,
+        'global_unsubscribed_dts': value.global_unsubscribed_dts,
+        'spam_complaint': value.spam_complaint,
+        'spam_complaint_cleared': value.spam_complaint_cleared,
+        'spam_complaint_dts': value.spam_complaint_dts,
+        'suppression_surfaces': (0, EmailSuppressionSurfaces_1.EmailSuppressionSurfacesToJSON)(value.suppression_surfaces),
+    };
+}
+exports.CustomerEmailSuppressionResultToJSON = CustomerEmailSuppressionResultToJSON;

package/dist/models/EmailSuppressionSurfaces.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface EmailSuppressionSurfaces
+ */
+export interface EmailSuppressionSurfaces {
+    /**
+     * Outcome of removing the address from the central cross-account ses_suppression table
+     * @type {string}
+     * @memberof EmailSuppressionSurfaces
+     */
+    central_ses_suppression?: string;
+    /**
+     * Outcome of clearing the per-customer send gates on esp_customer
+     * @type {string}
+     * @memberof EmailSuppressionSurfaces
+     */
+    esp_customer_flags?: string;
+    /**
+     * Outcome of removing the address from the SES-native account-level suppression list
+     * @type {string}
+     * @memberof EmailSuppressionSurfaces
+     */
+    ses_account_suppression?: string;
+}
+/**
+ * Check if a given object implements the EmailSuppressionSurfaces interface.
+ */
+export declare function instanceOfEmailSuppressionSurfaces(value: object): boolean;
+export declare function EmailSuppressionSurfacesFromJSON(json: any): EmailSuppressionSurfaces;
+export declare function EmailSuppressionSurfacesFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailSuppressionSurfaces;
+export declare function EmailSuppressionSurfacesToJSON(value?: EmailSuppressionSurfaces | null): any;