ultracart_rest_api_v2_typescript 4.1.226 → 4.1.228

package/.openapi-generator/FILES

@@ -1201,6 +1201,7 @@ src/models/SfvbRedirectResponse.ts
 src/models/SfvbRedirectsResponse.ts
 src/models/SfvbRenderRequest.ts
 src/models/SfvbRenderResponse.ts
+src/models/SfvbRobotsTxt.ts
 src/models/SfvbSecretHandle.ts
 src/models/SfvbSecretKind.ts
 src/models/SfvbSecretKindsResponse.ts
@@ -1226,9 +1227,15 @@ src/models/SfvbSiteAttribute.ts
 src/models/SfvbSiteAttributeUpdate.ts
 src/models/SfvbSiteAttributeUpdateRequest.ts
 src/models/SfvbSiteAttributesResponse.ts
+src/models/SfvbSitemap.ts
+src/models/SfvbSitemapFile.ts
+src/models/SfvbSitemapsResponse.ts
 src/models/SfvbSmartAttribution.ts
 src/models/SfvbSmartAttributionPlatform.ts
 src/models/SfvbSmartAttributionRequest.ts
+src/models/SfvbStepCounts.ts
+src/models/SfvbStepDispatchLog.ts
+src/models/SfvbStepDispatchLogsResponse.ts
 src/models/SfvbStorefront.ts
 src/models/SfvbStorefrontsResponse.ts
 src/models/SfvbTemplate.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.226
+## ultracart_rest_api_v2_typescript@4.1.228
 
 Every API method call has a sample for every language SDK.  See https://github.com/UltraCart/sdk_samples
 
 Installation
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.1.226 --save
+npm install ultracart_rest_api_v2_typescript@4.1.228 --save
 ```
 
 ```typescript
@@ -84,6 +84,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.228 | 11/04/2026 | sfvb internal testing |
+| 4.1.227 | 11/04/2026 | sfvb internal testing |
 | 4.1.226 | 11/04/2026 | sfvb internal testing |
 | 4.1.225 | 11/03/2026 | sfvb internal testing |
 | 4.1.224 | 11/03/2026 | sfvb internal testing |

package/dist/apis/SfvbApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-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, 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';
+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, 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';
 export interface AddSfvbPageBlogPostsRequest {
     storefrontOid: number;
     path: string;
@@ -462,6 +462,14 @@ export interface GetSfvbSequenceRequest {
     sequenceUuid: string;
     waiting?: boolean;
 }
+export interface GetSfvbSequenceStepDispatchLogsRequest {
+    storefrontOid: number;
+    sequenceUuid: string;
+    stepUuid: string;
+    since?: string;
+    limit?: number;
+    offset?: number;
+}
 export interface GetSfvbServerLogRequest {
     storefrontOid: number;
     logId: string;
@@ -470,6 +478,9 @@ export interface GetSfvbServerLogRequest {
 export interface GetSfvbSiteAttributesRequest {
     storefrontOid: number;
 }
+export interface GetSfvbSitemapsRequest {
+    storefrontOid: number;
+}
 export interface GetSfvbSmartAttributionRequest {
     storefrontOid: number;
 }
@@ -2750,6 +2761,25 @@ export interface SfvbApiInterface {
      * Get a campaign\'s or flow\'s steps as a tree
      */
     getSfvbSequence(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequence>;
+    /**
+     * 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.
+     * @summary Read a flow or campaign step\'s dispatch log and counts
+     * @param {number} storefrontOid
+     * @param {string} sequenceUuid
+     * @param {string} stepUuid
+     * @param {string} [since]
+     * @param {number} [limit]
+     * @param {number} [offset]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    getSfvbSequenceStepDispatchLogsRaw(requestParameters: GetSfvbSequenceStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbStepDispatchLogsResponse>>;
+    /**
+     * 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.
+     * Read a flow or campaign step\'s dispatch log and counts
+     */
+    getSfvbSequenceStepDispatchLogs(requestParameters: GetSfvbSequenceStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbStepDispatchLogsResponse>;
     /**
      * 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.
      * @summary Get one storefront render log
@@ -2780,6 +2810,20 @@ export interface SfvbApiInterface {
      * Read a storefront\'s site attributes
      */
     getSfvbSiteAttributes(requestParameters: GetSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSiteAttributesResponse>;
+    /**
+     * 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.
+     * @summary Read a storefront\'s sitemaps and robots.txt
+     * @param {number} storefrontOid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    getSfvbSitemapsRaw(requestParameters: GetSfvbSitemapsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSitemapsResponse>>;
+    /**
+     * 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.
+     * Read a storefront\'s sitemaps and robots.txt
+     */
+    getSfvbSitemaps(requestParameters: GetSfvbSitemapsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSitemapsResponse>;
     /**
      * The mode, model, global credit split, lookback and platforms, the platforms detected from the tracking integrations that are not configured yet, and the hash_sha256 a change or delete sends back as If-Match.  When configured is false the values are the defaults an enable would save.
      * @summary Read a storefront\'s Smart Attribution configuration
@@ -5904,6 +5948,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Get a campaign\'s or flow\'s steps as a tree
      */
     getSfvbSequence(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequence>;
+    /**
+     * 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.
+     * Read a flow or campaign step\'s dispatch log and counts
+     */
+    getSfvbSequenceStepDispatchLogsRaw(requestParameters: GetSfvbSequenceStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbStepDispatchLogsResponse>>;
+    /**
+     * 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.
+     * Read a flow or campaign step\'s dispatch log and counts
+     */
+    getSfvbSequenceStepDispatchLogs(requestParameters: GetSfvbSequenceStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbStepDispatchLogsResponse>;
     /**
      * 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.
      * Get one storefront render log
@@ -5924,6 +5978,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Read a storefront\'s site attributes
      */
     getSfvbSiteAttributes(requestParameters: GetSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSiteAttributesResponse>;
+    /**
+     * 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.
+     * Read a storefront\'s sitemaps and robots.txt
+     */
+    getSfvbSitemapsRaw(requestParameters: GetSfvbSitemapsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSitemapsResponse>>;
+    /**
+     * 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.
+     * Read a storefront\'s sitemaps and robots.txt
+     */
+    getSfvbSitemaps(requestParameters: GetSfvbSitemapsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSitemapsResponse>;
     /**
      * The mode, model, global credit split, lookback and platforms, the platforms detected from the tracking integrations that are not configured yet, and the hash_sha256 a change or delete sends back as If-Match.  When configured is false the values are the defaults an enable would save.
      * Read a storefront\'s Smart Attribution configuration

package/dist/apis/SfvbApi.js

@@ -6835,6 +6835,80 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * 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.
+     * Read a flow or campaign step\'s dispatch log and counts
+     */
+    SfvbApi.prototype.getSfvbSequenceStepDispatchLogsRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+                            throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getSfvbSequenceStepDispatchLogs.');
+                        }
+                        if (requestParameters.sequenceUuid === null || requestParameters.sequenceUuid === undefined) {
+                            throw new runtime.RequiredError('sequenceUuid', 'Required parameter requestParameters.sequenceUuid was null or undefined when calling getSfvbSequenceStepDispatchLogs.');
+                        }
+                        if (requestParameters.stepUuid === null || requestParameters.stepUuid === undefined) {
+                            throw new runtime.RequiredError('stepUuid', 'Required parameter requestParameters.stepUuid was null or undefined when calling getSfvbSequenceStepDispatchLogs.');
+                        }
+                        queryParameters = {};
+                        if (requestParameters.since !== undefined) {
+                            queryParameters['since'] = requestParameters.since;
+                        }
+                        if (requestParameters.limit !== undefined) {
+                            queryParameters['limit'] = requestParameters.limit;
+                        }
+                        if (requestParameters.offset !== undefined) {
+                            queryParameters['offset'] = requestParameters.offset;
+                        }
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/dispatch_logs".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("sequence_uuid", "}"), encodeURIComponent(String(requestParameters.sequenceUuid))).replace("{".concat("step_uuid", "}"), encodeURIComponent(String(requestParameters.stepUuid))),
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbStepDispatchLogsResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * 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.
+     * Read a flow or campaign step\'s dispatch log and counts
+     */
+    SfvbApi.prototype.getSfvbSequenceStepDispatchLogs = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getSfvbSequenceStepDispatchLogsRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * 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.
      * Get one storefront render log
@@ -6959,6 +7033,65 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * 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.
+     * Read a storefront\'s sitemaps and robots.txt
+     */
+    SfvbApi.prototype.getSfvbSitemapsRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+                            throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getSfvbSitemaps.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/sfvb/storefronts/{storefront_oid}/sitemaps".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbSitemapsResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * 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.
+     * Read a storefront\'s sitemaps and robots.txt
+     */
+    SfvbApi.prototype.getSfvbSitemaps = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getSfvbSitemapsRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * The mode, model, global credit split, lookback and platforms, the platforms detected from the tracking integrations that are not configured yet, and the hash_sha256 a change or delete sends back as If-Match.  When configured is false the values are the defaults an enable would save.
      * Read a storefront\'s Smart Attribution configuration

package/dist/models/SfvbBlogPostDetail.d.ts

@@ -46,6 +46,12 @@ export interface SfvbBlogPostDetail {
      * @memberof SfvbBlogPostDetail
      */
     created_dts?: string;
+    /**
+     * True when this is the result of a dry run and nothing was saved.  The post is shown as it is stored.
+     * @type {boolean}
+     * @memberof SfvbBlogPostDetail
+     */
+    dry_run?: boolean;
     /**
      * The post excerpt as HTML, exactly as stored.
      * @type {string}

package/dist/models/SfvbBlogPostDetail.js

@@ -38,6 +38,7 @@ function SfvbBlogPostDetailFromJSONTyped(json, ignoreDiscriminator) {
         'blog_post_oid': !(0, runtime_1.exists)(json, 'blog_post_oid') ? undefined : json['blog_post_oid'],
         'body': !(0, runtime_1.exists)(json, 'body') ? undefined : json['body'],
         'created_dts': !(0, runtime_1.exists)(json, 'created_dts') ? undefined : json['created_dts'],
+        'dry_run': !(0, runtime_1.exists)(json, 'dry_run') ? undefined : json['dry_run'],
         'excerpt': !(0, runtime_1.exists)(json, 'excerpt') ? undefined : json['excerpt'],
         'images': !(0, runtime_1.exists)(json, 'images') ? undefined : (json['images'].map(SfvbBlogPostImage_1.SfvbBlogPostImageFromJSON)),
         'last_modified_dts': !(0, runtime_1.exists)(json, 'last_modified_dts') ? undefined : json['last_modified_dts'],
@@ -67,6 +68,7 @@ function SfvbBlogPostDetailToJSON(value) {
         'blog_post_oid': value.blog_post_oid,
         'body': value.body,
         'created_dts': value.created_dts,
+        'dry_run': value.dry_run,
         'excerpt': value.excerpt,
         'images': value.images === undefined ? undefined : (value.images.map(SfvbBlogPostImage_1.SfvbBlogPostImageToJSON)),
         'last_modified_dts': value.last_modified_dts,

package/dist/models/SfvbBlogPostRequest.d.ts

@@ -33,6 +33,12 @@ export interface SfvbBlogPostRequest {
      * @memberof SfvbBlogPostRequest
      */
     body?: string;
+    /**
+     * On an update, true to run every check the write would run and save nothing.  A refusal comes back exactly as it would on the real write.
+     * @type {boolean}
+     * @memberof SfvbBlogPostRequest
+     */
+    dry_run?: boolean;
     /**
      * The post excerpt as HTML, up to 256 KB.  Held to the same rule as body.
      * @type {string}

package/dist/models/SfvbBlogPostRequest.js

@@ -43,6 +43,7 @@ function SfvbBlogPostRequestFromJSONTyped(json, ignoreDiscriminator) {
         'allow_comments': !(0, runtime_1.exists)(json, 'allow_comments') ? undefined : json['allow_comments'],
         'author': !(0, runtime_1.exists)(json, 'author') ? undefined : json['author'],
         'body': !(0, runtime_1.exists)(json, 'body') ? undefined : json['body'],
+        'dry_run': !(0, runtime_1.exists)(json, 'dry_run') ? undefined : json['dry_run'],
         'excerpt': !(0, runtime_1.exists)(json, 'excerpt') ? undefined : json['excerpt'],
         'publication_dts': !(0, runtime_1.exists)(json, 'publication_dts') ? undefined : json['publication_dts'],
         'seo_description': !(0, runtime_1.exists)(json, 'seo_description') ? undefined : json['seo_description'],
@@ -66,6 +67,7 @@ function SfvbBlogPostRequestToJSON(value) {
         'allow_comments': value.allow_comments,
         'author': value.author,
         'body': value.body,
+        'dry_run': value.dry_run,
         'excerpt': value.excerpt,
         'publication_dts': value.publication_dts,
         'seo_description': value.seo_description,

package/dist/models/SfvbRobotsTxt.d.ts

@@ -0,0 +1,43 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface SfvbRobotsTxt
+ */
+export interface SfvbRobotsTxt {
+    /**
+     * True when the merchant has their own /robots.txt file, which is served after UltraCart's entries.
+     * @type {boolean}
+     * @memberof SfvbRobotsTxt
+     */
+    custom_file?: boolean;
+    /**
+     * The Sitemap lines it serves, UltraCart's own first, then any in the merchant's own robots.txt file.
+     * @type {Array<string>}
+     * @memberof SfvbRobotsTxt
+     */
+    sitemap_lines?: Array<string>;
+    /**
+     * The robots.txt URL on the storefront's host.
+     * @type {string}
+     * @memberof SfvbRobotsTxt
+     */
+    url?: string;
+}
+/**
+ * Check if a given object implements the SfvbRobotsTxt interface.
+ */
+export declare function instanceOfSfvbRobotsTxt(value: object): boolean;
+export declare function SfvbRobotsTxtFromJSON(json: any): SfvbRobotsTxt;
+export declare function SfvbRobotsTxtFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbRobotsTxt;
+export declare function SfvbRobotsTxtToJSON(value?: SfvbRobotsTxt | null): any;

package/dist/models/SfvbRobotsTxt.js

@@ -0,0 +1,54 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SfvbRobotsTxtToJSON = exports.SfvbRobotsTxtFromJSONTyped = exports.SfvbRobotsTxtFromJSON = exports.instanceOfSfvbRobotsTxt = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the SfvbRobotsTxt interface.
+ */
+function instanceOfSfvbRobotsTxt(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbRobotsTxt = instanceOfSfvbRobotsTxt;
+function SfvbRobotsTxtFromJSON(json) {
+    return SfvbRobotsTxtFromJSONTyped(json, false);
+}
+exports.SfvbRobotsTxtFromJSON = SfvbRobotsTxtFromJSON;
+function SfvbRobotsTxtFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'custom_file': !(0, runtime_1.exists)(json, 'custom_file') ? undefined : json['custom_file'],
+        'sitemap_lines': !(0, runtime_1.exists)(json, 'sitemap_lines') ? undefined : json['sitemap_lines'],
+        'url': !(0, runtime_1.exists)(json, 'url') ? undefined : json['url'],
+    };
+}
+exports.SfvbRobotsTxtFromJSONTyped = SfvbRobotsTxtFromJSONTyped;
+function SfvbRobotsTxtToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'custom_file': value.custom_file,
+        'sitemap_lines': value.sitemap_lines,
+        'url': value.url,
+    };
+}
+exports.SfvbRobotsTxtToJSON = SfvbRobotsTxtToJSON;

package/dist/models/SfvbSitemap.d.ts

@@ -0,0 +1,62 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { SfvbSitemapFile } from './SfvbSitemapFile';
+/**
+ *
+ * @export
+ * @interface SfvbSitemap
+ */
+export interface SfvbSitemap {
+    /**
+     * For an index, the child files it lists, in order.
+     * @type {Array<SfvbSitemapFile>}
+     * @memberof SfvbSitemap
+     */
+    child_files?: Array<SfvbSitemapFile>;
+    /**
+     * sitemaps.org (the index to register with Google Search Console and Bing), google-0.84 (the older Google schema) or urllist (a plain URL list).
+     * @type {string}
+     * @memberof SfvbSitemap
+     */
+    format?: string;
+    /**
+     * When the nightly build last wrote the sitemap, as ISO 8601.
+     * @type {string}
+     * @memberof SfvbSitemap
+     */
+    last_built?: string;
+    /**
+     * The sitemap's path on the storefront.
+     * @type {string}
+     * @memberof SfvbSitemap
+     */
+    path?: string;
+    /**
+     * The file's size in bytes.
+     * @type {number}
+     * @memberof SfvbSitemap
+     */
+    size_bytes?: number;
+    /**
+     * The sitemap's https URL, the one to register.
+     * @type {string}
+     * @memberof SfvbSitemap
+     */
+    url?: string;
+}
+/**
+ * Check if a given object implements the SfvbSitemap interface.
+ */
+export declare function instanceOfSfvbSitemap(value: object): boolean;
+export declare function SfvbSitemapFromJSON(json: any): SfvbSitemap;
+export declare function SfvbSitemapFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSitemap;
+export declare function SfvbSitemapToJSON(value?: SfvbSitemap | null): any;

package/dist/models/SfvbSitemap.js

@@ -0,0 +1,61 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SfvbSitemapToJSON = exports.SfvbSitemapFromJSONTyped = exports.SfvbSitemapFromJSON = exports.instanceOfSfvbSitemap = void 0;
+var runtime_1 = require("../runtime");
+var SfvbSitemapFile_1 = require("./SfvbSitemapFile");
+/**
+ * Check if a given object implements the SfvbSitemap interface.
+ */
+function instanceOfSfvbSitemap(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbSitemap = instanceOfSfvbSitemap;
+function SfvbSitemapFromJSON(json) {
+    return SfvbSitemapFromJSONTyped(json, false);
+}
+exports.SfvbSitemapFromJSON = SfvbSitemapFromJSON;
+function SfvbSitemapFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'child_files': !(0, runtime_1.exists)(json, 'child_files') ? undefined : (json['child_files'].map(SfvbSitemapFile_1.SfvbSitemapFileFromJSON)),
+        'format': !(0, runtime_1.exists)(json, 'format') ? undefined : json['format'],
+        'last_built': !(0, runtime_1.exists)(json, 'last_built') ? undefined : json['last_built'],
+        'path': !(0, runtime_1.exists)(json, 'path') ? undefined : json['path'],
+        'size_bytes': !(0, runtime_1.exists)(json, 'size_bytes') ? undefined : json['size_bytes'],
+        'url': !(0, runtime_1.exists)(json, 'url') ? undefined : json['url'],
+    };
+}
+exports.SfvbSitemapFromJSONTyped = SfvbSitemapFromJSONTyped;
+function SfvbSitemapToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'child_files': value.child_files === undefined ? undefined : (value.child_files.map(SfvbSitemapFile_1.SfvbSitemapFileToJSON)),
+        'format': value.format,
+        'last_built': value.last_built,
+        'path': value.path,
+        'size_bytes': value.size_bytes,
+        'url': value.url,
+    };
+}
+exports.SfvbSitemapToJSON = SfvbSitemapToJSON;