ultracart_rest_api_v2_typescript 4.1.195 → 4.1.197

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.
@@ -995,6 +995,10 @@ src/models/ScreenRecordingUserAgentOS.ts
995
995
  src/models/ScreenRecordingUserProperty.ts
996
996
  src/models/ScreenshotsResponse.ts
997
997
  src/models/SelfConfig.ts
998
+ src/models/SfvbApproval.ts
999
+ src/models/SfvbApprovalCreateRequest.ts
1000
+ src/models/SfvbApprovalParams.ts
1001
+ src/models/SfvbApprovalsResponse.ts
998
1002
  src/models/SfvbBlogPost.ts
999
1003
  src/models/SfvbBlogPostDetail.ts
1000
1004
  src/models/SfvbBlogPostImage.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.195
2
+ ## ultracart_rest_api_v2_typescript@4.1.197
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.195 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.197 --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.197 | 10/08/2026 | sfvb internal testing |
88
+ | 4.1.196 | 10/08/2026 | sfvb internal testing |
87
89
  | 4.1.195 | 10/07/2026 | sfvb internal testing |
88
90
  | 4.1.194 | 10/07/2026 | sfvb internal testing |
89
91
  | 4.1.193 | 10/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 { SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaRequest, 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, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
13
+ import { SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaRequest, 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, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
14
14
  export interface AddSfvbPageBlogPostsRequest {
15
15
  storefrontOid: number;
16
16
  path: string;
@@ -53,14 +53,19 @@ export interface CreateSfvbPreviewAccessRequest {
53
53
  export interface CreateSfvbPreviewSessionRequest {
54
54
  storefrontOid: number;
55
55
  }
56
+ export interface DeleteSfvbApprovalRequest {
57
+ approvalId: string;
58
+ }
56
59
  export interface DeleteSfvbBlogPostRequest {
57
60
  storefrontOid: number;
58
61
  blogPostOid: number;
62
+ approvalId?: string;
59
63
  }
60
64
  export interface DeleteSfvbFileRequest {
61
65
  storefrontOid: number;
62
66
  ifMatch: string;
63
67
  path?: string;
68
+ approvalId?: string;
64
69
  }
65
70
  export interface DeleteSfvbItemAttributeRequest {
66
71
  storefrontOid: number;
@@ -159,6 +164,9 @@ export interface FavoriteSfvbLibraryEntryRequest {
159
164
  storefrontOid: number;
160
165
  libraryOid: number;
161
166
  }
167
+ export interface GetSfvbApprovalRequest {
168
+ approvalId: string;
169
+ }
162
170
  export interface GetSfvbBlogPostRequest {
163
171
  storefrontOid: number;
164
172
  blogPostOid: number;
@@ -358,6 +366,10 @@ export interface ImportSfvbRedirectsRequest {
358
366
  storefrontOid: number;
359
367
  redirectImportRequest: SfvbRedirectImportRequest;
360
368
  }
369
+ export interface InsertSfvbApprovalRequest {
370
+ approvalRequest: SfvbApprovalCreateRequest;
371
+ storefrontOid?: number;
372
+ }
361
373
  export interface InsertSfvbBlogPostRequest {
362
374
  storefrontOid: number;
363
375
  blogPostRequest: SfvbBlogPostRequest;
@@ -881,11 +893,26 @@ export interface SfvbApiInterface {
881
893
  * Create a preview session
882
894
  */
883
895
  createSfvbPreviewSession(requestParameters: CreateSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
896
+ /**
897
+ * Withdraws a request nobody has decided yet, which frees one of the five pending slots a sign-in has. A request that was already decided, used or expired cannot be cancelled.
898
+ * @summary Cancel a pending approval request
899
+ * @param {string} approvalId
900
+ * @param {*} [options] Override http request option.
901
+ * @throws {RequiredError}
902
+ * @memberof SfvbApiInterface
903
+ */
904
+ deleteSfvbApprovalRaw(requestParameters: DeleteSfvbApprovalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
905
+ /**
906
+ * Withdraws a request nobody has decided yet, which frees one of the five pending slots a sign-in has. A request that was already decided, used or expired cannot be cancelled.
907
+ * Cancel a pending approval request
908
+ */
909
+ deleteSfvbApproval(requestParameters: DeleteSfvbApprovalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
884
910
  /**
885
911
  * Takes the post off every page and deletes it. There is no undo. A post that is not a draft needs sfvb_publish.
886
912
  * @summary Delete a blog post
887
913
  * @param {number} storefrontOid
888
914
  * @param {number} blogPostOid
915
+ * @param {string} [approvalId] The approval_id of an approved blog_post.delete request for this post. See POST /sfvb/approvals.
889
916
  * @param {*} [options] Override http request option.
890
917
  * @throws {RequiredError}
891
918
  * @memberof SfvbApiInterface
@@ -902,6 +929,7 @@ export interface SfvbApiInterface {
902
929
  * @param {number} storefrontOid
903
930
  * @param {string} ifMatch Content hash of the file being deleted. Required; 428 when absent, 412 when stale.
904
931
  * @param {string} [path]
932
+ * @param {string} [approvalId] The approval_id of an approved file.delete request for this exact path. See POST /sfvb/approvals.
905
933
  * @param {*} [options] Override http request option.
906
934
  * @throws {RequiredError}
907
935
  * @memberof SfvbApiInterface
@@ -1229,6 +1257,33 @@ export interface SfvbApiInterface {
1229
1257
  * Favorite a library entry
1230
1258
  */
1231
1259
  favoriteSfvbLibraryEntry(requestParameters: FavoriteSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
1260
+ /**
1261
+ * Poll this every interval_seconds after requesting an approval. status is pending until the person decides, then approved or denied, and expired if nobody acts in 10 minutes. Once the gated call has used it, status is used and outcome says whether the call succeeded. Used with no outcome means the result is unknown, so check the target - never repeat the call.
1262
+ * @summary Read one approval request
1263
+ * @param {string} approvalId
1264
+ * @param {*} [options] Override http request option.
1265
+ * @throws {RequiredError}
1266
+ * @memberof SfvbApiInterface
1267
+ */
1268
+ getSfvbApprovalRaw(requestParameters: GetSfvbApprovalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbApproval>>;
1269
+ /**
1270
+ * Poll this every interval_seconds after requesting an approval. status is pending until the person decides, then approved or denied, and expired if nobody acts in 10 minutes. Once the gated call has used it, status is used and outcome says whether the call succeeded. Used with no outcome means the result is unknown, so check the target - never repeat the call.
1271
+ * Read one approval request
1272
+ */
1273
+ getSfvbApproval(requestParameters: GetSfvbApprovalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbApproval>;
1274
+ /**
1275
+ * Requests made with this sign-in in the last 24 hours, newest first, at most 50, with their status and outcome. Use it to find a request whose id was lost, or to see what an earlier run did.
1276
+ * @summary List this sign-in\'s approval requests
1277
+ * @param {*} [options] Override http request option.
1278
+ * @throws {RequiredError}
1279
+ * @memberof SfvbApiInterface
1280
+ */
1281
+ getSfvbApprovalsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbApprovalsResponse>>;
1282
+ /**
1283
+ * Requests made with this sign-in in the last 24 hours, newest first, at most 50, with their status and outcome. Use it to find a request whose id was lost, or to see what an earlier run did.
1284
+ * List this sign-in\'s approval requests
1285
+ */
1286
+ getSfvbApprovals(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbApprovalsResponse>;
1232
1287
  /**
1233
1288
  * The whole post - body, excerpt, tags, images and where it is shown. An image\'s url is the address to use for it in the body.
1234
1289
  * @summary Read a blog post
@@ -1936,6 +1991,21 @@ export interface SfvbApiInterface {
1936
1991
  * Apply a reviewed redirect import
1937
1992
  */
1938
1993
  importSfvbRedirects(requestParameters: ImportSfvbRedirectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRedirectImportResponse>;
1994
+ /**
1995
+ * Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow.
1996
+ * @summary Request a human approval
1997
+ * @param {SfvbApprovalCreateRequest} approvalRequest The request
1998
+ * @param {number} [storefrontOid] The storefront the action runs on. Required for storefront actions, left out for account-wide ones.
1999
+ * @param {*} [options] Override http request option.
2000
+ * @throws {RequiredError}
2001
+ * @memberof SfvbApiInterface
2002
+ */
2003
+ insertSfvbApprovalRaw(requestParameters: InsertSfvbApprovalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
2004
+ /**
2005
+ * Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow.
2006
+ * Request a human approval
2007
+ */
2008
+ insertSfvbApproval(requestParameters: InsertSfvbApprovalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
1939
2009
  /**
1940
2010
  * title and url_part are required. The post is a draft unless visibility says otherwise, and anything but a draft needs sfvb_publish. The body and excerpt are refused with sfvb.unsafe_html if they could run script, and a url_part another post uses is refused with a 409 and sfvb.blog_post_exists. Assign the post to a page with pages/blog_posts/add, or let the page\'s selectors choose it.
1941
2011
  * @summary Create a blog post
@@ -3178,6 +3248,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
3178
3248
  * Create a preview session
3179
3249
  */
3180
3250
  createSfvbPreviewSession(requestParameters: CreateSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
3251
+ /**
3252
+ * Withdraws a request nobody has decided yet, which frees one of the five pending slots a sign-in has. A request that was already decided, used or expired cannot be cancelled.
3253
+ * Cancel a pending approval request
3254
+ */
3255
+ deleteSfvbApprovalRaw(requestParameters: DeleteSfvbApprovalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
3256
+ /**
3257
+ * Withdraws a request nobody has decided yet, which frees one of the five pending slots a sign-in has. A request that was already decided, used or expired cannot be cancelled.
3258
+ * Cancel a pending approval request
3259
+ */
3260
+ deleteSfvbApproval(requestParameters: DeleteSfvbApprovalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
3181
3261
  /**
3182
3262
  * Takes the post off every page and deletes it. There is no undo. A post that is not a draft needs sfvb_publish.
3183
3263
  * Delete a blog post
@@ -3398,6 +3478,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
3398
3478
  * Favorite a library entry
3399
3479
  */
3400
3480
  favoriteSfvbLibraryEntry(requestParameters: FavoriteSfvbLibraryEntryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
3481
+ /**
3482
+ * Poll this every interval_seconds after requesting an approval. status is pending until the person decides, then approved or denied, and expired if nobody acts in 10 minutes. Once the gated call has used it, status is used and outcome says whether the call succeeded. Used with no outcome means the result is unknown, so check the target - never repeat the call.
3483
+ * Read one approval request
3484
+ */
3485
+ getSfvbApprovalRaw(requestParameters: GetSfvbApprovalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbApproval>>;
3486
+ /**
3487
+ * Poll this every interval_seconds after requesting an approval. status is pending until the person decides, then approved or denied, and expired if nobody acts in 10 minutes. Once the gated call has used it, status is used and outcome says whether the call succeeded. Used with no outcome means the result is unknown, so check the target - never repeat the call.
3488
+ * Read one approval request
3489
+ */
3490
+ getSfvbApproval(requestParameters: GetSfvbApprovalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbApproval>;
3491
+ /**
3492
+ * Requests made with this sign-in in the last 24 hours, newest first, at most 50, with their status and outcome. Use it to find a request whose id was lost, or to see what an earlier run did.
3493
+ * List this sign-in\'s approval requests
3494
+ */
3495
+ getSfvbApprovalsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbApprovalsResponse>>;
3496
+ /**
3497
+ * Requests made with this sign-in in the last 24 hours, newest first, at most 50, with their status and outcome. Use it to find a request whose id was lost, or to see what an earlier run did.
3498
+ * List this sign-in\'s approval requests
3499
+ */
3500
+ getSfvbApprovals(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbApprovalsResponse>;
3401
3501
  /**
3402
3502
  * The whole post - body, excerpt, tags, images and where it is shown. An image\'s url is the address to use for it in the body.
3403
3503
  * Read a blog post
@@ -3854,6 +3954,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
3854
3954
  * Apply a reviewed redirect import
3855
3955
  */
3856
3956
  importSfvbRedirects(requestParameters: ImportSfvbRedirectsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRedirectImportResponse>;
3957
+ /**
3958
+ * Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow.
3959
+ * Request a human approval
3960
+ */
3961
+ insertSfvbApprovalRaw(requestParameters: InsertSfvbApprovalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
3962
+ /**
3963
+ * Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow.
3964
+ * Request a human approval
3965
+ */
3966
+ insertSfvbApproval(requestParameters: InsertSfvbApprovalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
3857
3967
  /**
3858
3968
  * title and url_part are required. The post is a draft unless visibility says otherwise, and anything but a draft needs sfvb_publish. The body and excerpt are refused with sfvb.unsafe_html if they could run script, and a url_part another post uses is refused with a 409 and sfvb.blog_post_exists. Assign the post to a page with pages/blog_posts/add, or let the page\'s selectors choose it.
3859
3969
  * Create a blog post
@@ -721,6 +721,63 @@ var SfvbApi = /** @class */ (function (_super) {
721
721
  });
722
722
  });
723
723
  };
724
+ /**
725
+ * Withdraws a request nobody has decided yet, which frees one of the five pending slots a sign-in has. A request that was already decided, used or expired cannot be cancelled.
726
+ * Cancel a pending approval request
727
+ */
728
+ SfvbApi.prototype.deleteSfvbApprovalRaw = function (requestParameters, initOverrides) {
729
+ return __awaiter(this, void 0, void 0, function () {
730
+ var queryParameters, headerParameters, _a, _b, response;
731
+ return __generator(this, function (_c) {
732
+ switch (_c.label) {
733
+ case 0:
734
+ if (requestParameters.approvalId === null || requestParameters.approvalId === undefined) {
735
+ throw new runtime.RequiredError('approvalId', 'Required parameter requestParameters.approvalId was null or undefined when calling deleteSfvbApproval.');
736
+ }
737
+ queryParameters = {};
738
+ headerParameters = {};
739
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
740
+ // oauth required
741
+ _a = headerParameters;
742
+ _b = "Authorization";
743
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
744
+ case 1:
745
+ // oauth required
746
+ _a[_b] = _c.sent();
747
+ _c.label = 2;
748
+ case 2:
749
+ if (this.configuration && this.configuration.apiKey) {
750
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
751
+ }
752
+ return [4 /*yield*/, this.request({
753
+ path: "/sfvb/approvals/{approval_id}".replace("{".concat("approval_id", "}"), encodeURIComponent(String(requestParameters.approvalId))),
754
+ method: 'DELETE',
755
+ headers: headerParameters,
756
+ query: queryParameters,
757
+ }, initOverrides)];
758
+ case 3:
759
+ response = _c.sent();
760
+ return [2 /*return*/, new runtime.VoidApiResponse(response)];
761
+ }
762
+ });
763
+ });
764
+ };
765
+ /**
766
+ * Withdraws a request nobody has decided yet, which frees one of the five pending slots a sign-in has. A request that was already decided, used or expired cannot be cancelled.
767
+ * Cancel a pending approval request
768
+ */
769
+ SfvbApi.prototype.deleteSfvbApproval = function (requestParameters, initOverrides) {
770
+ return __awaiter(this, void 0, void 0, function () {
771
+ return __generator(this, function (_a) {
772
+ switch (_a.label) {
773
+ case 0: return [4 /*yield*/, this.deleteSfvbApprovalRaw(requestParameters, initOverrides)];
774
+ case 1:
775
+ _a.sent();
776
+ return [2 /*return*/];
777
+ }
778
+ });
779
+ });
780
+ };
724
781
  /**
725
782
  * Takes the post off every page and deletes it. There is no undo. A post that is not a draft needs sfvb_publish.
726
783
  * Delete a blog post
@@ -739,6 +796,9 @@ var SfvbApi = /** @class */ (function (_super) {
739
796
  }
740
797
  queryParameters = {};
741
798
  headerParameters = {};
799
+ if (requestParameters.approvalId !== undefined && requestParameters.approvalId !== null) {
800
+ headerParameters['Approval-Id'] = String(requestParameters.approvalId);
801
+ }
742
802
  if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
743
803
  // oauth required
744
804
  _a = headerParameters;
@@ -805,6 +865,9 @@ var SfvbApi = /** @class */ (function (_super) {
805
865
  if (requestParameters.ifMatch !== undefined && requestParameters.ifMatch !== null) {
806
866
  headerParameters['If-Match'] = String(requestParameters.ifMatch);
807
867
  }
868
+ if (requestParameters.approvalId !== undefined && requestParameters.approvalId !== null) {
869
+ headerParameters['Approval-Id'] = String(requestParameters.approvalId);
870
+ }
808
871
  if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
809
872
  // oauth required
810
873
  _a = headerParameters;
@@ -2156,6 +2219,121 @@ var SfvbApi = /** @class */ (function (_super) {
2156
2219
  });
2157
2220
  });
2158
2221
  };
2222
+ /**
2223
+ * Poll this every interval_seconds after requesting an approval. status is pending until the person decides, then approved or denied, and expired if nobody acts in 10 minutes. Once the gated call has used it, status is used and outcome says whether the call succeeded. Used with no outcome means the result is unknown, so check the target - never repeat the call.
2224
+ * Read one approval request
2225
+ */
2226
+ SfvbApi.prototype.getSfvbApprovalRaw = function (requestParameters, initOverrides) {
2227
+ return __awaiter(this, void 0, void 0, function () {
2228
+ var queryParameters, headerParameters, _a, _b, response;
2229
+ return __generator(this, function (_c) {
2230
+ switch (_c.label) {
2231
+ case 0:
2232
+ if (requestParameters.approvalId === null || requestParameters.approvalId === undefined) {
2233
+ throw new runtime.RequiredError('approvalId', 'Required parameter requestParameters.approvalId was null or undefined when calling getSfvbApproval.');
2234
+ }
2235
+ queryParameters = {};
2236
+ headerParameters = {};
2237
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
2238
+ // oauth required
2239
+ _a = headerParameters;
2240
+ _b = "Authorization";
2241
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
2242
+ case 1:
2243
+ // oauth required
2244
+ _a[_b] = _c.sent();
2245
+ _c.label = 2;
2246
+ case 2:
2247
+ if (this.configuration && this.configuration.apiKey) {
2248
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
2249
+ }
2250
+ return [4 /*yield*/, this.request({
2251
+ path: "/sfvb/approvals/{approval_id}".replace("{".concat("approval_id", "}"), encodeURIComponent(String(requestParameters.approvalId))),
2252
+ method: 'GET',
2253
+ headers: headerParameters,
2254
+ query: queryParameters,
2255
+ }, initOverrides)];
2256
+ case 3:
2257
+ response = _c.sent();
2258
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbApprovalFromJSON)(jsonValue); })];
2259
+ }
2260
+ });
2261
+ });
2262
+ };
2263
+ /**
2264
+ * Poll this every interval_seconds after requesting an approval. status is pending until the person decides, then approved or denied, and expired if nobody acts in 10 minutes. Once the gated call has used it, status is used and outcome says whether the call succeeded. Used with no outcome means the result is unknown, so check the target - never repeat the call.
2265
+ * Read one approval request
2266
+ */
2267
+ SfvbApi.prototype.getSfvbApproval = function (requestParameters, initOverrides) {
2268
+ return __awaiter(this, void 0, void 0, function () {
2269
+ var response;
2270
+ return __generator(this, function (_a) {
2271
+ switch (_a.label) {
2272
+ case 0: return [4 /*yield*/, this.getSfvbApprovalRaw(requestParameters, initOverrides)];
2273
+ case 1:
2274
+ response = _a.sent();
2275
+ return [4 /*yield*/, response.value()];
2276
+ case 2: return [2 /*return*/, _a.sent()];
2277
+ }
2278
+ });
2279
+ });
2280
+ };
2281
+ /**
2282
+ * Requests made with this sign-in in the last 24 hours, newest first, at most 50, with their status and outcome. Use it to find a request whose id was lost, or to see what an earlier run did.
2283
+ * List this sign-in\'s approval requests
2284
+ */
2285
+ SfvbApi.prototype.getSfvbApprovalsRaw = function (initOverrides) {
2286
+ return __awaiter(this, void 0, void 0, function () {
2287
+ var queryParameters, headerParameters, _a, _b, response;
2288
+ return __generator(this, function (_c) {
2289
+ switch (_c.label) {
2290
+ case 0:
2291
+ queryParameters = {};
2292
+ headerParameters = {};
2293
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
2294
+ // oauth required
2295
+ _a = headerParameters;
2296
+ _b = "Authorization";
2297
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
2298
+ case 1:
2299
+ // oauth required
2300
+ _a[_b] = _c.sent();
2301
+ _c.label = 2;
2302
+ case 2:
2303
+ if (this.configuration && this.configuration.apiKey) {
2304
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
2305
+ }
2306
+ return [4 /*yield*/, this.request({
2307
+ path: "/sfvb/approvals",
2308
+ method: 'GET',
2309
+ headers: headerParameters,
2310
+ query: queryParameters,
2311
+ }, initOverrides)];
2312
+ case 3:
2313
+ response = _c.sent();
2314
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbApprovalsResponseFromJSON)(jsonValue); })];
2315
+ }
2316
+ });
2317
+ });
2318
+ };
2319
+ /**
2320
+ * Requests made with this sign-in in the last 24 hours, newest first, at most 50, with their status and outcome. Use it to find a request whose id was lost, or to see what an earlier run did.
2321
+ * List this sign-in\'s approval requests
2322
+ */
2323
+ SfvbApi.prototype.getSfvbApprovals = function (initOverrides) {
2324
+ return __awaiter(this, void 0, void 0, function () {
2325
+ var response;
2326
+ return __generator(this, function (_a) {
2327
+ switch (_a.label) {
2328
+ case 0: return [4 /*yield*/, this.getSfvbApprovalsRaw(initOverrides)];
2329
+ case 1:
2330
+ response = _a.sent();
2331
+ return [4 /*yield*/, response.value()];
2332
+ case 2: return [2 /*return*/, _a.sent()];
2333
+ }
2334
+ });
2335
+ });
2336
+ };
2159
2337
  /**
2160
2338
  * The whole post - body, excerpt, tags, images and where it is shown. An image\'s url is the address to use for it in the body.
2161
2339
  * Read a blog post
@@ -5077,6 +5255,68 @@ var SfvbApi = /** @class */ (function (_super) {
5077
5255
  });
5078
5256
  });
5079
5257
  };
5258
+ /**
5259
+ * Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow.
5260
+ * Request a human approval
5261
+ */
5262
+ SfvbApi.prototype.insertSfvbApprovalRaw = function (requestParameters, initOverrides) {
5263
+ return __awaiter(this, void 0, void 0, function () {
5264
+ var queryParameters, headerParameters, _a, _b, response;
5265
+ return __generator(this, function (_c) {
5266
+ switch (_c.label) {
5267
+ case 0:
5268
+ if (requestParameters.approvalRequest === null || requestParameters.approvalRequest === undefined) {
5269
+ throw new runtime.RequiredError('approvalRequest', 'Required parameter requestParameters.approvalRequest was null or undefined when calling insertSfvbApproval.');
5270
+ }
5271
+ queryParameters = {};
5272
+ if (requestParameters.storefrontOid !== undefined) {
5273
+ queryParameters['storefront_oid'] = requestParameters.storefrontOid;
5274
+ }
5275
+ headerParameters = {};
5276
+ headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
5277
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
5278
+ // oauth required
5279
+ _a = headerParameters;
5280
+ _b = "Authorization";
5281
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
5282
+ case 1:
5283
+ // oauth required
5284
+ _a[_b] = _c.sent();
5285
+ _c.label = 2;
5286
+ case 2:
5287
+ if (this.configuration && this.configuration.apiKey) {
5288
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
5289
+ }
5290
+ return [4 /*yield*/, this.request({
5291
+ path: "/sfvb/approvals",
5292
+ method: 'POST',
5293
+ headers: headerParameters,
5294
+ query: queryParameters,
5295
+ body: (0, models_1.SfvbApprovalCreateRequestToJSON)(requestParameters.approvalRequest),
5296
+ }, initOverrides)];
5297
+ case 3:
5298
+ response = _c.sent();
5299
+ return [2 /*return*/, new runtime.VoidApiResponse(response)];
5300
+ }
5301
+ });
5302
+ });
5303
+ };
5304
+ /**
5305
+ * Asks the person who signed in the CLI to approve one gated action on one exact target. Name the storefront with the storefront_oid query parameter. The target is checked the way the action will check it, so nobody is asked to approve a call that would fail. Show the person approval_url and user_code, poll GET approvals/{approval_id} every interval_seconds, and once it is approved repeat the gated call with the approval_id in the Approval-Id header. Asking again for the same thing returns the pending request (200) rather than a new one (201). A request lapses after 10 minutes. Requires a token that resolves to a user, so use the device authorization flow.
5306
+ * Request a human approval
5307
+ */
5308
+ SfvbApi.prototype.insertSfvbApproval = function (requestParameters, initOverrides) {
5309
+ return __awaiter(this, void 0, void 0, function () {
5310
+ return __generator(this, function (_a) {
5311
+ switch (_a.label) {
5312
+ case 0: return [4 /*yield*/, this.insertSfvbApprovalRaw(requestParameters, initOverrides)];
5313
+ case 1:
5314
+ _a.sent();
5315
+ return [2 /*return*/];
5316
+ }
5317
+ });
5318
+ });
5319
+ };
5080
5320
  /**
5081
5321
  * title and url_part are required. The post is a draft unless visibility says otherwise, and anything but a draft needs sfvb_publish. The body and excerpt are refused with sfvb.unsafe_html if they could run script, and a url_part another post uses is refused with a 409 and sfvb.blog_post_exists. Assign the post to a page with pages/blog_posts/add, or let the page\'s selectors choose it.
5082
5322
  * Create a blog post