@equisoft/equisoft-connect-sdk-typescript 13.50.0 → 13.50.1-snapshot.20260515142108
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/.openapi-generator/FILES +2 -0
- package/README.md +3 -2
- package/dist/apis/ContactsApi.js +2 -2
- package/dist/esm/apis/ContactsApi.js +2 -2
- package/dist/esm/models/ContactsHouseholdAddress.d.ts +62 -0
- package/dist/esm/models/ContactsHouseholdAddress.js +51 -0
- package/dist/esm/models/index.d.ts +1 -0
- package/dist/esm/models/index.js +1 -0
- package/dist/models/ContactsHouseholdAddress.d.ts +62 -0
- package/dist/models/ContactsHouseholdAddress.js +58 -0
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/docs/ContactsApi.md +2 -2
- package/docs/ContactsHouseholdAddress.md +44 -0
- package/package.json +1 -1
- package/src/apis/ContactsApi.ts +2 -2
- package/src/models/ContactsHouseholdAddress.ts +105 -0
- package/src/models/index.ts +1 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -35,6 +35,7 @@ docs/ContactsCreateRevenuePayload.md
|
|
|
35
35
|
docs/ContactsCreateSegmentationPayload.md
|
|
36
36
|
docs/ContactsCreateWebsitePayload.md
|
|
37
37
|
docs/ContactsEmail.md
|
|
38
|
+
docs/ContactsHouseholdAddress.md
|
|
38
39
|
docs/ContactsHouseholdCreateHouseholdPayload.md
|
|
39
40
|
docs/ContactsHouseholdGetHouseholdResponse.md
|
|
40
41
|
docs/ContactsHouseholdHousehold.md
|
|
@@ -370,6 +371,7 @@ src/models/ContactsCreateRevenuePayload.ts
|
|
|
370
371
|
src/models/ContactsCreateSegmentationPayload.ts
|
|
371
372
|
src/models/ContactsCreateWebsitePayload.ts
|
|
372
373
|
src/models/ContactsEmail.ts
|
|
374
|
+
src/models/ContactsHouseholdAddress.ts
|
|
373
375
|
src/models/ContactsHouseholdCreateHouseholdPayload.ts
|
|
374
376
|
src/models/ContactsHouseholdGetHouseholdResponse.ts
|
|
375
377
|
src/models/ContactsHouseholdHousehold.ts
|
package/README.md
CHANGED
|
@@ -55,9 +55,9 @@ All URIs are relative to *http://localhost*
|
|
|
55
55
|
| Class | Method | HTTP request | Description
|
|
56
56
|
| ----- | ------ | ------------ | -------------
|
|
57
57
|
*ContactsApi* | [**createContact**](docs/ContactsApi.md#createcontact) | **POST** /crm/api/v1/contacts | Create a contact
|
|
58
|
-
*ContactsApi* | [**createHousehold**](docs/ContactsApi.md#createhousehold) | **POST** /crm/api/v1/contacts/
|
|
58
|
+
*ContactsApi* | [**createHousehold**](docs/ContactsApi.md#createhousehold) | **POST** /crm/api/v1/contacts/households | Create a household (EXPERIMENTAL)
|
|
59
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/
|
|
60
|
+
*ContactsApi* | [**getHouseholdByUuid**](docs/ContactsApi.md#gethouseholdbyuuid) | **GET** /crm/api/v1/contacts/households/{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
|
|
@@ -231,6 +231,7 @@ All URIs are relative to *http://localhost*
|
|
|
231
231
|
- [ContactsCreateSegmentationPayload](docs/ContactsCreateSegmentationPayload.md)
|
|
232
232
|
- [ContactsCreateWebsitePayload](docs/ContactsCreateWebsitePayload.md)
|
|
233
233
|
- [ContactsEmail](docs/ContactsEmail.md)
|
|
234
|
+
- [ContactsHouseholdAddress](docs/ContactsHouseholdAddress.md)
|
|
234
235
|
- [ContactsHouseholdCreateHouseholdPayload](docs/ContactsHouseholdCreateHouseholdPayload.md)
|
|
235
236
|
- [ContactsHouseholdGetHouseholdResponse](docs/ContactsHouseholdGetHouseholdResponse.md)
|
|
236
237
|
- [ContactsHouseholdHousehold](docs/ContactsHouseholdHousehold.md)
|
package/dist/apis/ContactsApi.js
CHANGED
|
@@ -99,7 +99,7 @@ class ContactsApi extends runtime.BaseAPI {
|
|
|
99
99
|
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
100
100
|
}
|
|
101
101
|
}
|
|
102
|
-
let urlPath = `/crm/api/v1/contacts/
|
|
102
|
+
let urlPath = `/crm/api/v1/contacts/households`;
|
|
103
103
|
return {
|
|
104
104
|
path: urlPath,
|
|
105
105
|
method: 'POST',
|
|
@@ -196,7 +196,7 @@ class ContactsApi extends runtime.BaseAPI {
|
|
|
196
196
|
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
197
197
|
}
|
|
198
198
|
}
|
|
199
|
-
let urlPath = `/crm/api/v1/contacts/
|
|
199
|
+
let urlPath = `/crm/api/v1/contacts/households/{householdUuid}`;
|
|
200
200
|
urlPath = urlPath.replace(`{${"householdUuid"}}`, encodeURIComponent(String(requestParameters['householdUuid'])));
|
|
201
201
|
return {
|
|
202
202
|
path: urlPath,
|
|
@@ -96,7 +96,7 @@ export class ContactsApi extends runtime.BaseAPI {
|
|
|
96
96
|
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
97
97
|
}
|
|
98
98
|
}
|
|
99
|
-
let urlPath = `/crm/api/v1/contacts/
|
|
99
|
+
let urlPath = `/crm/api/v1/contacts/households`;
|
|
100
100
|
return {
|
|
101
101
|
path: urlPath,
|
|
102
102
|
method: 'POST',
|
|
@@ -193,7 +193,7 @@ export class ContactsApi extends runtime.BaseAPI {
|
|
|
193
193
|
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
194
194
|
}
|
|
195
195
|
}
|
|
196
|
-
let urlPath = `/crm/api/v1/contacts/
|
|
196
|
+
let urlPath = `/crm/api/v1/contacts/households/{householdUuid}`;
|
|
197
197
|
urlPath = urlPath.replace(`{${"householdUuid"}}`, encodeURIComponent(String(requestParameters['householdUuid'])));
|
|
198
198
|
return {
|
|
199
199
|
path: urlPath,
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Equisoft /connect API
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: latest
|
|
6
|
+
*
|
|
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 ContactsHouseholdAddress
|
|
16
|
+
*/
|
|
17
|
+
export interface ContactsHouseholdAddress {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof ContactsHouseholdAddress
|
|
22
|
+
*/
|
|
23
|
+
street1?: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof ContactsHouseholdAddress
|
|
28
|
+
*/
|
|
29
|
+
street2?: string;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof ContactsHouseholdAddress
|
|
34
|
+
*/
|
|
35
|
+
city?: string;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof ContactsHouseholdAddress
|
|
40
|
+
*/
|
|
41
|
+
state?: string;
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof ContactsHouseholdAddress
|
|
46
|
+
*/
|
|
47
|
+
country?: string;
|
|
48
|
+
/**
|
|
49
|
+
*
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof ContactsHouseholdAddress
|
|
52
|
+
*/
|
|
53
|
+
postalCode?: string;
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Check if a given object implements the ContactsHouseholdAddress interface.
|
|
57
|
+
*/
|
|
58
|
+
export declare function instanceOfContactsHouseholdAddress(value: object): value is ContactsHouseholdAddress;
|
|
59
|
+
export declare function ContactsHouseholdAddressFromJSON(json: any): ContactsHouseholdAddress;
|
|
60
|
+
export declare function ContactsHouseholdAddressFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContactsHouseholdAddress;
|
|
61
|
+
export declare function ContactsHouseholdAddressToJSON(json: any): ContactsHouseholdAddress;
|
|
62
|
+
export declare function ContactsHouseholdAddressToJSONTyped(value?: ContactsHouseholdAddress | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Equisoft /connect API
|
|
5
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: latest
|
|
8
|
+
*
|
|
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
|
+
* Check if a given object implements the ContactsHouseholdAddress interface.
|
|
16
|
+
*/
|
|
17
|
+
export function instanceOfContactsHouseholdAddress(value) {
|
|
18
|
+
return true;
|
|
19
|
+
}
|
|
20
|
+
export function ContactsHouseholdAddressFromJSON(json) {
|
|
21
|
+
return ContactsHouseholdAddressFromJSONTyped(json, false);
|
|
22
|
+
}
|
|
23
|
+
export function ContactsHouseholdAddressFromJSONTyped(json, ignoreDiscriminator) {
|
|
24
|
+
if (json == null) {
|
|
25
|
+
return json;
|
|
26
|
+
}
|
|
27
|
+
return {
|
|
28
|
+
'street1': json['street1'] == null ? undefined : json['street1'],
|
|
29
|
+
'street2': json['street2'] == null ? undefined : json['street2'],
|
|
30
|
+
'city': json['city'] == null ? undefined : json['city'],
|
|
31
|
+
'state': json['state'] == null ? undefined : json['state'],
|
|
32
|
+
'country': json['country'] == null ? undefined : json['country'],
|
|
33
|
+
'postalCode': json['postalCode'] == null ? undefined : json['postalCode'],
|
|
34
|
+
};
|
|
35
|
+
}
|
|
36
|
+
export function ContactsHouseholdAddressToJSON(json) {
|
|
37
|
+
return ContactsHouseholdAddressToJSONTyped(json, false);
|
|
38
|
+
}
|
|
39
|
+
export function ContactsHouseholdAddressToJSONTyped(value, ignoreDiscriminator = false) {
|
|
40
|
+
if (value == null) {
|
|
41
|
+
return value;
|
|
42
|
+
}
|
|
43
|
+
return {
|
|
44
|
+
'street1': value['street1'],
|
|
45
|
+
'street2': value['street2'],
|
|
46
|
+
'city': value['city'],
|
|
47
|
+
'state': value['state'],
|
|
48
|
+
'country': value['country'],
|
|
49
|
+
'postalCode': value['postalCode'],
|
|
50
|
+
};
|
|
51
|
+
}
|
|
@@ -32,6 +32,7 @@ export * from './ContactsCreateRevenuePayload';
|
|
|
32
32
|
export * from './ContactsCreateSegmentationPayload';
|
|
33
33
|
export * from './ContactsCreateWebsitePayload';
|
|
34
34
|
export * from './ContactsEmail';
|
|
35
|
+
export * from './ContactsHouseholdAddress';
|
|
35
36
|
export * from './ContactsHouseholdCreateHouseholdPayload';
|
|
36
37
|
export * from './ContactsHouseholdGetHouseholdResponse';
|
|
37
38
|
export * from './ContactsHouseholdHousehold';
|
package/dist/esm/models/index.js
CHANGED
|
@@ -34,6 +34,7 @@ export * from './ContactsCreateRevenuePayload';
|
|
|
34
34
|
export * from './ContactsCreateSegmentationPayload';
|
|
35
35
|
export * from './ContactsCreateWebsitePayload';
|
|
36
36
|
export * from './ContactsEmail';
|
|
37
|
+
export * from './ContactsHouseholdAddress';
|
|
37
38
|
export * from './ContactsHouseholdCreateHouseholdPayload';
|
|
38
39
|
export * from './ContactsHouseholdGetHouseholdResponse';
|
|
39
40
|
export * from './ContactsHouseholdHousehold';
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Equisoft /connect API
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: latest
|
|
6
|
+
*
|
|
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 ContactsHouseholdAddress
|
|
16
|
+
*/
|
|
17
|
+
export interface ContactsHouseholdAddress {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof ContactsHouseholdAddress
|
|
22
|
+
*/
|
|
23
|
+
street1?: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof ContactsHouseholdAddress
|
|
28
|
+
*/
|
|
29
|
+
street2?: string;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof ContactsHouseholdAddress
|
|
34
|
+
*/
|
|
35
|
+
city?: string;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof ContactsHouseholdAddress
|
|
40
|
+
*/
|
|
41
|
+
state?: string;
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof ContactsHouseholdAddress
|
|
46
|
+
*/
|
|
47
|
+
country?: string;
|
|
48
|
+
/**
|
|
49
|
+
*
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof ContactsHouseholdAddress
|
|
52
|
+
*/
|
|
53
|
+
postalCode?: string;
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Check if a given object implements the ContactsHouseholdAddress interface.
|
|
57
|
+
*/
|
|
58
|
+
export declare function instanceOfContactsHouseholdAddress(value: object): value is ContactsHouseholdAddress;
|
|
59
|
+
export declare function ContactsHouseholdAddressFromJSON(json: any): ContactsHouseholdAddress;
|
|
60
|
+
export declare function ContactsHouseholdAddressFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContactsHouseholdAddress;
|
|
61
|
+
export declare function ContactsHouseholdAddressToJSON(json: any): ContactsHouseholdAddress;
|
|
62
|
+
export declare function ContactsHouseholdAddressToJSONTyped(value?: ContactsHouseholdAddress | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Equisoft /connect API
|
|
6
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: latest
|
|
9
|
+
*
|
|
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.instanceOfContactsHouseholdAddress = instanceOfContactsHouseholdAddress;
|
|
17
|
+
exports.ContactsHouseholdAddressFromJSON = ContactsHouseholdAddressFromJSON;
|
|
18
|
+
exports.ContactsHouseholdAddressFromJSONTyped = ContactsHouseholdAddressFromJSONTyped;
|
|
19
|
+
exports.ContactsHouseholdAddressToJSON = ContactsHouseholdAddressToJSON;
|
|
20
|
+
exports.ContactsHouseholdAddressToJSONTyped = ContactsHouseholdAddressToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the ContactsHouseholdAddress interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfContactsHouseholdAddress(value) {
|
|
25
|
+
return true;
|
|
26
|
+
}
|
|
27
|
+
function ContactsHouseholdAddressFromJSON(json) {
|
|
28
|
+
return ContactsHouseholdAddressFromJSONTyped(json, false);
|
|
29
|
+
}
|
|
30
|
+
function ContactsHouseholdAddressFromJSONTyped(json, ignoreDiscriminator) {
|
|
31
|
+
if (json == null) {
|
|
32
|
+
return json;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
'street1': json['street1'] == null ? undefined : json['street1'],
|
|
36
|
+
'street2': json['street2'] == null ? undefined : json['street2'],
|
|
37
|
+
'city': json['city'] == null ? undefined : json['city'],
|
|
38
|
+
'state': json['state'] == null ? undefined : json['state'],
|
|
39
|
+
'country': json['country'] == null ? undefined : json['country'],
|
|
40
|
+
'postalCode': json['postalCode'] == null ? undefined : json['postalCode'],
|
|
41
|
+
};
|
|
42
|
+
}
|
|
43
|
+
function ContactsHouseholdAddressToJSON(json) {
|
|
44
|
+
return ContactsHouseholdAddressToJSONTyped(json, false);
|
|
45
|
+
}
|
|
46
|
+
function ContactsHouseholdAddressToJSONTyped(value, ignoreDiscriminator = false) {
|
|
47
|
+
if (value == null) {
|
|
48
|
+
return value;
|
|
49
|
+
}
|
|
50
|
+
return {
|
|
51
|
+
'street1': value['street1'],
|
|
52
|
+
'street2': value['street2'],
|
|
53
|
+
'city': value['city'],
|
|
54
|
+
'state': value['state'],
|
|
55
|
+
'country': value['country'],
|
|
56
|
+
'postalCode': value['postalCode'],
|
|
57
|
+
};
|
|
58
|
+
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -32,6 +32,7 @@ export * from './ContactsCreateRevenuePayload';
|
|
|
32
32
|
export * from './ContactsCreateSegmentationPayload';
|
|
33
33
|
export * from './ContactsCreateWebsitePayload';
|
|
34
34
|
export * from './ContactsEmail';
|
|
35
|
+
export * from './ContactsHouseholdAddress';
|
|
35
36
|
export * from './ContactsHouseholdCreateHouseholdPayload';
|
|
36
37
|
export * from './ContactsHouseholdGetHouseholdResponse';
|
|
37
38
|
export * from './ContactsHouseholdHousehold';
|
package/dist/models/index.js
CHANGED
|
@@ -50,6 +50,7 @@ __exportStar(require("./ContactsCreateRevenuePayload"), exports);
|
|
|
50
50
|
__exportStar(require("./ContactsCreateSegmentationPayload"), exports);
|
|
51
51
|
__exportStar(require("./ContactsCreateWebsitePayload"), exports);
|
|
52
52
|
__exportStar(require("./ContactsEmail"), exports);
|
|
53
|
+
__exportStar(require("./ContactsHouseholdAddress"), exports);
|
|
53
54
|
__exportStar(require("./ContactsHouseholdCreateHouseholdPayload"), exports);
|
|
54
55
|
__exportStar(require("./ContactsHouseholdGetHouseholdResponse"), exports);
|
|
55
56
|
__exportStar(require("./ContactsHouseholdHousehold"), exports);
|
package/docs/ContactsApi.md
CHANGED
|
@@ -5,9 +5,9 @@ All URIs are relative to *http://localhost*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
| [**createContact**](ContactsApi.md#createcontact) | **POST** /crm/api/v1/contacts | Create a contact |
|
|
8
|
-
| [**createHousehold**](ContactsApi.md#createhousehold) | **POST** /crm/api/v1/contacts/
|
|
8
|
+
| [**createHousehold**](ContactsApi.md#createhousehold) | **POST** /crm/api/v1/contacts/households | Create a household (EXPERIMENTAL) |
|
|
9
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/
|
|
10
|
+
| [**getHouseholdByUuid**](ContactsApi.md#gethouseholdbyuuid) | **GET** /crm/api/v1/contacts/households/{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 |
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
|
|
2
|
+
# ContactsHouseholdAddress
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`street1` | string
|
|
10
|
+
`street2` | string
|
|
11
|
+
`city` | string
|
|
12
|
+
`state` | string
|
|
13
|
+
`country` | string
|
|
14
|
+
`postalCode` | string
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import type { ContactsHouseholdAddress } from '@equisoft/equisoft-connect-sdk-typescript'
|
|
20
|
+
|
|
21
|
+
// TODO: Update the object below with actual values
|
|
22
|
+
const example = {
|
|
23
|
+
"street1": null,
|
|
24
|
+
"street2": null,
|
|
25
|
+
"city": null,
|
|
26
|
+
"state": null,
|
|
27
|
+
"country": null,
|
|
28
|
+
"postalCode": null,
|
|
29
|
+
} satisfies ContactsHouseholdAddress
|
|
30
|
+
|
|
31
|
+
console.log(example)
|
|
32
|
+
|
|
33
|
+
// Convert the instance to a JSON string
|
|
34
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
35
|
+
console.log(exampleJSON)
|
|
36
|
+
|
|
37
|
+
// Parse the JSON string back to an object
|
|
38
|
+
const exampleParsed = JSON.parse(exampleJSON) as ContactsHouseholdAddress
|
|
39
|
+
console.log(exampleParsed)
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
43
|
+
|
|
44
|
+
|
package/package.json
CHANGED
package/src/apis/ContactsApi.ts
CHANGED
|
@@ -200,7 +200,7 @@ export class ContactsApi extends runtime.BaseAPI {
|
|
|
200
200
|
}
|
|
201
201
|
|
|
202
202
|
|
|
203
|
-
let urlPath = `/crm/api/v1/contacts/
|
|
203
|
+
let urlPath = `/crm/api/v1/contacts/households`;
|
|
204
204
|
|
|
205
205
|
return {
|
|
206
206
|
path: urlPath,
|
|
@@ -312,7 +312,7 @@ export class ContactsApi extends runtime.BaseAPI {
|
|
|
312
312
|
}
|
|
313
313
|
|
|
314
314
|
|
|
315
|
-
let urlPath = `/crm/api/v1/contacts/
|
|
315
|
+
let urlPath = `/crm/api/v1/contacts/households/{householdUuid}`;
|
|
316
316
|
urlPath = urlPath.replace(`{${"householdUuid"}}`, encodeURIComponent(String(requestParameters['householdUuid'])));
|
|
317
317
|
|
|
318
318
|
return {
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Equisoft /connect API
|
|
5
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: latest
|
|
8
|
+
*
|
|
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 { mapValues } from '../runtime';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface ContactsHouseholdAddress
|
|
20
|
+
*/
|
|
21
|
+
export interface ContactsHouseholdAddress {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof ContactsHouseholdAddress
|
|
26
|
+
*/
|
|
27
|
+
street1?: string;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof ContactsHouseholdAddress
|
|
32
|
+
*/
|
|
33
|
+
street2?: string;
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof ContactsHouseholdAddress
|
|
38
|
+
*/
|
|
39
|
+
city?: string;
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof ContactsHouseholdAddress
|
|
44
|
+
*/
|
|
45
|
+
state?: string;
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @type {string}
|
|
49
|
+
* @memberof ContactsHouseholdAddress
|
|
50
|
+
*/
|
|
51
|
+
country?: string;
|
|
52
|
+
/**
|
|
53
|
+
*
|
|
54
|
+
* @type {string}
|
|
55
|
+
* @memberof ContactsHouseholdAddress
|
|
56
|
+
*/
|
|
57
|
+
postalCode?: string;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* Check if a given object implements the ContactsHouseholdAddress interface.
|
|
62
|
+
*/
|
|
63
|
+
export function instanceOfContactsHouseholdAddress(value: object): value is ContactsHouseholdAddress {
|
|
64
|
+
return true;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
export function ContactsHouseholdAddressFromJSON(json: any): ContactsHouseholdAddress {
|
|
68
|
+
return ContactsHouseholdAddressFromJSONTyped(json, false);
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
export function ContactsHouseholdAddressFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContactsHouseholdAddress {
|
|
72
|
+
if (json == null) {
|
|
73
|
+
return json;
|
|
74
|
+
}
|
|
75
|
+
return {
|
|
76
|
+
|
|
77
|
+
'street1': json['street1'] == null ? undefined : json['street1'],
|
|
78
|
+
'street2': json['street2'] == null ? undefined : json['street2'],
|
|
79
|
+
'city': json['city'] == null ? undefined : json['city'],
|
|
80
|
+
'state': json['state'] == null ? undefined : json['state'],
|
|
81
|
+
'country': json['country'] == null ? undefined : json['country'],
|
|
82
|
+
'postalCode': json['postalCode'] == null ? undefined : json['postalCode'],
|
|
83
|
+
};
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
export function ContactsHouseholdAddressToJSON(json: any): ContactsHouseholdAddress {
|
|
87
|
+
return ContactsHouseholdAddressToJSONTyped(json, false);
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
export function ContactsHouseholdAddressToJSONTyped(value?: ContactsHouseholdAddress | null, ignoreDiscriminator: boolean = false): any {
|
|
91
|
+
if (value == null) {
|
|
92
|
+
return value;
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
return {
|
|
96
|
+
|
|
97
|
+
'street1': value['street1'],
|
|
98
|
+
'street2': value['street2'],
|
|
99
|
+
'city': value['city'],
|
|
100
|
+
'state': value['state'],
|
|
101
|
+
'country': value['country'],
|
|
102
|
+
'postalCode': value['postalCode'],
|
|
103
|
+
};
|
|
104
|
+
}
|
|
105
|
+
|
package/src/models/index.ts
CHANGED
|
@@ -34,6 +34,7 @@ export * from './ContactsCreateRevenuePayload';
|
|
|
34
34
|
export * from './ContactsCreateSegmentationPayload';
|
|
35
35
|
export * from './ContactsCreateWebsitePayload';
|
|
36
36
|
export * from './ContactsEmail';
|
|
37
|
+
export * from './ContactsHouseholdAddress';
|
|
37
38
|
export * from './ContactsHouseholdCreateHouseholdPayload';
|
|
38
39
|
export * from './ContactsHouseholdGetHouseholdResponse';
|
|
39
40
|
export * from './ContactsHouseholdHousehold';
|