ultracart_rest_api_v2_typescript 4.1.227 → 4.1.229
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 +9 -0
- package/README.md +4 -2
- package/dist/apis/SfvbApi.d.ts +243 -1
- package/dist/apis/SfvbApi.js +516 -0
- package/dist/models/SfvbApprovalCreateRequest.d.ts +8 -0
- package/dist/models/SfvbApprovalCreateRequest.js +5 -1
- package/dist/models/SfvbBlogPostDetail.d.ts +6 -0
- package/dist/models/SfvbBlogPostDetail.js +2 -0
- package/dist/models/SfvbBlogPostRequest.d.ts +6 -0
- package/dist/models/SfvbBlogPostRequest.js +2 -0
- package/dist/models/SfvbNotFoundEntry.d.ts +6 -0
- package/dist/models/SfvbNotFoundEntry.js +2 -0
- package/dist/models/SfvbNotFoundSummary.d.ts +62 -0
- package/dist/models/SfvbNotFoundSummary.js +61 -0
- package/dist/models/SfvbRedirectImportRow.d.ts +6 -0
- package/dist/models/SfvbRedirectImportRow.js +2 -0
- package/dist/models/SfvbRedirectRequest.d.ts +6 -0
- package/dist/models/SfvbRedirectRequest.js +2 -0
- package/dist/models/SfvbRedirectResolveBatchRequest.d.ts +31 -0
- package/dist/models/SfvbRedirectResolveBatchRequest.js +50 -0
- package/dist/models/SfvbRedirectResolveBatchResponse.d.ts +50 -0
- package/dist/models/SfvbRedirectResolveBatchResponse.js +57 -0
- package/dist/models/SfvbSiteSeo.d.ts +98 -0
- package/dist/models/SfvbSiteSeo.js +73 -0
- package/dist/models/SfvbSiteSeoChange.d.ts +55 -0
- package/dist/models/SfvbSiteSeoChange.js +58 -0
- package/dist/models/SfvbSiteSeoRequest.d.ts +49 -0
- package/dist/models/SfvbSiteSeoRequest.js +56 -0
- package/dist/models/SfvbStepCounts.d.ts +79 -0
- package/dist/models/SfvbStepCounts.js +66 -0
- package/dist/models/SfvbStepDispatchLog.d.ts +43 -0
- package/dist/models/SfvbStepDispatchLog.js +54 -0
- package/dist/models/SfvbStepDispatchLogsResponse.d.ts +75 -0
- package/dist/models/SfvbStepDispatchLogsResponse.js +66 -0
- package/dist/models/index.d.ts +9 -0
- package/dist/models/index.js +9 -0
- package/package.json +1 -1
- package/src/apis/SfvbApi.ts +593 -0
- package/src/models/SfvbApprovalCreateRequest.ts +16 -1
- package/src/models/SfvbBlogPostDetail.ts +8 -0
- package/src/models/SfvbBlogPostRequest.ts +8 -0
- package/src/models/SfvbNotFoundEntry.ts +8 -0
- package/src/models/SfvbNotFoundSummary.ts +114 -0
- package/src/models/SfvbRedirectImportRow.ts +8 -0
- package/src/models/SfvbRedirectRequest.ts +8 -0
- package/src/models/SfvbRedirectResolveBatchRequest.ts +67 -0
- package/src/models/SfvbRedirectResolveBatchResponse.ts +98 -0
- package/src/models/SfvbSiteSeo.ts +162 -0
- package/src/models/SfvbSiteSeoChange.ts +99 -0
- package/src/models/SfvbSiteSeoRequest.ts +91 -0
- package/src/models/SfvbStepCounts.ts +131 -0
- package/src/models/SfvbStepDispatchLog.ts +83 -0
- package/src/models/SfvbStepDispatchLogsResponse.ts +136 -0
- package/src/models/index.ts +9 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -1146,6 +1146,7 @@ src/models/SfvbNotFoundEntryResponse.ts
|
|
|
1146
1146
|
src/models/SfvbNotFoundHit.ts
|
|
1147
1147
|
src/models/SfvbNotFoundPage.ts
|
|
1148
1148
|
src/models/SfvbNotFoundResponse.ts
|
|
1149
|
+
src/models/SfvbNotFoundSummary.ts
|
|
1149
1150
|
src/models/SfvbPageAttribute.ts
|
|
1150
1151
|
src/models/SfvbPageAttributeUpdate.ts
|
|
1151
1152
|
src/models/SfvbPageAttributeUpdateRequest.ts
|
|
@@ -1195,6 +1196,8 @@ src/models/SfvbRedirectImportResponse.ts
|
|
|
1195
1196
|
src/models/SfvbRedirectImportRow.ts
|
|
1196
1197
|
src/models/SfvbRedirectImportRowResult.ts
|
|
1197
1198
|
src/models/SfvbRedirectRequest.ts
|
|
1199
|
+
src/models/SfvbRedirectResolveBatchRequest.ts
|
|
1200
|
+
src/models/SfvbRedirectResolveBatchResponse.ts
|
|
1198
1201
|
src/models/SfvbRedirectResolveResponse.ts
|
|
1199
1202
|
src/models/SfvbRedirectResolveStep.ts
|
|
1200
1203
|
src/models/SfvbRedirectResponse.ts
|
|
@@ -1227,12 +1230,18 @@ src/models/SfvbSiteAttribute.ts
|
|
|
1227
1230
|
src/models/SfvbSiteAttributeUpdate.ts
|
|
1228
1231
|
src/models/SfvbSiteAttributeUpdateRequest.ts
|
|
1229
1232
|
src/models/SfvbSiteAttributesResponse.ts
|
|
1233
|
+
src/models/SfvbSiteSeo.ts
|
|
1234
|
+
src/models/SfvbSiteSeoChange.ts
|
|
1235
|
+
src/models/SfvbSiteSeoRequest.ts
|
|
1230
1236
|
src/models/SfvbSitemap.ts
|
|
1231
1237
|
src/models/SfvbSitemapFile.ts
|
|
1232
1238
|
src/models/SfvbSitemapsResponse.ts
|
|
1233
1239
|
src/models/SfvbSmartAttribution.ts
|
|
1234
1240
|
src/models/SfvbSmartAttributionPlatform.ts
|
|
1235
1241
|
src/models/SfvbSmartAttributionRequest.ts
|
|
1242
|
+
src/models/SfvbStepCounts.ts
|
|
1243
|
+
src/models/SfvbStepDispatchLog.ts
|
|
1244
|
+
src/models/SfvbStepDispatchLogsResponse.ts
|
|
1236
1245
|
src/models/SfvbStorefront.ts
|
|
1237
1246
|
src/models/SfvbStorefrontsResponse.ts
|
|
1238
1247
|
src/models/SfvbTemplate.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.229
|
|
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.229 --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.229 | 11/04/2026 | sfvb internal testing |
|
|
88
|
+
| 4.1.228 | 11/04/2026 | sfvb internal testing |
|
|
87
89
|
| 4.1.227 | 11/04/2026 | sfvb internal testing |
|
|
88
90
|
| 4.1.226 | 11/04/2026 | sfvb internal testing |
|
|
89
91
|
| 4.1.225 | 11/03/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 { SfvbAffiliateNetwork, SfvbAffiliateNetworkRequest, SfvbAffiliateNetworksResponse, SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbArchiveRequest, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignWriteRequest, SfvbCampaignsResponse, SfvbCodeLibraryEmailsResponse, SfvbCommsListsResponse, SfvbCommsSegmentResponse, SfvbCommsSegmentWriteRequest, SfvbCommsSegmentsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEmail, SfvbEmailRenderRequest, SfvbEmailRenderResponse, SfvbEmailReviewRequest, SfvbEmailUpdateRequest, SfvbEventsAuthRequest, SfvbEventsAuthResponse, SfvbEventsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbFlow, SfvbFlowStatusRequest, SfvbFlowWriteRequest, SfvbFlowsResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeBatchRequest, SfvbItemAttributeBatchResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaDescriptionRequest, SfvbItemMultimediaRequest, SfvbItemPricing, SfvbItemPricingRequest, SfvbItemRelated, SfvbItemRelatedRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPostcardProofRequest, SfvbPostcardProofResponse, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbSequence, SfvbSequenceStepCreateRequest, SfvbSequenceStepCreateResponse, SfvbSequenceStepDeleteResponse, SfvbSequenceStepMoveRequest, SfvbSequenceStepMoveResponse, SfvbSequenceStepUpdateRequest, SfvbSequenceStepUpdateResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbSitemapsResponse, SfvbSmartAttribution, SfvbSmartAttributionRequest, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTrackingAdvancedRequest, SfvbTrackingHtml, SfvbTrackingHtmlRequest, SfvbTrackingHtmlResponse, SfvbTrackingPrivacyRequest, SfvbTrackingProvider, SfvbTrackingProviderRequest, SfvbTrackingProvidersResponse, SfvbTrackingSettingsResponse, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbUtmShortcode, SfvbUtmShortcodeRequest, SfvbUtmShortcodesResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
|
|
13
|
+
import { SfvbAffiliateNetwork, SfvbAffiliateNetworkRequest, SfvbAffiliateNetworksResponse, SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbArchiveRequest, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignWriteRequest, SfvbCampaignsResponse, SfvbCodeLibraryEmailsResponse, SfvbCommsListsResponse, SfvbCommsSegmentResponse, SfvbCommsSegmentWriteRequest, SfvbCommsSegmentsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEmail, SfvbEmailRenderRequest, SfvbEmailRenderResponse, SfvbEmailReviewRequest, SfvbEmailUpdateRequest, SfvbEventsAuthRequest, SfvbEventsAuthResponse, SfvbEventsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbFlow, SfvbFlowStatusRequest, SfvbFlowWriteRequest, SfvbFlowsResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeBatchRequest, SfvbItemAttributeBatchResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaDescriptionRequest, SfvbItemMultimediaRequest, SfvbItemPricing, SfvbItemPricingRequest, SfvbItemRelated, SfvbItemRelatedRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbNotFoundSummary, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPostcardProofRequest, SfvbPostcardProofResponse, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveBatchRequest, SfvbRedirectResolveBatchResponse, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbSequence, SfvbSequenceStepCreateRequest, SfvbSequenceStepCreateResponse, SfvbSequenceStepDeleteResponse, SfvbSequenceStepMoveRequest, SfvbSequenceStepMoveResponse, SfvbSequenceStepUpdateRequest, SfvbSequenceStepUpdateResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbSiteSeo, SfvbSiteSeoRequest, SfvbSitemapsResponse, SfvbSmartAttribution, SfvbSmartAttributionRequest, SfvbStepDispatchLogsResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTrackingAdvancedRequest, SfvbTrackingHtml, SfvbTrackingHtmlRequest, SfvbTrackingHtmlResponse, SfvbTrackingPrivacyRequest, SfvbTrackingProvider, SfvbTrackingProviderRequest, SfvbTrackingProvidersResponse, SfvbTrackingSettingsResponse, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbUtmShortcode, SfvbUtmShortcodeRequest, SfvbUtmShortcodesResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
|
|
14
14
|
export interface AddSfvbPageBlogPostsRequest {
|
|
15
15
|
storefrontOid: number;
|
|
16
16
|
path: string;
|
|
@@ -126,6 +126,10 @@ export interface DeleteSfvbLibraryEntryRequest {
|
|
|
126
126
|
libraryOid: number;
|
|
127
127
|
ifMatch: string;
|
|
128
128
|
}
|
|
129
|
+
export interface DeleteSfvbNotFoundEntryRequest {
|
|
130
|
+
storefrontOid: number;
|
|
131
|
+
notFoundId: string;
|
|
132
|
+
}
|
|
129
133
|
export interface DeleteSfvbPageMultimediaRequest {
|
|
130
134
|
storefrontOid: number;
|
|
131
135
|
path: string;
|
|
@@ -253,10 +257,19 @@ export interface EndSfvbExperimentRequest {
|
|
|
253
257
|
approvalId?: string;
|
|
254
258
|
experimentEndRequest?: SfvbExperimentEndRequest;
|
|
255
259
|
}
|
|
260
|
+
export interface ExportSfvbNotFoundRequest {
|
|
261
|
+
storefrontOid: number;
|
|
262
|
+
includeBots?: boolean;
|
|
263
|
+
includeTokens?: boolean;
|
|
264
|
+
}
|
|
256
265
|
export interface FavoriteSfvbLibraryEntryRequest {
|
|
257
266
|
storefrontOid: number;
|
|
258
267
|
libraryOid: number;
|
|
259
268
|
}
|
|
269
|
+
export interface FixSfvbNotFoundEntryRequest {
|
|
270
|
+
storefrontOid: number;
|
|
271
|
+
notFoundId: string;
|
|
272
|
+
}
|
|
260
273
|
export interface GetSfvbAffiliateNetworkRequest {
|
|
261
274
|
storefrontOid: number;
|
|
262
275
|
affiliateNetworkOid: number;
|
|
@@ -411,6 +424,9 @@ export interface GetSfvbNotFoundEntryRequest {
|
|
|
411
424
|
export interface GetSfvbNotFoundPageRequest {
|
|
412
425
|
storefrontOid: number;
|
|
413
426
|
}
|
|
427
|
+
export interface GetSfvbNotFoundSummaryRequest {
|
|
428
|
+
storefrontOid: number;
|
|
429
|
+
}
|
|
414
430
|
export interface GetSfvbPageRequest {
|
|
415
431
|
storefrontOid: number;
|
|
416
432
|
path: string;
|
|
@@ -462,6 +478,14 @@ export interface GetSfvbSequenceRequest {
|
|
|
462
478
|
sequenceUuid: string;
|
|
463
479
|
waiting?: boolean;
|
|
464
480
|
}
|
|
481
|
+
export interface GetSfvbSequenceStepDispatchLogsRequest {
|
|
482
|
+
storefrontOid: number;
|
|
483
|
+
sequenceUuid: string;
|
|
484
|
+
stepUuid: string;
|
|
485
|
+
since?: string;
|
|
486
|
+
limit?: number;
|
|
487
|
+
offset?: number;
|
|
488
|
+
}
|
|
465
489
|
export interface GetSfvbServerLogRequest {
|
|
466
490
|
storefrontOid: number;
|
|
467
491
|
logId: string;
|
|
@@ -470,6 +494,9 @@ export interface GetSfvbServerLogRequest {
|
|
|
470
494
|
export interface GetSfvbSiteAttributesRequest {
|
|
471
495
|
storefrontOid: number;
|
|
472
496
|
}
|
|
497
|
+
export interface GetSfvbSiteSeoRequest {
|
|
498
|
+
storefrontOid: number;
|
|
499
|
+
}
|
|
473
500
|
export interface GetSfvbSitemapsRequest {
|
|
474
501
|
storefrontOid: number;
|
|
475
502
|
}
|
|
@@ -908,6 +935,10 @@ export interface ResolveSfvbRedirectRequest {
|
|
|
908
935
|
storefrontOid: number;
|
|
909
936
|
path?: string;
|
|
910
937
|
}
|
|
938
|
+
export interface ResolveSfvbRedirectBatchRequest {
|
|
939
|
+
storefrontOid: number;
|
|
940
|
+
redirectResolveBatchRequest: SfvbRedirectResolveBatchRequest;
|
|
941
|
+
}
|
|
911
942
|
export interface ResolveSfvbTemplateRequest {
|
|
912
943
|
storefrontOid: number;
|
|
913
944
|
name: string;
|
|
@@ -1059,6 +1090,12 @@ export interface UpdateSfvbSequenceStepRequest {
|
|
|
1059
1090
|
sequenceStepUpdateRequest: SfvbSequenceStepUpdateRequest;
|
|
1060
1091
|
approvalId?: string;
|
|
1061
1092
|
}
|
|
1093
|
+
export interface UpdateSfvbSiteSeoRequest {
|
|
1094
|
+
storefrontOid: number;
|
|
1095
|
+
ifMatch: string;
|
|
1096
|
+
siteSeoRequest: SfvbSiteSeoRequest;
|
|
1097
|
+
approvalId?: string;
|
|
1098
|
+
}
|
|
1062
1099
|
export interface UpdateSfvbSmartAttributionRequest {
|
|
1063
1100
|
storefrontOid: number;
|
|
1064
1101
|
ifMatch: string;
|
|
@@ -1517,6 +1554,21 @@ export interface SfvbApiInterface {
|
|
|
1517
1554
|
* Delete or retire a library entry
|
|
1518
1555
|
*/
|
|
1519
1556
|
deleteSfvbLibraryEntry(requestParameters: DeleteSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryDeleteResult>;
|
|
1557
|
+
/**
|
|
1558
|
+
* The admin\'s Permanent Ignore button. Despite that label, the next hit on the path records it again as a new entry. To stop counting a path, ignore it instead.
|
|
1559
|
+
* @summary Remove a 404 path from the log
|
|
1560
|
+
* @param {number} storefrontOid
|
|
1561
|
+
* @param {string} notFoundId
|
|
1562
|
+
* @param {*} [options] Override http request option.
|
|
1563
|
+
* @throws {RequiredError}
|
|
1564
|
+
* @memberof SfvbApiInterface
|
|
1565
|
+
*/
|
|
1566
|
+
deleteSfvbNotFoundEntryRaw(requestParameters: DeleteSfvbNotFoundEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
1567
|
+
/**
|
|
1568
|
+
* The admin\'s Permanent Ignore button. Despite that label, the next hit on the path records it again as a new entry. To stop counting a path, ignore it instead.
|
|
1569
|
+
* Remove a 404 path from the log
|
|
1570
|
+
*/
|
|
1571
|
+
deleteSfvbNotFoundEntry(requestParameters: DeleteSfvbNotFoundEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1520
1572
|
/**
|
|
1521
1573
|
* 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.
|
|
1522
1574
|
* @summary Detach an image from a page
|
|
@@ -1941,6 +1993,22 @@ export interface SfvbApiInterface {
|
|
|
1941
1993
|
* End an experiment
|
|
1942
1994
|
*/
|
|
1943
1995
|
endSfvbExperiment(requestParameters: EndSfvbExperimentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbExperiment>;
|
|
1996
|
+
/**
|
|
1997
|
+
* Up to 5,000 open paths, most hits first, as the admin\'s mapping spreadsheet reads them, each with where a redirect rule already sends it. Fixed, mapped and ignored paths are never included. Paths only bots have hit are left out unless include_bots is true. Tokens in paths are redacted unless include_tokens is true. Read only.
|
|
1998
|
+
* @summary Export the open 404 paths
|
|
1999
|
+
* @param {number} storefrontOid
|
|
2000
|
+
* @param {boolean} [includeBots]
|
|
2001
|
+
* @param {boolean} [includeTokens]
|
|
2002
|
+
* @param {*} [options] Override http request option.
|
|
2003
|
+
* @throws {RequiredError}
|
|
2004
|
+
* @memberof SfvbApiInterface
|
|
2005
|
+
*/
|
|
2006
|
+
exportSfvbNotFoundRaw(requestParameters: ExportSfvbNotFoundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbNotFoundResponse>>;
|
|
2007
|
+
/**
|
|
2008
|
+
* Up to 5,000 open paths, most hits first, as the admin\'s mapping spreadsheet reads them, each with where a redirect rule already sends it. Fixed, mapped and ignored paths are never included. Paths only bots have hit are left out unless include_bots is true. Tokens in paths are redacted unless include_tokens is true. Read only.
|
|
2009
|
+
* Export the open 404 paths
|
|
2010
|
+
*/
|
|
2011
|
+
exportSfvbNotFound(requestParameters: ExportSfvbNotFoundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbNotFoundResponse>;
|
|
1944
2012
|
/**
|
|
1945
2013
|
* Bookmarks the entry for the calling user. Idempotent. Owner or anyone the entry is shared with.
|
|
1946
2014
|
* @summary Favorite a library entry
|
|
@@ -1956,6 +2024,21 @@ export interface SfvbApiInterface {
|
|
|
1956
2024
|
* Favorite a library entry
|
|
1957
2025
|
*/
|
|
1958
2026
|
favoriteSfvbLibraryEntry(requestParameters: FavoriteSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
2027
|
+
/**
|
|
2028
|
+
* For a path fixed by creating the page rather than a redirect. It leaves the list; the next hit on the path clears the mark and lists it again. The admin\'s Mark Fixed.
|
|
2029
|
+
* @summary Mark a 404 path fixed
|
|
2030
|
+
* @param {number} storefrontOid
|
|
2031
|
+
* @param {string} notFoundId
|
|
2032
|
+
* @param {*} [options] Override http request option.
|
|
2033
|
+
* @throws {RequiredError}
|
|
2034
|
+
* @memberof SfvbApiInterface
|
|
2035
|
+
*/
|
|
2036
|
+
fixSfvbNotFoundEntryRaw(requestParameters: FixSfvbNotFoundEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbNotFoundEntry>>;
|
|
2037
|
+
/**
|
|
2038
|
+
* For a path fixed by creating the page rather than a redirect. It leaves the list; the next hit on the path clears the mark and lists it again. The admin\'s Mark Fixed.
|
|
2039
|
+
* Mark a 404 path fixed
|
|
2040
|
+
*/
|
|
2041
|
+
fixSfvbNotFoundEntry(requestParameters: FixSfvbNotFoundEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbNotFoundEntry>;
|
|
1959
2042
|
/**
|
|
1960
2043
|
* The network with its conversion_pixel, and the hash_sha256 an update or delete sends back as If-Match.
|
|
1961
2044
|
* @summary Read one affiliate network
|
|
@@ -2544,6 +2627,20 @@ export interface SfvbApiInterface {
|
|
|
2544
2627
|
* What renders the storefront\'s 404 page
|
|
2545
2628
|
*/
|
|
2546
2629
|
getSfvbNotFoundPage(requestParameters: GetSfvbNotFoundPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbNotFoundPage>;
|
|
2630
|
+
/**
|
|
2631
|
+
* The admin\'s 404 charts: hits per day for 30 and 7 days and per hour for 24 hours, bots included, plus up to 10 open paths first seen in the last 30 days. Read only.
|
|
2632
|
+
* @summary The 404 log\'s trend
|
|
2633
|
+
* @param {number} storefrontOid
|
|
2634
|
+
* @param {*} [options] Override http request option.
|
|
2635
|
+
* @throws {RequiredError}
|
|
2636
|
+
* @memberof SfvbApiInterface
|
|
2637
|
+
*/
|
|
2638
|
+
getSfvbNotFoundSummaryRaw(requestParameters: GetSfvbNotFoundSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbNotFoundSummary>>;
|
|
2639
|
+
/**
|
|
2640
|
+
* The admin\'s 404 charts: hits per day for 30 and 7 days and per hour for 24 hours, bots included, plus up to 10 open paths first seen in the last 30 days. Read only.
|
|
2641
|
+
* The 404 log\'s trend
|
|
2642
|
+
*/
|
|
2643
|
+
getSfvbNotFoundSummary(requestParameters: GetSfvbNotFoundSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbNotFoundSummary>;
|
|
2547
2644
|
/**
|
|
2548
2645
|
* 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.
|
|
2549
2646
|
* @summary Read a page\'s attributes and images
|
|
@@ -2753,6 +2850,25 @@ export interface SfvbApiInterface {
|
|
|
2753
2850
|
* Get a campaign\'s or flow\'s steps as a tree
|
|
2754
2851
|
*/
|
|
2755
2852
|
getSfvbSequence(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequence>;
|
|
2853
|
+
/**
|
|
2854
|
+
* Why customers were sent, skipped or ended at this step, newest first, as the admin\'s Dispatch Logs screen shows it, with the step\'s counts. An email step\'s counts are its email\'s; any other step\'s are its own over 90 days. Email addresses and phone numbers in the text are masked. since is 15m, 2h or 7d, or an ISO-8601 time, default 7d; entries are kept 90 days. limit is 1 to 200, default 50; send next_offset as offset for the next page. Read only.
|
|
2855
|
+
* @summary Read a flow or campaign step\'s dispatch log and counts
|
|
2856
|
+
* @param {number} storefrontOid
|
|
2857
|
+
* @param {string} sequenceUuid
|
|
2858
|
+
* @param {string} stepUuid
|
|
2859
|
+
* @param {string} [since]
|
|
2860
|
+
* @param {number} [limit]
|
|
2861
|
+
* @param {number} [offset]
|
|
2862
|
+
* @param {*} [options] Override http request option.
|
|
2863
|
+
* @throws {RequiredError}
|
|
2864
|
+
* @memberof SfvbApiInterface
|
|
2865
|
+
*/
|
|
2866
|
+
getSfvbSequenceStepDispatchLogsRaw(requestParameters: GetSfvbSequenceStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbStepDispatchLogsResponse>>;
|
|
2867
|
+
/**
|
|
2868
|
+
* Why customers were sent, skipped or ended at this step, newest first, as the admin\'s Dispatch Logs screen shows it, with the step\'s counts. An email step\'s counts are its email\'s; any other step\'s are its own over 90 days. Email addresses and phone numbers in the text are masked. since is 15m, 2h or 7d, or an ISO-8601 time, default 7d; entries are kept 90 days. limit is 1 to 200, default 50; send next_offset as offset for the next page. Read only.
|
|
2869
|
+
* Read a flow or campaign step\'s dispatch log and counts
|
|
2870
|
+
*/
|
|
2871
|
+
getSfvbSequenceStepDispatchLogs(requestParameters: GetSfvbSequenceStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbStepDispatchLogsResponse>;
|
|
2756
2872
|
/**
|
|
2757
2873
|
* 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.
|
|
2758
2874
|
* @summary Get one storefront render log
|
|
@@ -2783,6 +2899,20 @@ export interface SfvbApiInterface {
|
|
|
2783
2899
|
* Read a storefront\'s site attributes
|
|
2784
2900
|
*/
|
|
2785
2901
|
getSfvbSiteAttributes(requestParameters: GetSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSiteAttributesResponse>;
|
|
2902
|
+
/**
|
|
2903
|
+
* Canonical Links, Schema.org and Prevent Indexing as true or false, with the default meta description and keywords and the hash to send as If-Match on a change.
|
|
2904
|
+
* @summary Read a storefront\'s search engine settings
|
|
2905
|
+
* @param {number} storefrontOid
|
|
2906
|
+
* @param {*} [options] Override http request option.
|
|
2907
|
+
* @throws {RequiredError}
|
|
2908
|
+
* @memberof SfvbApiInterface
|
|
2909
|
+
*/
|
|
2910
|
+
getSfvbSiteSeoRaw(requestParameters: GetSfvbSiteSeoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSiteSeo>>;
|
|
2911
|
+
/**
|
|
2912
|
+
* Canonical Links, Schema.org and Prevent Indexing as true or false, with the default meta description and keywords and the hash to send as If-Match on a change.
|
|
2913
|
+
* Read a storefront\'s search engine settings
|
|
2914
|
+
*/
|
|
2915
|
+
getSfvbSiteSeo(requestParameters: GetSfvbSiteSeoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSiteSeo>;
|
|
2786
2916
|
/**
|
|
2787
2917
|
* The sitemaps the admin SEO Sitemaps screen lists, with their child files and build times, the Sitemap lines robots.txt serves, and whether Prevent Indexing is on. Read only. The files are rebuilt nightly, so a page change shows in them after the next build.
|
|
2788
2918
|
* @summary Read a storefront\'s sitemaps and robots.txt
|
|
@@ -4217,6 +4347,21 @@ export interface SfvbApiInterface {
|
|
|
4217
4347
|
* What a shopper gets for a path
|
|
4218
4348
|
*/
|
|
4219
4349
|
resolveSfvbRedirect(requestParameters: ResolveSfvbRedirectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRedirectResolveResponse>;
|
|
4350
|
+
/**
|
|
4351
|
+
* Up to 1,000 paths in one call, each followed through the redirect rules exactly as the single resolve does, with counts of how many redirect and how many end on a 404. For checking every old URL of a migrated store. Read only.
|
|
4352
|
+
* @summary What a shopper gets for each of many paths
|
|
4353
|
+
* @param {number} storefrontOid
|
|
4354
|
+
* @param {SfvbRedirectResolveBatchRequest} redirectResolveBatchRequest The paths
|
|
4355
|
+
* @param {*} [options] Override http request option.
|
|
4356
|
+
* @throws {RequiredError}
|
|
4357
|
+
* @memberof SfvbApiInterface
|
|
4358
|
+
*/
|
|
4359
|
+
resolveSfvbRedirectBatchRaw(requestParameters: ResolveSfvbRedirectBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRedirectResolveBatchResponse>>;
|
|
4360
|
+
/**
|
|
4361
|
+
* Up to 1,000 paths in one call, each followed through the redirect rules exactly as the single resolve does, with counts of how many redirect and how many end on a 404. For checking every old URL of a migrated store. Read only.
|
|
4362
|
+
* What a shopper gets for each of many paths
|
|
4363
|
+
*/
|
|
4364
|
+
resolveSfvbRedirectBatch(requestParameters: ResolveSfvbRedirectBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRedirectResolveBatchResponse>;
|
|
4220
4365
|
/**
|
|
4221
4366
|
* A page stores only its template\'s file name. This runs the storefront\'s own template search for that name and returns the file a page naming it renders, relative to the theme. It also lists the theme\'s resource paths in search order with every file of that name below each, so a theme copy overriding a shared core copy, or a copy in a snippets folder that is never used, is visible. exists is false when a page naming the template cannot render.
|
|
4222
4367
|
* @summary Resolve a template name to the file a page renders
|
|
@@ -4676,6 +4821,23 @@ export interface SfvbApiInterface {
|
|
|
4676
4821
|
* Change one step\'s settings or audience filter
|
|
4677
4822
|
*/
|
|
4678
4823
|
updateSfvbSequenceStep(requestParameters: UpdateSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepUpdateResponse>;
|
|
4824
|
+
/**
|
|
4825
|
+
* A partial update of Canonical Links, Schema.org and Prevent Indexing. Send the hash_sha256 you read as If-Match. dry_run reports each change, whether it needs approval and whether that approval needs a fresh code, without saving. Turning Canonical Links or Schema.org on needs no approval. Turning either off, or turning Prevent Indexing on or off, needs an approved site_seo.change request for exactly this change (Approval-Id), and turning Prevent Indexing on asks for an authenticator code even inside an approval session. Always needs sfvb_publish, because the settings apply to every page as soon as they are saved. The admin saves the whole storefront, so a merchant with the screen open can still overwrite a change made here.
|
|
4826
|
+
* @summary Change a storefront\'s search engine settings
|
|
4827
|
+
* @param {number} storefrontOid
|
|
4828
|
+
* @param {string} ifMatch The hash_sha256 from the last read. 428 when absent, 412 when stale.
|
|
4829
|
+
* @param {SfvbSiteSeoRequest} siteSeoRequest The switches to change
|
|
4830
|
+
* @param {string} [approvalId] When the change turns Canonical Links or Schema.org off, or turns Prevent Indexing on or off, the approval_id of an approved site_seo.change request for this change. See POST /sfvb/approvals.
|
|
4831
|
+
* @param {*} [options] Override http request option.
|
|
4832
|
+
* @throws {RequiredError}
|
|
4833
|
+
* @memberof SfvbApiInterface
|
|
4834
|
+
*/
|
|
4835
|
+
updateSfvbSiteSeoRaw(requestParameters: UpdateSfvbSiteSeoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSiteSeo>>;
|
|
4836
|
+
/**
|
|
4837
|
+
* A partial update of Canonical Links, Schema.org and Prevent Indexing. Send the hash_sha256 you read as If-Match. dry_run reports each change, whether it needs approval and whether that approval needs a fresh code, without saving. Turning Canonical Links or Schema.org on needs no approval. Turning either off, or turning Prevent Indexing on or off, needs an approved site_seo.change request for exactly this change (Approval-Id), and turning Prevent Indexing on asks for an authenticator code even inside an approval session. Always needs sfvb_publish, because the settings apply to every page as soon as they are saved. The admin saves the whole storefront, so a merchant with the screen open can still overwrite a change made here.
|
|
4838
|
+
* Change a storefront\'s search engine settings
|
|
4839
|
+
*/
|
|
4840
|
+
updateSfvbSiteSeo(requestParameters: UpdateSfvbSiteSeoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSiteSeo>;
|
|
4679
4841
|
/**
|
|
4680
4842
|
* A partial update of the mode, model, global split and lookback. platforms, when sent, replaces the whole list. The global split must total exactly 1 and the lookback is 7 to 365. On an unconfigured storefront it creates the configuration. Send the hash_sha256 you read as If-Match. Needs sfvb_publish, and when the mode is active or the change makes it active, an approved smart_attribution.change request for exactly this change (Approval-Id), because active mode decides which conversions each platform is sent. A change that stores what is already stored returns the configuration unchanged and uses no approval.
|
|
4681
4843
|
* @summary Change a storefront\'s Smart Attribution configuration
|
|
@@ -5113,6 +5275,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
5113
5275
|
* Delete or retire a library entry
|
|
5114
5276
|
*/
|
|
5115
5277
|
deleteSfvbLibraryEntry(requestParameters: DeleteSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryDeleteResult>;
|
|
5278
|
+
/**
|
|
5279
|
+
* The admin\'s Permanent Ignore button. Despite that label, the next hit on the path records it again as a new entry. To stop counting a path, ignore it instead.
|
|
5280
|
+
* Remove a 404 path from the log
|
|
5281
|
+
*/
|
|
5282
|
+
deleteSfvbNotFoundEntryRaw(requestParameters: DeleteSfvbNotFoundEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
5283
|
+
/**
|
|
5284
|
+
* The admin\'s Permanent Ignore button. Despite that label, the next hit on the path records it again as a new entry. To stop counting a path, ignore it instead.
|
|
5285
|
+
* Remove a 404 path from the log
|
|
5286
|
+
*/
|
|
5287
|
+
deleteSfvbNotFoundEntry(requestParameters: DeleteSfvbNotFoundEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
5116
5288
|
/**
|
|
5117
5289
|
* 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.
|
|
5118
5290
|
* Detach an image from a page
|
|
@@ -5383,6 +5555,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
5383
5555
|
* End an experiment
|
|
5384
5556
|
*/
|
|
5385
5557
|
endSfvbExperiment(requestParameters: EndSfvbExperimentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbExperiment>;
|
|
5558
|
+
/**
|
|
5559
|
+
* Up to 5,000 open paths, most hits first, as the admin\'s mapping spreadsheet reads them, each with where a redirect rule already sends it. Fixed, mapped and ignored paths are never included. Paths only bots have hit are left out unless include_bots is true. Tokens in paths are redacted unless include_tokens is true. Read only.
|
|
5560
|
+
* Export the open 404 paths
|
|
5561
|
+
*/
|
|
5562
|
+
exportSfvbNotFoundRaw(requestParameters: ExportSfvbNotFoundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbNotFoundResponse>>;
|
|
5563
|
+
/**
|
|
5564
|
+
* Up to 5,000 open paths, most hits first, as the admin\'s mapping spreadsheet reads them, each with where a redirect rule already sends it. Fixed, mapped and ignored paths are never included. Paths only bots have hit are left out unless include_bots is true. Tokens in paths are redacted unless include_tokens is true. Read only.
|
|
5565
|
+
* Export the open 404 paths
|
|
5566
|
+
*/
|
|
5567
|
+
exportSfvbNotFound(requestParameters: ExportSfvbNotFoundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbNotFoundResponse>;
|
|
5386
5568
|
/**
|
|
5387
5569
|
* Bookmarks the entry for the calling user. Idempotent. Owner or anyone the entry is shared with.
|
|
5388
5570
|
* Favorite a library entry
|
|
@@ -5393,6 +5575,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
5393
5575
|
* Favorite a library entry
|
|
5394
5576
|
*/
|
|
5395
5577
|
favoriteSfvbLibraryEntry(requestParameters: FavoriteSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
5578
|
+
/**
|
|
5579
|
+
* For a path fixed by creating the page rather than a redirect. It leaves the list; the next hit on the path clears the mark and lists it again. The admin\'s Mark Fixed.
|
|
5580
|
+
* Mark a 404 path fixed
|
|
5581
|
+
*/
|
|
5582
|
+
fixSfvbNotFoundEntryRaw(requestParameters: FixSfvbNotFoundEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbNotFoundEntry>>;
|
|
5583
|
+
/**
|
|
5584
|
+
* For a path fixed by creating the page rather than a redirect. It leaves the list; the next hit on the path clears the mark and lists it again. The admin\'s Mark Fixed.
|
|
5585
|
+
* Mark a 404 path fixed
|
|
5586
|
+
*/
|
|
5587
|
+
fixSfvbNotFoundEntry(requestParameters: FixSfvbNotFoundEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbNotFoundEntry>;
|
|
5396
5588
|
/**
|
|
5397
5589
|
* The network with its conversion_pixel, and the hash_sha256 an update or delete sends back as If-Match.
|
|
5398
5590
|
* Read one affiliate network
|
|
@@ -5781,6 +5973,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
5781
5973
|
* What renders the storefront\'s 404 page
|
|
5782
5974
|
*/
|
|
5783
5975
|
getSfvbNotFoundPage(requestParameters: GetSfvbNotFoundPageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbNotFoundPage>;
|
|
5976
|
+
/**
|
|
5977
|
+
* The admin\'s 404 charts: hits per day for 30 and 7 days and per hour for 24 hours, bots included, plus up to 10 open paths first seen in the last 30 days. Read only.
|
|
5978
|
+
* The 404 log\'s trend
|
|
5979
|
+
*/
|
|
5980
|
+
getSfvbNotFoundSummaryRaw(requestParameters: GetSfvbNotFoundSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbNotFoundSummary>>;
|
|
5981
|
+
/**
|
|
5982
|
+
* The admin\'s 404 charts: hits per day for 30 and 7 days and per hour for 24 hours, bots included, plus up to 10 open paths first seen in the last 30 days. Read only.
|
|
5983
|
+
* The 404 log\'s trend
|
|
5984
|
+
*/
|
|
5985
|
+
getSfvbNotFoundSummary(requestParameters: GetSfvbNotFoundSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbNotFoundSummary>;
|
|
5784
5986
|
/**
|
|
5785
5987
|
* 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.
|
|
5786
5988
|
* Read a page\'s attributes and images
|
|
@@ -5921,6 +6123,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
5921
6123
|
* Get a campaign\'s or flow\'s steps as a tree
|
|
5922
6124
|
*/
|
|
5923
6125
|
getSfvbSequence(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequence>;
|
|
6126
|
+
/**
|
|
6127
|
+
* Why customers were sent, skipped or ended at this step, newest first, as the admin\'s Dispatch Logs screen shows it, with the step\'s counts. An email step\'s counts are its email\'s; any other step\'s are its own over 90 days. Email addresses and phone numbers in the text are masked. since is 15m, 2h or 7d, or an ISO-8601 time, default 7d; entries are kept 90 days. limit is 1 to 200, default 50; send next_offset as offset for the next page. Read only.
|
|
6128
|
+
* Read a flow or campaign step\'s dispatch log and counts
|
|
6129
|
+
*/
|
|
6130
|
+
getSfvbSequenceStepDispatchLogsRaw(requestParameters: GetSfvbSequenceStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbStepDispatchLogsResponse>>;
|
|
6131
|
+
/**
|
|
6132
|
+
* Why customers were sent, skipped or ended at this step, newest first, as the admin\'s Dispatch Logs screen shows it, with the step\'s counts. An email step\'s counts are its email\'s; any other step\'s are its own over 90 days. Email addresses and phone numbers in the text are masked. since is 15m, 2h or 7d, or an ISO-8601 time, default 7d; entries are kept 90 days. limit is 1 to 200, default 50; send next_offset as offset for the next page. Read only.
|
|
6133
|
+
* Read a flow or campaign step\'s dispatch log and counts
|
|
6134
|
+
*/
|
|
6135
|
+
getSfvbSequenceStepDispatchLogs(requestParameters: GetSfvbSequenceStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbStepDispatchLogsResponse>;
|
|
5924
6136
|
/**
|
|
5925
6137
|
* 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.
|
|
5926
6138
|
* Get one storefront render log
|
|
@@ -5941,6 +6153,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
5941
6153
|
* Read a storefront\'s site attributes
|
|
5942
6154
|
*/
|
|
5943
6155
|
getSfvbSiteAttributes(requestParameters: GetSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSiteAttributesResponse>;
|
|
6156
|
+
/**
|
|
6157
|
+
* Canonical Links, Schema.org and Prevent Indexing as true or false, with the default meta description and keywords and the hash to send as If-Match on a change.
|
|
6158
|
+
* Read a storefront\'s search engine settings
|
|
6159
|
+
*/
|
|
6160
|
+
getSfvbSiteSeoRaw(requestParameters: GetSfvbSiteSeoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSiteSeo>>;
|
|
6161
|
+
/**
|
|
6162
|
+
* Canonical Links, Schema.org and Prevent Indexing as true or false, with the default meta description and keywords and the hash to send as If-Match on a change.
|
|
6163
|
+
* Read a storefront\'s search engine settings
|
|
6164
|
+
*/
|
|
6165
|
+
getSfvbSiteSeo(requestParameters: GetSfvbSiteSeoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSiteSeo>;
|
|
5944
6166
|
/**
|
|
5945
6167
|
* The sitemaps the admin SEO Sitemaps screen lists, with their child files and build times, the Sitemap lines robots.txt serves, and whether Prevent Indexing is on. Read only. The files are rebuilt nightly, so a page change shows in them after the next build.
|
|
5946
6168
|
* Read a storefront\'s sitemaps and robots.txt
|
|
@@ -6837,6 +7059,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
6837
7059
|
* What a shopper gets for a path
|
|
6838
7060
|
*/
|
|
6839
7061
|
resolveSfvbRedirect(requestParameters: ResolveSfvbRedirectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRedirectResolveResponse>;
|
|
7062
|
+
/**
|
|
7063
|
+
* Up to 1,000 paths in one call, each followed through the redirect rules exactly as the single resolve does, with counts of how many redirect and how many end on a 404. For checking every old URL of a migrated store. Read only.
|
|
7064
|
+
* What a shopper gets for each of many paths
|
|
7065
|
+
*/
|
|
7066
|
+
resolveSfvbRedirectBatchRaw(requestParameters: ResolveSfvbRedirectBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRedirectResolveBatchResponse>>;
|
|
7067
|
+
/**
|
|
7068
|
+
* Up to 1,000 paths in one call, each followed through the redirect rules exactly as the single resolve does, with counts of how many redirect and how many end on a 404. For checking every old URL of a migrated store. Read only.
|
|
7069
|
+
* What a shopper gets for each of many paths
|
|
7070
|
+
*/
|
|
7071
|
+
resolveSfvbRedirectBatch(requestParameters: ResolveSfvbRedirectBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRedirectResolveBatchResponse>;
|
|
6840
7072
|
/**
|
|
6841
7073
|
* A page stores only its template\'s file name. This runs the storefront\'s own template search for that name and returns the file a page naming it renders, relative to the theme. It also lists the theme\'s resource paths in search order with every file of that name below each, so a theme copy overriding a shared core copy, or a copy in a snippets folder that is never used, is visible. exists is false when a page naming the template cannot render.
|
|
6842
7074
|
* Resolve a template name to the file a page renders
|
|
@@ -7117,6 +7349,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
7117
7349
|
* Change one step\'s settings or audience filter
|
|
7118
7350
|
*/
|
|
7119
7351
|
updateSfvbSequenceStep(requestParameters: UpdateSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepUpdateResponse>;
|
|
7352
|
+
/**
|
|
7353
|
+
* A partial update of Canonical Links, Schema.org and Prevent Indexing. Send the hash_sha256 you read as If-Match. dry_run reports each change, whether it needs approval and whether that approval needs a fresh code, without saving. Turning Canonical Links or Schema.org on needs no approval. Turning either off, or turning Prevent Indexing on or off, needs an approved site_seo.change request for exactly this change (Approval-Id), and turning Prevent Indexing on asks for an authenticator code even inside an approval session. Always needs sfvb_publish, because the settings apply to every page as soon as they are saved. The admin saves the whole storefront, so a merchant with the screen open can still overwrite a change made here.
|
|
7354
|
+
* Change a storefront\'s search engine settings
|
|
7355
|
+
*/
|
|
7356
|
+
updateSfvbSiteSeoRaw(requestParameters: UpdateSfvbSiteSeoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSiteSeo>>;
|
|
7357
|
+
/**
|
|
7358
|
+
* A partial update of Canonical Links, Schema.org and Prevent Indexing. Send the hash_sha256 you read as If-Match. dry_run reports each change, whether it needs approval and whether that approval needs a fresh code, without saving. Turning Canonical Links or Schema.org on needs no approval. Turning either off, or turning Prevent Indexing on or off, needs an approved site_seo.change request for exactly this change (Approval-Id), and turning Prevent Indexing on asks for an authenticator code even inside an approval session. Always needs sfvb_publish, because the settings apply to every page as soon as they are saved. The admin saves the whole storefront, so a merchant with the screen open can still overwrite a change made here.
|
|
7359
|
+
* Change a storefront\'s search engine settings
|
|
7360
|
+
*/
|
|
7361
|
+
updateSfvbSiteSeo(requestParameters: UpdateSfvbSiteSeoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSiteSeo>;
|
|
7120
7362
|
/**
|
|
7121
7363
|
* A partial update of the mode, model, global split and lookback. platforms, when sent, replaces the whole list. The global split must total exactly 1 and the lookback is 7 to 365. On an unconfigured storefront it creates the configuration. Send the hash_sha256 you read as If-Match. Needs sfvb_publish, and when the mode is active or the change makes it active, an approved smart_attribution.change request for exactly this change (Approval-Id), because active mode decides which conversions each platform is sent. A change that stores what is already stored returns the configuration unchanged and uses no approval.
|
|
7122
7364
|
* Change a storefront\'s Smart Attribution configuration
|