ultracart_rest_api_v2_typescript 4.1.151 → 4.1.152

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1023,7 +1023,13 @@ src/models/SfvbRenderResponse.ts
1023
1023
  src/models/SfvbStorefront.ts
1024
1024
  src/models/SfvbStorefrontsResponse.ts
1025
1025
  src/models/SfvbTheme.ts
1026
+ src/models/SfvbThemeAttribute.ts
1027
+ src/models/SfvbThemeAttributeUpdate.ts
1028
+ src/models/SfvbThemeAttributeUpdateRequest.ts
1029
+ src/models/SfvbThemeAttributesResponse.ts
1026
1030
  src/models/SfvbThemeDuplicateRequest.ts
1031
+ src/models/SfvbThemeFont.ts
1032
+ src/models/SfvbThemeFontFamily.ts
1027
1033
  src/models/SfvbThemeJobResponse.ts
1028
1034
  src/models/SfvbThemesResponse.ts
1029
1035
  src/models/SfvbUpsellOffer.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.151
2
+ ## ultracart_rest_api_v2_typescript@4.1.152
3
3
 
4
4
  Every API method call has a sample for every language SDK. See https://github.com/UltraCart/sdk_samples
5
5
 
6
6
  Installation
7
7
 
8
8
  ```
9
- npm install ultracart_rest_api_v2_typescript@4.1.151 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.152 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -85,6 +85,7 @@ Not every change is committed to every SDK.
85
85
 
86
86
  | Version | Date | Comments |
87
87
  | --: | :-: | --- |
88
+ | 4.1.152 | 09/09/2026 | sfvb - internal testing |
88
89
  | 4.1.151 | 09/04/2026 | conversations - added ai agent capabilities |
89
90
  | 4.1.150 | 09/04/2026 | conversations - add ai agent capabilities |
90
91
  | 4.1.149 | 09/04/2026 | conversations - added ai agent capabilities |
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbLibraryEntry, SfvbLibraryResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbStorefrontsResponse, SfvbTheme, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffersResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
13
+ import { SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbLibraryEntry, SfvbLibraryResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbStorefrontsResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffersResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
14
14
  export interface CompileSfvbCjsonRequest {
15
15
  compileRequest: SfvbCompileRequest;
16
16
  }
@@ -76,6 +76,10 @@ export interface GetSfvbThemeRequest {
76
76
  storefrontOid: number;
77
77
  themeOid: number;
78
78
  }
79
+ export interface GetSfvbThemeAttributesRequest {
80
+ storefrontOid: number;
81
+ themeOid: number;
82
+ }
79
83
  export interface GetSfvbThemeJobRequest {
80
84
  storefrontOid: number;
81
85
  jobId: number;
@@ -127,6 +131,11 @@ export interface PutSfvbPreviewSessionRequest {
127
131
  previewSession: SfvbPreviewSessionRequest;
128
132
  themeOid?: number;
129
133
  }
134
+ export interface PutSfvbThemeAttributesRequest {
135
+ storefrontOid: number;
136
+ themeOid: number;
137
+ attributeUpdateRequest: SfvbThemeAttributeUpdateRequest;
138
+ }
130
139
  export interface RenderSfvbWidgetsRequest {
131
140
  storefrontOid: number;
132
141
  themeOid: number;
@@ -407,6 +416,21 @@ export interface SfvbApiInterface {
407
416
  * Get a theme
408
417
  */
409
418
  getSfvbTheme(requestParameters: GetSfvbThemeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTheme>;
419
+ /**
420
+ * The values theme.css and the compiled containers resolve at render time. These do NOT live in any file. settings.json contains a palette and looks like the answer, but it is the theme\'s factory template - it supplies defaults for slots that have never been set and is ignored for slots that have, so editing it will not change a color and reading it will not tell you the current one. Slots a template declares but nothing has ever set are included here, carrying the default they will render with, so the response describes the whole theme rather than the rows that happen to exist.
421
+ * @summary Read a theme\'s colors, fonts and settings
422
+ * @param {number} storefrontOid
423
+ * @param {number} themeOid
424
+ * @param {*} [options] Override http request option.
425
+ * @throws {RequiredError}
426
+ * @memberof SfvbApiInterface
427
+ */
428
+ getSfvbThemeAttributesRaw(requestParameters: GetSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbThemeAttributesResponse>>;
429
+ /**
430
+ * The values theme.css and the compiled containers resolve at render time. These do NOT live in any file. settings.json contains a palette and looks like the answer, but it is the theme\'s factory template - it supplies defaults for slots that have never been set and is ignored for slots that have, so editing it will not change a color and reading it will not tell you the current one. Slots a template declares but nothing has ever set are included here, carrying the default they will render with, so the response describes the whole theme rather than the rows that happen to exist.
431
+ * Read a theme\'s colors, fonts and settings
432
+ */
433
+ getSfvbThemeAttributes(requestParameters: GetSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbThemeAttributesResponse>;
410
434
  /**
411
435
  * Poll until complete is true, then check success. Note that the new theme\'s oid is not returned. The job\'s product is a plain text report rather than a structured result, so once it completes, list themes and match on the target_path the start call gave you.
412
436
  * @summary Status of an asynchronous theme job
@@ -618,6 +642,22 @@ export interface SfvbApiInterface {
618
642
  * Push containers into a preview session
619
643
  */
620
644
  putSfvbPreviewSession(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
645
+ /**
646
+ * 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.
647
+ * @summary Change a theme\'s colors, fonts and settings
648
+ * @param {number} storefrontOid
649
+ * @param {number} themeOid
650
+ * @param {SfvbThemeAttributeUpdateRequest} attributeUpdateRequest Slots to change
651
+ * @param {*} [options] Override http request option.
652
+ * @throws {RequiredError}
653
+ * @memberof SfvbApiInterface
654
+ */
655
+ putSfvbThemeAttributesRaw(requestParameters: PutSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbThemeAttributesResponse>>;
656
+ /**
657
+ * 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.
658
+ * Change a theme\'s colors, fonts and settings
659
+ */
660
+ putSfvbThemeAttributes(requestParameters: PutSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbThemeAttributesResponse>;
621
661
  /**
622
662
  * Renders one node in the context of a theme and a page. Unlike compile this is stateful. Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id. One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why.
623
663
  * @summary Render a CJSON node to HTML
@@ -912,6 +952,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
912
952
  * Get a theme
913
953
  */
914
954
  getSfvbTheme(requestParameters: GetSfvbThemeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTheme>;
955
+ /**
956
+ * The values theme.css and the compiled containers resolve at render time. These do NOT live in any file. settings.json contains a palette and looks like the answer, but it is the theme\'s factory template - it supplies defaults for slots that have never been set and is ignored for slots that have, so editing it will not change a color and reading it will not tell you the current one. Slots a template declares but nothing has ever set are included here, carrying the default they will render with, so the response describes the whole theme rather than the rows that happen to exist.
957
+ * Read a theme\'s colors, fonts and settings
958
+ */
959
+ getSfvbThemeAttributesRaw(requestParameters: GetSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbThemeAttributesResponse>>;
960
+ /**
961
+ * The values theme.css and the compiled containers resolve at render time. These do NOT live in any file. settings.json contains a palette and looks like the answer, but it is the theme\'s factory template - it supplies defaults for slots that have never been set and is ignored for slots that have, so editing it will not change a color and reading it will not tell you the current one. Slots a template declares but nothing has ever set are included here, carrying the default they will render with, so the response describes the whole theme rather than the rows that happen to exist.
962
+ * Read a theme\'s colors, fonts and settings
963
+ */
964
+ getSfvbThemeAttributes(requestParameters: GetSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbThemeAttributesResponse>;
915
965
  /**
916
966
  * Poll until complete is true, then check success. Note that the new theme\'s oid is not returned. The job\'s product is a plain text report rather than a structured result, so once it completes, list themes and match on the target_path the start call gave you.
917
967
  * Status of an asynchronous theme job
@@ -1048,6 +1098,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
1048
1098
  * Push containers into a preview session
1049
1099
  */
1050
1100
  putSfvbPreviewSession(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
1101
+ /**
1102
+ * 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.
1103
+ * Change a theme\'s colors, fonts and settings
1104
+ */
1105
+ putSfvbThemeAttributesRaw(requestParameters: PutSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbThemeAttributesResponse>>;
1106
+ /**
1107
+ * 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.
1108
+ * Change a theme\'s colors, fonts and settings
1109
+ */
1110
+ putSfvbThemeAttributes(requestParameters: PutSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbThemeAttributesResponse>;
1051
1111
  /**
1052
1112
  * Renders one node in the context of a theme and a page. Unlike compile this is stateful. Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id. One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why.
1053
1113
  * Render a CJSON node to HTML
@@ -1017,6 +1017,68 @@ var SfvbApi = /** @class */ (function (_super) {
1017
1017
  });
1018
1018
  });
1019
1019
  };
1020
+ /**
1021
+ * The values theme.css and the compiled containers resolve at render time. These do NOT live in any file. settings.json contains a palette and looks like the answer, but it is the theme\'s factory template - it supplies defaults for slots that have never been set and is ignored for slots that have, so editing it will not change a color and reading it will not tell you the current one. Slots a template declares but nothing has ever set are included here, carrying the default they will render with, so the response describes the whole theme rather than the rows that happen to exist.
1022
+ * Read a theme\'s colors, fonts and settings
1023
+ */
1024
+ SfvbApi.prototype.getSfvbThemeAttributesRaw = function (requestParameters, initOverrides) {
1025
+ return __awaiter(this, void 0, void 0, function () {
1026
+ var queryParameters, headerParameters, _a, _b, response;
1027
+ return __generator(this, function (_c) {
1028
+ switch (_c.label) {
1029
+ case 0:
1030
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
1031
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getSfvbThemeAttributes.');
1032
+ }
1033
+ if (requestParameters.themeOid === null || requestParameters.themeOid === undefined) {
1034
+ throw new runtime.RequiredError('themeOid', 'Required parameter requestParameters.themeOid was null or undefined when calling getSfvbThemeAttributes.');
1035
+ }
1036
+ queryParameters = {};
1037
+ headerParameters = {};
1038
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
1039
+ // oauth required
1040
+ _a = headerParameters;
1041
+ _b = "Authorization";
1042
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
1043
+ case 1:
1044
+ // oauth required
1045
+ _a[_b] = _c.sent();
1046
+ _c.label = 2;
1047
+ case 2:
1048
+ if (this.configuration && this.configuration.apiKey) {
1049
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
1050
+ }
1051
+ return [4 /*yield*/, this.request({
1052
+ path: "/sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("theme_oid", "}"), encodeURIComponent(String(requestParameters.themeOid))),
1053
+ method: 'GET',
1054
+ headers: headerParameters,
1055
+ query: queryParameters,
1056
+ }, initOverrides)];
1057
+ case 3:
1058
+ response = _c.sent();
1059
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbThemeAttributesResponseFromJSON)(jsonValue); })];
1060
+ }
1061
+ });
1062
+ });
1063
+ };
1064
+ /**
1065
+ * The values theme.css and the compiled containers resolve at render time. These do NOT live in any file. settings.json contains a palette and looks like the answer, but it is the theme\'s factory template - it supplies defaults for slots that have never been set and is ignored for slots that have, so editing it will not change a color and reading it will not tell you the current one. Slots a template declares but nothing has ever set are included here, carrying the default they will render with, so the response describes the whole theme rather than the rows that happen to exist.
1066
+ * Read a theme\'s colors, fonts and settings
1067
+ */
1068
+ SfvbApi.prototype.getSfvbThemeAttributes = function (requestParameters, initOverrides) {
1069
+ return __awaiter(this, void 0, void 0, function () {
1070
+ var response;
1071
+ return __generator(this, function (_a) {
1072
+ switch (_a.label) {
1073
+ case 0: return [4 /*yield*/, this.getSfvbThemeAttributesRaw(requestParameters, initOverrides)];
1074
+ case 1:
1075
+ response = _a.sent();
1076
+ return [4 /*yield*/, response.value()];
1077
+ case 2: return [2 /*return*/, _a.sent()];
1078
+ }
1079
+ });
1080
+ });
1081
+ };
1020
1082
  /**
1021
1083
  * Poll until complete is true, then check success. Note that the new theme\'s oid is not returned. The job\'s product is a plain text report rather than a structured result, so once it completes, list themes and match on the target_path the start call gave you.
1022
1084
  * Status of an asynchronous theme job
@@ -1902,6 +1964,73 @@ var SfvbApi = /** @class */ (function (_super) {
1902
1964
  });
1903
1965
  });
1904
1966
  };
1967
+ /**
1968
+ * 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.
1969
+ * Change a theme\'s colors, fonts and settings
1970
+ */
1971
+ SfvbApi.prototype.putSfvbThemeAttributesRaw = function (requestParameters, initOverrides) {
1972
+ return __awaiter(this, void 0, void 0, function () {
1973
+ var queryParameters, headerParameters, _a, _b, response;
1974
+ return __generator(this, function (_c) {
1975
+ switch (_c.label) {
1976
+ case 0:
1977
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
1978
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling putSfvbThemeAttributes.');
1979
+ }
1980
+ if (requestParameters.themeOid === null || requestParameters.themeOid === undefined) {
1981
+ throw new runtime.RequiredError('themeOid', 'Required parameter requestParameters.themeOid was null or undefined when calling putSfvbThemeAttributes.');
1982
+ }
1983
+ if (requestParameters.attributeUpdateRequest === null || requestParameters.attributeUpdateRequest === undefined) {
1984
+ throw new runtime.RequiredError('attributeUpdateRequest', 'Required parameter requestParameters.attributeUpdateRequest was null or undefined when calling putSfvbThemeAttributes.');
1985
+ }
1986
+ queryParameters = {};
1987
+ headerParameters = {};
1988
+ headerParameters['Content-Type'] = 'application/json';
1989
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
1990
+ // oauth required
1991
+ _a = headerParameters;
1992
+ _b = "Authorization";
1993
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
1994
+ case 1:
1995
+ // oauth required
1996
+ _a[_b] = _c.sent();
1997
+ _c.label = 2;
1998
+ case 2:
1999
+ if (this.configuration && this.configuration.apiKey) {
2000
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
2001
+ }
2002
+ return [4 /*yield*/, this.request({
2003
+ path: "/sfvb/storefronts/{storefront_oid}/themes/{theme_oid}/attributes".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("theme_oid", "}"), encodeURIComponent(String(requestParameters.themeOid))),
2004
+ method: 'PUT',
2005
+ headers: headerParameters,
2006
+ query: queryParameters,
2007
+ body: (0, models_1.SfvbThemeAttributeUpdateRequestToJSON)(requestParameters.attributeUpdateRequest),
2008
+ }, initOverrides)];
2009
+ case 3:
2010
+ response = _c.sent();
2011
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbThemeAttributesResponseFromJSON)(jsonValue); })];
2012
+ }
2013
+ });
2014
+ });
2015
+ };
2016
+ /**
2017
+ * 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.
2018
+ * Change a theme\'s colors, fonts and settings
2019
+ */
2020
+ SfvbApi.prototype.putSfvbThemeAttributes = function (requestParameters, initOverrides) {
2021
+ return __awaiter(this, void 0, void 0, function () {
2022
+ var response;
2023
+ return __generator(this, function (_a) {
2024
+ switch (_a.label) {
2025
+ case 0: return [4 /*yield*/, this.putSfvbThemeAttributesRaw(requestParameters, initOverrides)];
2026
+ case 1:
2027
+ response = _a.sent();
2028
+ return [4 /*yield*/, response.value()];
2029
+ case 2: return [2 /*return*/, _a.sent()];
2030
+ }
2031
+ });
2032
+ });
2033
+ };
1905
2034
  /**
1906
2035
  * Renders one node in the context of a theme and a page. Unlike compile this is stateful. Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id. One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why.
1907
2036
  * Render a CJSON node to HTML
@@ -0,0 +1,103 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { SfvbThemeFont } from './SfvbThemeFont';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface SfvbThemeAttribute
17
+ */
18
+ export interface SfvbThemeAttribute {
19
+ /**
20
+ * What the declaring template falls back to when this slot has no value.
21
+ * @type {string}
22
+ * @memberof SfvbThemeAttribute
23
+ */
24
+ default_value?: string;
25
+ /**
26
+ * True when the theme marks this slot as on its way out. Prefer not to build on it.
27
+ * @type {boolean}
28
+ * @memberof SfvbThemeAttribute
29
+ */
30
+ deprecated?: boolean;
31
+ /**
32
+ * What this slot is for, where the theme author documented it.
33
+ * @type {string}
34
+ * @memberof SfvbThemeAttribute
35
+ */
36
+ description?: string;
37
+ /**
38
+ *
39
+ * @type {SfvbThemeFont}
40
+ * @memberof SfvbThemeAttribute
41
+ */
42
+ font?: SfvbThemeFont;
43
+ /**
44
+ * Slot name, for example Theme Color 01. Returned in the casing the theme's templates declare, which may differ from the casing you wrote. Compare case insensitively.
45
+ * @type {string}
46
+ * @memberof SfvbThemeAttribute
47
+ */
48
+ name?: string;
49
+ /**
50
+ * What kind of slot this is, taken from the template that declares it rather than guessed from the value. orphan means nothing declares it.
51
+ * @type {string}
52
+ * @memberof SfvbThemeAttribute
53
+ */
54
+ type?: SfvbThemeAttributeTypeEnum;
55
+ /**
56
+ * True when no template in this theme references this name. Writing such a name is allowed and is how the builder stores its own settings, but if you did not mean to create one this is a misspelling and the write changed nothing visible.
57
+ * @type {boolean}
58
+ * @memberof SfvbThemeAttribute
59
+ */
60
+ undeclared?: boolean;
61
+ /**
62
+ * True when the slot is declared but nothing in the theme actually reads it, so setting it has no visible effect.
63
+ * @type {boolean}
64
+ * @memberof SfvbThemeAttribute
65
+ */
66
+ unused?: boolean;
67
+ /**
68
+ * The applied value. For a colour this is a hex or rgb string, for a boolean the text true or false, for a font the raw JSON document also given in the font field. When the stored value is empty the current preset's default is filled in here.
69
+ * @type {string}
70
+ * @memberof SfvbThemeAttribute
71
+ */
72
+ value?: string;
73
+ }
74
+ /**
75
+ * @export
76
+ */
77
+ export declare const SfvbThemeAttributeTypeEnum: {
78
+ readonly String: "string";
79
+ readonly Color: "color";
80
+ readonly Rgba: "rgba";
81
+ readonly Boolean: "boolean";
82
+ readonly Integer: "integer";
83
+ readonly Html: "html";
84
+ readonly Orphan: "orphan";
85
+ readonly Multiline: "multiline";
86
+ readonly Reserved: "reserved";
87
+ readonly Itemset: "itemset";
88
+ readonly Slider: "slider";
89
+ readonly Simplelist: "simplelist";
90
+ readonly Definitionlist: "definitionlist";
91
+ readonly Pagecollection: "pagecollection";
92
+ readonly Font: "font";
93
+ readonly Videolist: "videolist";
94
+ readonly Mailinglist: "mailinglist";
95
+ };
96
+ export type SfvbThemeAttributeTypeEnum = typeof SfvbThemeAttributeTypeEnum[keyof typeof SfvbThemeAttributeTypeEnum];
97
+ /**
98
+ * Check if a given object implements the SfvbThemeAttribute interface.
99
+ */
100
+ export declare function instanceOfSfvbThemeAttribute(value: object): boolean;
101
+ export declare function SfvbThemeAttributeFromJSON(json: any): SfvbThemeAttribute;
102
+ export declare function SfvbThemeAttributeFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbThemeAttribute;
103
+ export declare function SfvbThemeAttributeToJSON(value?: SfvbThemeAttribute | null): any;
@@ -0,0 +1,89 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.SfvbThemeAttributeToJSON = exports.SfvbThemeAttributeFromJSONTyped = exports.SfvbThemeAttributeFromJSON = exports.instanceOfSfvbThemeAttribute = exports.SfvbThemeAttributeTypeEnum = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ var SfvbThemeFont_1 = require("./SfvbThemeFont");
19
+ /**
20
+ * @export
21
+ */
22
+ exports.SfvbThemeAttributeTypeEnum = {
23
+ String: 'string',
24
+ Color: 'color',
25
+ Rgba: 'rgba',
26
+ Boolean: 'boolean',
27
+ Integer: 'integer',
28
+ Html: 'html',
29
+ Orphan: 'orphan',
30
+ Multiline: 'multiline',
31
+ Reserved: 'reserved',
32
+ Itemset: 'itemset',
33
+ Slider: 'slider',
34
+ Simplelist: 'simplelist',
35
+ Definitionlist: 'definitionlist',
36
+ Pagecollection: 'pagecollection',
37
+ Font: 'font',
38
+ Videolist: 'videolist',
39
+ Mailinglist: 'mailinglist'
40
+ };
41
+ /**
42
+ * Check if a given object implements the SfvbThemeAttribute interface.
43
+ */
44
+ function instanceOfSfvbThemeAttribute(value) {
45
+ var isInstance = true;
46
+ return isInstance;
47
+ }
48
+ exports.instanceOfSfvbThemeAttribute = instanceOfSfvbThemeAttribute;
49
+ function SfvbThemeAttributeFromJSON(json) {
50
+ return SfvbThemeAttributeFromJSONTyped(json, false);
51
+ }
52
+ exports.SfvbThemeAttributeFromJSON = SfvbThemeAttributeFromJSON;
53
+ function SfvbThemeAttributeFromJSONTyped(json, ignoreDiscriminator) {
54
+ if ((json === undefined) || (json === null)) {
55
+ return json;
56
+ }
57
+ return {
58
+ 'default_value': !(0, runtime_1.exists)(json, 'default_value') ? undefined : json['default_value'],
59
+ 'deprecated': !(0, runtime_1.exists)(json, 'deprecated') ? undefined : json['deprecated'],
60
+ 'description': !(0, runtime_1.exists)(json, 'description') ? undefined : json['description'],
61
+ 'font': !(0, runtime_1.exists)(json, 'font') ? undefined : (0, SfvbThemeFont_1.SfvbThemeFontFromJSON)(json['font']),
62
+ 'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
63
+ 'type': !(0, runtime_1.exists)(json, 'type') ? undefined : json['type'],
64
+ 'undeclared': !(0, runtime_1.exists)(json, 'undeclared') ? undefined : json['undeclared'],
65
+ 'unused': !(0, runtime_1.exists)(json, 'unused') ? undefined : json['unused'],
66
+ 'value': !(0, runtime_1.exists)(json, 'value') ? undefined : json['value'],
67
+ };
68
+ }
69
+ exports.SfvbThemeAttributeFromJSONTyped = SfvbThemeAttributeFromJSONTyped;
70
+ function SfvbThemeAttributeToJSON(value) {
71
+ if (value === undefined) {
72
+ return undefined;
73
+ }
74
+ if (value === null) {
75
+ return null;
76
+ }
77
+ return {
78
+ 'default_value': value.default_value,
79
+ 'deprecated': value.deprecated,
80
+ 'description': value.description,
81
+ 'font': (0, SfvbThemeFont_1.SfvbThemeFontToJSON)(value.font),
82
+ 'name': value.name,
83
+ 'type': value.type,
84
+ 'undeclared': value.undeclared,
85
+ 'unused': value.unused,
86
+ 'value': value.value,
87
+ };
88
+ }
89
+ exports.SfvbThemeAttributeToJSON = SfvbThemeAttributeToJSON;
@@ -0,0 +1,64 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { SfvbThemeFont } from './SfvbThemeFont';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface SfvbThemeAttributeUpdate
17
+ */
18
+ export interface SfvbThemeAttributeUpdate {
19
+ /**
20
+ *
21
+ * @type {SfvbThemeFont}
22
+ * @memberof SfvbThemeAttributeUpdate
23
+ */
24
+ font?: SfvbThemeFont;
25
+ /**
26
+ * Slot name. Matched without regard to case against what the theme already has, so you do not have to reproduce the exact casing. A name nothing matches creates a new slot.
27
+ * @type {string}
28
+ * @memberof SfvbThemeAttributeUpdate
29
+ */
30
+ name?: string;
31
+ /**
32
+ * Only consulted when creating a slot the theme does not already have. For a slot that exists the declared type always wins, because the templates decide it and not the caller.
33
+ * @type {string}
34
+ * @memberof SfvbThemeAttributeUpdate
35
+ */
36
+ type?: SfvbThemeAttributeUpdateTypeEnum;
37
+ /**
38
+ * The value to store. An empty string clears the slot, which makes it fall back to the theme's default rather than removing it. Ignored for a font when the font field is supplied.
39
+ * @type {string}
40
+ * @memberof SfvbThemeAttributeUpdate
41
+ */
42
+ value?: string;
43
+ }
44
+ /**
45
+ * @export
46
+ */
47
+ export declare const SfvbThemeAttributeUpdateTypeEnum: {
48
+ readonly Color: "color";
49
+ readonly Rgba: "rgba";
50
+ readonly Font: "font";
51
+ readonly String: "string";
52
+ readonly Multiline: "multiline";
53
+ readonly Html: "html";
54
+ readonly Boolean: "boolean";
55
+ readonly Integer: "integer";
56
+ };
57
+ export type SfvbThemeAttributeUpdateTypeEnum = typeof SfvbThemeAttributeUpdateTypeEnum[keyof typeof SfvbThemeAttributeUpdateTypeEnum];
58
+ /**
59
+ * Check if a given object implements the SfvbThemeAttributeUpdate interface.
60
+ */
61
+ export declare function instanceOfSfvbThemeAttributeUpdate(value: object): boolean;
62
+ export declare function SfvbThemeAttributeUpdateFromJSON(json: any): SfvbThemeAttributeUpdate;
63
+ export declare function SfvbThemeAttributeUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbThemeAttributeUpdate;
64
+ export declare function SfvbThemeAttributeUpdateToJSON(value?: SfvbThemeAttributeUpdate | null): any;
@@ -0,0 +1,70 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.SfvbThemeAttributeUpdateToJSON = exports.SfvbThemeAttributeUpdateFromJSONTyped = exports.SfvbThemeAttributeUpdateFromJSON = exports.instanceOfSfvbThemeAttributeUpdate = exports.SfvbThemeAttributeUpdateTypeEnum = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ var SfvbThemeFont_1 = require("./SfvbThemeFont");
19
+ /**
20
+ * @export
21
+ */
22
+ exports.SfvbThemeAttributeUpdateTypeEnum = {
23
+ Color: 'color',
24
+ Rgba: 'rgba',
25
+ Font: 'font',
26
+ String: 'string',
27
+ Multiline: 'multiline',
28
+ Html: 'html',
29
+ Boolean: 'boolean',
30
+ Integer: 'integer'
31
+ };
32
+ /**
33
+ * Check if a given object implements the SfvbThemeAttributeUpdate interface.
34
+ */
35
+ function instanceOfSfvbThemeAttributeUpdate(value) {
36
+ var isInstance = true;
37
+ return isInstance;
38
+ }
39
+ exports.instanceOfSfvbThemeAttributeUpdate = instanceOfSfvbThemeAttributeUpdate;
40
+ function SfvbThemeAttributeUpdateFromJSON(json) {
41
+ return SfvbThemeAttributeUpdateFromJSONTyped(json, false);
42
+ }
43
+ exports.SfvbThemeAttributeUpdateFromJSON = SfvbThemeAttributeUpdateFromJSON;
44
+ function SfvbThemeAttributeUpdateFromJSONTyped(json, ignoreDiscriminator) {
45
+ if ((json === undefined) || (json === null)) {
46
+ return json;
47
+ }
48
+ return {
49
+ 'font': !(0, runtime_1.exists)(json, 'font') ? undefined : (0, SfvbThemeFont_1.SfvbThemeFontFromJSON)(json['font']),
50
+ 'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
51
+ 'type': !(0, runtime_1.exists)(json, 'type') ? undefined : json['type'],
52
+ 'value': !(0, runtime_1.exists)(json, 'value') ? undefined : json['value'],
53
+ };
54
+ }
55
+ exports.SfvbThemeAttributeUpdateFromJSONTyped = SfvbThemeAttributeUpdateFromJSONTyped;
56
+ function SfvbThemeAttributeUpdateToJSON(value) {
57
+ if (value === undefined) {
58
+ return undefined;
59
+ }
60
+ if (value === null) {
61
+ return null;
62
+ }
63
+ return {
64
+ 'font': (0, SfvbThemeFont_1.SfvbThemeFontToJSON)(value.font),
65
+ 'name': value.name,
66
+ 'type': value.type,
67
+ 'value': value.value,
68
+ };
69
+ }
70
+ exports.SfvbThemeAttributeUpdateToJSON = SfvbThemeAttributeUpdateToJSON;
@@ -0,0 +1,32 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { SfvbThemeAttributeUpdate } from './SfvbThemeAttributeUpdate';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface SfvbThemeAttributeUpdateRequest
17
+ */
18
+ export interface SfvbThemeAttributeUpdateRequest {
19
+ /**
20
+ * The slots to change. Sending several in one call is preferred over one call each - they are applied together, so a palette lands as a single change rather than as a sequence a shopper could see halfway through.
21
+ * @type {Array<SfvbThemeAttributeUpdate>}
22
+ * @memberof SfvbThemeAttributeUpdateRequest
23
+ */
24
+ attributes?: Array<SfvbThemeAttributeUpdate>;
25
+ }
26
+ /**
27
+ * Check if a given object implements the SfvbThemeAttributeUpdateRequest interface.
28
+ */
29
+ export declare function instanceOfSfvbThemeAttributeUpdateRequest(value: object): boolean;
30
+ export declare function SfvbThemeAttributeUpdateRequestFromJSON(json: any): SfvbThemeAttributeUpdateRequest;
31
+ export declare function SfvbThemeAttributeUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbThemeAttributeUpdateRequest;
32
+ export declare function SfvbThemeAttributeUpdateRequestToJSON(value?: SfvbThemeAttributeUpdateRequest | null): any;