ultracart_rest_api_v2_typescript 3.10.216 → 3.10.218
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.
- package/README.md +4 -2
- package/api.ts +181 -0
- package/dist/api.d.ts +104 -0
- package/dist/api.js +112 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## ultracart_rest_api_v2_typescript@3.10.
|
|
1
|
+
## ultracart_rest_api_v2_typescript@3.10.218
|
|
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@3.10.
|
|
39
|
+
npm install ultracart_rest_api_v2_typescript@3.10.218 --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
|
+
| 3.10.218 | 11/04/2024 | item - new constant for auto order schedule of every 5 months |
|
|
58
|
+
| 3.10.217 | 10/24/2024 | storefront page attribute edit method |
|
|
57
59
|
| 3.10.216 | 09/18/2024 | order payment constant for PayPal Fastlane |
|
|
58
60
|
| 3.10.215 | 08/29/2024 | add hold_for_transmission to item shipping object |
|
|
59
61
|
| 3.10.214 | 08/08/2024 | added query_target to OrderApi.getOrdersBatch to allow cache usage |
|
package/api.ts
CHANGED
|
@@ -1796,6 +1796,7 @@ export namespace AutoOrderItem {
|
|
|
1796
1796
|
Every2Months = <any> 'Every 2 Months',
|
|
1797
1797
|
Every3Months = <any> 'Every 3 Months',
|
|
1798
1798
|
Every4Months = <any> 'Every 4 Months',
|
|
1799
|
+
Every5Months = <any> 'Every 5 Months',
|
|
1799
1800
|
Every6Months = <any> 'Every 6 Months',
|
|
1800
1801
|
Yearly = <any> 'Yearly',
|
|
1801
1802
|
Every4Weeks = <any> 'Every 4 Weeks',
|
|
@@ -1903,6 +1904,7 @@ export namespace AutoOrderItemSimpleSchedule {
|
|
|
1903
1904
|
Every2Months = <any> 'Every 2 Months',
|
|
1904
1905
|
Every3Months = <any> 'Every 3 Months',
|
|
1905
1906
|
Every4Months = <any> 'Every 4 Months',
|
|
1907
|
+
Every5Months = <any> 'Every 5 Months',
|
|
1906
1908
|
Every6Months = <any> 'Every 6 Months',
|
|
1907
1909
|
Yearly = <any> 'Yearly',
|
|
1908
1910
|
Every4Weeks = <any> 'Every 4 Weeks',
|
|
@@ -6227,6 +6229,7 @@ export namespace ChannelPartnerOrderItem {
|
|
|
6227
6229
|
Every2Months = <any> 'Every 2 Months',
|
|
6228
6230
|
Every3Months = <any> 'Every 3 Months',
|
|
6229
6231
|
Every4Months = <any> 'Every 4 Months',
|
|
6232
|
+
Every5Months = <any> 'Every 5 Months',
|
|
6230
6233
|
Every6Months = <any> 'Every 6 Months',
|
|
6231
6234
|
Yearly = <any> 'Yearly',
|
|
6232
6235
|
Every4Weeks = <any> 'Every 4 Weeks',
|
|
@@ -36343,6 +36346,18 @@ export interface OrderUtm {
|
|
|
36343
36346
|
* @memberof OrderUtm
|
|
36344
36347
|
*/
|
|
36345
36348
|
msclkid?: string;
|
|
36349
|
+
/**
|
|
36350
|
+
*
|
|
36351
|
+
* @type {string}
|
|
36352
|
+
* @memberof OrderUtm
|
|
36353
|
+
*/
|
|
36354
|
+
short_code?: string;
|
|
36355
|
+
/**
|
|
36356
|
+
*
|
|
36357
|
+
* @type {boolean}
|
|
36358
|
+
* @memberof OrderUtm
|
|
36359
|
+
*/
|
|
36360
|
+
short_code_backup?: boolean;
|
|
36346
36361
|
/**
|
|
36347
36362
|
*
|
|
36348
36363
|
* @type {string}
|
|
@@ -41446,6 +41461,38 @@ export interface StoreFront {
|
|
|
41446
41461
|
unlock_password?: string;
|
|
41447
41462
|
}
|
|
41448
41463
|
|
|
41464
|
+
/**
|
|
41465
|
+
*
|
|
41466
|
+
* @export
|
|
41467
|
+
* @interface StoreFrontPageContentAttribute
|
|
41468
|
+
*/
|
|
41469
|
+
export interface StoreFrontPageContentAttribute {
|
|
41470
|
+
/**
|
|
41471
|
+
* Attribute name
|
|
41472
|
+
* @type {string}
|
|
41473
|
+
* @memberof StoreFrontPageContentAttribute
|
|
41474
|
+
*/
|
|
41475
|
+
name?: string;
|
|
41476
|
+
/**
|
|
41477
|
+
* Attribute translated text instance identifier
|
|
41478
|
+
* @type {number}
|
|
41479
|
+
* @memberof StoreFrontPageContentAttribute
|
|
41480
|
+
*/
|
|
41481
|
+
translated_text_instance_oid?: number;
|
|
41482
|
+
/**
|
|
41483
|
+
* Attribute type
|
|
41484
|
+
* @type {string}
|
|
41485
|
+
* @memberof StoreFrontPageContentAttribute
|
|
41486
|
+
*/
|
|
41487
|
+
type?: string;
|
|
41488
|
+
/**
|
|
41489
|
+
* Attribute value
|
|
41490
|
+
* @type {string}
|
|
41491
|
+
* @memberof StoreFrontPageContentAttribute
|
|
41492
|
+
*/
|
|
41493
|
+
value?: string;
|
|
41494
|
+
}
|
|
41495
|
+
|
|
41449
41496
|
/**
|
|
41450
41497
|
*
|
|
41451
41498
|
* @export
|
|
@@ -43723,6 +43770,12 @@ export interface WebhookLog {
|
|
|
43723
43770
|
* @memberof WebhookLog
|
|
43724
43771
|
*/
|
|
43725
43772
|
uri?: string;
|
|
43773
|
+
/**
|
|
43774
|
+
* webhook oid
|
|
43775
|
+
* @type {number}
|
|
43776
|
+
* @memberof WebhookLog
|
|
43777
|
+
*/
|
|
43778
|
+
webhook_oid?: number;
|
|
43726
43779
|
}
|
|
43727
43780
|
|
|
43728
43781
|
/**
|
|
@@ -84220,6 +84273,73 @@ export const StorefrontApiFetchParamCreator = function (configuration?: Configur
|
|
|
84220
84273
|
options: localVarRequestOptions,
|
|
84221
84274
|
};
|
|
84222
84275
|
},
|
|
84276
|
+
/**
|
|
84277
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
84278
|
+
* @summary Upsert a page content attribute
|
|
84279
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
84280
|
+
* @param {number} storefront_oid
|
|
84281
|
+
* @param {number} page_oid The page oid to modify.
|
|
84282
|
+
* @param {*} [options] Override http request option.
|
|
84283
|
+
* @throws {RequiredError}
|
|
84284
|
+
*/
|
|
84285
|
+
insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options: any = {}): FetchArgs {
|
|
84286
|
+
// verify required parameter 'page_attribute' is not null or undefined
|
|
84287
|
+
if (page_attribute === null || page_attribute === undefined) {
|
|
84288
|
+
throw new RequiredError('page_attribute','Required parameter page_attribute was null or undefined when calling insertUpdatePageContentAttribute.');
|
|
84289
|
+
}
|
|
84290
|
+
// verify required parameter 'storefront_oid' is not null or undefined
|
|
84291
|
+
if (storefront_oid === null || storefront_oid === undefined) {
|
|
84292
|
+
throw new RequiredError('storefront_oid','Required parameter storefront_oid was null or undefined when calling insertUpdatePageContentAttribute.');
|
|
84293
|
+
}
|
|
84294
|
+
// verify required parameter 'page_oid' is not null or undefined
|
|
84295
|
+
if (page_oid === null || page_oid === undefined) {
|
|
84296
|
+
throw new RequiredError('page_oid','Required parameter page_oid was null or undefined when calling insertUpdatePageContentAttribute.');
|
|
84297
|
+
}
|
|
84298
|
+
const localVarPath = `/storefront/{storefront_oid}/pages/{page_oid}/content/attributes`
|
|
84299
|
+
.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(storefront_oid)))
|
|
84300
|
+
.replace(`{${"page_oid"}}`, encodeURIComponent(String(page_oid)));
|
|
84301
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
84302
|
+
const localVarRequestOptions = Object.assign({ method: 'POST' }, options);
|
|
84303
|
+
const localVarHeaderParameter = {} as any;
|
|
84304
|
+
const localVarQueryParameter = {} as any;
|
|
84305
|
+
|
|
84306
|
+
if(configuration && configuration.apiVersion) {
|
|
84307
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
84308
|
+
}
|
|
84309
|
+
|
|
84310
|
+
|
|
84311
|
+
|
|
84312
|
+
// authentication ultraCartOauth required
|
|
84313
|
+
// oauth required
|
|
84314
|
+
if (configuration && configuration.accessToken) {
|
|
84315
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
84316
|
+
? configuration.accessToken("ultraCartOauth", ["storefront_write"])
|
|
84317
|
+
: configuration.accessToken;
|
|
84318
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
84319
|
+
}
|
|
84320
|
+
|
|
84321
|
+
// authentication ultraCartSimpleApiKey required
|
|
84322
|
+
if (configuration && configuration.apiKey) {
|
|
84323
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
84324
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
84325
|
+
: configuration.apiKey;
|
|
84326
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
84327
|
+
}
|
|
84328
|
+
|
|
84329
|
+
localVarHeaderParameter['Content-Type'] = 'application/json; charset=UTF-8';
|
|
84330
|
+
|
|
84331
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
84332
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
84333
|
+
delete localVarUrlObj.search;
|
|
84334
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
84335
|
+
const needsSerialization = (<any>"StoreFrontPageContentAttribute" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
|
|
84336
|
+
localVarRequestOptions.body = needsSerialization ? JSON.stringify(page_attribute || {}) : (page_attribute || "");
|
|
84337
|
+
|
|
84338
|
+
return {
|
|
84339
|
+
url: url.format(localVarUrlObj),
|
|
84340
|
+
options: localVarRequestOptions,
|
|
84341
|
+
};
|
|
84342
|
+
},
|
|
84223
84343
|
/**
|
|
84224
84344
|
*
|
|
84225
84345
|
* @summary Prepare download of email segment
|
|
@@ -90472,6 +90592,29 @@ export const StorefrontApiFp = function(configuration?: Configuration) {
|
|
|
90472
90592
|
});
|
|
90473
90593
|
};
|
|
90474
90594
|
},
|
|
90595
|
+
/**
|
|
90596
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
90597
|
+
* @summary Upsert a page content attribute
|
|
90598
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
90599
|
+
* @param {number} storefront_oid
|
|
90600
|
+
* @param {number} page_oid The page oid to modify.
|
|
90601
|
+
* @param {*} [options] Override http request option.
|
|
90602
|
+
* @throws {RequiredError}
|
|
90603
|
+
*/
|
|
90604
|
+
insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response> {
|
|
90605
|
+
const localVarFetchArgs = StorefrontApiFetchParamCreator(configuration).insertUpdatePageContentAttribute(page_attribute, storefront_oid, page_oid, options);
|
|
90606
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
90607
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
90608
|
+
|
|
90609
|
+
if (response.status >= 200 && response.status < 300) {
|
|
90610
|
+
return response;
|
|
90611
|
+
|
|
90612
|
+
} else {
|
|
90613
|
+
throw response;
|
|
90614
|
+
}
|
|
90615
|
+
});
|
|
90616
|
+
};
|
|
90617
|
+
},
|
|
90475
90618
|
/**
|
|
90476
90619
|
*
|
|
90477
90620
|
* @summary Prepare download of email segment
|
|
@@ -92985,6 +93128,18 @@ export const StorefrontApiFactory = function (configuration?: Configuration, fet
|
|
|
92985
93128
|
insertScreenRecordingSegment(storefront_oid: number, segment: ScreenRecordingSegment, options?: any) {
|
|
92986
93129
|
return StorefrontApiFp(configuration).insertScreenRecordingSegment(storefront_oid, segment, options)(fetch, basePath);
|
|
92987
93130
|
},
|
|
93131
|
+
/**
|
|
93132
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
93133
|
+
* @summary Upsert a page content attribute
|
|
93134
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
93135
|
+
* @param {number} storefront_oid
|
|
93136
|
+
* @param {number} page_oid The page oid to modify.
|
|
93137
|
+
* @param {*} [options] Override http request option.
|
|
93138
|
+
* @throws {RequiredError}
|
|
93139
|
+
*/
|
|
93140
|
+
insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any) {
|
|
93141
|
+
return StorefrontApiFp(configuration).insertUpdatePageContentAttribute(page_attribute, storefront_oid, page_oid, options)(fetch, basePath);
|
|
93142
|
+
},
|
|
92988
93143
|
/**
|
|
92989
93144
|
*
|
|
92990
93145
|
* @summary Prepare download of email segment
|
|
@@ -94970,6 +95125,18 @@ export interface StorefrontApiInterface {
|
|
|
94970
95125
|
*/
|
|
94971
95126
|
insertScreenRecordingSegment(storefront_oid: number, segment: ScreenRecordingSegment, options?: any): Promise<ScreenRecordingSegmentResponse>;
|
|
94972
95127
|
|
|
95128
|
+
/**
|
|
95129
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
95130
|
+
* @summary Upsert a page content attribute
|
|
95131
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
95132
|
+
* @param {number} storefront_oid
|
|
95133
|
+
* @param {number} page_oid The page oid to modify.
|
|
95134
|
+
* @param {*} [options] Override http request option.
|
|
95135
|
+
* @throws {RequiredError}
|
|
95136
|
+
* @memberof StorefrontApiInterface
|
|
95137
|
+
*/
|
|
95138
|
+
insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any): Promise<{}>;
|
|
95139
|
+
|
|
94973
95140
|
/**
|
|
94974
95141
|
*
|
|
94975
95142
|
* @summary Prepare download of email segment
|
|
@@ -97213,6 +97380,20 @@ export class StorefrontApi extends BaseAPI implements StorefrontApiInterface {
|
|
|
97213
97380
|
return StorefrontApiFp(this.configuration).insertScreenRecordingSegment(storefront_oid, segment, options)(this.fetch, this.basePath);
|
|
97214
97381
|
}
|
|
97215
97382
|
|
|
97383
|
+
/**
|
|
97384
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
97385
|
+
* @summary Upsert a page content attribute
|
|
97386
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
97387
|
+
* @param {number} storefront_oid
|
|
97388
|
+
* @param {number} page_oid The page oid to modify.
|
|
97389
|
+
* @param {*} [options] Override http request option.
|
|
97390
|
+
* @throws {RequiredError}
|
|
97391
|
+
* @memberof StorefrontApi
|
|
97392
|
+
*/
|
|
97393
|
+
public insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any) {
|
|
97394
|
+
return StorefrontApiFp(this.configuration).insertUpdatePageContentAttribute(page_attribute, storefront_oid, page_oid, options)(this.fetch, this.basePath);
|
|
97395
|
+
}
|
|
97396
|
+
|
|
97216
97397
|
/**
|
|
97217
97398
|
*
|
|
97218
97399
|
* @summary Prepare download of email segment
|
package/dist/api.d.ts
CHANGED
|
@@ -1748,6 +1748,7 @@ export declare namespace AutoOrderItem {
|
|
|
1748
1748
|
Every2Months,
|
|
1749
1749
|
Every3Months,
|
|
1750
1750
|
Every4Months,
|
|
1751
|
+
Every5Months,
|
|
1751
1752
|
Every6Months,
|
|
1752
1753
|
Yearly,
|
|
1753
1754
|
Every4Weeks,
|
|
@@ -1851,6 +1852,7 @@ export declare namespace AutoOrderItemSimpleSchedule {
|
|
|
1851
1852
|
Every2Months,
|
|
1852
1853
|
Every3Months,
|
|
1853
1854
|
Every4Months,
|
|
1855
|
+
Every5Months,
|
|
1854
1856
|
Every6Months,
|
|
1855
1857
|
Yearly,
|
|
1856
1858
|
Every4Weeks,
|
|
@@ -6089,6 +6091,7 @@ export declare namespace ChannelPartnerOrderItem {
|
|
|
6089
6091
|
Every2Months,
|
|
6090
6092
|
Every3Months,
|
|
6091
6093
|
Every4Months,
|
|
6094
|
+
Every5Months,
|
|
6092
6095
|
Every6Months,
|
|
6093
6096
|
Yearly,
|
|
6094
6097
|
Every4Weeks,
|
|
@@ -35589,6 +35592,18 @@ export interface OrderUtm {
|
|
|
35589
35592
|
* @memberof OrderUtm
|
|
35590
35593
|
*/
|
|
35591
35594
|
msclkid?: string;
|
|
35595
|
+
/**
|
|
35596
|
+
*
|
|
35597
|
+
* @type {string}
|
|
35598
|
+
* @memberof OrderUtm
|
|
35599
|
+
*/
|
|
35600
|
+
short_code?: string;
|
|
35601
|
+
/**
|
|
35602
|
+
*
|
|
35603
|
+
* @type {boolean}
|
|
35604
|
+
* @memberof OrderUtm
|
|
35605
|
+
*/
|
|
35606
|
+
short_code_backup?: boolean;
|
|
35592
35607
|
/**
|
|
35593
35608
|
*
|
|
35594
35609
|
* @type {string}
|
|
@@ -40575,6 +40590,37 @@ export interface StoreFront {
|
|
|
40575
40590
|
*/
|
|
40576
40591
|
unlock_password?: string;
|
|
40577
40592
|
}
|
|
40593
|
+
/**
|
|
40594
|
+
*
|
|
40595
|
+
* @export
|
|
40596
|
+
* @interface StoreFrontPageContentAttribute
|
|
40597
|
+
*/
|
|
40598
|
+
export interface StoreFrontPageContentAttribute {
|
|
40599
|
+
/**
|
|
40600
|
+
* Attribute name
|
|
40601
|
+
* @type {string}
|
|
40602
|
+
* @memberof StoreFrontPageContentAttribute
|
|
40603
|
+
*/
|
|
40604
|
+
name?: string;
|
|
40605
|
+
/**
|
|
40606
|
+
* Attribute translated text instance identifier
|
|
40607
|
+
* @type {number}
|
|
40608
|
+
* @memberof StoreFrontPageContentAttribute
|
|
40609
|
+
*/
|
|
40610
|
+
translated_text_instance_oid?: number;
|
|
40611
|
+
/**
|
|
40612
|
+
* Attribute type
|
|
40613
|
+
* @type {string}
|
|
40614
|
+
* @memberof StoreFrontPageContentAttribute
|
|
40615
|
+
*/
|
|
40616
|
+
type?: string;
|
|
40617
|
+
/**
|
|
40618
|
+
* Attribute value
|
|
40619
|
+
* @type {string}
|
|
40620
|
+
* @memberof StoreFrontPageContentAttribute
|
|
40621
|
+
*/
|
|
40622
|
+
value?: string;
|
|
40623
|
+
}
|
|
40578
40624
|
/**
|
|
40579
40625
|
*
|
|
40580
40626
|
* @export
|
|
@@ -42803,6 +42849,12 @@ export interface WebhookLog {
|
|
|
42803
42849
|
* @memberof WebhookLog
|
|
42804
42850
|
*/
|
|
42805
42851
|
uri?: string;
|
|
42852
|
+
/**
|
|
42853
|
+
* webhook oid
|
|
42854
|
+
* @type {number}
|
|
42855
|
+
* @memberof WebhookLog
|
|
42856
|
+
*/
|
|
42857
|
+
webhook_oid?: number;
|
|
42806
42858
|
}
|
|
42807
42859
|
/**
|
|
42808
42860
|
*
|
|
@@ -57913,6 +57965,16 @@ export declare const StorefrontApiFetchParamCreator: (configuration?: Configurat
|
|
|
57913
57965
|
* @throws {RequiredError}
|
|
57914
57966
|
*/
|
|
57915
57967
|
insertScreenRecordingSegment(storefront_oid: number, segment: ScreenRecordingSegment, options?: any): FetchArgs;
|
|
57968
|
+
/**
|
|
57969
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
57970
|
+
* @summary Upsert a page content attribute
|
|
57971
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
57972
|
+
* @param {number} storefront_oid
|
|
57973
|
+
* @param {number} page_oid The page oid to modify.
|
|
57974
|
+
* @param {*} [options] Override http request option.
|
|
57975
|
+
* @throws {RequiredError}
|
|
57976
|
+
*/
|
|
57977
|
+
insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any): FetchArgs;
|
|
57916
57978
|
/**
|
|
57917
57979
|
*
|
|
57918
57980
|
* @summary Prepare download of email segment
|
|
@@ -59541,6 +59603,16 @@ export declare const StorefrontApiFp: (configuration?: Configuration) => {
|
|
|
59541
59603
|
* @throws {RequiredError}
|
|
59542
59604
|
*/
|
|
59543
59605
|
insertScreenRecordingSegment(storefront_oid: number, segment: ScreenRecordingSegment, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ScreenRecordingSegmentResponse>;
|
|
59606
|
+
/**
|
|
59607
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
59608
|
+
* @summary Upsert a page content attribute
|
|
59609
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
59610
|
+
* @param {number} storefront_oid
|
|
59611
|
+
* @param {number} page_oid The page oid to modify.
|
|
59612
|
+
* @param {*} [options] Override http request option.
|
|
59613
|
+
* @throws {RequiredError}
|
|
59614
|
+
*/
|
|
59615
|
+
insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
|
|
59544
59616
|
/**
|
|
59545
59617
|
*
|
|
59546
59618
|
* @summary Prepare download of email segment
|
|
@@ -61169,6 +61241,16 @@ export declare const StorefrontApiFactory: (configuration?: Configuration, fetch
|
|
|
61169
61241
|
* @throws {RequiredError}
|
|
61170
61242
|
*/
|
|
61171
61243
|
insertScreenRecordingSegment(storefront_oid: number, segment: ScreenRecordingSegment, options?: any): Promise<ScreenRecordingSegmentResponse>;
|
|
61244
|
+
/**
|
|
61245
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
61246
|
+
* @summary Upsert a page content attribute
|
|
61247
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
61248
|
+
* @param {number} storefront_oid
|
|
61249
|
+
* @param {number} page_oid The page oid to modify.
|
|
61250
|
+
* @param {*} [options] Override http request option.
|
|
61251
|
+
* @throws {RequiredError}
|
|
61252
|
+
*/
|
|
61253
|
+
insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any): Promise<Response>;
|
|
61172
61254
|
/**
|
|
61173
61255
|
*
|
|
61174
61256
|
* @summary Prepare download of email segment
|
|
@@ -62927,6 +63009,17 @@ export interface StorefrontApiInterface {
|
|
|
62927
63009
|
* @memberof StorefrontApiInterface
|
|
62928
63010
|
*/
|
|
62929
63011
|
insertScreenRecordingSegment(storefront_oid: number, segment: ScreenRecordingSegment, options?: any): Promise<ScreenRecordingSegmentResponse>;
|
|
63012
|
+
/**
|
|
63013
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
63014
|
+
* @summary Upsert a page content attribute
|
|
63015
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
63016
|
+
* @param {number} storefront_oid
|
|
63017
|
+
* @param {number} page_oid The page oid to modify.
|
|
63018
|
+
* @param {*} [options] Override http request option.
|
|
63019
|
+
* @throws {RequiredError}
|
|
63020
|
+
* @memberof StorefrontApiInterface
|
|
63021
|
+
*/
|
|
63022
|
+
insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any): Promise<{}>;
|
|
62930
63023
|
/**
|
|
62931
63024
|
*
|
|
62932
63025
|
* @summary Prepare download of email segment
|
|
@@ -64734,6 +64827,17 @@ export declare class StorefrontApi extends BaseAPI implements StorefrontApiInter
|
|
|
64734
64827
|
* @memberof StorefrontApi
|
|
64735
64828
|
*/
|
|
64736
64829
|
insertScreenRecordingSegment(storefront_oid: number, segment: ScreenRecordingSegment, options?: any): Promise<ScreenRecordingSegmentResponse>;
|
|
64830
|
+
/**
|
|
64831
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
64832
|
+
* @summary Upsert a page content attribute
|
|
64833
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
64834
|
+
* @param {number} storefront_oid
|
|
64835
|
+
* @param {number} page_oid The page oid to modify.
|
|
64836
|
+
* @param {*} [options] Override http request option.
|
|
64837
|
+
* @throws {RequiredError}
|
|
64838
|
+
* @memberof StorefrontApi
|
|
64839
|
+
*/
|
|
64840
|
+
insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any): Promise<Response>;
|
|
64737
64841
|
/**
|
|
64738
64842
|
*
|
|
64739
64843
|
* @summary Prepare download of email segment
|
package/dist/api.js
CHANGED
|
@@ -180,6 +180,7 @@ var AutoOrderItem;
|
|
|
180
180
|
FrequencyEnum[FrequencyEnum["Every2Months"] = 'Every 2 Months'] = "Every2Months";
|
|
181
181
|
FrequencyEnum[FrequencyEnum["Every3Months"] = 'Every 3 Months'] = "Every3Months";
|
|
182
182
|
FrequencyEnum[FrequencyEnum["Every4Months"] = 'Every 4 Months'] = "Every4Months";
|
|
183
|
+
FrequencyEnum[FrequencyEnum["Every5Months"] = 'Every 5 Months'] = "Every5Months";
|
|
183
184
|
FrequencyEnum[FrequencyEnum["Every6Months"] = 'Every 6 Months'] = "Every6Months";
|
|
184
185
|
FrequencyEnum[FrequencyEnum["Yearly"] = 'Yearly'] = "Yearly";
|
|
185
186
|
FrequencyEnum[FrequencyEnum["Every4Weeks"] = 'Every 4 Weeks'] = "Every4Weeks";
|
|
@@ -210,6 +211,7 @@ var AutoOrderItemSimpleSchedule;
|
|
|
210
211
|
FrequencyEnum[FrequencyEnum["Every2Months"] = 'Every 2 Months'] = "Every2Months";
|
|
211
212
|
FrequencyEnum[FrequencyEnum["Every3Months"] = 'Every 3 Months'] = "Every3Months";
|
|
212
213
|
FrequencyEnum[FrequencyEnum["Every4Months"] = 'Every 4 Months'] = "Every4Months";
|
|
214
|
+
FrequencyEnum[FrequencyEnum["Every5Months"] = 'Every 5 Months'] = "Every5Months";
|
|
213
215
|
FrequencyEnum[FrequencyEnum["Every6Months"] = 'Every 6 Months'] = "Every6Months";
|
|
214
216
|
FrequencyEnum[FrequencyEnum["Yearly"] = 'Yearly'] = "Yearly";
|
|
215
217
|
FrequencyEnum[FrequencyEnum["Every4Weeks"] = 'Every 4 Weeks'] = "Every4Weeks";
|
|
@@ -362,6 +364,7 @@ var ChannelPartnerOrderItem;
|
|
|
362
364
|
AutoOrderScheduleEnum[AutoOrderScheduleEnum["Every2Months"] = 'Every 2 Months'] = "Every2Months";
|
|
363
365
|
AutoOrderScheduleEnum[AutoOrderScheduleEnum["Every3Months"] = 'Every 3 Months'] = "Every3Months";
|
|
364
366
|
AutoOrderScheduleEnum[AutoOrderScheduleEnum["Every4Months"] = 'Every 4 Months'] = "Every4Months";
|
|
367
|
+
AutoOrderScheduleEnum[AutoOrderScheduleEnum["Every5Months"] = 'Every 5 Months'] = "Every5Months";
|
|
365
368
|
AutoOrderScheduleEnum[AutoOrderScheduleEnum["Every6Months"] = 'Every 6 Months'] = "Every6Months";
|
|
366
369
|
AutoOrderScheduleEnum[AutoOrderScheduleEnum["Yearly"] = 'Yearly'] = "Yearly";
|
|
367
370
|
AutoOrderScheduleEnum[AutoOrderScheduleEnum["Every4Weeks"] = 'Every 4 Weeks'] = "Every4Weeks";
|
|
@@ -35299,6 +35302,66 @@ var StorefrontApiFetchParamCreator = function (configuration) {
|
|
|
35299
35302
|
options: localVarRequestOptions,
|
|
35300
35303
|
};
|
|
35301
35304
|
},
|
|
35305
|
+
/**
|
|
35306
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
35307
|
+
* @summary Upsert a page content attribute
|
|
35308
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
35309
|
+
* @param {number} storefront_oid
|
|
35310
|
+
* @param {number} page_oid The page oid to modify.
|
|
35311
|
+
* @param {*} [options] Override http request option.
|
|
35312
|
+
* @throws {RequiredError}
|
|
35313
|
+
*/
|
|
35314
|
+
insertUpdatePageContentAttribute: function (page_attribute, storefront_oid, page_oid, options) {
|
|
35315
|
+
if (options === void 0) { options = {}; }
|
|
35316
|
+
// verify required parameter 'page_attribute' is not null or undefined
|
|
35317
|
+
if (page_attribute === null || page_attribute === undefined) {
|
|
35318
|
+
throw new RequiredError('page_attribute', 'Required parameter page_attribute was null or undefined when calling insertUpdatePageContentAttribute.');
|
|
35319
|
+
}
|
|
35320
|
+
// verify required parameter 'storefront_oid' is not null or undefined
|
|
35321
|
+
if (storefront_oid === null || storefront_oid === undefined) {
|
|
35322
|
+
throw new RequiredError('storefront_oid', 'Required parameter storefront_oid was null or undefined when calling insertUpdatePageContentAttribute.');
|
|
35323
|
+
}
|
|
35324
|
+
// verify required parameter 'page_oid' is not null or undefined
|
|
35325
|
+
if (page_oid === null || page_oid === undefined) {
|
|
35326
|
+
throw new RequiredError('page_oid', 'Required parameter page_oid was null or undefined when calling insertUpdatePageContentAttribute.');
|
|
35327
|
+
}
|
|
35328
|
+
var localVarPath = "/storefront/{storefront_oid}/pages/{page_oid}/content/attributes"
|
|
35329
|
+
.replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(storefront_oid)))
|
|
35330
|
+
.replace("{".concat("page_oid", "}"), encodeURIComponent(String(page_oid)));
|
|
35331
|
+
var localVarUrlObj = url.parse(localVarPath, true);
|
|
35332
|
+
var localVarRequestOptions = Object.assign({ method: 'POST' }, options);
|
|
35333
|
+
var localVarHeaderParameter = {};
|
|
35334
|
+
var localVarQueryParameter = {};
|
|
35335
|
+
if (configuration && configuration.apiVersion) {
|
|
35336
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
35337
|
+
}
|
|
35338
|
+
// authentication ultraCartOauth required
|
|
35339
|
+
// oauth required
|
|
35340
|
+
if (configuration && configuration.accessToken) {
|
|
35341
|
+
var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
35342
|
+
? configuration.accessToken("ultraCartOauth", ["storefront_write"])
|
|
35343
|
+
: configuration.accessToken;
|
|
35344
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
35345
|
+
}
|
|
35346
|
+
// authentication ultraCartSimpleApiKey required
|
|
35347
|
+
if (configuration && configuration.apiKey) {
|
|
35348
|
+
var localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
35349
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
35350
|
+
: configuration.apiKey;
|
|
35351
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
35352
|
+
}
|
|
35353
|
+
localVarHeaderParameter['Content-Type'] = 'application/json; charset=UTF-8';
|
|
35354
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
35355
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
35356
|
+
delete localVarUrlObj.search;
|
|
35357
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
35358
|
+
var needsSerialization = ("StoreFrontPageContentAttribute" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
|
|
35359
|
+
localVarRequestOptions.body = needsSerialization ? JSON.stringify(page_attribute || {}) : (page_attribute || "");
|
|
35360
|
+
return {
|
|
35361
|
+
url: url.format(localVarUrlObj),
|
|
35362
|
+
options: localVarRequestOptions,
|
|
35363
|
+
};
|
|
35364
|
+
},
|
|
35302
35365
|
/**
|
|
35303
35366
|
*
|
|
35304
35367
|
* @summary Prepare download of email segment
|
|
@@ -41293,6 +41356,30 @@ var StorefrontApiFp = function (configuration) {
|
|
|
41293
41356
|
});
|
|
41294
41357
|
};
|
|
41295
41358
|
},
|
|
41359
|
+
/**
|
|
41360
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
41361
|
+
* @summary Upsert a page content attribute
|
|
41362
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
41363
|
+
* @param {number} storefront_oid
|
|
41364
|
+
* @param {number} page_oid The page oid to modify.
|
|
41365
|
+
* @param {*} [options] Override http request option.
|
|
41366
|
+
* @throws {RequiredError}
|
|
41367
|
+
*/
|
|
41368
|
+
insertUpdatePageContentAttribute: function (page_attribute, storefront_oid, page_oid, options) {
|
|
41369
|
+
var localVarFetchArgs = (0, exports.StorefrontApiFetchParamCreator)(configuration).insertUpdatePageContentAttribute(page_attribute, storefront_oid, page_oid, options);
|
|
41370
|
+
return function (fetch, basePath) {
|
|
41371
|
+
if (fetch === void 0) { fetch = portableFetch; }
|
|
41372
|
+
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
41373
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
|
|
41374
|
+
if (response.status >= 200 && response.status < 300) {
|
|
41375
|
+
return response;
|
|
41376
|
+
}
|
|
41377
|
+
else {
|
|
41378
|
+
throw response;
|
|
41379
|
+
}
|
|
41380
|
+
});
|
|
41381
|
+
};
|
|
41382
|
+
},
|
|
41296
41383
|
/**
|
|
41297
41384
|
*
|
|
41298
41385
|
* @summary Prepare download of email segment
|
|
@@ -43854,6 +43941,18 @@ var StorefrontApiFactory = function (configuration, fetch, basePath) {
|
|
|
43854
43941
|
insertScreenRecordingSegment: function (storefront_oid, segment, options) {
|
|
43855
43942
|
return (0, exports.StorefrontApiFp)(configuration).insertScreenRecordingSegment(storefront_oid, segment, options)(fetch, basePath);
|
|
43856
43943
|
},
|
|
43944
|
+
/**
|
|
43945
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
43946
|
+
* @summary Upsert a page content attribute
|
|
43947
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
43948
|
+
* @param {number} storefront_oid
|
|
43949
|
+
* @param {number} page_oid The page oid to modify.
|
|
43950
|
+
* @param {*} [options] Override http request option.
|
|
43951
|
+
* @throws {RequiredError}
|
|
43952
|
+
*/
|
|
43953
|
+
insertUpdatePageContentAttribute: function (page_attribute, storefront_oid, page_oid, options) {
|
|
43954
|
+
return (0, exports.StorefrontApiFp)(configuration).insertUpdatePageContentAttribute(page_attribute, storefront_oid, page_oid, options)(fetch, basePath);
|
|
43955
|
+
},
|
|
43857
43956
|
/**
|
|
43858
43957
|
*
|
|
43859
43958
|
* @summary Prepare download of email segment
|
|
@@ -45973,6 +46072,19 @@ var StorefrontApi = /** @class */ (function (_super) {
|
|
|
45973
46072
|
StorefrontApi.prototype.insertScreenRecordingSegment = function (storefront_oid, segment, options) {
|
|
45974
46073
|
return (0, exports.StorefrontApiFp)(this.configuration).insertScreenRecordingSegment(storefront_oid, segment, options)(this.fetch, this.basePath);
|
|
45975
46074
|
};
|
|
46075
|
+
/**
|
|
46076
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
46077
|
+
* @summary Upsert a page content attribute
|
|
46078
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
46079
|
+
* @param {number} storefront_oid
|
|
46080
|
+
* @param {number} page_oid The page oid to modify.
|
|
46081
|
+
* @param {*} [options] Override http request option.
|
|
46082
|
+
* @throws {RequiredError}
|
|
46083
|
+
* @memberof StorefrontApi
|
|
46084
|
+
*/
|
|
46085
|
+
StorefrontApi.prototype.insertUpdatePageContentAttribute = function (page_attribute, storefront_oid, page_oid, options) {
|
|
46086
|
+
return (0, exports.StorefrontApiFp)(this.configuration).insertUpdatePageContentAttribute(page_attribute, storefront_oid, page_oid, options)(this.fetch, this.basePath);
|
|
46087
|
+
};
|
|
45976
46088
|
/**
|
|
45977
46089
|
*
|
|
45978
46090
|
* @summary Prepare download of email segment
|