ultracart_rest_api_v2_typescript 3.10.99 → 3.10.101

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.99
1
+ ## ultracart_rest_api_v2_typescript@3.10.101
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.99 --save
39
+ npm install ultracart_rest_api_v2_typescript@3.10.101 --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.101 | 01/18/2023 | conversation get dept member list method added |
58
+ | 3.10.100 | 01/18/2023 | conversation dept members |
57
59
  | 3.10.99 | 01/18/2023 | channel partner ship to pref desc field |
58
60
  | 3.10.98 | 01/17/2023 | changed convo webchat constant |
59
61
  | 3.10.97 | 01/17/2023 | support for checkout item properties |
package/api.ts CHANGED
@@ -6990,6 +6990,12 @@ export interface ConversationDepartment {
6990
6990
  * @memberof ConversationDepartment
6991
6991
  */
6992
6992
  department_name?: string;
6993
+ /**
6994
+ *
6995
+ * @type {Array<ConversationDepartmentMember>}
6996
+ * @memberof ConversationDepartment
6997
+ */
6998
+ members?: Array<ConversationDepartmentMember>;
6993
6999
  /**
6994
7000
  *
6995
7001
  * @type {string}
@@ -7004,6 +7010,70 @@ export interface ConversationDepartment {
7004
7010
  settings?: ConversationDepartmentSettings;
7005
7011
  }
7006
7012
 
7013
+ /**
7014
+ *
7015
+ * @export
7016
+ * @interface ConversationDepartmentMember
7017
+ */
7018
+ export interface ConversationDepartmentMember {
7019
+ /**
7020
+ *
7021
+ * @type {boolean}
7022
+ * @memberof ConversationDepartmentMember
7023
+ */
7024
+ member?: boolean;
7025
+ /**
7026
+ *
7027
+ * @type {string}
7028
+ * @memberof ConversationDepartmentMember
7029
+ */
7030
+ name?: string;
7031
+ /**
7032
+ *
7033
+ * @type {number}
7034
+ * @memberof ConversationDepartmentMember
7035
+ */
7036
+ user_id?: number;
7037
+ }
7038
+
7039
+ /**
7040
+ *
7041
+ * @export
7042
+ * @interface ConversationDepartmentMembersResponse
7043
+ */
7044
+ export interface ConversationDepartmentMembersResponse {
7045
+ /**
7046
+ *
7047
+ * @type {Array<ConversationDepartmentMember>}
7048
+ * @memberof ConversationDepartmentMembersResponse
7049
+ */
7050
+ conversation_department_members?: Array<ConversationDepartmentMember>;
7051
+ /**
7052
+ *
7053
+ * @type {ModelError}
7054
+ * @memberof ConversationDepartmentMembersResponse
7055
+ */
7056
+ error?: ModelError;
7057
+ /**
7058
+ *
7059
+ * @type {ResponseMetadata}
7060
+ * @memberof ConversationDepartmentMembersResponse
7061
+ */
7062
+ metadata?: ResponseMetadata;
7063
+ /**
7064
+ * Indicates if API call was successful
7065
+ * @type {boolean}
7066
+ * @memberof ConversationDepartmentMembersResponse
7067
+ */
7068
+ success?: boolean;
7069
+ /**
7070
+ *
7071
+ * @type {Warning}
7072
+ * @memberof ConversationDepartmentMembersResponse
7073
+ */
7074
+ warning?: Warning;
7075
+ }
7076
+
7007
7077
  /**
7008
7078
  *
7009
7079
  * @export
@@ -7074,6 +7144,12 @@ export interface ConversationDepartmentsResponse {
7074
7144
  * @memberof ConversationDepartmentsResponse
7075
7145
  */
7076
7146
  metadata?: ResponseMetadata;
7147
+ /**
7148
+ *
7149
+ * @type {boolean}
7150
+ * @memberof ConversationDepartmentsResponse
7151
+ */
7152
+ read_only?: boolean;
7077
7153
  /**
7078
7154
  * Indicates if API call was successful
7079
7155
  * @type {boolean}
@@ -44034,6 +44110,52 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
44034
44110
  options: localVarRequestOptions,
44035
44111
  };
44036
44112
  },
44113
+ /**
44114
+ * Retrieve a list of possible department members
44115
+ * @summary Retrieve a list of possible department members
44116
+ * @param {*} [options] Override http request option.
44117
+ * @throws {RequiredError}
44118
+ */
44119
+ getConversationDepartmentMemberList(options: any = {}): FetchArgs {
44120
+ const localVarPath = `/conversation/department_members`;
44121
+ const localVarUrlObj = url.parse(localVarPath, true);
44122
+ const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
44123
+ const localVarHeaderParameter = {} as any;
44124
+ const localVarQueryParameter = {} as any;
44125
+
44126
+ if(configuration && configuration.apiVersion) {
44127
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
44128
+ }
44129
+
44130
+
44131
+
44132
+ // authentication ultraCartOauth required
44133
+ // oauth required
44134
+ if (configuration && configuration.accessToken) {
44135
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
44136
+ ? configuration.accessToken("ultraCartOauth", ["conversation_read"])
44137
+ : configuration.accessToken;
44138
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
44139
+ }
44140
+
44141
+ // authentication ultraCartSimpleApiKey required
44142
+ if (configuration && configuration.apiKey) {
44143
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
44144
+ ? configuration.apiKey("x-ultracart-simple-key")
44145
+ : configuration.apiKey;
44146
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
44147
+ }
44148
+
44149
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
44150
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
44151
+ delete localVarUrlObj.search;
44152
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
44153
+
44154
+ return {
44155
+ url: url.format(localVarUrlObj),
44156
+ options: localVarRequestOptions,
44157
+ };
44158
+ },
44037
44159
  /**
44038
44160
  * Retrieve a list of departments ordered by name
44039
44161
  * @summary Retrieve a list of departments ordered by name
@@ -45318,6 +45440,26 @@ export const ConversationApiFp = function(configuration?: Configuration) {
45318
45440
  });
45319
45441
  };
45320
45442
  },
45443
+ /**
45444
+ * Retrieve a list of possible department members
45445
+ * @summary Retrieve a list of possible department members
45446
+ * @param {*} [options] Override http request option.
45447
+ * @throws {RequiredError}
45448
+ */
45449
+ getConversationDepartmentMemberList(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationDepartmentMembersResponse> {
45450
+ const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getConversationDepartmentMemberList(options);
45451
+ return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
45452
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
45453
+
45454
+ if (response.status >= 200 && response.status < 300) {
45455
+ return response.json();
45456
+
45457
+ } else {
45458
+ throw response;
45459
+ }
45460
+ });
45461
+ };
45462
+ },
45321
45463
  /**
45322
45464
  * Retrieve a list of departments ordered by name
45323
45465
  * @summary Retrieve a list of departments ordered by name
@@ -45832,6 +45974,15 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
45832
45974
  getConversationContext(conversation_uuid: string, options?: any) {
45833
45975
  return ConversationApiFp(configuration).getConversationContext(conversation_uuid, options)(fetch, basePath);
45834
45976
  },
45977
+ /**
45978
+ * Retrieve a list of possible department members
45979
+ * @summary Retrieve a list of possible department members
45980
+ * @param {*} [options] Override http request option.
45981
+ * @throws {RequiredError}
45982
+ */
45983
+ getConversationDepartmentMemberList(options?: any) {
45984
+ return ConversationApiFp(configuration).getConversationDepartmentMemberList(options)(fetch, basePath);
45985
+ },
45835
45986
  /**
45836
45987
  * Retrieve a list of departments ordered by name
45837
45988
  * @summary Retrieve a list of departments ordered by name
@@ -46126,6 +46277,15 @@ export interface ConversationApiInterface {
46126
46277
  */
46127
46278
  getConversationContext(conversation_uuid: string, options?: any): Promise<ConversationWebchatContext>;
46128
46279
 
46280
+ /**
46281
+ * Retrieve a list of possible department members
46282
+ * @summary Retrieve a list of possible department members
46283
+ * @param {*} [options] Override http request option.
46284
+ * @throws {RequiredError}
46285
+ * @memberof ConversationApiInterface
46286
+ */
46287
+ getConversationDepartmentMemberList(options?: any): Promise<ConversationDepartmentMembersResponse>;
46288
+
46129
46289
  /**
46130
46290
  * Retrieve a list of departments ordered by name
46131
46291
  * @summary Retrieve a list of departments ordered by name
@@ -46436,6 +46596,17 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
46436
46596
  return ConversationApiFp(this.configuration).getConversationContext(conversation_uuid, options)(this.fetch, this.basePath);
46437
46597
  }
46438
46598
 
46599
+ /**
46600
+ * Retrieve a list of possible department members
46601
+ * @summary Retrieve a list of possible department members
46602
+ * @param {*} [options] Override http request option.
46603
+ * @throws {RequiredError}
46604
+ * @memberof ConversationApi
46605
+ */
46606
+ public getConversationDepartmentMemberList(options?: any) {
46607
+ return ConversationApiFp(this.configuration).getConversationDepartmentMemberList(options)(this.fetch, this.basePath);
46608
+ }
46609
+
46439
46610
  /**
46440
46611
  * Retrieve a list of departments ordered by name
46441
46612
  * @summary Retrieve a list of departments ordered by name
package/dist/api.d.ts CHANGED
@@ -6826,6 +6826,12 @@ export interface ConversationDepartment {
6826
6826
  * @memberof ConversationDepartment
6827
6827
  */
6828
6828
  department_name?: string;
6829
+ /**
6830
+ *
6831
+ * @type {Array<ConversationDepartmentMember>}
6832
+ * @memberof ConversationDepartment
6833
+ */
6834
+ members?: Array<ConversationDepartmentMember>;
6829
6835
  /**
6830
6836
  *
6831
6837
  * @type {string}
@@ -6839,6 +6845,68 @@ export interface ConversationDepartment {
6839
6845
  */
6840
6846
  settings?: ConversationDepartmentSettings;
6841
6847
  }
6848
+ /**
6849
+ *
6850
+ * @export
6851
+ * @interface ConversationDepartmentMember
6852
+ */
6853
+ export interface ConversationDepartmentMember {
6854
+ /**
6855
+ *
6856
+ * @type {boolean}
6857
+ * @memberof ConversationDepartmentMember
6858
+ */
6859
+ member?: boolean;
6860
+ /**
6861
+ *
6862
+ * @type {string}
6863
+ * @memberof ConversationDepartmentMember
6864
+ */
6865
+ name?: string;
6866
+ /**
6867
+ *
6868
+ * @type {number}
6869
+ * @memberof ConversationDepartmentMember
6870
+ */
6871
+ user_id?: number;
6872
+ }
6873
+ /**
6874
+ *
6875
+ * @export
6876
+ * @interface ConversationDepartmentMembersResponse
6877
+ */
6878
+ export interface ConversationDepartmentMembersResponse {
6879
+ /**
6880
+ *
6881
+ * @type {Array<ConversationDepartmentMember>}
6882
+ * @memberof ConversationDepartmentMembersResponse
6883
+ */
6884
+ conversation_department_members?: Array<ConversationDepartmentMember>;
6885
+ /**
6886
+ *
6887
+ * @type {ModelError}
6888
+ * @memberof ConversationDepartmentMembersResponse
6889
+ */
6890
+ error?: ModelError;
6891
+ /**
6892
+ *
6893
+ * @type {ResponseMetadata}
6894
+ * @memberof ConversationDepartmentMembersResponse
6895
+ */
6896
+ metadata?: ResponseMetadata;
6897
+ /**
6898
+ * Indicates if API call was successful
6899
+ * @type {boolean}
6900
+ * @memberof ConversationDepartmentMembersResponse
6901
+ */
6902
+ success?: boolean;
6903
+ /**
6904
+ *
6905
+ * @type {Warning}
6906
+ * @memberof ConversationDepartmentMembersResponse
6907
+ */
6908
+ warning?: Warning;
6909
+ }
6842
6910
  /**
6843
6911
  *
6844
6912
  * @export
@@ -6907,6 +6975,12 @@ export interface ConversationDepartmentsResponse {
6907
6975
  * @memberof ConversationDepartmentsResponse
6908
6976
  */
6909
6977
  metadata?: ResponseMetadata;
6978
+ /**
6979
+ *
6980
+ * @type {boolean}
6981
+ * @memberof ConversationDepartmentsResponse
6982
+ */
6983
+ read_only?: boolean;
6910
6984
  /**
6911
6985
  * Indicates if API call was successful
6912
6986
  * @type {boolean}
@@ -39502,6 +39576,13 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
39502
39576
  * @throws {RequiredError}
39503
39577
  */
39504
39578
  getConversationContext(conversation_uuid: string, options?: any): FetchArgs;
39579
+ /**
39580
+ * Retrieve a list of possible department members
39581
+ * @summary Retrieve a list of possible department members
39582
+ * @param {*} [options] Override http request option.
39583
+ * @throws {RequiredError}
39584
+ */
39585
+ getConversationDepartmentMemberList(options?: any): FetchArgs;
39505
39586
  /**
39506
39587
  * Retrieve a list of departments ordered by name
39507
39588
  * @summary Retrieve a list of departments ordered by name
@@ -39737,6 +39818,13 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
39737
39818
  * @throws {RequiredError}
39738
39819
  */
39739
39820
  getConversationContext(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationWebchatContext>;
39821
+ /**
39822
+ * Retrieve a list of possible department members
39823
+ * @summary Retrieve a list of possible department members
39824
+ * @param {*} [options] Override http request option.
39825
+ * @throws {RequiredError}
39826
+ */
39827
+ getConversationDepartmentMemberList(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationDepartmentMembersResponse>;
39740
39828
  /**
39741
39829
  * Retrieve a list of departments ordered by name
39742
39830
  * @summary Retrieve a list of departments ordered by name
@@ -39972,6 +40060,13 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
39972
40060
  * @throws {RequiredError}
39973
40061
  */
39974
40062
  getConversationContext(conversation_uuid: string, options?: any): Promise<ConversationWebchatContext>;
40063
+ /**
40064
+ * Retrieve a list of possible department members
40065
+ * @summary Retrieve a list of possible department members
40066
+ * @param {*} [options] Override http request option.
40067
+ * @throws {RequiredError}
40068
+ */
40069
+ getConversationDepartmentMemberList(options?: any): Promise<ConversationDepartmentMembersResponse>;
39975
40070
  /**
39976
40071
  * Retrieve a list of departments ordered by name
39977
40072
  * @summary Retrieve a list of departments ordered by name
@@ -40216,6 +40311,14 @@ export interface ConversationApiInterface {
40216
40311
  * @memberof ConversationApiInterface
40217
40312
  */
40218
40313
  getConversationContext(conversation_uuid: string, options?: any): Promise<ConversationWebchatContext>;
40314
+ /**
40315
+ * Retrieve a list of possible department members
40316
+ * @summary Retrieve a list of possible department members
40317
+ * @param {*} [options] Override http request option.
40318
+ * @throws {RequiredError}
40319
+ * @memberof ConversationApiInterface
40320
+ */
40321
+ getConversationDepartmentMemberList(options?: any): Promise<ConversationDepartmentMembersResponse>;
40219
40322
  /**
40220
40323
  * Retrieve a list of departments ordered by name
40221
40324
  * @summary Retrieve a list of departments ordered by name
@@ -40481,6 +40584,14 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
40481
40584
  * @memberof ConversationApi
40482
40585
  */
40483
40586
  getConversationContext(conversation_uuid: string, options?: any): Promise<ConversationWebchatContext>;
40587
+ /**
40588
+ * Retrieve a list of possible department members
40589
+ * @summary Retrieve a list of possible department members
40590
+ * @param {*} [options] Override http request option.
40591
+ * @throws {RequiredError}
40592
+ * @memberof ConversationApi
40593
+ */
40594
+ getConversationDepartmentMemberList(options?: any): Promise<ConversationDepartmentMembersResponse>;
40484
40595
  /**
40485
40596
  * Retrieve a list of departments ordered by name
40486
40597
  * @summary Retrieve a list of departments ordered by name
package/dist/api.js CHANGED
@@ -6507,6 +6507,46 @@ var ConversationApiFetchParamCreator = function (configuration) {
6507
6507
  options: localVarRequestOptions,
6508
6508
  };
6509
6509
  },
6510
+ /**
6511
+ * Retrieve a list of possible department members
6512
+ * @summary Retrieve a list of possible department members
6513
+ * @param {*} [options] Override http request option.
6514
+ * @throws {RequiredError}
6515
+ */
6516
+ getConversationDepartmentMemberList: function (options) {
6517
+ if (options === void 0) { options = {}; }
6518
+ var localVarPath = "/conversation/department_members";
6519
+ var localVarUrlObj = url.parse(localVarPath, true);
6520
+ var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
6521
+ var localVarHeaderParameter = {};
6522
+ var localVarQueryParameter = {};
6523
+ if (configuration && configuration.apiVersion) {
6524
+ localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
6525
+ }
6526
+ // authentication ultraCartOauth required
6527
+ // oauth required
6528
+ if (configuration && configuration.accessToken) {
6529
+ var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
6530
+ ? configuration.accessToken("ultraCartOauth", ["conversation_read"])
6531
+ : configuration.accessToken;
6532
+ localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
6533
+ }
6534
+ // authentication ultraCartSimpleApiKey required
6535
+ if (configuration && configuration.apiKey) {
6536
+ var localVarApiKeyValue = typeof configuration.apiKey === 'function'
6537
+ ? configuration.apiKey("x-ultracart-simple-key")
6538
+ : configuration.apiKey;
6539
+ localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
6540
+ }
6541
+ localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
6542
+ // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
6543
+ delete localVarUrlObj.search;
6544
+ localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
6545
+ return {
6546
+ url: url.format(localVarUrlObj),
6547
+ options: localVarRequestOptions,
6548
+ };
6549
+ },
6510
6550
  /**
6511
6551
  * Retrieve a list of departments ordered by name
6512
6552
  * @summary Retrieve a list of departments ordered by name
@@ -7662,6 +7702,27 @@ var ConversationApiFp = function (configuration) {
7662
7702
  });
7663
7703
  };
7664
7704
  },
7705
+ /**
7706
+ * Retrieve a list of possible department members
7707
+ * @summary Retrieve a list of possible department members
7708
+ * @param {*} [options] Override http request option.
7709
+ * @throws {RequiredError}
7710
+ */
7711
+ getConversationDepartmentMemberList: function (options) {
7712
+ var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).getConversationDepartmentMemberList(options);
7713
+ return function (fetch, basePath) {
7714
+ if (fetch === void 0) { fetch = portableFetch; }
7715
+ if (basePath === void 0) { basePath = BASE_PATH; }
7716
+ return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
7717
+ if (response.status >= 200 && response.status < 300) {
7718
+ return response.json();
7719
+ }
7720
+ else {
7721
+ throw response;
7722
+ }
7723
+ });
7724
+ };
7725
+ },
7665
7726
  /**
7666
7727
  * Retrieve a list of departments ordered by name
7667
7728
  * @summary Retrieve a list of departments ordered by name
@@ -8196,6 +8257,15 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
8196
8257
  getConversationContext: function (conversation_uuid, options) {
8197
8258
  return (0, exports.ConversationApiFp)(configuration).getConversationContext(conversation_uuid, options)(fetch, basePath);
8198
8259
  },
8260
+ /**
8261
+ * Retrieve a list of possible department members
8262
+ * @summary Retrieve a list of possible department members
8263
+ * @param {*} [options] Override http request option.
8264
+ * @throws {RequiredError}
8265
+ */
8266
+ getConversationDepartmentMemberList: function (options) {
8267
+ return (0, exports.ConversationApiFp)(configuration).getConversationDepartmentMemberList(options)(fetch, basePath);
8268
+ },
8199
8269
  /**
8200
8270
  * Retrieve a list of departments ordered by name
8201
8271
  * @summary Retrieve a list of departments ordered by name
@@ -8503,6 +8573,16 @@ var ConversationApi = /** @class */ (function (_super) {
8503
8573
  ConversationApi.prototype.getConversationContext = function (conversation_uuid, options) {
8504
8574
  return (0, exports.ConversationApiFp)(this.configuration).getConversationContext(conversation_uuid, options)(this.fetch, this.basePath);
8505
8575
  };
8576
+ /**
8577
+ * Retrieve a list of possible department members
8578
+ * @summary Retrieve a list of possible department members
8579
+ * @param {*} [options] Override http request option.
8580
+ * @throws {RequiredError}
8581
+ * @memberof ConversationApi
8582
+ */
8583
+ ConversationApi.prototype.getConversationDepartmentMemberList = function (options) {
8584
+ return (0, exports.ConversationApiFp)(this.configuration).getConversationDepartmentMemberList(options)(this.fetch, this.basePath);
8585
+ };
8506
8586
  /**
8507
8587
  * Retrieve a list of departments ordered by name
8508
8588
  * @summary Retrieve a list of departments ordered by name
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "3.10.99",
3
+ "version": "3.10.101",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "keywords": [