ultracart_rest_api_v2_typescript 3.10.101 → 3.10.103

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.10.101
1
+ ## ultracart_rest_api_v2_typescript@3.10.103
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install ultracart_rest_api_v2_typescript@3.10.101 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.103 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
54
54
 
55
55
  | Version | Date | Comments |
56
56
  | --: | :-: | --- |
57
+ | 3.10.103 | 01/19/2023 | added skip_on_rebill field to coupon object |
58
+ | 3.10.102 | 01/19/2023 | convo - getConversationPermissions added |
57
59
  | 3.10.101 | 01/18/2023 | conversation get dept member list method added |
58
60
  | 3.10.100 | 01/18/2023 | conversation dept members |
59
61
  | 3.10.99 | 01/18/2023 | channel partner ship to pref desc field |
package/api.ts CHANGED
@@ -7144,12 +7144,6 @@ export interface ConversationDepartmentsResponse {
7144
7144
  * @memberof ConversationDepartmentsResponse
7145
7145
  */
7146
7146
  metadata?: ResponseMetadata;
7147
- /**
7148
- *
7149
- * @type {boolean}
7150
- * @memberof ConversationDepartmentsResponse
7151
- */
7152
- read_only?: boolean;
7153
7147
  /**
7154
7148
  * Indicates if API call was successful
7155
7149
  * @type {boolean}
@@ -8097,6 +8091,58 @@ export interface ConversationParticipant {
8097
8091
  unread_messages?: number;
8098
8092
  }
8099
8093
 
8094
+ /**
8095
+ *
8096
+ * @export
8097
+ * @interface ConversationPermissions
8098
+ */
8099
+ export interface ConversationPermissions {
8100
+ /**
8101
+ *
8102
+ * @type {boolean}
8103
+ * @memberof ConversationPermissions
8104
+ */
8105
+ edit_settings?: boolean;
8106
+ }
8107
+
8108
+ /**
8109
+ *
8110
+ * @export
8111
+ * @interface ConversationPermissionsResponse
8112
+ */
8113
+ export interface ConversationPermissionsResponse {
8114
+ /**
8115
+ *
8116
+ * @type {ModelError}
8117
+ * @memberof ConversationPermissionsResponse
8118
+ */
8119
+ error?: ModelError;
8120
+ /**
8121
+ *
8122
+ * @type {ResponseMetadata}
8123
+ * @memberof ConversationPermissionsResponse
8124
+ */
8125
+ metadata?: ResponseMetadata;
8126
+ /**
8127
+ *
8128
+ * @type {ConversationPermissions}
8129
+ * @memberof ConversationPermissionsResponse
8130
+ */
8131
+ permissions?: ConversationPermissions;
8132
+ /**
8133
+ * Indicates if API call was successful
8134
+ * @type {boolean}
8135
+ * @memberof ConversationPermissionsResponse
8136
+ */
8137
+ success?: boolean;
8138
+ /**
8139
+ *
8140
+ * @type {Warning}
8141
+ * @memberof ConversationPermissionsResponse
8142
+ */
8143
+ warning?: Warning;
8144
+ }
8145
+
8100
8146
  /**
8101
8147
  *
8102
8148
  * @export
@@ -9345,6 +9391,12 @@ export interface Coupon {
9345
9391
  * @memberof Coupon
9346
9392
  */
9347
9393
  restrict_by_storefronts?: Array<CouponRestriction>;
9394
+ /**
9395
+ * Skip this coupon when it is on a rebill of an auto order.
9396
+ * @type {boolean}
9397
+ * @memberof Coupon
9398
+ */
9399
+ skip_on_rebill?: boolean;
9348
9400
  /**
9349
9401
  * Date/time when coupon is valid
9350
9402
  * @type {string}
@@ -44363,6 +44415,52 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
44363
44415
  options: localVarRequestOptions,
44364
44416
  };
44365
44417
  },
44418
+ /**
44419
+ * Retrieve conversation permissions
44420
+ * @summary Retrieve conversation permissions
44421
+ * @param {*} [options] Override http request option.
44422
+ * @throws {RequiredError}
44423
+ */
44424
+ getConversationPermissions(options: any = {}): FetchArgs {
44425
+ const localVarPath = `/conversation/permissions`;
44426
+ const localVarUrlObj = url.parse(localVarPath, true);
44427
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
44428
+ const localVarHeaderParameter = {} as any;
44429
+ const localVarQueryParameter = {} as any;
44430
+
44431
+ if(configuration && configuration.apiVersion) {
44432
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
44433
+ }
44434
+
44435
+
44436
+
44437
+ // authentication ultraCartOauth required
44438
+ // oauth required
44439
+ if (configuration && configuration.accessToken) {
44440
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
44441
+ ? configuration.accessToken("ultraCartOauth", ["conversation_read"])
44442
+ : configuration.accessToken;
44443
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
44444
+ }
44445
+
44446
+ // authentication ultraCartSimpleApiKey required
44447
+ if (configuration && configuration.apiKey) {
44448
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
44449
+ ? configuration.apiKey("x-ultracart-simple-key")
44450
+ : configuration.apiKey;
44451
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
44452
+ }
44453
+
44454
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
44455
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
44456
+ delete localVarUrlObj.search;
44457
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
44458
+
44459
+ return {
44460
+ url: url.format(localVarUrlObj),
44461
+ options: localVarRequestOptions,
44462
+ };
44463
+ },
44366
44464
  /**
44367
44465
  * Retrieve a conversation webchat queue statuses including agent status and queue entries
44368
44466
  * @summary Retrieve a conversation webchat queue statuses
@@ -45544,6 +45642,26 @@ export const ConversationApiFp = function(configuration?: Configuration) {
45544
45642
  });
45545
45643
  };
45546
45644
  },
45645
+ /**
45646
+ * Retrieve conversation permissions
45647
+ * @summary Retrieve conversation permissions
45648
+ * @param {*} [options] Override http request option.
45649
+ * @throws {RequiredError}
45650
+ */
45651
+ getConversationPermissions(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationPermissionsResponse> {
45652
+ const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getConversationPermissions(options);
45653
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
45654
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
45655
+
45656
+ if (response.status >= 200 && response.status < 300) {
45657
+ return response.json();
45658
+
45659
+ } else {
45660
+ throw response;
45661
+ }
45662
+ });
45663
+ };
45664
+ },
45547
45665
  /**
45548
45666
  * Retrieve a conversation webchat queue statuses including agent status and queue entries
45549
45667
  * @summary Retrieve a conversation webchat queue statuses
@@ -46023,6 +46141,15 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
46023
46141
  getConversationMultimediaUploadUrl(extension: string, options?: any) {
46024
46142
  return ConversationApiFp(configuration).getConversationMultimediaUploadUrl(extension, options)(fetch, basePath);
46025
46143
  },
46144
+ /**
46145
+ * Retrieve conversation permissions
46146
+ * @summary Retrieve conversation permissions
46147
+ * @param {*} [options] Override http request option.
46148
+ * @throws {RequiredError}
46149
+ */
46150
+ getConversationPermissions(options?: any) {
46151
+ return ConversationApiFp(configuration).getConversationPermissions(options)(fetch, basePath);
46152
+ },
46026
46153
  /**
46027
46154
  * Retrieve a conversation webchat queue statuses including agent status and queue entries
46028
46155
  * @summary Retrieve a conversation webchat queue statuses
@@ -46326,6 +46453,15 @@ export interface ConversationApiInterface {
46326
46453
  */
46327
46454
  getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
46328
46455
 
46456
+ /**
46457
+ * Retrieve conversation permissions
46458
+ * @summary Retrieve conversation permissions
46459
+ * @param {*} [options] Override http request option.
46460
+ * @throws {RequiredError}
46461
+ * @memberof ConversationApiInterface
46462
+ */
46463
+ getConversationPermissions(options?: any): Promise<ConversationPermissionsResponse>;
46464
+
46329
46465
  /**
46330
46466
  * Retrieve a conversation webchat queue statuses including agent status and queue entries
46331
46467
  * @summary Retrieve a conversation webchat queue statuses
@@ -46655,6 +46791,17 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
46655
46791
  return ConversationApiFp(this.configuration).getConversationMultimediaUploadUrl(extension, options)(this.fetch, this.basePath);
46656
46792
  }
46657
46793
 
46794
+ /**
46795
+ * Retrieve conversation permissions
46796
+ * @summary Retrieve conversation permissions
46797
+ * @param {*} [options] Override http request option.
46798
+ * @throws {RequiredError}
46799
+ * @memberof ConversationApi
46800
+ */
46801
+ public getConversationPermissions(options?: any) {
46802
+ return ConversationApiFp(this.configuration).getConversationPermissions(options)(this.fetch, this.basePath);
46803
+ }
46804
+
46658
46805
  /**
46659
46806
  * Retrieve a conversation webchat queue statuses including agent status and queue entries
46660
46807
  * @summary Retrieve a conversation webchat queue statuses
package/dist/api.d.ts CHANGED
@@ -6975,12 +6975,6 @@ export interface ConversationDepartmentsResponse {
6975
6975
  * @memberof ConversationDepartmentsResponse
6976
6976
  */
6977
6977
  metadata?: ResponseMetadata;
6978
- /**
6979
- *
6980
- * @type {boolean}
6981
- * @memberof ConversationDepartmentsResponse
6982
- */
6983
- read_only?: boolean;
6984
6978
  /**
6985
6979
  * Indicates if API call was successful
6986
6980
  * @type {boolean}
@@ -7901,6 +7895,56 @@ export interface ConversationParticipant {
7901
7895
  */
7902
7896
  unread_messages?: number;
7903
7897
  }
7898
+ /**
7899
+ *
7900
+ * @export
7901
+ * @interface ConversationPermissions
7902
+ */
7903
+ export interface ConversationPermissions {
7904
+ /**
7905
+ *
7906
+ * @type {boolean}
7907
+ * @memberof ConversationPermissions
7908
+ */
7909
+ edit_settings?: boolean;
7910
+ }
7911
+ /**
7912
+ *
7913
+ * @export
7914
+ * @interface ConversationPermissionsResponse
7915
+ */
7916
+ export interface ConversationPermissionsResponse {
7917
+ /**
7918
+ *
7919
+ * @type {ModelError}
7920
+ * @memberof ConversationPermissionsResponse
7921
+ */
7922
+ error?: ModelError;
7923
+ /**
7924
+ *
7925
+ * @type {ResponseMetadata}
7926
+ * @memberof ConversationPermissionsResponse
7927
+ */
7928
+ metadata?: ResponseMetadata;
7929
+ /**
7930
+ *
7931
+ * @type {ConversationPermissions}
7932
+ * @memberof ConversationPermissionsResponse
7933
+ */
7934
+ permissions?: ConversationPermissions;
7935
+ /**
7936
+ * Indicates if API call was successful
7937
+ * @type {boolean}
7938
+ * @memberof ConversationPermissionsResponse
7939
+ */
7940
+ success?: boolean;
7941
+ /**
7942
+ *
7943
+ * @type {Warning}
7944
+ * @memberof ConversationPermissionsResponse
7945
+ */
7946
+ warning?: Warning;
7947
+ }
7904
7948
  /**
7905
7949
  *
7906
7950
  * @export
@@ -9128,6 +9172,12 @@ export interface Coupon {
9128
9172
  * @memberof Coupon
9129
9173
  */
9130
9174
  restrict_by_storefronts?: Array<CouponRestriction>;
9175
+ /**
9176
+ * Skip this coupon when it is on a rebill of an auto order.
9177
+ * @type {boolean}
9178
+ * @memberof Coupon
9179
+ */
9180
+ skip_on_rebill?: boolean;
9131
9181
  /**
9132
9182
  * Date/time when coupon is valid
9133
9183
  * @type {string}
@@ -39615,6 +39665,13 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
39615
39665
  * @throws {RequiredError}
39616
39666
  */
39617
39667
  getConversationMultimediaUploadUrl(extension: string, options?: any): FetchArgs;
39668
+ /**
39669
+ * Retrieve conversation permissions
39670
+ * @summary Retrieve conversation permissions
39671
+ * @param {*} [options] Override http request option.
39672
+ * @throws {RequiredError}
39673
+ */
39674
+ getConversationPermissions(options?: any): FetchArgs;
39618
39675
  /**
39619
39676
  * Retrieve a conversation webchat queue statuses including agent status and queue entries
39620
39677
  * @summary Retrieve a conversation webchat queue statuses
@@ -39857,6 +39914,13 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
39857
39914
  * @throws {RequiredError}
39858
39915
  */
39859
39916
  getConversationMultimediaUploadUrl(extension: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationMultimediaUploadUrlResponse>;
39917
+ /**
39918
+ * Retrieve conversation permissions
39919
+ * @summary Retrieve conversation permissions
39920
+ * @param {*} [options] Override http request option.
39921
+ * @throws {RequiredError}
39922
+ */
39923
+ getConversationPermissions(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationPermissionsResponse>;
39860
39924
  /**
39861
39925
  * Retrieve a conversation webchat queue statuses including agent status and queue entries
39862
39926
  * @summary Retrieve a conversation webchat queue statuses
@@ -40099,6 +40163,13 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
40099
40163
  * @throws {RequiredError}
40100
40164
  */
40101
40165
  getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
40166
+ /**
40167
+ * Retrieve conversation permissions
40168
+ * @summary Retrieve conversation permissions
40169
+ * @param {*} [options] Override http request option.
40170
+ * @throws {RequiredError}
40171
+ */
40172
+ getConversationPermissions(options?: any): Promise<ConversationPermissionsResponse>;
40102
40173
  /**
40103
40174
  * Retrieve a conversation webchat queue statuses including agent status and queue entries
40104
40175
  * @summary Retrieve a conversation webchat queue statuses
@@ -40355,6 +40426,14 @@ export interface ConversationApiInterface {
40355
40426
  * @memberof ConversationApiInterface
40356
40427
  */
40357
40428
  getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
40429
+ /**
40430
+ * Retrieve conversation permissions
40431
+ * @summary Retrieve conversation permissions
40432
+ * @param {*} [options] Override http request option.
40433
+ * @throws {RequiredError}
40434
+ * @memberof ConversationApiInterface
40435
+ */
40436
+ getConversationPermissions(options?: any): Promise<ConversationPermissionsResponse>;
40358
40437
  /**
40359
40438
  * Retrieve a conversation webchat queue statuses including agent status and queue entries
40360
40439
  * @summary Retrieve a conversation webchat queue statuses
@@ -40628,6 +40707,14 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
40628
40707
  * @memberof ConversationApi
40629
40708
  */
40630
40709
  getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
40710
+ /**
40711
+ * Retrieve conversation permissions
40712
+ * @summary Retrieve conversation permissions
40713
+ * @param {*} [options] Override http request option.
40714
+ * @throws {RequiredError}
40715
+ * @memberof ConversationApi
40716
+ */
40717
+ getConversationPermissions(options?: any): Promise<ConversationPermissionsResponse>;
40631
40718
  /**
40632
40719
  * Retrieve a conversation webchat queue statuses including agent status and queue entries
40633
40720
  * @summary Retrieve a conversation webchat queue statuses
package/dist/api.js CHANGED
@@ -6729,6 +6729,46 @@ var ConversationApiFetchParamCreator = function (configuration) {
6729
6729
  options: localVarRequestOptions,
6730
6730
  };
6731
6731
  },
6732
+ /**
6733
+ * Retrieve conversation permissions
6734
+ * @summary Retrieve conversation permissions
6735
+ * @param {*} [options] Override http request option.
6736
+ * @throws {RequiredError}
6737
+ */
6738
+ getConversationPermissions: function (options) {
6739
+ if (options === void 0) { options = {}; }
6740
+ var localVarPath = "/conversation/permissions";
6741
+ var localVarUrlObj = url.parse(localVarPath, true);
6742
+ var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
6743
+ var localVarHeaderParameter = {};
6744
+ var localVarQueryParameter = {};
6745
+ if (configuration && configuration.apiVersion) {
6746
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
6747
+ }
6748
+ // authentication ultraCartOauth required
6749
+ // oauth required
6750
+ if (configuration && configuration.accessToken) {
6751
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
6752
+ ? configuration.accessToken("ultraCartOauth", ["conversation_read"])
6753
+ : configuration.accessToken;
6754
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
6755
+ }
6756
+ // authentication ultraCartSimpleApiKey required
6757
+ if (configuration && configuration.apiKey) {
6758
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
6759
+ ? configuration.apiKey("x-ultracart-simple-key")
6760
+ : configuration.apiKey;
6761
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
6762
+ }
6763
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
6764
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
6765
+ delete localVarUrlObj.search;
6766
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
6767
+ return {
6768
+ url: url.format(localVarUrlObj),
6769
+ options: localVarRequestOptions,
6770
+ };
6771
+ },
6732
6772
  /**
6733
6773
  * Retrieve a conversation webchat queue statuses including agent status and queue entries
6734
6774
  * @summary Retrieve a conversation webchat queue statuses
@@ -7811,6 +7851,27 @@ var ConversationApiFp = function (configuration) {
7811
7851
  });
7812
7852
  };
7813
7853
  },
7854
+ /**
7855
+ * Retrieve conversation permissions
7856
+ * @summary Retrieve conversation permissions
7857
+ * @param {*} [options] Override http request option.
7858
+ * @throws {RequiredError}
7859
+ */
7860
+ getConversationPermissions: function (options) {
7861
+ var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).getConversationPermissions(options);
7862
+ return function (fetch, basePath) {
7863
+ if (fetch === void 0) { fetch = portableFetch; }
7864
+ if (basePath === void 0) { basePath = BASE_PATH; }
7865
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
7866
+ if (response.status >= 200 && response.status < 300) {
7867
+ return response.json();
7868
+ }
7869
+ else {
7870
+ throw response;
7871
+ }
7872
+ });
7873
+ };
7874
+ },
7814
7875
  /**
7815
7876
  * Retrieve a conversation webchat queue statuses including agent status and queue entries
7816
7877
  * @summary Retrieve a conversation webchat queue statuses
@@ -8306,6 +8367,15 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
8306
8367
  getConversationMultimediaUploadUrl: function (extension, options) {
8307
8368
  return (0, exports.ConversationApiFp)(configuration).getConversationMultimediaUploadUrl(extension, options)(fetch, basePath);
8308
8369
  },
8370
+ /**
8371
+ * Retrieve conversation permissions
8372
+ * @summary Retrieve conversation permissions
8373
+ * @param {*} [options] Override http request option.
8374
+ * @throws {RequiredError}
8375
+ */
8376
+ getConversationPermissions: function (options) {
8377
+ return (0, exports.ConversationApiFp)(configuration).getConversationPermissions(options)(fetch, basePath);
8378
+ },
8309
8379
  /**
8310
8380
  * Retrieve a conversation webchat queue statuses including agent status and queue entries
8311
8381
  * @summary Retrieve a conversation webchat queue statuses
@@ -8627,6 +8697,16 @@ var ConversationApi = /** @class */ (function (_super) {
8627
8697
  ConversationApi.prototype.getConversationMultimediaUploadUrl = function (extension, options) {
8628
8698
  return (0, exports.ConversationApiFp)(this.configuration).getConversationMultimediaUploadUrl(extension, options)(this.fetch, this.basePath);
8629
8699
  };
8700
+ /**
8701
+ * Retrieve conversation permissions
8702
+ * @summary Retrieve conversation permissions
8703
+ * @param {*} [options] Override http request option.
8704
+ * @throws {RequiredError}
8705
+ * @memberof ConversationApi
8706
+ */
8707
+ ConversationApi.prototype.getConversationPermissions = function (options) {
8708
+ return (0, exports.ConversationApiFp)(this.configuration).getConversationPermissions(options)(this.fetch, this.basePath);
8709
+ };
8630
8710
  /**
8631
8711
  * Retrieve a conversation webchat queue statuses including agent status and queue entries
8632
8712
  * @summary Retrieve a conversation webchat queue statuses
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.10.101",
3
+ "version": "3.10.103",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [