ultracart_rest_api_v2_typescript 3.9.2 → 3.9.3

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 CHANGED
@@ -1,4 +1,4 @@
1
- ## ultracart_rest_api_v2_typescript@3.9.2
1
+ ## ultracart_rest_api_v2_typescript@3.9.3
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.2 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.9.3 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 3.9.3 | 04/06/2022 | fix return object on send webhook test method |
57
58
  | 3.9.2 | 04/04/2022 | user.email field extended and postcard screenshot fields |
58
59
  | 3.9.1 | 03/03/2022 | javascript sdk package.json bug fix |
59
60
  | 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}
@@ -10448,53 +10442,17 @@ export interface EmailCommseqPostcard {
10448
10442
  */
10449
10443
  postcard_front_container_uuid?: string;
10450
10444
  /**
10451
- * URL to screenshot (back) in large form factor full page
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
10445
+ * URL for front screenshot
10458
10446
  * @type {string}
10459
10447
  * @memberof EmailCommseqPostcard
10460
10448
  */
10461
- screenshot_back_large_viewport_url?: string;
10449
+ screenshot_front_url?: string;
10462
10450
  /**
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
10482
- * @type {string}
10483
- * @memberof EmailCommseqPostcard
10484
- */
10485
- screenshot_large_viewport_url?: string;
10486
- /**
10487
- * URL to screenshot in small form factor full page
10451
+ * URL for back screenshot
10488
10452
  * @type {string}
10489
10453
  * @memberof EmailCommseqPostcard
10490
10454
  */
10491
10455
  screenshot_small_full_url?: string;
10492
- /**
10493
- * URL to screenshot in small form factor viewport
10494
- * @type {string}
10495
- * @memberof EmailCommseqPostcard
10496
- */
10497
- screenshot_small_viewport_url?: string;
10498
10456
  /**
10499
10457
  * Storefront oid
10500
10458
  * @type {number}
@@ -11236,6 +11194,56 @@ export interface EmailCommseqWebhookSendTestRequest {
11236
11194
  order_id?: string;
11237
11195
  }
11238
11196
 
11197
+ /**
11198
+ *
11199
+ * @export
11200
+ * @interface EmailCommseqWebhookSendTestResponse
11201
+ */
11202
+ export interface EmailCommseqWebhookSendTestResponse {
11203
+ /**
11204
+ *
11205
+ * @type {ModelError}
11206
+ * @memberof EmailCommseqWebhookSendTestResponse
11207
+ */
11208
+ error?: ModelError;
11209
+ /**
11210
+ *
11211
+ * @type {ResponseMetadata}
11212
+ * @memberof EmailCommseqWebhookSendTestResponse
11213
+ */
11214
+ metadata?: ResponseMetadata;
11215
+ /**
11216
+ * HTTP Request
11217
+ * @type {string}
11218
+ * @memberof EmailCommseqWebhookSendTestResponse
11219
+ */
11220
+ request?: string;
11221
+ /**
11222
+ * HTTP Response
11223
+ * @type {string}
11224
+ * @memberof EmailCommseqWebhookSendTestResponse
11225
+ */
11226
+ response?: string;
11227
+ /**
11228
+ * HTTP Status Code
11229
+ * @type {number}
11230
+ * @memberof EmailCommseqWebhookSendTestResponse
11231
+ */
11232
+ status_code?: number;
11233
+ /**
11234
+ * Indicates if API call was successful
11235
+ * @type {boolean}
11236
+ * @memberof EmailCommseqWebhookSendTestResponse
11237
+ */
11238
+ success?: boolean;
11239
+ /**
11240
+ *
11241
+ * @type {Warning}
11242
+ * @memberof EmailCommseqWebhookSendTestResponse
11243
+ */
11244
+ warning?: Warning;
11245
+ }
11246
+
11239
11247
  /**
11240
11248
  *
11241
11249
  * @export
@@ -65510,7 +65518,7 @@ export const StorefrontApiFp = function(configuration?: Configuration) {
65510
65518
  * @param {*} [options] Override http request option.
65511
65519
  * @throws {RequiredError}
65512
65520
  */
65513
- sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailCommseqEmailSendTestResponse> {
65521
+ sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailCommseqWebhookSendTestResponse> {
65514
65522
  const localVarFetchArgs = StorefrontApiFetchParamCreator(configuration).sendWebhookTest(storefront_oid, email_commseq_webhook_test_request, options);
65515
65523
  return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
65516
65524
  return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
@@ -69381,7 +69389,7 @@ export interface StorefrontApiInterface {
69381
69389
  * @throws {RequiredError}
69382
69390
  * @memberof StorefrontApiInterface
69383
69391
  */
69384
- sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqEmailSendTestResponse>;
69392
+ sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqWebhookSendTestResponse>;
69385
69393
 
69386
69394
  /**
69387
69395
  *
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}
@@ -10204,53 +10198,17 @@ export interface EmailCommseqPostcard {
10204
10198
  */
10205
10199
  postcard_front_container_uuid?: string;
10206
10200
  /**
10207
- * URL to screenshot (back) in large form factor full page
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
10214
- * @type {string}
10215
- * @memberof EmailCommseqPostcard
10216
- */
10217
- screenshot_back_large_viewport_url?: string;
10218
- /**
10219
- * URL to screenshot (back) in small form factor full page
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
10201
+ * URL for front screenshot
10238
10202
  * @type {string}
10239
10203
  * @memberof EmailCommseqPostcard
10240
10204
  */
10241
- screenshot_large_viewport_url?: string;
10205
+ screenshot_front_url?: string;
10242
10206
  /**
10243
- * URL to screenshot in small form factor full page
10207
+ * URL for back screenshot
10244
10208
  * @type {string}
10245
10209
  * @memberof EmailCommseqPostcard
10246
10210
  */
10247
10211
  screenshot_small_full_url?: string;
10248
- /**
10249
- * URL to screenshot in small form factor viewport
10250
- * @type {string}
10251
- * @memberof EmailCommseqPostcard
10252
- */
10253
- screenshot_small_viewport_url?: string;
10254
10212
  /**
10255
10213
  * Storefront oid
10256
10214
  * @type {number}
@@ -10978,6 +10936,55 @@ export interface EmailCommseqWebhookSendTestRequest {
10978
10936
  */
10979
10937
  order_id?: string;
10980
10938
  }
10939
+ /**
10940
+ *
10941
+ * @export
10942
+ * @interface EmailCommseqWebhookSendTestResponse
10943
+ */
10944
+ export interface EmailCommseqWebhookSendTestResponse {
10945
+ /**
10946
+ *
10947
+ * @type {ModelError}
10948
+ * @memberof EmailCommseqWebhookSendTestResponse
10949
+ */
10950
+ error?: ModelError;
10951
+ /**
10952
+ *
10953
+ * @type {ResponseMetadata}
10954
+ * @memberof EmailCommseqWebhookSendTestResponse
10955
+ */
10956
+ metadata?: ResponseMetadata;
10957
+ /**
10958
+ * HTTP Request
10959
+ * @type {string}
10960
+ * @memberof EmailCommseqWebhookSendTestResponse
10961
+ */
10962
+ request?: string;
10963
+ /**
10964
+ * HTTP Response
10965
+ * @type {string}
10966
+ * @memberof EmailCommseqWebhookSendTestResponse
10967
+ */
10968
+ response?: string;
10969
+ /**
10970
+ * HTTP Status Code
10971
+ * @type {number}
10972
+ * @memberof EmailCommseqWebhookSendTestResponse
10973
+ */
10974
+ status_code?: number;
10975
+ /**
10976
+ * Indicates if API call was successful
10977
+ * @type {boolean}
10978
+ * @memberof EmailCommseqWebhookSendTestResponse
10979
+ */
10980
+ success?: boolean;
10981
+ /**
10982
+ *
10983
+ * @type {Warning}
10984
+ * @memberof EmailCommseqWebhookSendTestResponse
10985
+ */
10986
+ warning?: Warning;
10987
+ }
10981
10988
  /**
10982
10989
  *
10983
10990
  * @export
@@ -43764,7 +43771,7 @@ export declare const StorefrontApiFp: (configuration?: Configuration) => {
43764
43771
  * @param {*} [options] Override http request option.
43765
43772
  * @throws {RequiredError}
43766
43773
  */
43767
- sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailCommseqEmailSendTestResponse>;
43774
+ sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailCommseqWebhookSendTestResponse>;
43768
43775
  /**
43769
43776
  *
43770
43777
  * @summary Start email campaign
@@ -45233,7 +45240,7 @@ export declare const StorefrontApiFactory: (configuration?: Configuration, fetch
45233
45240
  * @param {*} [options] Override http request option.
45234
45241
  * @throws {RequiredError}
45235
45242
  */
45236
- sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqEmailSendTestResponse>;
45243
+ sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqWebhookSendTestResponse>;
45237
45244
  /**
45238
45245
  *
45239
45246
  * @summary Start email campaign
@@ -46838,7 +46845,7 @@ export interface StorefrontApiInterface {
46838
46845
  * @throws {RequiredError}
46839
46846
  * @memberof StorefrontApiInterface
46840
46847
  */
46841
- sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqEmailSendTestResponse>;
46848
+ sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqWebhookSendTestResponse>;
46842
46849
  /**
46843
46850
  *
46844
46851
  * @summary Start email campaign
@@ -48469,7 +48476,7 @@ export declare class StorefrontApi extends BaseAPI implements StorefrontApiInter
48469
48476
  * @throws {RequiredError}
48470
48477
  * @memberof StorefrontApi
48471
48478
  */
48472
- sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqEmailSendTestResponse>;
48479
+ sendWebhookTest(storefront_oid: number, email_commseq_webhook_test_request: EmailCommseqWebhookSendTestRequest, options?: any): Promise<EmailCommseqWebhookSendTestResponse>;
48473
48480
  /**
48474
48481
  *
48475
48482
  * @summary Start email campaign
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.9.2",
3
+ "version": "3.9.3",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [