ultracart_rest_api_v2_typescript 4.1.226 → 4.1.227

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.
@@ -1201,6 +1201,7 @@ src/models/SfvbRedirectResponse.ts
1201
1201
  src/models/SfvbRedirectsResponse.ts
1202
1202
  src/models/SfvbRenderRequest.ts
1203
1203
  src/models/SfvbRenderResponse.ts
1204
+ src/models/SfvbRobotsTxt.ts
1204
1205
  src/models/SfvbSecretHandle.ts
1205
1206
  src/models/SfvbSecretKind.ts
1206
1207
  src/models/SfvbSecretKindsResponse.ts
@@ -1226,6 +1227,9 @@ src/models/SfvbSiteAttribute.ts
1226
1227
  src/models/SfvbSiteAttributeUpdate.ts
1227
1228
  src/models/SfvbSiteAttributeUpdateRequest.ts
1228
1229
  src/models/SfvbSiteAttributesResponse.ts
1230
+ src/models/SfvbSitemap.ts
1231
+ src/models/SfvbSitemapFile.ts
1232
+ src/models/SfvbSitemapsResponse.ts
1229
1233
  src/models/SfvbSmartAttribution.ts
1230
1234
  src/models/SfvbSmartAttributionPlatform.ts
1231
1235
  src/models/SfvbSmartAttributionRequest.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.226
2
+ ## ultracart_rest_api_v2_typescript@4.1.227
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.226 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.227 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -84,6 +84,7 @@ Not every change is committed to every SDK.
84
84
 
85
85
  | Version | Date | Comments |
86
86
  | --: | :-: | --- |
87
+ | 4.1.227 | 11/04/2026 | sfvb internal testing |
87
88
  | 4.1.226 | 11/04/2026 | sfvb internal testing |
88
89
  | 4.1.225 | 11/03/2026 | sfvb internal testing |
89
90
  | 4.1.224 | 11/03/2026 | sfvb internal testing |
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { 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';
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';
14
14
  export interface AddSfvbPageBlogPostsRequest {
15
15
  storefrontOid: number;
16
16
  path: string;
@@ -470,6 +470,9 @@ export interface GetSfvbServerLogRequest {
470
470
  export interface GetSfvbSiteAttributesRequest {
471
471
  storefrontOid: number;
472
472
  }
473
+ export interface GetSfvbSitemapsRequest {
474
+ storefrontOid: number;
475
+ }
473
476
  export interface GetSfvbSmartAttributionRequest {
474
477
  storefrontOid: number;
475
478
  }
@@ -2780,6 +2783,20 @@ export interface SfvbApiInterface {
2780
2783
  * Read a storefront\'s site attributes
2781
2784
  */
2782
2785
  getSfvbSiteAttributes(requestParameters: GetSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSiteAttributesResponse>;
2786
+ /**
2787
+ * 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
+ * @summary Read a storefront\'s sitemaps and robots.txt
2789
+ * @param {number} storefrontOid
2790
+ * @param {*} [options] Override http request option.
2791
+ * @throws {RequiredError}
2792
+ * @memberof SfvbApiInterface
2793
+ */
2794
+ getSfvbSitemapsRaw(requestParameters: GetSfvbSitemapsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSitemapsResponse>>;
2795
+ /**
2796
+ * 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.
2797
+ * Read a storefront\'s sitemaps and robots.txt
2798
+ */
2799
+ getSfvbSitemaps(requestParameters: GetSfvbSitemapsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSitemapsResponse>;
2783
2800
  /**
2784
2801
  * 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.
2785
2802
  * @summary Read a storefront\'s Smart Attribution configuration
@@ -5924,6 +5941,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
5924
5941
  * Read a storefront\'s site attributes
5925
5942
  */
5926
5943
  getSfvbSiteAttributes(requestParameters: GetSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSiteAttributesResponse>;
5944
+ /**
5945
+ * 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
+ * Read a storefront\'s sitemaps and robots.txt
5947
+ */
5948
+ getSfvbSitemapsRaw(requestParameters: GetSfvbSitemapsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSitemapsResponse>>;
5949
+ /**
5950
+ * 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.
5951
+ * Read a storefront\'s sitemaps and robots.txt
5952
+ */
5953
+ getSfvbSitemaps(requestParameters: GetSfvbSitemapsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSitemapsResponse>;
5927
5954
  /**
5928
5955
  * 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.
5929
5956
  * Read a storefront\'s Smart Attribution configuration
@@ -6959,6 +6959,65 @@ var SfvbApi = /** @class */ (function (_super) {
6959
6959
  });
6960
6960
  });
6961
6961
  };
6962
+ /**
6963
+ * 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.
6964
+ * Read a storefront\'s sitemaps and robots.txt
6965
+ */
6966
+ SfvbApi.prototype.getSfvbSitemapsRaw = function (requestParameters, initOverrides) {
6967
+ return __awaiter(this, void 0, void 0, function () {
6968
+ var queryParameters, headerParameters, _a, _b, response;
6969
+ return __generator(this, function (_c) {
6970
+ switch (_c.label) {
6971
+ case 0:
6972
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
6973
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getSfvbSitemaps.');
6974
+ }
6975
+ queryParameters = {};
6976
+ headerParameters = {};
6977
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
6978
+ // oauth required
6979
+ _a = headerParameters;
6980
+ _b = "Authorization";
6981
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
6982
+ case 1:
6983
+ // oauth required
6984
+ _a[_b] = _c.sent();
6985
+ _c.label = 2;
6986
+ case 2:
6987
+ if (this.configuration && this.configuration.apiKey) {
6988
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
6989
+ }
6990
+ return [4 /*yield*/, this.request({
6991
+ path: "/sfvb/storefronts/{storefront_oid}/sitemaps".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
6992
+ method: 'GET',
6993
+ headers: headerParameters,
6994
+ query: queryParameters,
6995
+ }, initOverrides)];
6996
+ case 3:
6997
+ response = _c.sent();
6998
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbSitemapsResponseFromJSON)(jsonValue); })];
6999
+ }
7000
+ });
7001
+ });
7002
+ };
7003
+ /**
7004
+ * 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.
7005
+ * Read a storefront\'s sitemaps and robots.txt
7006
+ */
7007
+ SfvbApi.prototype.getSfvbSitemaps = function (requestParameters, initOverrides) {
7008
+ return __awaiter(this, void 0, void 0, function () {
7009
+ var response;
7010
+ return __generator(this, function (_a) {
7011
+ switch (_a.label) {
7012
+ case 0: return [4 /*yield*/, this.getSfvbSitemapsRaw(requestParameters, initOverrides)];
7013
+ case 1:
7014
+ response = _a.sent();
7015
+ return [4 /*yield*/, response.value()];
7016
+ case 2: return [2 /*return*/, _a.sent()];
7017
+ }
7018
+ });
7019
+ });
7020
+ };
6962
7021
  /**
6963
7022
  * 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.
6964
7023
  * Read a storefront\'s Smart Attribution configuration
@@ -0,0 +1,43 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface SfvbRobotsTxt
16
+ */
17
+ export interface SfvbRobotsTxt {
18
+ /**
19
+ * True when the merchant has their own /robots.txt file, which is served after UltraCart's entries.
20
+ * @type {boolean}
21
+ * @memberof SfvbRobotsTxt
22
+ */
23
+ custom_file?: boolean;
24
+ /**
25
+ * The Sitemap lines it serves, UltraCart's own first, then any in the merchant's own robots.txt file.
26
+ * @type {Array<string>}
27
+ * @memberof SfvbRobotsTxt
28
+ */
29
+ sitemap_lines?: Array<string>;
30
+ /**
31
+ * The robots.txt URL on the storefront's host.
32
+ * @type {string}
33
+ * @memberof SfvbRobotsTxt
34
+ */
35
+ url?: string;
36
+ }
37
+ /**
38
+ * Check if a given object implements the SfvbRobotsTxt interface.
39
+ */
40
+ export declare function instanceOfSfvbRobotsTxt(value: object): boolean;
41
+ export declare function SfvbRobotsTxtFromJSON(json: any): SfvbRobotsTxt;
42
+ export declare function SfvbRobotsTxtFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbRobotsTxt;
43
+ export declare function SfvbRobotsTxtToJSON(value?: SfvbRobotsTxt | null): any;
@@ -0,0 +1,54 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.SfvbRobotsTxtToJSON = exports.SfvbRobotsTxtFromJSONTyped = exports.SfvbRobotsTxtFromJSON = exports.instanceOfSfvbRobotsTxt = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * Check if a given object implements the SfvbRobotsTxt interface.
20
+ */
21
+ function instanceOfSfvbRobotsTxt(value) {
22
+ var isInstance = true;
23
+ return isInstance;
24
+ }
25
+ exports.instanceOfSfvbRobotsTxt = instanceOfSfvbRobotsTxt;
26
+ function SfvbRobotsTxtFromJSON(json) {
27
+ return SfvbRobotsTxtFromJSONTyped(json, false);
28
+ }
29
+ exports.SfvbRobotsTxtFromJSON = SfvbRobotsTxtFromJSON;
30
+ function SfvbRobotsTxtFromJSONTyped(json, ignoreDiscriminator) {
31
+ if ((json === undefined) || (json === null)) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'custom_file': !(0, runtime_1.exists)(json, 'custom_file') ? undefined : json['custom_file'],
36
+ 'sitemap_lines': !(0, runtime_1.exists)(json, 'sitemap_lines') ? undefined : json['sitemap_lines'],
37
+ 'url': !(0, runtime_1.exists)(json, 'url') ? undefined : json['url'],
38
+ };
39
+ }
40
+ exports.SfvbRobotsTxtFromJSONTyped = SfvbRobotsTxtFromJSONTyped;
41
+ function SfvbRobotsTxtToJSON(value) {
42
+ if (value === undefined) {
43
+ return undefined;
44
+ }
45
+ if (value === null) {
46
+ return null;
47
+ }
48
+ return {
49
+ 'custom_file': value.custom_file,
50
+ 'sitemap_lines': value.sitemap_lines,
51
+ 'url': value.url,
52
+ };
53
+ }
54
+ exports.SfvbRobotsTxtToJSON = SfvbRobotsTxtToJSON;
@@ -0,0 +1,62 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { SfvbSitemapFile } from './SfvbSitemapFile';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface SfvbSitemap
17
+ */
18
+ export interface SfvbSitemap {
19
+ /**
20
+ * For an index, the child files it lists, in order.
21
+ * @type {Array<SfvbSitemapFile>}
22
+ * @memberof SfvbSitemap
23
+ */
24
+ child_files?: Array<SfvbSitemapFile>;
25
+ /**
26
+ * 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).
27
+ * @type {string}
28
+ * @memberof SfvbSitemap
29
+ */
30
+ format?: string;
31
+ /**
32
+ * When the nightly build last wrote the sitemap, as ISO 8601.
33
+ * @type {string}
34
+ * @memberof SfvbSitemap
35
+ */
36
+ last_built?: string;
37
+ /**
38
+ * The sitemap's path on the storefront.
39
+ * @type {string}
40
+ * @memberof SfvbSitemap
41
+ */
42
+ path?: string;
43
+ /**
44
+ * The file's size in bytes.
45
+ * @type {number}
46
+ * @memberof SfvbSitemap
47
+ */
48
+ size_bytes?: number;
49
+ /**
50
+ * The sitemap's https URL, the one to register.
51
+ * @type {string}
52
+ * @memberof SfvbSitemap
53
+ */
54
+ url?: string;
55
+ }
56
+ /**
57
+ * Check if a given object implements the SfvbSitemap interface.
58
+ */
59
+ export declare function instanceOfSfvbSitemap(value: object): boolean;
60
+ export declare function SfvbSitemapFromJSON(json: any): SfvbSitemap;
61
+ export declare function SfvbSitemapFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSitemap;
62
+ export declare function SfvbSitemapToJSON(value?: SfvbSitemap | null): any;
@@ -0,0 +1,61 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.SfvbSitemapToJSON = exports.SfvbSitemapFromJSONTyped = exports.SfvbSitemapFromJSON = exports.instanceOfSfvbSitemap = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ var SfvbSitemapFile_1 = require("./SfvbSitemapFile");
19
+ /**
20
+ * Check if a given object implements the SfvbSitemap interface.
21
+ */
22
+ function instanceOfSfvbSitemap(value) {
23
+ var isInstance = true;
24
+ return isInstance;
25
+ }
26
+ exports.instanceOfSfvbSitemap = instanceOfSfvbSitemap;
27
+ function SfvbSitemapFromJSON(json) {
28
+ return SfvbSitemapFromJSONTyped(json, false);
29
+ }
30
+ exports.SfvbSitemapFromJSON = SfvbSitemapFromJSON;
31
+ function SfvbSitemapFromJSONTyped(json, ignoreDiscriminator) {
32
+ if ((json === undefined) || (json === null)) {
33
+ return json;
34
+ }
35
+ return {
36
+ 'child_files': !(0, runtime_1.exists)(json, 'child_files') ? undefined : (json['child_files'].map(SfvbSitemapFile_1.SfvbSitemapFileFromJSON)),
37
+ 'format': !(0, runtime_1.exists)(json, 'format') ? undefined : json['format'],
38
+ 'last_built': !(0, runtime_1.exists)(json, 'last_built') ? undefined : json['last_built'],
39
+ 'path': !(0, runtime_1.exists)(json, 'path') ? undefined : json['path'],
40
+ 'size_bytes': !(0, runtime_1.exists)(json, 'size_bytes') ? undefined : json['size_bytes'],
41
+ 'url': !(0, runtime_1.exists)(json, 'url') ? undefined : json['url'],
42
+ };
43
+ }
44
+ exports.SfvbSitemapFromJSONTyped = SfvbSitemapFromJSONTyped;
45
+ function SfvbSitemapToJSON(value) {
46
+ if (value === undefined) {
47
+ return undefined;
48
+ }
49
+ if (value === null) {
50
+ return null;
51
+ }
52
+ return {
53
+ 'child_files': value.child_files === undefined ? undefined : (value.child_files.map(SfvbSitemapFile_1.SfvbSitemapFileToJSON)),
54
+ 'format': value.format,
55
+ 'last_built': value.last_built,
56
+ 'path': value.path,
57
+ 'size_bytes': value.size_bytes,
58
+ 'url': value.url,
59
+ };
60
+ }
61
+ exports.SfvbSitemapToJSON = SfvbSitemapToJSON;
@@ -0,0 +1,49 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface SfvbSitemapFile
16
+ */
17
+ export interface SfvbSitemapFile {
18
+ /**
19
+ * When the nightly build last wrote the file, as ISO 8601.
20
+ * @type {string}
21
+ * @memberof SfvbSitemapFile
22
+ */
23
+ last_built?: string;
24
+ /**
25
+ * The file's path on the storefront, such as /sitemapsdotorg1.xml.gz.
26
+ * @type {string}
27
+ * @memberof SfvbSitemapFile
28
+ */
29
+ path?: string;
30
+ /**
31
+ * The file's size in bytes, compressed for a .gz file.
32
+ * @type {number}
33
+ * @memberof SfvbSitemapFile
34
+ */
35
+ size_bytes?: number;
36
+ /**
37
+ * The file's https URL on the storefront's host.
38
+ * @type {string}
39
+ * @memberof SfvbSitemapFile
40
+ */
41
+ url?: string;
42
+ }
43
+ /**
44
+ * Check if a given object implements the SfvbSitemapFile interface.
45
+ */
46
+ export declare function instanceOfSfvbSitemapFile(value: object): boolean;
47
+ export declare function SfvbSitemapFileFromJSON(json: any): SfvbSitemapFile;
48
+ export declare function SfvbSitemapFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSitemapFile;
49
+ export declare function SfvbSitemapFileToJSON(value?: SfvbSitemapFile | null): any;
@@ -0,0 +1,56 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.SfvbSitemapFileToJSON = exports.SfvbSitemapFileFromJSONTyped = exports.SfvbSitemapFileFromJSON = exports.instanceOfSfvbSitemapFile = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * Check if a given object implements the SfvbSitemapFile interface.
20
+ */
21
+ function instanceOfSfvbSitemapFile(value) {
22
+ var isInstance = true;
23
+ return isInstance;
24
+ }
25
+ exports.instanceOfSfvbSitemapFile = instanceOfSfvbSitemapFile;
26
+ function SfvbSitemapFileFromJSON(json) {
27
+ return SfvbSitemapFileFromJSONTyped(json, false);
28
+ }
29
+ exports.SfvbSitemapFileFromJSON = SfvbSitemapFileFromJSON;
30
+ function SfvbSitemapFileFromJSONTyped(json, ignoreDiscriminator) {
31
+ if ((json === undefined) || (json === null)) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'last_built': !(0, runtime_1.exists)(json, 'last_built') ? undefined : json['last_built'],
36
+ 'path': !(0, runtime_1.exists)(json, 'path') ? undefined : json['path'],
37
+ 'size_bytes': !(0, runtime_1.exists)(json, 'size_bytes') ? undefined : json['size_bytes'],
38
+ 'url': !(0, runtime_1.exists)(json, 'url') ? undefined : json['url'],
39
+ };
40
+ }
41
+ exports.SfvbSitemapFileFromJSONTyped = SfvbSitemapFileFromJSONTyped;
42
+ function SfvbSitemapFileToJSON(value) {
43
+ if (value === undefined) {
44
+ return undefined;
45
+ }
46
+ if (value === null) {
47
+ return null;
48
+ }
49
+ return {
50
+ 'last_built': value.last_built,
51
+ 'path': value.path,
52
+ 'size_bytes': value.size_bytes,
53
+ 'url': value.url,
54
+ };
55
+ }
56
+ exports.SfvbSitemapFileToJSON = SfvbSitemapFileToJSON;
@@ -0,0 +1,63 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { SfvbRobotsTxt } from './SfvbRobotsTxt';
13
+ import { SfvbSitemap } from './SfvbSitemap';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface SfvbSitemapsResponse
18
+ */
19
+ export interface SfvbSitemapsResponse {
20
+ /**
21
+ * The host the sitemaps are built for.
22
+ * @type {string}
23
+ * @memberof SfvbSitemapsResponse
24
+ */
25
+ host?: string;
26
+ /**
27
+ * What a person should know about these sitemaps, such as when they are rebuilt.
28
+ * @type {Array<string>}
29
+ * @memberof SfvbSitemapsResponse
30
+ */
31
+ notes?: Array<string>;
32
+ /**
33
+ * True when the storefront's Prevent Indexing setting is on. The sitemaps are still served, but every page tells search engines not to index it.
34
+ * @type {boolean}
35
+ * @memberof SfvbSitemapsResponse
36
+ */
37
+ prevent_indexing?: boolean;
38
+ /**
39
+ *
40
+ * @type {SfvbRobotsTxt}
41
+ * @memberof SfvbSitemapsResponse
42
+ */
43
+ robots_txt?: SfvbRobotsTxt;
44
+ /**
45
+ * The sitemaps that exist, sitemaps.org first. Empty until the nightly build has run.
46
+ * @type {Array<SfvbSitemap>}
47
+ * @memberof SfvbSitemapsResponse
48
+ */
49
+ sitemaps?: Array<SfvbSitemap>;
50
+ /**
51
+ * The storefront.
52
+ * @type {number}
53
+ * @memberof SfvbSitemapsResponse
54
+ */
55
+ storefront_oid?: number;
56
+ }
57
+ /**
58
+ * Check if a given object implements the SfvbSitemapsResponse interface.
59
+ */
60
+ export declare function instanceOfSfvbSitemapsResponse(value: object): boolean;
61
+ export declare function SfvbSitemapsResponseFromJSON(json: any): SfvbSitemapsResponse;
62
+ export declare function SfvbSitemapsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSitemapsResponse;
63
+ export declare function SfvbSitemapsResponseToJSON(value?: SfvbSitemapsResponse | null): any;
@@ -0,0 +1,62 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.SfvbSitemapsResponseToJSON = exports.SfvbSitemapsResponseFromJSONTyped = exports.SfvbSitemapsResponseFromJSON = exports.instanceOfSfvbSitemapsResponse = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ var SfvbRobotsTxt_1 = require("./SfvbRobotsTxt");
19
+ var SfvbSitemap_1 = require("./SfvbSitemap");
20
+ /**
21
+ * Check if a given object implements the SfvbSitemapsResponse interface.
22
+ */
23
+ function instanceOfSfvbSitemapsResponse(value) {
24
+ var isInstance = true;
25
+ return isInstance;
26
+ }
27
+ exports.instanceOfSfvbSitemapsResponse = instanceOfSfvbSitemapsResponse;
28
+ function SfvbSitemapsResponseFromJSON(json) {
29
+ return SfvbSitemapsResponseFromJSONTyped(json, false);
30
+ }
31
+ exports.SfvbSitemapsResponseFromJSON = SfvbSitemapsResponseFromJSON;
32
+ function SfvbSitemapsResponseFromJSONTyped(json, ignoreDiscriminator) {
33
+ if ((json === undefined) || (json === null)) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'host': !(0, runtime_1.exists)(json, 'host') ? undefined : json['host'],
38
+ 'notes': !(0, runtime_1.exists)(json, 'notes') ? undefined : json['notes'],
39
+ 'prevent_indexing': !(0, runtime_1.exists)(json, 'prevent_indexing') ? undefined : json['prevent_indexing'],
40
+ 'robots_txt': !(0, runtime_1.exists)(json, 'robots_txt') ? undefined : (0, SfvbRobotsTxt_1.SfvbRobotsTxtFromJSON)(json['robots_txt']),
41
+ 'sitemaps': !(0, runtime_1.exists)(json, 'sitemaps') ? undefined : (json['sitemaps'].map(SfvbSitemap_1.SfvbSitemapFromJSON)),
42
+ 'storefront_oid': !(0, runtime_1.exists)(json, 'storefront_oid') ? undefined : json['storefront_oid'],
43
+ };
44
+ }
45
+ exports.SfvbSitemapsResponseFromJSONTyped = SfvbSitemapsResponseFromJSONTyped;
46
+ function SfvbSitemapsResponseToJSON(value) {
47
+ if (value === undefined) {
48
+ return undefined;
49
+ }
50
+ if (value === null) {
51
+ return null;
52
+ }
53
+ return {
54
+ 'host': value.host,
55
+ 'notes': value.notes,
56
+ 'prevent_indexing': value.prevent_indexing,
57
+ 'robots_txt': (0, SfvbRobotsTxt_1.SfvbRobotsTxtToJSON)(value.robots_txt),
58
+ 'sitemaps': value.sitemaps === undefined ? undefined : (value.sitemaps.map(SfvbSitemap_1.SfvbSitemapToJSON)),
59
+ 'storefront_oid': value.storefront_oid,
60
+ };
61
+ }
62
+ exports.SfvbSitemapsResponseToJSON = SfvbSitemapsResponseToJSON;
@@ -1171,6 +1171,7 @@ export * from './SfvbRedirectResponse';
1171
1171
  export * from './SfvbRedirectsResponse';
1172
1172
  export * from './SfvbRenderRequest';
1173
1173
  export * from './SfvbRenderResponse';
1174
+ export * from './SfvbRobotsTxt';
1174
1175
  export * from './SfvbSecretHandle';
1175
1176
  export * from './SfvbSecretKind';
1176
1177
  export * from './SfvbSecretKindsResponse';
@@ -1196,6 +1197,9 @@ export * from './SfvbSiteAttribute';
1196
1197
  export * from './SfvbSiteAttributeUpdate';
1197
1198
  export * from './SfvbSiteAttributeUpdateRequest';
1198
1199
  export * from './SfvbSiteAttributesResponse';
1200
+ export * from './SfvbSitemap';
1201
+ export * from './SfvbSitemapFile';
1202
+ export * from './SfvbSitemapsResponse';
1199
1203
  export * from './SfvbSmartAttribution';
1200
1204
  export * from './SfvbSmartAttributionPlatform';
1201
1205
  export * from './SfvbSmartAttributionRequest';
@@ -1189,6 +1189,7 @@ __exportStar(require("./SfvbRedirectResponse"), exports);
1189
1189
  __exportStar(require("./SfvbRedirectsResponse"), exports);
1190
1190
  __exportStar(require("./SfvbRenderRequest"), exports);
1191
1191
  __exportStar(require("./SfvbRenderResponse"), exports);
1192
+ __exportStar(require("./SfvbRobotsTxt"), exports);
1192
1193
  __exportStar(require("./SfvbSecretHandle"), exports);
1193
1194
  __exportStar(require("./SfvbSecretKind"), exports);
1194
1195
  __exportStar(require("./SfvbSecretKindsResponse"), exports);
@@ -1214,6 +1215,9 @@ __exportStar(require("./SfvbSiteAttribute"), exports);
1214
1215
  __exportStar(require("./SfvbSiteAttributeUpdate"), exports);
1215
1216
  __exportStar(require("./SfvbSiteAttributeUpdateRequest"), exports);
1216
1217
  __exportStar(require("./SfvbSiteAttributesResponse"), exports);
1218
+ __exportStar(require("./SfvbSitemap"), exports);
1219
+ __exportStar(require("./SfvbSitemapFile"), exports);
1220
+ __exportStar(require("./SfvbSitemapsResponse"), exports);
1217
1221
  __exportStar(require("./SfvbSmartAttribution"), exports);
1218
1222
  __exportStar(require("./SfvbSmartAttributionPlatform"), exports);
1219
1223
  __exportStar(require("./SfvbSmartAttributionRequest"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "4.1.226",
3
+ "version": "4.1.227",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "repository": {
@@ -489,6 +489,9 @@ import {
489
489
  SfvbSiteAttributesResponse,
490
490
  SfvbSiteAttributesResponseFromJSON,
491
491
  SfvbSiteAttributesResponseToJSON,
492
+ SfvbSitemapsResponse,
493
+ SfvbSitemapsResponseFromJSON,
494
+ SfvbSitemapsResponseToJSON,
492
495
  SfvbSmartAttribution,
493
496
  SfvbSmartAttributionFromJSON,
494
497
  SfvbSmartAttributionToJSON,
@@ -1164,6 +1167,10 @@ export interface GetSfvbSiteAttributesRequest {
1164
1167
  storefrontOid: number;
1165
1168
  }
1166
1169
 
1170
+ export interface GetSfvbSitemapsRequest {
1171
+ storefrontOid: number;
1172
+ }
1173
+
1167
1174
  export interface GetSfvbSmartAttributionRequest {
1168
1175
  storefrontOid: number;
1169
1176
  }
@@ -3814,6 +3821,22 @@ export interface SfvbApiInterface {
3814
3821
  */
3815
3822
  getSfvbSiteAttributes(requestParameters: GetSfvbSiteAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSiteAttributesResponse>;
3816
3823
 
3824
+ /**
3825
+ * 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.
3826
+ * @summary Read a storefront\'s sitemaps and robots.txt
3827
+ * @param {number} storefrontOid
3828
+ * @param {*} [options] Override http request option.
3829
+ * @throws {RequiredError}
3830
+ * @memberof SfvbApiInterface
3831
+ */
3832
+ getSfvbSitemapsRaw(requestParameters: GetSfvbSitemapsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSitemapsResponse>>;
3833
+
3834
+ /**
3835
+ * 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.
3836
+ * Read a storefront\'s sitemaps and robots.txt
3837
+ */
3838
+ getSfvbSitemaps(requestParameters: GetSfvbSitemapsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSitemapsResponse>;
3839
+
3817
3840
  /**
3818
3841
  * 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.
3819
3842
  * @summary Read a storefront\'s Smart Attribution configuration
@@ -11273,6 +11296,47 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
11273
11296
  return await response.value();
11274
11297
  }
11275
11298
 
11299
+ /**
11300
+ * 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.
11301
+ * Read a storefront\'s sitemaps and robots.txt
11302
+ */
11303
+ async getSfvbSitemapsRaw(requestParameters: GetSfvbSitemapsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSitemapsResponse>> {
11304
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
11305
+ throw new runtime.RequiredError('storefrontOid','Required parameter requestParameters.storefrontOid was null or undefined when calling getSfvbSitemaps.');
11306
+ }
11307
+
11308
+ const queryParameters: any = {};
11309
+
11310
+ const headerParameters: runtime.HTTPHeaders = {};
11311
+
11312
+ if (this.configuration && this.configuration.accessToken) {
11313
+ // oauth required
11314
+ headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", []);
11315
+ }
11316
+
11317
+ if (this.configuration && this.configuration.apiKey) {
11318
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
11319
+ }
11320
+
11321
+ const response = await this.request({
11322
+ path: `/sfvb/storefronts/{storefront_oid}/sitemaps`.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(requestParameters.storefrontOid))),
11323
+ method: 'GET',
11324
+ headers: headerParameters,
11325
+ query: queryParameters,
11326
+ }, initOverrides);
11327
+
11328
+ return new runtime.JSONApiResponse(response, (jsonValue) => SfvbSitemapsResponseFromJSON(jsonValue));
11329
+ }
11330
+
11331
+ /**
11332
+ * 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.
11333
+ * Read a storefront\'s sitemaps and robots.txt
11334
+ */
11335
+ async getSfvbSitemaps(requestParameters: GetSfvbSitemapsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSitemapsResponse> {
11336
+ const response = await this.getSfvbSitemapsRaw(requestParameters, initOverrides);
11337
+ return await response.value();
11338
+ }
11339
+
11276
11340
  /**
11277
11341
  * 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.
11278
11342
  * Read a storefront\'s Smart Attribution configuration
@@ -0,0 +1,83 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * UltraCart Rest API V2
5
+ * UltraCart REST API Version 2
6
+ *
7
+ * The version of the OpenAPI document: 2.0.0
8
+ * Contact: support@ultracart.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { exists, mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface SfvbRobotsTxt
20
+ */
21
+ export interface SfvbRobotsTxt {
22
+ /**
23
+ * True when the merchant has their own /robots.txt file, which is served after UltraCart's entries.
24
+ * @type {boolean}
25
+ * @memberof SfvbRobotsTxt
26
+ */
27
+ custom_file?: boolean;
28
+ /**
29
+ * The Sitemap lines it serves, UltraCart's own first, then any in the merchant's own robots.txt file.
30
+ * @type {Array<string>}
31
+ * @memberof SfvbRobotsTxt
32
+ */
33
+ sitemap_lines?: Array<string>;
34
+ /**
35
+ * The robots.txt URL on the storefront's host.
36
+ * @type {string}
37
+ * @memberof SfvbRobotsTxt
38
+ */
39
+ url?: string;
40
+ }
41
+
42
+
43
+
44
+ /**
45
+ * Check if a given object implements the SfvbRobotsTxt interface.
46
+ */
47
+ export function instanceOfSfvbRobotsTxt(value: object): boolean {
48
+ let isInstance = true;
49
+
50
+ return isInstance;
51
+ }
52
+
53
+ export function SfvbRobotsTxtFromJSON(json: any): SfvbRobotsTxt {
54
+ return SfvbRobotsTxtFromJSONTyped(json, false);
55
+ }
56
+
57
+ export function SfvbRobotsTxtFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbRobotsTxt {
58
+ if ((json === undefined) || (json === null)) {
59
+ return json;
60
+ }
61
+ return {
62
+
63
+ 'custom_file': !exists(json, 'custom_file') ? undefined : json['custom_file'],
64
+ 'sitemap_lines': !exists(json, 'sitemap_lines') ? undefined : json['sitemap_lines'],
65
+ 'url': !exists(json, 'url') ? undefined : json['url'],
66
+ };
67
+ }
68
+
69
+ export function SfvbRobotsTxtToJSON(value?: SfvbRobotsTxt | null): any {
70
+ if (value === undefined) {
71
+ return undefined;
72
+ }
73
+ if (value === null) {
74
+ return null;
75
+ }
76
+ return {
77
+
78
+ 'custom_file': value.custom_file,
79
+ 'sitemap_lines': value.sitemap_lines,
80
+ 'url': value.url,
81
+ };
82
+ }
83
+
@@ -0,0 +1,114 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * UltraCart Rest API V2
5
+ * UltraCart REST API Version 2
6
+ *
7
+ * The version of the OpenAPI document: 2.0.0
8
+ * Contact: support@ultracart.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { exists, mapValues } from '../runtime';
16
+ import {
17
+ SfvbSitemapFile,
18
+ SfvbSitemapFileFromJSON,
19
+ SfvbSitemapFileFromJSONTyped,
20
+ SfvbSitemapFileToJSON,
21
+ } from './SfvbSitemapFile';
22
+
23
+ /**
24
+ *
25
+ * @export
26
+ * @interface SfvbSitemap
27
+ */
28
+ export interface SfvbSitemap {
29
+ /**
30
+ * For an index, the child files it lists, in order.
31
+ * @type {Array<SfvbSitemapFile>}
32
+ * @memberof SfvbSitemap
33
+ */
34
+ child_files?: Array<SfvbSitemapFile>;
35
+ /**
36
+ * 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).
37
+ * @type {string}
38
+ * @memberof SfvbSitemap
39
+ */
40
+ format?: string;
41
+ /**
42
+ * When the nightly build last wrote the sitemap, as ISO 8601.
43
+ * @type {string}
44
+ * @memberof SfvbSitemap
45
+ */
46
+ last_built?: string;
47
+ /**
48
+ * The sitemap's path on the storefront.
49
+ * @type {string}
50
+ * @memberof SfvbSitemap
51
+ */
52
+ path?: string;
53
+ /**
54
+ * The file's size in bytes.
55
+ * @type {number}
56
+ * @memberof SfvbSitemap
57
+ */
58
+ size_bytes?: number;
59
+ /**
60
+ * The sitemap's https URL, the one to register.
61
+ * @type {string}
62
+ * @memberof SfvbSitemap
63
+ */
64
+ url?: string;
65
+ }
66
+
67
+
68
+
69
+ /**
70
+ * Check if a given object implements the SfvbSitemap interface.
71
+ */
72
+ export function instanceOfSfvbSitemap(value: object): boolean {
73
+ let isInstance = true;
74
+
75
+ return isInstance;
76
+ }
77
+
78
+ export function SfvbSitemapFromJSON(json: any): SfvbSitemap {
79
+ return SfvbSitemapFromJSONTyped(json, false);
80
+ }
81
+
82
+ export function SfvbSitemapFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSitemap {
83
+ if ((json === undefined) || (json === null)) {
84
+ return json;
85
+ }
86
+ return {
87
+
88
+ 'child_files': !exists(json, 'child_files') ? undefined : ((json['child_files'] as Array<any>).map(SfvbSitemapFileFromJSON)),
89
+ 'format': !exists(json, 'format') ? undefined : json['format'],
90
+ 'last_built': !exists(json, 'last_built') ? undefined : json['last_built'],
91
+ 'path': !exists(json, 'path') ? undefined : json['path'],
92
+ 'size_bytes': !exists(json, 'size_bytes') ? undefined : json['size_bytes'],
93
+ 'url': !exists(json, 'url') ? undefined : json['url'],
94
+ };
95
+ }
96
+
97
+ export function SfvbSitemapToJSON(value?: SfvbSitemap | null): any {
98
+ if (value === undefined) {
99
+ return undefined;
100
+ }
101
+ if (value === null) {
102
+ return null;
103
+ }
104
+ return {
105
+
106
+ 'child_files': value.child_files === undefined ? undefined : ((value.child_files as Array<any>).map(SfvbSitemapFileToJSON)),
107
+ 'format': value.format,
108
+ 'last_built': value.last_built,
109
+ 'path': value.path,
110
+ 'size_bytes': value.size_bytes,
111
+ 'url': value.url,
112
+ };
113
+ }
114
+
@@ -0,0 +1,91 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * UltraCart Rest API V2
5
+ * UltraCart REST API Version 2
6
+ *
7
+ * The version of the OpenAPI document: 2.0.0
8
+ * Contact: support@ultracart.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { exists, mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface SfvbSitemapFile
20
+ */
21
+ export interface SfvbSitemapFile {
22
+ /**
23
+ * When the nightly build last wrote the file, as ISO 8601.
24
+ * @type {string}
25
+ * @memberof SfvbSitemapFile
26
+ */
27
+ last_built?: string;
28
+ /**
29
+ * The file's path on the storefront, such as /sitemapsdotorg1.xml.gz.
30
+ * @type {string}
31
+ * @memberof SfvbSitemapFile
32
+ */
33
+ path?: string;
34
+ /**
35
+ * The file's size in bytes, compressed for a .gz file.
36
+ * @type {number}
37
+ * @memberof SfvbSitemapFile
38
+ */
39
+ size_bytes?: number;
40
+ /**
41
+ * The file's https URL on the storefront's host.
42
+ * @type {string}
43
+ * @memberof SfvbSitemapFile
44
+ */
45
+ url?: string;
46
+ }
47
+
48
+
49
+
50
+ /**
51
+ * Check if a given object implements the SfvbSitemapFile interface.
52
+ */
53
+ export function instanceOfSfvbSitemapFile(value: object): boolean {
54
+ let isInstance = true;
55
+
56
+ return isInstance;
57
+ }
58
+
59
+ export function SfvbSitemapFileFromJSON(json: any): SfvbSitemapFile {
60
+ return SfvbSitemapFileFromJSONTyped(json, false);
61
+ }
62
+
63
+ export function SfvbSitemapFileFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSitemapFile {
64
+ if ((json === undefined) || (json === null)) {
65
+ return json;
66
+ }
67
+ return {
68
+
69
+ 'last_built': !exists(json, 'last_built') ? undefined : json['last_built'],
70
+ 'path': !exists(json, 'path') ? undefined : json['path'],
71
+ 'size_bytes': !exists(json, 'size_bytes') ? undefined : json['size_bytes'],
72
+ 'url': !exists(json, 'url') ? undefined : json['url'],
73
+ };
74
+ }
75
+
76
+ export function SfvbSitemapFileToJSON(value?: SfvbSitemapFile | null): any {
77
+ if (value === undefined) {
78
+ return undefined;
79
+ }
80
+ if (value === null) {
81
+ return null;
82
+ }
83
+ return {
84
+
85
+ 'last_built': value.last_built,
86
+ 'path': value.path,
87
+ 'size_bytes': value.size_bytes,
88
+ 'url': value.url,
89
+ };
90
+ }
91
+
@@ -0,0 +1,120 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * UltraCart Rest API V2
5
+ * UltraCart REST API Version 2
6
+ *
7
+ * The version of the OpenAPI document: 2.0.0
8
+ * Contact: support@ultracart.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { exists, mapValues } from '../runtime';
16
+ import {
17
+ SfvbRobotsTxt,
18
+ SfvbRobotsTxtFromJSON,
19
+ SfvbRobotsTxtFromJSONTyped,
20
+ SfvbRobotsTxtToJSON,
21
+ } from './SfvbRobotsTxt';
22
+ import {
23
+ SfvbSitemap,
24
+ SfvbSitemapFromJSON,
25
+ SfvbSitemapFromJSONTyped,
26
+ SfvbSitemapToJSON,
27
+ } from './SfvbSitemap';
28
+
29
+ /**
30
+ *
31
+ * @export
32
+ * @interface SfvbSitemapsResponse
33
+ */
34
+ export interface SfvbSitemapsResponse {
35
+ /**
36
+ * The host the sitemaps are built for.
37
+ * @type {string}
38
+ * @memberof SfvbSitemapsResponse
39
+ */
40
+ host?: string;
41
+ /**
42
+ * What a person should know about these sitemaps, such as when they are rebuilt.
43
+ * @type {Array<string>}
44
+ * @memberof SfvbSitemapsResponse
45
+ */
46
+ notes?: Array<string>;
47
+ /**
48
+ * True when the storefront's Prevent Indexing setting is on. The sitemaps are still served, but every page tells search engines not to index it.
49
+ * @type {boolean}
50
+ * @memberof SfvbSitemapsResponse
51
+ */
52
+ prevent_indexing?: boolean;
53
+ /**
54
+ *
55
+ * @type {SfvbRobotsTxt}
56
+ * @memberof SfvbSitemapsResponse
57
+ */
58
+ robots_txt?: SfvbRobotsTxt;
59
+ /**
60
+ * The sitemaps that exist, sitemaps.org first. Empty until the nightly build has run.
61
+ * @type {Array<SfvbSitemap>}
62
+ * @memberof SfvbSitemapsResponse
63
+ */
64
+ sitemaps?: Array<SfvbSitemap>;
65
+ /**
66
+ * The storefront.
67
+ * @type {number}
68
+ * @memberof SfvbSitemapsResponse
69
+ */
70
+ storefront_oid?: number;
71
+ }
72
+
73
+
74
+
75
+ /**
76
+ * Check if a given object implements the SfvbSitemapsResponse interface.
77
+ */
78
+ export function instanceOfSfvbSitemapsResponse(value: object): boolean {
79
+ let isInstance = true;
80
+
81
+ return isInstance;
82
+ }
83
+
84
+ export function SfvbSitemapsResponseFromJSON(json: any): SfvbSitemapsResponse {
85
+ return SfvbSitemapsResponseFromJSONTyped(json, false);
86
+ }
87
+
88
+ export function SfvbSitemapsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSitemapsResponse {
89
+ if ((json === undefined) || (json === null)) {
90
+ return json;
91
+ }
92
+ return {
93
+
94
+ 'host': !exists(json, 'host') ? undefined : json['host'],
95
+ 'notes': !exists(json, 'notes') ? undefined : json['notes'],
96
+ 'prevent_indexing': !exists(json, 'prevent_indexing') ? undefined : json['prevent_indexing'],
97
+ 'robots_txt': !exists(json, 'robots_txt') ? undefined : SfvbRobotsTxtFromJSON(json['robots_txt']),
98
+ 'sitemaps': !exists(json, 'sitemaps') ? undefined : ((json['sitemaps'] as Array<any>).map(SfvbSitemapFromJSON)),
99
+ 'storefront_oid': !exists(json, 'storefront_oid') ? undefined : json['storefront_oid'],
100
+ };
101
+ }
102
+
103
+ export function SfvbSitemapsResponseToJSON(value?: SfvbSitemapsResponse | null): any {
104
+ if (value === undefined) {
105
+ return undefined;
106
+ }
107
+ if (value === null) {
108
+ return null;
109
+ }
110
+ return {
111
+
112
+ 'host': value.host,
113
+ 'notes': value.notes,
114
+ 'prevent_indexing': value.prevent_indexing,
115
+ 'robots_txt': SfvbRobotsTxtToJSON(value.robots_txt),
116
+ 'sitemaps': value.sitemaps === undefined ? undefined : ((value.sitemaps as Array<any>).map(SfvbSitemapToJSON)),
117
+ 'storefront_oid': value.storefront_oid,
118
+ };
119
+ }
120
+
@@ -1173,6 +1173,7 @@ export * from './SfvbRedirectResponse';
1173
1173
  export * from './SfvbRedirectsResponse';
1174
1174
  export * from './SfvbRenderRequest';
1175
1175
  export * from './SfvbRenderResponse';
1176
+ export * from './SfvbRobotsTxt';
1176
1177
  export * from './SfvbSecretHandle';
1177
1178
  export * from './SfvbSecretKind';
1178
1179
  export * from './SfvbSecretKindsResponse';
@@ -1198,6 +1199,9 @@ export * from './SfvbSiteAttribute';
1198
1199
  export * from './SfvbSiteAttributeUpdate';
1199
1200
  export * from './SfvbSiteAttributeUpdateRequest';
1200
1201
  export * from './SfvbSiteAttributesResponse';
1202
+ export * from './SfvbSitemap';
1203
+ export * from './SfvbSitemapFile';
1204
+ export * from './SfvbSitemapsResponse';
1201
1205
  export * from './SfvbSmartAttribution';
1202
1206
  export * from './SfvbSmartAttributionPlatform';
1203
1207
  export * from './SfvbSmartAttributionRequest';