ultracart_rest_api_v2_typescript 4.0.232 → 4.0.234

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.
@@ -804,6 +804,7 @@ src/models/SovosConfig.ts
804
804
  src/models/StateProvince.ts
805
805
  src/models/StepWaiting.ts
806
806
  src/models/StoreFront.ts
807
+ src/models/StoreFrontPageContentAttribute.ts
807
808
  src/models/StoreFrontsResponse.ts
808
809
  src/models/TaxCity.ts
809
810
  src/models/TaxCountry.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## ultracart_rest_api_v2_typescript@4.0.232
1
+ ## ultracart_rest_api_v2_typescript@4.0.234
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.232 --save
39
+ npm install ultracart_rest_api_v2_typescript@4.0.234 --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.234 | 10/24/2024 | storefront page attribute edit method |
58
+ | 4.0.233 | 09/18/2024 | order payment constant for PayPal Fastlane |
57
59
  | 4.0.232 | 08/29/2024 | add hold_for_transmission to item shipping object |
58
60
  | 4.0.231 | 08/08/2024 | added query_target to OrderApi.getOrdersBatch to allow cache usage |
59
61
  | 4.0.230 | 06/24/2024 | conversation object cleanup |
@@ -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, EmailCommseqSmsSendTestRequest, EmailCommseqSmsSendTestResponse, 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, EmailRateLimitersResponse, EmailSegment, EmailSegmentArchiveResponse, EmailSegmentCustomersResponse, EmailSegmentDownloadPrepareResponse, EmailSegmentResponse, EmailSegmentsResponse, EmailSendingDomainResponse, EmailSendingDomainsResponse, EmailSettings, EmailSettingsResponse, EmailSmsOrdersResponse, EmailStatPostcardSummaryRequest, EmailStatPostcardSummaryResponse, EmailStatSmsSummaryRequest, EmailStatSmsSummaryResponse, EmailStatSummaryRequest, EmailStatSummaryResponse, EmailStepStatRequest, EmailStepStatResponse, EmailStepWaitingRequest, EmailStepWaitingResponse, EmailTemplate, EmailTemplatesResponse, EmailThirdPartyListImportRequest, EmailThirdPartyProvidersResponse, EmailWebhookEditorValuesResponse, Experiment, ExperimentResponse, ExperimentsResponse, FileManagerPageResponse, 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';
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, EmailCommseqSmsSendTestRequest, EmailCommseqSmsSendTestResponse, 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, EmailRateLimitersResponse, EmailSegment, EmailSegmentArchiveResponse, EmailSegmentCustomersResponse, EmailSegmentDownloadPrepareResponse, EmailSegmentResponse, EmailSegmentsResponse, EmailSendingDomainResponse, EmailSendingDomainsResponse, EmailSettings, EmailSettingsResponse, EmailSmsOrdersResponse, EmailStatPostcardSummaryRequest, EmailStatPostcardSummaryResponse, EmailStatSmsSummaryRequest, EmailStatSmsSummaryResponse, EmailStatSummaryRequest, EmailStatSummaryResponse, EmailStepStatRequest, EmailStepStatResponse, EmailStepWaitingRequest, EmailStepWaitingResponse, EmailTemplate, EmailTemplatesResponse, EmailThirdPartyListImportRequest, EmailThirdPartyProvidersResponse, EmailWebhookEditorValuesResponse, Experiment, ExperimentResponse, ExperimentsResponse, FileManagerPageResponse, 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, StoreFrontPageContentAttribute, StoreFrontsResponse, ThumbnailParametersRequest, ThumbnailParametersResponse, TransactionEmail, TransactionEmailListResponse, TransactionEmailResponse, Twilio, TwilioResponse, TwiliosResponse } from '../models';
14
14
  export interface AddToLibraryRequest {
15
15
  addLibraryRequest: AddLibraryItemRequest;
16
16
  }
@@ -512,6 +512,11 @@ export interface InsertScreenRecordingSegmentRequest {
512
512
  storefrontOid: number;
513
513
  segment: ScreenRecordingSegment;
514
514
  }
515
+ export interface InsertUpdatePageContentAttributeRequest {
516
+ storefrontOid: number;
517
+ pageOid: number;
518
+ pageAttribute: StoreFrontPageContentAttribute;
519
+ }
515
520
  export interface PrepareDownloadEmailSegmentRequest {
516
521
  storefrontOid: number;
517
522
  emailSegmentUuid: string;
@@ -2562,6 +2567,22 @@ export interface StorefrontApiInterface {
2562
2567
  * Insert screen recording segment
2563
2568
  */
2564
2569
  insertScreenRecordingSegment(requestParameters: InsertScreenRecordingSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScreenRecordingSegmentResponse>;
2570
+ /**
2571
+ * Update a page content attribute, creating it new if it does not yet exist.
2572
+ * @summary Upsert a page content attribute
2573
+ * @param {number} storefrontOid
2574
+ * @param {number} pageOid The page oid to modify.
2575
+ * @param {StoreFrontPageContentAttribute} pageAttribute Page content attribute to upsert
2576
+ * @param {*} [options] Override http request option.
2577
+ * @throws {RequiredError}
2578
+ * @memberof StorefrontApiInterface
2579
+ */
2580
+ insertUpdatePageContentAttributeRaw(requestParameters: InsertUpdatePageContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
2581
+ /**
2582
+ * Update a page content attribute, creating it new if it does not yet exist.
2583
+ * Upsert a page content attribute
2584
+ */
2585
+ insertUpdatePageContentAttribute(requestParameters: InsertUpdatePageContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
2565
2586
  /**
2566
2587
  *
2567
2588
  * @summary Prepare download of email segment
@@ -4345,6 +4366,16 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
4345
4366
  * Insert screen recording segment
4346
4367
  */
4347
4368
  insertScreenRecordingSegment(requestParameters: InsertScreenRecordingSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScreenRecordingSegmentResponse>;
4369
+ /**
4370
+ * Update a page content attribute, creating it new if it does not yet exist.
4371
+ * Upsert a page content attribute
4372
+ */
4373
+ insertUpdatePageContentAttributeRaw(requestParameters: InsertUpdatePageContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
4374
+ /**
4375
+ * Update a page content attribute, creating it new if it does not yet exist.
4376
+ * Upsert a page content attribute
4377
+ */
4378
+ insertUpdatePageContentAttribute(requestParameters: InsertUpdatePageContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
4348
4379
  /**
4349
4380
  * Prepare download of email segment
4350
4381
  */
@@ -8236,6 +8236,71 @@ var StorefrontApi = /** @class */ (function (_super) {
8236
8236
  });
8237
8237
  });
8238
8238
  };
8239
+ /**
8240
+ * Update a page content attribute, creating it new if it does not yet exist.
8241
+ * Upsert a page content attribute
8242
+ */
8243
+ StorefrontApi.prototype.insertUpdatePageContentAttributeRaw = function (requestParameters, initOverrides) {
8244
+ return __awaiter(this, void 0, void 0, function () {
8245
+ var queryParameters, headerParameters, _a, _b, response;
8246
+ return __generator(this, function (_c) {
8247
+ switch (_c.label) {
8248
+ case 0:
8249
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
8250
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling insertUpdatePageContentAttribute.');
8251
+ }
8252
+ if (requestParameters.pageOid === null || requestParameters.pageOid === undefined) {
8253
+ throw new runtime.RequiredError('pageOid', 'Required parameter requestParameters.pageOid was null or undefined when calling insertUpdatePageContentAttribute.');
8254
+ }
8255
+ if (requestParameters.pageAttribute === null || requestParameters.pageAttribute === undefined) {
8256
+ throw new runtime.RequiredError('pageAttribute', 'Required parameter requestParameters.pageAttribute was null or undefined when calling insertUpdatePageContentAttribute.');
8257
+ }
8258
+ queryParameters = {};
8259
+ headerParameters = {};
8260
+ headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
8261
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
8262
+ // oauth required
8263
+ _a = headerParameters;
8264
+ _b = "Authorization";
8265
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["storefront_write"])];
8266
+ case 1:
8267
+ // oauth required
8268
+ _a[_b] = _c.sent();
8269
+ _c.label = 2;
8270
+ case 2:
8271
+ if (this.configuration && this.configuration.apiKey) {
8272
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
8273
+ }
8274
+ return [4 /*yield*/, this.request({
8275
+ path: "/storefront/{storefront_oid}/pages/{page_oid}/content/attributes".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("page_oid", "}"), encodeURIComponent(String(requestParameters.pageOid))),
8276
+ method: 'POST',
8277
+ headers: headerParameters,
8278
+ query: queryParameters,
8279
+ body: (0, models_1.StoreFrontPageContentAttributeToJSON)(requestParameters.pageAttribute),
8280
+ }, initOverrides)];
8281
+ case 3:
8282
+ response = _c.sent();
8283
+ return [2 /*return*/, new runtime.VoidApiResponse(response)];
8284
+ }
8285
+ });
8286
+ });
8287
+ };
8288
+ /**
8289
+ * Update a page content attribute, creating it new if it does not yet exist.
8290
+ * Upsert a page content attribute
8291
+ */
8292
+ StorefrontApi.prototype.insertUpdatePageContentAttribute = function (requestParameters, initOverrides) {
8293
+ return __awaiter(this, void 0, void 0, function () {
8294
+ return __generator(this, function (_a) {
8295
+ switch (_a.label) {
8296
+ case 0: return [4 /*yield*/, this.insertUpdatePageContentAttributeRaw(requestParameters, initOverrides)];
8297
+ case 1:
8298
+ _a.sent();
8299
+ return [2 /*return*/];
8300
+ }
8301
+ });
8302
+ });
8303
+ };
8239
8304
  /**
8240
8305
  * Prepare download of email segment
8241
8306
  */
@@ -135,6 +135,18 @@ export interface OrderUtm {
135
135
  * @memberof OrderUtm
136
136
  */
137
137
  msclkid?: string;
138
+ /**
139
+ *
140
+ * @type {string}
141
+ * @memberof OrderUtm
142
+ */
143
+ short_code?: string;
144
+ /**
145
+ *
146
+ * @type {boolean}
147
+ * @memberof OrderUtm
148
+ */
149
+ short_code_backup?: boolean;
138
150
  /**
139
151
  *
140
152
  * @type {string}
@@ -44,6 +44,8 @@ function OrderUtmFromJSONTyped(json, ignoreDiscriminator) {
44
44
  'itm_source': !(0, runtime_1.exists)(json, 'itm_source') ? undefined : json['itm_source'],
45
45
  'itm_term': !(0, runtime_1.exists)(json, 'itm_term') ? undefined : json['itm_term'],
46
46
  'msclkid': !(0, runtime_1.exists)(json, 'msclkid') ? undefined : json['msclkid'],
47
+ 'short_code': !(0, runtime_1.exists)(json, 'short_code') ? undefined : json['short_code'],
48
+ 'short_code_backup': !(0, runtime_1.exists)(json, 'short_code_backup') ? undefined : json['short_code_backup'],
47
49
  'ttclid': !(0, runtime_1.exists)(json, 'ttclid') ? undefined : json['ttclid'],
48
50
  'uc_message_id': !(0, runtime_1.exists)(json, 'uc_message_id') ? undefined : json['uc_message_id'],
49
51
  'utm_campaign': !(0, runtime_1.exists)(json, 'utm_campaign') ? undefined : json['utm_campaign'],
@@ -85,6 +87,8 @@ function OrderUtmToJSON(value) {
85
87
  'itm_source': value.itm_source,
86
88
  'itm_term': value.itm_term,
87
89
  'msclkid': value.msclkid,
90
+ 'short_code': value.short_code,
91
+ 'short_code_backup': value.short_code_backup,
88
92
  'ttclid': value.ttclid,
89
93
  'uc_message_id': value.uc_message_id,
90
94
  'utm_campaign': value.utm_campaign,
@@ -0,0 +1,45 @@
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 StoreFrontPageContentAttribute
16
+ */
17
+ export interface StoreFrontPageContentAttribute {
18
+ /**
19
+ * Attribute name
20
+ * @type {string}
21
+ * @memberof StoreFrontPageContentAttribute
22
+ */
23
+ name?: string;
24
+ /**
25
+ * Attribute translated text instance identifier
26
+ * @type {number}
27
+ * @memberof StoreFrontPageContentAttribute
28
+ */
29
+ translated_text_instance_oid?: number;
30
+ /**
31
+ * Attribute type
32
+ * @type {string}
33
+ * @memberof StoreFrontPageContentAttribute
34
+ */
35
+ type?: string;
36
+ /**
37
+ * Attribute value
38
+ * @type {string}
39
+ * @memberof StoreFrontPageContentAttribute
40
+ */
41
+ value?: string;
42
+ }
43
+ export declare function StoreFrontPageContentAttributeFromJSON(json: any): StoreFrontPageContentAttribute;
44
+ export declare function StoreFrontPageContentAttributeFromJSONTyped(json: any, ignoreDiscriminator: boolean): StoreFrontPageContentAttribute;
45
+ export declare function StoreFrontPageContentAttributeToJSON(value?: StoreFrontPageContentAttribute | null): any;
@@ -0,0 +1,48 @@
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.StoreFrontPageContentAttributeToJSON = exports.StoreFrontPageContentAttributeFromJSONTyped = exports.StoreFrontPageContentAttributeFromJSON = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ function StoreFrontPageContentAttributeFromJSON(json) {
19
+ return StoreFrontPageContentAttributeFromJSONTyped(json, false);
20
+ }
21
+ exports.StoreFrontPageContentAttributeFromJSON = StoreFrontPageContentAttributeFromJSON;
22
+ function StoreFrontPageContentAttributeFromJSONTyped(json, ignoreDiscriminator) {
23
+ if ((json === undefined) || (json === null)) {
24
+ return json;
25
+ }
26
+ return {
27
+ 'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
28
+ 'translated_text_instance_oid': !(0, runtime_1.exists)(json, 'translated_text_instance_oid') ? undefined : json['translated_text_instance_oid'],
29
+ 'type': !(0, runtime_1.exists)(json, 'type') ? undefined : json['type'],
30
+ 'value': !(0, runtime_1.exists)(json, 'value') ? undefined : json['value'],
31
+ };
32
+ }
33
+ exports.StoreFrontPageContentAttributeFromJSONTyped = StoreFrontPageContentAttributeFromJSONTyped;
34
+ function StoreFrontPageContentAttributeToJSON(value) {
35
+ if (value === undefined) {
36
+ return undefined;
37
+ }
38
+ if (value === null) {
39
+ return null;
40
+ }
41
+ return {
42
+ 'name': value.name,
43
+ 'translated_text_instance_oid': value.translated_text_instance_oid,
44
+ 'type': value.type,
45
+ 'value': value.value,
46
+ };
47
+ }
48
+ exports.StoreFrontPageContentAttributeToJSON = StoreFrontPageContentAttributeToJSON;
@@ -145,6 +145,8 @@ export type WebhookApiVersionEnum = typeof WebhookApiVersionEnum[keyof typeof We
145
145
  export declare const WebhookAuthenticationTypeEnum: {
146
146
  readonly None: "none";
147
147
  readonly Basic: "basic";
148
+ readonly ApiUser: "api user";
149
+ readonly AwsIam: "aws iam";
148
150
  };
149
151
  export type WebhookAuthenticationTypeEnum = typeof WebhookAuthenticationTypeEnum[keyof typeof WebhookAuthenticationTypeEnum];
150
152
  export declare function WebhookFromJSON(json: any): Webhook;
@@ -28,7 +28,9 @@ exports.WebhookApiVersionEnum = {
28
28
  */
29
29
  exports.WebhookAuthenticationTypeEnum = {
30
30
  None: 'none',
31
- Basic: 'basic'
31
+ Basic: 'basic',
32
+ ApiUser: 'api user',
33
+ AwsIam: 'aws iam'
32
34
  };
33
35
  function WebhookFromJSON(json) {
34
36
  return WebhookFromJSONTyped(json, false);
@@ -777,6 +777,7 @@ export * from './SovosConfig';
777
777
  export * from './StateProvince';
778
778
  export * from './StepWaiting';
779
779
  export * from './StoreFront';
780
+ export * from './StoreFrontPageContentAttribute';
780
781
  export * from './StoreFrontsResponse';
781
782
  export * from './TaxCity';
782
783
  export * from './TaxCountry';
@@ -795,6 +795,7 @@ __exportStar(require("./SovosConfig"), exports);
795
795
  __exportStar(require("./StateProvince"), exports);
796
796
  __exportStar(require("./StepWaiting"), exports);
797
797
  __exportStar(require("./StoreFront"), exports);
798
+ __exportStar(require("./StoreFrontPageContentAttribute"), exports);
798
799
  __exportStar(require("./StoreFrontsResponse"), exports);
799
800
  __exportStar(require("./TaxCity"), exports);
800
801
  __exportStar(require("./TaxCountry"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "4.0.232",
3
+ "version": "4.0.234",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "repository": {
@@ -423,6 +423,9 @@ import {
423
423
  ScreenshotsResponse,
424
424
  ScreenshotsResponseFromJSON,
425
425
  ScreenshotsResponseToJSON,
426
+ StoreFrontPageContentAttribute,
427
+ StoreFrontPageContentAttributeFromJSON,
428
+ StoreFrontPageContentAttributeToJSON,
426
429
  StoreFrontsResponse,
427
430
  StoreFrontsResponseFromJSON,
428
431
  StoreFrontsResponseToJSON,
@@ -1077,6 +1080,12 @@ export interface InsertScreenRecordingSegmentRequest {
1077
1080
  segment: ScreenRecordingSegment;
1078
1081
  }
1079
1082
 
1083
+ export interface InsertUpdatePageContentAttributeRequest {
1084
+ storefrontOid: number;
1085
+ pageOid: number;
1086
+ pageAttribute: StoreFrontPageContentAttribute;
1087
+ }
1088
+
1080
1089
  export interface PrepareDownloadEmailSegmentRequest {
1081
1090
  storefrontOid: number;
1082
1091
  emailSegmentUuid: string;
@@ -3433,6 +3442,24 @@ export interface StorefrontApiInterface {
3433
3442
  */
3434
3443
  insertScreenRecordingSegment(requestParameters: InsertScreenRecordingSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScreenRecordingSegmentResponse>;
3435
3444
 
3445
+ /**
3446
+ * Update a page content attribute, creating it new if it does not yet exist.
3447
+ * @summary Upsert a page content attribute
3448
+ * @param {number} storefrontOid
3449
+ * @param {number} pageOid The page oid to modify.
3450
+ * @param {StoreFrontPageContentAttribute} pageAttribute Page content attribute to upsert
3451
+ * @param {*} [options] Override http request option.
3452
+ * @throws {RequiredError}
3453
+ * @memberof StorefrontApiInterface
3454
+ */
3455
+ insertUpdatePageContentAttributeRaw(requestParameters: InsertUpdatePageContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
3456
+
3457
+ /**
3458
+ * Update a page content attribute, creating it new if it does not yet exist.
3459
+ * Upsert a page content attribute
3460
+ */
3461
+ insertUpdatePageContentAttribute(requestParameters: InsertUpdatePageContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
3462
+
3436
3463
  /**
3437
3464
  *
3438
3465
  * @summary Prepare download of email segment
@@ -10370,6 +10397,57 @@ export class StorefrontApi extends runtime.BaseAPI implements StorefrontApiInter
10370
10397
  return await response.value();
10371
10398
  }
10372
10399
 
10400
+ /**
10401
+ * Update a page content attribute, creating it new if it does not yet exist.
10402
+ * Upsert a page content attribute
10403
+ */
10404
+ async insertUpdatePageContentAttributeRaw(requestParameters: InsertUpdatePageContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
10405
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
10406
+ throw new runtime.RequiredError('storefrontOid','Required parameter requestParameters.storefrontOid was null or undefined when calling insertUpdatePageContentAttribute.');
10407
+ }
10408
+
10409
+ if (requestParameters.pageOid === null || requestParameters.pageOid === undefined) {
10410
+ throw new runtime.RequiredError('pageOid','Required parameter requestParameters.pageOid was null or undefined when calling insertUpdatePageContentAttribute.');
10411
+ }
10412
+
10413
+ if (requestParameters.pageAttribute === null || requestParameters.pageAttribute === undefined) {
10414
+ throw new runtime.RequiredError('pageAttribute','Required parameter requestParameters.pageAttribute was null or undefined when calling insertUpdatePageContentAttribute.');
10415
+ }
10416
+
10417
+ const queryParameters: any = {};
10418
+
10419
+ const headerParameters: runtime.HTTPHeaders = {};
10420
+
10421
+ headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
10422
+
10423
+ if (this.configuration && this.configuration.accessToken) {
10424
+ // oauth required
10425
+ headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["storefront_write"]);
10426
+ }
10427
+
10428
+ if (this.configuration && this.configuration.apiKey) {
10429
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
10430
+ }
10431
+
10432
+ const response = await this.request({
10433
+ path: `/storefront/{storefront_oid}/pages/{page_oid}/content/attributes`.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(requestParameters.storefrontOid))).replace(`{${"page_oid"}}`, encodeURIComponent(String(requestParameters.pageOid))),
10434
+ method: 'POST',
10435
+ headers: headerParameters,
10436
+ query: queryParameters,
10437
+ body: StoreFrontPageContentAttributeToJSON(requestParameters.pageAttribute),
10438
+ }, initOverrides);
10439
+
10440
+ return new runtime.VoidApiResponse(response);
10441
+ }
10442
+
10443
+ /**
10444
+ * Update a page content attribute, creating it new if it does not yet exist.
10445
+ * Upsert a page content attribute
10446
+ */
10447
+ async insertUpdatePageContentAttribute(requestParameters: InsertUpdatePageContentAttributeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
10448
+ await this.insertUpdatePageContentAttributeRaw(requestParameters, initOverrides);
10449
+ }
10450
+
10373
10451
  /**
10374
10452
  * Prepare download of email segment
10375
10453
  */
@@ -139,6 +139,18 @@ export interface OrderUtm {
139
139
  * @memberof OrderUtm
140
140
  */
141
141
  msclkid?: string;
142
+ /**
143
+ *
144
+ * @type {string}
145
+ * @memberof OrderUtm
146
+ */
147
+ short_code?: string;
148
+ /**
149
+ *
150
+ * @type {boolean}
151
+ * @memberof OrderUtm
152
+ */
153
+ short_code_backup?: boolean;
142
154
  /**
143
155
  *
144
156
  * @type {string}
@@ -231,6 +243,8 @@ export function OrderUtmFromJSONTyped(json: any, ignoreDiscriminator: boolean):
231
243
  'itm_source': !exists(json, 'itm_source') ? undefined : json['itm_source'],
232
244
  'itm_term': !exists(json, 'itm_term') ? undefined : json['itm_term'],
233
245
  'msclkid': !exists(json, 'msclkid') ? undefined : json['msclkid'],
246
+ 'short_code': !exists(json, 'short_code') ? undefined : json['short_code'],
247
+ 'short_code_backup': !exists(json, 'short_code_backup') ? undefined : json['short_code_backup'],
234
248
  'ttclid': !exists(json, 'ttclid') ? undefined : json['ttclid'],
235
249
  'uc_message_id': !exists(json, 'uc_message_id') ? undefined : json['uc_message_id'],
236
250
  'utm_campaign': !exists(json, 'utm_campaign') ? undefined : json['utm_campaign'],
@@ -273,6 +287,8 @@ export function OrderUtmToJSON(value?: OrderUtm | null): any {
273
287
  'itm_source': value.itm_source,
274
288
  'itm_term': value.itm_term,
275
289
  'msclkid': value.msclkid,
290
+ 'short_code': value.short_code,
291
+ 'short_code_backup': value.short_code_backup,
276
292
  'ttclid': value.ttclid,
277
293
  'uc_message_id': value.uc_message_id,
278
294
  'utm_campaign': value.utm_campaign,
@@ -0,0 +1,80 @@
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 StoreFrontPageContentAttribute
20
+ */
21
+ export interface StoreFrontPageContentAttribute {
22
+ /**
23
+ * Attribute name
24
+ * @type {string}
25
+ * @memberof StoreFrontPageContentAttribute
26
+ */
27
+ name?: string;
28
+ /**
29
+ * Attribute translated text instance identifier
30
+ * @type {number}
31
+ * @memberof StoreFrontPageContentAttribute
32
+ */
33
+ translated_text_instance_oid?: number;
34
+ /**
35
+ * Attribute type
36
+ * @type {string}
37
+ * @memberof StoreFrontPageContentAttribute
38
+ */
39
+ type?: string;
40
+ /**
41
+ * Attribute value
42
+ * @type {string}
43
+ * @memberof StoreFrontPageContentAttribute
44
+ */
45
+ value?: string;
46
+ }
47
+
48
+ export function StoreFrontPageContentAttributeFromJSON(json: any): StoreFrontPageContentAttribute {
49
+ return StoreFrontPageContentAttributeFromJSONTyped(json, false);
50
+ }
51
+
52
+ export function StoreFrontPageContentAttributeFromJSONTyped(json: any, ignoreDiscriminator: boolean): StoreFrontPageContentAttribute {
53
+ if ((json === undefined) || (json === null)) {
54
+ return json;
55
+ }
56
+ return {
57
+
58
+ 'name': !exists(json, 'name') ? undefined : json['name'],
59
+ 'translated_text_instance_oid': !exists(json, 'translated_text_instance_oid') ? undefined : json['translated_text_instance_oid'],
60
+ 'type': !exists(json, 'type') ? undefined : json['type'],
61
+ 'value': !exists(json, 'value') ? undefined : json['value'],
62
+ };
63
+ }
64
+
65
+ export function StoreFrontPageContentAttributeToJSON(value?: StoreFrontPageContentAttribute | null): any {
66
+ if (value === undefined) {
67
+ return undefined;
68
+ }
69
+ if (value === null) {
70
+ return null;
71
+ }
72
+ return {
73
+
74
+ 'name': value.name,
75
+ 'translated_text_instance_oid': value.translated_text_instance_oid,
76
+ 'type': value.type,
77
+ 'value': value.value,
78
+ };
79
+ }
80
+
@@ -162,7 +162,9 @@ export type WebhookApiVersionEnum = typeof WebhookApiVersionEnum[keyof typeof We
162
162
  */
163
163
  export const WebhookAuthenticationTypeEnum = {
164
164
  None: 'none',
165
- Basic: 'basic'
165
+ Basic: 'basic',
166
+ ApiUser: 'api user',
167
+ AwsIam: 'aws iam'
166
168
  } as const;
167
169
  export type WebhookAuthenticationTypeEnum = typeof WebhookAuthenticationTypeEnum[keyof typeof WebhookAuthenticationTypeEnum];
168
170
 
@@ -779,6 +779,7 @@ export * from './SovosConfig';
779
779
  export * from './StateProvince';
780
780
  export * from './StepWaiting';
781
781
  export * from './StoreFront';
782
+ export * from './StoreFrontPageContentAttribute';
782
783
  export * from './StoreFrontsResponse';
783
784
  export * from './TaxCity';
784
785
  export * from './TaxCountry';