ultracart_rest_api_v2_typescript 3.10.215 → 3.10.217
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 +175 -1
- package/dist/api.d.ts +98 -1
- package/dist/api.js +111 -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.217
|
|
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.217 --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.217 | 10/24/2024 | storefront page attribute edit method |
|
|
58
|
+
| 3.10.216 | 09/18/2024 | order payment constant for PayPal Fastlane |
|
|
57
59
|
| 3.10.215 | 08/29/2024 | add hold_for_transmission to item shipping object |
|
|
58
60
|
| 3.10.214 | 08/08/2024 | added query_target to OrderApi.getOrdersBatch to allow cache usage |
|
|
59
61
|
| 3.10.213 | 06/24/2024 | conversation object cleanup |
|
package/api.ts
CHANGED
|
@@ -36343,6 +36343,18 @@ export interface OrderUtm {
|
|
|
36343
36343
|
* @memberof OrderUtm
|
|
36344
36344
|
*/
|
|
36345
36345
|
msclkid?: string;
|
|
36346
|
+
/**
|
|
36347
|
+
*
|
|
36348
|
+
* @type {string}
|
|
36349
|
+
* @memberof OrderUtm
|
|
36350
|
+
*/
|
|
36351
|
+
short_code?: string;
|
|
36352
|
+
/**
|
|
36353
|
+
*
|
|
36354
|
+
* @type {boolean}
|
|
36355
|
+
* @memberof OrderUtm
|
|
36356
|
+
*/
|
|
36357
|
+
short_code_backup?: boolean;
|
|
36346
36358
|
/**
|
|
36347
36359
|
*
|
|
36348
36360
|
* @type {string}
|
|
@@ -41446,6 +41458,38 @@ export interface StoreFront {
|
|
|
41446
41458
|
unlock_password?: string;
|
|
41447
41459
|
}
|
|
41448
41460
|
|
|
41461
|
+
/**
|
|
41462
|
+
*
|
|
41463
|
+
* @export
|
|
41464
|
+
* @interface StoreFrontPageContentAttribute
|
|
41465
|
+
*/
|
|
41466
|
+
export interface StoreFrontPageContentAttribute {
|
|
41467
|
+
/**
|
|
41468
|
+
* Attribute name
|
|
41469
|
+
* @type {string}
|
|
41470
|
+
* @memberof StoreFrontPageContentAttribute
|
|
41471
|
+
*/
|
|
41472
|
+
name?: string;
|
|
41473
|
+
/**
|
|
41474
|
+
* Attribute translated text instance identifier
|
|
41475
|
+
* @type {number}
|
|
41476
|
+
* @memberof StoreFrontPageContentAttribute
|
|
41477
|
+
*/
|
|
41478
|
+
translated_text_instance_oid?: number;
|
|
41479
|
+
/**
|
|
41480
|
+
* Attribute type
|
|
41481
|
+
* @type {string}
|
|
41482
|
+
* @memberof StoreFrontPageContentAttribute
|
|
41483
|
+
*/
|
|
41484
|
+
type?: string;
|
|
41485
|
+
/**
|
|
41486
|
+
* Attribute value
|
|
41487
|
+
* @type {string}
|
|
41488
|
+
* @memberof StoreFrontPageContentAttribute
|
|
41489
|
+
*/
|
|
41490
|
+
value?: string;
|
|
41491
|
+
}
|
|
41492
|
+
|
|
41449
41493
|
/**
|
|
41450
41494
|
*
|
|
41451
41495
|
* @export
|
|
@@ -43539,7 +43583,9 @@ export namespace Webhook {
|
|
|
43539
43583
|
*/
|
|
43540
43584
|
export enum AuthenticationTypeEnum {
|
|
43541
43585
|
None = <any> 'none',
|
|
43542
|
-
Basic = <any> 'basic'
|
|
43586
|
+
Basic = <any> 'basic',
|
|
43587
|
+
ApiUser = <any> 'api user',
|
|
43588
|
+
AwsIam = <any> 'aws iam'
|
|
43543
43589
|
}
|
|
43544
43590
|
}
|
|
43545
43591
|
|
|
@@ -84218,6 +84264,73 @@ export const StorefrontApiFetchParamCreator = function (configuration?: Configur
|
|
|
84218
84264
|
options: localVarRequestOptions,
|
|
84219
84265
|
};
|
|
84220
84266
|
},
|
|
84267
|
+
/**
|
|
84268
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
84269
|
+
* @summary Upsert a page content attribute
|
|
84270
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
84271
|
+
* @param {number} storefront_oid
|
|
84272
|
+
* @param {number} page_oid The page oid to modify.
|
|
84273
|
+
* @param {*} [options] Override http request option.
|
|
84274
|
+
* @throws {RequiredError}
|
|
84275
|
+
*/
|
|
84276
|
+
insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options: any = {}): FetchArgs {
|
|
84277
|
+
// verify required parameter 'page_attribute' is not null or undefined
|
|
84278
|
+
if (page_attribute === null || page_attribute === undefined) {
|
|
84279
|
+
throw new RequiredError('page_attribute','Required parameter page_attribute was null or undefined when calling insertUpdatePageContentAttribute.');
|
|
84280
|
+
}
|
|
84281
|
+
// verify required parameter 'storefront_oid' is not null or undefined
|
|
84282
|
+
if (storefront_oid === null || storefront_oid === undefined) {
|
|
84283
|
+
throw new RequiredError('storefront_oid','Required parameter storefront_oid was null or undefined when calling insertUpdatePageContentAttribute.');
|
|
84284
|
+
}
|
|
84285
|
+
// verify required parameter 'page_oid' is not null or undefined
|
|
84286
|
+
if (page_oid === null || page_oid === undefined) {
|
|
84287
|
+
throw new RequiredError('page_oid','Required parameter page_oid was null or undefined when calling insertUpdatePageContentAttribute.');
|
|
84288
|
+
}
|
|
84289
|
+
const localVarPath = `/storefront/{storefront_oid}/pages/{page_oid}/content/attributes`
|
|
84290
|
+
.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(storefront_oid)))
|
|
84291
|
+
.replace(`{${"page_oid"}}`, encodeURIComponent(String(page_oid)));
|
|
84292
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
84293
|
+
const localVarRequestOptions = Object.assign({ method: 'POST' }, options);
|
|
84294
|
+
const localVarHeaderParameter = {} as any;
|
|
84295
|
+
const localVarQueryParameter = {} as any;
|
|
84296
|
+
|
|
84297
|
+
if(configuration && configuration.apiVersion) {
|
|
84298
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
84299
|
+
}
|
|
84300
|
+
|
|
84301
|
+
|
|
84302
|
+
|
|
84303
|
+
// authentication ultraCartOauth required
|
|
84304
|
+
// oauth required
|
|
84305
|
+
if (configuration && configuration.accessToken) {
|
|
84306
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
84307
|
+
? configuration.accessToken("ultraCartOauth", ["storefront_write"])
|
|
84308
|
+
: configuration.accessToken;
|
|
84309
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
84310
|
+
}
|
|
84311
|
+
|
|
84312
|
+
// authentication ultraCartSimpleApiKey required
|
|
84313
|
+
if (configuration && configuration.apiKey) {
|
|
84314
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
84315
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
84316
|
+
: configuration.apiKey;
|
|
84317
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
84318
|
+
}
|
|
84319
|
+
|
|
84320
|
+
localVarHeaderParameter['Content-Type'] = 'application/json; charset=UTF-8';
|
|
84321
|
+
|
|
84322
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
84323
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
84324
|
+
delete localVarUrlObj.search;
|
|
84325
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
84326
|
+
const needsSerialization = (<any>"StoreFrontPageContentAttribute" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
|
|
84327
|
+
localVarRequestOptions.body = needsSerialization ? JSON.stringify(page_attribute || {}) : (page_attribute || "");
|
|
84328
|
+
|
|
84329
|
+
return {
|
|
84330
|
+
url: url.format(localVarUrlObj),
|
|
84331
|
+
options: localVarRequestOptions,
|
|
84332
|
+
};
|
|
84333
|
+
},
|
|
84221
84334
|
/**
|
|
84222
84335
|
*
|
|
84223
84336
|
* @summary Prepare download of email segment
|
|
@@ -90470,6 +90583,29 @@ export const StorefrontApiFp = function(configuration?: Configuration) {
|
|
|
90470
90583
|
});
|
|
90471
90584
|
};
|
|
90472
90585
|
},
|
|
90586
|
+
/**
|
|
90587
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
90588
|
+
* @summary Upsert a page content attribute
|
|
90589
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
90590
|
+
* @param {number} storefront_oid
|
|
90591
|
+
* @param {number} page_oid The page oid to modify.
|
|
90592
|
+
* @param {*} [options] Override http request option.
|
|
90593
|
+
* @throws {RequiredError}
|
|
90594
|
+
*/
|
|
90595
|
+
insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response> {
|
|
90596
|
+
const localVarFetchArgs = StorefrontApiFetchParamCreator(configuration).insertUpdatePageContentAttribute(page_attribute, storefront_oid, page_oid, options);
|
|
90597
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
90598
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
90599
|
+
|
|
90600
|
+
if (response.status >= 200 && response.status < 300) {
|
|
90601
|
+
return response;
|
|
90602
|
+
|
|
90603
|
+
} else {
|
|
90604
|
+
throw response;
|
|
90605
|
+
}
|
|
90606
|
+
});
|
|
90607
|
+
};
|
|
90608
|
+
},
|
|
90473
90609
|
/**
|
|
90474
90610
|
*
|
|
90475
90611
|
* @summary Prepare download of email segment
|
|
@@ -92983,6 +93119,18 @@ export const StorefrontApiFactory = function (configuration?: Configuration, fet
|
|
|
92983
93119
|
insertScreenRecordingSegment(storefront_oid: number, segment: ScreenRecordingSegment, options?: any) {
|
|
92984
93120
|
return StorefrontApiFp(configuration).insertScreenRecordingSegment(storefront_oid, segment, options)(fetch, basePath);
|
|
92985
93121
|
},
|
|
93122
|
+
/**
|
|
93123
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
93124
|
+
* @summary Upsert a page content attribute
|
|
93125
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
93126
|
+
* @param {number} storefront_oid
|
|
93127
|
+
* @param {number} page_oid The page oid to modify.
|
|
93128
|
+
* @param {*} [options] Override http request option.
|
|
93129
|
+
* @throws {RequiredError}
|
|
93130
|
+
*/
|
|
93131
|
+
insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any) {
|
|
93132
|
+
return StorefrontApiFp(configuration).insertUpdatePageContentAttribute(page_attribute, storefront_oid, page_oid, options)(fetch, basePath);
|
|
93133
|
+
},
|
|
92986
93134
|
/**
|
|
92987
93135
|
*
|
|
92988
93136
|
* @summary Prepare download of email segment
|
|
@@ -94968,6 +95116,18 @@ export interface StorefrontApiInterface {
|
|
|
94968
95116
|
*/
|
|
94969
95117
|
insertScreenRecordingSegment(storefront_oid: number, segment: ScreenRecordingSegment, options?: any): Promise<ScreenRecordingSegmentResponse>;
|
|
94970
95118
|
|
|
95119
|
+
/**
|
|
95120
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
95121
|
+
* @summary Upsert a page content attribute
|
|
95122
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
95123
|
+
* @param {number} storefront_oid
|
|
95124
|
+
* @param {number} page_oid The page oid to modify.
|
|
95125
|
+
* @param {*} [options] Override http request option.
|
|
95126
|
+
* @throws {RequiredError}
|
|
95127
|
+
* @memberof StorefrontApiInterface
|
|
95128
|
+
*/
|
|
95129
|
+
insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any): Promise<{}>;
|
|
95130
|
+
|
|
94971
95131
|
/**
|
|
94972
95132
|
*
|
|
94973
95133
|
* @summary Prepare download of email segment
|
|
@@ -97211,6 +97371,20 @@ export class StorefrontApi extends BaseAPI implements StorefrontApiInterface {
|
|
|
97211
97371
|
return StorefrontApiFp(this.configuration).insertScreenRecordingSegment(storefront_oid, segment, options)(this.fetch, this.basePath);
|
|
97212
97372
|
}
|
|
97213
97373
|
|
|
97374
|
+
/**
|
|
97375
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
97376
|
+
* @summary Upsert a page content attribute
|
|
97377
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
97378
|
+
* @param {number} storefront_oid
|
|
97379
|
+
* @param {number} page_oid The page oid to modify.
|
|
97380
|
+
* @param {*} [options] Override http request option.
|
|
97381
|
+
* @throws {RequiredError}
|
|
97382
|
+
* @memberof StorefrontApi
|
|
97383
|
+
*/
|
|
97384
|
+
public insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any) {
|
|
97385
|
+
return StorefrontApiFp(this.configuration).insertUpdatePageContentAttribute(page_attribute, storefront_oid, page_oid, options)(this.fetch, this.basePath);
|
|
97386
|
+
}
|
|
97387
|
+
|
|
97214
97388
|
/**
|
|
97215
97389
|
*
|
|
97216
97390
|
* @summary Prepare download of email segment
|
package/dist/api.d.ts
CHANGED
|
@@ -35589,6 +35589,18 @@ export interface OrderUtm {
|
|
|
35589
35589
|
* @memberof OrderUtm
|
|
35590
35590
|
*/
|
|
35591
35591
|
msclkid?: string;
|
|
35592
|
+
/**
|
|
35593
|
+
*
|
|
35594
|
+
* @type {string}
|
|
35595
|
+
* @memberof OrderUtm
|
|
35596
|
+
*/
|
|
35597
|
+
short_code?: string;
|
|
35598
|
+
/**
|
|
35599
|
+
*
|
|
35600
|
+
* @type {boolean}
|
|
35601
|
+
* @memberof OrderUtm
|
|
35602
|
+
*/
|
|
35603
|
+
short_code_backup?: boolean;
|
|
35592
35604
|
/**
|
|
35593
35605
|
*
|
|
35594
35606
|
* @type {string}
|
|
@@ -40575,6 +40587,37 @@ export interface StoreFront {
|
|
|
40575
40587
|
*/
|
|
40576
40588
|
unlock_password?: string;
|
|
40577
40589
|
}
|
|
40590
|
+
/**
|
|
40591
|
+
*
|
|
40592
|
+
* @export
|
|
40593
|
+
* @interface StoreFrontPageContentAttribute
|
|
40594
|
+
*/
|
|
40595
|
+
export interface StoreFrontPageContentAttribute {
|
|
40596
|
+
/**
|
|
40597
|
+
* Attribute name
|
|
40598
|
+
* @type {string}
|
|
40599
|
+
* @memberof StoreFrontPageContentAttribute
|
|
40600
|
+
*/
|
|
40601
|
+
name?: string;
|
|
40602
|
+
/**
|
|
40603
|
+
* Attribute translated text instance identifier
|
|
40604
|
+
* @type {number}
|
|
40605
|
+
* @memberof StoreFrontPageContentAttribute
|
|
40606
|
+
*/
|
|
40607
|
+
translated_text_instance_oid?: number;
|
|
40608
|
+
/**
|
|
40609
|
+
* Attribute type
|
|
40610
|
+
* @type {string}
|
|
40611
|
+
* @memberof StoreFrontPageContentAttribute
|
|
40612
|
+
*/
|
|
40613
|
+
type?: string;
|
|
40614
|
+
/**
|
|
40615
|
+
* Attribute value
|
|
40616
|
+
* @type {string}
|
|
40617
|
+
* @memberof StoreFrontPageContentAttribute
|
|
40618
|
+
*/
|
|
40619
|
+
value?: string;
|
|
40620
|
+
}
|
|
40578
40621
|
/**
|
|
40579
40622
|
*
|
|
40580
40623
|
* @export
|
|
@@ -42622,7 +42665,9 @@ export declare namespace Webhook {
|
|
|
42622
42665
|
*/
|
|
42623
42666
|
enum AuthenticationTypeEnum {
|
|
42624
42667
|
None,
|
|
42625
|
-
Basic
|
|
42668
|
+
Basic,
|
|
42669
|
+
ApiUser,
|
|
42670
|
+
AwsIam
|
|
42626
42671
|
}
|
|
42627
42672
|
}
|
|
42628
42673
|
/**
|
|
@@ -57911,6 +57956,16 @@ export declare const StorefrontApiFetchParamCreator: (configuration?: Configurat
|
|
|
57911
57956
|
* @throws {RequiredError}
|
|
57912
57957
|
*/
|
|
57913
57958
|
insertScreenRecordingSegment(storefront_oid: number, segment: ScreenRecordingSegment, options?: any): FetchArgs;
|
|
57959
|
+
/**
|
|
57960
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
57961
|
+
* @summary Upsert a page content attribute
|
|
57962
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
57963
|
+
* @param {number} storefront_oid
|
|
57964
|
+
* @param {number} page_oid The page oid to modify.
|
|
57965
|
+
* @param {*} [options] Override http request option.
|
|
57966
|
+
* @throws {RequiredError}
|
|
57967
|
+
*/
|
|
57968
|
+
insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any): FetchArgs;
|
|
57914
57969
|
/**
|
|
57915
57970
|
*
|
|
57916
57971
|
* @summary Prepare download of email segment
|
|
@@ -59539,6 +59594,16 @@ export declare const StorefrontApiFp: (configuration?: Configuration) => {
|
|
|
59539
59594
|
* @throws {RequiredError}
|
|
59540
59595
|
*/
|
|
59541
59596
|
insertScreenRecordingSegment(storefront_oid: number, segment: ScreenRecordingSegment, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ScreenRecordingSegmentResponse>;
|
|
59597
|
+
/**
|
|
59598
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
59599
|
+
* @summary Upsert a page content attribute
|
|
59600
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
59601
|
+
* @param {number} storefront_oid
|
|
59602
|
+
* @param {number} page_oid The page oid to modify.
|
|
59603
|
+
* @param {*} [options] Override http request option.
|
|
59604
|
+
* @throws {RequiredError}
|
|
59605
|
+
*/
|
|
59606
|
+
insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
|
|
59542
59607
|
/**
|
|
59543
59608
|
*
|
|
59544
59609
|
* @summary Prepare download of email segment
|
|
@@ -61167,6 +61232,16 @@ export declare const StorefrontApiFactory: (configuration?: Configuration, fetch
|
|
|
61167
61232
|
* @throws {RequiredError}
|
|
61168
61233
|
*/
|
|
61169
61234
|
insertScreenRecordingSegment(storefront_oid: number, segment: ScreenRecordingSegment, options?: any): Promise<ScreenRecordingSegmentResponse>;
|
|
61235
|
+
/**
|
|
61236
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
61237
|
+
* @summary Upsert a page content attribute
|
|
61238
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
61239
|
+
* @param {number} storefront_oid
|
|
61240
|
+
* @param {number} page_oid The page oid to modify.
|
|
61241
|
+
* @param {*} [options] Override http request option.
|
|
61242
|
+
* @throws {RequiredError}
|
|
61243
|
+
*/
|
|
61244
|
+
insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any): Promise<Response>;
|
|
61170
61245
|
/**
|
|
61171
61246
|
*
|
|
61172
61247
|
* @summary Prepare download of email segment
|
|
@@ -62925,6 +63000,17 @@ export interface StorefrontApiInterface {
|
|
|
62925
63000
|
* @memberof StorefrontApiInterface
|
|
62926
63001
|
*/
|
|
62927
63002
|
insertScreenRecordingSegment(storefront_oid: number, segment: ScreenRecordingSegment, options?: any): Promise<ScreenRecordingSegmentResponse>;
|
|
63003
|
+
/**
|
|
63004
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
63005
|
+
* @summary Upsert a page content attribute
|
|
63006
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
63007
|
+
* @param {number} storefront_oid
|
|
63008
|
+
* @param {number} page_oid The page oid to modify.
|
|
63009
|
+
* @param {*} [options] Override http request option.
|
|
63010
|
+
* @throws {RequiredError}
|
|
63011
|
+
* @memberof StorefrontApiInterface
|
|
63012
|
+
*/
|
|
63013
|
+
insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any): Promise<{}>;
|
|
62928
63014
|
/**
|
|
62929
63015
|
*
|
|
62930
63016
|
* @summary Prepare download of email segment
|
|
@@ -64732,6 +64818,17 @@ export declare class StorefrontApi extends BaseAPI implements StorefrontApiInter
|
|
|
64732
64818
|
* @memberof StorefrontApi
|
|
64733
64819
|
*/
|
|
64734
64820
|
insertScreenRecordingSegment(storefront_oid: number, segment: ScreenRecordingSegment, options?: any): Promise<ScreenRecordingSegmentResponse>;
|
|
64821
|
+
/**
|
|
64822
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
64823
|
+
* @summary Upsert a page content attribute
|
|
64824
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
64825
|
+
* @param {number} storefront_oid
|
|
64826
|
+
* @param {number} page_oid The page oid to modify.
|
|
64827
|
+
* @param {*} [options] Override http request option.
|
|
64828
|
+
* @throws {RequiredError}
|
|
64829
|
+
* @memberof StorefrontApi
|
|
64830
|
+
*/
|
|
64831
|
+
insertUpdatePageContentAttribute(page_attribute: StoreFrontPageContentAttribute, storefront_oid: number, page_oid: number, options?: any): Promise<Response>;
|
|
64735
64832
|
/**
|
|
64736
64833
|
*
|
|
64737
64834
|
* @summary Prepare download of email segment
|
package/dist/api.js
CHANGED
|
@@ -1740,6 +1740,8 @@ var Webhook;
|
|
|
1740
1740
|
(function (AuthenticationTypeEnum) {
|
|
1741
1741
|
AuthenticationTypeEnum[AuthenticationTypeEnum["None"] = 'none'] = "None";
|
|
1742
1742
|
AuthenticationTypeEnum[AuthenticationTypeEnum["Basic"] = 'basic'] = "Basic";
|
|
1743
|
+
AuthenticationTypeEnum[AuthenticationTypeEnum["ApiUser"] = 'api user'] = "ApiUser";
|
|
1744
|
+
AuthenticationTypeEnum[AuthenticationTypeEnum["AwsIam"] = 'aws iam'] = "AwsIam";
|
|
1743
1745
|
})(AuthenticationTypeEnum = Webhook.AuthenticationTypeEnum || (Webhook.AuthenticationTypeEnum = {}));
|
|
1744
1746
|
})(Webhook = exports.Webhook || (exports.Webhook = {}));
|
|
1745
1747
|
/**
|
|
@@ -35297,6 +35299,66 @@ var StorefrontApiFetchParamCreator = function (configuration) {
|
|
|
35297
35299
|
options: localVarRequestOptions,
|
|
35298
35300
|
};
|
|
35299
35301
|
},
|
|
35302
|
+
/**
|
|
35303
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
35304
|
+
* @summary Upsert a page content attribute
|
|
35305
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
35306
|
+
* @param {number} storefront_oid
|
|
35307
|
+
* @param {number} page_oid The page oid to modify.
|
|
35308
|
+
* @param {*} [options] Override http request option.
|
|
35309
|
+
* @throws {RequiredError}
|
|
35310
|
+
*/
|
|
35311
|
+
insertUpdatePageContentAttribute: function (page_attribute, storefront_oid, page_oid, options) {
|
|
35312
|
+
if (options === void 0) { options = {}; }
|
|
35313
|
+
// verify required parameter 'page_attribute' is not null or undefined
|
|
35314
|
+
if (page_attribute === null || page_attribute === undefined) {
|
|
35315
|
+
throw new RequiredError('page_attribute', 'Required parameter page_attribute was null or undefined when calling insertUpdatePageContentAttribute.');
|
|
35316
|
+
}
|
|
35317
|
+
// verify required parameter 'storefront_oid' is not null or undefined
|
|
35318
|
+
if (storefront_oid === null || storefront_oid === undefined) {
|
|
35319
|
+
throw new RequiredError('storefront_oid', 'Required parameter storefront_oid was null or undefined when calling insertUpdatePageContentAttribute.');
|
|
35320
|
+
}
|
|
35321
|
+
// verify required parameter 'page_oid' is not null or undefined
|
|
35322
|
+
if (page_oid === null || page_oid === undefined) {
|
|
35323
|
+
throw new RequiredError('page_oid', 'Required parameter page_oid was null or undefined when calling insertUpdatePageContentAttribute.');
|
|
35324
|
+
}
|
|
35325
|
+
var localVarPath = "/storefront/{storefront_oid}/pages/{page_oid}/content/attributes"
|
|
35326
|
+
.replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(storefront_oid)))
|
|
35327
|
+
.replace("{".concat("page_oid", "}"), encodeURIComponent(String(page_oid)));
|
|
35328
|
+
var localVarUrlObj = url.parse(localVarPath, true);
|
|
35329
|
+
var localVarRequestOptions = Object.assign({ method: 'POST' }, options);
|
|
35330
|
+
var localVarHeaderParameter = {};
|
|
35331
|
+
var localVarQueryParameter = {};
|
|
35332
|
+
if (configuration && configuration.apiVersion) {
|
|
35333
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
35334
|
+
}
|
|
35335
|
+
// authentication ultraCartOauth required
|
|
35336
|
+
// oauth required
|
|
35337
|
+
if (configuration && configuration.accessToken) {
|
|
35338
|
+
var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
35339
|
+
? configuration.accessToken("ultraCartOauth", ["storefront_write"])
|
|
35340
|
+
: configuration.accessToken;
|
|
35341
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
35342
|
+
}
|
|
35343
|
+
// authentication ultraCartSimpleApiKey required
|
|
35344
|
+
if (configuration && configuration.apiKey) {
|
|
35345
|
+
var localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
35346
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
35347
|
+
: configuration.apiKey;
|
|
35348
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
35349
|
+
}
|
|
35350
|
+
localVarHeaderParameter['Content-Type'] = 'application/json; charset=UTF-8';
|
|
35351
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
35352
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
35353
|
+
delete localVarUrlObj.search;
|
|
35354
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
35355
|
+
var needsSerialization = ("StoreFrontPageContentAttribute" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
|
|
35356
|
+
localVarRequestOptions.body = needsSerialization ? JSON.stringify(page_attribute || {}) : (page_attribute || "");
|
|
35357
|
+
return {
|
|
35358
|
+
url: url.format(localVarUrlObj),
|
|
35359
|
+
options: localVarRequestOptions,
|
|
35360
|
+
};
|
|
35361
|
+
},
|
|
35300
35362
|
/**
|
|
35301
35363
|
*
|
|
35302
35364
|
* @summary Prepare download of email segment
|
|
@@ -41291,6 +41353,30 @@ var StorefrontApiFp = function (configuration) {
|
|
|
41291
41353
|
});
|
|
41292
41354
|
};
|
|
41293
41355
|
},
|
|
41356
|
+
/**
|
|
41357
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
41358
|
+
* @summary Upsert a page content attribute
|
|
41359
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
41360
|
+
* @param {number} storefront_oid
|
|
41361
|
+
* @param {number} page_oid The page oid to modify.
|
|
41362
|
+
* @param {*} [options] Override http request option.
|
|
41363
|
+
* @throws {RequiredError}
|
|
41364
|
+
*/
|
|
41365
|
+
insertUpdatePageContentAttribute: function (page_attribute, storefront_oid, page_oid, options) {
|
|
41366
|
+
var localVarFetchArgs = (0, exports.StorefrontApiFetchParamCreator)(configuration).insertUpdatePageContentAttribute(page_attribute, storefront_oid, page_oid, options);
|
|
41367
|
+
return function (fetch, basePath) {
|
|
41368
|
+
if (fetch === void 0) { fetch = portableFetch; }
|
|
41369
|
+
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
41370
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
|
|
41371
|
+
if (response.status >= 200 && response.status < 300) {
|
|
41372
|
+
return response;
|
|
41373
|
+
}
|
|
41374
|
+
else {
|
|
41375
|
+
throw response;
|
|
41376
|
+
}
|
|
41377
|
+
});
|
|
41378
|
+
};
|
|
41379
|
+
},
|
|
41294
41380
|
/**
|
|
41295
41381
|
*
|
|
41296
41382
|
* @summary Prepare download of email segment
|
|
@@ -43852,6 +43938,18 @@ var StorefrontApiFactory = function (configuration, fetch, basePath) {
|
|
|
43852
43938
|
insertScreenRecordingSegment: function (storefront_oid, segment, options) {
|
|
43853
43939
|
return (0, exports.StorefrontApiFp)(configuration).insertScreenRecordingSegment(storefront_oid, segment, options)(fetch, basePath);
|
|
43854
43940
|
},
|
|
43941
|
+
/**
|
|
43942
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
43943
|
+
* @summary Upsert a page content attribute
|
|
43944
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
43945
|
+
* @param {number} storefront_oid
|
|
43946
|
+
* @param {number} page_oid The page oid to modify.
|
|
43947
|
+
* @param {*} [options] Override http request option.
|
|
43948
|
+
* @throws {RequiredError}
|
|
43949
|
+
*/
|
|
43950
|
+
insertUpdatePageContentAttribute: function (page_attribute, storefront_oid, page_oid, options) {
|
|
43951
|
+
return (0, exports.StorefrontApiFp)(configuration).insertUpdatePageContentAttribute(page_attribute, storefront_oid, page_oid, options)(fetch, basePath);
|
|
43952
|
+
},
|
|
43855
43953
|
/**
|
|
43856
43954
|
*
|
|
43857
43955
|
* @summary Prepare download of email segment
|
|
@@ -45971,6 +46069,19 @@ var StorefrontApi = /** @class */ (function (_super) {
|
|
|
45971
46069
|
StorefrontApi.prototype.insertScreenRecordingSegment = function (storefront_oid, segment, options) {
|
|
45972
46070
|
return (0, exports.StorefrontApiFp)(this.configuration).insertScreenRecordingSegment(storefront_oid, segment, options)(this.fetch, this.basePath);
|
|
45973
46071
|
};
|
|
46072
|
+
/**
|
|
46073
|
+
* Update a page content attribute, creating it new if it does not yet exist.
|
|
46074
|
+
* @summary Upsert a page content attribute
|
|
46075
|
+
* @param {StoreFrontPageContentAttribute} page_attribute Page content attribute to upsert
|
|
46076
|
+
* @param {number} storefront_oid
|
|
46077
|
+
* @param {number} page_oid The page oid to modify.
|
|
46078
|
+
* @param {*} [options] Override http request option.
|
|
46079
|
+
* @throws {RequiredError}
|
|
46080
|
+
* @memberof StorefrontApi
|
|
46081
|
+
*/
|
|
46082
|
+
StorefrontApi.prototype.insertUpdatePageContentAttribute = function (page_attribute, storefront_oid, page_oid, options) {
|
|
46083
|
+
return (0, exports.StorefrontApiFp)(this.configuration).insertUpdatePageContentAttribute(page_attribute, storefront_oid, page_oid, options)(this.fetch, this.basePath);
|
|
46084
|
+
};
|
|
45974
46085
|
/**
|
|
45975
46086
|
*
|
|
45976
46087
|
* @summary Prepare download of email segment
|