ultracart_rest_api_v2_typescript 4.1.157 → 4.1.158

package/.openapi-generator/FILES

@@ -1032,6 +1032,10 @@ src/models/SfvbPreviewSessionResponse.ts
 src/models/SfvbPreviewUrlResponse.ts
 src/models/SfvbRenderRequest.ts
 src/models/SfvbRenderResponse.ts
+src/models/SfvbSiteAttribute.ts
+src/models/SfvbSiteAttributeUpdate.ts
+src/models/SfvbSiteAttributeUpdateRequest.ts
+src/models/SfvbSiteAttributesResponse.ts
 src/models/SfvbStorefront.ts
 src/models/SfvbStorefrontsResponse.ts
 src/models/SfvbTheme.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.157
+## ultracart_rest_api_v2_typescript@4.1.158
 
 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.157 --save
+npm install ultracart_rest_api_v2_typescript@4.1.158 --save
 ```
 
 ```typescript
@@ -85,6 +85,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.158 | 09/18/2026 | sfvb internal testing |
 | 4.1.157 | 09/18/2026 | sfvb internal testing |
 | 4.1.156 | 09/16/2026 | sfvb internal testing |
 | 4.1.155 | 09/15/2026 | sfvb internal testing |

package/dist/apis/SfvbApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbLibraryEntry, SfvbLibraryResponse, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbPageAttributeUpdateRequest, SfvbPageMultimediaRequest, SfvbPageResponse, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbStorefrontsResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffersResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
+import { SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbLibraryEntry, SfvbLibraryResponse, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbPageAttributeUpdateRequest, SfvbPageMultimediaRequest, SfvbPageResponse, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffersResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
 export interface CompileSfvbCjsonRequest {
     compileRequest: SfvbCompileRequest;
 }
@@ -93,6 +93,9 @@ export interface GetSfvbPreviewUrlRequest {
     previewSessionId: string;
     path?: string;
 }
+export interface GetSfvbSiteAttributesRequest {
+    storefrontOid: number;
+}
 export interface GetSfvbThemeRequest {
     storefrontOid: number;
     themeOid: number;
@@ -168,6 +171,10 @@ export interface PutSfvbPreviewSessionRequest {
     previewSession: SfvbPreviewSessionRequest;
     themeOid?: number;
 }
+export interface PutSfvbSiteAttributesRequest {
+    storefrontOid: number;
+    siteAttributeUpdateRequest: SfvbSiteAttributeUpdateRequest;
+}
 export interface PutSfvbThemeAttributesRequest {
     storefrontOid: number;
     themeOid: number;
@@ -516,6 +523,20 @@ export interface SfvbApiInterface {
      * URL that renders a preview session
      */
     getSfvbPreviewUrl(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewUrlResponse>;
+    /**
+     * The values the siteattribute element and $site.attr render.  These are not in any file or theme.  Attributes a template declares but nothing has set are included with the template\'s default, so the response describes what the templates can render rather than only what has been saved.  Credentials stored as site attributes are never included.
+     * @summary Read a storefront\'s site attributes
+     * @param {number} storefrontOid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    getSfvbSiteAttributesRaw(requestParameters: GetSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSiteAttributesResponse>>;
+    /**
+     * The values the siteattribute element and $site.attr render.  These are not in any file or theme.  Attributes a template declares but nothing has set are included with the template\'s default, so the response describes what the templates can render rather than only what has been saved.  Credentials stored as site attributes are never included.
+     * Read a storefront\'s site attributes
+     */
+    getSfvbSiteAttributes(requestParameters: GetSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSiteAttributesResponse>;
     /**
      *
      * @summary Get a theme
@@ -806,6 +827,21 @@ export interface SfvbApiInterface {
      * Push containers into a preview session
      */
     putSfvbPreviewSession(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
+    /**
+     * A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, video list, mailing list and item set attributes are refused, and so are the General screen settings other than the title, the SEO description and keywords and the social account names.  Credentials are refused.  Always needs sfvb_publish, because every theme reads the same attributes and there is no dormant copy to change instead.  The admin General screen saves the whole storefront, so a merchant with it open can still overwrite a change made here.
+     * @summary Change a storefront\'s site attributes
+     * @param {number} storefrontOid
+     * @param {SfvbSiteAttributeUpdateRequest} siteAttributeUpdateRequest Attributes to change
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    putSfvbSiteAttributesRaw(requestParameters: PutSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSiteAttributesResponse>>;
+    /**
+     * A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, video list, mailing list and item set attributes are refused, and so are the General screen settings other than the title, the SEO description and keywords and the social account names.  Credentials are refused.  Always needs sfvb_publish, because every theme reads the same attributes and there is no dormant copy to change instead.  The admin General screen saves the whole storefront, so a merchant with it open can still overwrite a change made here.
+     * Change a storefront\'s site attributes
+     */
+    putSfvbSiteAttributes(requestParameters: PutSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSiteAttributesResponse>;
     /**
      * A partial update.  Only the slots you name are changed and every other slot on the theme keeps its value, so there is no need to send the whole set back to change one color.  Send a whole palette in one call rather than one call per color - they are applied together, so the storefront never renders half of a change.  Needs sfvb_publish when the theme is the one serving live traffic, because a color is referenced by name from every template that uses it and one write repaints the whole storefront at once.  On a dormant theme sfvb_write is enough, which is what makes duplicate-then-restyle work.
      * @summary Change a theme\'s colors, fonts and settings
@@ -1160,6 +1196,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * URL that renders a preview session
      */
     getSfvbPreviewUrl(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewUrlResponse>;
+    /**
+     * The values the siteattribute element and $site.attr render.  These are not in any file or theme.  Attributes a template declares but nothing has set are included with the template\'s default, so the response describes what the templates can render rather than only what has been saved.  Credentials stored as site attributes are never included.
+     * Read a storefront\'s site attributes
+     */
+    getSfvbSiteAttributesRaw(requestParameters: GetSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSiteAttributesResponse>>;
+    /**
+     * The values the siteattribute element and $site.attr render.  These are not in any file or theme.  Attributes a template declares but nothing has set are included with the template\'s default, so the response describes what the templates can render rather than only what has been saved.  Credentials stored as site attributes are never included.
+     * Read a storefront\'s site attributes
+     */
+    getSfvbSiteAttributes(requestParameters: GetSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSiteAttributesResponse>;
     /**
      * Get a theme
      */
@@ -1346,6 +1392,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Push containers into a preview session
      */
     putSfvbPreviewSession(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
+    /**
+     * A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, video list, mailing list and item set attributes are refused, and so are the General screen settings other than the title, the SEO description and keywords and the social account names.  Credentials are refused.  Always needs sfvb_publish, because every theme reads the same attributes and there is no dormant copy to change instead.  The admin General screen saves the whole storefront, so a merchant with it open can still overwrite a change made here.
+     * Change a storefront\'s site attributes
+     */
+    putSfvbSiteAttributesRaw(requestParameters: PutSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSiteAttributesResponse>>;
+    /**
+     * A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, video list, mailing list and item set attributes are refused, and so are the General screen settings other than the title, the SEO description and keywords and the social account names.  Credentials are refused.  Always needs sfvb_publish, because every theme reads the same attributes and there is no dormant copy to change instead.  The admin General screen saves the whole storefront, so a merchant with it open can still overwrite a change made here.
+     * Change a storefront\'s site attributes
+     */
+    putSfvbSiteAttributes(requestParameters: PutSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSiteAttributesResponse>;
     /**
      * A partial update.  Only the slots you name are changed and every other slot on the theme keeps its value, so there is no need to send the whole set back to change one color.  Send a whole palette in one call rather than one call per color - they are applied together, so the storefront never renders half of a change.  Needs sfvb_publish when the theme is the one serving live traffic, because a color is referenced by name from every template that uses it and one write repaints the whole storefront at once.  On a dormant theme sfvb_write is enough, which is what makes duplicate-then-restyle work.
      * Change a theme\'s colors, fonts and settings

package/dist/apis/SfvbApi.js

@@ -1277,6 +1277,65 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * The values the siteattribute element and $site.attr render.  These are not in any file or theme.  Attributes a template declares but nothing has set are included with the template\'s default, so the response describes what the templates can render rather than only what has been saved.  Credentials stored as site attributes are never included.
+     * Read a storefront\'s site attributes
+     */
+    SfvbApi.prototype.getSfvbSiteAttributesRaw = 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.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+                            throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getSfvbSiteAttributes.');
+                        }
+                        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", [])];
+                    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: "/sfvb/storefronts/{storefront_oid}/attributes".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
+                                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.SfvbSiteAttributesResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * The values the siteattribute element and $site.attr render.  These are not in any file or theme.  Attributes a template declares but nothing has set are included with the template\'s default, so the response describes what the templates can render rather than only what has been saved.  Credentials stored as site attributes are never included.
+     * Read a storefront\'s site attributes
+     */
+    SfvbApi.prototype.getSfvbSiteAttributes = 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.getSfvbSiteAttributesRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Get a theme
      */
@@ -2496,6 +2555,70 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, video list, mailing list and item set attributes are refused, and so are the General screen settings other than the title, the SEO description and keywords and the social account names.  Credentials are refused.  Always needs sfvb_publish, because every theme reads the same attributes and there is no dormant copy to change instead.  The admin General screen saves the whole storefront, so a merchant with it open can still overwrite a change made here.
+     * Change a storefront\'s site attributes
+     */
+    SfvbApi.prototype.putSfvbSiteAttributesRaw = 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.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+                            throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling putSfvbSiteAttributes.');
+                        }
+                        if (requestParameters.siteAttributeUpdateRequest === null || requestParameters.siteAttributeUpdateRequest === undefined) {
+                            throw new runtime.RequiredError('siteAttributeUpdateRequest', 'Required parameter requestParameters.siteAttributeUpdateRequest was null or undefined when calling putSfvbSiteAttributes.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
+                    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: "/sfvb/storefronts/{storefront_oid}/attributes".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
+                                method: 'PUT',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.SfvbSiteAttributeUpdateRequestToJSON)(requestParameters.siteAttributeUpdateRequest),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbSiteAttributesResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, video list, mailing list and item set attributes are refused, and so are the General screen settings other than the title, the SEO description and keywords and the social account names.  Credentials are refused.  Always needs sfvb_publish, because every theme reads the same attributes and there is no dormant copy to change instead.  The admin General screen saves the whole storefront, so a merchant with it open can still overwrite a change made here.
+     * Change a storefront\'s site attributes
+     */
+    SfvbApi.prototype.putSfvbSiteAttributes = 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.putSfvbSiteAttributesRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * A partial update.  Only the slots you name are changed and every other slot on the theme keeps its value, so there is no need to send the whole set back to change one color.  Send a whole palette in one call rather than one call per color - they are applied together, so the storefront never renders half of a change.  Needs sfvb_publish when the theme is the one serving live traffic, because a color is referenced by name from every template that uses it and one write repaints the whole storefront at once.  On a dormant theme sfvb_write is enough, which is what makes duplicate-then-restyle work.
      * Change a theme\'s colors, fonts and settings

package/dist/models/SfvbSiteAttribute.d.ts

@@ -0,0 +1,87 @@
+/**
+ * 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 SfvbSiteAttribute
+ */
+export interface SfvbSiteAttribute {
+    /**
+     * Attribute name, as a template's site attribute declaration spells it.  Compare case insensitively.  This is the value siteAttributeName refers to and the name $site.attr takes.
+     * @type {string}
+     * @memberof SfvbSiteAttribute
+     */
+    name?: string;
+    /**
+     * What kind of attribute this is, taken from the template that declares it rather than from the stored row.  orphan means no template declares it.  reserved covers the settings the StoreFronts General screen owns.
+     * @type {string}
+     * @memberof SfvbSiteAttribute
+     */
+    type?: SfvbSiteAttributeTypeEnum;
+    /**
+     * True when no template declares this name and it is not a reserved setting.  A template can still read it with $site.attr, so this is not proof it is unused, but a name you did not mean to create is most likely a misspelling.
+     * @type {boolean}
+     * @memberof SfvbSiteAttribute
+     */
+    undeclared?: boolean;
+    /**
+     * The other themes that declare this attribute, when the active theme does not.
+     * @type {string}
+     * @memberof SfvbSiteAttribute
+     */
+    used_by?: string;
+    /**
+     * True when a template in the active theme declares this attribute.
+     * @type {boolean}
+     * @memberof SfvbSiteAttribute
+     */
+    used_by_current_theme?: boolean;
+    /**
+     * The stored value, or the template default when nothing has set it.
+     * @type {string}
+     * @memberof SfvbSiteAttribute
+     */
+    value?: string;
+    /**
+     * True when this API will change the value.  List, video list, mailing list and item set values are structured documents and must be edited in the store admin.  Of the reserved settings only the title, the SEO description and keywords and the social account names are writable here.
+     * @type {boolean}
+     * @memberof SfvbSiteAttribute
+     */
+    writable?: boolean;
+}
+/**
+ * @export
+ */
+export declare const SfvbSiteAttributeTypeEnum: {
+    readonly String: "string";
+    readonly Multiline: "multiline";
+    readonly Html: "html";
+    readonly Color: "color";
+    readonly Rgba: "rgba";
+    readonly Boolean: "boolean";
+    readonly Integer: "integer";
+    readonly Orphan: "orphan";
+    readonly Reserved: "reserved";
+    readonly Simplelist: "simplelist";
+    readonly Definitionlist: "definitionlist";
+    readonly Videolist: "videolist";
+    readonly Mailinglist: "mailinglist";
+    readonly Itemset: "itemset";
+};
+export type SfvbSiteAttributeTypeEnum = typeof SfvbSiteAttributeTypeEnum[keyof typeof SfvbSiteAttributeTypeEnum];
+/**
+ * Check if a given object implements the SfvbSiteAttribute interface.
+ */
+export declare function instanceOfSfvbSiteAttribute(value: object): boolean;
+export declare function SfvbSiteAttributeFromJSON(json: any): SfvbSiteAttribute;
+export declare function SfvbSiteAttributeFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSiteAttribute;
+export declare function SfvbSiteAttributeToJSON(value?: SfvbSiteAttribute | null): any;

package/dist/models/SfvbSiteAttribute.js

@@ -0,0 +1,81 @@
+"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.SfvbSiteAttributeToJSON = exports.SfvbSiteAttributeFromJSONTyped = exports.SfvbSiteAttributeFromJSON = exports.instanceOfSfvbSiteAttribute = exports.SfvbSiteAttributeTypeEnum = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * @export
+ */
+exports.SfvbSiteAttributeTypeEnum = {
+    String: 'string',
+    Multiline: 'multiline',
+    Html: 'html',
+    Color: 'color',
+    Rgba: 'rgba',
+    Boolean: 'boolean',
+    Integer: 'integer',
+    Orphan: 'orphan',
+    Reserved: 'reserved',
+    Simplelist: 'simplelist',
+    Definitionlist: 'definitionlist',
+    Videolist: 'videolist',
+    Mailinglist: 'mailinglist',
+    Itemset: 'itemset'
+};
+/**
+ * Check if a given object implements the SfvbSiteAttribute interface.
+ */
+function instanceOfSfvbSiteAttribute(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbSiteAttribute = instanceOfSfvbSiteAttribute;
+function SfvbSiteAttributeFromJSON(json) {
+    return SfvbSiteAttributeFromJSONTyped(json, false);
+}
+exports.SfvbSiteAttributeFromJSON = SfvbSiteAttributeFromJSON;
+function SfvbSiteAttributeFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
+        'type': !(0, runtime_1.exists)(json, 'type') ? undefined : json['type'],
+        'undeclared': !(0, runtime_1.exists)(json, 'undeclared') ? undefined : json['undeclared'],
+        'used_by': !(0, runtime_1.exists)(json, 'used_by') ? undefined : json['used_by'],
+        'used_by_current_theme': !(0, runtime_1.exists)(json, 'used_by_current_theme') ? undefined : json['used_by_current_theme'],
+        'value': !(0, runtime_1.exists)(json, 'value') ? undefined : json['value'],
+        'writable': !(0, runtime_1.exists)(json, 'writable') ? undefined : json['writable'],
+    };
+}
+exports.SfvbSiteAttributeFromJSONTyped = SfvbSiteAttributeFromJSONTyped;
+function SfvbSiteAttributeToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'type': value.type,
+        'undeclared': value.undeclared,
+        'used_by': value.used_by,
+        'used_by_current_theme': value.used_by_current_theme,
+        'value': value.value,
+        'writable': value.writable,
+    };
+}
+exports.SfvbSiteAttributeToJSON = SfvbSiteAttributeToJSON;

package/dist/models/SfvbSiteAttributeUpdate.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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 SfvbSiteAttributeUpdate
+ */
+export interface SfvbSiteAttributeUpdate {
+    /**
+     * Attribute name.  Matched without regard to case against what the storefront already has, so you do not have to reproduce the exact casing.  A name nothing matches creates a new attribute.
+     * @type {string}
+     * @memberof SfvbSiteAttributeUpdate
+     */
+    name?: string;
+    /**
+     * Only consulted when creating an attribute no template declares.  For a declared attribute the template's type always wins, because the templates decide it and not the caller.
+     * @type {string}
+     * @memberof SfvbSiteAttributeUpdate
+     */
+    type?: SfvbSiteAttributeUpdateTypeEnum;
+    /**
+     * The value to store.  An empty string clears it.  For html the markup is stored as given and rendered as given.  For boolean send the text true or false.
+     * @type {string}
+     * @memberof SfvbSiteAttributeUpdate
+     */
+    value?: string;
+}
+/**
+ * @export
+ */
+export declare const SfvbSiteAttributeUpdateTypeEnum: {
+    readonly String: "string";
+    readonly Multiline: "multiline";
+    readonly Html: "html";
+    readonly Boolean: "boolean";
+    readonly Integer: "integer";
+    readonly Color: "color";
+    readonly Rgba: "rgba";
+};
+export type SfvbSiteAttributeUpdateTypeEnum = typeof SfvbSiteAttributeUpdateTypeEnum[keyof typeof SfvbSiteAttributeUpdateTypeEnum];
+/**
+ * Check if a given object implements the SfvbSiteAttributeUpdate interface.
+ */
+export declare function instanceOfSfvbSiteAttributeUpdate(value: object): boolean;
+export declare function SfvbSiteAttributeUpdateFromJSON(json: any): SfvbSiteAttributeUpdate;
+export declare function SfvbSiteAttributeUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSiteAttributeUpdate;
+export declare function SfvbSiteAttributeUpdateToJSON(value?: SfvbSiteAttributeUpdate | null): any;

package/dist/models/SfvbSiteAttributeUpdate.js

@@ -0,0 +1,66 @@
+"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.SfvbSiteAttributeUpdateToJSON = exports.SfvbSiteAttributeUpdateFromJSONTyped = exports.SfvbSiteAttributeUpdateFromJSON = exports.instanceOfSfvbSiteAttributeUpdate = exports.SfvbSiteAttributeUpdateTypeEnum = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * @export
+ */
+exports.SfvbSiteAttributeUpdateTypeEnum = {
+    String: 'string',
+    Multiline: 'multiline',
+    Html: 'html',
+    Boolean: 'boolean',
+    Integer: 'integer',
+    Color: 'color',
+    Rgba: 'rgba'
+};
+/**
+ * Check if a given object implements the SfvbSiteAttributeUpdate interface.
+ */
+function instanceOfSfvbSiteAttributeUpdate(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbSiteAttributeUpdate = instanceOfSfvbSiteAttributeUpdate;
+function SfvbSiteAttributeUpdateFromJSON(json) {
+    return SfvbSiteAttributeUpdateFromJSONTyped(json, false);
+}
+exports.SfvbSiteAttributeUpdateFromJSON = SfvbSiteAttributeUpdateFromJSON;
+function SfvbSiteAttributeUpdateFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
+        'type': !(0, runtime_1.exists)(json, 'type') ? undefined : json['type'],
+        'value': !(0, runtime_1.exists)(json, 'value') ? undefined : json['value'],
+    };
+}
+exports.SfvbSiteAttributeUpdateFromJSONTyped = SfvbSiteAttributeUpdateFromJSONTyped;
+function SfvbSiteAttributeUpdateToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'type': value.type,
+        'value': value.value,
+    };
+}
+exports.SfvbSiteAttributeUpdateToJSON = SfvbSiteAttributeUpdateToJSON;

package/dist/models/SfvbSiteAttributeUpdateRequest.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 { SfvbSiteAttributeUpdate } from './SfvbSiteAttributeUpdate';
+/**
+ *
+ * @export
+ * @interface SfvbSiteAttributeUpdateRequest
+ */
+export interface SfvbSiteAttributeUpdateRequest {
+    /**
+     * The attributes to change.  Every entry is checked before any is written, so a request naming one attribute this API will not change writes nothing rather than part of what it asked for.
+     * @type {Array<SfvbSiteAttributeUpdate>}
+     * @memberof SfvbSiteAttributeUpdateRequest
+     */
+    attributes?: Array<SfvbSiteAttributeUpdate>;
+}
+/**
+ * Check if a given object implements the SfvbSiteAttributeUpdateRequest interface.
+ */
+export declare function instanceOfSfvbSiteAttributeUpdateRequest(value: object): boolean;
+export declare function SfvbSiteAttributeUpdateRequestFromJSON(json: any): SfvbSiteAttributeUpdateRequest;
+export declare function SfvbSiteAttributeUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSiteAttributeUpdateRequest;
+export declare function SfvbSiteAttributeUpdateRequestToJSON(value?: SfvbSiteAttributeUpdateRequest | null): any;

package/dist/models/SfvbSiteAttributeUpdateRequest.js

@@ -0,0 +1,51 @@
+"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.SfvbSiteAttributeUpdateRequestToJSON = exports.SfvbSiteAttributeUpdateRequestFromJSONTyped = exports.SfvbSiteAttributeUpdateRequestFromJSON = exports.instanceOfSfvbSiteAttributeUpdateRequest = void 0;
+var runtime_1 = require("../runtime");
+var SfvbSiteAttributeUpdate_1 = require("./SfvbSiteAttributeUpdate");
+/**
+ * Check if a given object implements the SfvbSiteAttributeUpdateRequest interface.
+ */
+function instanceOfSfvbSiteAttributeUpdateRequest(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbSiteAttributeUpdateRequest = instanceOfSfvbSiteAttributeUpdateRequest;
+function SfvbSiteAttributeUpdateRequestFromJSON(json) {
+    return SfvbSiteAttributeUpdateRequestFromJSONTyped(json, false);
+}
+exports.SfvbSiteAttributeUpdateRequestFromJSON = SfvbSiteAttributeUpdateRequestFromJSON;
+function SfvbSiteAttributeUpdateRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'attributes': !(0, runtime_1.exists)(json, 'attributes') ? undefined : (json['attributes'].map(SfvbSiteAttributeUpdate_1.SfvbSiteAttributeUpdateFromJSON)),
+    };
+}
+exports.SfvbSiteAttributeUpdateRequestFromJSONTyped = SfvbSiteAttributeUpdateRequestFromJSONTyped;
+function SfvbSiteAttributeUpdateRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'attributes': value.attributes === undefined ? undefined : (value.attributes.map(SfvbSiteAttributeUpdate_1.SfvbSiteAttributeUpdateToJSON)),
+    };
+}
+exports.SfvbSiteAttributeUpdateRequestToJSON = SfvbSiteAttributeUpdateRequestToJSON;