ultracart_rest_api_v2_typescript 4.1.235 → 4.1.237

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.
@@ -1088,6 +1088,9 @@ src/models/SfvbContainerRevertRequest.ts
1088
1088
  src/models/SfvbContainerVersion.ts
1089
1089
  src/models/SfvbContainerVersionsResponse.ts
1090
1090
  src/models/SfvbContainerWriteRequest.ts
1091
+ src/models/SfvbDocsGap.ts
1092
+ src/models/SfvbDocsGapReport.ts
1093
+ src/models/SfvbDocsGapReportGap.ts
1091
1094
  src/models/SfvbElement.ts
1092
1095
  src/models/SfvbElementSchemaResponse.ts
1093
1096
  src/models/SfvbElementsResponse.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.235
2
+ ## ultracart_rest_api_v2_typescript@4.1.237
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.235 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.237 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -84,6 +84,8 @@ Not every change is committed to every SDK.
84
84
 
85
85
  | Version | Date | Comments |
86
86
  | --: | :-: | --- |
87
+ | 4.1.237 | 11/10/2026 | sfvb internal testing |
88
+ | 4.1.236 | 11/09/2026 | sfvb internal testing |
87
89
  | 4.1.235 | 11/09/2026 | sfvb internal testing |
88
90
  | 4.1.234 | 11/09/2026 | sfvb internal testing |
89
91
  | 4.1.233 | 11/06/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, SfvbCommsClicksResponse, SfvbCommsDashboardResponse, SfvbCommsFolderResponse, SfvbCommsFolderWriteRequest, SfvbCommsFoldersResponse, SfvbCommsListResponse, SfvbCommsListWriteRequest, SfvbCommsListsResponse, SfvbCommsLookupResponse, SfvbCommsMembersResponse, SfvbCommsPlanResponse, SfvbCommsProviderImportRequest, SfvbCommsProviderImportResponse, SfvbCommsProvidersResponse, SfvbCommsRulerValidateRequest, SfvbCommsRulerValidateResponse, SfvbCommsSegmentResponse, SfvbCommsSegmentWriteRequest, SfvbCommsSegmentsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsSequenceFolderResponse, SfvbCommsSequenceFoldersResponse, SfvbCommsSequenceStatsResponse, SfvbCommsSettingsResponse, SfvbCommsSettingsUpdateRequest, SfvbCommsTemplateResponse, SfvbCommsTemplatesResponse, SfvbCommsTestEmailRequest, SfvbCommsTestPostcardRequest, SfvbCommsTestSendResponse, SfvbCommsTestSmsRequest, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCommsUnreferencedResponse, 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, SfvbFlowBackfillRequest, SfvbFlowBackfillResponse, SfvbFlowStatusRequest, SfvbFlowWriteRequest, SfvbFlowsResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeBatchRequest, SfvbItemAttributeBatchResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaDescriptionRequest, SfvbItemMultimediaRequest, SfvbItemPricing, SfvbItemPricingRequest, SfvbItemRelated, SfvbItemRelatedRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbNotFoundSummary, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPostcardProofRequest, SfvbPostcardProofResponse, SfvbPostcardTrackingResponse, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewTrackingHtmlRequest, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveBatchRequest, SfvbRedirectResolveBatchResponse, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbSequence, SfvbSequenceStepCreateRequest, SfvbSequenceStepCreateResponse, SfvbSequenceStepDeleteResponse, SfvbSequenceStepMoveRequest, SfvbSequenceStepMoveResponse, SfvbSequenceStepUpdateRequest, SfvbSequenceStepUpdateResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbSiteSeo, SfvbSiteSeoRequest, SfvbSitemapsResponse, SfvbSmartAttribution, SfvbSmartAttributionRequest, SfvbStepDispatchLogsResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTrackingAdvancedRequest, SfvbTrackingCheckPlan, SfvbTrackingHtml, SfvbTrackingHtmlRenderRequest, SfvbTrackingHtmlRenderResponse, SfvbTrackingHtmlRequest, SfvbTrackingHtmlResponse, SfvbTrackingPrivacyRequest, SfvbTrackingProvider, SfvbTrackingProviderRequest, SfvbTrackingProvidersResponse, SfvbTrackingSettingsResponse, SfvbTransactionalEmailResponse, SfvbTransactionalEmailUpdateRequest, 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, SfvbCommsClicksResponse, SfvbCommsDashboardResponse, SfvbCommsFolderResponse, SfvbCommsFolderWriteRequest, SfvbCommsFoldersResponse, SfvbCommsListResponse, SfvbCommsListWriteRequest, SfvbCommsListsResponse, SfvbCommsLookupResponse, SfvbCommsMembersResponse, SfvbCommsPlanResponse, SfvbCommsProviderImportRequest, SfvbCommsProviderImportResponse, SfvbCommsProvidersResponse, SfvbCommsRulerValidateRequest, SfvbCommsRulerValidateResponse, SfvbCommsSegmentResponse, SfvbCommsSegmentWriteRequest, SfvbCommsSegmentsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsSequenceFolderResponse, SfvbCommsSequenceFoldersResponse, SfvbCommsSequenceStatsResponse, SfvbCommsSettingsResponse, SfvbCommsSettingsUpdateRequest, SfvbCommsTemplateResponse, SfvbCommsTemplatesResponse, SfvbCommsTestEmailRequest, SfvbCommsTestPostcardRequest, SfvbCommsTestSendResponse, SfvbCommsTestSmsRequest, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCommsUnreferencedResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbDocsGap, SfvbDocsGapReport, 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, SfvbFlowBackfillRequest, SfvbFlowBackfillResponse, SfvbFlowStatusRequest, SfvbFlowWriteRequest, SfvbFlowsResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeBatchRequest, SfvbItemAttributeBatchResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaDescriptionRequest, SfvbItemMultimediaRequest, SfvbItemPricing, SfvbItemPricingRequest, SfvbItemRelated, SfvbItemRelatedRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbNotFoundSummary, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPostcardProofRequest, SfvbPostcardProofResponse, SfvbPostcardTrackingResponse, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewTrackingHtmlRequest, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveBatchRequest, SfvbRedirectResolveBatchResponse, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbSequence, SfvbSequenceStepCreateRequest, SfvbSequenceStepCreateResponse, SfvbSequenceStepDeleteResponse, SfvbSequenceStepMoveRequest, SfvbSequenceStepMoveResponse, SfvbSequenceStepUpdateRequest, SfvbSequenceStepUpdateResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbSiteSeo, SfvbSiteSeoRequest, SfvbSitemapsResponse, SfvbSmartAttribution, SfvbSmartAttributionRequest, SfvbStepDispatchLogsResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTrackingAdvancedRequest, SfvbTrackingCheckPlan, SfvbTrackingHtml, SfvbTrackingHtmlRenderRequest, SfvbTrackingHtmlRenderResponse, SfvbTrackingHtmlRequest, SfvbTrackingHtmlResponse, SfvbTrackingPrivacyRequest, SfvbTrackingProvider, SfvbTrackingProviderRequest, SfvbTrackingProvidersResponse, SfvbTrackingSettingsResponse, SfvbTransactionalEmailResponse, SfvbTransactionalEmailUpdateRequest, 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;
@@ -420,6 +420,9 @@ export interface GetSfvbContainerVersionRequest {
420
420
  ownerObjectId?: string;
421
421
  containerName?: string;
422
422
  }
423
+ export interface GetSfvbDocsGapRequest {
424
+ reportId: string;
425
+ }
423
426
  export interface GetSfvbElementRequest {
424
427
  elementType: string;
425
428
  }
@@ -746,6 +749,10 @@ export interface InsertSfvbCommsSendingDomainRequest {
746
749
  export interface InsertSfvbCommsTwilioAccountRequest {
747
750
  twilioAccount: SfvbCommsTwilioAccount;
748
751
  }
752
+ export interface InsertSfvbDocsGapRequest {
753
+ docsGapReport: SfvbDocsGapReport;
754
+ storefrontOid?: number;
755
+ }
749
756
  export interface InsertSfvbPageRequest {
750
757
  storefrontOid: number;
751
758
  pageCreateRequest: SfvbPageCreateRequest;
@@ -2831,6 +2838,20 @@ export interface SfvbApiInterface {
2831
2838
  * Read the CJSON stored in one container history entry
2832
2839
  */
2833
2840
  getSfvbContainerVersion(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersion>;
2841
+ /**
2842
+ * The status of a report this account sent. received until UltraCart staff look at it, then accepted, declined or fixed. The report text and UltraCart\'s internal notes are not returned. A report from another account answers 404.
2843
+ * @summary Get a documentation-gap report\'s status
2844
+ * @param {string} reportId
2845
+ * @param {*} [options] Override http request option.
2846
+ * @throws {RequiredError}
2847
+ * @memberof SfvbApiInterface
2848
+ */
2849
+ getSfvbDocsGapRaw(requestParameters: GetSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbDocsGap>>;
2850
+ /**
2851
+ * The status of a report this account sent. received until UltraCart staff look at it, then accepted, declined or fixed. The report text and UltraCart\'s internal notes are not returned. A report from another account answers 404.
2852
+ * Get a documentation-gap report\'s status
2853
+ */
2854
+ getSfvbDocsGap(requestParameters: GetSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbDocsGap>;
2834
2855
  /**
2835
2856
  * schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings. Either is omitted when none has been published for the element, which is still a 200. The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here.
2836
2857
  * @summary Configuration schema and field card for one element type
@@ -4033,6 +4054,21 @@ export interface SfvbApiInterface {
4033
4054
  * Connect the Twilio account
4034
4055
  */
4035
4056
  insertSfvbCommsTwilioAccount(requestParameters: InsertSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTwilioAccountResponse>;
4057
+ /**
4058
+ * Reports a place where docs.ultracart.com is wrong or missing, for UltraCart staff to triage. Send the report uc-storefront docs gap review checked, in this form. Optionally name the storefront the agent was working on with storefront_oid. The server checks the report again and refuses one that holds a credential or an email address (an ultracart.com address may stay), without keeping it. Sending the same report again returns the earlier report_id with 200 and duplicate true rather than a second report. An account may send 20 reports a UTC day. Requires a token that resolves to a user, so use the device authorization flow.
4059
+ * @summary Send UltraCart a documentation-gap report
4060
+ * @param {SfvbDocsGapReport} docsGapReport The report
4061
+ * @param {number} [storefrontOid] The storefront the agent was working on, recorded for context. Leave it out when none applies.
4062
+ * @param {*} [options] Override http request option.
4063
+ * @throws {RequiredError}
4064
+ * @memberof SfvbApiInterface
4065
+ */
4066
+ insertSfvbDocsGapRaw(requestParameters: InsertSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbDocsGap>>;
4067
+ /**
4068
+ * Reports a place where docs.ultracart.com is wrong or missing, for UltraCart staff to triage. Send the report uc-storefront docs gap review checked, in this form. Optionally name the storefront the agent was working on with storefront_oid. The server checks the report again and refuses one that holds a credential or an email address (an ultracart.com address may stay), without keeping it. Sending the same report again returns the earlier report_id with 200 and duplicate true rather than a second report. An account may send 20 reports a UTC day. Requires a token that resolves to a user, so use the device authorization flow.
4069
+ * Send UltraCart a documentation-gap report
4070
+ */
4071
+ insertSfvbDocsGap(requestParameters: InsertSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbDocsGap>;
4036
4072
  /**
4037
4073
  * Creates the page and its folder, the way the store admin\'s add page does. The parent page must already exist, and the last part of the path may only contain letters, digits, hyphens and underscores - it is refused, not cleaned. A path that already has a page is refused with a 409 and the code sfvb.page_exists. Without a group_template the page inherits its parent\'s templates, or catalog_group.vm directly under the root. Set attributes and images afterwards with the page attribute and image endpoints, and push the body to the page folder. Always needs sfvb_publish, because the page is live as soon as it exists. Deleting, moving and renaming pages stay in the store admin.
4038
4074
  * @summary Create a page
@@ -6896,6 +6932,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
6896
6932
  * Read the CJSON stored in one container history entry
6897
6933
  */
6898
6934
  getSfvbContainerVersion(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersion>;
6935
+ /**
6936
+ * The status of a report this account sent. received until UltraCart staff look at it, then accepted, declined or fixed. The report text and UltraCart\'s internal notes are not returned. A report from another account answers 404.
6937
+ * Get a documentation-gap report\'s status
6938
+ */
6939
+ getSfvbDocsGapRaw(requestParameters: GetSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbDocsGap>>;
6940
+ /**
6941
+ * The status of a report this account sent. received until UltraCart staff look at it, then accepted, declined or fixed. The report text and UltraCart\'s internal notes are not returned. A report from another account answers 404.
6942
+ * Get a documentation-gap report\'s status
6943
+ */
6944
+ getSfvbDocsGap(requestParameters: GetSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbDocsGap>;
6899
6945
  /**
6900
6946
  * schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings. Either is omitted when none has been published for the element, which is still a 200. The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here.
6901
6947
  * Configuration schema and field card for one element type
@@ -7684,6 +7730,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
7684
7730
  * Connect the Twilio account
7685
7731
  */
7686
7732
  insertSfvbCommsTwilioAccount(requestParameters: InsertSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTwilioAccountResponse>;
7733
+ /**
7734
+ * Reports a place where docs.ultracart.com is wrong or missing, for UltraCart staff to triage. Send the report uc-storefront docs gap review checked, in this form. Optionally name the storefront the agent was working on with storefront_oid. The server checks the report again and refuses one that holds a credential or an email address (an ultracart.com address may stay), without keeping it. Sending the same report again returns the earlier report_id with 200 and duplicate true rather than a second report. An account may send 20 reports a UTC day. Requires a token that resolves to a user, so use the device authorization flow.
7735
+ * Send UltraCart a documentation-gap report
7736
+ */
7737
+ insertSfvbDocsGapRaw(requestParameters: InsertSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbDocsGap>>;
7738
+ /**
7739
+ * Reports a place where docs.ultracart.com is wrong or missing, for UltraCart staff to triage. Send the report uc-storefront docs gap review checked, in this form. Optionally name the storefront the agent was working on with storefront_oid. The server checks the report again and refuses one that holds a credential or an email address (an ultracart.com address may stay), without keeping it. Sending the same report again returns the earlier report_id with 200 and duplicate true rather than a second report. An account may send 20 reports a UTC day. Requires a token that resolves to a user, so use the device authorization flow.
7740
+ * Send UltraCart a documentation-gap report
7741
+ */
7742
+ insertSfvbDocsGap(requestParameters: InsertSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbDocsGap>;
7687
7743
  /**
7688
7744
  * Creates the page and its folder, the way the store admin\'s add page does. The parent page must already exist, and the last part of the path may only contain letters, digits, hyphens and underscores - it is refused, not cleaned. A path that already has a page is refused with a 409 and the code sfvb.page_exists. Without a group_template the page inherits its parent\'s templates, or catalog_group.vm directly under the root. Set attributes and images afterwards with the page attribute and image endpoints, and push the body to the page folder. Always needs sfvb_publish, because the page is live as soon as it exists. Deleting, moving and renaming pages stay in the store admin.
7689
7745
  * Create a page
@@ -6102,6 +6102,65 @@ var SfvbApi = /** @class */ (function (_super) {
6102
6102
  });
6103
6103
  });
6104
6104
  };
6105
+ /**
6106
+ * The status of a report this account sent. received until UltraCart staff look at it, then accepted, declined or fixed. The report text and UltraCart\'s internal notes are not returned. A report from another account answers 404.
6107
+ * Get a documentation-gap report\'s status
6108
+ */
6109
+ SfvbApi.prototype.getSfvbDocsGapRaw = function (requestParameters, initOverrides) {
6110
+ return __awaiter(this, void 0, void 0, function () {
6111
+ var queryParameters, headerParameters, _a, _b, response;
6112
+ return __generator(this, function (_c) {
6113
+ switch (_c.label) {
6114
+ case 0:
6115
+ if (requestParameters.reportId === null || requestParameters.reportId === undefined) {
6116
+ throw new runtime.RequiredError('reportId', 'Required parameter requestParameters.reportId was null or undefined when calling getSfvbDocsGap.');
6117
+ }
6118
+ queryParameters = {};
6119
+ headerParameters = {};
6120
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
6121
+ // oauth required
6122
+ _a = headerParameters;
6123
+ _b = "Authorization";
6124
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
6125
+ case 1:
6126
+ // oauth required
6127
+ _a[_b] = _c.sent();
6128
+ _c.label = 2;
6129
+ case 2:
6130
+ if (this.configuration && this.configuration.apiKey) {
6131
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
6132
+ }
6133
+ return [4 /*yield*/, this.request({
6134
+ path: "/sfvb/docs/gaps/{report_id}".replace("{".concat("report_id", "}"), encodeURIComponent(String(requestParameters.reportId))),
6135
+ method: 'GET',
6136
+ headers: headerParameters,
6137
+ query: queryParameters,
6138
+ }, initOverrides)];
6139
+ case 3:
6140
+ response = _c.sent();
6141
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbDocsGapFromJSON)(jsonValue); })];
6142
+ }
6143
+ });
6144
+ });
6145
+ };
6146
+ /**
6147
+ * The status of a report this account sent. received until UltraCart staff look at it, then accepted, declined or fixed. The report text and UltraCart\'s internal notes are not returned. A report from another account answers 404.
6148
+ * Get a documentation-gap report\'s status
6149
+ */
6150
+ SfvbApi.prototype.getSfvbDocsGap = function (requestParameters, initOverrides) {
6151
+ return __awaiter(this, void 0, void 0, function () {
6152
+ var response;
6153
+ return __generator(this, function (_a) {
6154
+ switch (_a.label) {
6155
+ case 0: return [4 /*yield*/, this.getSfvbDocsGapRaw(requestParameters, initOverrides)];
6156
+ case 1:
6157
+ response = _a.sent();
6158
+ return [4 /*yield*/, response.value()];
6159
+ case 2: return [2 /*return*/, _a.sent()];
6160
+ }
6161
+ });
6162
+ });
6163
+ };
6105
6164
  /**
6106
6165
  * schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings. Either is omitted when none has been published for the element, which is still a 200. The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here.
6107
6166
  * Configuration schema and field card for one element type
@@ -11092,6 +11151,70 @@ var SfvbApi = /** @class */ (function (_super) {
11092
11151
  });
11093
11152
  });
11094
11153
  };
11154
+ /**
11155
+ * Reports a place where docs.ultracart.com is wrong or missing, for UltraCart staff to triage. Send the report uc-storefront docs gap review checked, in this form. Optionally name the storefront the agent was working on with storefront_oid. The server checks the report again and refuses one that holds a credential or an email address (an ultracart.com address may stay), without keeping it. Sending the same report again returns the earlier report_id with 200 and duplicate true rather than a second report. An account may send 20 reports a UTC day. Requires a token that resolves to a user, so use the device authorization flow.
11156
+ * Send UltraCart a documentation-gap report
11157
+ */
11158
+ SfvbApi.prototype.insertSfvbDocsGapRaw = function (requestParameters, initOverrides) {
11159
+ return __awaiter(this, void 0, void 0, function () {
11160
+ var queryParameters, headerParameters, _a, _b, response;
11161
+ return __generator(this, function (_c) {
11162
+ switch (_c.label) {
11163
+ case 0:
11164
+ if (requestParameters.docsGapReport === null || requestParameters.docsGapReport === undefined) {
11165
+ throw new runtime.RequiredError('docsGapReport', 'Required parameter requestParameters.docsGapReport was null or undefined when calling insertSfvbDocsGap.');
11166
+ }
11167
+ queryParameters = {};
11168
+ if (requestParameters.storefrontOid !== undefined) {
11169
+ queryParameters['storefront_oid'] = requestParameters.storefrontOid;
11170
+ }
11171
+ headerParameters = {};
11172
+ headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
11173
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
11174
+ // oauth required
11175
+ _a = headerParameters;
11176
+ _b = "Authorization";
11177
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
11178
+ case 1:
11179
+ // oauth required
11180
+ _a[_b] = _c.sent();
11181
+ _c.label = 2;
11182
+ case 2:
11183
+ if (this.configuration && this.configuration.apiKey) {
11184
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
11185
+ }
11186
+ return [4 /*yield*/, this.request({
11187
+ path: "/sfvb/docs/gaps",
11188
+ method: 'POST',
11189
+ headers: headerParameters,
11190
+ query: queryParameters,
11191
+ body: (0, models_1.SfvbDocsGapReportToJSON)(requestParameters.docsGapReport),
11192
+ }, initOverrides)];
11193
+ case 3:
11194
+ response = _c.sent();
11195
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbDocsGapFromJSON)(jsonValue); })];
11196
+ }
11197
+ });
11198
+ });
11199
+ };
11200
+ /**
11201
+ * Reports a place where docs.ultracart.com is wrong or missing, for UltraCart staff to triage. Send the report uc-storefront docs gap review checked, in this form. Optionally name the storefront the agent was working on with storefront_oid. The server checks the report again and refuses one that holds a credential or an email address (an ultracart.com address may stay), without keeping it. Sending the same report again returns the earlier report_id with 200 and duplicate true rather than a second report. An account may send 20 reports a UTC day. Requires a token that resolves to a user, so use the device authorization flow.
11202
+ * Send UltraCart a documentation-gap report
11203
+ */
11204
+ SfvbApi.prototype.insertSfvbDocsGap = function (requestParameters, initOverrides) {
11205
+ return __awaiter(this, void 0, void 0, function () {
11206
+ var response;
11207
+ return __generator(this, function (_a) {
11208
+ switch (_a.label) {
11209
+ case 0: return [4 /*yield*/, this.insertSfvbDocsGapRaw(requestParameters, initOverrides)];
11210
+ case 1:
11211
+ response = _a.sent();
11212
+ return [4 /*yield*/, response.value()];
11213
+ case 2: return [2 /*return*/, _a.sent()];
11214
+ }
11215
+ });
11216
+ });
11217
+ };
11095
11218
  /**
11096
11219
  * Creates the page and its folder, the way the store admin\'s add page does. The parent page must already exist, and the last part of the path may only contain letters, digits, hyphens and underscores - it is refused, not cleaned. A path that already has a page is refused with a 409 and the code sfvb.page_exists. Without a group_template the page inherits its parent\'s templates, or catalog_group.vm directly under the root. Set attributes and images afterwards with the page attribute and image endpoints, and push the body to the page folder. Always needs sfvb_publish, because the page is live as soon as it exists. Deleting, moving and renaming pages stay in the store admin.
11097
11220
  * Create a page
@@ -161,6 +161,7 @@ export declare const SfvbApprovalCreateRequestActionEnum: {
161
161
  readonly SmartAttributionChange: "smart_attribution.change";
162
162
  readonly SmartAttributionDelete: "smart_attribution.delete";
163
163
  readonly TrackingProviderChange: "tracking_provider.change";
164
+ readonly TrackingProviderClear: "tracking_provider.clear";
164
165
  readonly TrackingHtmlPut: "tracking_html.put";
165
166
  readonly AffiliateNetworkChange: "affiliate_network.change";
166
167
  readonly AffiliateNetworkDelete: "affiliate_network.delete";
@@ -52,6 +52,7 @@ exports.SfvbApprovalCreateRequestActionEnum = {
52
52
  SmartAttributionChange: 'smart_attribution.change',
53
53
  SmartAttributionDelete: 'smart_attribution.delete',
54
54
  TrackingProviderChange: 'tracking_provider.change',
55
+ TrackingProviderClear: 'tracking_provider.clear',
55
56
  TrackingHtmlPut: 'tracking_html.put',
56
57
  AffiliateNetworkChange: 'affiliate_network.change',
57
58
  AffiliateNetworkDelete: 'affiliate_network.delete',
@@ -0,0 +1,71 @@
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 SfvbDocsGap
16
+ */
17
+ export interface SfvbDocsGap {
18
+ /**
19
+ * On submit, true when this account had already sent the same report. The earlier report_id is returned and nothing new is kept.
20
+ * @type {boolean}
21
+ * @memberof SfvbDocsGap
22
+ */
23
+ duplicate?: boolean;
24
+ /**
25
+ * When UltraCart received the report.
26
+ * @type {string}
27
+ * @memberof SfvbDocsGap
28
+ */
29
+ received_at?: string;
30
+ /**
31
+ * The report's id. Quote it to UltraCart, or look the report up with GET docs/gaps/{report_id}.
32
+ * @type {string}
33
+ * @memberof SfvbDocsGap
34
+ */
35
+ report_id?: string;
36
+ /**
37
+ * received until UltraCart staff look at it, then accepted, declined or fixed.
38
+ * @type {string}
39
+ * @memberof SfvbDocsGap
40
+ */
41
+ status?: SfvbDocsGapStatusEnum;
42
+ /**
43
+ * When the status last changed. Absent while the report is received.
44
+ * @type {string}
45
+ * @memberof SfvbDocsGap
46
+ */
47
+ status_at?: string;
48
+ /**
49
+ * The storefront named when the report was sent, if one was.
50
+ * @type {number}
51
+ * @memberof SfvbDocsGap
52
+ */
53
+ storefront_oid?: number;
54
+ }
55
+ /**
56
+ * @export
57
+ */
58
+ export declare const SfvbDocsGapStatusEnum: {
59
+ readonly Received: "received";
60
+ readonly Accepted: "accepted";
61
+ readonly Declined: "declined";
62
+ readonly Fixed: "fixed";
63
+ };
64
+ export type SfvbDocsGapStatusEnum = typeof SfvbDocsGapStatusEnum[keyof typeof SfvbDocsGapStatusEnum];
65
+ /**
66
+ * Check if a given object implements the SfvbDocsGap interface.
67
+ */
68
+ export declare function instanceOfSfvbDocsGap(value: object): boolean;
69
+ export declare function SfvbDocsGapFromJSON(json: any): SfvbDocsGap;
70
+ export declare function SfvbDocsGapFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbDocsGap;
71
+ export declare function SfvbDocsGapToJSON(value?: SfvbDocsGap | null): any;
@@ -0,0 +1,69 @@
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.SfvbDocsGapToJSON = exports.SfvbDocsGapFromJSONTyped = exports.SfvbDocsGapFromJSON = exports.instanceOfSfvbDocsGap = exports.SfvbDocsGapStatusEnum = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * @export
20
+ */
21
+ exports.SfvbDocsGapStatusEnum = {
22
+ Received: 'received',
23
+ Accepted: 'accepted',
24
+ Declined: 'declined',
25
+ Fixed: 'fixed'
26
+ };
27
+ /**
28
+ * Check if a given object implements the SfvbDocsGap interface.
29
+ */
30
+ function instanceOfSfvbDocsGap(value) {
31
+ var isInstance = true;
32
+ return isInstance;
33
+ }
34
+ exports.instanceOfSfvbDocsGap = instanceOfSfvbDocsGap;
35
+ function SfvbDocsGapFromJSON(json) {
36
+ return SfvbDocsGapFromJSONTyped(json, false);
37
+ }
38
+ exports.SfvbDocsGapFromJSON = SfvbDocsGapFromJSON;
39
+ function SfvbDocsGapFromJSONTyped(json, ignoreDiscriminator) {
40
+ if ((json === undefined) || (json === null)) {
41
+ return json;
42
+ }
43
+ return {
44
+ 'duplicate': !(0, runtime_1.exists)(json, 'duplicate') ? undefined : json['duplicate'],
45
+ 'received_at': !(0, runtime_1.exists)(json, 'received_at') ? undefined : json['received_at'],
46
+ 'report_id': !(0, runtime_1.exists)(json, 'report_id') ? undefined : json['report_id'],
47
+ 'status': !(0, runtime_1.exists)(json, 'status') ? undefined : json['status'],
48
+ 'status_at': !(0, runtime_1.exists)(json, 'status_at') ? undefined : json['status_at'],
49
+ 'storefront_oid': !(0, runtime_1.exists)(json, 'storefront_oid') ? undefined : json['storefront_oid'],
50
+ };
51
+ }
52
+ exports.SfvbDocsGapFromJSONTyped = SfvbDocsGapFromJSONTyped;
53
+ function SfvbDocsGapToJSON(value) {
54
+ if (value === undefined) {
55
+ return undefined;
56
+ }
57
+ if (value === null) {
58
+ return null;
59
+ }
60
+ return {
61
+ 'duplicate': value.duplicate,
62
+ 'received_at': value.received_at,
63
+ 'report_id': value.report_id,
64
+ 'status': value.status,
65
+ 'status_at': value.status_at,
66
+ 'storefront_oid': value.storefront_oid,
67
+ };
68
+ }
69
+ exports.SfvbDocsGapToJSON = SfvbDocsGapToJSON;
@@ -0,0 +1,50 @@
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 { SfvbDocsGapReportGap } from './SfvbDocsGapReportGap';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface SfvbDocsGapReport
17
+ */
18
+ export interface SfvbDocsGapReport {
19
+ /**
20
+ * When the report was captured, as a UTC ISO-8601 timestamp. Not more than a day ahead of the server's clock.
21
+ * @type {string}
22
+ * @memberof SfvbDocsGapReport
23
+ */
24
+ created_at?: string;
25
+ /**
26
+ * Always 1.
27
+ * @type {number}
28
+ * @memberof SfvbDocsGapReport
29
+ */
30
+ format_version?: number;
31
+ /**
32
+ *
33
+ * @type {SfvbDocsGapReportGap}
34
+ * @memberof SfvbDocsGapReport
35
+ */
36
+ gap?: SfvbDocsGapReportGap;
37
+ /**
38
+ * Always documentation-gap.
39
+ * @type {string}
40
+ * @memberof SfvbDocsGapReport
41
+ */
42
+ kind?: string;
43
+ }
44
+ /**
45
+ * Check if a given object implements the SfvbDocsGapReport interface.
46
+ */
47
+ export declare function instanceOfSfvbDocsGapReport(value: object): boolean;
48
+ export declare function SfvbDocsGapReportFromJSON(json: any): SfvbDocsGapReport;
49
+ export declare function SfvbDocsGapReportFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbDocsGapReport;
50
+ export declare function SfvbDocsGapReportToJSON(value?: SfvbDocsGapReport | null): any;
@@ -0,0 +1,57 @@
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.SfvbDocsGapReportToJSON = exports.SfvbDocsGapReportFromJSONTyped = exports.SfvbDocsGapReportFromJSON = exports.instanceOfSfvbDocsGapReport = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ var SfvbDocsGapReportGap_1 = require("./SfvbDocsGapReportGap");
19
+ /**
20
+ * Check if a given object implements the SfvbDocsGapReport interface.
21
+ */
22
+ function instanceOfSfvbDocsGapReport(value) {
23
+ var isInstance = true;
24
+ return isInstance;
25
+ }
26
+ exports.instanceOfSfvbDocsGapReport = instanceOfSfvbDocsGapReport;
27
+ function SfvbDocsGapReportFromJSON(json) {
28
+ return SfvbDocsGapReportFromJSONTyped(json, false);
29
+ }
30
+ exports.SfvbDocsGapReportFromJSON = SfvbDocsGapReportFromJSON;
31
+ function SfvbDocsGapReportFromJSONTyped(json, ignoreDiscriminator) {
32
+ if ((json === undefined) || (json === null)) {
33
+ return json;
34
+ }
35
+ return {
36
+ 'created_at': !(0, runtime_1.exists)(json, 'created_at') ? undefined : json['created_at'],
37
+ 'format_version': !(0, runtime_1.exists)(json, 'format_version') ? undefined : json['format_version'],
38
+ 'gap': !(0, runtime_1.exists)(json, 'gap') ? undefined : (0, SfvbDocsGapReportGap_1.SfvbDocsGapReportGapFromJSON)(json['gap']),
39
+ 'kind': !(0, runtime_1.exists)(json, 'kind') ? undefined : json['kind'],
40
+ };
41
+ }
42
+ exports.SfvbDocsGapReportFromJSONTyped = SfvbDocsGapReportFromJSONTyped;
43
+ function SfvbDocsGapReportToJSON(value) {
44
+ if (value === undefined) {
45
+ return undefined;
46
+ }
47
+ if (value === null) {
48
+ return null;
49
+ }
50
+ return {
51
+ 'created_at': value.created_at,
52
+ 'format_version': value.format_version,
53
+ 'gap': (0, SfvbDocsGapReportGap_1.SfvbDocsGapReportGapToJSON)(value.gap),
54
+ 'kind': value.kind,
55
+ };
56
+ }
57
+ exports.SfvbDocsGapReportToJSON = SfvbDocsGapReportToJSON;
@@ -0,0 +1,55 @@
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 SfvbDocsGapReportGap
16
+ */
17
+ export interface SfvbDocsGapReportGap {
18
+ /**
19
+ * The nearest documentation page, an absolute http or https URL of at most 2000 characters. Leave it out when no page exists.
20
+ * @type {string}
21
+ * @memberof SfvbDocsGapReportGap
22
+ */
23
+ documentation_url?: string;
24
+ /**
25
+ * 1 to 20 sanitized evidence descriptions or links, each at most 8000 characters.
26
+ * @type {Array<string>}
27
+ * @memberof SfvbDocsGapReportGap
28
+ */
29
+ evidence?: Array<string>;
30
+ /**
31
+ * What the documentation should say, at most 8000 characters.
32
+ * @type {string}
33
+ * @memberof SfvbDocsGapReportGap
34
+ */
35
+ expected?: string;
36
+ /**
37
+ * The confirmed behavior, or the guidance that is missing, at most 8000 characters.
38
+ * @type {string}
39
+ * @memberof SfvbDocsGapReportGap
40
+ */
41
+ observed?: string;
42
+ /**
43
+ * A short description of the gap, at most 200 characters.
44
+ * @type {string}
45
+ * @memberof SfvbDocsGapReportGap
46
+ */
47
+ title?: string;
48
+ }
49
+ /**
50
+ * Check if a given object implements the SfvbDocsGapReportGap interface.
51
+ */
52
+ export declare function instanceOfSfvbDocsGapReportGap(value: object): boolean;
53
+ export declare function SfvbDocsGapReportGapFromJSON(json: any): SfvbDocsGapReportGap;
54
+ export declare function SfvbDocsGapReportGapFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbDocsGapReportGap;
55
+ export declare function SfvbDocsGapReportGapToJSON(value?: SfvbDocsGapReportGap | null): any;
@@ -0,0 +1,58 @@
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.SfvbDocsGapReportGapToJSON = exports.SfvbDocsGapReportGapFromJSONTyped = exports.SfvbDocsGapReportGapFromJSON = exports.instanceOfSfvbDocsGapReportGap = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * Check if a given object implements the SfvbDocsGapReportGap interface.
20
+ */
21
+ function instanceOfSfvbDocsGapReportGap(value) {
22
+ var isInstance = true;
23
+ return isInstance;
24
+ }
25
+ exports.instanceOfSfvbDocsGapReportGap = instanceOfSfvbDocsGapReportGap;
26
+ function SfvbDocsGapReportGapFromJSON(json) {
27
+ return SfvbDocsGapReportGapFromJSONTyped(json, false);
28
+ }
29
+ exports.SfvbDocsGapReportGapFromJSON = SfvbDocsGapReportGapFromJSON;
30
+ function SfvbDocsGapReportGapFromJSONTyped(json, ignoreDiscriminator) {
31
+ if ((json === undefined) || (json === null)) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'documentation_url': !(0, runtime_1.exists)(json, 'documentation_url') ? undefined : json['documentation_url'],
36
+ 'evidence': !(0, runtime_1.exists)(json, 'evidence') ? undefined : json['evidence'],
37
+ 'expected': !(0, runtime_1.exists)(json, 'expected') ? undefined : json['expected'],
38
+ 'observed': !(0, runtime_1.exists)(json, 'observed') ? undefined : json['observed'],
39
+ 'title': !(0, runtime_1.exists)(json, 'title') ? undefined : json['title'],
40
+ };
41
+ }
42
+ exports.SfvbDocsGapReportGapFromJSONTyped = SfvbDocsGapReportGapFromJSONTyped;
43
+ function SfvbDocsGapReportGapToJSON(value) {
44
+ if (value === undefined) {
45
+ return undefined;
46
+ }
47
+ if (value === null) {
48
+ return null;
49
+ }
50
+ return {
51
+ 'documentation_url': value.documentation_url,
52
+ 'evidence': value.evidence,
53
+ 'expected': value.expected,
54
+ 'observed': value.observed,
55
+ 'title': value.title,
56
+ };
57
+ }
58
+ exports.SfvbDocsGapReportGapToJSON = SfvbDocsGapReportGapToJSON;
@@ -106,7 +106,7 @@ export interface SfvbTrackingProvider {
106
106
  */
107
107
  name?: string;
108
108
  /**
109
- * Anything the write left for a person to do, such as disconnecting an OAuth connection in the admin.
109
+ * Anything for a person to know or do, such as a field the provider needs before it sends anything, or an OAuth connection to disconnect in the admin after a write.
110
110
  * @type {Array<string>}
111
111
  * @memberof SfvbTrackingProvider
112
112
  */
@@ -1058,6 +1058,9 @@ export * from './SfvbContainerRevertRequest';
1058
1058
  export * from './SfvbContainerVersion';
1059
1059
  export * from './SfvbContainerVersionsResponse';
1060
1060
  export * from './SfvbContainerWriteRequest';
1061
+ export * from './SfvbDocsGap';
1062
+ export * from './SfvbDocsGapReport';
1063
+ export * from './SfvbDocsGapReportGap';
1061
1064
  export * from './SfvbElement';
1062
1065
  export * from './SfvbElementSchemaResponse';
1063
1066
  export * from './SfvbElementsResponse';
@@ -1076,6 +1076,9 @@ __exportStar(require("./SfvbContainerRevertRequest"), exports);
1076
1076
  __exportStar(require("./SfvbContainerVersion"), exports);
1077
1077
  __exportStar(require("./SfvbContainerVersionsResponse"), exports);
1078
1078
  __exportStar(require("./SfvbContainerWriteRequest"), exports);
1079
+ __exportStar(require("./SfvbDocsGap"), exports);
1080
+ __exportStar(require("./SfvbDocsGapReport"), exports);
1081
+ __exportStar(require("./SfvbDocsGapReportGap"), exports);
1079
1082
  __exportStar(require("./SfvbElement"), exports);
1080
1083
  __exportStar(require("./SfvbElementSchemaResponse"), exports);
1081
1084
  __exportStar(require("./SfvbElementsResponse"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "4.1.235",
3
+ "version": "4.1.237",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "repository": {
@@ -189,6 +189,12 @@ import {
189
189
  SfvbContainerWriteRequest,
190
190
  SfvbContainerWriteRequestFromJSON,
191
191
  SfvbContainerWriteRequestToJSON,
192
+ SfvbDocsGap,
193
+ SfvbDocsGapFromJSON,
194
+ SfvbDocsGapToJSON,
195
+ SfvbDocsGapReport,
196
+ SfvbDocsGapReportFromJSON,
197
+ SfvbDocsGapReportToJSON,
192
198
  SfvbElementSchemaResponse,
193
199
  SfvbElementSchemaResponseFromJSON,
194
200
  SfvbElementSchemaResponseToJSON,
@@ -1231,6 +1237,10 @@ export interface GetSfvbContainerVersionRequest {
1231
1237
  containerName?: string;
1232
1238
  }
1233
1239
 
1240
+ export interface GetSfvbDocsGapRequest {
1241
+ reportId: string;
1242
+ }
1243
+
1234
1244
  export interface GetSfvbElementRequest {
1235
1245
  elementType: string;
1236
1246
  }
@@ -1632,6 +1642,11 @@ export interface InsertSfvbCommsTwilioAccountRequest {
1632
1642
  twilioAccount: SfvbCommsTwilioAccount;
1633
1643
  }
1634
1644
 
1645
+ export interface InsertSfvbDocsGapRequest {
1646
+ docsGapReport: SfvbDocsGapReport;
1647
+ storefrontOid?: number;
1648
+ }
1649
+
1635
1650
  export interface InsertSfvbPageRequest {
1636
1651
  storefrontOid: number;
1637
1652
  pageCreateRequest: SfvbPageCreateRequest;
@@ -4020,6 +4035,22 @@ export interface SfvbApiInterface {
4020
4035
  */
4021
4036
  getSfvbContainerVersion(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersion>;
4022
4037
 
4038
+ /**
4039
+ * The status of a report this account sent. received until UltraCart staff look at it, then accepted, declined or fixed. The report text and UltraCart\'s internal notes are not returned. A report from another account answers 404.
4040
+ * @summary Get a documentation-gap report\'s status
4041
+ * @param {string} reportId
4042
+ * @param {*} [options] Override http request option.
4043
+ * @throws {RequiredError}
4044
+ * @memberof SfvbApiInterface
4045
+ */
4046
+ getSfvbDocsGapRaw(requestParameters: GetSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbDocsGap>>;
4047
+
4048
+ /**
4049
+ * The status of a report this account sent. received until UltraCart staff look at it, then accepted, declined or fixed. The report text and UltraCart\'s internal notes are not returned. A report from another account answers 404.
4050
+ * Get a documentation-gap report\'s status
4051
+ */
4052
+ getSfvbDocsGap(requestParameters: GetSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbDocsGap>;
4053
+
4023
4054
  /**
4024
4055
  * schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings. Either is omitted when none has been published for the element, which is still a 200. The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here.
4025
4056
  * @summary Configuration schema and field card for one element type
@@ -5380,6 +5411,23 @@ export interface SfvbApiInterface {
5380
5411
  */
5381
5412
  insertSfvbCommsTwilioAccount(requestParameters: InsertSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTwilioAccountResponse>;
5382
5413
 
5414
+ /**
5415
+ * Reports a place where docs.ultracart.com is wrong or missing, for UltraCart staff to triage. Send the report uc-storefront docs gap review checked, in this form. Optionally name the storefront the agent was working on with storefront_oid. The server checks the report again and refuses one that holds a credential or an email address (an ultracart.com address may stay), without keeping it. Sending the same report again returns the earlier report_id with 200 and duplicate true rather than a second report. An account may send 20 reports a UTC day. Requires a token that resolves to a user, so use the device authorization flow.
5416
+ * @summary Send UltraCart a documentation-gap report
5417
+ * @param {SfvbDocsGapReport} docsGapReport The report
5418
+ * @param {number} [storefrontOid] The storefront the agent was working on, recorded for context. Leave it out when none applies.
5419
+ * @param {*} [options] Override http request option.
5420
+ * @throws {RequiredError}
5421
+ * @memberof SfvbApiInterface
5422
+ */
5423
+ insertSfvbDocsGapRaw(requestParameters: InsertSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbDocsGap>>;
5424
+
5425
+ /**
5426
+ * Reports a place where docs.ultracart.com is wrong or missing, for UltraCart staff to triage. Send the report uc-storefront docs gap review checked, in this form. Optionally name the storefront the agent was working on with storefront_oid. The server checks the report again and refuses one that holds a credential or an email address (an ultracart.com address may stay), without keeping it. Sending the same report again returns the earlier report_id with 200 and duplicate true rather than a second report. An account may send 20 reports a UTC day. Requires a token that resolves to a user, so use the device authorization flow.
5427
+ * Send UltraCart a documentation-gap report
5428
+ */
5429
+ insertSfvbDocsGap(requestParameters: InsertSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbDocsGap>;
5430
+
5383
5431
  /**
5384
5432
  * Creates the page and its folder, the way the store admin\'s add page does. The parent page must already exist, and the last part of the path may only contain letters, digits, hyphens and underscores - it is refused, not cleaned. A path that already has a page is refused with a 409 and the code sfvb.page_exists. Without a group_template the page inherits its parent\'s templates, or catalog_group.vm directly under the root. Set attributes and images afterwards with the page attribute and image endpoints, and push the body to the page folder. Always needs sfvb_publish, because the page is live as soon as it exists. Deleting, moving and renaming pages stay in the store admin.
5385
5433
  * @summary Create a page
@@ -12065,6 +12113,47 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
12065
12113
  return await response.value();
12066
12114
  }
12067
12115
 
12116
+ /**
12117
+ * The status of a report this account sent. received until UltraCart staff look at it, then accepted, declined or fixed. The report text and UltraCart\'s internal notes are not returned. A report from another account answers 404.
12118
+ * Get a documentation-gap report\'s status
12119
+ */
12120
+ async getSfvbDocsGapRaw(requestParameters: GetSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbDocsGap>> {
12121
+ if (requestParameters.reportId === null || requestParameters.reportId === undefined) {
12122
+ throw new runtime.RequiredError('reportId','Required parameter requestParameters.reportId was null or undefined when calling getSfvbDocsGap.');
12123
+ }
12124
+
12125
+ const queryParameters: any = {};
12126
+
12127
+ const headerParameters: runtime.HTTPHeaders = {};
12128
+
12129
+ if (this.configuration && this.configuration.accessToken) {
12130
+ // oauth required
12131
+ headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", []);
12132
+ }
12133
+
12134
+ if (this.configuration && this.configuration.apiKey) {
12135
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
12136
+ }
12137
+
12138
+ const response = await this.request({
12139
+ path: `/sfvb/docs/gaps/{report_id}`.replace(`{${"report_id"}}`, encodeURIComponent(String(requestParameters.reportId))),
12140
+ method: 'GET',
12141
+ headers: headerParameters,
12142
+ query: queryParameters,
12143
+ }, initOverrides);
12144
+
12145
+ return new runtime.JSONApiResponse(response, (jsonValue) => SfvbDocsGapFromJSON(jsonValue));
12146
+ }
12147
+
12148
+ /**
12149
+ * The status of a report this account sent. received until UltraCart staff look at it, then accepted, declined or fixed. The report text and UltraCart\'s internal notes are not returned. A report from another account answers 404.
12150
+ * Get a documentation-gap report\'s status
12151
+ */
12152
+ async getSfvbDocsGap(requestParameters: GetSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbDocsGap> {
12153
+ const response = await this.getSfvbDocsGapRaw(requestParameters, initOverrides);
12154
+ return await response.value();
12155
+ }
12156
+
12068
12157
  /**
12069
12158
  * schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings. Either is omitted when none has been published for the element, which is still a 200. The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here.
12070
12159
  * Configuration schema and field card for one element type
@@ -15745,6 +15834,54 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
15745
15834
  return await response.value();
15746
15835
  }
15747
15836
 
15837
+ /**
15838
+ * Reports a place where docs.ultracart.com is wrong or missing, for UltraCart staff to triage. Send the report uc-storefront docs gap review checked, in this form. Optionally name the storefront the agent was working on with storefront_oid. The server checks the report again and refuses one that holds a credential or an email address (an ultracart.com address may stay), without keeping it. Sending the same report again returns the earlier report_id with 200 and duplicate true rather than a second report. An account may send 20 reports a UTC day. Requires a token that resolves to a user, so use the device authorization flow.
15839
+ * Send UltraCart a documentation-gap report
15840
+ */
15841
+ async insertSfvbDocsGapRaw(requestParameters: InsertSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbDocsGap>> {
15842
+ if (requestParameters.docsGapReport === null || requestParameters.docsGapReport === undefined) {
15843
+ throw new runtime.RequiredError('docsGapReport','Required parameter requestParameters.docsGapReport was null or undefined when calling insertSfvbDocsGap.');
15844
+ }
15845
+
15846
+ const queryParameters: any = {};
15847
+
15848
+ if (requestParameters.storefrontOid !== undefined) {
15849
+ queryParameters['storefront_oid'] = requestParameters.storefrontOid;
15850
+ }
15851
+
15852
+ const headerParameters: runtime.HTTPHeaders = {};
15853
+
15854
+ headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
15855
+
15856
+ if (this.configuration && this.configuration.accessToken) {
15857
+ // oauth required
15858
+ headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", []);
15859
+ }
15860
+
15861
+ if (this.configuration && this.configuration.apiKey) {
15862
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
15863
+ }
15864
+
15865
+ const response = await this.request({
15866
+ path: `/sfvb/docs/gaps`,
15867
+ method: 'POST',
15868
+ headers: headerParameters,
15869
+ query: queryParameters,
15870
+ body: SfvbDocsGapReportToJSON(requestParameters.docsGapReport),
15871
+ }, initOverrides);
15872
+
15873
+ return new runtime.JSONApiResponse(response, (jsonValue) => SfvbDocsGapFromJSON(jsonValue));
15874
+ }
15875
+
15876
+ /**
15877
+ * Reports a place where docs.ultracart.com is wrong or missing, for UltraCart staff to triage. Send the report uc-storefront docs gap review checked, in this form. Optionally name the storefront the agent was working on with storefront_oid. The server checks the report again and refuses one that holds a credential or an email address (an ultracart.com address may stay), without keeping it. Sending the same report again returns the earlier report_id with 200 and duplicate true rather than a second report. An account may send 20 reports a UTC day. Requires a token that resolves to a user, so use the device authorization flow.
15878
+ * Send UltraCart a documentation-gap report
15879
+ */
15880
+ async insertSfvbDocsGap(requestParameters: InsertSfvbDocsGapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbDocsGap> {
15881
+ const response = await this.insertSfvbDocsGapRaw(requestParameters, initOverrides);
15882
+ return await response.value();
15883
+ }
15884
+
15748
15885
  /**
15749
15886
  * Creates the page and its folder, the way the store admin\'s add page does. The parent page must already exist, and the last part of the path may only contain letters, digits, hyphens and underscores - it is refused, not cleaned. A path that already has a page is refused with a 409 and the code sfvb.page_exists. Without a group_template the page inherits its parent\'s templates, or catalog_group.vm directly under the root. Set attributes and images afterwards with the page attribute and image endpoints, and push the body to the page folder. Always needs sfvb_publish, because the page is live as soon as it exists. Deleting, moving and renaming pages stay in the store admin.
15750
15887
  * Create a page
@@ -244,6 +244,7 @@ export const SfvbApprovalCreateRequestActionEnum = {
244
244
  SmartAttributionChange: 'smart_attribution.change',
245
245
  SmartAttributionDelete: 'smart_attribution.delete',
246
246
  TrackingProviderChange: 'tracking_provider.change',
247
+ TrackingProviderClear: 'tracking_provider.clear',
247
248
  TrackingHtmlPut: 'tracking_html.put',
248
249
  AffiliateNetworkChange: 'affiliate_network.change',
249
250
  AffiliateNetworkDelete: 'affiliate_network.delete',
@@ -0,0 +1,119 @@
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 SfvbDocsGap
20
+ */
21
+ export interface SfvbDocsGap {
22
+ /**
23
+ * On submit, true when this account had already sent the same report. The earlier report_id is returned and nothing new is kept.
24
+ * @type {boolean}
25
+ * @memberof SfvbDocsGap
26
+ */
27
+ duplicate?: boolean;
28
+ /**
29
+ * When UltraCart received the report.
30
+ * @type {string}
31
+ * @memberof SfvbDocsGap
32
+ */
33
+ received_at?: string;
34
+ /**
35
+ * The report's id. Quote it to UltraCart, or look the report up with GET docs/gaps/{report_id}.
36
+ * @type {string}
37
+ * @memberof SfvbDocsGap
38
+ */
39
+ report_id?: string;
40
+ /**
41
+ * received until UltraCart staff look at it, then accepted, declined or fixed.
42
+ * @type {string}
43
+ * @memberof SfvbDocsGap
44
+ */
45
+ status?: SfvbDocsGapStatusEnum;
46
+ /**
47
+ * When the status last changed. Absent while the report is received.
48
+ * @type {string}
49
+ * @memberof SfvbDocsGap
50
+ */
51
+ status_at?: string;
52
+ /**
53
+ * The storefront named when the report was sent, if one was.
54
+ * @type {number}
55
+ * @memberof SfvbDocsGap
56
+ */
57
+ storefront_oid?: number;
58
+ }
59
+
60
+
61
+
62
+ /**
63
+ * @export
64
+ */
65
+ export const SfvbDocsGapStatusEnum = {
66
+ Received: 'received',
67
+ Accepted: 'accepted',
68
+ Declined: 'declined',
69
+ Fixed: 'fixed'
70
+ } as const;
71
+ export type SfvbDocsGapStatusEnum = typeof SfvbDocsGapStatusEnum[keyof typeof SfvbDocsGapStatusEnum];
72
+
73
+
74
+ /**
75
+ * Check if a given object implements the SfvbDocsGap interface.
76
+ */
77
+ export function instanceOfSfvbDocsGap(value: object): boolean {
78
+ let isInstance = true;
79
+
80
+ return isInstance;
81
+ }
82
+
83
+ export function SfvbDocsGapFromJSON(json: any): SfvbDocsGap {
84
+ return SfvbDocsGapFromJSONTyped(json, false);
85
+ }
86
+
87
+ export function SfvbDocsGapFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbDocsGap {
88
+ if ((json === undefined) || (json === null)) {
89
+ return json;
90
+ }
91
+ return {
92
+
93
+ 'duplicate': !exists(json, 'duplicate') ? undefined : json['duplicate'],
94
+ 'received_at': !exists(json, 'received_at') ? undefined : json['received_at'],
95
+ 'report_id': !exists(json, 'report_id') ? undefined : json['report_id'],
96
+ 'status': !exists(json, 'status') ? undefined : json['status'],
97
+ 'status_at': !exists(json, 'status_at') ? undefined : json['status_at'],
98
+ 'storefront_oid': !exists(json, 'storefront_oid') ? undefined : json['storefront_oid'],
99
+ };
100
+ }
101
+
102
+ export function SfvbDocsGapToJSON(value?: SfvbDocsGap | null): any {
103
+ if (value === undefined) {
104
+ return undefined;
105
+ }
106
+ if (value === null) {
107
+ return null;
108
+ }
109
+ return {
110
+
111
+ 'duplicate': value.duplicate,
112
+ 'received_at': value.received_at,
113
+ 'report_id': value.report_id,
114
+ 'status': value.status,
115
+ 'status_at': value.status_at,
116
+ 'storefront_oid': value.storefront_oid,
117
+ };
118
+ }
119
+
@@ -0,0 +1,98 @@
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
+ SfvbDocsGapReportGap,
18
+ SfvbDocsGapReportGapFromJSON,
19
+ SfvbDocsGapReportGapFromJSONTyped,
20
+ SfvbDocsGapReportGapToJSON,
21
+ } from './SfvbDocsGapReportGap';
22
+
23
+ /**
24
+ *
25
+ * @export
26
+ * @interface SfvbDocsGapReport
27
+ */
28
+ export interface SfvbDocsGapReport {
29
+ /**
30
+ * When the report was captured, as a UTC ISO-8601 timestamp. Not more than a day ahead of the server's clock.
31
+ * @type {string}
32
+ * @memberof SfvbDocsGapReport
33
+ */
34
+ created_at?: string;
35
+ /**
36
+ * Always 1.
37
+ * @type {number}
38
+ * @memberof SfvbDocsGapReport
39
+ */
40
+ format_version?: number;
41
+ /**
42
+ *
43
+ * @type {SfvbDocsGapReportGap}
44
+ * @memberof SfvbDocsGapReport
45
+ */
46
+ gap?: SfvbDocsGapReportGap;
47
+ /**
48
+ * Always documentation-gap.
49
+ * @type {string}
50
+ * @memberof SfvbDocsGapReport
51
+ */
52
+ kind?: string;
53
+ }
54
+
55
+
56
+
57
+ /**
58
+ * Check if a given object implements the SfvbDocsGapReport interface.
59
+ */
60
+ export function instanceOfSfvbDocsGapReport(value: object): boolean {
61
+ let isInstance = true;
62
+
63
+ return isInstance;
64
+ }
65
+
66
+ export function SfvbDocsGapReportFromJSON(json: any): SfvbDocsGapReport {
67
+ return SfvbDocsGapReportFromJSONTyped(json, false);
68
+ }
69
+
70
+ export function SfvbDocsGapReportFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbDocsGapReport {
71
+ if ((json === undefined) || (json === null)) {
72
+ return json;
73
+ }
74
+ return {
75
+
76
+ 'created_at': !exists(json, 'created_at') ? undefined : json['created_at'],
77
+ 'format_version': !exists(json, 'format_version') ? undefined : json['format_version'],
78
+ 'gap': !exists(json, 'gap') ? undefined : SfvbDocsGapReportGapFromJSON(json['gap']),
79
+ 'kind': !exists(json, 'kind') ? undefined : json['kind'],
80
+ };
81
+ }
82
+
83
+ export function SfvbDocsGapReportToJSON(value?: SfvbDocsGapReport | null): any {
84
+ if (value === undefined) {
85
+ return undefined;
86
+ }
87
+ if (value === null) {
88
+ return null;
89
+ }
90
+ return {
91
+
92
+ 'created_at': value.created_at,
93
+ 'format_version': value.format_version,
94
+ 'gap': SfvbDocsGapReportGapToJSON(value.gap),
95
+ 'kind': value.kind,
96
+ };
97
+ }
98
+
@@ -0,0 +1,99 @@
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 SfvbDocsGapReportGap
20
+ */
21
+ export interface SfvbDocsGapReportGap {
22
+ /**
23
+ * The nearest documentation page, an absolute http or https URL of at most 2000 characters. Leave it out when no page exists.
24
+ * @type {string}
25
+ * @memberof SfvbDocsGapReportGap
26
+ */
27
+ documentation_url?: string;
28
+ /**
29
+ * 1 to 20 sanitized evidence descriptions or links, each at most 8000 characters.
30
+ * @type {Array<string>}
31
+ * @memberof SfvbDocsGapReportGap
32
+ */
33
+ evidence?: Array<string>;
34
+ /**
35
+ * What the documentation should say, at most 8000 characters.
36
+ * @type {string}
37
+ * @memberof SfvbDocsGapReportGap
38
+ */
39
+ expected?: string;
40
+ /**
41
+ * The confirmed behavior, or the guidance that is missing, at most 8000 characters.
42
+ * @type {string}
43
+ * @memberof SfvbDocsGapReportGap
44
+ */
45
+ observed?: string;
46
+ /**
47
+ * A short description of the gap, at most 200 characters.
48
+ * @type {string}
49
+ * @memberof SfvbDocsGapReportGap
50
+ */
51
+ title?: string;
52
+ }
53
+
54
+
55
+
56
+ /**
57
+ * Check if a given object implements the SfvbDocsGapReportGap interface.
58
+ */
59
+ export function instanceOfSfvbDocsGapReportGap(value: object): boolean {
60
+ let isInstance = true;
61
+
62
+ return isInstance;
63
+ }
64
+
65
+ export function SfvbDocsGapReportGapFromJSON(json: any): SfvbDocsGapReportGap {
66
+ return SfvbDocsGapReportGapFromJSONTyped(json, false);
67
+ }
68
+
69
+ export function SfvbDocsGapReportGapFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbDocsGapReportGap {
70
+ if ((json === undefined) || (json === null)) {
71
+ return json;
72
+ }
73
+ return {
74
+
75
+ 'documentation_url': !exists(json, 'documentation_url') ? undefined : json['documentation_url'],
76
+ 'evidence': !exists(json, 'evidence') ? undefined : json['evidence'],
77
+ 'expected': !exists(json, 'expected') ? undefined : json['expected'],
78
+ 'observed': !exists(json, 'observed') ? undefined : json['observed'],
79
+ 'title': !exists(json, 'title') ? undefined : json['title'],
80
+ };
81
+ }
82
+
83
+ export function SfvbDocsGapReportGapToJSON(value?: SfvbDocsGapReportGap | null): any {
84
+ if (value === undefined) {
85
+ return undefined;
86
+ }
87
+ if (value === null) {
88
+ return null;
89
+ }
90
+ return {
91
+
92
+ 'documentation_url': value.documentation_url,
93
+ 'evidence': value.evidence,
94
+ 'expected': value.expected,
95
+ 'observed': value.observed,
96
+ 'title': value.title,
97
+ };
98
+ }
99
+
@@ -141,7 +141,7 @@ export interface SfvbTrackingProvider {
141
141
  */
142
142
  name?: string;
143
143
  /**
144
- * Anything the write left for a person to do, such as disconnecting an OAuth connection in the admin.
144
+ * Anything for a person to know or do, such as a field the provider needs before it sends anything, or an OAuth connection to disconnect in the admin after a write.
145
145
  * @type {Array<string>}
146
146
  * @memberof SfvbTrackingProvider
147
147
  */
@@ -1060,6 +1060,9 @@ export * from './SfvbContainerRevertRequest';
1060
1060
  export * from './SfvbContainerVersion';
1061
1061
  export * from './SfvbContainerVersionsResponse';
1062
1062
  export * from './SfvbContainerWriteRequest';
1063
+ export * from './SfvbDocsGap';
1064
+ export * from './SfvbDocsGapReport';
1065
+ export * from './SfvbDocsGapReportGap';
1063
1066
  export * from './SfvbElement';
1064
1067
  export * from './SfvbElementSchemaResponse';
1065
1068
  export * from './SfvbElementsResponse';