ultracart_rest_api_v2_typescript 4.0.66-RC → 4.0.68-RC

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.
@@ -384,6 +384,11 @@ src/models/ExperimentResponse.ts
384
384
  src/models/ExperimentVariation.ts
385
385
  src/models/ExperimentVariationStat.ts
386
386
  src/models/ExperimentsResponse.ts
387
+ src/models/FileManagerDirectory.ts
388
+ src/models/FileManagerFile.ts
389
+ src/models/FileManagerPage.ts
390
+ src/models/FileManagerUploadRequest.ts
391
+ src/models/FileManagerUploadUrlResponse.ts
387
392
  src/models/FulfillmentInventory.ts
388
393
  src/models/FulfillmentShipment.ts
389
394
  src/models/GeoPoint.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## ultracart_rest_api_v2_typescript@4.0.66-RC
1
+ ## ultracart_rest_api_v2_typescript@4.0.68-RC
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install ultracart_rest_api_v2_typescript@4.0.66-RC --save
39
+ npm install ultracart_rest_api_v2_typescript@4.0.68-RC --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 4.0.68-RC | 09/29/2022 | storefront methods for file manager ui |
58
+ | 4.0.67-RC | 09/27/2022 | added digital library call for unassociated content |
57
59
  | 4.0.66-RC | 09/22/2022 | digital item mgmt testing |
58
60
  | 4.0.65-RC | 09/22/2022 | testing digital file mgmt calls |
59
61
  | 4.0.64-RC | 09/19/2022 | conversations pagination |
@@ -28,6 +28,9 @@ export interface GetDigitalItemsRequest {
28
28
  expand?: string;
29
29
  placeholders?: boolean;
30
30
  }
31
+ export interface GetDigitalItemsByExternalIdRequest {
32
+ externalId: string;
33
+ }
31
34
  export interface GetItemRequest {
32
35
  merchantItemOid: number;
33
36
  expand?: string;
@@ -51,6 +54,14 @@ export interface GetItemsRequest {
51
54
  export interface GetPricingTiersRequest {
52
55
  expand?: string;
53
56
  }
57
+ export interface GetUnassociatedDigitalItemsRequest {
58
+ limit?: number;
59
+ offset?: number;
60
+ since?: string;
61
+ sort?: string;
62
+ expand?: string;
63
+ placeholders?: boolean;
64
+ }
54
65
  export interface InsertDigitalItemRequest {
55
66
  digitalItem: ItemDigitalItem;
56
67
  }
@@ -146,6 +157,20 @@ export interface ItemApiInterface {
146
157
  * Retrieve digital items from the digital library which are digital files that may be attached to normal items
147
158
  */
148
159
  getDigitalItems(requestParameters: GetDigitalItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemsResponse>;
160
+ /**
161
+ * Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.
162
+ * @summary Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
163
+ * @param {string} externalId The external id to match against.
164
+ * @param {*} [options] Override http request option.
165
+ * @throws {RequiredError}
166
+ * @memberof ItemApiInterface
167
+ */
168
+ getDigitalItemsByExternalIdRaw(requestParameters: GetDigitalItemsByExternalIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemDigitalItemsResponse>>;
169
+ /**
170
+ * Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.
171
+ * Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
172
+ */
173
+ getDigitalItemsByExternalId(requestParameters: GetDigitalItemsByExternalIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemsResponse>;
149
174
  /**
150
175
  * Retrieves a single item using the specified item oid.
151
176
  * @summary Retrieve an item
@@ -213,6 +238,25 @@ export interface ItemApiInterface {
213
238
  * Retrieve pricing tiers
214
239
  */
215
240
  getPricingTiers(requestParameters: GetPricingTiersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PricingTiersResponse>;
241
+ /**
242
+ * Retrieves a group of digital items (file information) from the account that are not yet associated with any actual items. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
243
+ * @summary Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
244
+ * @param {number} [limit] The maximum number of records to return on this one API call. (Default 100, Max 2000)
245
+ * @param {number} [offset] Pagination of the record set. Offset is a zero based index.
246
+ * @param {string} [since] Fetch items that have been created/modified since this date/time.
247
+ * @param {string} [sort] The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
248
+ * @param {string} [expand] The object expansion to perform on the result. See documentation for examples
249
+ * @param {boolean} [placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
250
+ * @param {*} [options] Override http request option.
251
+ * @throws {RequiredError}
252
+ * @memberof ItemApiInterface
253
+ */
254
+ getUnassociatedDigitalItemsRaw(requestParameters: GetUnassociatedDigitalItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemDigitalItemsResponse>>;
255
+ /**
256
+ * Retrieves a group of digital items (file information) from the account that are not yet associated with any actual items. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
257
+ * Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
258
+ */
259
+ getUnassociatedDigitalItems(requestParameters: GetUnassociatedDigitalItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemsResponse>;
216
260
  /**
217
261
  * Create a file within the digital library. This does not create an item, but makes this digital file available and selectable as part (or all) of an item.
218
262
  * @summary Create a file within the digital library
@@ -351,6 +395,16 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
351
395
  * Retrieve digital items from the digital library which are digital files that may be attached to normal items
352
396
  */
353
397
  getDigitalItems(requestParameters?: GetDigitalItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemsResponse>;
398
+ /**
399
+ * Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.
400
+ * Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
401
+ */
402
+ getDigitalItemsByExternalIdRaw(requestParameters: GetDigitalItemsByExternalIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemDigitalItemsResponse>>;
403
+ /**
404
+ * Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.
405
+ * Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
406
+ */
407
+ getDigitalItemsByExternalId(requestParameters: GetDigitalItemsByExternalIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemsResponse>;
354
408
  /**
355
409
  * Retrieves a single item using the specified item oid.
356
410
  * Retrieve an item
@@ -391,6 +445,16 @@ export declare class ItemApi extends runtime.BaseAPI implements ItemApiInterface
391
445
  * Retrieve pricing tiers
392
446
  */
393
447
  getPricingTiers(requestParameters?: GetPricingTiersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PricingTiersResponse>;
448
+ /**
449
+ * Retrieves a group of digital items (file information) from the account that are not yet associated with any actual items. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
450
+ * Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
451
+ */
452
+ getUnassociatedDigitalItemsRaw(requestParameters: GetUnassociatedDigitalItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemDigitalItemsResponse>>;
453
+ /**
454
+ * Retrieves a group of digital items (file information) from the account that are not yet associated with any actual items. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
455
+ * Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
456
+ */
457
+ getUnassociatedDigitalItems(requestParameters?: GetUnassociatedDigitalItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemDigitalItemsResponse>;
394
458
  /**
395
459
  * Create a file within the digital library. This does not create an item, but makes this digital file available and selectable as part (or all) of an item.
396
460
  * Create a file within the digital library
@@ -323,6 +323,65 @@ var ItemApi = /** @class */ (function (_super) {
323
323
  });
324
324
  });
325
325
  };
326
+ /**
327
+ * Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.
328
+ * Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
329
+ */
330
+ ItemApi.prototype.getDigitalItemsByExternalIdRaw = function (requestParameters, initOverrides) {
331
+ return __awaiter(this, void 0, void 0, function () {
332
+ var queryParameters, headerParameters, _a, _b, response;
333
+ return __generator(this, function (_c) {
334
+ switch (_c.label) {
335
+ case 0:
336
+ if (requestParameters.externalId === null || requestParameters.externalId === undefined) {
337
+ throw new runtime.RequiredError('externalId', 'Required parameter requestParameters.externalId was null or undefined when calling getDigitalItemsByExternalId.');
338
+ }
339
+ queryParameters = {};
340
+ headerParameters = {};
341
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
342
+ // oauth required
343
+ _a = headerParameters;
344
+ _b = "Authorization";
345
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["item_read"])];
346
+ case 1:
347
+ // oauth required
348
+ _a[_b] = _c.sent();
349
+ _c.label = 2;
350
+ case 2:
351
+ if (this.configuration && this.configuration.apiKey) {
352
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
353
+ }
354
+ return [4 /*yield*/, this.request({
355
+ path: "/item/digital_library/by_external/{external_id}".replace("{".concat("external_id", "}"), encodeURIComponent(String(requestParameters.externalId))),
356
+ method: 'GET',
357
+ headers: headerParameters,
358
+ query: queryParameters,
359
+ }, initOverrides)];
360
+ case 3:
361
+ response = _c.sent();
362
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ItemDigitalItemsResponseFromJSON)(jsonValue); })];
363
+ }
364
+ });
365
+ });
366
+ };
367
+ /**
368
+ * Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.
369
+ * Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
370
+ */
371
+ ItemApi.prototype.getDigitalItemsByExternalId = function (requestParameters, initOverrides) {
372
+ return __awaiter(this, void 0, void 0, function () {
373
+ var response;
374
+ return __generator(this, function (_a) {
375
+ switch (_a.label) {
376
+ case 0: return [4 /*yield*/, this.getDigitalItemsByExternalIdRaw(requestParameters, initOverrides)];
377
+ case 1:
378
+ response = _a.sent();
379
+ return [4 /*yield*/, response.value()];
380
+ case 2: return [2 /*return*/, _a.sent()];
381
+ }
382
+ });
383
+ });
384
+ };
326
385
  /**
327
386
  * Retrieves a single item using the specified item oid.
328
387
  * Retrieve an item
@@ -594,6 +653,81 @@ var ItemApi = /** @class */ (function (_super) {
594
653
  });
595
654
  });
596
655
  };
656
+ /**
657
+ * Retrieves a group of digital items (file information) from the account that are not yet associated with any actual items. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
658
+ * Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
659
+ */
660
+ ItemApi.prototype.getUnassociatedDigitalItemsRaw = function (requestParameters, initOverrides) {
661
+ return __awaiter(this, void 0, void 0, function () {
662
+ var queryParameters, headerParameters, _a, _b, response;
663
+ return __generator(this, function (_c) {
664
+ switch (_c.label) {
665
+ case 0:
666
+ queryParameters = {};
667
+ if (requestParameters.limit !== undefined) {
668
+ queryParameters['_limit'] = requestParameters.limit;
669
+ }
670
+ if (requestParameters.offset !== undefined) {
671
+ queryParameters['_offset'] = requestParameters.offset;
672
+ }
673
+ if (requestParameters.since !== undefined) {
674
+ queryParameters['_since'] = requestParameters.since;
675
+ }
676
+ if (requestParameters.sort !== undefined) {
677
+ queryParameters['_sort'] = requestParameters.sort;
678
+ }
679
+ if (requestParameters.expand !== undefined) {
680
+ queryParameters['_expand'] = requestParameters.expand;
681
+ }
682
+ if (requestParameters.placeholders !== undefined) {
683
+ queryParameters['_placeholders'] = requestParameters.placeholders;
684
+ }
685
+ headerParameters = {};
686
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
687
+ // oauth required
688
+ _a = headerParameters;
689
+ _b = "Authorization";
690
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["item_read"])];
691
+ case 1:
692
+ // oauth required
693
+ _a[_b] = _c.sent();
694
+ _c.label = 2;
695
+ case 2:
696
+ if (this.configuration && this.configuration.apiKey) {
697
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
698
+ }
699
+ return [4 /*yield*/, this.request({
700
+ path: "/item/digital_library/unassociated",
701
+ method: 'GET',
702
+ headers: headerParameters,
703
+ query: queryParameters,
704
+ }, initOverrides)];
705
+ case 3:
706
+ response = _c.sent();
707
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ItemDigitalItemsResponseFromJSON)(jsonValue); })];
708
+ }
709
+ });
710
+ });
711
+ };
712
+ /**
713
+ * Retrieves a group of digital items (file information) from the account that are not yet associated with any actual items. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
714
+ * Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
715
+ */
716
+ ItemApi.prototype.getUnassociatedDigitalItems = function (requestParameters, initOverrides) {
717
+ if (requestParameters === void 0) { requestParameters = {}; }
718
+ return __awaiter(this, void 0, void 0, function () {
719
+ var response;
720
+ return __generator(this, function (_a) {
721
+ switch (_a.label) {
722
+ case 0: return [4 /*yield*/, this.getUnassociatedDigitalItemsRaw(requestParameters, initOverrides)];
723
+ case 1:
724
+ response = _a.sent();
725
+ return [4 /*yield*/, response.value()];
726
+ case 2: return [2 /*return*/, _a.sent()];
727
+ }
728
+ });
729
+ });
730
+ };
597
731
  /**
598
732
  * Create a file within the digital library. This does not create an item, but makes this digital file available and selectable as part (or all) of an item.
599
733
  * Create a file within the digital library
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { AddLibraryItemRequest, ApplyLibraryItemRequest, ApplyLibraryItemResponse, BaseResponse, CountriesResponse, EmailBaseTemplateListResponse, EmailCampaign, EmailCampaignFolder, EmailCampaignFolderResponse, EmailCampaignFoldersResponse, EmailCampaignResponse, EmailCampaignsResponse, EmailClicksResponse, EmailCommseq, EmailCommseqEmail, EmailCommseqEmailResponse, EmailCommseqEmailSendTestRequest, EmailCommseqEmailSendTestResponse, EmailCommseqEmailsRequest, EmailCommseqEmailsResponse, EmailCommseqPostcard, EmailCommseqPostcardResponse, EmailCommseqPostcardSendTestRequest, EmailCommseqPostcardSendTestResponse, EmailCommseqPostcardsRequest, EmailCommseqPostcardsResponse, EmailCommseqResponse, EmailCommseqSequenceTestRequest, EmailCommseqSequenceTestResponse, EmailCommseqStatResponse, EmailCommseqStepLogsResponse, EmailCommseqWebhookSendTestRequest, EmailCommseqWebhookSendTestResponse, EmailCommseqsResponse, EmailCustomer, EmailCustomerEditorUrlResponse, EmailCustomersResponse, EmailDashboardActivityResponse, EmailDashboardStatsResponse, EmailDomain, EmailEditorTokenResponse, EmailFlow, EmailFlowBackPopulateRequest, EmailFlowBackPopulateResponse, EmailFlowFolder, EmailFlowFolderResponse, EmailFlowFoldersResponse, EmailFlowResponse, EmailFlowsResponse, EmailGlobalSettings, EmailGlobalSettingsResponse, EmailGlobalUnsubscribeRequest, EmailGlobalUnsubscribeResponse, EmailHistogramPropertyNamesResponse, EmailHistogramPropertyValuesResponse, EmailList, EmailListArchiveResponse, EmailListCustomersResponse, EmailListResponse, EmailListSegmentFolder, EmailListSegmentFolderResponse, EmailListSegmentFoldersResponse, EmailListSubscribeResponse, EmailListsResponse, EmailOrdersResponse, EmailPerformanceResponse, EmailPlan, EmailPlanResponse, EmailPostcardTrackingResponse, EmailSegment, EmailSegmentArchiveResponse, EmailSegmentCustomersResponse, EmailSegmentDownloadPrepareResponse, EmailSegmentResponse, EmailSegmentsResponse, EmailSendingDomainResponse, EmailSendingDomainsResponse, EmailSettings, EmailSettingsResponse, EmailStatPostcardSummaryRequest, EmailStatPostcardSummaryResponse, EmailStatSummaryRequest, EmailStatSummaryResponse, EmailStepStatRequest, EmailStepStatResponse, EmailStepWaitingRequest, EmailStepWaitingResponse, EmailTemplate, EmailTemplatesResponse, EmailThirdPartyListImportRequest, EmailThirdPartyProvidersResponse, EmailWebhookEditorValuesResponse, Experiment, ExperimentResponse, ExperimentsResponse, GeocodeRequest, GeocodeResponse, LibraryFilterValuesResponse, LibraryItem, LibraryItemQuery, LibraryItemResponse, LibraryItemsResponse, LookupRequest, LookupResponse, PricingTiersResponse, PublishLibraryItemRequest, RulerValidationRequest, RulerValidationResponse, ScreenRecordingHeatmapIndexRequest, ScreenRecordingHeatmapIndexResponse, ScreenRecordingHeatmapRequest, ScreenRecordingHeatmapReset, ScreenRecordingHeatmapResponse, ScreenRecordingMerchantNotesRequest, ScreenRecordingPageViewDataResponse, ScreenRecordingQueryRequest, ScreenRecordingQueryResponse, ScreenRecordingResponse, ScreenRecordingSegment, ScreenRecordingSegmentResponse, ScreenRecordingSegmentsResponse, ScreenRecordingSettings, ScreenRecordingSettingsResponse, ScreenRecordingTagsRequest, ScreenRecordingTagsResponse, ScreenshotsResponse, StoreFrontsResponse, ThumbnailParametersRequest, ThumbnailParametersResponse, TransactionEmail, TransactionEmailListResponse, TransactionEmailResponse, Twilio, TwilioResponse, TwiliosResponse } from '../models';
13
+ import { AddLibraryItemRequest, ApplyLibraryItemRequest, ApplyLibraryItemResponse, BaseResponse, CountriesResponse, EmailBaseTemplateListResponse, EmailCampaign, EmailCampaignFolder, EmailCampaignFolderResponse, EmailCampaignFoldersResponse, EmailCampaignResponse, EmailCampaignsResponse, EmailClicksResponse, EmailCommseq, EmailCommseqEmail, EmailCommseqEmailResponse, EmailCommseqEmailSendTestRequest, EmailCommseqEmailSendTestResponse, EmailCommseqEmailsRequest, EmailCommseqEmailsResponse, EmailCommseqPostcard, EmailCommseqPostcardResponse, EmailCommseqPostcardSendTestRequest, EmailCommseqPostcardSendTestResponse, EmailCommseqPostcardsRequest, EmailCommseqPostcardsResponse, EmailCommseqResponse, EmailCommseqSequenceTestRequest, EmailCommseqSequenceTestResponse, EmailCommseqStatResponse, EmailCommseqStepLogsResponse, EmailCommseqWebhookSendTestRequest, EmailCommseqWebhookSendTestResponse, EmailCommseqsResponse, EmailCustomer, EmailCustomerEditorUrlResponse, EmailCustomersResponse, EmailDashboardActivityResponse, EmailDashboardStatsResponse, EmailDomain, EmailEditorTokenResponse, EmailFlow, EmailFlowBackPopulateRequest, EmailFlowBackPopulateResponse, EmailFlowFolder, EmailFlowFolderResponse, EmailFlowFoldersResponse, EmailFlowResponse, EmailFlowsResponse, EmailGlobalSettings, EmailGlobalSettingsResponse, EmailGlobalUnsubscribeRequest, EmailGlobalUnsubscribeResponse, EmailHistogramPropertyNamesResponse, EmailHistogramPropertyValuesResponse, EmailList, EmailListArchiveResponse, EmailListCustomersResponse, EmailListResponse, EmailListSegmentFolder, EmailListSegmentFolderResponse, EmailListSegmentFoldersResponse, EmailListSubscribeResponse, EmailListsResponse, EmailOrdersResponse, EmailPerformanceResponse, EmailPlan, EmailPlanResponse, EmailPostcardTrackingResponse, EmailSegment, EmailSegmentArchiveResponse, EmailSegmentCustomersResponse, EmailSegmentDownloadPrepareResponse, EmailSegmentResponse, EmailSegmentsResponse, EmailSendingDomainResponse, EmailSendingDomainsResponse, EmailSettings, EmailSettingsResponse, EmailStatPostcardSummaryRequest, EmailStatPostcardSummaryResponse, EmailStatSummaryRequest, EmailStatSummaryResponse, EmailStepStatRequest, EmailStepStatResponse, EmailStepWaitingRequest, EmailStepWaitingResponse, EmailTemplate, EmailTemplatesResponse, EmailThirdPartyListImportRequest, EmailThirdPartyProvidersResponse, EmailWebhookEditorValuesResponse, Experiment, ExperimentResponse, ExperimentsResponse, FileManagerPage, FileManagerUploadRequest, FileManagerUploadUrlResponse, GeocodeRequest, GeocodeResponse, LibraryFilterValuesResponse, LibraryItem, LibraryItemQuery, LibraryItemResponse, LibraryItemsResponse, LookupRequest, LookupResponse, PricingTiersResponse, PublishLibraryItemRequest, RulerValidationRequest, RulerValidationResponse, ScreenRecordingHeatmapIndexRequest, ScreenRecordingHeatmapIndexResponse, ScreenRecordingHeatmapRequest, ScreenRecordingHeatmapReset, ScreenRecordingHeatmapResponse, ScreenRecordingMerchantNotesRequest, ScreenRecordingPageViewDataResponse, ScreenRecordingQueryRequest, ScreenRecordingQueryResponse, ScreenRecordingResponse, ScreenRecordingSegment, ScreenRecordingSegmentResponse, ScreenRecordingSegmentsResponse, ScreenRecordingSettings, ScreenRecordingSettingsResponse, ScreenRecordingTagsRequest, ScreenRecordingTagsResponse, ScreenshotsResponse, StoreFrontsResponse, ThumbnailParametersRequest, ThumbnailParametersResponse, TransactionEmail, TransactionEmailListResponse, TransactionEmailResponse, Twilio, TwilioResponse, TwiliosResponse } from '../models';
14
14
  export interface AddToLibraryRequest {
15
15
  addLibraryRequest: AddLibraryItemRequest;
16
16
  }
@@ -51,6 +51,11 @@ export interface CreateEmailSendingDomainRequest {
51
51
  export interface CreateEmailSendingDomain2Request {
52
52
  emailDomain: EmailDomain;
53
53
  }
54
+ export interface CreateFsDirectoryRequest {
55
+ id: number;
56
+ name?: string;
57
+ parentStorefrontFsDirectoryOid?: number;
58
+ }
54
59
  export interface CreateTwilioAccountRequest {
55
60
  twilio: Twilio;
56
61
  }
@@ -90,6 +95,11 @@ export interface DeleteExperimentRequest {
90
95
  storefrontOid: number;
91
96
  storefrontExperimentOid: number;
92
97
  }
98
+ export interface DeleteFsFileRequest {
99
+ id: number;
100
+ parentStorefrontFsDirectoryOid?: number;
101
+ storefrontFsFileOid?: number;
102
+ }
93
103
  export interface DeleteHeatmapRequest {
94
104
  storefrontOid: number;
95
105
  query: ScreenRecordingHeatmapReset;
@@ -342,6 +352,12 @@ export interface GetEmailThirdPartyProvidersRequest {
342
352
  export interface GetExperimentsRequest {
343
353
  storefrontOid: number;
344
354
  }
355
+ export interface GetFsDirectoryRequest {
356
+ id: number;
357
+ path?: string;
358
+ storefrontFsDirectoryOid?: number;
359
+ storefrontThemeOid?: number;
360
+ }
345
361
  export interface GetHeatmapRequest {
346
362
  storefrontOid: number;
347
363
  query: ScreenRecordingHeatmapRequest;
@@ -425,6 +441,10 @@ export interface GetTransactionEmailScreenshotsRequest {
425
441
  export interface GetTwilioAccountRequest {
426
442
  espTwilioUuid: string;
427
443
  }
444
+ export interface GetUploadFsFileUrlRequest {
445
+ id: number;
446
+ extension: string;
447
+ }
428
448
  export interface GlobalUnsubscribeRequest {
429
449
  storefrontOid: number;
430
450
  unsubscribe: EmailGlobalUnsubscribeRequest;
@@ -682,6 +702,10 @@ export interface UpdateTwilioAccountRequest {
682
702
  espTwilioUuid: string;
683
703
  twilio: Twilio;
684
704
  }
705
+ export interface UploadFsFileRequest {
706
+ id: number;
707
+ uploadRequest: FileManagerUploadRequest;
708
+ }
685
709
  export interface ValidateRulerRequest {
686
710
  rulerValidateRequest: RulerValidationRequest;
687
711
  }
@@ -832,6 +856,21 @@ export interface StorefrontApiInterface {
832
856
  * Create email sending domain for various providers
833
857
  */
834
858
  createEmailSendingDomain2(requestParameters: CreateEmailSendingDomain2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailSendingDomainResponse>;
859
+ /**
860
+ *
861
+ * @summary Create file manager directory
862
+ * @param {number} id
863
+ * @param {string} [name]
864
+ * @param {number} [parentStorefrontFsDirectoryOid]
865
+ * @param {*} [options] Override http request option.
866
+ * @throws {RequiredError}
867
+ * @memberof StorefrontApiInterface
868
+ */
869
+ createFsDirectoryRaw(requestParameters: CreateFsDirectoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileManagerPage>>;
870
+ /**
871
+ * Create file manager directory
872
+ */
873
+ createFsDirectory(requestParameters: CreateFsDirectoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileManagerPage>;
835
874
  /**
836
875
  *
837
876
  * @summary Create Twilio account
@@ -971,6 +1010,21 @@ export interface StorefrontApiInterface {
971
1010
  * Delete experiment
972
1011
  */
973
1012
  deleteExperiment(requestParameters: DeleteExperimentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
1013
+ /**
1014
+ *
1015
+ * @summary Delete file manager directory
1016
+ * @param {number} id
1017
+ * @param {number} [parentStorefrontFsDirectoryOid]
1018
+ * @param {number} [storefrontFsFileOid]
1019
+ * @param {*} [options] Override http request option.
1020
+ * @throws {RequiredError}
1021
+ * @memberof StorefrontApiInterface
1022
+ */
1023
+ deleteFsFileRaw(requestParameters: DeleteFsFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileManagerPage>>;
1024
+ /**
1025
+ * Delete file manager directory
1026
+ */
1027
+ deleteFsFile(requestParameters: DeleteFsFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileManagerPage>;
974
1028
  /**
975
1029
  * Delete screen recording heatmap
976
1030
  * @summary Delete screen recording heatmap
@@ -1891,6 +1945,22 @@ export interface StorefrontApiInterface {
1891
1945
  * Get experiments
1892
1946
  */
1893
1947
  getExperiments(requestParameters: GetExperimentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExperimentsResponse>;
1948
+ /**
1949
+ *
1950
+ * @summary Get file manager directory
1951
+ * @param {number} id
1952
+ * @param {string} [path]
1953
+ * @param {number} [storefrontFsDirectoryOid]
1954
+ * @param {number} [storefrontThemeOid]
1955
+ * @param {*} [options] Override http request option.
1956
+ * @throws {RequiredError}
1957
+ * @memberof StorefrontApiInterface
1958
+ */
1959
+ getFsDirectoryRaw(requestParameters: GetFsDirectoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileManagerPage>>;
1960
+ /**
1961
+ * Get file manager directory
1962
+ */
1963
+ getFsDirectory(requestParameters: GetFsDirectoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileManagerPage>;
1894
1964
  /**
1895
1965
  * Get screen recording heatmap
1896
1966
  * @summary Get screen recording heatmap
@@ -2222,6 +2292,20 @@ export interface StorefrontApiInterface {
2222
2292
  * Get all Twilio accounts
2223
2293
  */
2224
2294
  getTwilioAccounts(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TwiliosResponse>;
2295
+ /**
2296
+ *
2297
+ * @summary Retrieves a S3 url where a file may be uploaded. Once uploaded, use uploadFsFile to trigger the server into reading the S3 bucket and retrieving the file.
2298
+ * @param {number} id
2299
+ * @param {string} extension
2300
+ * @param {*} [options] Override http request option.
2301
+ * @throws {RequiredError}
2302
+ * @memberof StorefrontApiInterface
2303
+ */
2304
+ getUploadFsFileUrlRaw(requestParameters: GetUploadFsFileUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileManagerUploadUrlResponse>>;
2305
+ /**
2306
+ * Retrieves a S3 url where a file may be uploaded. Once uploaded, use uploadFsFile to trigger the server into reading the S3 bucket and retrieving the file.
2307
+ */
2308
+ getUploadFsFileUrl(requestParameters: GetUploadFsFileUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileManagerUploadUrlResponse>;
2225
2309
  /**
2226
2310
  *
2227
2311
  * @summary Globally unsubscribe a customer
@@ -3047,6 +3131,20 @@ export interface StorefrontApiInterface {
3047
3131
  * Update Twilio account
3048
3132
  */
3049
3133
  updateTwilioAccount(requestParameters: UpdateTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TwilioResponse>;
3134
+ /**
3135
+ *
3136
+ * @summary This is the last step in uploading a file after 1) calling getUploadFsFileUrl and 2) uploading a file to the provided url, then finally 3) calling this method and providing the key to trigger the server into reading the S3 bucket and retrieving the file.
3137
+ * @param {number} id
3138
+ * @param {FileManagerUploadRequest} uploadRequest UploadRequest
3139
+ * @param {*} [options] Override http request option.
3140
+ * @throws {RequiredError}
3141
+ * @memberof StorefrontApiInterface
3142
+ */
3143
+ uploadFsFileRaw(requestParameters: UploadFsFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
3144
+ /**
3145
+ * This is the last step in uploading a file after 1) calling getUploadFsFileUrl and 2) uploading a file to the provided url, then finally 3) calling this method and providing the key to trigger the server into reading the S3 bucket and retrieving the file.
3146
+ */
3147
+ uploadFsFile(requestParameters: UploadFsFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
3050
3148
  /**
3051
3149
  *
3052
3150
  * @summary Validate AWS Event Ruler
@@ -3145,6 +3243,14 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
3145
3243
  * Create email sending domain for various providers
3146
3244
  */
3147
3245
  createEmailSendingDomain2(requestParameters: CreateEmailSendingDomain2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailSendingDomainResponse>;
3246
+ /**
3247
+ * Create file manager directory
3248
+ */
3249
+ createFsDirectoryRaw(requestParameters: CreateFsDirectoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileManagerPage>>;
3250
+ /**
3251
+ * Create file manager directory
3252
+ */
3253
+ createFsDirectory(requestParameters: CreateFsDirectoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileManagerPage>;
3148
3254
  /**
3149
3255
  * Create Twilio account
3150
3256
  */
@@ -3225,6 +3331,14 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
3225
3331
  * Delete experiment
3226
3332
  */
3227
3333
  deleteExperiment(requestParameters: DeleteExperimentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
3334
+ /**
3335
+ * Delete file manager directory
3336
+ */
3337
+ deleteFsFileRaw(requestParameters: DeleteFsFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileManagerPage>>;
3338
+ /**
3339
+ * Delete file manager directory
3340
+ */
3341
+ deleteFsFile(requestParameters: DeleteFsFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileManagerPage>;
3228
3342
  /**
3229
3343
  * Delete screen recording heatmap
3230
3344
  * Delete screen recording heatmap
@@ -3761,6 +3875,14 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
3761
3875
  * Get experiments
3762
3876
  */
3763
3877
  getExperiments(requestParameters: GetExperimentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExperimentsResponse>;
3878
+ /**
3879
+ * Get file manager directory
3880
+ */
3881
+ getFsDirectoryRaw(requestParameters: GetFsDirectoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileManagerPage>>;
3882
+ /**
3883
+ * Get file manager directory
3884
+ */
3885
+ getFsDirectory(requestParameters: GetFsDirectoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileManagerPage>;
3764
3886
  /**
3765
3887
  * Get screen recording heatmap
3766
3888
  * Get screen recording heatmap
@@ -3969,6 +4091,14 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
3969
4091
  * Get all Twilio accounts
3970
4092
  */
3971
4093
  getTwilioAccounts(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TwiliosResponse>;
4094
+ /**
4095
+ * Retrieves a S3 url where a file may be uploaded. Once uploaded, use uploadFsFile to trigger the server into reading the S3 bucket and retrieving the file.
4096
+ */
4097
+ getUploadFsFileUrlRaw(requestParameters: GetUploadFsFileUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileManagerUploadUrlResponse>>;
4098
+ /**
4099
+ * Retrieves a S3 url where a file may be uploaded. Once uploaded, use uploadFsFile to trigger the server into reading the S3 bucket and retrieving the file.
4100
+ */
4101
+ getUploadFsFileUrl(requestParameters: GetUploadFsFileUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileManagerUploadUrlResponse>;
3972
4102
  /**
3973
4103
  * Globally unsubscribe a customer
3974
4104
  */
@@ -4433,6 +4563,14 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
4433
4563
  * Update Twilio account
4434
4564
  */
4435
4565
  updateTwilioAccount(requestParameters: UpdateTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TwilioResponse>;
4566
+ /**
4567
+ * This is the last step in uploading a file after 1) calling getUploadFsFileUrl and 2) uploading a file to the provided url, then finally 3) calling this method and providing the key to trigger the server into reading the S3 bucket and retrieving the file.
4568
+ */
4569
+ uploadFsFileRaw(requestParameters: UploadFsFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
4570
+ /**
4571
+ * This is the last step in uploading a file after 1) calling getUploadFsFileUrl and 2) uploading a file to the provided url, then finally 3) calling this method and providing the key to trigger the server into reading the S3 bucket and retrieving the file.
4572
+ */
4573
+ uploadFsFile(requestParameters: UploadFsFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
4436
4574
  /**
4437
4575
  * Validate AWS Event Ruler
4438
4576
  */