ultracart_rest_api_v2_typescript 3.9.2 → 3.9.5
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 +5 -2
- package/api.ts +74 -48
- package/dist/api.d.ts +75 -50
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## ultracart_rest_api_v2_typescript@3.9.
|
|
1
|
+
## ultracart_rest_api_v2_typescript@3.9.5
|
|
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.9.
|
|
39
|
+
npm install ultracart_rest_api_v2_typescript@3.9.5 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -54,6 +54,9 @@ Not every change is committed to every SDK.
|
|
|
54
54
|
|
|
55
55
|
| Version | Date | Comments |
|
|
56
56
|
| --: | :-: | --- |
|
|
57
|
+
| 3.9.5 | 04/14/2022 | postcard screenshot bug fixes |
|
|
58
|
+
| 3.9.4 | 04/13/2022 | Added spf DNS record to the sending domain object |
|
|
59
|
+
| 3.9.3 | 04/06/2022 | fix return object on send webhook test method |
|
|
57
60
|
| 3.9.2 | 04/04/2022 | user.email field extended and postcard screenshot fields |
|
|
58
61
|
| 3.9.1 | 03/03/2022 | javascript sdk package.json bug fix |
|
|
59
62
|
| 3.9.0 | 03/03/2022 | removed ultra_cart_rest_api_v2.d.ts from javascript sdk because typescript sdk exists now |
|
package/api.ts
CHANGED
|
@@ -490,12 +490,6 @@ export interface AddLibraryItemRequest {
|
|
|
490
490
|
* @memberof AddLibraryItemRequest
|
|
491
491
|
*/
|
|
492
492
|
cjson?: string;
|
|
493
|
-
/**
|
|
494
|
-
* Additional Cjson to be added to library, notably for the postcard which has a front and back.
|
|
495
|
-
* @type {string}
|
|
496
|
-
* @memberof AddLibraryItemRequest
|
|
497
|
-
*/
|
|
498
|
-
cjson2?: string;
|
|
499
493
|
/**
|
|
500
494
|
* flow, campaign, cjson, email, transactional_email, postcard or upsell
|
|
501
495
|
* @type {string}
|
|
@@ -8338,6 +8332,18 @@ export interface CustomerLoyalty {
|
|
|
8338
8332
|
* @memberof CustomerLoyalty
|
|
8339
8333
|
*/
|
|
8340
8334
|
current_points?: number;
|
|
8335
|
+
/**
|
|
8336
|
+
* Loyalty Cashback / Store credit balance (internal gift certificate balance)
|
|
8337
|
+
* @type {string}
|
|
8338
|
+
* @memberof CustomerLoyalty
|
|
8339
|
+
*/
|
|
8340
|
+
internal_gift_certificate_balance?: string;
|
|
8341
|
+
/**
|
|
8342
|
+
* Internal gift certificate oid used to tracking loyalty cashback / store credit.
|
|
8343
|
+
* @type {number}
|
|
8344
|
+
* @memberof CustomerLoyalty
|
|
8345
|
+
*/
|
|
8346
|
+
internal_gift_certificate_oid?: number;
|
|
8341
8347
|
/**
|
|
8342
8348
|
* Ledger entries
|
|
8343
8349
|
* @type {Array<CustomerLoyaltyLedger>}
|
|
@@ -10448,53 +10454,17 @@ export interface EmailCommseqPostcard {
|
|
|
10448
10454
|
*/
|
|
10449
10455
|
postcard_front_container_uuid?: string;
|
|
10450
10456
|
/**
|
|
10451
|
-
* URL to screenshot
|
|
10452
|
-
* @type {string}
|
|
10453
|
-
* @memberof EmailCommseqPostcard
|
|
10454
|
-
*/
|
|
10455
|
-
screenshot_back_large_full_url?: string;
|
|
10456
|
-
/**
|
|
10457
|
-
* URL to screenshot (back) in large form factor viewport
|
|
10458
|
-
* @type {string}
|
|
10459
|
-
* @memberof EmailCommseqPostcard
|
|
10460
|
-
*/
|
|
10461
|
-
screenshot_back_large_viewport_url?: string;
|
|
10462
|
-
/**
|
|
10463
|
-
* URL to screenshot (back) in small form factor full page
|
|
10464
|
-
* @type {string}
|
|
10465
|
-
* @memberof EmailCommseqPostcard
|
|
10466
|
-
*/
|
|
10467
|
-
screenshot_back_small_full_url?: string;
|
|
10468
|
-
/**
|
|
10469
|
-
* URL to screenshot (back) in small form factor viewport
|
|
10470
|
-
* @type {string}
|
|
10471
|
-
* @memberof EmailCommseqPostcard
|
|
10472
|
-
*/
|
|
10473
|
-
screenshot_back_small_viewport_url?: string;
|
|
10474
|
-
/**
|
|
10475
|
-
* URL to screenshot in large form factor full page
|
|
10476
|
-
* @type {string}
|
|
10477
|
-
* @memberof EmailCommseqPostcard
|
|
10478
|
-
*/
|
|
10479
|
-
screenshot_large_full_url?: string;
|
|
10480
|
-
/**
|
|
10481
|
-
* URL to screenshot in large form factor viewport
|
|
10457
|
+
* URL to screenshot of the back of the postcard
|
|
10482
10458
|
* @type {string}
|
|
10483
10459
|
* @memberof EmailCommseqPostcard
|
|
10484
10460
|
*/
|
|
10485
|
-
|
|
10461
|
+
screenshot_back_url?: string;
|
|
10486
10462
|
/**
|
|
10487
|
-
* URL to screenshot
|
|
10463
|
+
* URL to screenshot of the front of the postcard
|
|
10488
10464
|
* @type {string}
|
|
10489
10465
|
* @memberof EmailCommseqPostcard
|
|
10490
10466
|
*/
|
|
10491
|
-
|
|
10492
|
-
/**
|
|
10493
|
-
* URL to screenshot in small form factor viewport
|
|
10494
|
-
* @type {string}
|
|
10495
|
-
* @memberof EmailCommseqPostcard
|
|
10496
|
-
*/
|
|
10497
|
-
screenshot_small_viewport_url?: string;
|
|
10467
|
+
screenshot_front_url?: string;
|
|
10498
10468
|
/**
|
|
10499
10469
|
* Storefront oid
|
|
10500
10470
|
* @type {number}
|
|
@@ -11236,6 +11206,56 @@ export interface EmailCommseqWebhookSendTestRequest {
|
|
|
11236
11206
|
order_id?: string;
|
|
11237
11207
|
}
|
|
11238
11208
|
|
|
11209
|
+
/**
|
|
11210
|
+
*
|
|
11211
|
+
* @export
|
|
11212
|
+
* @interface EmailCommseqWebhookSendTestResponse
|
|
11213
|
+
*/
|
|
11214
|
+
export interface EmailCommseqWebhookSendTestResponse {
|
|
11215
|
+
/**
|
|
11216
|
+
*
|
|
11217
|
+
* @type {ModelError}
|
|
11218
|
+
* @memberof EmailCommseqWebhookSendTestResponse
|
|
11219
|
+
*/
|
|
11220
|
+
error?: ModelError;
|
|
11221
|
+
/**
|
|
11222
|
+
*
|
|
11223
|
+
* @type {ResponseMetadata}
|
|
11224
|
+
* @memberof EmailCommseqWebhookSendTestResponse
|
|
11225
|
+
*/
|
|
11226
|
+
metadata?: ResponseMetadata;
|
|
11227
|
+
/**
|
|
11228
|
+
* HTTP Request
|
|
11229
|
+
* @type {string}
|
|
11230
|
+
* @memberof EmailCommseqWebhookSendTestResponse
|
|
11231
|
+
*/
|
|
11232
|
+
request?: string;
|
|
11233
|
+
/**
|
|
11234
|
+
* HTTP Response
|
|
11235
|
+
* @type {string}
|
|
11236
|
+
* @memberof EmailCommseqWebhookSendTestResponse
|
|
11237
|
+
*/
|
|
11238
|
+
response?: string;
|
|
11239
|
+
/**
|
|
11240
|
+
* HTTP Status Code
|
|
11241
|
+
* @type {number}
|
|
11242
|
+
* @memberof EmailCommseqWebhookSendTestResponse
|
|
11243
|
+
*/
|
|
11244
|
+
status_code?: number;
|
|
11245
|
+
/**
|
|
11246
|
+
* Indicates if API call was successful
|
|
11247
|
+
* @type {boolean}
|
|
11248
|
+
* @memberof EmailCommseqWebhookSendTestResponse
|
|
11249
|
+
*/
|
|
11250
|
+
success?: boolean;
|
|
11251
|
+
/**
|
|
11252
|
+
*
|
|
11253
|
+
* @type {Warning}
|
|
11254
|
+
* @memberof EmailCommseqWebhookSendTestResponse
|
|
11255
|
+
*/
|
|
11256
|
+
warning?: Warning;
|
|
11257
|
+
}
|
|
11258
|
+
|
|
11239
11259
|
/**
|
|
11240
11260
|
*
|
|
11241
11261
|
* @export
|
|
@@ -11586,6 +11606,12 @@ export interface EmailDomain {
|
|
|
11586
11606
|
* @memberof EmailDomain
|
|
11587
11607
|
*/
|
|
11588
11608
|
provider?: string;
|
|
11609
|
+
/**
|
|
11610
|
+
*
|
|
11611
|
+
* @type {VerificationRecord}
|
|
11612
|
+
* @memberof EmailDomain
|
|
11613
|
+
*/
|
|
11614
|
+
spf?: VerificationRecord;
|
|
11589
11615
|
/**
|
|
11590
11616
|
*
|
|
11591
11617
|
* @type {string}
|
|
@@ -65510,7 +65536,7 @@ export const StorefrontApiFp = function(configuration?: Configuration) {
|
|
|
65510
65536
|
* @param {*} [options] Override http request option.
|
|
65511
65537
|
* @throws {RequiredError}
|
|
65512
65538
|
*/
|
|
65513
|
-
sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<
|
|
65539
|
+
sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailCommseqWebhookSendTestResponse> {
|
|
65514
65540
|
const localVarFetchArgs = StorefrontApiFetchParamCreator(configuration).sendWebhookTest(storefront_oid, email_commseq_webhook_test_request, options);
|
|
65515
65541
|
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
65516
65542
|
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
@@ -69381,7 +69407,7 @@ export interface StorefrontApiInterface {
|
|
|
69381
69407
|
* @throws {RequiredError}
|
|
69382
69408
|
* @memberof StorefrontApiInterface
|
|
69383
69409
|
*/
|
|
69384
|
-
sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<
|
|
69410
|
+
sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqWebhookSendTestResponse>;
|
|
69385
69411
|
|
|
69386
69412
|
/**
|
|
69387
69413
|
*
|
package/dist/api.d.ts
CHANGED
|
@@ -464,12 +464,6 @@ export interface AddLibraryItemRequest {
|
|
|
464
464
|
* @memberof AddLibraryItemRequest
|
|
465
465
|
*/
|
|
466
466
|
cjson?: string;
|
|
467
|
-
/**
|
|
468
|
-
* Additional Cjson to be added to library, notably for the postcard which has a front and back.
|
|
469
|
-
* @type {string}
|
|
470
|
-
* @memberof AddLibraryItemRequest
|
|
471
|
-
*/
|
|
472
|
-
cjson2?: string;
|
|
473
467
|
/**
|
|
474
468
|
* flow, campaign, cjson, email, transactional_email, postcard or upsell
|
|
475
469
|
* @type {string}
|
|
@@ -8131,6 +8125,18 @@ export interface CustomerLoyalty {
|
|
|
8131
8125
|
* @memberof CustomerLoyalty
|
|
8132
8126
|
*/
|
|
8133
8127
|
current_points?: number;
|
|
8128
|
+
/**
|
|
8129
|
+
* Loyalty Cashback / Store credit balance (internal gift certificate balance)
|
|
8130
|
+
* @type {string}
|
|
8131
|
+
* @memberof CustomerLoyalty
|
|
8132
|
+
*/
|
|
8133
|
+
internal_gift_certificate_balance?: string;
|
|
8134
|
+
/**
|
|
8135
|
+
* Internal gift certificate oid used to tracking loyalty cashback / store credit.
|
|
8136
|
+
* @type {number}
|
|
8137
|
+
* @memberof CustomerLoyalty
|
|
8138
|
+
*/
|
|
8139
|
+
internal_gift_certificate_oid?: number;
|
|
8134
8140
|
/**
|
|
8135
8141
|
* Ledger entries
|
|
8136
8142
|
* @type {Array<CustomerLoyaltyLedger>}
|
|
@@ -10204,53 +10210,17 @@ export interface EmailCommseqPostcard {
|
|
|
10204
10210
|
*/
|
|
10205
10211
|
postcard_front_container_uuid?: string;
|
|
10206
10212
|
/**
|
|
10207
|
-
* URL to screenshot
|
|
10208
|
-
* @type {string}
|
|
10209
|
-
* @memberof EmailCommseqPostcard
|
|
10210
|
-
*/
|
|
10211
|
-
screenshot_back_large_full_url?: string;
|
|
10212
|
-
/**
|
|
10213
|
-
* URL to screenshot (back) in large form factor viewport
|
|
10213
|
+
* URL to screenshot of the back of the postcard
|
|
10214
10214
|
* @type {string}
|
|
10215
10215
|
* @memberof EmailCommseqPostcard
|
|
10216
10216
|
*/
|
|
10217
|
-
|
|
10217
|
+
screenshot_back_url?: string;
|
|
10218
10218
|
/**
|
|
10219
|
-
* URL to screenshot
|
|
10220
|
-
* @type {string}
|
|
10221
|
-
* @memberof EmailCommseqPostcard
|
|
10222
|
-
*/
|
|
10223
|
-
screenshot_back_small_full_url?: string;
|
|
10224
|
-
/**
|
|
10225
|
-
* URL to screenshot (back) in small form factor viewport
|
|
10226
|
-
* @type {string}
|
|
10227
|
-
* @memberof EmailCommseqPostcard
|
|
10228
|
-
*/
|
|
10229
|
-
screenshot_back_small_viewport_url?: string;
|
|
10230
|
-
/**
|
|
10231
|
-
* URL to screenshot in large form factor full page
|
|
10232
|
-
* @type {string}
|
|
10233
|
-
* @memberof EmailCommseqPostcard
|
|
10234
|
-
*/
|
|
10235
|
-
screenshot_large_full_url?: string;
|
|
10236
|
-
/**
|
|
10237
|
-
* URL to screenshot in large form factor viewport
|
|
10238
|
-
* @type {string}
|
|
10239
|
-
* @memberof EmailCommseqPostcard
|
|
10240
|
-
*/
|
|
10241
|
-
screenshot_large_viewport_url?: string;
|
|
10242
|
-
/**
|
|
10243
|
-
* URL to screenshot in small form factor full page
|
|
10244
|
-
* @type {string}
|
|
10245
|
-
* @memberof EmailCommseqPostcard
|
|
10246
|
-
*/
|
|
10247
|
-
screenshot_small_full_url?: string;
|
|
10248
|
-
/**
|
|
10249
|
-
* URL to screenshot in small form factor viewport
|
|
10219
|
+
* URL to screenshot of the front of the postcard
|
|
10250
10220
|
* @type {string}
|
|
10251
10221
|
* @memberof EmailCommseqPostcard
|
|
10252
10222
|
*/
|
|
10253
|
-
|
|
10223
|
+
screenshot_front_url?: string;
|
|
10254
10224
|
/**
|
|
10255
10225
|
* Storefront oid
|
|
10256
10226
|
* @type {number}
|
|
@@ -10978,6 +10948,55 @@ export interface EmailCommseqWebhookSendTestRequest {
|
|
|
10978
10948
|
*/
|
|
10979
10949
|
order_id?: string;
|
|
10980
10950
|
}
|
|
10951
|
+
/**
|
|
10952
|
+
*
|
|
10953
|
+
* @export
|
|
10954
|
+
* @interface EmailCommseqWebhookSendTestResponse
|
|
10955
|
+
*/
|
|
10956
|
+
export interface EmailCommseqWebhookSendTestResponse {
|
|
10957
|
+
/**
|
|
10958
|
+
*
|
|
10959
|
+
* @type {ModelError}
|
|
10960
|
+
* @memberof EmailCommseqWebhookSendTestResponse
|
|
10961
|
+
*/
|
|
10962
|
+
error?: ModelError;
|
|
10963
|
+
/**
|
|
10964
|
+
*
|
|
10965
|
+
* @type {ResponseMetadata}
|
|
10966
|
+
* @memberof EmailCommseqWebhookSendTestResponse
|
|
10967
|
+
*/
|
|
10968
|
+
metadata?: ResponseMetadata;
|
|
10969
|
+
/**
|
|
10970
|
+
* HTTP Request
|
|
10971
|
+
* @type {string}
|
|
10972
|
+
* @memberof EmailCommseqWebhookSendTestResponse
|
|
10973
|
+
*/
|
|
10974
|
+
request?: string;
|
|
10975
|
+
/**
|
|
10976
|
+
* HTTP Response
|
|
10977
|
+
* @type {string}
|
|
10978
|
+
* @memberof EmailCommseqWebhookSendTestResponse
|
|
10979
|
+
*/
|
|
10980
|
+
response?: string;
|
|
10981
|
+
/**
|
|
10982
|
+
* HTTP Status Code
|
|
10983
|
+
* @type {number}
|
|
10984
|
+
* @memberof EmailCommseqWebhookSendTestResponse
|
|
10985
|
+
*/
|
|
10986
|
+
status_code?: number;
|
|
10987
|
+
/**
|
|
10988
|
+
* Indicates if API call was successful
|
|
10989
|
+
* @type {boolean}
|
|
10990
|
+
* @memberof EmailCommseqWebhookSendTestResponse
|
|
10991
|
+
*/
|
|
10992
|
+
success?: boolean;
|
|
10993
|
+
/**
|
|
10994
|
+
*
|
|
10995
|
+
* @type {Warning}
|
|
10996
|
+
* @memberof EmailCommseqWebhookSendTestResponse
|
|
10997
|
+
*/
|
|
10998
|
+
warning?: Warning;
|
|
10999
|
+
}
|
|
10981
11000
|
/**
|
|
10982
11001
|
*
|
|
10983
11002
|
* @export
|
|
@@ -11321,6 +11340,12 @@ export interface EmailDomain {
|
|
|
11321
11340
|
* @memberof EmailDomain
|
|
11322
11341
|
*/
|
|
11323
11342
|
provider?: string;
|
|
11343
|
+
/**
|
|
11344
|
+
*
|
|
11345
|
+
* @type {VerificationRecord}
|
|
11346
|
+
* @memberof EmailDomain
|
|
11347
|
+
*/
|
|
11348
|
+
spf?: VerificationRecord;
|
|
11324
11349
|
/**
|
|
11325
11350
|
*
|
|
11326
11351
|
* @type {string}
|
|
@@ -43764,7 +43789,7 @@ export declare const StorefrontApiFp: (configuration?: Configuration) => {
|
|
|
43764
43789
|
* @param {*} [options] Override http request option.
|
|
43765
43790
|
* @throws {RequiredError}
|
|
43766
43791
|
*/
|
|
43767
|
-
sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<
|
|
43792
|
+
sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailCommseqWebhookSendTestResponse>;
|
|
43768
43793
|
/**
|
|
43769
43794
|
*
|
|
43770
43795
|
* @summary Start email campaign
|
|
@@ -45233,7 +45258,7 @@ export declare const StorefrontApiFactory: (configuration?: Configuration, fetch
|
|
|
45233
45258
|
* @param {*} [options] Override http request option.
|
|
45234
45259
|
* @throws {RequiredError}
|
|
45235
45260
|
*/
|
|
45236
|
-
sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<
|
|
45261
|
+
sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqWebhookSendTestResponse>;
|
|
45237
45262
|
/**
|
|
45238
45263
|
*
|
|
45239
45264
|
* @summary Start email campaign
|
|
@@ -46838,7 +46863,7 @@ export interface StorefrontApiInterface {
|
|
|
46838
46863
|
* @throws {RequiredError}
|
|
46839
46864
|
* @memberof StorefrontApiInterface
|
|
46840
46865
|
*/
|
|
46841
|
-
sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<
|
|
46866
|
+
sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqWebhookSendTestResponse>;
|
|
46842
46867
|
/**
|
|
46843
46868
|
*
|
|
46844
46869
|
* @summary Start email campaign
|
|
@@ -48469,7 +48494,7 @@ export declare class StorefrontApi extends BaseAPI implements StorefrontApiInter
|
|
|
48469
48494
|
* @throws {RequiredError}
|
|
48470
48495
|
* @memberof StorefrontApi
|
|
48471
48496
|
*/
|
|
48472
|
-
sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<
|
|
48497
|
+
sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqWebhookSendTestResponse>;
|
|
48473
48498
|
/**
|
|
48474
48499
|
*
|
|
48475
48500
|
* @summary Start email campaign
|