ultracart_rest_api_v2_typescript 3.9.4 → 3.9.7

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.4
1
+ ## ultracart_rest_api_v2_typescript@3.9.7
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.4 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.9.7 --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.7 | 04/25/2022 | integration logs method for zpl to pdf conversion |
58
+ | 3.9.6 | 04/25/2022 | storefront communications email magic link setting |
59
+ | 3.9.5 | 04/14/2022 | postcard screenshot bug fixes |
57
60
  | 3.9.4 | 04/13/2022 | Added spf DNS record to the sending domain object |
58
61
  | 3.9.3 | 04/06/2022 | fix return object on send webhook test method |
59
62
  | 3.9.2 | 04/04/2022 | user.email field extended and postcard screenshot fields |
package/api.ts CHANGED
@@ -546,6 +546,94 @@ export interface AddLibraryItemRequest {
546
546
  uuid?: string;
547
547
  }
548
548
 
549
+ /**
550
+ *
551
+ * @export
552
+ * @interface AdjustInternalCertificateRequest
553
+ */
554
+ export interface AdjustInternalCertificateRequest {
555
+ /**
556
+ * The adjustment amount
557
+ * @type {number}
558
+ * @memberof AdjustInternalCertificateRequest
559
+ */
560
+ adjustment_amount?: number;
561
+ /**
562
+ * Description of this adjustment, 50 characters max
563
+ * @type {string}
564
+ * @memberof AdjustInternalCertificateRequest
565
+ */
566
+ description?: string;
567
+ /**
568
+ * Optional timestamp for the adjustment, defaults to current time
569
+ * @type {string}
570
+ * @memberof AdjustInternalCertificateRequest
571
+ */
572
+ entry_dts?: string;
573
+ /**
574
+ * Optional expiration days from the entry_dts when these adjustment becomes worthless
575
+ * @type {number}
576
+ * @memberof AdjustInternalCertificateRequest
577
+ */
578
+ expiration_days?: number;
579
+ /**
580
+ * Optional order id if this adjustment is related to a particular order
581
+ * @type {string}
582
+ * @memberof AdjustInternalCertificateRequest
583
+ */
584
+ order_id?: string;
585
+ /**
586
+ * Optional days required for this adjustment to vest
587
+ * @type {number}
588
+ * @memberof AdjustInternalCertificateRequest
589
+ */
590
+ vesting_days?: number;
591
+ }
592
+
593
+ /**
594
+ *
595
+ * @export
596
+ * @interface AdjustInternalCertificateResponse
597
+ */
598
+ export interface AdjustInternalCertificateResponse {
599
+ /**
600
+ * The adjustment amount
601
+ * @type {number}
602
+ * @memberof AdjustInternalCertificateResponse
603
+ */
604
+ adjustment_amount?: number;
605
+ /**
606
+ * The balance amount after the adjustment was made
607
+ * @type {number}
608
+ * @memberof AdjustInternalCertificateResponse
609
+ */
610
+ balance_amount?: number;
611
+ /**
612
+ *
613
+ * @type {ModelError}
614
+ * @memberof AdjustInternalCertificateResponse
615
+ */
616
+ error?: ModelError;
617
+ /**
618
+ *
619
+ * @type {ResponseMetadata}
620
+ * @memberof AdjustInternalCertificateResponse
621
+ */
622
+ metadata?: ResponseMetadata;
623
+ /**
624
+ * Indicates if API call was successful
625
+ * @type {boolean}
626
+ * @memberof AdjustInternalCertificateResponse
627
+ */
628
+ success?: boolean;
629
+ /**
630
+ *
631
+ * @type {Warning}
632
+ * @memberof AdjustInternalCertificateResponse
633
+ */
634
+ warning?: Warning;
635
+ }
636
+
549
637
  /**
550
638
  *
551
639
  * @export
@@ -1226,6 +1314,12 @@ export interface AutoOrder {
1226
1314
  * @memberof AutoOrder
1227
1315
  */
1228
1316
  cancel_downgrade?: boolean;
1317
+ /**
1318
+ * The reason this auto order was canceled by either merchant or customer
1319
+ * @type {string}
1320
+ * @memberof AutoOrder
1321
+ */
1322
+ cancel_reason?: string;
1229
1323
  /**
1230
1324
  * True if the auto order was canceled because the customer purchased an upgrade item
1231
1325
  * @type {boolean}
@@ -8327,11 +8421,17 @@ export interface CustomerEmailListChanges {
8327
8421
  */
8328
8422
  export interface CustomerLoyalty {
8329
8423
  /**
8330
- * Current Points
8424
+ * Current points
8331
8425
  * @type {number}
8332
8426
  * @memberof CustomerLoyalty
8333
8427
  */
8334
8428
  current_points?: number;
8429
+ /**
8430
+ *
8431
+ * @type {GiftCertificate}
8432
+ * @memberof CustomerLoyalty
8433
+ */
8434
+ internal_gift_certificate?: GiftCertificate;
8335
8435
  /**
8336
8436
  * Loyalty Cashback / Store credit balance (internal gift certificate balance)
8337
8437
  * @type {string}
@@ -10081,6 +10181,12 @@ export interface EmailCommseqEmail {
10081
10181
  * @memberof EmailCommseqEmail
10082
10182
  */
10083
10183
  library_item_oid?: number;
10184
+ /**
10185
+ * True if email links should contain magic link tokens to log the customer in automatically
10186
+ * @type {boolean}
10187
+ * @memberof EmailCommseqEmail
10188
+ */
10189
+ magic_link?: boolean;
10084
10190
  /**
10085
10191
  * Merchant ID
10086
10192
  * @type {string}
@@ -10454,17 +10560,17 @@ export interface EmailCommseqPostcard {
10454
10560
  */
10455
10561
  postcard_front_container_uuid?: string;
10456
10562
  /**
10457
- * URL for front screenshot
10563
+ * URL to screenshot of the back of the postcard
10458
10564
  * @type {string}
10459
10565
  * @memberof EmailCommseqPostcard
10460
10566
  */
10461
- screenshot_front_url?: string;
10567
+ screenshot_back_url?: string;
10462
10568
  /**
10463
- * URL for back screenshot
10569
+ * URL to screenshot of the front of the postcard
10464
10570
  * @type {string}
10465
10571
  * @memberof EmailCommseqPostcard
10466
10572
  */
10467
- screenshot_small_full_url?: string;
10573
+ screenshot_front_url?: string;
10468
10574
  /**
10469
10575
  * Storefront oid
10470
10576
  * @type {number}
@@ -12776,6 +12882,12 @@ export interface EmailPerformance {
12776
12882
  * @memberof EmailPerformance
12777
12883
  */
12778
12884
  delivered_count?: number;
12885
+ /**
12886
+ * Loyalty Program Type
12887
+ * @type {string}
12888
+ * @memberof EmailPerformance
12889
+ */
12890
+ loyalty_program_type?: EmailPerformance.LoyaltyProgramTypeEnum;
12779
12891
  /**
12780
12892
  * Maximum active customers allowed under their billing plan
12781
12893
  * @type {number}
@@ -12862,6 +12974,22 @@ export interface EmailPerformance {
12862
12974
  transactional_send_count?: number;
12863
12975
  }
12864
12976
 
12977
+ /**
12978
+ * @export
12979
+ * @namespace EmailPerformance
12980
+ */
12981
+ export namespace EmailPerformance {
12982
+ /**
12983
+ * @export
12984
+ * @enum {string}
12985
+ */
12986
+ export enum LoyaltyProgramTypeEnum {
12987
+ Disabled = <any> 'disabled',
12988
+ Points = <any> 'points',
12989
+ Cashback = <any> 'cashback'
12990
+ }
12991
+ }
12992
+
12865
12993
  /**
12866
12994
  *
12867
12995
  * @export
@@ -22344,6 +22472,12 @@ export interface OrderAutoOrder {
22344
22472
  * @memberof OrderAutoOrder
22345
22473
  */
22346
22474
  cancel_downgrade?: boolean;
22475
+ /**
22476
+ * The reason this auto order was canceled by either merchant or customer
22477
+ * @type {string}
22478
+ * @memberof OrderAutoOrder
22479
+ */
22480
+ cancel_reason?: string;
22347
22481
  /**
22348
22482
  * True if the auto order was canceled because the customer purchased an upgrade item
22349
22483
  * @type {boolean}
@@ -42952,6 +43086,67 @@ export class CouponApi extends BaseAPI implements CouponApiInterface {
42952
43086
  */
42953
43087
  export const CustomerApiFetchParamCreator = function (configuration?: Configuration) {
42954
43088
  return {
43089
+ /**
43090
+ * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
43091
+ * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
43092
+ * @param {number} customer_profile_oid The customer profile oid
43093
+ * @param {AdjustInternalCertificateRequest} adjust_internal_certificate_request adjustInternalCertificateRequest
43094
+ * @param {*} [options] Override http request option.
43095
+ * @throws {RequiredError}
43096
+ */
43097
+ adjustInternalCertificate(customer_profile_oid: number, adjust_internal_certificate_request: AdjustInternalCertificateRequest, options: any = {}): FetchArgs {
43098
+ // verify required parameter 'customer_profile_oid' is not null or undefined
43099
+ if (customer_profile_oid === null || customer_profile_oid === undefined) {
43100
+ throw new RequiredError('customer_profile_oid','Required parameter customer_profile_oid was null or undefined when calling adjustInternalCertificate.');
43101
+ }
43102
+ // verify required parameter 'adjust_internal_certificate_request' is not null or undefined
43103
+ if (adjust_internal_certificate_request === null || adjust_internal_certificate_request === undefined) {
43104
+ throw new RequiredError('adjust_internal_certificate_request','Required parameter adjust_internal_certificate_request was null or undefined when calling adjustInternalCertificate.');
43105
+ }
43106
+ const localVarPath = `/customer/customers/{customer_profile_oid}/adjust_cashback_balance`
43107
+ .replace(`{${"customer_profile_oid"}}`, encodeURIComponent(String(customer_profile_oid)));
43108
+ const localVarUrlObj = url.parse(localVarPath, true);
43109
+ const localVarRequestOptions = Object.assign({ method: 'POST' }, options);
43110
+ const localVarHeaderParameter = {} as any;
43111
+ const localVarQueryParameter = {} as any;
43112
+
43113
+ if(configuration && configuration.apiVersion) {
43114
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
43115
+ }
43116
+
43117
+
43118
+
43119
+ // authentication ultraCartOauth required
43120
+ // oauth required
43121
+ if (configuration && configuration.accessToken) {
43122
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
43123
+ ? configuration.accessToken("ultraCartOauth", ["customer_write"])
43124
+ : configuration.accessToken;
43125
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
43126
+ }
43127
+
43128
+ // authentication ultraCartSimpleApiKey required
43129
+ if (configuration && configuration.apiKey) {
43130
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
43131
+ ? configuration.apiKey("x-ultracart-simple-key")
43132
+ : configuration.apiKey;
43133
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
43134
+ }
43135
+
43136
+ localVarHeaderParameter['Content-Type'] = 'application/json; charset=UTF-8';
43137
+
43138
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
43139
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
43140
+ delete localVarUrlObj.search;
43141
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
43142
+ const needsSerialization = (<any>"AdjustInternalCertificateRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
43143
+ localVarRequestOptions.body = needsSerialization ? JSON.stringify(adjust_internal_certificate_request || {}) : (adjust_internal_certificate_request || "");
43144
+
43145
+ return {
43146
+ url: url.format(localVarUrlObj),
43147
+ options: localVarRequestOptions,
43148
+ };
43149
+ },
42955
43150
  /**
42956
43151
  * Delete a customer on the UltraCart account.
42957
43152
  * @summary Delete a customer
@@ -43853,6 +44048,28 @@ export const CustomerApiFetchParamCreator = function (configuration?: Configurat
43853
44048
  */
43854
44049
  export const CustomerApiFp = function(configuration?: Configuration) {
43855
44050
  return {
44051
+ /**
44052
+ * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
44053
+ * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
44054
+ * @param {number} customer_profile_oid The customer profile oid
44055
+ * @param {AdjustInternalCertificateRequest} adjust_internal_certificate_request adjustInternalCertificateRequest
44056
+ * @param {*} [options] Override http request option.
44057
+ * @throws {RequiredError}
44058
+ */
44059
+ adjustInternalCertificate(customer_profile_oid: number, adjust_internal_certificate_request: AdjustInternalCertificateRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<AdjustInternalCertificateResponse> {
44060
+ const localVarFetchArgs = CustomerApiFetchParamCreator(configuration).adjustInternalCertificate(customer_profile_oid, adjust_internal_certificate_request, options);
44061
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
44062
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
44063
+
44064
+ if (response.status >= 200 && response.status < 300) {
44065
+ return response.json();
44066
+
44067
+ } else {
44068
+ throw response;
44069
+ }
44070
+ });
44071
+ };
44072
+ },
43856
44073
  /**
43857
44074
  * Delete a customer on the UltraCart account.
43858
44075
  * @summary Delete a customer
@@ -44175,6 +44392,17 @@ export const CustomerApiFp = function(configuration?: Configuration) {
44175
44392
  */
44176
44393
  export const CustomerApiFactory = function (configuration?: Configuration, fetch?: FetchAPI, basePath?: string) {
44177
44394
  return {
44395
+ /**
44396
+ * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
44397
+ * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
44398
+ * @param {number} customer_profile_oid The customer profile oid
44399
+ * @param {AdjustInternalCertificateRequest} adjust_internal_certificate_request adjustInternalCertificateRequest
44400
+ * @param {*} [options] Override http request option.
44401
+ * @throws {RequiredError}
44402
+ */
44403
+ adjustInternalCertificate(customer_profile_oid: number, adjust_internal_certificate_request: AdjustInternalCertificateRequest, options?: any) {
44404
+ return CustomerApiFp(configuration).adjustInternalCertificate(customer_profile_oid, adjust_internal_certificate_request, options)(fetch, basePath);
44405
+ },
44178
44406
  /**
44179
44407
  * Delete a customer on the UltraCart account.
44180
44408
  * @summary Delete a customer
@@ -44354,6 +44582,17 @@ export const CustomerApiFactory = function (configuration?: Configuration, fetch
44354
44582
  * @interface CustomerApi
44355
44583
  */
44356
44584
  export interface CustomerApiInterface {
44585
+ /**
44586
+ * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
44587
+ * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
44588
+ * @param {number} customer_profile_oid The customer profile oid
44589
+ * @param {AdjustInternalCertificateRequest} adjust_internal_certificate_request adjustInternalCertificateRequest
44590
+ * @param {*} [options] Override http request option.
44591
+ * @throws {RequiredError}
44592
+ * @memberof CustomerApiInterface
44593
+ */
44594
+ adjustInternalCertificate(customer_profile_oid: number, adjust_internal_certificate_request: AdjustInternalCertificateRequest, options?: any): Promise<AdjustInternalCertificateResponse>;
44595
+
44357
44596
  /**
44358
44597
  * Delete a customer on the UltraCart account.
44359
44598
  * @summary Delete a customer
@@ -44533,6 +44772,19 @@ export interface CustomerApiInterface {
44533
44772
  * @extends {BaseAPI}
44534
44773
  */
44535
44774
  export class CustomerApi extends BaseAPI implements CustomerApiInterface {
44775
+ /**
44776
+ * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
44777
+ * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
44778
+ * @param {number} customer_profile_oid The customer profile oid
44779
+ * @param {AdjustInternalCertificateRequest} adjust_internal_certificate_request adjustInternalCertificateRequest
44780
+ * @param {*} [options] Override http request option.
44781
+ * @throws {RequiredError}
44782
+ * @memberof CustomerApi
44783
+ */
44784
+ public adjustInternalCertificate(customer_profile_oid: number, adjust_internal_certificate_request: AdjustInternalCertificateRequest, options?: any) {
44785
+ return CustomerApiFp(this.configuration).adjustInternalCertificate(customer_profile_oid, adjust_internal_certificate_request, options)(this.fetch, this.basePath);
44786
+ }
44787
+
44536
44788
  /**
44537
44789
  * Delete a customer on the UltraCart account.
44538
44790
  * @summary Delete a customer
@@ -46506,6 +46758,70 @@ export const IntegrationLogApiFetchParamCreator = function (configuration?: Conf
46506
46758
 
46507
46759
 
46508
46760
 
46761
+ // authentication ultraCartOauth required
46762
+ // oauth required
46763
+ if (configuration && configuration.accessToken) {
46764
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
46765
+ ? configuration.accessToken("ultraCartOauth", ["integration_log_read"])
46766
+ : configuration.accessToken;
46767
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
46768
+ }
46769
+
46770
+ // authentication ultraCartSimpleApiKey required
46771
+ if (configuration && configuration.apiKey) {
46772
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
46773
+ ? configuration.apiKey("x-ultracart-simple-key")
46774
+ : configuration.apiKey;
46775
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
46776
+ }
46777
+
46778
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
46779
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
46780
+ delete localVarUrlObj.search;
46781
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
46782
+
46783
+ return {
46784
+ url: url.format(localVarUrlObj),
46785
+ options: localVarRequestOptions,
46786
+ };
46787
+ },
46788
+ /**
46789
+ * Retrieve an integration log file from the account based identifiers
46790
+ * @summary Retrieve an integration log file converted to PDF
46791
+ * @param {string} pk
46792
+ * @param {string} sk
46793
+ * @param {string} uuid
46794
+ * @param {*} [options] Override http request option.
46795
+ * @throws {RequiredError}
46796
+ */
46797
+ getIntegrationLogFilePdf(pk: string, sk: string, uuid: string, options: any = {}): FetchArgs {
46798
+ // verify required parameter 'pk' is not null or undefined
46799
+ if (pk === null || pk === undefined) {
46800
+ throw new RequiredError('pk','Required parameter pk was null or undefined when calling getIntegrationLogFilePdf.');
46801
+ }
46802
+ // verify required parameter 'sk' is not null or undefined
46803
+ if (sk === null || sk === undefined) {
46804
+ throw new RequiredError('sk','Required parameter sk was null or undefined when calling getIntegrationLogFilePdf.');
46805
+ }
46806
+ // verify required parameter 'uuid' is not null or undefined
46807
+ if (uuid === null || uuid === undefined) {
46808
+ throw new RequiredError('uuid','Required parameter uuid was null or undefined when calling getIntegrationLogFilePdf.');
46809
+ }
46810
+ const localVarPath = `/integration_log/query/{pk}/{sk}/{uuid}/pdf`
46811
+ .replace(`{${"pk"}}`, encodeURIComponent(String(pk)))
46812
+ .replace(`{${"sk"}}`, encodeURIComponent(String(sk)))
46813
+ .replace(`{${"uuid"}}`, encodeURIComponent(String(uuid)));
46814
+ const localVarUrlObj = url.parse(localVarPath, true);
46815
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
46816
+ const localVarHeaderParameter = {} as any;
46817
+ const localVarQueryParameter = {} as any;
46818
+
46819
+ if(configuration && configuration.apiVersion) {
46820
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
46821
+ }
46822
+
46823
+
46824
+
46509
46825
  // authentication ultraCartOauth required
46510
46826
  // oauth required
46511
46827
  if (configuration && configuration.accessToken) {
@@ -46712,6 +47028,29 @@ export const IntegrationLogApiFp = function(configuration?: Configuration) {
46712
47028
  });
46713
47029
  };
46714
47030
  },
47031
+ /**
47032
+ * Retrieve an integration log file from the account based identifiers
47033
+ * @summary Retrieve an integration log file converted to PDF
47034
+ * @param {string} pk
47035
+ * @param {string} sk
47036
+ * @param {string} uuid
47037
+ * @param {*} [options] Override http request option.
47038
+ * @throws {RequiredError}
47039
+ */
47040
+ getIntegrationLogFilePdf(pk: string, sk: string, uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Blob> {
47041
+ const localVarFetchArgs = IntegrationLogApiFetchParamCreator(configuration).getIntegrationLogFilePdf(pk, sk, uuid, options);
47042
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
47043
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
47044
+
47045
+ if (response.status >= 200 && response.status < 300) {
47046
+
47047
+ return response.blob();
47048
+ } else {
47049
+ throw response;
47050
+ }
47051
+ });
47052
+ };
47053
+ },
46715
47054
  /**
46716
47055
  * Retrieves a set of integration log summaries from the account based on a query object.
46717
47056
  * @summary Retrieve integration log summaries
@@ -46789,6 +47128,18 @@ export const IntegrationLogApiFactory = function (configuration?: Configuration,
46789
47128
  getIntegrationLogFile(pk: string, sk: string, uuid: string, options?: any) {
46790
47129
  return IntegrationLogApiFp(configuration).getIntegrationLogFile(pk, sk, uuid, options)(fetch, basePath);
46791
47130
  },
47131
+ /**
47132
+ * Retrieve an integration log file from the account based identifiers
47133
+ * @summary Retrieve an integration log file converted to PDF
47134
+ * @param {string} pk
47135
+ * @param {string} sk
47136
+ * @param {string} uuid
47137
+ * @param {*} [options] Override http request option.
47138
+ * @throws {RequiredError}
47139
+ */
47140
+ getIntegrationLogFilePdf(pk: string, sk: string, uuid: string, options?: any) {
47141
+ return IntegrationLogApiFp(configuration).getIntegrationLogFilePdf(pk, sk, uuid, options)(fetch, basePath);
47142
+ },
46792
47143
  /**
46793
47144
  * Retrieves a set of integration log summaries from the account based on a query object.
46794
47145
  * @summary Retrieve integration log summaries
@@ -46844,6 +47195,18 @@ export interface IntegrationLogApiInterface {
46844
47195
  */
46845
47196
  getIntegrationLogFile(pk: string, sk: string, uuid: string, options?: any): Promise<Blob>;
46846
47197
 
47198
+ /**
47199
+ * Retrieve an integration log file from the account based identifiers
47200
+ * @summary Retrieve an integration log file converted to PDF
47201
+ * @param {string} pk
47202
+ * @param {string} sk
47203
+ * @param {string} uuid
47204
+ * @param {*} [options] Override http request option.
47205
+ * @throws {RequiredError}
47206
+ * @memberof IntegrationLogApiInterface
47207
+ */
47208
+ getIntegrationLogFilePdf(pk: string, sk: string, uuid: string, options?: any): Promise<Blob>;
47209
+
46847
47210
  /**
46848
47211
  * Retrieves a set of integration log summaries from the account based on a query object.
46849
47212
  * @summary Retrieve integration log summaries
@@ -46903,6 +47266,20 @@ export class IntegrationLogApi extends BaseAPI implements IntegrationLogApiInter
46903
47266
  return IntegrationLogApiFp(this.configuration).getIntegrationLogFile(pk, sk, uuid, options)(this.fetch, this.basePath);
46904
47267
  }
46905
47268
 
47269
+ /**
47270
+ * Retrieve an integration log file from the account based identifiers
47271
+ * @summary Retrieve an integration log file converted to PDF
47272
+ * @param {string} pk
47273
+ * @param {string} sk
47274
+ * @param {string} uuid
47275
+ * @param {*} [options] Override http request option.
47276
+ * @throws {RequiredError}
47277
+ * @memberof IntegrationLogApi
47278
+ */
47279
+ public getIntegrationLogFilePdf(pk: string, sk: string, uuid: string, options?: any) {
47280
+ return IntegrationLogApiFp(this.configuration).getIntegrationLogFilePdf(pk, sk, uuid, options)(this.fetch, this.basePath);
47281
+ }
47282
+
46906
47283
  /**
46907
47284
  * Retrieves a set of integration log summaries from the account based on a query object.
46908
47285
  * @summary Retrieve integration log summaries
package/dist/api.d.ts CHANGED
@@ -519,6 +519,92 @@ export interface AddLibraryItemRequest {
519
519
  */
520
520
  uuid?: string;
521
521
  }
522
+ /**
523
+ *
524
+ * @export
525
+ * @interface AdjustInternalCertificateRequest
526
+ */
527
+ export interface AdjustInternalCertificateRequest {
528
+ /**
529
+ * The adjustment amount
530
+ * @type {number}
531
+ * @memberof AdjustInternalCertificateRequest
532
+ */
533
+ adjustment_amount?: number;
534
+ /**
535
+ * Description of this adjustment, 50 characters max
536
+ * @type {string}
537
+ * @memberof AdjustInternalCertificateRequest
538
+ */
539
+ description?: string;
540
+ /**
541
+ * Optional timestamp for the adjustment, defaults to current time
542
+ * @type {string}
543
+ * @memberof AdjustInternalCertificateRequest
544
+ */
545
+ entry_dts?: string;
546
+ /**
547
+ * Optional expiration days from the entry_dts when these adjustment becomes worthless
548
+ * @type {number}
549
+ * @memberof AdjustInternalCertificateRequest
550
+ */
551
+ expiration_days?: number;
552
+ /**
553
+ * Optional order id if this adjustment is related to a particular order
554
+ * @type {string}
555
+ * @memberof AdjustInternalCertificateRequest
556
+ */
557
+ order_id?: string;
558
+ /**
559
+ * Optional days required for this adjustment to vest
560
+ * @type {number}
561
+ * @memberof AdjustInternalCertificateRequest
562
+ */
563
+ vesting_days?: number;
564
+ }
565
+ /**
566
+ *
567
+ * @export
568
+ * @interface AdjustInternalCertificateResponse
569
+ */
570
+ export interface AdjustInternalCertificateResponse {
571
+ /**
572
+ * The adjustment amount
573
+ * @type {number}
574
+ * @memberof AdjustInternalCertificateResponse
575
+ */
576
+ adjustment_amount?: number;
577
+ /**
578
+ * The balance amount after the adjustment was made
579
+ * @type {number}
580
+ * @memberof AdjustInternalCertificateResponse
581
+ */
582
+ balance_amount?: number;
583
+ /**
584
+ *
585
+ * @type {ModelError}
586
+ * @memberof AdjustInternalCertificateResponse
587
+ */
588
+ error?: ModelError;
589
+ /**
590
+ *
591
+ * @type {ResponseMetadata}
592
+ * @memberof AdjustInternalCertificateResponse
593
+ */
594
+ metadata?: ResponseMetadata;
595
+ /**
596
+ * Indicates if API call was successful
597
+ * @type {boolean}
598
+ * @memberof AdjustInternalCertificateResponse
599
+ */
600
+ success?: boolean;
601
+ /**
602
+ *
603
+ * @type {Warning}
604
+ * @memberof AdjustInternalCertificateResponse
605
+ */
606
+ warning?: Warning;
607
+ }
522
608
  /**
523
609
  *
524
610
  * @export
@@ -1187,6 +1273,12 @@ export interface AutoOrder {
1187
1273
  * @memberof AutoOrder
1188
1274
  */
1189
1275
  cancel_downgrade?: boolean;
1276
+ /**
1277
+ * The reason this auto order was canceled by either merchant or customer
1278
+ * @type {string}
1279
+ * @memberof AutoOrder
1280
+ */
1281
+ cancel_reason?: string;
1190
1282
  /**
1191
1283
  * True if the auto order was canceled because the customer purchased an upgrade item
1192
1284
  * @type {boolean}
@@ -8120,11 +8212,17 @@ export interface CustomerEmailListChanges {
8120
8212
  */
8121
8213
  export interface CustomerLoyalty {
8122
8214
  /**
8123
- * Current Points
8215
+ * Current points
8124
8216
  * @type {number}
8125
8217
  * @memberof CustomerLoyalty
8126
8218
  */
8127
8219
  current_points?: number;
8220
+ /**
8221
+ *
8222
+ * @type {GiftCertificate}
8223
+ * @memberof CustomerLoyalty
8224
+ */
8225
+ internal_gift_certificate?: GiftCertificate;
8128
8226
  /**
8129
8227
  * Loyalty Cashback / Store credit balance (internal gift certificate balance)
8130
8228
  * @type {string}
@@ -9843,6 +9941,12 @@ export interface EmailCommseqEmail {
9843
9941
  * @memberof EmailCommseqEmail
9844
9942
  */
9845
9943
  library_item_oid?: number;
9944
+ /**
9945
+ * True if email links should contain magic link tokens to log the customer in automatically
9946
+ * @type {boolean}
9947
+ * @memberof EmailCommseqEmail
9948
+ */
9949
+ magic_link?: boolean;
9846
9950
  /**
9847
9951
  * Merchant ID
9848
9952
  * @type {string}
@@ -10210,17 +10314,17 @@ export interface EmailCommseqPostcard {
10210
10314
  */
10211
10315
  postcard_front_container_uuid?: string;
10212
10316
  /**
10213
- * URL for front screenshot
10317
+ * URL to screenshot of the back of the postcard
10214
10318
  * @type {string}
10215
10319
  * @memberof EmailCommseqPostcard
10216
10320
  */
10217
- screenshot_front_url?: string;
10321
+ screenshot_back_url?: string;
10218
10322
  /**
10219
- * URL for back screenshot
10323
+ * URL to screenshot of the front of the postcard
10220
10324
  * @type {string}
10221
10325
  * @memberof EmailCommseqPostcard
10222
10326
  */
10223
- screenshot_small_full_url?: string;
10327
+ screenshot_front_url?: string;
10224
10328
  /**
10225
10329
  * Storefront oid
10226
10330
  * @type {number}
@@ -12480,6 +12584,12 @@ export interface EmailPerformance {
12480
12584
  * @memberof EmailPerformance
12481
12585
  */
12482
12586
  delivered_count?: number;
12587
+ /**
12588
+ * Loyalty Program Type
12589
+ * @type {string}
12590
+ * @memberof EmailPerformance
12591
+ */
12592
+ loyalty_program_type?: EmailPerformance.LoyaltyProgramTypeEnum;
12483
12593
  /**
12484
12594
  * Maximum active customers allowed under their billing plan
12485
12595
  * @type {number}
@@ -12565,6 +12675,21 @@ export interface EmailPerformance {
12565
12675
  */
12566
12676
  transactional_send_count?: number;
12567
12677
  }
12678
+ /**
12679
+ * @export
12680
+ * @namespace EmailPerformance
12681
+ */
12682
+ export declare namespace EmailPerformance {
12683
+ /**
12684
+ * @export
12685
+ * @enum {string}
12686
+ */
12687
+ enum LoyaltyProgramTypeEnum {
12688
+ Disabled,
12689
+ Points,
12690
+ Cashback
12691
+ }
12692
+ }
12568
12693
  /**
12569
12694
  *
12570
12695
  * @export
@@ -21860,6 +21985,12 @@ export interface OrderAutoOrder {
21860
21985
  * @memberof OrderAutoOrder
21861
21986
  */
21862
21987
  cancel_downgrade?: boolean;
21988
+ /**
21989
+ * The reason this auto order was canceled by either merchant or customer
21990
+ * @type {string}
21991
+ * @memberof OrderAutoOrder
21992
+ */
21993
+ cancel_reason?: string;
21863
21994
  /**
21864
21995
  * True if the auto order was canceled because the customer purchased an upgrade item
21865
21996
  * @type {boolean}
@@ -37269,6 +37400,15 @@ export declare class CouponApi extends BaseAPI implements CouponApiInterface {
37269
37400
  * @export
37270
37401
  */
37271
37402
  export declare const CustomerApiFetchParamCreator: (configuration?: Configuration) => {
37403
+ /**
37404
+ * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
37405
+ * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
37406
+ * @param {number} customer_profile_oid The customer profile oid
37407
+ * @param {AdjustInternalCertificateRequest} adjust_internal_certificate_request adjustInternalCertificateRequest
37408
+ * @param {*} [options] Override http request option.
37409
+ * @throws {RequiredError}
37410
+ */
37411
+ adjustInternalCertificate(customer_profile_oid: number, adjust_internal_certificate_request: AdjustInternalCertificateRequest, options?: any): FetchArgs;
37272
37412
  /**
37273
37413
  * Delete a customer on the UltraCart account.
37274
37414
  * @summary Delete a customer
@@ -37419,6 +37559,15 @@ export declare const CustomerApiFetchParamCreator: (configuration?: Configuratio
37419
37559
  * @export
37420
37560
  */
37421
37561
  export declare const CustomerApiFp: (configuration?: Configuration) => {
37562
+ /**
37563
+ * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
37564
+ * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
37565
+ * @param {number} customer_profile_oid The customer profile oid
37566
+ * @param {AdjustInternalCertificateRequest} adjust_internal_certificate_request adjustInternalCertificateRequest
37567
+ * @param {*} [options] Override http request option.
37568
+ * @throws {RequiredError}
37569
+ */
37570
+ adjustInternalCertificate(customer_profile_oid: number, adjust_internal_certificate_request: AdjustInternalCertificateRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<AdjustInternalCertificateResponse>;
37422
37571
  /**
37423
37572
  * Delete a customer on the UltraCart account.
37424
37573
  * @summary Delete a customer
@@ -37569,6 +37718,15 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
37569
37718
  * @export
37570
37719
  */
37571
37720
  export declare const CustomerApiFactory: (configuration?: Configuration, fetch?: FetchAPI, basePath?: string) => {
37721
+ /**
37722
+ * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
37723
+ * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
37724
+ * @param {number} customer_profile_oid The customer profile oid
37725
+ * @param {AdjustInternalCertificateRequest} adjust_internal_certificate_request adjustInternalCertificateRequest
37726
+ * @param {*} [options] Override http request option.
37727
+ * @throws {RequiredError}
37728
+ */
37729
+ adjustInternalCertificate(customer_profile_oid: number, adjust_internal_certificate_request: AdjustInternalCertificateRequest, options?: any): Promise<AdjustInternalCertificateResponse>;
37572
37730
  /**
37573
37731
  * Delete a customer on the UltraCart account.
37574
37732
  * @summary Delete a customer
@@ -37720,6 +37878,16 @@ export declare const CustomerApiFactory: (configuration?: Configuration, fetch?:
37720
37878
  * @interface CustomerApi
37721
37879
  */
37722
37880
  export interface CustomerApiInterface {
37881
+ /**
37882
+ * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
37883
+ * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
37884
+ * @param {number} customer_profile_oid The customer profile oid
37885
+ * @param {AdjustInternalCertificateRequest} adjust_internal_certificate_request adjustInternalCertificateRequest
37886
+ * @param {*} [options] Override http request option.
37887
+ * @throws {RequiredError}
37888
+ * @memberof CustomerApiInterface
37889
+ */
37890
+ adjustInternalCertificate(customer_profile_oid: number, adjust_internal_certificate_request: AdjustInternalCertificateRequest, options?: any): Promise<AdjustInternalCertificateResponse>;
37723
37891
  /**
37724
37892
  * Delete a customer on the UltraCart account.
37725
37893
  * @summary Delete a customer
@@ -37885,6 +38053,16 @@ export interface CustomerApiInterface {
37885
38053
  * @extends {BaseAPI}
37886
38054
  */
37887
38055
  export declare class CustomerApi extends BaseAPI implements CustomerApiInterface {
38056
+ /**
38057
+ * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
38058
+ * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
38059
+ * @param {number} customer_profile_oid The customer profile oid
38060
+ * @param {AdjustInternalCertificateRequest} adjust_internal_certificate_request adjustInternalCertificateRequest
38061
+ * @param {*} [options] Override http request option.
38062
+ * @throws {RequiredError}
38063
+ * @memberof CustomerApi
38064
+ */
38065
+ adjustInternalCertificate(customer_profile_oid: number, adjust_internal_certificate_request: AdjustInternalCertificateRequest, options?: any): Promise<AdjustInternalCertificateResponse>;
37888
38066
  /**
37889
38067
  * Delete a customer on the UltraCart account.
37890
38068
  * @summary Delete a customer
@@ -38771,6 +38949,16 @@ export declare const IntegrationLogApiFetchParamCreator: (configuration?: Config
38771
38949
  * @throws {RequiredError}
38772
38950
  */
38773
38951
  getIntegrationLogFile(pk: string, sk: string, uuid: string, options?: any): FetchArgs;
38952
+ /**
38953
+ * Retrieve an integration log file from the account based identifiers
38954
+ * @summary Retrieve an integration log file converted to PDF
38955
+ * @param {string} pk
38956
+ * @param {string} sk
38957
+ * @param {string} uuid
38958
+ * @param {*} [options] Override http request option.
38959
+ * @throws {RequiredError}
38960
+ */
38961
+ getIntegrationLogFilePdf(pk: string, sk: string, uuid: string, options?: any): FetchArgs;
38774
38962
  /**
38775
38963
  * Retrieves a set of integration log summaries from the account based on a query object.
38776
38964
  * @summary Retrieve integration log summaries
@@ -38815,6 +39003,16 @@ export declare const IntegrationLogApiFp: (configuration?: Configuration) => {
38815
39003
  * @throws {RequiredError}
38816
39004
  */
38817
39005
  getIntegrationLogFile(pk: string, sk: string, uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Blob>;
39006
+ /**
39007
+ * Retrieve an integration log file from the account based identifiers
39008
+ * @summary Retrieve an integration log file converted to PDF
39009
+ * @param {string} pk
39010
+ * @param {string} sk
39011
+ * @param {string} uuid
39012
+ * @param {*} [options] Override http request option.
39013
+ * @throws {RequiredError}
39014
+ */
39015
+ getIntegrationLogFilePdf(pk: string, sk: string, uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Blob>;
38818
39016
  /**
38819
39017
  * Retrieves a set of integration log summaries from the account based on a query object.
38820
39018
  * @summary Retrieve integration log summaries
@@ -38859,6 +39057,16 @@ export declare const IntegrationLogApiFactory: (configuration?: Configuration, f
38859
39057
  * @throws {RequiredError}
38860
39058
  */
38861
39059
  getIntegrationLogFile(pk: string, sk: string, uuid: string, options?: any): Promise<Blob>;
39060
+ /**
39061
+ * Retrieve an integration log file from the account based identifiers
39062
+ * @summary Retrieve an integration log file converted to PDF
39063
+ * @param {string} pk
39064
+ * @param {string} sk
39065
+ * @param {string} uuid
39066
+ * @param {*} [options] Override http request option.
39067
+ * @throws {RequiredError}
39068
+ */
39069
+ getIntegrationLogFilePdf(pk: string, sk: string, uuid: string, options?: any): Promise<Blob>;
38862
39070
  /**
38863
39071
  * Retrieves a set of integration log summaries from the account based on a query object.
38864
39072
  * @summary Retrieve integration log summaries
@@ -38906,6 +39114,17 @@ export interface IntegrationLogApiInterface {
38906
39114
  * @memberof IntegrationLogApiInterface
38907
39115
  */
38908
39116
  getIntegrationLogFile(pk: string, sk: string, uuid: string, options?: any): Promise<Blob>;
39117
+ /**
39118
+ * Retrieve an integration log file from the account based identifiers
39119
+ * @summary Retrieve an integration log file converted to PDF
39120
+ * @param {string} pk
39121
+ * @param {string} sk
39122
+ * @param {string} uuid
39123
+ * @param {*} [options] Override http request option.
39124
+ * @throws {RequiredError}
39125
+ * @memberof IntegrationLogApiInterface
39126
+ */
39127
+ getIntegrationLogFilePdf(pk: string, sk: string, uuid: string, options?: any): Promise<Blob>;
38909
39128
  /**
38910
39129
  * Retrieves a set of integration log summaries from the account based on a query object.
38911
39130
  * @summary Retrieve integration log summaries
@@ -38956,6 +39175,17 @@ export declare class IntegrationLogApi extends BaseAPI implements IntegrationLog
38956
39175
  * @memberof IntegrationLogApi
38957
39176
  */
38958
39177
  getIntegrationLogFile(pk: string, sk: string, uuid: string, options?: any): Promise<Blob>;
39178
+ /**
39179
+ * Retrieve an integration log file from the account based identifiers
39180
+ * @summary Retrieve an integration log file converted to PDF
39181
+ * @param {string} pk
39182
+ * @param {string} sk
39183
+ * @param {string} uuid
39184
+ * @param {*} [options] Override http request option.
39185
+ * @throws {RequiredError}
39186
+ * @memberof IntegrationLogApi
39187
+ */
39188
+ getIntegrationLogFilePdf(pk: string, sk: string, uuid: string, options?: any): Promise<Blob>;
38959
39189
  /**
38960
39190
  * Retrieves a set of integration log summaries from the account based on a query object.
38961
39191
  * @summary Retrieve integration log summaries
package/dist/api.js CHANGED
@@ -28,9 +28,9 @@ var __extends = (this && this.__extends) || (function () {
28
28
  };
29
29
  })();
30
30
  Object.defineProperty(exports, "__esModule", { value: true });
31
- exports.TempMultimedia = exports.RtgThemeRestriction = exports.RotatingTransactionGateway = exports.PaymentsThemeTransactionType = exports.PaymentsConfigurationTestMethod = exports.PaymentsConfigurationSezzle = exports.PaymentsConfigurationRestrictions = exports.PaymentsConfigurationPayPal = exports.PaymentsConfigurationCreditCardType = exports.PaymentsConfigurationAmazon = exports.PaymentsConfigurationAffirm = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = exports.ItemTax = exports.ItemTag = exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailCommseqStep = exports.Distance = exports.CheckoutHandoffRequest = exports.CartKitComponentOption = exports.CartItemOption = exports.CartItemMultimedia = exports.CartCustomerProfileCreditCard = exports.AutoOrderItemSimpleSchedule = exports.AutoOrderItem = exports.AutoOrder = exports.AffiliateLink = exports.AffiliateLedger = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = void 0;
32
- exports.OauthApiFactory = exports.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = exports.IntegrationLogApiFp = exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConfigurationApi = exports.ConfigurationApiFactory = exports.ConfigurationApiFp = exports.ConfigurationApiFetchParamCreator = exports.CheckoutApi = exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChargebackApi = exports.ChargebackApiFactory = exports.ChargebackApiFp = exports.ChargebackApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.Weight = exports.Webhook = exports.TransactionGatewaysRequest = void 0;
33
- exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = exports.TaxApiFp = exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = void 0;
31
+ exports.RtgThemeRestriction = exports.RotatingTransactionGateway = exports.PaymentsThemeTransactionType = exports.PaymentsConfigurationTestMethod = exports.PaymentsConfigurationSezzle = exports.PaymentsConfigurationRestrictions = exports.PaymentsConfigurationPayPal = exports.PaymentsConfigurationCreditCardType = exports.PaymentsConfigurationAmazon = exports.PaymentsConfigurationAffirm = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = exports.ItemTax = exports.ItemTag = exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailPerformance = exports.EmailCommseqStep = exports.Distance = exports.CheckoutHandoffRequest = exports.CartKitComponentOption = exports.CartItemOption = exports.CartItemMultimedia = exports.CartCustomerProfileCreditCard = exports.AutoOrderItemSimpleSchedule = exports.AutoOrderItem = exports.AutoOrder = exports.AffiliateLink = exports.AffiliateLedger = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = void 0;
32
+ exports.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = exports.IntegrationLogApiFp = exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConfigurationApi = exports.ConfigurationApiFactory = exports.ConfigurationApiFp = exports.ConfigurationApiFetchParamCreator = exports.CheckoutApi = exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChargebackApi = exports.ChargebackApiFactory = exports.ChargebackApiFp = exports.ChargebackApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.Weight = exports.Webhook = exports.TransactionGatewaysRequest = exports.TempMultimedia = void 0;
33
+ exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = exports.TaxApiFp = exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = exports.OauthApiFactory = void 0;
34
34
  var url = require("url");
35
35
  var portableFetch = require("portable-fetch");
36
36
  var BASE_PATH = "https://secure.ultracart.com/rest/v2".replace(/\/+$/, "");
@@ -344,6 +344,23 @@ var EmailCommseqStep;
344
344
  TypeEnum[TypeEnum["End"] = 'end'] = "End";
345
345
  })(TypeEnum = EmailCommseqStep.TypeEnum || (EmailCommseqStep.TypeEnum = {}));
346
346
  })(EmailCommseqStep = exports.EmailCommseqStep || (exports.EmailCommseqStep = {}));
347
+ /**
348
+ * @export
349
+ * @namespace EmailPerformance
350
+ */
351
+ var EmailPerformance;
352
+ (function (EmailPerformance) {
353
+ /**
354
+ * @export
355
+ * @enum {string}
356
+ */
357
+ var LoyaltyProgramTypeEnum;
358
+ (function (LoyaltyProgramTypeEnum) {
359
+ LoyaltyProgramTypeEnum[LoyaltyProgramTypeEnum["Disabled"] = 'disabled'] = "Disabled";
360
+ LoyaltyProgramTypeEnum[LoyaltyProgramTypeEnum["Points"] = 'points'] = "Points";
361
+ LoyaltyProgramTypeEnum[LoyaltyProgramTypeEnum["Cashback"] = 'cashback'] = "Cashback";
362
+ })(LoyaltyProgramTypeEnum = EmailPerformance.LoyaltyProgramTypeEnum || (EmailPerformance.LoyaltyProgramTypeEnum = {}));
363
+ })(EmailPerformance = exports.EmailPerformance || (exports.EmailPerformance = {}));
347
364
  /**
348
365
  * @export
349
366
  * @namespace Experiment
@@ -8351,6 +8368,60 @@ exports.CouponApi = CouponApi;
8351
8368
  */
8352
8369
  var CustomerApiFetchParamCreator = function (configuration) {
8353
8370
  return {
8371
+ /**
8372
+ * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
8373
+ * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
8374
+ * @param {number} customer_profile_oid The customer profile oid
8375
+ * @param {AdjustInternalCertificateRequest} adjust_internal_certificate_request adjustInternalCertificateRequest
8376
+ * @param {*} [options] Override http request option.
8377
+ * @throws {RequiredError}
8378
+ */
8379
+ adjustInternalCertificate: function (customer_profile_oid, adjust_internal_certificate_request, options) {
8380
+ if (options === void 0) { options = {}; }
8381
+ // verify required parameter 'customer_profile_oid' is not null or undefined
8382
+ if (customer_profile_oid === null || customer_profile_oid === undefined) {
8383
+ throw new RequiredError('customer_profile_oid', 'Required parameter customer_profile_oid was null or undefined when calling adjustInternalCertificate.');
8384
+ }
8385
+ // verify required parameter 'adjust_internal_certificate_request' is not null or undefined
8386
+ if (adjust_internal_certificate_request === null || adjust_internal_certificate_request === undefined) {
8387
+ throw new RequiredError('adjust_internal_certificate_request', 'Required parameter adjust_internal_certificate_request was null or undefined when calling adjustInternalCertificate.');
8388
+ }
8389
+ var localVarPath = "/customer/customers/{customer_profile_oid}/adjust_cashback_balance"
8390
+ .replace("{".concat("customer_profile_oid", "}"), encodeURIComponent(String(customer_profile_oid)));
8391
+ var localVarUrlObj = url.parse(localVarPath, true);
8392
+ var localVarRequestOptions = Object.assign({ method: 'POST' }, options);
8393
+ var localVarHeaderParameter = {};
8394
+ var localVarQueryParameter = {};
8395
+ if (configuration && configuration.apiVersion) {
8396
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
8397
+ }
8398
+ // authentication ultraCartOauth required
8399
+ // oauth required
8400
+ if (configuration && configuration.accessToken) {
8401
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
8402
+ ? configuration.accessToken("ultraCartOauth", ["customer_write"])
8403
+ : configuration.accessToken;
8404
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
8405
+ }
8406
+ // authentication ultraCartSimpleApiKey required
8407
+ if (configuration && configuration.apiKey) {
8408
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
8409
+ ? configuration.apiKey("x-ultracart-simple-key")
8410
+ : configuration.apiKey;
8411
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
8412
+ }
8413
+ localVarHeaderParameter['Content-Type'] = 'application/json; charset=UTF-8';
8414
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
8415
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
8416
+ delete localVarUrlObj.search;
8417
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
8418
+ var needsSerialization = ("AdjustInternalCertificateRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
8419
+ localVarRequestOptions.body = needsSerialization ? JSON.stringify(adjust_internal_certificate_request || {}) : (adjust_internal_certificate_request || "");
8420
+ return {
8421
+ url: url.format(localVarUrlObj),
8422
+ options: localVarRequestOptions,
8423
+ };
8424
+ },
8354
8425
  /**
8355
8426
  * Delete a customer on the UltraCart account.
8356
8427
  * @summary Delete a customer
@@ -9126,6 +9197,29 @@ exports.CustomerApiFetchParamCreator = CustomerApiFetchParamCreator;
9126
9197
  */
9127
9198
  var CustomerApiFp = function (configuration) {
9128
9199
  return {
9200
+ /**
9201
+ * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
9202
+ * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
9203
+ * @param {number} customer_profile_oid The customer profile oid
9204
+ * @param {AdjustInternalCertificateRequest} adjust_internal_certificate_request adjustInternalCertificateRequest
9205
+ * @param {*} [options] Override http request option.
9206
+ * @throws {RequiredError}
9207
+ */
9208
+ adjustInternalCertificate: function (customer_profile_oid, adjust_internal_certificate_request, options) {
9209
+ var localVarFetchArgs = (0, exports.CustomerApiFetchParamCreator)(configuration).adjustInternalCertificate(customer_profile_oid, adjust_internal_certificate_request, options);
9210
+ return function (fetch, basePath) {
9211
+ if (fetch === void 0) { fetch = portableFetch; }
9212
+ if (basePath === void 0) { basePath = BASE_PATH; }
9213
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
9214
+ if (response.status >= 200 && response.status < 300) {
9215
+ return response.json();
9216
+ }
9217
+ else {
9218
+ throw response;
9219
+ }
9220
+ });
9221
+ };
9222
+ },
9129
9223
  /**
9130
9224
  * Delete a customer on the UltraCart account.
9131
9225
  * @summary Delete a customer
@@ -9461,6 +9555,17 @@ exports.CustomerApiFp = CustomerApiFp;
9461
9555
  */
9462
9556
  var CustomerApiFactory = function (configuration, fetch, basePath) {
9463
9557
  return {
9558
+ /**
9559
+ * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
9560
+ * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
9561
+ * @param {number} customer_profile_oid The customer profile oid
9562
+ * @param {AdjustInternalCertificateRequest} adjust_internal_certificate_request adjustInternalCertificateRequest
9563
+ * @param {*} [options] Override http request option.
9564
+ * @throws {RequiredError}
9565
+ */
9566
+ adjustInternalCertificate: function (customer_profile_oid, adjust_internal_certificate_request, options) {
9567
+ return (0, exports.CustomerApiFp)(configuration).adjustInternalCertificate(customer_profile_oid, adjust_internal_certificate_request, options)(fetch, basePath);
9568
+ },
9464
9569
  /**
9465
9570
  * Delete a customer on the UltraCart account.
9466
9571
  * @summary Delete a customer
@@ -9645,6 +9750,18 @@ var CustomerApi = /** @class */ (function (_super) {
9645
9750
  function CustomerApi() {
9646
9751
  return _super !== null && _super.apply(this, arguments) || this;
9647
9752
  }
9753
+ /**
9754
+ * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
9755
+ * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
9756
+ * @param {number} customer_profile_oid The customer profile oid
9757
+ * @param {AdjustInternalCertificateRequest} adjust_internal_certificate_request adjustInternalCertificateRequest
9758
+ * @param {*} [options] Override http request option.
9759
+ * @throws {RequiredError}
9760
+ * @memberof CustomerApi
9761
+ */
9762
+ CustomerApi.prototype.adjustInternalCertificate = function (customer_profile_oid, adjust_internal_certificate_request, options) {
9763
+ return (0, exports.CustomerApiFp)(this.configuration).adjustInternalCertificate(customer_profile_oid, adjust_internal_certificate_request, options)(this.fetch, this.basePath);
9764
+ };
9648
9765
  /**
9649
9766
  * Delete a customer on the UltraCart account.
9650
9767
  * @summary Delete a customer
@@ -11369,6 +11486,64 @@ var IntegrationLogApiFetchParamCreator = function (configuration) {
11369
11486
  options: localVarRequestOptions,
11370
11487
  };
11371
11488
  },
11489
+ /**
11490
+ * Retrieve an integration log file from the account based identifiers
11491
+ * @summary Retrieve an integration log file converted to PDF
11492
+ * @param {string} pk
11493
+ * @param {string} sk
11494
+ * @param {string} uuid
11495
+ * @param {*} [options] Override http request option.
11496
+ * @throws {RequiredError}
11497
+ */
11498
+ getIntegrationLogFilePdf: function (pk, sk, uuid, options) {
11499
+ if (options === void 0) { options = {}; }
11500
+ // verify required parameter 'pk' is not null or undefined
11501
+ if (pk === null || pk === undefined) {
11502
+ throw new RequiredError('pk', 'Required parameter pk was null or undefined when calling getIntegrationLogFilePdf.');
11503
+ }
11504
+ // verify required parameter 'sk' is not null or undefined
11505
+ if (sk === null || sk === undefined) {
11506
+ throw new RequiredError('sk', 'Required parameter sk was null or undefined when calling getIntegrationLogFilePdf.');
11507
+ }
11508
+ // verify required parameter 'uuid' is not null or undefined
11509
+ if (uuid === null || uuid === undefined) {
11510
+ throw new RequiredError('uuid', 'Required parameter uuid was null or undefined when calling getIntegrationLogFilePdf.');
11511
+ }
11512
+ var localVarPath = "/integration_log/query/{pk}/{sk}/{uuid}/pdf"
11513
+ .replace("{".concat("pk", "}"), encodeURIComponent(String(pk)))
11514
+ .replace("{".concat("sk", "}"), encodeURIComponent(String(sk)))
11515
+ .replace("{".concat("uuid", "}"), encodeURIComponent(String(uuid)));
11516
+ var localVarUrlObj = url.parse(localVarPath, true);
11517
+ var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
11518
+ var localVarHeaderParameter = {};
11519
+ var localVarQueryParameter = {};
11520
+ if (configuration && configuration.apiVersion) {
11521
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
11522
+ }
11523
+ // authentication ultraCartOauth required
11524
+ // oauth required
11525
+ if (configuration && configuration.accessToken) {
11526
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
11527
+ ? configuration.accessToken("ultraCartOauth", ["integration_log_read"])
11528
+ : configuration.accessToken;
11529
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
11530
+ }
11531
+ // authentication ultraCartSimpleApiKey required
11532
+ if (configuration && configuration.apiKey) {
11533
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
11534
+ ? configuration.apiKey("x-ultracart-simple-key")
11535
+ : configuration.apiKey;
11536
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
11537
+ }
11538
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
11539
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
11540
+ delete localVarUrlObj.search;
11541
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
11542
+ return {
11543
+ url: url.format(localVarUrlObj),
11544
+ options: localVarRequestOptions,
11545
+ };
11546
+ },
11372
11547
  /**
11373
11548
  * Retrieves a set of integration log summaries from the account based on a query object.
11374
11549
  * @summary Retrieve integration log summaries
@@ -11533,6 +11708,30 @@ var IntegrationLogApiFp = function (configuration) {
11533
11708
  });
11534
11709
  };
11535
11710
  },
11711
+ /**
11712
+ * Retrieve an integration log file from the account based identifiers
11713
+ * @summary Retrieve an integration log file converted to PDF
11714
+ * @param {string} pk
11715
+ * @param {string} sk
11716
+ * @param {string} uuid
11717
+ * @param {*} [options] Override http request option.
11718
+ * @throws {RequiredError}
11719
+ */
11720
+ getIntegrationLogFilePdf: function (pk, sk, uuid, options) {
11721
+ var localVarFetchArgs = (0, exports.IntegrationLogApiFetchParamCreator)(configuration).getIntegrationLogFilePdf(pk, sk, uuid, options);
11722
+ return function (fetch, basePath) {
11723
+ if (fetch === void 0) { fetch = portableFetch; }
11724
+ if (basePath === void 0) { basePath = BASE_PATH; }
11725
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
11726
+ if (response.status >= 200 && response.status < 300) {
11727
+ return response.blob();
11728
+ }
11729
+ else {
11730
+ throw response;
11731
+ }
11732
+ });
11733
+ };
11734
+ },
11536
11735
  /**
11537
11736
  * Retrieves a set of integration log summaries from the account based on a query object.
11538
11737
  * @summary Retrieve integration log summaries
@@ -11612,6 +11811,18 @@ var IntegrationLogApiFactory = function (configuration, fetch, basePath) {
11612
11811
  getIntegrationLogFile: function (pk, sk, uuid, options) {
11613
11812
  return (0, exports.IntegrationLogApiFp)(configuration).getIntegrationLogFile(pk, sk, uuid, options)(fetch, basePath);
11614
11813
  },
11814
+ /**
11815
+ * Retrieve an integration log file from the account based identifiers
11816
+ * @summary Retrieve an integration log file converted to PDF
11817
+ * @param {string} pk
11818
+ * @param {string} sk
11819
+ * @param {string} uuid
11820
+ * @param {*} [options] Override http request option.
11821
+ * @throws {RequiredError}
11822
+ */
11823
+ getIntegrationLogFilePdf: function (pk, sk, uuid, options) {
11824
+ return (0, exports.IntegrationLogApiFp)(configuration).getIntegrationLogFilePdf(pk, sk, uuid, options)(fetch, basePath);
11825
+ },
11615
11826
  /**
11616
11827
  * Retrieves a set of integration log summaries from the account based on a query object.
11617
11828
  * @summary Retrieve integration log summaries
@@ -11674,6 +11885,19 @@ var IntegrationLogApi = /** @class */ (function (_super) {
11674
11885
  IntegrationLogApi.prototype.getIntegrationLogFile = function (pk, sk, uuid, options) {
11675
11886
  return (0, exports.IntegrationLogApiFp)(this.configuration).getIntegrationLogFile(pk, sk, uuid, options)(this.fetch, this.basePath);
11676
11887
  };
11888
+ /**
11889
+ * Retrieve an integration log file from the account based identifiers
11890
+ * @summary Retrieve an integration log file converted to PDF
11891
+ * @param {string} pk
11892
+ * @param {string} sk
11893
+ * @param {string} uuid
11894
+ * @param {*} [options] Override http request option.
11895
+ * @throws {RequiredError}
11896
+ * @memberof IntegrationLogApi
11897
+ */
11898
+ IntegrationLogApi.prototype.getIntegrationLogFilePdf = function (pk, sk, uuid, options) {
11899
+ return (0, exports.IntegrationLogApiFp)(this.configuration).getIntegrationLogFilePdf(pk, sk, uuid, options)(this.fetch, this.basePath);
11900
+ };
11677
11901
  /**
11678
11902
  * Retrieves a set of integration log summaries from the account based on a query object.
11679
11903
  * @summary Retrieve integration log summaries
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.9.4",
3
+ "version": "3.9.7",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [