@equisoft/equisoft-connect-sdk-typescript 13.49.1-snapshot.20260506133000 → 13.50.0

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
@@ -56,8 +56,8 @@ All URIs are relative to *http://localhost*
56
56
  | ----- | ------ | ------------ | -------------
57
57
  *ContactsApi* | [**createContact**](docs/ContactsApi.md#createcontact) | **POST** /crm/api/v1/contacts | Create a contact
58
58
  *ContactsApi* | [**createHousehold**](docs/ContactsApi.md#createhousehold) | **POST** /crm/api/v1/contacts/household | Create a household (EXPERIMENTAL)
59
- *ContactsApi* | [**getByUuid**](docs/ContactsApi.md#getbyuuid) | **GET** /crm/api/v1/contacts/household/{householdUuid} | Gets a household by uuid (EXPERIMENTAL)
60
- *ContactsApi* | [**getHouseholdByUuid**](docs/ContactsApi.md#gethouseholdbyuuid) | **GET** /crm/api/v1/contacts/{contactUuid} | Get contact by Uuid
59
+ *ContactsApi* | [**getByUuid**](docs/ContactsApi.md#getbyuuid) | **GET** /crm/api/v1/contacts/{contactUuid} | Get contact by Uuid
60
+ *ContactsApi* | [**getHouseholdByUuid**](docs/ContactsApi.md#gethouseholdbyuuid) | **GET** /crm/api/v1/contacts/household/{householdUuid} | Gets a household by uuid (EXPERIMENTAL)
61
61
  *ContactsApi* | [**listContact**](docs/ContactsApi.md#listcontact) | **GET** /crm/api/v1/contacts | List contact
62
62
  *ContactsApi* | [**listContactDocument**](docs/ContactsApi.md#listcontactdocument) | **GET** /crm/api/v1/contacts/{contactUuid}/documents | List contact documents
63
63
  *ContactsApi* | [**listContactInvestment**](docs/ContactsApi.md#listcontactinvestment) | **GET** /crm/api/v1/contacts/{contactUuid}/investmentAccounts | List contact investments
@@ -19,12 +19,12 @@ export interface CreateHouseholdRequest {
19
19
  name?: string;
20
20
  }
21
21
  export interface GetByUuidRequest {
22
- householdUuid: string;
23
- }
24
- export interface GetHouseholdByUuidRequest {
25
22
  contactUuid: string;
26
23
  acceptLanguage?: string;
27
24
  }
25
+ export interface GetHouseholdByUuidRequest {
26
+ householdUuid: string;
27
+ }
28
28
  export interface ListContactRequest {
29
29
  search?: string;
30
30
  ids?: Array<number>;
@@ -98,25 +98,25 @@ export declare class ContactsApi extends runtime.BaseAPI {
98
98
  */
99
99
  getByUuidRequestOpts(requestParameters: GetByUuidRequest): Promise<runtime.RequestOpts>;
100
100
  /**
101
- * Gets a household by uuid (EXPERIMENTAL)
101
+ * Get contact by Uuid
102
102
  */
103
- getByUuidRaw(requestParameters: GetByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContactsHouseholdGetHouseholdResponse>>;
103
+ getByUuidRaw(requestParameters: GetByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContactsContact>>;
104
104
  /**
105
- * Gets a household by uuid (EXPERIMENTAL)
105
+ * Get contact by Uuid
106
106
  */
107
- getByUuid(requestParameters: GetByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContactsHouseholdGetHouseholdResponse>;
107
+ getByUuid(requestParameters: GetByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContactsContact>;
108
108
  /**
109
109
  * Creates request options for getHouseholdByUuid without sending the request
110
110
  */
111
111
  getHouseholdByUuidRequestOpts(requestParameters: GetHouseholdByUuidRequest): Promise<runtime.RequestOpts>;
112
112
  /**
113
- * Get contact by Uuid
113
+ * Gets a household by uuid (EXPERIMENTAL)
114
114
  */
115
- getHouseholdByUuidRaw(requestParameters: GetHouseholdByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContactsContact>>;
115
+ getHouseholdByUuidRaw(requestParameters: GetHouseholdByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContactsHouseholdGetHouseholdResponse>>;
116
116
  /**
117
- * Get contact by Uuid
117
+ * Gets a household by uuid (EXPERIMENTAL)
118
118
  */
119
- getHouseholdByUuid(requestParameters: GetHouseholdByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContactsContact>;
119
+ getHouseholdByUuid(requestParameters: GetHouseholdByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContactsHouseholdGetHouseholdResponse>;
120
120
  /**
121
121
  * Creates request options for listContact without sending the request
122
122
  */
@@ -133,11 +133,14 @@ class ContactsApi extends runtime.BaseAPI {
133
133
  */
134
134
  getByUuidRequestOpts(requestParameters) {
135
135
  return __awaiter(this, void 0, void 0, function* () {
136
- if (requestParameters['householdUuid'] == null) {
137
- throw new runtime.RequiredError('householdUuid', 'Required parameter "householdUuid" was null or undefined when calling getByUuid().');
136
+ if (requestParameters['contactUuid'] == null) {
137
+ throw new runtime.RequiredError('contactUuid', 'Required parameter "contactUuid" was null or undefined when calling getByUuid().');
138
138
  }
139
139
  const queryParameters = {};
140
140
  const headerParameters = {};
141
+ if (requestParameters['acceptLanguage'] != null) {
142
+ headerParameters['Accept-Language'] = String(requestParameters['acceptLanguage']);
143
+ }
141
144
  if (this.configuration && this.configuration.accessToken) {
142
145
  // oauth required
143
146
  const token = this.configuration.accessToken;
@@ -146,8 +149,8 @@ class ContactsApi extends runtime.BaseAPI {
146
149
  headerParameters["Authorization"] = `Bearer ${tokenString}`;
147
150
  }
148
151
  }
149
- let urlPath = `/crm/api/v1/contacts/household/{householdUuid}`;
150
- urlPath = urlPath.replace(`{${"householdUuid"}}`, encodeURIComponent(String(requestParameters['householdUuid'])));
152
+ let urlPath = `/crm/api/v1/contacts/{contactUuid}`;
153
+ urlPath = urlPath.replace(`{${"contactUuid"}}`, encodeURIComponent(String(requestParameters['contactUuid'])));
151
154
  return {
152
155
  path: urlPath,
153
156
  method: 'GET',
@@ -157,17 +160,17 @@ class ContactsApi extends runtime.BaseAPI {
157
160
  });
158
161
  }
159
162
  /**
160
- * Gets a household by uuid (EXPERIMENTAL)
163
+ * Get contact by Uuid
161
164
  */
162
165
  getByUuidRaw(requestParameters, initOverrides) {
163
166
  return __awaiter(this, void 0, void 0, function* () {
164
167
  const requestOptions = yield this.getByUuidRequestOpts(requestParameters);
165
168
  const response = yield this.request(requestOptions, initOverrides);
166
- return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ContactsHouseholdGetHouseholdResponseFromJSON)(jsonValue));
169
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ContactsContactFromJSON)(jsonValue));
167
170
  });
168
171
  }
169
172
  /**
170
- * Gets a household by uuid (EXPERIMENTAL)
173
+ * Get contact by Uuid
171
174
  */
172
175
  getByUuid(requestParameters, initOverrides) {
173
176
  return __awaiter(this, void 0, void 0, function* () {
@@ -180,14 +183,11 @@ class ContactsApi extends runtime.BaseAPI {
180
183
  */
181
184
  getHouseholdByUuidRequestOpts(requestParameters) {
182
185
  return __awaiter(this, void 0, void 0, function* () {
183
- if (requestParameters['contactUuid'] == null) {
184
- throw new runtime.RequiredError('contactUuid', 'Required parameter "contactUuid" was null or undefined when calling getHouseholdByUuid().');
186
+ if (requestParameters['householdUuid'] == null) {
187
+ throw new runtime.RequiredError('householdUuid', 'Required parameter "householdUuid" was null or undefined when calling getHouseholdByUuid().');
185
188
  }
186
189
  const queryParameters = {};
187
190
  const headerParameters = {};
188
- if (requestParameters['acceptLanguage'] != null) {
189
- headerParameters['Accept-Language'] = String(requestParameters['acceptLanguage']);
190
- }
191
191
  if (this.configuration && this.configuration.accessToken) {
192
192
  // oauth required
193
193
  const token = this.configuration.accessToken;
@@ -196,8 +196,8 @@ class ContactsApi extends runtime.BaseAPI {
196
196
  headerParameters["Authorization"] = `Bearer ${tokenString}`;
197
197
  }
198
198
  }
199
- let urlPath = `/crm/api/v1/contacts/{contactUuid}`;
200
- urlPath = urlPath.replace(`{${"contactUuid"}}`, encodeURIComponent(String(requestParameters['contactUuid'])));
199
+ let urlPath = `/crm/api/v1/contacts/household/{householdUuid}`;
200
+ urlPath = urlPath.replace(`{${"householdUuid"}}`, encodeURIComponent(String(requestParameters['householdUuid'])));
201
201
  return {
202
202
  path: urlPath,
203
203
  method: 'GET',
@@ -207,17 +207,17 @@ class ContactsApi extends runtime.BaseAPI {
207
207
  });
208
208
  }
209
209
  /**
210
- * Get contact by Uuid
210
+ * Gets a household by uuid (EXPERIMENTAL)
211
211
  */
212
212
  getHouseholdByUuidRaw(requestParameters, initOverrides) {
213
213
  return __awaiter(this, void 0, void 0, function* () {
214
214
  const requestOptions = yield this.getHouseholdByUuidRequestOpts(requestParameters);
215
215
  const response = yield this.request(requestOptions, initOverrides);
216
- return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ContactsContactFromJSON)(jsonValue));
216
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ContactsHouseholdGetHouseholdResponseFromJSON)(jsonValue));
217
217
  });
218
218
  }
219
219
  /**
220
- * Get contact by Uuid
220
+ * Gets a household by uuid (EXPERIMENTAL)
221
221
  */
222
222
  getHouseholdByUuid(requestParameters, initOverrides) {
223
223
  return __awaiter(this, void 0, void 0, function* () {
@@ -19,12 +19,12 @@ export interface CreateHouseholdRequest {
19
19
  name?: string;
20
20
  }
21
21
  export interface GetByUuidRequest {
22
- householdUuid: string;
23
- }
24
- export interface GetHouseholdByUuidRequest {
25
22
  contactUuid: string;
26
23
  acceptLanguage?: string;
27
24
  }
25
+ export interface GetHouseholdByUuidRequest {
26
+ householdUuid: string;
27
+ }
28
28
  export interface ListContactRequest {
29
29
  search?: string;
30
30
  ids?: Array<number>;
@@ -98,25 +98,25 @@ export declare class ContactsApi extends runtime.BaseAPI {
98
98
  */
99
99
  getByUuidRequestOpts(requestParameters: GetByUuidRequest): Promise<runtime.RequestOpts>;
100
100
  /**
101
- * Gets a household by uuid (EXPERIMENTAL)
101
+ * Get contact by Uuid
102
102
  */
103
- getByUuidRaw(requestParameters: GetByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContactsHouseholdGetHouseholdResponse>>;
103
+ getByUuidRaw(requestParameters: GetByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContactsContact>>;
104
104
  /**
105
- * Gets a household by uuid (EXPERIMENTAL)
105
+ * Get contact by Uuid
106
106
  */
107
- getByUuid(requestParameters: GetByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContactsHouseholdGetHouseholdResponse>;
107
+ getByUuid(requestParameters: GetByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContactsContact>;
108
108
  /**
109
109
  * Creates request options for getHouseholdByUuid without sending the request
110
110
  */
111
111
  getHouseholdByUuidRequestOpts(requestParameters: GetHouseholdByUuidRequest): Promise<runtime.RequestOpts>;
112
112
  /**
113
- * Get contact by Uuid
113
+ * Gets a household by uuid (EXPERIMENTAL)
114
114
  */
115
- getHouseholdByUuidRaw(requestParameters: GetHouseholdByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContactsContact>>;
115
+ getHouseholdByUuidRaw(requestParameters: GetHouseholdByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContactsHouseholdGetHouseholdResponse>>;
116
116
  /**
117
- * Get contact by Uuid
117
+ * Gets a household by uuid (EXPERIMENTAL)
118
118
  */
119
- getHouseholdByUuid(requestParameters: GetHouseholdByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContactsContact>;
119
+ getHouseholdByUuid(requestParameters: GetHouseholdByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContactsHouseholdGetHouseholdResponse>;
120
120
  /**
121
121
  * Creates request options for listContact without sending the request
122
122
  */
@@ -130,11 +130,14 @@ export class ContactsApi extends runtime.BaseAPI {
130
130
  */
131
131
  getByUuidRequestOpts(requestParameters) {
132
132
  return __awaiter(this, void 0, void 0, function* () {
133
- if (requestParameters['householdUuid'] == null) {
134
- throw new runtime.RequiredError('householdUuid', 'Required parameter "householdUuid" was null or undefined when calling getByUuid().');
133
+ if (requestParameters['contactUuid'] == null) {
134
+ throw new runtime.RequiredError('contactUuid', 'Required parameter "contactUuid" was null or undefined when calling getByUuid().');
135
135
  }
136
136
  const queryParameters = {};
137
137
  const headerParameters = {};
138
+ if (requestParameters['acceptLanguage'] != null) {
139
+ headerParameters['Accept-Language'] = String(requestParameters['acceptLanguage']);
140
+ }
138
141
  if (this.configuration && this.configuration.accessToken) {
139
142
  // oauth required
140
143
  const token = this.configuration.accessToken;
@@ -143,8 +146,8 @@ export class ContactsApi extends runtime.BaseAPI {
143
146
  headerParameters["Authorization"] = `Bearer ${tokenString}`;
144
147
  }
145
148
  }
146
- let urlPath = `/crm/api/v1/contacts/household/{householdUuid}`;
147
- urlPath = urlPath.replace(`{${"householdUuid"}}`, encodeURIComponent(String(requestParameters['householdUuid'])));
149
+ let urlPath = `/crm/api/v1/contacts/{contactUuid}`;
150
+ urlPath = urlPath.replace(`{${"contactUuid"}}`, encodeURIComponent(String(requestParameters['contactUuid'])));
148
151
  return {
149
152
  path: urlPath,
150
153
  method: 'GET',
@@ -154,17 +157,17 @@ export class ContactsApi extends runtime.BaseAPI {
154
157
  });
155
158
  }
156
159
  /**
157
- * Gets a household by uuid (EXPERIMENTAL)
160
+ * Get contact by Uuid
158
161
  */
159
162
  getByUuidRaw(requestParameters, initOverrides) {
160
163
  return __awaiter(this, void 0, void 0, function* () {
161
164
  const requestOptions = yield this.getByUuidRequestOpts(requestParameters);
162
165
  const response = yield this.request(requestOptions, initOverrides);
163
- return new runtime.JSONApiResponse(response, (jsonValue) => ContactsHouseholdGetHouseholdResponseFromJSON(jsonValue));
166
+ return new runtime.JSONApiResponse(response, (jsonValue) => ContactsContactFromJSON(jsonValue));
164
167
  });
165
168
  }
166
169
  /**
167
- * Gets a household by uuid (EXPERIMENTAL)
170
+ * Get contact by Uuid
168
171
  */
169
172
  getByUuid(requestParameters, initOverrides) {
170
173
  return __awaiter(this, void 0, void 0, function* () {
@@ -177,14 +180,11 @@ export class ContactsApi extends runtime.BaseAPI {
177
180
  */
178
181
  getHouseholdByUuidRequestOpts(requestParameters) {
179
182
  return __awaiter(this, void 0, void 0, function* () {
180
- if (requestParameters['contactUuid'] == null) {
181
- throw new runtime.RequiredError('contactUuid', 'Required parameter "contactUuid" was null or undefined when calling getHouseholdByUuid().');
183
+ if (requestParameters['householdUuid'] == null) {
184
+ throw new runtime.RequiredError('householdUuid', 'Required parameter "householdUuid" was null or undefined when calling getHouseholdByUuid().');
182
185
  }
183
186
  const queryParameters = {};
184
187
  const headerParameters = {};
185
- if (requestParameters['acceptLanguage'] != null) {
186
- headerParameters['Accept-Language'] = String(requestParameters['acceptLanguage']);
187
- }
188
188
  if (this.configuration && this.configuration.accessToken) {
189
189
  // oauth required
190
190
  const token = this.configuration.accessToken;
@@ -193,8 +193,8 @@ export class ContactsApi extends runtime.BaseAPI {
193
193
  headerParameters["Authorization"] = `Bearer ${tokenString}`;
194
194
  }
195
195
  }
196
- let urlPath = `/crm/api/v1/contacts/{contactUuid}`;
197
- urlPath = urlPath.replace(`{${"contactUuid"}}`, encodeURIComponent(String(requestParameters['contactUuid'])));
196
+ let urlPath = `/crm/api/v1/contacts/household/{householdUuid}`;
197
+ urlPath = urlPath.replace(`{${"householdUuid"}}`, encodeURIComponent(String(requestParameters['householdUuid'])));
198
198
  return {
199
199
  path: urlPath,
200
200
  method: 'GET',
@@ -204,17 +204,17 @@ export class ContactsApi extends runtime.BaseAPI {
204
204
  });
205
205
  }
206
206
  /**
207
- * Get contact by Uuid
207
+ * Gets a household by uuid (EXPERIMENTAL)
208
208
  */
209
209
  getHouseholdByUuidRaw(requestParameters, initOverrides) {
210
210
  return __awaiter(this, void 0, void 0, function* () {
211
211
  const requestOptions = yield this.getHouseholdByUuidRequestOpts(requestParameters);
212
212
  const response = yield this.request(requestOptions, initOverrides);
213
- return new runtime.JSONApiResponse(response, (jsonValue) => ContactsContactFromJSON(jsonValue));
213
+ return new runtime.JSONApiResponse(response, (jsonValue) => ContactsHouseholdGetHouseholdResponseFromJSON(jsonValue));
214
214
  });
215
215
  }
216
216
  /**
217
- * Get contact by Uuid
217
+ * Gets a household by uuid (EXPERIMENTAL)
218
218
  */
219
219
  getHouseholdByUuid(requestParameters, initOverrides) {
220
220
  return __awaiter(this, void 0, void 0, function* () {
@@ -6,8 +6,8 @@ All URIs are relative to *http://localhost*
6
6
  |------------- | ------------- | -------------|
7
7
  | [**createContact**](ContactsApi.md#createcontact) | **POST** /crm/api/v1/contacts | Create a contact |
8
8
  | [**createHousehold**](ContactsApi.md#createhousehold) | **POST** /crm/api/v1/contacts/household | Create a household (EXPERIMENTAL) |
9
- | [**getByUuid**](ContactsApi.md#getbyuuid) | **GET** /crm/api/v1/contacts/household/{householdUuid} | Gets a household by uuid (EXPERIMENTAL) |
10
- | [**getHouseholdByUuid**](ContactsApi.md#gethouseholdbyuuid) | **GET** /crm/api/v1/contacts/{contactUuid} | Get contact by Uuid |
9
+ | [**getByUuid**](ContactsApi.md#getbyuuid) | **GET** /crm/api/v1/contacts/{contactUuid} | Get contact by Uuid |
10
+ | [**getHouseholdByUuid**](ContactsApi.md#gethouseholdbyuuid) | **GET** /crm/api/v1/contacts/household/{householdUuid} | Gets a household by uuid (EXPERIMENTAL) |
11
11
  | [**listContact**](ContactsApi.md#listcontact) | **GET** /crm/api/v1/contacts | List contact |
12
12
  | [**listContactDocument**](ContactsApi.md#listcontactdocument) | **GET** /crm/api/v1/contacts/{contactUuid}/documents | List contact documents |
13
13
  | [**listContactInvestment**](ContactsApi.md#listcontactinvestment) | **GET** /crm/api/v1/contacts/{contactUuid}/investmentAccounts | List contact investments |
@@ -162,9 +162,9 @@ example().catch(console.error);
162
162
 
163
163
  ## getByUuid
164
164
 
165
- > ContactsHouseholdGetHouseholdResponse getByUuid(householdUuid)
165
+ > ContactsContact getByUuid(contactUuid, acceptLanguage)
166
166
 
167
- Gets a household by uuid (EXPERIMENTAL)
167
+ Get contact by Uuid
168
168
 
169
169
  ### Example
170
170
 
@@ -184,8 +184,10 @@ async function example() {
184
184
  const api = new ContactsApi(config);
185
185
 
186
186
  const body = {
187
- // string | The unique identifier of the household to fetch
188
- householdUuid: householdUuid_example,
187
+ // string | Contact unique identifier.
188
+ contactUuid: contactUuid_example,
189
+ // string | Specify preferred language for returned data. Format is https://tools.ietf.org/html/rfc3282. (optional)
190
+ acceptLanguage: acceptLanguage_example,
189
191
  } satisfies GetByUuidRequest;
190
192
 
191
193
  try {
@@ -205,11 +207,12 @@ example().catch(console.error);
205
207
 
206
208
  | Name | Type | Description | Notes |
207
209
  |------------- | ------------- | ------------- | -------------|
208
- | **householdUuid** | `string` | The unique identifier of the household to fetch | [Defaults to `undefined`] |
210
+ | **contactUuid** | `string` | Contact unique identifier. | [Defaults to `undefined`] |
211
+ | **acceptLanguage** | `string` | Specify preferred language for returned data. Format is https://tools.ietf.org/html/rfc3282. | [Optional] [Defaults to `undefined`] |
209
212
 
210
213
  ### Return type
211
214
 
212
- [**ContactsHouseholdGetHouseholdResponse**](ContactsHouseholdGetHouseholdResponse.md)
215
+ [**ContactsContact**](ContactsContact.md)
213
216
 
214
217
  ### Authorization
215
218
 
@@ -225,17 +228,18 @@ example().catch(console.error);
225
228
  | Status code | Description | Response headers |
226
229
  |-------------|-------------|------------------|
227
230
  | **200** | Ok | - |
231
+ | **401** | Unauthorized | - |
228
232
  | **500** | Internal Server Error | - |
229
- | **400** | Bad Request | - |
233
+ | **404** | Not Found | - |
230
234
 
231
235
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
232
236
 
233
237
 
234
238
  ## getHouseholdByUuid
235
239
 
236
- > ContactsContact getHouseholdByUuid(contactUuid, acceptLanguage)
240
+ > ContactsHouseholdGetHouseholdResponse getHouseholdByUuid(householdUuid)
237
241
 
238
- Get contact by Uuid
242
+ Gets a household by uuid (EXPERIMENTAL)
239
243
 
240
244
  ### Example
241
245
 
@@ -255,10 +259,8 @@ async function example() {
255
259
  const api = new ContactsApi(config);
256
260
 
257
261
  const body = {
258
- // string | Contact unique identifier.
259
- contactUuid: contactUuid_example,
260
- // string | Specify preferred language for returned data. Format is https://tools.ietf.org/html/rfc3282. (optional)
261
- acceptLanguage: acceptLanguage_example,
262
+ // string | The unique identifier of the household to fetch
263
+ householdUuid: householdUuid_example,
262
264
  } satisfies GetHouseholdByUuidRequest;
263
265
 
264
266
  try {
@@ -278,12 +280,11 @@ example().catch(console.error);
278
280
 
279
281
  | Name | Type | Description | Notes |
280
282
  |------------- | ------------- | ------------- | -------------|
281
- | **contactUuid** | `string` | Contact unique identifier. | [Defaults to `undefined`] |
282
- | **acceptLanguage** | `string` | Specify preferred language for returned data. Format is https://tools.ietf.org/html/rfc3282. | [Optional] [Defaults to `undefined`] |
283
+ | **householdUuid** | `string` | The unique identifier of the household to fetch | [Defaults to `undefined`] |
283
284
 
284
285
  ### Return type
285
286
 
286
- [**ContactsContact**](ContactsContact.md)
287
+ [**ContactsHouseholdGetHouseholdResponse**](ContactsHouseholdGetHouseholdResponse.md)
287
288
 
288
289
  ### Authorization
289
290
 
@@ -299,9 +300,8 @@ example().catch(console.error);
299
300
  | Status code | Description | Response headers |
300
301
  |-------------|-------------|------------------|
301
302
  | **200** | Ok | - |
302
- | **401** | Unauthorized | - |
303
303
  | **500** | Internal Server Error | - |
304
- | **404** | Not Found | - |
304
+ | **400** | Bad Request | - |
305
305
 
306
306
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
307
307
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@equisoft/equisoft-connect-sdk-typescript",
3
- "version": "13.49.1-snapshot.20260506133000",
3
+ "version": "13.50.0",
4
4
  "description": "OpenAPI client for @equisoft/equisoft-connect-sdk-typescript",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -56,12 +56,12 @@ export interface CreateHouseholdRequest {
56
56
  }
57
57
 
58
58
  export interface GetByUuidRequest {
59
- householdUuid: string;
59
+ contactUuid: string;
60
+ acceptLanguage?: string;
60
61
  }
61
62
 
62
63
  export interface GetHouseholdByUuidRequest {
63
- contactUuid: string;
64
- acceptLanguage?: string;
64
+ householdUuid: string;
65
65
  }
66
66
 
67
67
  export interface ListContactRequest {
@@ -233,10 +233,10 @@ export class ContactsApi extends runtime.BaseAPI {
233
233
  * Creates request options for getByUuid without sending the request
234
234
  */
235
235
  async getByUuidRequestOpts(requestParameters: GetByUuidRequest): Promise<runtime.RequestOpts> {
236
- if (requestParameters['householdUuid'] == null) {
236
+ if (requestParameters['contactUuid'] == null) {
237
237
  throw new runtime.RequiredError(
238
- 'householdUuid',
239
- 'Required parameter "householdUuid" was null or undefined when calling getByUuid().'
238
+ 'contactUuid',
239
+ 'Required parameter "contactUuid" was null or undefined when calling getByUuid().'
240
240
  );
241
241
  }
242
242
 
@@ -244,6 +244,10 @@ export class ContactsApi extends runtime.BaseAPI {
244
244
 
245
245
  const headerParameters: runtime.HTTPHeaders = {};
246
246
 
247
+ if (requestParameters['acceptLanguage'] != null) {
248
+ headerParameters['Accept-Language'] = String(requestParameters['acceptLanguage']);
249
+ }
250
+
247
251
  if (this.configuration && this.configuration.accessToken) {
248
252
  // oauth required
249
253
  const token = this.configuration.accessToken;
@@ -254,8 +258,8 @@ export class ContactsApi extends runtime.BaseAPI {
254
258
  }
255
259
 
256
260
 
257
- let urlPath = `/crm/api/v1/contacts/household/{householdUuid}`;
258
- urlPath = urlPath.replace(`{${"householdUuid"}}`, encodeURIComponent(String(requestParameters['householdUuid'])));
261
+ let urlPath = `/crm/api/v1/contacts/{contactUuid}`;
262
+ urlPath = urlPath.replace(`{${"contactUuid"}}`, encodeURIComponent(String(requestParameters['contactUuid'])));
259
263
 
260
264
  return {
261
265
  path: urlPath,
@@ -266,19 +270,19 @@ export class ContactsApi extends runtime.BaseAPI {
266
270
  }
267
271
 
268
272
  /**
269
- * Gets a household by uuid (EXPERIMENTAL)
273
+ * Get contact by Uuid
270
274
  */
271
- async getByUuidRaw(requestParameters: GetByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContactsHouseholdGetHouseholdResponse>> {
275
+ async getByUuidRaw(requestParameters: GetByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContactsContact>> {
272
276
  const requestOptions = await this.getByUuidRequestOpts(requestParameters);
273
277
  const response = await this.request(requestOptions, initOverrides);
274
278
 
275
- return new runtime.JSONApiResponse(response, (jsonValue) => ContactsHouseholdGetHouseholdResponseFromJSON(jsonValue));
279
+ return new runtime.JSONApiResponse(response, (jsonValue) => ContactsContactFromJSON(jsonValue));
276
280
  }
277
281
 
278
282
  /**
279
- * Gets a household by uuid (EXPERIMENTAL)
283
+ * Get contact by Uuid
280
284
  */
281
- async getByUuid(requestParameters: GetByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContactsHouseholdGetHouseholdResponse> {
285
+ async getByUuid(requestParameters: GetByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContactsContact> {
282
286
  const response = await this.getByUuidRaw(requestParameters, initOverrides);
283
287
  return await response.value();
284
288
  }
@@ -287,10 +291,10 @@ export class ContactsApi extends runtime.BaseAPI {
287
291
  * Creates request options for getHouseholdByUuid without sending the request
288
292
  */
289
293
  async getHouseholdByUuidRequestOpts(requestParameters: GetHouseholdByUuidRequest): Promise<runtime.RequestOpts> {
290
- if (requestParameters['contactUuid'] == null) {
294
+ if (requestParameters['householdUuid'] == null) {
291
295
  throw new runtime.RequiredError(
292
- 'contactUuid',
293
- 'Required parameter "contactUuid" was null or undefined when calling getHouseholdByUuid().'
296
+ 'householdUuid',
297
+ 'Required parameter "householdUuid" was null or undefined when calling getHouseholdByUuid().'
294
298
  );
295
299
  }
296
300
 
@@ -298,10 +302,6 @@ export class ContactsApi extends runtime.BaseAPI {
298
302
 
299
303
  const headerParameters: runtime.HTTPHeaders = {};
300
304
 
301
- if (requestParameters['acceptLanguage'] != null) {
302
- headerParameters['Accept-Language'] = String(requestParameters['acceptLanguage']);
303
- }
304
-
305
305
  if (this.configuration && this.configuration.accessToken) {
306
306
  // oauth required
307
307
  const token = this.configuration.accessToken;
@@ -312,8 +312,8 @@ export class ContactsApi extends runtime.BaseAPI {
312
312
  }
313
313
 
314
314
 
315
- let urlPath = `/crm/api/v1/contacts/{contactUuid}`;
316
- urlPath = urlPath.replace(`{${"contactUuid"}}`, encodeURIComponent(String(requestParameters['contactUuid'])));
315
+ let urlPath = `/crm/api/v1/contacts/household/{householdUuid}`;
316
+ urlPath = urlPath.replace(`{${"householdUuid"}}`, encodeURIComponent(String(requestParameters['householdUuid'])));
317
317
 
318
318
  return {
319
319
  path: urlPath,
@@ -324,19 +324,19 @@ export class ContactsApi extends runtime.BaseAPI {
324
324
  }
325
325
 
326
326
  /**
327
- * Get contact by Uuid
327
+ * Gets a household by uuid (EXPERIMENTAL)
328
328
  */
329
- async getHouseholdByUuidRaw(requestParameters: GetHouseholdByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContactsContact>> {
329
+ async getHouseholdByUuidRaw(requestParameters: GetHouseholdByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContactsHouseholdGetHouseholdResponse>> {
330
330
  const requestOptions = await this.getHouseholdByUuidRequestOpts(requestParameters);
331
331
  const response = await this.request(requestOptions, initOverrides);
332
332
 
333
- return new runtime.JSONApiResponse(response, (jsonValue) => ContactsContactFromJSON(jsonValue));
333
+ return new runtime.JSONApiResponse(response, (jsonValue) => ContactsHouseholdGetHouseholdResponseFromJSON(jsonValue));
334
334
  }
335
335
 
336
336
  /**
337
- * Get contact by Uuid
337
+ * Gets a household by uuid (EXPERIMENTAL)
338
338
  */
339
- async getHouseholdByUuid(requestParameters: GetHouseholdByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContactsContact> {
339
+ async getHouseholdByUuid(requestParameters: GetHouseholdByUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContactsHouseholdGetHouseholdResponse> {
340
340
  const response = await this.getHouseholdByUuidRaw(requestParameters, initOverrides);
341
341
  return await response.value();
342
342
  }