ultracart_rest_api_v2_typescript 4.1.114 → 4.1.116

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.
@@ -882,6 +882,8 @@ src/models/PricingTierNotification.ts
882
882
  src/models/PricingTiersResponse.ts
883
883
  src/models/Property.ts
884
884
  src/models/PublishLibraryItemRequest.ts
885
+ src/models/QuickBooksOnlineCustomer.ts
886
+ src/models/QuickBooksOnlineCustomersResponse.ts
885
887
  src/models/RegisterAffiliateClickRequest.ts
886
888
  src/models/RegisterAffiliateClickResponse.ts
887
889
  src/models/ReplaceOrderItemIdRequest.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.114
2
+ ## ultracart_rest_api_v2_typescript@4.1.116
3
3
 
4
4
  Every API method call has a sample for every language SDK. See https://github.com/UltraCart/sdk_samples
5
5
 
6
6
  Installation
7
7
 
8
8
  ```
9
- npm install ultracart_rest_api_v2_typescript@4.1.114 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.116 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
85
85
 
86
86
  | Version | Date | Comments |
87
87
  | --: | :-: | --- |
88
+ | 4.1.116 | 07/10/2026 | customer - method to search quickbooks online customers |
89
+ | 4.1.115 | 07/10/2026 | customer profile birthday |
88
90
  | 4.1.114 | 07/08/2026 | tax - anrok tax provider |
89
91
  | 4.1.113 | 07/08/2026 | tax - anrok tax provider |
90
92
  | 4.1.112 | 07/08/2026 | tax - added anrok tax provider |
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { AdjustInternalCertificateRequest, AdjustInternalCertificateResponse, BaseResponse, Customer, CustomerEditorValues, CustomerEmailListChanges, CustomerMagicLinkResponse, CustomerMergeRequest, CustomerQuery, CustomerResponse, CustomerStoreCreditAddRequest, CustomerStoreCreditResponse, CustomerWishListItem, CustomerWishListItemResponse, CustomerWishListItemsResponse, CustomersResponse, DataTablesServerSideResponse, EmailListsResponse, EmailVerifyTokenRequest, EmailVerifyTokenResponse, EmailVerifyTokenValidateRequest, EmailVerifyTokenValidateResponse, LookupRequest, LookupResponse } from '../models';
13
+ import { AdjustInternalCertificateRequest, AdjustInternalCertificateResponse, BaseResponse, Customer, CustomerEditorValues, CustomerEmailListChanges, CustomerMagicLinkResponse, CustomerMergeRequest, CustomerQuery, CustomerResponse, CustomerStoreCreditAddRequest, CustomerStoreCreditResponse, CustomerWishListItem, CustomerWishListItemResponse, CustomerWishListItemsResponse, CustomersResponse, DataTablesServerSideResponse, EmailListsResponse, EmailVerifyTokenRequest, EmailVerifyTokenResponse, EmailVerifyTokenValidateRequest, EmailVerifyTokenValidateResponse, LookupRequest, LookupResponse, QuickBooksOnlineCustomersResponse } from '../models';
14
14
  export interface AddCustomerStoreCreditRequest {
15
15
  customerProfileOid: number;
16
16
  storeCreditRequest: CustomerStoreCreditAddRequest;
@@ -96,6 +96,9 @@ export interface GetMagicLinkRequest {
96
96
  customerProfileOid: number;
97
97
  storefrontHostName: string;
98
98
  }
99
+ export interface GetQuickBooksOnlineCustomersRequest {
100
+ q?: string;
101
+ }
99
102
  export interface InsertCustomerRequest {
100
103
  customer: Customer;
101
104
  expand?: string;
@@ -411,6 +414,20 @@ export interface CustomerApiInterface {
411
414
  * getMagicLink
412
415
  */
413
416
  getMagicLink(requestParameters: GetMagicLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomerMagicLinkResponse>;
417
+ /**
418
+ * Typeahead search of the merchant\'s QuickBooks Online customers by display name. Used by the customer profile editor to link a profile 1:1 to a QuickBooks Online customer. Returns up to 100 matches. If QuickBooks Online is not connected the list will be empty.
419
+ * @summary Search the merchant\'s QuickBooks Online customers
420
+ * @param {string} [q] Search query matched against the QuickBooks Online customer display name
421
+ * @param {*} [options] Override http request option.
422
+ * @throws {RequiredError}
423
+ * @memberof CustomerApiInterface
424
+ */
425
+ getQuickBooksOnlineCustomersRaw(requestParameters: GetQuickBooksOnlineCustomersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QuickBooksOnlineCustomersResponse>>;
426
+ /**
427
+ * Typeahead search of the merchant\'s QuickBooks Online customers by display name. Used by the customer profile editor to link a profile 1:1 to a QuickBooks Online customer. Returns up to 100 matches. If QuickBooks Online is not connected the list will be empty.
428
+ * Search the merchant\'s QuickBooks Online customers
429
+ */
430
+ getQuickBooksOnlineCustomers(requestParameters: GetQuickBooksOnlineCustomersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QuickBooksOnlineCustomersResponse>;
414
431
  /**
415
432
  * Insert a customer on the UltraCart account.
416
433
  * @summary Insert a customer
@@ -717,6 +734,16 @@ export declare class CustomerApi extends runtime.BaseAPI implements CustomerApiI
717
734
  * getMagicLink
718
735
  */
719
736
  getMagicLink(requestParameters: GetMagicLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomerMagicLinkResponse>;
737
+ /**
738
+ * Typeahead search of the merchant\'s QuickBooks Online customers by display name. Used by the customer profile editor to link a profile 1:1 to a QuickBooks Online customer. Returns up to 100 matches. If QuickBooks Online is not connected the list will be empty.
739
+ * Search the merchant\'s QuickBooks Online customers
740
+ */
741
+ getQuickBooksOnlineCustomersRaw(requestParameters: GetQuickBooksOnlineCustomersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QuickBooksOnlineCustomersResponse>>;
742
+ /**
743
+ * Typeahead search of the merchant\'s QuickBooks Online customers by display name. Used by the customer profile editor to link a profile 1:1 to a QuickBooks Online customer. Returns up to 100 matches. If QuickBooks Online is not connected the list will be empty.
744
+ * Search the merchant\'s QuickBooks Online customers
745
+ */
746
+ getQuickBooksOnlineCustomers(requestParameters?: GetQuickBooksOnlineCustomersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QuickBooksOnlineCustomersResponse>;
720
747
  /**
721
748
  * Insert a customer on the UltraCart account.
722
749
  * Insert a customer
@@ -1148,6 +1148,66 @@ var CustomerApi = /** @class */ (function (_super) {
1148
1148
  });
1149
1149
  });
1150
1150
  };
1151
+ /**
1152
+ * Typeahead search of the merchant\'s QuickBooks Online customers by display name. Used by the customer profile editor to link a profile 1:1 to a QuickBooks Online customer. Returns up to 100 matches. If QuickBooks Online is not connected the list will be empty.
1153
+ * Search the merchant\'s QuickBooks Online customers
1154
+ */
1155
+ CustomerApi.prototype.getQuickBooksOnlineCustomersRaw = function (requestParameters, initOverrides) {
1156
+ return __awaiter(this, void 0, void 0, function () {
1157
+ var queryParameters, headerParameters, _a, _b, response;
1158
+ return __generator(this, function (_c) {
1159
+ switch (_c.label) {
1160
+ case 0:
1161
+ queryParameters = {};
1162
+ if (requestParameters.q !== undefined) {
1163
+ queryParameters['q'] = requestParameters.q;
1164
+ }
1165
+ headerParameters = {};
1166
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
1167
+ // oauth required
1168
+ _a = headerParameters;
1169
+ _b = "Authorization";
1170
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["customer_read"])];
1171
+ case 1:
1172
+ // oauth required
1173
+ _a[_b] = _c.sent();
1174
+ _c.label = 2;
1175
+ case 2:
1176
+ if (this.configuration && this.configuration.apiKey) {
1177
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
1178
+ }
1179
+ return [4 /*yield*/, this.request({
1180
+ path: "/customer/quickbooks_online/customers",
1181
+ method: 'GET',
1182
+ headers: headerParameters,
1183
+ query: queryParameters,
1184
+ }, initOverrides)];
1185
+ case 3:
1186
+ response = _c.sent();
1187
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.QuickBooksOnlineCustomersResponseFromJSON)(jsonValue); })];
1188
+ }
1189
+ });
1190
+ });
1191
+ };
1192
+ /**
1193
+ * Typeahead search of the merchant\'s QuickBooks Online customers by display name. Used by the customer profile editor to link a profile 1:1 to a QuickBooks Online customer. Returns up to 100 matches. If QuickBooks Online is not connected the list will be empty.
1194
+ * Search the merchant\'s QuickBooks Online customers
1195
+ */
1196
+ CustomerApi.prototype.getQuickBooksOnlineCustomers = function (requestParameters, initOverrides) {
1197
+ if (requestParameters === void 0) { requestParameters = {}; }
1198
+ return __awaiter(this, void 0, void 0, function () {
1199
+ var response;
1200
+ return __generator(this, function (_a) {
1201
+ switch (_a.label) {
1202
+ case 0: return [4 /*yield*/, this.getQuickBooksOnlineCustomersRaw(requestParameters, initOverrides)];
1203
+ case 1:
1204
+ response = _a.sent();
1205
+ return [4 /*yield*/, response.value()];
1206
+ case 2: return [2 /*return*/, _a.sent()];
1207
+ }
1208
+ });
1209
+ });
1210
+ };
1151
1211
  /**
1152
1212
  * Insert a customer on the UltraCart account.
1153
1213
  * Insert a customer
@@ -111,6 +111,12 @@ export interface Customer {
111
111
  * @memberof Customer
112
112
  */
113
113
  billing?: Array<CustomerBilling>;
114
+ /**
115
+ * Customer birthday
116
+ * @type {string}
117
+ * @memberof Customer
118
+ */
119
+ birth_date?: string;
114
120
  /**
115
121
  * Business notes (internally visible only)
116
122
  * @type {string}
@@ -309,6 +315,12 @@ export interface Customer {
309
315
  * @memberof Customer
310
316
  */
311
317
  qb_tax_exemption_reason_code?: number;
318
+ /**
319
+ * QuickBooks Online customer ID used to lock this customer 1:1 with QuickBooks Online
320
+ * @type {string}
321
+ * @memberof Customer
322
+ */
323
+ quickbooks_online_customer_id?: string;
312
324
  /**
313
325
  * Quotes associated with this customer profile
314
326
  * @type {Array<Order>}
@@ -63,6 +63,7 @@ function CustomerFromJSONTyped(json, ignoreDiscriminator) {
63
63
  'auto_approve_purchase_order': !(0, runtime_1.exists)(json, 'auto_approve_purchase_order') ? undefined : json['auto_approve_purchase_order'],
64
64
  'automatic_merchant_notes': !(0, runtime_1.exists)(json, 'automatic_merchant_notes') ? undefined : json['automatic_merchant_notes'],
65
65
  'billing': !(0, runtime_1.exists)(json, 'billing') ? undefined : (json['billing'].map(CustomerBilling_1.CustomerBillingFromJSON)),
66
+ 'birth_date': !(0, runtime_1.exists)(json, 'birth_date') ? undefined : json['birth_date'],
66
67
  'business_notes': !(0, runtime_1.exists)(json, 'business_notes') ? undefined : json['business_notes'],
67
68
  'cards': !(0, runtime_1.exists)(json, 'cards') ? undefined : (json['cards'].map(CustomerCard_1.CustomerCardFromJSON)),
68
69
  'cc_emails': !(0, runtime_1.exists)(json, 'cc_emails') ? undefined : (json['cc_emails'].map(CustomerEmail_1.CustomerEmailFromJSON)),
@@ -96,6 +97,7 @@ function CustomerFromJSONTyped(json, ignoreDiscriminator) {
96
97
  'qb_class': !(0, runtime_1.exists)(json, 'qb_class') ? undefined : json['qb_class'],
97
98
  'qb_code': !(0, runtime_1.exists)(json, 'qb_code') ? undefined : json['qb_code'],
98
99
  'qb_tax_exemption_reason_code': !(0, runtime_1.exists)(json, 'qb_tax_exemption_reason_code') ? undefined : json['qb_tax_exemption_reason_code'],
100
+ 'quickbooks_online_customer_id': !(0, runtime_1.exists)(json, 'quickbooks_online_customer_id') ? undefined : json['quickbooks_online_customer_id'],
99
101
  'quotes': !(0, runtime_1.exists)(json, 'quotes') ? undefined : (json['quotes'].map(Order_1.OrderFromJSON)),
100
102
  'quotes_summary': !(0, runtime_1.exists)(json, 'quotes_summary') ? undefined : (0, CustomerQuotesSummary_1.CustomerQuotesSummaryFromJSON)(json['quotes_summary']),
101
103
  'referral_source': !(0, runtime_1.exists)(json, 'referral_source') ? undefined : json['referral_source'],
@@ -139,6 +141,7 @@ function CustomerToJSON(value) {
139
141
  'auto_approve_purchase_order': value.auto_approve_purchase_order,
140
142
  'automatic_merchant_notes': value.automatic_merchant_notes,
141
143
  'billing': value.billing === undefined ? undefined : (value.billing.map(CustomerBilling_1.CustomerBillingToJSON)),
144
+ 'birth_date': value.birth_date,
142
145
  'business_notes': value.business_notes,
143
146
  'cards': value.cards === undefined ? undefined : (value.cards.map(CustomerCard_1.CustomerCardToJSON)),
144
147
  'cc_emails': value.cc_emails === undefined ? undefined : (value.cc_emails.map(CustomerEmail_1.CustomerEmailToJSON)),
@@ -172,6 +175,7 @@ function CustomerToJSON(value) {
172
175
  'qb_class': value.qb_class,
173
176
  'qb_code': value.qb_code,
174
177
  'qb_tax_exemption_reason_code': value.qb_tax_exemption_reason_code,
178
+ 'quickbooks_online_customer_id': value.quickbooks_online_customer_id,
175
179
  'quotes': value.quotes === undefined ? undefined : (value.quotes.map(Order_1.OrderToJSON)),
176
180
  'quotes_summary': (0, CustomerQuotesSummary_1.CustomerQuotesSummaryToJSON)(value.quotes_summary),
177
181
  'referral_source': value.referral_source,
@@ -0,0 +1,43 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface QuickBooksOnlineCustomer
16
+ */
17
+ export interface QuickBooksOnlineCustomer {
18
+ /**
19
+ * The QuickBooks Online internal customer id. Stored on the customer profile to lock it 1:1 with QuickBooks Online.
20
+ * @type {string}
21
+ * @memberof QuickBooksOnlineCustomer
22
+ */
23
+ customer_id?: string;
24
+ /**
25
+ * The QuickBooks Online customer display name.
26
+ * @type {string}
27
+ * @memberof QuickBooksOnlineCustomer
28
+ */
29
+ display_name?: string;
30
+ /**
31
+ * The QuickBooks Online customer primary email address, if any.
32
+ * @type {string}
33
+ * @memberof QuickBooksOnlineCustomer
34
+ */
35
+ email?: string;
36
+ }
37
+ /**
38
+ * Check if a given object implements the QuickBooksOnlineCustomer interface.
39
+ */
40
+ export declare function instanceOfQuickBooksOnlineCustomer(value: object): boolean;
41
+ export declare function QuickBooksOnlineCustomerFromJSON(json: any): QuickBooksOnlineCustomer;
42
+ export declare function QuickBooksOnlineCustomerFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuickBooksOnlineCustomer;
43
+ export declare function QuickBooksOnlineCustomerToJSON(value?: QuickBooksOnlineCustomer | null): any;
@@ -0,0 +1,54 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.QuickBooksOnlineCustomerToJSON = exports.QuickBooksOnlineCustomerFromJSONTyped = exports.QuickBooksOnlineCustomerFromJSON = exports.instanceOfQuickBooksOnlineCustomer = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * Check if a given object implements the QuickBooksOnlineCustomer interface.
20
+ */
21
+ function instanceOfQuickBooksOnlineCustomer(value) {
22
+ var isInstance = true;
23
+ return isInstance;
24
+ }
25
+ exports.instanceOfQuickBooksOnlineCustomer = instanceOfQuickBooksOnlineCustomer;
26
+ function QuickBooksOnlineCustomerFromJSON(json) {
27
+ return QuickBooksOnlineCustomerFromJSONTyped(json, false);
28
+ }
29
+ exports.QuickBooksOnlineCustomerFromJSON = QuickBooksOnlineCustomerFromJSON;
30
+ function QuickBooksOnlineCustomerFromJSONTyped(json, ignoreDiscriminator) {
31
+ if ((json === undefined) || (json === null)) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'customer_id': !(0, runtime_1.exists)(json, 'customer_id') ? undefined : json['customer_id'],
36
+ 'display_name': !(0, runtime_1.exists)(json, 'display_name') ? undefined : json['display_name'],
37
+ 'email': !(0, runtime_1.exists)(json, 'email') ? undefined : json['email'],
38
+ };
39
+ }
40
+ exports.QuickBooksOnlineCustomerFromJSONTyped = QuickBooksOnlineCustomerFromJSONTyped;
41
+ function QuickBooksOnlineCustomerToJSON(value) {
42
+ if (value === undefined) {
43
+ return undefined;
44
+ }
45
+ if (value === null) {
46
+ return null;
47
+ }
48
+ return {
49
+ 'customer_id': value.customer_id,
50
+ 'display_name': value.display_name,
51
+ 'email': value.email,
52
+ };
53
+ }
54
+ exports.QuickBooksOnlineCustomerToJSON = QuickBooksOnlineCustomerToJSON;
@@ -0,0 +1,59 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { ModelError } from './ModelError';
13
+ import { QuickBooksOnlineCustomer } from './QuickBooksOnlineCustomer';
14
+ import { ResponseMetadata } from './ResponseMetadata';
15
+ import { Warning } from './Warning';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface QuickBooksOnlineCustomersResponse
20
+ */
21
+ export interface QuickBooksOnlineCustomersResponse {
22
+ /**
23
+ *
24
+ * @type {ModelError}
25
+ * @memberof QuickBooksOnlineCustomersResponse
26
+ */
27
+ error?: ModelError;
28
+ /**
29
+ *
30
+ * @type {ResponseMetadata}
31
+ * @memberof QuickBooksOnlineCustomersResponse
32
+ */
33
+ metadata?: ResponseMetadata;
34
+ /**
35
+ * QuickBooks Online customers matching the typeahead query
36
+ * @type {Array<QuickBooksOnlineCustomer>}
37
+ * @memberof QuickBooksOnlineCustomersResponse
38
+ */
39
+ quickbooks_online_customers?: Array<QuickBooksOnlineCustomer>;
40
+ /**
41
+ * Indicates if API call was successful
42
+ * @type {boolean}
43
+ * @memberof QuickBooksOnlineCustomersResponse
44
+ */
45
+ success?: boolean;
46
+ /**
47
+ *
48
+ * @type {Warning}
49
+ * @memberof QuickBooksOnlineCustomersResponse
50
+ */
51
+ warning?: Warning;
52
+ }
53
+ /**
54
+ * Check if a given object implements the QuickBooksOnlineCustomersResponse interface.
55
+ */
56
+ export declare function instanceOfQuickBooksOnlineCustomersResponse(value: object): boolean;
57
+ export declare function QuickBooksOnlineCustomersResponseFromJSON(json: any): QuickBooksOnlineCustomersResponse;
58
+ export declare function QuickBooksOnlineCustomersResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuickBooksOnlineCustomersResponse;
59
+ export declare function QuickBooksOnlineCustomersResponseToJSON(value?: QuickBooksOnlineCustomersResponse | null): any;
@@ -0,0 +1,62 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.QuickBooksOnlineCustomersResponseToJSON = exports.QuickBooksOnlineCustomersResponseFromJSONTyped = exports.QuickBooksOnlineCustomersResponseFromJSON = exports.instanceOfQuickBooksOnlineCustomersResponse = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ var ModelError_1 = require("./ModelError");
19
+ var QuickBooksOnlineCustomer_1 = require("./QuickBooksOnlineCustomer");
20
+ var ResponseMetadata_1 = require("./ResponseMetadata");
21
+ var Warning_1 = require("./Warning");
22
+ /**
23
+ * Check if a given object implements the QuickBooksOnlineCustomersResponse interface.
24
+ */
25
+ function instanceOfQuickBooksOnlineCustomersResponse(value) {
26
+ var isInstance = true;
27
+ return isInstance;
28
+ }
29
+ exports.instanceOfQuickBooksOnlineCustomersResponse = instanceOfQuickBooksOnlineCustomersResponse;
30
+ function QuickBooksOnlineCustomersResponseFromJSON(json) {
31
+ return QuickBooksOnlineCustomersResponseFromJSONTyped(json, false);
32
+ }
33
+ exports.QuickBooksOnlineCustomersResponseFromJSON = QuickBooksOnlineCustomersResponseFromJSON;
34
+ function QuickBooksOnlineCustomersResponseFromJSONTyped(json, ignoreDiscriminator) {
35
+ if ((json === undefined) || (json === null)) {
36
+ return json;
37
+ }
38
+ return {
39
+ 'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
40
+ 'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
41
+ 'quickbooks_online_customers': !(0, runtime_1.exists)(json, 'quickbooks_online_customers') ? undefined : (json['quickbooks_online_customers'].map(QuickBooksOnlineCustomer_1.QuickBooksOnlineCustomerFromJSON)),
42
+ 'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
43
+ 'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
44
+ };
45
+ }
46
+ exports.QuickBooksOnlineCustomersResponseFromJSONTyped = QuickBooksOnlineCustomersResponseFromJSONTyped;
47
+ function QuickBooksOnlineCustomersResponseToJSON(value) {
48
+ if (value === undefined) {
49
+ return undefined;
50
+ }
51
+ if (value === null) {
52
+ return null;
53
+ }
54
+ return {
55
+ 'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
56
+ 'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
57
+ 'quickbooks_online_customers': value.quickbooks_online_customers === undefined ? undefined : (value.quickbooks_online_customers.map(QuickBooksOnlineCustomer_1.QuickBooksOnlineCustomerToJSON)),
58
+ 'success': value.success,
59
+ 'warning': (0, Warning_1.WarningToJSON)(value.warning),
60
+ };
61
+ }
62
+ exports.QuickBooksOnlineCustomersResponseToJSON = QuickBooksOnlineCustomersResponseToJSON;
@@ -853,6 +853,8 @@ export * from './PricingTierNotification';
853
853
  export * from './PricingTiersResponse';
854
854
  export * from './Property';
855
855
  export * from './PublishLibraryItemRequest';
856
+ export * from './QuickBooksOnlineCustomer';
857
+ export * from './QuickBooksOnlineCustomersResponse';
856
858
  export * from './RegisterAffiliateClickRequest';
857
859
  export * from './RegisterAffiliateClickResponse';
858
860
  export * from './ReplaceOrderItemIdRequest';
@@ -871,6 +871,8 @@ __exportStar(require("./PricingTierNotification"), exports);
871
871
  __exportStar(require("./PricingTiersResponse"), exports);
872
872
  __exportStar(require("./Property"), exports);
873
873
  __exportStar(require("./PublishLibraryItemRequest"), exports);
874
+ __exportStar(require("./QuickBooksOnlineCustomer"), exports);
875
+ __exportStar(require("./QuickBooksOnlineCustomersResponse"), exports);
874
876
  __exportStar(require("./RegisterAffiliateClickRequest"), exports);
875
877
  __exportStar(require("./RegisterAffiliateClickResponse"), exports);
876
878
  __exportStar(require("./ReplaceOrderItemIdRequest"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "4.1.114",
3
+ "version": "4.1.116",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "repository": {
@@ -90,6 +90,9 @@ import {
90
90
  LookupResponse,
91
91
  LookupResponseFromJSON,
92
92
  LookupResponseToJSON,
93
+ QuickBooksOnlineCustomersResponse,
94
+ QuickBooksOnlineCustomersResponseFromJSON,
95
+ QuickBooksOnlineCustomersResponseToJSON,
93
96
  } from '../models';
94
97
 
95
98
  export interface AddCustomerStoreCreditRequest {
@@ -191,6 +194,10 @@ export interface GetMagicLinkRequest {
191
194
  storefrontHostName: string;
192
195
  }
193
196
 
197
+ export interface GetQuickBooksOnlineCustomersRequest {
198
+ q?: string;
199
+ }
200
+
194
201
  export interface InsertCustomerRequest {
195
202
  customer: Customer;
196
203
  expand?: string;
@@ -547,6 +554,22 @@ export interface CustomerApiInterface {
547
554
  */
548
555
  getMagicLink(requestParameters: GetMagicLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomerMagicLinkResponse>;
549
556
 
557
+ /**
558
+ * Typeahead search of the merchant\'s QuickBooks Online customers by display name. Used by the customer profile editor to link a profile 1:1 to a QuickBooks Online customer. Returns up to 100 matches. If QuickBooks Online is not connected the list will be empty.
559
+ * @summary Search the merchant\'s QuickBooks Online customers
560
+ * @param {string} [q] Search query matched against the QuickBooks Online customer display name
561
+ * @param {*} [options] Override http request option.
562
+ * @throws {RequiredError}
563
+ * @memberof CustomerApiInterface
564
+ */
565
+ getQuickBooksOnlineCustomersRaw(requestParameters: GetQuickBooksOnlineCustomersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QuickBooksOnlineCustomersResponse>>;
566
+
567
+ /**
568
+ * Typeahead search of the merchant\'s QuickBooks Online customers by display name. Used by the customer profile editor to link a profile 1:1 to a QuickBooks Online customer. Returns up to 100 matches. If QuickBooks Online is not connected the list will be empty.
569
+ * Search the merchant\'s QuickBooks Online customers
570
+ */
571
+ getQuickBooksOnlineCustomers(requestParameters: GetQuickBooksOnlineCustomersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QuickBooksOnlineCustomersResponse>;
572
+
550
573
  /**
551
574
  * Insert a customer on the UltraCart account.
552
575
  * @summary Insert a customer
@@ -1543,6 +1566,47 @@ export class CustomerApi extends runtime.BaseAPI implements CustomerApiInterface
1543
1566
  return await response.value();
1544
1567
  }
1545
1568
 
1569
+ /**
1570
+ * Typeahead search of the merchant\'s QuickBooks Online customers by display name. Used by the customer profile editor to link a profile 1:1 to a QuickBooks Online customer. Returns up to 100 matches. If QuickBooks Online is not connected the list will be empty.
1571
+ * Search the merchant\'s QuickBooks Online customers
1572
+ */
1573
+ async getQuickBooksOnlineCustomersRaw(requestParameters: GetQuickBooksOnlineCustomersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QuickBooksOnlineCustomersResponse>> {
1574
+ const queryParameters: any = {};
1575
+
1576
+ if (requestParameters.q !== undefined) {
1577
+ queryParameters['q'] = requestParameters.q;
1578
+ }
1579
+
1580
+ const headerParameters: runtime.HTTPHeaders = {};
1581
+
1582
+ if (this.configuration && this.configuration.accessToken) {
1583
+ // oauth required
1584
+ headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["customer_read"]);
1585
+ }
1586
+
1587
+ if (this.configuration && this.configuration.apiKey) {
1588
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
1589
+ }
1590
+
1591
+ const response = await this.request({
1592
+ path: `/customer/quickbooks_online/customers`,
1593
+ method: 'GET',
1594
+ headers: headerParameters,
1595
+ query: queryParameters,
1596
+ }, initOverrides);
1597
+
1598
+ return new runtime.JSONApiResponse(response, (jsonValue) => QuickBooksOnlineCustomersResponseFromJSON(jsonValue));
1599
+ }
1600
+
1601
+ /**
1602
+ * Typeahead search of the merchant\'s QuickBooks Online customers by display name. Used by the customer profile editor to link a profile 1:1 to a QuickBooks Online customer. Returns up to 100 matches. If QuickBooks Online is not connected the list will be empty.
1603
+ * Search the merchant\'s QuickBooks Online customers
1604
+ */
1605
+ async getQuickBooksOnlineCustomers(requestParameters: GetQuickBooksOnlineCustomersRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QuickBooksOnlineCustomersResponse> {
1606
+ const response = await this.getQuickBooksOnlineCustomersRaw(requestParameters, initOverrides);
1607
+ return await response.value();
1608
+ }
1609
+
1546
1610
  /**
1547
1611
  * Insert a customer on the UltraCart account.
1548
1612
  * Insert a customer
@@ -206,6 +206,12 @@ export interface Customer {
206
206
  * @memberof Customer
207
207
  */
208
208
  billing?: Array<CustomerBilling>;
209
+ /**
210
+ * Customer birthday
211
+ * @type {string}
212
+ * @memberof Customer
213
+ */
214
+ birth_date?: string;
209
215
  /**
210
216
  * Business notes (internally visible only)
211
217
  * @type {string}
@@ -404,6 +410,12 @@ export interface Customer {
404
410
  * @memberof Customer
405
411
  */
406
412
  qb_tax_exemption_reason_code?: number;
413
+ /**
414
+ * QuickBooks Online customer ID used to lock this customer 1:1 with QuickBooks Online
415
+ * @type {string}
416
+ * @memberof Customer
417
+ */
418
+ quickbooks_online_customer_id?: string;
407
419
  /**
408
420
  * Quotes associated with this customer profile
409
421
  * @type {Array<Order>}
@@ -554,6 +566,7 @@ export function CustomerFromJSONTyped(json: any, ignoreDiscriminator: boolean):
554
566
  'auto_approve_purchase_order': !exists(json, 'auto_approve_purchase_order') ? undefined : json['auto_approve_purchase_order'],
555
567
  'automatic_merchant_notes': !exists(json, 'automatic_merchant_notes') ? undefined : json['automatic_merchant_notes'],
556
568
  'billing': !exists(json, 'billing') ? undefined : ((json['billing'] as Array<any>).map(CustomerBillingFromJSON)),
569
+ 'birth_date': !exists(json, 'birth_date') ? undefined : json['birth_date'],
557
570
  'business_notes': !exists(json, 'business_notes') ? undefined : json['business_notes'],
558
571
  'cards': !exists(json, 'cards') ? undefined : ((json['cards'] as Array<any>).map(CustomerCardFromJSON)),
559
572
  'cc_emails': !exists(json, 'cc_emails') ? undefined : ((json['cc_emails'] as Array<any>).map(CustomerEmailFromJSON)),
@@ -587,6 +600,7 @@ export function CustomerFromJSONTyped(json: any, ignoreDiscriminator: boolean):
587
600
  'qb_class': !exists(json, 'qb_class') ? undefined : json['qb_class'],
588
601
  'qb_code': !exists(json, 'qb_code') ? undefined : json['qb_code'],
589
602
  'qb_tax_exemption_reason_code': !exists(json, 'qb_tax_exemption_reason_code') ? undefined : json['qb_tax_exemption_reason_code'],
603
+ 'quickbooks_online_customer_id': !exists(json, 'quickbooks_online_customer_id') ? undefined : json['quickbooks_online_customer_id'],
590
604
  'quotes': !exists(json, 'quotes') ? undefined : ((json['quotes'] as Array<any>).map(OrderFromJSON)),
591
605
  'quotes_summary': !exists(json, 'quotes_summary') ? undefined : CustomerQuotesSummaryFromJSON(json['quotes_summary']),
592
606
  'referral_source': !exists(json, 'referral_source') ? undefined : json['referral_source'],
@@ -631,6 +645,7 @@ export function CustomerToJSON(value?: Customer | null): any {
631
645
  'auto_approve_purchase_order': value.auto_approve_purchase_order,
632
646
  'automatic_merchant_notes': value.automatic_merchant_notes,
633
647
  'billing': value.billing === undefined ? undefined : ((value.billing as Array<any>).map(CustomerBillingToJSON)),
648
+ 'birth_date': value.birth_date,
634
649
  'business_notes': value.business_notes,
635
650
  'cards': value.cards === undefined ? undefined : ((value.cards as Array<any>).map(CustomerCardToJSON)),
636
651
  'cc_emails': value.cc_emails === undefined ? undefined : ((value.cc_emails as Array<any>).map(CustomerEmailToJSON)),
@@ -664,6 +679,7 @@ export function CustomerToJSON(value?: Customer | null): any {
664
679
  'qb_class': value.qb_class,
665
680
  'qb_code': value.qb_code,
666
681
  'qb_tax_exemption_reason_code': value.qb_tax_exemption_reason_code,
682
+ 'quickbooks_online_customer_id': value.quickbooks_online_customer_id,
667
683
  'quotes': value.quotes === undefined ? undefined : ((value.quotes as Array<any>).map(OrderToJSON)),
668
684
  'quotes_summary': CustomerQuotesSummaryToJSON(value.quotes_summary),
669
685
  'referral_source': value.referral_source,
@@ -0,0 +1,83 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * UltraCart Rest API V2
5
+ * UltraCart REST API Version 2
6
+ *
7
+ * The version of the OpenAPI document: 2.0.0
8
+ * Contact: support@ultracart.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { exists, mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface QuickBooksOnlineCustomer
20
+ */
21
+ export interface QuickBooksOnlineCustomer {
22
+ /**
23
+ * The QuickBooks Online internal customer id. Stored on the customer profile to lock it 1:1 with QuickBooks Online.
24
+ * @type {string}
25
+ * @memberof QuickBooksOnlineCustomer
26
+ */
27
+ customer_id?: string;
28
+ /**
29
+ * The QuickBooks Online customer display name.
30
+ * @type {string}
31
+ * @memberof QuickBooksOnlineCustomer
32
+ */
33
+ display_name?: string;
34
+ /**
35
+ * The QuickBooks Online customer primary email address, if any.
36
+ * @type {string}
37
+ * @memberof QuickBooksOnlineCustomer
38
+ */
39
+ email?: string;
40
+ }
41
+
42
+
43
+
44
+ /**
45
+ * Check if a given object implements the QuickBooksOnlineCustomer interface.
46
+ */
47
+ export function instanceOfQuickBooksOnlineCustomer(value: object): boolean {
48
+ let isInstance = true;
49
+
50
+ return isInstance;
51
+ }
52
+
53
+ export function QuickBooksOnlineCustomerFromJSON(json: any): QuickBooksOnlineCustomer {
54
+ return QuickBooksOnlineCustomerFromJSONTyped(json, false);
55
+ }
56
+
57
+ export function QuickBooksOnlineCustomerFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuickBooksOnlineCustomer {
58
+ if ((json === undefined) || (json === null)) {
59
+ return json;
60
+ }
61
+ return {
62
+
63
+ 'customer_id': !exists(json, 'customer_id') ? undefined : json['customer_id'],
64
+ 'display_name': !exists(json, 'display_name') ? undefined : json['display_name'],
65
+ 'email': !exists(json, 'email') ? undefined : json['email'],
66
+ };
67
+ }
68
+
69
+ export function QuickBooksOnlineCustomerToJSON(value?: QuickBooksOnlineCustomer | null): any {
70
+ if (value === undefined) {
71
+ return undefined;
72
+ }
73
+ if (value === null) {
74
+ return null;
75
+ }
76
+ return {
77
+
78
+ 'customer_id': value.customer_id,
79
+ 'display_name': value.display_name,
80
+ 'email': value.email,
81
+ };
82
+ }
83
+
@@ -0,0 +1,124 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * UltraCart Rest API V2
5
+ * UltraCart REST API Version 2
6
+ *
7
+ * The version of the OpenAPI document: 2.0.0
8
+ * Contact: support@ultracart.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { exists, mapValues } from '../runtime';
16
+ import {
17
+ ModelError,
18
+ ModelErrorFromJSON,
19
+ ModelErrorFromJSONTyped,
20
+ ModelErrorToJSON,
21
+ } from './ModelError';
22
+ import {
23
+ QuickBooksOnlineCustomer,
24
+ QuickBooksOnlineCustomerFromJSON,
25
+ QuickBooksOnlineCustomerFromJSONTyped,
26
+ QuickBooksOnlineCustomerToJSON,
27
+ } from './QuickBooksOnlineCustomer';
28
+ import {
29
+ ResponseMetadata,
30
+ ResponseMetadataFromJSON,
31
+ ResponseMetadataFromJSONTyped,
32
+ ResponseMetadataToJSON,
33
+ } from './ResponseMetadata';
34
+ import {
35
+ Warning,
36
+ WarningFromJSON,
37
+ WarningFromJSONTyped,
38
+ WarningToJSON,
39
+ } from './Warning';
40
+
41
+ /**
42
+ *
43
+ * @export
44
+ * @interface QuickBooksOnlineCustomersResponse
45
+ */
46
+ export interface QuickBooksOnlineCustomersResponse {
47
+ /**
48
+ *
49
+ * @type {ModelError}
50
+ * @memberof QuickBooksOnlineCustomersResponse
51
+ */
52
+ error?: ModelError;
53
+ /**
54
+ *
55
+ * @type {ResponseMetadata}
56
+ * @memberof QuickBooksOnlineCustomersResponse
57
+ */
58
+ metadata?: ResponseMetadata;
59
+ /**
60
+ * QuickBooks Online customers matching the typeahead query
61
+ * @type {Array<QuickBooksOnlineCustomer>}
62
+ * @memberof QuickBooksOnlineCustomersResponse
63
+ */
64
+ quickbooks_online_customers?: Array<QuickBooksOnlineCustomer>;
65
+ /**
66
+ * Indicates if API call was successful
67
+ * @type {boolean}
68
+ * @memberof QuickBooksOnlineCustomersResponse
69
+ */
70
+ success?: boolean;
71
+ /**
72
+ *
73
+ * @type {Warning}
74
+ * @memberof QuickBooksOnlineCustomersResponse
75
+ */
76
+ warning?: Warning;
77
+ }
78
+
79
+
80
+
81
+ /**
82
+ * Check if a given object implements the QuickBooksOnlineCustomersResponse interface.
83
+ */
84
+ export function instanceOfQuickBooksOnlineCustomersResponse(value: object): boolean {
85
+ let isInstance = true;
86
+
87
+ return isInstance;
88
+ }
89
+
90
+ export function QuickBooksOnlineCustomersResponseFromJSON(json: any): QuickBooksOnlineCustomersResponse {
91
+ return QuickBooksOnlineCustomersResponseFromJSONTyped(json, false);
92
+ }
93
+
94
+ export function QuickBooksOnlineCustomersResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuickBooksOnlineCustomersResponse {
95
+ if ((json === undefined) || (json === null)) {
96
+ return json;
97
+ }
98
+ return {
99
+
100
+ 'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
101
+ 'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
102
+ 'quickbooks_online_customers': !exists(json, 'quickbooks_online_customers') ? undefined : ((json['quickbooks_online_customers'] as Array<any>).map(QuickBooksOnlineCustomerFromJSON)),
103
+ 'success': !exists(json, 'success') ? undefined : json['success'],
104
+ 'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
105
+ };
106
+ }
107
+
108
+ export function QuickBooksOnlineCustomersResponseToJSON(value?: QuickBooksOnlineCustomersResponse | null): any {
109
+ if (value === undefined) {
110
+ return undefined;
111
+ }
112
+ if (value === null) {
113
+ return null;
114
+ }
115
+ return {
116
+
117
+ 'error': ModelErrorToJSON(value.error),
118
+ 'metadata': ResponseMetadataToJSON(value.metadata),
119
+ 'quickbooks_online_customers': value.quickbooks_online_customers === undefined ? undefined : ((value.quickbooks_online_customers as Array<any>).map(QuickBooksOnlineCustomerToJSON)),
120
+ 'success': value.success,
121
+ 'warning': WarningToJSON(value.warning),
122
+ };
123
+ }
124
+
@@ -855,6 +855,8 @@ export * from './PricingTierNotification';
855
855
  export * from './PricingTiersResponse';
856
856
  export * from './Property';
857
857
  export * from './PublishLibraryItemRequest';
858
+ export * from './QuickBooksOnlineCustomer';
859
+ export * from './QuickBooksOnlineCustomersResponse';
858
860
  export * from './RegisterAffiliateClickRequest';
859
861
  export * from './RegisterAffiliateClickResponse';
860
862
  export * from './ReplaceOrderItemIdRequest';