ultracart_rest_api_v2_typescript 4.1.151 → 4.1.153

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.
Files changed (45) hide show
  1. package/.openapi-generator/FILES +12 -0
  2. package/README.md +4 -2
  3. package/dist/apis/SfvbApi.d.ts +185 -1
  4. package/dist/apis/SfvbApi.js +405 -0
  5. package/dist/models/SfvbPageAttribute.d.ts +96 -0
  6. package/dist/models/SfvbPageAttribute.js +86 -0
  7. package/dist/models/SfvbPageAttributeUpdate.d.ts +56 -0
  8. package/dist/models/SfvbPageAttributeUpdate.js +66 -0
  9. package/dist/models/SfvbPageAttributeUpdateRequest.d.ts +32 -0
  10. package/dist/models/SfvbPageAttributeUpdateRequest.js +51 -0
  11. package/dist/models/SfvbPageMultimedia.d.ts +67 -0
  12. package/dist/models/SfvbPageMultimedia.js +62 -0
  13. package/dist/models/SfvbPageMultimediaRequest.d.ts +49 -0
  14. package/dist/models/SfvbPageMultimediaRequest.js +56 -0
  15. package/dist/models/SfvbPageResponse.d.ts +45 -0
  16. package/dist/models/SfvbPageResponse.js +56 -0
  17. package/dist/models/SfvbThemeAttribute.d.ts +103 -0
  18. package/dist/models/SfvbThemeAttribute.js +89 -0
  19. package/dist/models/SfvbThemeAttributeUpdate.d.ts +64 -0
  20. package/dist/models/SfvbThemeAttributeUpdate.js +70 -0
  21. package/dist/models/SfvbThemeAttributeUpdateRequest.d.ts +32 -0
  22. package/dist/models/SfvbThemeAttributeUpdateRequest.js +51 -0
  23. package/dist/models/SfvbThemeAttributesResponse.d.ts +50 -0
  24. package/dist/models/SfvbThemeAttributesResponse.js +57 -0
  25. package/dist/models/SfvbThemeFont.d.ts +44 -0
  26. package/dist/models/SfvbThemeFont.js +55 -0
  27. package/dist/models/SfvbThemeFontFamily.d.ts +53 -0
  28. package/dist/models/SfvbThemeFontFamily.js +63 -0
  29. package/dist/models/index.d.ts +12 -0
  30. package/dist/models/index.js +12 -0
  31. package/package.json +1 -1
  32. package/src/apis/SfvbApi.ts +472 -0
  33. package/src/models/SfvbPageAttribute.ts +148 -0
  34. package/src/models/SfvbPageAttributeUpdate.ts +98 -0
  35. package/src/models/SfvbPageAttributeUpdateRequest.ts +74 -0
  36. package/src/models/SfvbPageMultimedia.ts +115 -0
  37. package/src/models/SfvbPageMultimediaRequest.ts +91 -0
  38. package/src/models/SfvbPageResponse.ts +96 -0
  39. package/src/models/SfvbThemeAttribute.ts +163 -0
  40. package/src/models/SfvbThemeAttributeUpdate.ts +114 -0
  41. package/src/models/SfvbThemeAttributeUpdateRequest.ts +74 -0
  42. package/src/models/SfvbThemeAttributesResponse.ts +98 -0
  43. package/src/models/SfvbThemeFont.ts +90 -0
  44. package/src/models/SfvbThemeFontFamily.ts +95 -0
  45. package/src/models/index.ts +12 -0
@@ -1015,6 +1015,12 @@ src/models/SfvbFilesResponse.ts
1015
1015
  src/models/SfvbLibraryEntry.ts
1016
1016
  src/models/SfvbLibraryFacet.ts
1017
1017
  src/models/SfvbLibraryResponse.ts
1018
+ src/models/SfvbPageAttribute.ts
1019
+ src/models/SfvbPageAttributeUpdate.ts
1020
+ src/models/SfvbPageAttributeUpdateRequest.ts
1021
+ src/models/SfvbPageMultimedia.ts
1022
+ src/models/SfvbPageMultimediaRequest.ts
1023
+ src/models/SfvbPageResponse.ts
1018
1024
  src/models/SfvbPreviewSessionRequest.ts
1019
1025
  src/models/SfvbPreviewSessionResponse.ts
1020
1026
  src/models/SfvbPreviewUrlResponse.ts
@@ -1023,7 +1029,13 @@ src/models/SfvbRenderResponse.ts
1023
1029
  src/models/SfvbStorefront.ts
1024
1030
  src/models/SfvbStorefrontsResponse.ts
1025
1031
  src/models/SfvbTheme.ts
1032
+ src/models/SfvbThemeAttribute.ts
1033
+ src/models/SfvbThemeAttributeUpdate.ts
1034
+ src/models/SfvbThemeAttributeUpdateRequest.ts
1035
+ src/models/SfvbThemeAttributesResponse.ts
1026
1036
  src/models/SfvbThemeDuplicateRequest.ts
1037
+ src/models/SfvbThemeFont.ts
1038
+ src/models/SfvbThemeFontFamily.ts
1027
1039
  src/models/SfvbThemeJobResponse.ts
1028
1040
  src/models/SfvbThemesResponse.ts
1029
1041
  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.153
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.153 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
85
85
 
86
86
  | Version | Date | Comments |
87
87
  | --: | :-: | --- |
88
+ | 4.1.153 | 09/14/2026 | sfvb internal testing |
89
+ | 4.1.152 | 09/09/2026 | sfvb - internal testing |
88
90
  | 4.1.151 | 09/04/2026 | conversations - added ai agent capabilities |
89
91
  | 4.1.150 | 09/04/2026 | conversations - add ai agent capabilities |
90
92
  | 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, SfvbPageAttributeUpdateRequest, SfvbPageMultimediaRequest, SfvbPageResponse, 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
  }
@@ -22,6 +22,12 @@ export interface DeleteSfvbFileRequest {
22
22
  ifMatch: string;
23
23
  path?: string;
24
24
  }
25
+ export interface DeleteSfvbPageMultimediaRequest {
26
+ storefrontOid: number;
27
+ path: string;
28
+ code?: string;
29
+ _default?: boolean;
30
+ }
25
31
  export interface DeleteSfvbPreviewSessionRequest {
26
32
  storefrontOid: number;
27
33
  previewSessionId: string;
@@ -67,6 +73,10 @@ export interface GetSfvbLibraryEntryRequest {
67
73
  storefrontOid: number;
68
74
  libraryOid: number;
69
75
  }
76
+ export interface GetSfvbPageRequest {
77
+ storefrontOid: number;
78
+ path: string;
79
+ }
70
80
  export interface GetSfvbPreviewUrlRequest {
71
81
  storefrontOid: number;
72
82
  previewSessionId: string;
@@ -76,6 +86,10 @@ export interface GetSfvbThemeRequest {
76
86
  storefrontOid: number;
77
87
  themeOid: number;
78
88
  }
89
+ export interface GetSfvbThemeAttributesRequest {
90
+ storefrontOid: number;
91
+ themeOid: number;
92
+ }
79
93
  export interface GetSfvbThemeJobRequest {
80
94
  storefrontOid: number;
81
95
  jobId: number;
@@ -121,12 +135,27 @@ export interface PutSfvbFileContentRequest {
121
135
  fileWriteRequest: SfvbFileWriteRequest;
122
136
  path?: string;
123
137
  }
138
+ export interface PutSfvbPageAttributesRequest {
139
+ storefrontOid: number;
140
+ path: string;
141
+ pageAttributeUpdateRequest: SfvbPageAttributeUpdateRequest;
142
+ }
143
+ export interface PutSfvbPageMultimediaRequest {
144
+ storefrontOid: number;
145
+ path: string;
146
+ pageMultimediaRequest: SfvbPageMultimediaRequest;
147
+ }
124
148
  export interface PutSfvbPreviewSessionRequest {
125
149
  storefrontOid: number;
126
150
  previewSessionId: string;
127
151
  previewSession: SfvbPreviewSessionRequest;
128
152
  themeOid?: number;
129
153
  }
154
+ export interface PutSfvbThemeAttributesRequest {
155
+ storefrontOid: number;
156
+ themeOid: number;
157
+ attributeUpdateRequest: SfvbThemeAttributeUpdateRequest;
158
+ }
130
159
  export interface RenderSfvbWidgetsRequest {
131
160
  storefrontOid: number;
132
161
  themeOid: number;
@@ -224,6 +253,23 @@ export interface SfvbApiInterface {
224
253
  * Delete a storefront file
225
254
  */
226
255
  deleteSfvbFile(requestParameters: DeleteSfvbFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
256
+ /**
257
+ * Name exactly one of code or default. Removes the page\'s copy of the image; the source file in the page folder is left alone. Always needs sfvb_publish.
258
+ * @summary Detach an image from a page
259
+ * @param {number} storefrontOid
260
+ * @param {string} path Page path, for example /catalog/dispensers/
261
+ * @param {string} [code] Image code to detach
262
+ * @param {boolean} [_default] True to detach the default image
263
+ * @param {*} [options] Override http request option.
264
+ * @throws {RequiredError}
265
+ * @memberof SfvbApiInterface
266
+ */
267
+ deleteSfvbPageMultimediaRaw(requestParameters: DeleteSfvbPageMultimediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPageResponse>>;
268
+ /**
269
+ * Name exactly one of code or default. Removes the page\'s copy of the image; the source file in the page folder is left alone. Always needs sfvb_publish.
270
+ * Detach an image from a page
271
+ */
272
+ deleteSfvbPageMultimedia(requestParameters: DeleteSfvbPageMultimediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageResponse>;
227
273
  /**
228
274
  * Releases the session before its eight hour expiry. Without this the only way to free one is to wait, which is a poor answer for a tool that may open a dozen in an afternoon.
229
275
  * @summary Delete a preview session
@@ -377,6 +423,21 @@ export interface SfvbApiInterface {
377
423
  * Read one library entry including its CJSON
378
424
  */
379
425
  getSfvbLibraryEntry(requestParameters: GetSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
426
+ /**
427
+ * What the pageattribute and pageimage elements render for this page. These are not in any file, which is why a page folder can be empty and its elements still render something. Attributes and image codes a template declares but nothing has set are included, so the response describes what the page can show rather than only what has been saved.
428
+ * @summary Read a page\'s attributes and images
429
+ * @param {number} storefrontOid
430
+ * @param {string} path Page path, for example /catalog/dispensers/
431
+ * @param {*} [options] Override http request option.
432
+ * @throws {RequiredError}
433
+ * @memberof SfvbApiInterface
434
+ */
435
+ getSfvbPageRaw(requestParameters: GetSfvbPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPageResponse>>;
436
+ /**
437
+ * What the pageattribute and pageimage elements render for this page. These are not in any file, which is why a page folder can be empty and its elements still render something. Attributes and image codes a template declares but nothing has set are included, so the response describes what the page can show rather than only what has been saved.
438
+ * Read a page\'s attributes and images
439
+ */
440
+ getSfvbPage(requestParameters: GetSfvbPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageResponse>;
380
441
  /**
381
442
  * Refuses a session that does not exist, so a URL you receive is for a session that was really there. expires_in_seconds is the time actually remaining, not the configured lifetime. Needs a token that resolves to a user, because a preview session belongs to the person who created it.
382
443
  * @summary URL that renders a preview session
@@ -407,6 +468,21 @@ export interface SfvbApiInterface {
407
468
  * Get a theme
408
469
  */
409
470
  getSfvbTheme(requestParameters: GetSfvbThemeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTheme>;
471
+ /**
472
+ * 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.
473
+ * @summary Read a theme\'s colors, fonts and settings
474
+ * @param {number} storefrontOid
475
+ * @param {number} themeOid
476
+ * @param {*} [options] Override http request option.
477
+ * @throws {RequiredError}
478
+ * @memberof SfvbApiInterface
479
+ */
480
+ getSfvbThemeAttributesRaw(requestParameters: GetSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbThemeAttributesResponse>>;
481
+ /**
482
+ * 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.
483
+ * Read a theme\'s colors, fonts and settings
484
+ */
485
+ getSfvbThemeAttributes(requestParameters: GetSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbThemeAttributesResponse>;
410
486
  /**
411
487
  * 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
488
  * @summary Status of an asynchronous theme job
@@ -601,6 +677,38 @@ export interface SfvbApiInterface {
601
677
  * Write a storefront file
602
678
  */
603
679
  putSfvbFileContent(requestParameters: PutSfvbFileContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
680
+ /**
681
+ * A partial update. Only the attributes you name are changed. Every entry is checked before any is written. List, slider, item set, page collection and video list attributes are refused - edit those in the page editor. Always needs sfvb_publish, because a page\'s attributes are shared by every theme and there is no dormant copy to change instead.
682
+ * @summary Change a page\'s attributes
683
+ * @param {number} storefrontOid
684
+ * @param {string} path Page path, for example /catalog/dispensers/
685
+ * @param {SfvbPageAttributeUpdateRequest} pageAttributeUpdateRequest Attributes to change
686
+ * @param {*} [options] Override http request option.
687
+ * @throws {RequiredError}
688
+ * @memberof SfvbApiInterface
689
+ */
690
+ putSfvbPageAttributesRaw(requestParameters: PutSfvbPageAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPageResponse>>;
691
+ /**
692
+ * A partial update. Only the attributes you name are changed. Every entry is checked before any is written. List, slider, item set, page collection and video list attributes are refused - edit those in the page editor. Always needs sfvb_publish, because a page\'s attributes are shared by every theme and there is no dormant copy to change instead.
693
+ * Change a page\'s attributes
694
+ */
695
+ putSfvbPageAttributes(requestParameters: PutSfvbPageAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageResponse>;
696
+ /**
697
+ * Upload the image with files/upload to the page path followed by a filename first, then name that filename here as either the default image or an image code. The default image is what a pageimage element with no pageImageCode renders, and what a subgroup tile shows. Replaces whatever that slot held. Always needs sfvb_publish.
698
+ * @summary Attach an image to a page
699
+ * @param {number} storefrontOid
700
+ * @param {string} path Page path, for example /catalog/dispensers/
701
+ * @param {SfvbPageMultimediaRequest} pageMultimediaRequest Image to attach
702
+ * @param {*} [options] Override http request option.
703
+ * @throws {RequiredError}
704
+ * @memberof SfvbApiInterface
705
+ */
706
+ putSfvbPageMultimediaRaw(requestParameters: PutSfvbPageMultimediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPageResponse>>;
707
+ /**
708
+ * Upload the image with files/upload to the page path followed by a filename first, then name that filename here as either the default image or an image code. The default image is what a pageimage element with no pageImageCode renders, and what a subgroup tile shows. Replaces whatever that slot held. Always needs sfvb_publish.
709
+ * Attach an image to a page
710
+ */
711
+ putSfvbPageMultimedia(requestParameters: PutSfvbPageMultimediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageResponse>;
604
712
  /**
605
713
  * Stores compiled containers against a session created by createSfvbPreviewSession. Replaces whatever the session held. The session must exist - this does not create one, so a deleted, expired or never issued id is a 404 rather than a new session. Nothing durable is written. Requires a token that resolves to a user, so use the device authorization flow.
606
714
  * @summary Push containers into a preview session
@@ -618,6 +726,22 @@ export interface SfvbApiInterface {
618
726
  * Push containers into a preview session
619
727
  */
620
728
  putSfvbPreviewSession(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
729
+ /**
730
+ * 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.
731
+ * @summary Change a theme\'s colors, fonts and settings
732
+ * @param {number} storefrontOid
733
+ * @param {number} themeOid
734
+ * @param {SfvbThemeAttributeUpdateRequest} attributeUpdateRequest Slots to change
735
+ * @param {*} [options] Override http request option.
736
+ * @throws {RequiredError}
737
+ * @memberof SfvbApiInterface
738
+ */
739
+ putSfvbThemeAttributesRaw(requestParameters: PutSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbThemeAttributesResponse>>;
740
+ /**
741
+ * 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.
742
+ * Change a theme\'s colors, fonts and settings
743
+ */
744
+ putSfvbThemeAttributes(requestParameters: PutSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbThemeAttributesResponse>;
621
745
  /**
622
746
  * 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
747
  * @summary Render a CJSON node to HTML
@@ -798,6 +922,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
798
922
  * Delete a storefront file
799
923
  */
800
924
  deleteSfvbFile(requestParameters: DeleteSfvbFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
925
+ /**
926
+ * Name exactly one of code or default. Removes the page\'s copy of the image; the source file in the page folder is left alone. Always needs sfvb_publish.
927
+ * Detach an image from a page
928
+ */
929
+ deleteSfvbPageMultimediaRaw(requestParameters: DeleteSfvbPageMultimediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPageResponse>>;
930
+ /**
931
+ * Name exactly one of code or default. Removes the page\'s copy of the image; the source file in the page folder is left alone. Always needs sfvb_publish.
932
+ * Detach an image from a page
933
+ */
934
+ deleteSfvbPageMultimedia(requestParameters: DeleteSfvbPageMultimediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageResponse>;
801
935
  /**
802
936
  * Releases the session before its eight hour expiry. Without this the only way to free one is to wait, which is a poor answer for a tool that may open a dozen in an afternoon.
803
937
  * Delete a preview session
@@ -894,6 +1028,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
894
1028
  * Read one library entry including its CJSON
895
1029
  */
896
1030
  getSfvbLibraryEntry(requestParameters: GetSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
1031
+ /**
1032
+ * What the pageattribute and pageimage elements render for this page. These are not in any file, which is why a page folder can be empty and its elements still render something. Attributes and image codes a template declares but nothing has set are included, so the response describes what the page can show rather than only what has been saved.
1033
+ * Read a page\'s attributes and images
1034
+ */
1035
+ getSfvbPageRaw(requestParameters: GetSfvbPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPageResponse>>;
1036
+ /**
1037
+ * What the pageattribute and pageimage elements render for this page. These are not in any file, which is why a page folder can be empty and its elements still render something. Attributes and image codes a template declares but nothing has set are included, so the response describes what the page can show rather than only what has been saved.
1038
+ * Read a page\'s attributes and images
1039
+ */
1040
+ getSfvbPage(requestParameters: GetSfvbPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageResponse>;
897
1041
  /**
898
1042
  * Refuses a session that does not exist, so a URL you receive is for a session that was really there. expires_in_seconds is the time actually remaining, not the configured lifetime. Needs a token that resolves to a user, because a preview session belongs to the person who created it.
899
1043
  * URL that renders a preview session
@@ -912,6 +1056,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
912
1056
  * Get a theme
913
1057
  */
914
1058
  getSfvbTheme(requestParameters: GetSfvbThemeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTheme>;
1059
+ /**
1060
+ * 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.
1061
+ * Read a theme\'s colors, fonts and settings
1062
+ */
1063
+ getSfvbThemeAttributesRaw(requestParameters: GetSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbThemeAttributesResponse>>;
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
+ getSfvbThemeAttributes(requestParameters: GetSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbThemeAttributesResponse>;
915
1069
  /**
916
1070
  * 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
1071
  * Status of an asynchronous theme job
@@ -1038,6 +1192,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
1038
1192
  * Write a storefront file
1039
1193
  */
1040
1194
  putSfvbFileContent(requestParameters: PutSfvbFileContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
1195
+ /**
1196
+ * A partial update. Only the attributes you name are changed. Every entry is checked before any is written. List, slider, item set, page collection and video list attributes are refused - edit those in the page editor. Always needs sfvb_publish, because a page\'s attributes are shared by every theme and there is no dormant copy to change instead.
1197
+ * Change a page\'s attributes
1198
+ */
1199
+ putSfvbPageAttributesRaw(requestParameters: PutSfvbPageAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPageResponse>>;
1200
+ /**
1201
+ * A partial update. Only the attributes you name are changed. Every entry is checked before any is written. List, slider, item set, page collection and video list attributes are refused - edit those in the page editor. Always needs sfvb_publish, because a page\'s attributes are shared by every theme and there is no dormant copy to change instead.
1202
+ * Change a page\'s attributes
1203
+ */
1204
+ putSfvbPageAttributes(requestParameters: PutSfvbPageAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageResponse>;
1205
+ /**
1206
+ * Upload the image with files/upload to the page path followed by a filename first, then name that filename here as either the default image or an image code. The default image is what a pageimage element with no pageImageCode renders, and what a subgroup tile shows. Replaces whatever that slot held. Always needs sfvb_publish.
1207
+ * Attach an image to a page
1208
+ */
1209
+ putSfvbPageMultimediaRaw(requestParameters: PutSfvbPageMultimediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPageResponse>>;
1210
+ /**
1211
+ * Upload the image with files/upload to the page path followed by a filename first, then name that filename here as either the default image or an image code. The default image is what a pageimage element with no pageImageCode renders, and what a subgroup tile shows. Replaces whatever that slot held. Always needs sfvb_publish.
1212
+ * Attach an image to a page
1213
+ */
1214
+ putSfvbPageMultimedia(requestParameters: PutSfvbPageMultimediaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageResponse>;
1041
1215
  /**
1042
1216
  * Stores compiled containers against a session created by createSfvbPreviewSession. Replaces whatever the session held. The session must exist - this does not create one, so a deleted, expired or never issued id is a 404 rather than a new session. Nothing durable is written. Requires a token that resolves to a user, so use the device authorization flow.
1043
1217
  * Push containers into a preview session
@@ -1048,6 +1222,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
1048
1222
  * Push containers into a preview session
1049
1223
  */
1050
1224
  putSfvbPreviewSession(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
1225
+ /**
1226
+ * 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.
1227
+ * Change a theme\'s colors, fonts and settings
1228
+ */
1229
+ putSfvbThemeAttributesRaw(requestParameters: PutSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbThemeAttributesResponse>>;
1230
+ /**
1231
+ * 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.
1232
+ * Change a theme\'s colors, fonts and settings
1233
+ */
1234
+ putSfvbThemeAttributes(requestParameters: PutSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbThemeAttributesResponse>;
1051
1235
  /**
1052
1236
  * 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
1237
  * Render a CJSON node to HTML