ultracart_rest_api_v2_typescript 4.1.176 → 4.1.177
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.
- package/.openapi-generator/FILES +4 -0
- package/README.md +3 -2
- package/dist/apis/SfvbApi.d.ts +181 -1
- package/dist/apis/SfvbApi.js +387 -0
- package/dist/models/SfvbBlogPostDetail.d.ts +116 -0
- package/dist/models/SfvbBlogPostDetail.js +79 -0
- package/dist/models/SfvbBlogPostImage.d.ts +73 -0
- package/dist/models/SfvbBlogPostImage.js +64 -0
- package/dist/models/SfvbBlogPostImageRequest.d.ts +61 -0
- package/dist/models/SfvbBlogPostImageRequest.js +60 -0
- package/dist/models/SfvbBlogPostRequest.d.ts +88 -0
- package/dist/models/SfvbBlogPostRequest.js +74 -0
- package/dist/models/SfvbPageAttributeUpdate.d.ts +1 -1
- package/dist/models/index.d.ts +4 -0
- package/dist/models/index.js +4 -0
- package/package.json +1 -1
- package/src/apis/SfvbApi.ts +440 -0
- package/src/models/SfvbBlogPostDetail.ts +186 -0
- package/src/models/SfvbBlogPostImage.ts +123 -0
- package/src/models/SfvbBlogPostImageRequest.ts +107 -0
- package/src/models/SfvbBlogPostRequest.ts +142 -0
- package/src/models/SfvbPageAttributeUpdate.ts +1 -1
- package/src/models/index.ts +4 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -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
|
package/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# UltraCart Typescript SDK
|
|
2
|
-
## ultracart_rest_api_v2_typescript@4.1.
|
|
2
|
+
## ultracart_rest_api_v2_typescript@4.1.177
|
|
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.
|
|
9
|
+
npm install ultracart_rest_api_v2_typescript@4.1.177 --save
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
@@ -84,6 +84,7 @@ Not every change is committed to every SDK.
|
|
|
84
84
|
|
|
85
85
|
| Version | Date | Comments |
|
|
86
86
|
| --: | :-: | --- |
|
|
87
|
+
| 4.1.177 | 09/30/2026 | sfvb internal testing |
|
|
87
88
|
| 4.1.176 | 09/29/2026 | taxcloud tax provider testing |
|
|
88
89
|
| 4.1.175 | 09/29/2026 | sfvb internal testing |
|
|
89
90
|
| 4.1.174 | 09/25/2026 | sfvb internal testing |
|
package/dist/apis/SfvbApi.d.ts
CHANGED
|
@@ -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, 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
|
}
|
|
@@ -202,6 +220,10 @@ export interface GetSfvbUpsellPathRequest {
|
|
|
202
220
|
statsEnd?: string;
|
|
203
221
|
statsWeekdays?: string;
|
|
204
222
|
}
|
|
223
|
+
export interface InsertSfvbBlogPostRequest {
|
|
224
|
+
storefrontOid: number;
|
|
225
|
+
blogPostRequest: SfvbBlogPostRequest;
|
|
226
|
+
}
|
|
205
227
|
export interface InsertSfvbPageRequest {
|
|
206
228
|
storefrontOid: number;
|
|
207
229
|
pageCreateRequest: SfvbPageCreateRequest;
|
|
@@ -435,6 +457,11 @@ export interface UnarchiveSfvbUpsellPathRequest {
|
|
|
435
457
|
storefrontOid: number;
|
|
436
458
|
upsellPathOid: number;
|
|
437
459
|
}
|
|
460
|
+
export interface UpdateSfvbBlogPostRequest {
|
|
461
|
+
storefrontOid: number;
|
|
462
|
+
blogPostOid: number;
|
|
463
|
+
blogPostRequest: SfvbBlogPostRequest;
|
|
464
|
+
}
|
|
438
465
|
export interface UpdateSfvbUpsellOfferRequest {
|
|
439
466
|
storefrontOid: number;
|
|
440
467
|
upsellOfferOid: number;
|
|
@@ -514,6 +541,22 @@ export interface SfvbApiInterface {
|
|
|
514
541
|
* Archive an upsell path
|
|
515
542
|
*/
|
|
516
543
|
archiveSfvbUpsellPath(requestParameters: ArchiveSfvbUpsellPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPath>;
|
|
544
|
+
/**
|
|
545
|
+
* 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.
|
|
546
|
+
* @summary Attach an image to a blog post
|
|
547
|
+
* @param {number} storefrontOid
|
|
548
|
+
* @param {number} blogPostOid
|
|
549
|
+
* @param {SfvbBlogPostImageRequest} blogPostImageRequest Image to attach
|
|
550
|
+
* @param {*} [options] Override http request option.
|
|
551
|
+
* @throws {RequiredError}
|
|
552
|
+
* @memberof SfvbApiInterface
|
|
553
|
+
*/
|
|
554
|
+
attachSfvbBlogPostImageRaw(requestParameters: AttachSfvbBlogPostImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbBlogPostDetail>>;
|
|
555
|
+
/**
|
|
556
|
+
* 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.
|
|
557
|
+
* Attach an image to a blog post
|
|
558
|
+
*/
|
|
559
|
+
attachSfvbBlogPostImage(requestParameters: AttachSfvbBlogPostImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
|
|
517
560
|
/**
|
|
518
561
|
* 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
562
|
* @summary Compile CJSON to Velocity
|
|
@@ -557,6 +600,21 @@ export interface SfvbApiInterface {
|
|
|
557
600
|
* Create a preview session
|
|
558
601
|
*/
|
|
559
602
|
createSfvbPreviewSession(requestParameters: CreateSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
|
|
603
|
+
/**
|
|
604
|
+
* Takes the post off every page and deletes it. There is no undo. A post that is not a draft needs sfvb_publish.
|
|
605
|
+
* @summary Delete a blog post
|
|
606
|
+
* @param {number} storefrontOid
|
|
607
|
+
* @param {number} blogPostOid
|
|
608
|
+
* @param {*} [options] Override http request option.
|
|
609
|
+
* @throws {RequiredError}
|
|
610
|
+
* @memberof SfvbApiInterface
|
|
611
|
+
*/
|
|
612
|
+
deleteSfvbBlogPostRaw(requestParameters: DeleteSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
613
|
+
/**
|
|
614
|
+
* Takes the post off every page and deletes it. There is no undo. A post that is not a draft needs sfvb_publish.
|
|
615
|
+
* Delete a blog post
|
|
616
|
+
*/
|
|
617
|
+
deleteSfvbBlogPost(requestParameters: DeleteSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
560
618
|
/**
|
|
561
619
|
* Recoverable from the recycle bin.
|
|
562
620
|
* @summary Delete a storefront file
|
|
@@ -640,6 +698,22 @@ export interface SfvbApiInterface {
|
|
|
640
698
|
* Delete a preview session
|
|
641
699
|
*/
|
|
642
700
|
deleteSfvbPreviewSession(requestParameters: DeleteSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
701
|
+
/**
|
|
702
|
+
* 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.
|
|
703
|
+
* @summary Detach an image from a blog post
|
|
704
|
+
* @param {number} storefrontOid
|
|
705
|
+
* @param {number} blogPostOid
|
|
706
|
+
* @param {SfvbBlogPostImageRequest} blogPostImageRequest Image to detach
|
|
707
|
+
* @param {*} [options] Override http request option.
|
|
708
|
+
* @throws {RequiredError}
|
|
709
|
+
* @memberof SfvbApiInterface
|
|
710
|
+
*/
|
|
711
|
+
detachSfvbBlogPostImageRaw(requestParameters: DetachSfvbBlogPostImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbBlogPostDetail>>;
|
|
712
|
+
/**
|
|
713
|
+
* 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.
|
|
714
|
+
* Detach an image from a blog post
|
|
715
|
+
*/
|
|
716
|
+
detachSfvbBlogPostImage(requestParameters: DetachSfvbBlogPostImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
|
|
643
717
|
/**
|
|
644
718
|
* 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
719
|
* @summary Disable an upsell offer
|
|
@@ -763,6 +837,21 @@ export interface SfvbApiInterface {
|
|
|
763
837
|
* End an experiment
|
|
764
838
|
*/
|
|
765
839
|
endSfvbExperiment(requestParameters: EndSfvbExperimentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbExperiment>;
|
|
840
|
+
/**
|
|
841
|
+
* 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.
|
|
842
|
+
* @summary Read a blog post
|
|
843
|
+
* @param {number} storefrontOid
|
|
844
|
+
* @param {number} blogPostOid
|
|
845
|
+
* @param {*} [options] Override http request option.
|
|
846
|
+
* @throws {RequiredError}
|
|
847
|
+
* @memberof SfvbApiInterface
|
|
848
|
+
*/
|
|
849
|
+
getSfvbBlogPostRaw(requestParameters: GetSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbBlogPostDetail>>;
|
|
850
|
+
/**
|
|
851
|
+
* 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.
|
|
852
|
+
* Read a blog post
|
|
853
|
+
*/
|
|
854
|
+
getSfvbBlogPost(requestParameters: GetSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
|
|
766
855
|
/**
|
|
767
856
|
*
|
|
768
857
|
* @summary Element types used by a container
|
|
@@ -1144,6 +1233,21 @@ export interface SfvbApiInterface {
|
|
|
1144
1233
|
* Who this token is
|
|
1145
1234
|
*/
|
|
1146
1235
|
getSfvbWhoami(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbWhoamiResponse>;
|
|
1236
|
+
/**
|
|
1237
|
+
* 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.
|
|
1238
|
+
* @summary Create a blog post
|
|
1239
|
+
* @param {number} storefrontOid
|
|
1240
|
+
* @param {SfvbBlogPostRequest} blogPostRequest The blog post to create
|
|
1241
|
+
* @param {*} [options] Override http request option.
|
|
1242
|
+
* @throws {RequiredError}
|
|
1243
|
+
* @memberof SfvbApiInterface
|
|
1244
|
+
*/
|
|
1245
|
+
insertSfvbBlogPostRaw(requestParameters: InsertSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbBlogPostDetail>>;
|
|
1246
|
+
/**
|
|
1247
|
+
* 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.
|
|
1248
|
+
* Create a blog post
|
|
1249
|
+
*/
|
|
1250
|
+
insertSfvbBlogPost(requestParameters: InsertSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
|
|
1147
1251
|
/**
|
|
1148
1252
|
* 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
1253
|
* @summary Create a page
|
|
@@ -1875,6 +1979,22 @@ export interface SfvbApiInterface {
|
|
|
1875
1979
|
* Unarchive an upsell path
|
|
1876
1980
|
*/
|
|
1877
1981
|
unarchiveSfvbUpsellPath(requestParameters: UnarchiveSfvbUpsellPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPath>;
|
|
1982
|
+
/**
|
|
1983
|
+
* 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.
|
|
1984
|
+
* @summary Change a blog post
|
|
1985
|
+
* @param {number} storefrontOid
|
|
1986
|
+
* @param {number} blogPostOid
|
|
1987
|
+
* @param {SfvbBlogPostRequest} blogPostRequest The fields to change
|
|
1988
|
+
* @param {*} [options] Override http request option.
|
|
1989
|
+
* @throws {RequiredError}
|
|
1990
|
+
* @memberof SfvbApiInterface
|
|
1991
|
+
*/
|
|
1992
|
+
updateSfvbBlogPostRaw(requestParameters: UpdateSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbBlogPostDetail>>;
|
|
1993
|
+
/**
|
|
1994
|
+
* 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.
|
|
1995
|
+
* Change a blog post
|
|
1996
|
+
*/
|
|
1997
|
+
updateSfvbBlogPost(requestParameters: UpdateSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
|
|
1878
1998
|
/**
|
|
1879
1999
|
* 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
2000
|
* @summary Update an upsell offer
|
|
@@ -1990,6 +2110,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
1990
2110
|
* Archive an upsell path
|
|
1991
2111
|
*/
|
|
1992
2112
|
archiveSfvbUpsellPath(requestParameters: ArchiveSfvbUpsellPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPath>;
|
|
2113
|
+
/**
|
|
2114
|
+
* 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.
|
|
2115
|
+
* Attach an image to a blog post
|
|
2116
|
+
*/
|
|
2117
|
+
attachSfvbBlogPostImageRaw(requestParameters: AttachSfvbBlogPostImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbBlogPostDetail>>;
|
|
2118
|
+
/**
|
|
2119
|
+
* 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.
|
|
2120
|
+
* Attach an image to a blog post
|
|
2121
|
+
*/
|
|
2122
|
+
attachSfvbBlogPostImage(requestParameters: AttachSfvbBlogPostImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
|
|
1993
2123
|
/**
|
|
1994
2124
|
* 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
2125
|
* Compile CJSON to Velocity
|
|
@@ -2020,6 +2150,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
2020
2150
|
* Create a preview session
|
|
2021
2151
|
*/
|
|
2022
2152
|
createSfvbPreviewSession(requestParameters: CreateSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
|
|
2153
|
+
/**
|
|
2154
|
+
* Takes the post off every page and deletes it. There is no undo. A post that is not a draft needs sfvb_publish.
|
|
2155
|
+
* Delete a blog post
|
|
2156
|
+
*/
|
|
2157
|
+
deleteSfvbBlogPostRaw(requestParameters: DeleteSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
2158
|
+
/**
|
|
2159
|
+
* Takes the post off every page and deletes it. There is no undo. A post that is not a draft needs sfvb_publish.
|
|
2160
|
+
* Delete a blog post
|
|
2161
|
+
*/
|
|
2162
|
+
deleteSfvbBlogPost(requestParameters: DeleteSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
2023
2163
|
/**
|
|
2024
2164
|
* Recoverable from the recycle bin.
|
|
2025
2165
|
* Delete a storefront file
|
|
@@ -2070,6 +2210,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
2070
2210
|
* Delete a preview session
|
|
2071
2211
|
*/
|
|
2072
2212
|
deleteSfvbPreviewSession(requestParameters: DeleteSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
2213
|
+
/**
|
|
2214
|
+
* 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.
|
|
2215
|
+
* Detach an image from a blog post
|
|
2216
|
+
*/
|
|
2217
|
+
detachSfvbBlogPostImageRaw(requestParameters: DetachSfvbBlogPostImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbBlogPostDetail>>;
|
|
2218
|
+
/**
|
|
2219
|
+
* 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.
|
|
2220
|
+
* Detach an image from a blog post
|
|
2221
|
+
*/
|
|
2222
|
+
detachSfvbBlogPostImage(requestParameters: DetachSfvbBlogPostImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
|
|
2073
2223
|
/**
|
|
2074
2224
|
* 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
2225
|
* Disable an upsell offer
|
|
@@ -2150,6 +2300,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
2150
2300
|
* End an experiment
|
|
2151
2301
|
*/
|
|
2152
2302
|
endSfvbExperiment(requestParameters: EndSfvbExperimentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbExperiment>;
|
|
2303
|
+
/**
|
|
2304
|
+
* 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.
|
|
2305
|
+
* Read a blog post
|
|
2306
|
+
*/
|
|
2307
|
+
getSfvbBlogPostRaw(requestParameters: GetSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbBlogPostDetail>>;
|
|
2308
|
+
/**
|
|
2309
|
+
* 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.
|
|
2310
|
+
* Read a blog post
|
|
2311
|
+
*/
|
|
2312
|
+
getSfvbBlogPost(requestParameters: GetSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
|
|
2153
2313
|
/**
|
|
2154
2314
|
* Element types used by a container
|
|
2155
2315
|
*/
|
|
@@ -2396,6 +2556,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
2396
2556
|
* Who this token is
|
|
2397
2557
|
*/
|
|
2398
2558
|
getSfvbWhoami(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbWhoamiResponse>;
|
|
2559
|
+
/**
|
|
2560
|
+
* 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.
|
|
2561
|
+
* Create a blog post
|
|
2562
|
+
*/
|
|
2563
|
+
insertSfvbBlogPostRaw(requestParameters: InsertSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbBlogPostDetail>>;
|
|
2564
|
+
/**
|
|
2565
|
+
* 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.
|
|
2566
|
+
* Create a blog post
|
|
2567
|
+
*/
|
|
2568
|
+
insertSfvbBlogPost(requestParameters: InsertSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
|
|
2399
2569
|
/**
|
|
2400
2570
|
* 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
2571
|
* Create a page
|
|
@@ -2844,6 +3014,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
2844
3014
|
* Unarchive an upsell path
|
|
2845
3015
|
*/
|
|
2846
3016
|
unarchiveSfvbUpsellPath(requestParameters: UnarchiveSfvbUpsellPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPath>;
|
|
3017
|
+
/**
|
|
3018
|
+
* 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.
|
|
3019
|
+
* Change a blog post
|
|
3020
|
+
*/
|
|
3021
|
+
updateSfvbBlogPostRaw(requestParameters: UpdateSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbBlogPostDetail>>;
|
|
3022
|
+
/**
|
|
3023
|
+
* 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.
|
|
3024
|
+
* Change a blog post
|
|
3025
|
+
*/
|
|
3026
|
+
updateSfvbBlogPost(requestParameters: UpdateSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
|
|
2847
3027
|
/**
|
|
2848
3028
|
* 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
3029
|
* Update an upsell offer
|