ultracart_rest_api_v2_typescript 4.1.176 → 4.1.178

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 (35) hide show
  1. package/.openapi-generator/FILES +8 -0
  2. package/README.md +4 -2
  3. package/dist/apis/SfvbApi.d.ts +247 -1
  4. package/dist/apis/SfvbApi.js +523 -0
  5. package/dist/models/SfvbBlogPostDetail.d.ts +116 -0
  6. package/dist/models/SfvbBlogPostDetail.js +79 -0
  7. package/dist/models/SfvbBlogPostImage.d.ts +73 -0
  8. package/dist/models/SfvbBlogPostImage.js +64 -0
  9. package/dist/models/SfvbBlogPostImageRequest.d.ts +61 -0
  10. package/dist/models/SfvbBlogPostImageRequest.js +60 -0
  11. package/dist/models/SfvbBlogPostRequest.d.ts +88 -0
  12. package/dist/models/SfvbBlogPostRequest.js +74 -0
  13. package/dist/models/SfvbPageAttributeUpdate.d.ts +1 -1
  14. package/dist/models/SfvbServerLog.d.ts +91 -0
  15. package/dist/models/SfvbServerLog.js +70 -0
  16. package/dist/models/SfvbServerLogDetail.d.ts +57 -0
  17. package/dist/models/SfvbServerLogDetail.js +60 -0
  18. package/dist/models/SfvbServerLogEntry.d.ts +49 -0
  19. package/dist/models/SfvbServerLogEntry.js +56 -0
  20. package/dist/models/SfvbServerLogsResponse.d.ts +56 -0
  21. package/dist/models/SfvbServerLogsResponse.js +59 -0
  22. package/dist/models/index.d.ts +8 -0
  23. package/dist/models/index.js +8 -0
  24. package/package.json +1 -1
  25. package/src/apis/SfvbApi.ts +604 -0
  26. package/src/models/SfvbBlogPostDetail.ts +186 -0
  27. package/src/models/SfvbBlogPostImage.ts +123 -0
  28. package/src/models/SfvbBlogPostImageRequest.ts +107 -0
  29. package/src/models/SfvbBlogPostRequest.ts +142 -0
  30. package/src/models/SfvbPageAttributeUpdate.ts +1 -1
  31. package/src/models/SfvbServerLog.ts +147 -0
  32. package/src/models/SfvbServerLogDetail.ts +112 -0
  33. package/src/models/SfvbServerLogEntry.ts +91 -0
  34. package/src/models/SfvbServerLogsResponse.ts +106 -0
  35. package/src/models/index.ts +8 -0
@@ -994,6 +994,10 @@ src/models/ScreenRecordingUserProperty.ts
994
994
  src/models/ScreenshotsResponse.ts
995
995
  src/models/SelfConfig.ts
996
996
  src/models/SfvbBlogPost.ts
997
+ src/models/SfvbBlogPostDetail.ts
998
+ src/models/SfvbBlogPostImage.ts
999
+ src/models/SfvbBlogPostImageRequest.ts
1000
+ src/models/SfvbBlogPostRequest.ts
997
1001
  src/models/SfvbBlogPostsResponse.ts
998
1002
  src/models/SfvbCompileRequest.ts
999
1003
  src/models/SfvbCompileResponse.ts
@@ -1073,6 +1077,10 @@ src/models/SfvbPreviewSessionResponse.ts
1073
1077
  src/models/SfvbPreviewUrlResponse.ts
1074
1078
  src/models/SfvbRenderRequest.ts
1075
1079
  src/models/SfvbRenderResponse.ts
1080
+ src/models/SfvbServerLog.ts
1081
+ src/models/SfvbServerLogDetail.ts
1082
+ src/models/SfvbServerLogEntry.ts
1083
+ src/models/SfvbServerLogsResponse.ts
1076
1084
  src/models/SfvbSiteAttribute.ts
1077
1085
  src/models/SfvbSiteAttributeUpdate.ts
1078
1086
  src/models/SfvbSiteAttributeUpdateRequest.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.176
2
+ ## ultracart_rest_api_v2_typescript@4.1.178
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.176 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.178 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -84,6 +84,8 @@ Not every change is committed to every SDK.
84
84
 
85
85
  | Version | Date | Comments |
86
86
  | --: | :-: | --- |
87
+ | 4.1.178 | 09/30/2026 | sfvb internal testing |
88
+ | 4.1.177 | 09/30/2026 | sfvb internal testing |
87
89
  | 4.1.176 | 09/29/2026 | taxcloud tax provider testing |
88
90
  | 4.1.175 | 09/29/2026 | sfvb internal testing |
89
91
  | 4.1.174 | 09/25/2026 | sfvb internal testing |
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { SfvbBlogPostsResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryEntry, SfvbLibraryResponse, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
13
+ import { SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryEntry, SfvbLibraryResponse, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
14
14
  export interface AddSfvbPageBlogPostsRequest {
15
15
  storefrontOid: number;
16
16
  path: string;
@@ -25,6 +25,11 @@ export interface ArchiveSfvbUpsellPathRequest {
25
25
  storefrontOid: number;
26
26
  upsellPathOid: number;
27
27
  }
28
+ export interface AttachSfvbBlogPostImageRequest {
29
+ storefrontOid: number;
30
+ blogPostOid: number;
31
+ blogPostImageRequest: SfvbBlogPostImageRequest;
32
+ }
28
33
  export interface CompileSfvbCjsonRequest {
29
34
  compileRequest: SfvbCompileRequest;
30
35
  }
@@ -35,6 +40,10 @@ export interface CreateSfvbPreviewAccessRequest {
35
40
  export interface CreateSfvbPreviewSessionRequest {
36
41
  storefrontOid: number;
37
42
  }
43
+ export interface DeleteSfvbBlogPostRequest {
44
+ storefrontOid: number;
45
+ blogPostOid: number;
46
+ }
38
47
  export interface DeleteSfvbFileRequest {
39
48
  storefrontOid: number;
40
49
  ifMatch: string;
@@ -63,6 +72,11 @@ export interface DeleteSfvbPreviewSessionRequest {
63
72
  storefrontOid: number;
64
73
  previewSessionId: string;
65
74
  }
75
+ export interface DetachSfvbBlogPostImageRequest {
76
+ storefrontOid: number;
77
+ blogPostOid: number;
78
+ blogPostImageRequest: SfvbBlogPostImageRequest;
79
+ }
66
80
  export interface DisableSfvbUpsellOfferRequest {
67
81
  storefrontOid: number;
68
82
  upsellOfferOid: number;
@@ -98,6 +112,10 @@ export interface EndSfvbExperimentRequest {
98
112
  experimentOid: number;
99
113
  experimentEndRequest?: SfvbExperimentEndRequest;
100
114
  }
115
+ export interface GetSfvbBlogPostRequest {
116
+ storefrontOid: number;
117
+ blogPostOid: number;
118
+ }
101
119
  export interface GetSfvbCjsonUsedElementsRequest {
102
120
  compileRequest: SfvbCompileRequest;
103
121
  }
@@ -171,6 +189,11 @@ export interface GetSfvbPreviewUrlRequest {
171
189
  previewSessionId: string;
172
190
  path?: string;
173
191
  }
192
+ export interface GetSfvbServerLogRequest {
193
+ storefrontOid: number;
194
+ logId: string;
195
+ minLevel?: string;
196
+ }
174
197
  export interface GetSfvbSiteAttributesRequest {
175
198
  storefrontOid: number;
176
199
  }
@@ -202,6 +225,10 @@ export interface GetSfvbUpsellPathRequest {
202
225
  statsEnd?: string;
203
226
  statsWeekdays?: string;
204
227
  }
228
+ export interface InsertSfvbBlogPostRequest {
229
+ storefrontOid: number;
230
+ blogPostRequest: SfvbBlogPostRequest;
231
+ }
205
232
  export interface InsertSfvbPageRequest {
206
233
  storefrontOid: number;
207
234
  pageCreateRequest: SfvbPageCreateRequest;
@@ -259,6 +286,13 @@ export interface ListSfvbPagesRequest {
259
286
  storefrontOid: number;
260
287
  under?: string;
261
288
  }
289
+ export interface ListSfvbServerLogsRequest {
290
+ storefrontOid: number;
291
+ uri?: string;
292
+ since?: string;
293
+ errorsOnly?: boolean;
294
+ limit?: number;
295
+ }
262
296
  export interface ListSfvbTemplatesRequest {
263
297
  storefrontOid: number;
264
298
  pageType?: string;
@@ -435,6 +469,11 @@ export interface UnarchiveSfvbUpsellPathRequest {
435
469
  storefrontOid: number;
436
470
  upsellPathOid: number;
437
471
  }
472
+ export interface UpdateSfvbBlogPostRequest {
473
+ storefrontOid: number;
474
+ blogPostOid: number;
475
+ blogPostRequest: SfvbBlogPostRequest;
476
+ }
438
477
  export interface UpdateSfvbUpsellOfferRequest {
439
478
  storefrontOid: number;
440
479
  upsellOfferOid: number;
@@ -514,6 +553,22 @@ export interface SfvbApiInterface {
514
553
  * Archive an upsell path
515
554
  */
516
555
  archiveSfvbUpsellPath(requestParameters: ArchiveSfvbUpsellPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPath>;
556
+ /**
557
+ * Three calls, like the admin blog editor\'s upload. Request an upload URL with files/upload_url, send the bytes to it, then attach with the key and a filename. No storefront file is created, and the key is redeemed, so it cannot be used twice. default_image replaces the post\'s default image and code replaces the image with that code; with neither, the image is added for use in the body at the url the response reports. JPEG, PNG, GIF or WebP, checked by content. A post that is not a draft needs sfvb_publish.
558
+ * @summary Attach an image to a blog post
559
+ * @param {number} storefrontOid
560
+ * @param {number} blogPostOid
561
+ * @param {SfvbBlogPostImageRequest} blogPostImageRequest Image to attach
562
+ * @param {*} [options] Override http request option.
563
+ * @throws {RequiredError}
564
+ * @memberof SfvbApiInterface
565
+ */
566
+ attachSfvbBlogPostImageRaw(requestParameters: AttachSfvbBlogPostImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbBlogPostDetail>>;
567
+ /**
568
+ * Three calls, like the admin blog editor\'s upload. Request an upload URL with files/upload_url, send the bytes to it, then attach with the key and a filename. No storefront file is created, and the key is redeemed, so it cannot be used twice. default_image replaces the post\'s default image and code replaces the image with that code; with neither, the image is added for use in the body at the url the response reports. JPEG, PNG, GIF or WebP, checked by content. A post that is not a draft needs sfvb_publish.
569
+ * Attach an image to a blog post
570
+ */
571
+ attachSfvbBlogPostImage(requestParameters: AttachSfvbBlogPostImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
517
572
  /**
518
573
  * Compiles a container document to Velocity without storing anything. Supply theme_oid to compile with the theme\'s inherit groups applied; omit it to compile standalone.
519
574
  * @summary Compile CJSON to Velocity
@@ -557,6 +612,21 @@ export interface SfvbApiInterface {
557
612
  * Create a preview session
558
613
  */
559
614
  createSfvbPreviewSession(requestParameters: CreateSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
615
+ /**
616
+ * Takes the post off every page and deletes it. There is no undo. A post that is not a draft needs sfvb_publish.
617
+ * @summary Delete a blog post
618
+ * @param {number} storefrontOid
619
+ * @param {number} blogPostOid
620
+ * @param {*} [options] Override http request option.
621
+ * @throws {RequiredError}
622
+ * @memberof SfvbApiInterface
623
+ */
624
+ deleteSfvbBlogPostRaw(requestParameters: DeleteSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
625
+ /**
626
+ * Takes the post off every page and deletes it. There is no undo. A post that is not a draft needs sfvb_publish.
627
+ * Delete a blog post
628
+ */
629
+ deleteSfvbBlogPost(requestParameters: DeleteSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
560
630
  /**
561
631
  * Recoverable from the recycle bin.
562
632
  * @summary Delete a storefront file
@@ -640,6 +710,22 @@ export interface SfvbApiInterface {
640
710
  * Delete a preview session
641
711
  */
642
712
  deleteSfvbPreviewSession(requestParameters: DeleteSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
713
+ /**
714
+ * Name exactly one of default_image, code or blog_post_multimedia_oid. Removes the image from the post and deletes its stored copy. Take it out of the body too, or the body keeps a broken image. A post that is not a draft needs sfvb_publish.
715
+ * @summary Detach an image from a blog post
716
+ * @param {number} storefrontOid
717
+ * @param {number} blogPostOid
718
+ * @param {SfvbBlogPostImageRequest} blogPostImageRequest Image to detach
719
+ * @param {*} [options] Override http request option.
720
+ * @throws {RequiredError}
721
+ * @memberof SfvbApiInterface
722
+ */
723
+ detachSfvbBlogPostImageRaw(requestParameters: DetachSfvbBlogPostImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbBlogPostDetail>>;
724
+ /**
725
+ * Name exactly one of default_image, code or blog_post_multimedia_oid. Removes the image from the post and deletes its stored copy. Take it out of the body too, or the body keeps a broken image. A post that is not a draft needs sfvb_publish.
726
+ * Detach an image from a blog post
727
+ */
728
+ detachSfvbBlogPostImage(requestParameters: DetachSfvbBlogPostImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
643
729
  /**
644
730
  * Switches the offer off. Disabling one that is switched on is a live change and needs sfvb_publish. An offer that is already off is returned unchanged. There is no delete.
645
731
  * @summary Disable an upsell offer
@@ -763,6 +849,21 @@ export interface SfvbApiInterface {
763
849
  * End an experiment
764
850
  */
765
851
  endSfvbExperiment(requestParameters: EndSfvbExperimentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbExperiment>;
852
+ /**
853
+ * The whole post - body, excerpt, tags, images and where it is shown. An image\'s url is the address to use for it in the body.
854
+ * @summary Read a blog post
855
+ * @param {number} storefrontOid
856
+ * @param {number} blogPostOid
857
+ * @param {*} [options] Override http request option.
858
+ * @throws {RequiredError}
859
+ * @memberof SfvbApiInterface
860
+ */
861
+ getSfvbBlogPostRaw(requestParameters: GetSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbBlogPostDetail>>;
862
+ /**
863
+ * The whole post - body, excerpt, tags, images and where it is shown. An image\'s url is the address to use for it in the body.
864
+ * Read a blog post
865
+ */
866
+ getSfvbBlogPost(requestParameters: GetSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
766
867
  /**
767
868
  *
768
869
  * @summary Element types used by a container
@@ -1022,6 +1123,22 @@ export interface SfvbApiInterface {
1022
1123
  * URL that renders a preview session
1023
1124
  */
1024
1125
  getSfvbPreviewUrl(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewUrlResponse>;
1126
+ /**
1127
+ * One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message. log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session. min_level is debug, info, warn or error, default debug.
1128
+ * @summary Get one storefront render log
1129
+ * @param {number} storefrontOid
1130
+ * @param {string} logId
1131
+ * @param {string} [minLevel]
1132
+ * @param {*} [options] Override http request option.
1133
+ * @throws {RequiredError}
1134
+ * @memberof SfvbApiInterface
1135
+ */
1136
+ getSfvbServerLogRaw(requestParameters: GetSfvbServerLogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbServerLogDetail>>;
1137
+ /**
1138
+ * One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message. log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session. min_level is debug, info, warn or error, default debug.
1139
+ * Get one storefront render log
1140
+ */
1141
+ getSfvbServerLog(requestParameters: GetSfvbServerLogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbServerLogDetail>;
1025
1142
  /**
1026
1143
  * 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.
1027
1144
  * @summary Read a storefront\'s site attributes
@@ -1144,6 +1261,21 @@ export interface SfvbApiInterface {
1144
1261
  * Who this token is
1145
1262
  */
1146
1263
  getSfvbWhoami(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbWhoamiResponse>;
1264
+ /**
1265
+ * title and url_part are required. The post is a draft unless visibility says otherwise, and anything but a draft needs sfvb_publish. The body and excerpt are refused with sfvb.unsafe_html if they could run script, and a url_part another post uses is refused with a 409 and sfvb.blog_post_exists. Assign the post to a page with pages/blog_posts/add, or let the page\'s selectors choose it.
1266
+ * @summary Create a blog post
1267
+ * @param {number} storefrontOid
1268
+ * @param {SfvbBlogPostRequest} blogPostRequest The blog post to create
1269
+ * @param {*} [options] Override http request option.
1270
+ * @throws {RequiredError}
1271
+ * @memberof SfvbApiInterface
1272
+ */
1273
+ insertSfvbBlogPostRaw(requestParameters: InsertSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbBlogPostDetail>>;
1274
+ /**
1275
+ * title and url_part are required. The post is a draft unless visibility says otherwise, and anything but a draft needs sfvb_publish. The body and excerpt are refused with sfvb.unsafe_html if they could run script, and a url_part another post uses is refused with a 409 and sfvb.blog_post_exists. Assign the post to a page with pages/blog_posts/add, or let the page\'s selectors choose it.
1276
+ * Create a blog post
1277
+ */
1278
+ insertSfvbBlogPost(requestParameters: InsertSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
1147
1279
  /**
1148
1280
  * Creates the page and its folder, the way the store admin\'s add page does. The parent page must already exist, and the last part of the path may only contain letters, digits, hyphens and underscores - it is refused, not cleaned. A path that already has a page is refused with a 409 and the code sfvb.page_exists. Without a group_template the page inherits its parent\'s templates, or catalog_group.vm directly under the root. Set attributes and images afterwards with the page attribute and image endpoints, and push the body to the page folder. Always needs sfvb_publish, because the page is live as soon as it exists. Deleting, moving and renaming pages stay in the store admin.
1149
1281
  * @summary Create a page
@@ -1335,6 +1467,24 @@ export interface SfvbApiInterface {
1335
1467
  * List the storefront\'s pages
1336
1468
  */
1337
1469
  listSfvbPages(requestParameters: ListSfvbPagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageListResponse>;
1470
+ /**
1471
+ * The server log the storefront Developer Tools panel shows, one per page render, newest first and without the log text. Each carries counts of error and warning lines, including Velocity problems such as a null #set, so a failing render stands out without reading every log. Filter by uri (a case insensitive contains match on the rendered address) and errors_only. since is 15m, 2h or 1d, or an ISO-8601 time, default 1h; logs are kept for seven days and only the newest 1000. With a filter the newest 200 logs in the window are searched, and more_available says whether older ones were left unread.
1472
+ * @summary List recent storefront render logs
1473
+ * @param {number} storefrontOid
1474
+ * @param {string} [uri]
1475
+ * @param {string} [since]
1476
+ * @param {boolean} [errorsOnly]
1477
+ * @param {number} [limit]
1478
+ * @param {*} [options] Override http request option.
1479
+ * @throws {RequiredError}
1480
+ * @memberof SfvbApiInterface
1481
+ */
1482
+ listSfvbServerLogsRaw(requestParameters: ListSfvbServerLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbServerLogsResponse>>;
1483
+ /**
1484
+ * The server log the storefront Developer Tools panel shows, one per page render, newest first and without the log text. Each carries counts of error and warning lines, including Velocity problems such as a null #set, so a failing render stands out without reading every log. Filter by uri (a case insensitive contains match on the rendered address) and errors_only. since is 15m, 2h or 1d, or an ISO-8601 time, default 1h; logs are kept for seven days and only the newest 1000. With a filter the newest 200 logs in the window are searched, and more_available says whether older ones were left unread.
1485
+ * List recent storefront render logs
1486
+ */
1487
+ listSfvbServerLogs(requestParameters: ListSfvbServerLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbServerLogsResponse>;
1338
1488
  /**
1339
1489
  *
1340
1490
  * @summary List storefronts
@@ -1875,6 +2025,22 @@ export interface SfvbApiInterface {
1875
2025
  * Unarchive an upsell path
1876
2026
  */
1877
2027
  unarchiveSfvbUpsellPath(requestParameters: UnarchiveSfvbUpsellPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPath>;
2028
+ /**
2029
+ * Only the fields sent change; tags, when sent, replaces every tag. The post\'s images and attributes are left alone. Publish or unpublish with visibility. A post that is not a draft before or after the change needs sfvb_publish. The same content rules as create apply.
2030
+ * @summary Change a blog post
2031
+ * @param {number} storefrontOid
2032
+ * @param {number} blogPostOid
2033
+ * @param {SfvbBlogPostRequest} blogPostRequest The fields to change
2034
+ * @param {*} [options] Override http request option.
2035
+ * @throws {RequiredError}
2036
+ * @memberof SfvbApiInterface
2037
+ */
2038
+ updateSfvbBlogPostRaw(requestParameters: UpdateSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbBlogPostDetail>>;
2039
+ /**
2040
+ * Only the fields sent change; tags, when sent, replaces every tag. The post\'s images and attributes are left alone. Publish or unpublish with visibility. A post that is not a draft before or after the change needs sfvb_publish. The same content rules as create apply.
2041
+ * Change a blog post
2042
+ */
2043
+ updateSfvbBlogPost(requestParameters: UpdateSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
1878
2044
  /**
1879
2045
  * A full replace. Send back the whole offer you read, changed, with its hash_sha256 in If-Match. Read only fields are ignored and a writable field left out is cleared. Changing an offer that is switched on, switching one on, or changing upsell_item_id_javascript or offsite_content_url needs sfvb_publish. Settings the API does not show, such as the offer\'s screenshots, are kept.
1880
2046
  * @summary Update an upsell offer
@@ -1990,6 +2156,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
1990
2156
  * Archive an upsell path
1991
2157
  */
1992
2158
  archiveSfvbUpsellPath(requestParameters: ArchiveSfvbUpsellPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPath>;
2159
+ /**
2160
+ * Three calls, like the admin blog editor\'s upload. Request an upload URL with files/upload_url, send the bytes to it, then attach with the key and a filename. No storefront file is created, and the key is redeemed, so it cannot be used twice. default_image replaces the post\'s default image and code replaces the image with that code; with neither, the image is added for use in the body at the url the response reports. JPEG, PNG, GIF or WebP, checked by content. A post that is not a draft needs sfvb_publish.
2161
+ * Attach an image to a blog post
2162
+ */
2163
+ attachSfvbBlogPostImageRaw(requestParameters: AttachSfvbBlogPostImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbBlogPostDetail>>;
2164
+ /**
2165
+ * Three calls, like the admin blog editor\'s upload. Request an upload URL with files/upload_url, send the bytes to it, then attach with the key and a filename. No storefront file is created, and the key is redeemed, so it cannot be used twice. default_image replaces the post\'s default image and code replaces the image with that code; with neither, the image is added for use in the body at the url the response reports. JPEG, PNG, GIF or WebP, checked by content. A post that is not a draft needs sfvb_publish.
2166
+ * Attach an image to a blog post
2167
+ */
2168
+ attachSfvbBlogPostImage(requestParameters: AttachSfvbBlogPostImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
1993
2169
  /**
1994
2170
  * Compiles a container document to Velocity without storing anything. Supply theme_oid to compile with the theme\'s inherit groups applied; omit it to compile standalone.
1995
2171
  * Compile CJSON to Velocity
@@ -2020,6 +2196,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
2020
2196
  * Create a preview session
2021
2197
  */
2022
2198
  createSfvbPreviewSession(requestParameters: CreateSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
2199
+ /**
2200
+ * Takes the post off every page and deletes it. There is no undo. A post that is not a draft needs sfvb_publish.
2201
+ * Delete a blog post
2202
+ */
2203
+ deleteSfvbBlogPostRaw(requestParameters: DeleteSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
2204
+ /**
2205
+ * Takes the post off every page and deletes it. There is no undo. A post that is not a draft needs sfvb_publish.
2206
+ * Delete a blog post
2207
+ */
2208
+ deleteSfvbBlogPost(requestParameters: DeleteSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
2023
2209
  /**
2024
2210
  * Recoverable from the recycle bin.
2025
2211
  * Delete a storefront file
@@ -2070,6 +2256,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
2070
2256
  * Delete a preview session
2071
2257
  */
2072
2258
  deleteSfvbPreviewSession(requestParameters: DeleteSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
2259
+ /**
2260
+ * Name exactly one of default_image, code or blog_post_multimedia_oid. Removes the image from the post and deletes its stored copy. Take it out of the body too, or the body keeps a broken image. A post that is not a draft needs sfvb_publish.
2261
+ * Detach an image from a blog post
2262
+ */
2263
+ detachSfvbBlogPostImageRaw(requestParameters: DetachSfvbBlogPostImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbBlogPostDetail>>;
2264
+ /**
2265
+ * Name exactly one of default_image, code or blog_post_multimedia_oid. Removes the image from the post and deletes its stored copy. Take it out of the body too, or the body keeps a broken image. A post that is not a draft needs sfvb_publish.
2266
+ * Detach an image from a blog post
2267
+ */
2268
+ detachSfvbBlogPostImage(requestParameters: DetachSfvbBlogPostImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
2073
2269
  /**
2074
2270
  * Switches the offer off. Disabling one that is switched on is a live change and needs sfvb_publish. An offer that is already off is returned unchanged. There is no delete.
2075
2271
  * Disable an upsell offer
@@ -2150,6 +2346,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
2150
2346
  * End an experiment
2151
2347
  */
2152
2348
  endSfvbExperiment(requestParameters: EndSfvbExperimentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbExperiment>;
2349
+ /**
2350
+ * The whole post - body, excerpt, tags, images and where it is shown. An image\'s url is the address to use for it in the body.
2351
+ * Read a blog post
2352
+ */
2353
+ getSfvbBlogPostRaw(requestParameters: GetSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbBlogPostDetail>>;
2354
+ /**
2355
+ * The whole post - body, excerpt, tags, images and where it is shown. An image\'s url is the address to use for it in the body.
2356
+ * Read a blog post
2357
+ */
2358
+ getSfvbBlogPost(requestParameters: GetSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
2153
2359
  /**
2154
2360
  * Element types used by a container
2155
2361
  */
@@ -2318,6 +2524,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
2318
2524
  * URL that renders a preview session
2319
2525
  */
2320
2526
  getSfvbPreviewUrl(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewUrlResponse>;
2527
+ /**
2528
+ * One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message. log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session. min_level is debug, info, warn or error, default debug.
2529
+ * Get one storefront render log
2530
+ */
2531
+ getSfvbServerLogRaw(requestParameters: GetSfvbServerLogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbServerLogDetail>>;
2532
+ /**
2533
+ * One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message. log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session. min_level is debug, info, warn or error, default debug.
2534
+ * Get one storefront render log
2535
+ */
2536
+ getSfvbServerLog(requestParameters: GetSfvbServerLogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbServerLogDetail>;
2321
2537
  /**
2322
2538
  * 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.
2323
2539
  * Read a storefront\'s site attributes
@@ -2396,6 +2612,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
2396
2612
  * Who this token is
2397
2613
  */
2398
2614
  getSfvbWhoami(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbWhoamiResponse>;
2615
+ /**
2616
+ * title and url_part are required. The post is a draft unless visibility says otherwise, and anything but a draft needs sfvb_publish. The body and excerpt are refused with sfvb.unsafe_html if they could run script, and a url_part another post uses is refused with a 409 and sfvb.blog_post_exists. Assign the post to a page with pages/blog_posts/add, or let the page\'s selectors choose it.
2617
+ * Create a blog post
2618
+ */
2619
+ insertSfvbBlogPostRaw(requestParameters: InsertSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbBlogPostDetail>>;
2620
+ /**
2621
+ * title and url_part are required. The post is a draft unless visibility says otherwise, and anything but a draft needs sfvb_publish. The body and excerpt are refused with sfvb.unsafe_html if they could run script, and a url_part another post uses is refused with a 409 and sfvb.blog_post_exists. Assign the post to a page with pages/blog_posts/add, or let the page\'s selectors choose it.
2622
+ * Create a blog post
2623
+ */
2624
+ insertSfvbBlogPost(requestParameters: InsertSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
2399
2625
  /**
2400
2626
  * Creates the page and its folder, the way the store admin\'s add page does. The parent page must already exist, and the last part of the path may only contain letters, digits, hyphens and underscores - it is refused, not cleaned. A path that already has a page is refused with a 409 and the code sfvb.page_exists. Without a group_template the page inherits its parent\'s templates, or catalog_group.vm directly under the root. Set attributes and images afterwards with the page attribute and image endpoints, and push the body to the page folder. Always needs sfvb_publish, because the page is live as soon as it exists. Deleting, moving and renaming pages stay in the store admin.
2401
2627
  * Create a page
@@ -2516,6 +2742,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
2516
2742
  * List the storefront\'s pages
2517
2743
  */
2518
2744
  listSfvbPages(requestParameters: ListSfvbPagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageListResponse>;
2745
+ /**
2746
+ * The server log the storefront Developer Tools panel shows, one per page render, newest first and without the log text. Each carries counts of error and warning lines, including Velocity problems such as a null #set, so a failing render stands out without reading every log. Filter by uri (a case insensitive contains match on the rendered address) and errors_only. since is 15m, 2h or 1d, or an ISO-8601 time, default 1h; logs are kept for seven days and only the newest 1000. With a filter the newest 200 logs in the window are searched, and more_available says whether older ones were left unread.
2747
+ * List recent storefront render logs
2748
+ */
2749
+ listSfvbServerLogsRaw(requestParameters: ListSfvbServerLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbServerLogsResponse>>;
2750
+ /**
2751
+ * The server log the storefront Developer Tools panel shows, one per page render, newest first and without the log text. Each carries counts of error and warning lines, including Velocity problems such as a null #set, so a failing render stands out without reading every log. Filter by uri (a case insensitive contains match on the rendered address) and errors_only. since is 15m, 2h or 1d, or an ISO-8601 time, default 1h; logs are kept for seven days and only the newest 1000. With a filter the newest 200 logs in the window are searched, and more_available says whether older ones were left unread.
2752
+ * List recent storefront render logs
2753
+ */
2754
+ listSfvbServerLogs(requestParameters: ListSfvbServerLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbServerLogsResponse>;
2519
2755
  /**
2520
2756
  * List storefronts
2521
2757
  */
@@ -2844,6 +3080,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
2844
3080
  * Unarchive an upsell path
2845
3081
  */
2846
3082
  unarchiveSfvbUpsellPath(requestParameters: UnarchiveSfvbUpsellPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPath>;
3083
+ /**
3084
+ * Only the fields sent change; tags, when sent, replaces every tag. The post\'s images and attributes are left alone. Publish or unpublish with visibility. A post that is not a draft before or after the change needs sfvb_publish. The same content rules as create apply.
3085
+ * Change a blog post
3086
+ */
3087
+ updateSfvbBlogPostRaw(requestParameters: UpdateSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbBlogPostDetail>>;
3088
+ /**
3089
+ * Only the fields sent change; tags, when sent, replaces every tag. The post\'s images and attributes are left alone. Publish or unpublish with visibility. A post that is not a draft before or after the change needs sfvb_publish. The same content rules as create apply.
3090
+ * Change a blog post
3091
+ */
3092
+ updateSfvbBlogPost(requestParameters: UpdateSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
2847
3093
  /**
2848
3094
  * A full replace. Send back the whole offer you read, changed, with its hash_sha256 in If-Match. Read only fields are ignored and a writable field left out is cleared. Changing an offer that is switched on, switching one on, or changing upsell_item_id_javascript or offsite_content_url needs sfvb_publish. Settings the API does not show, such as the offer\'s screenshots, are kept.
2849
3095
  * Update an upsell offer