@sweepbright/api-client 0.30.2 → 0.30.4
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/.circleci/config.yml +102 -0
- package/.devcontainer/Dockerfile +23 -0
- package/.devcontainer/devcontainer.json +59 -0
- package/.editorconfig +11 -0
- package/.eslintrc.json +6 -0
- package/.github/PULL_REQUEST_TEMPLATE.md +40 -0
- package/.nvmrc +1 -0
- package/.prettierignore +1 -0
- package/jest.config.js +7 -0
- package/mockServer.ts +44 -0
- package/package.json +3 -6
- package/setupTests.ts +1 -0
- package/src/__tests__/auth.test.ts +14 -0
- package/src/__tests__/channels.test.ts +104 -0
- package/src/__tests__/contacts.test.ts +85 -0
- package/src/__tests__/estates.test.ts +50 -0
- package/src/__tests__/leads.test.ts +67 -0
- package/src/common/currencies.ts +50 -0
- package/src/common/types.ts +1 -0
- package/src/entities/office.ts +193 -0
- package/src/entities/property.ts +574 -0
- package/src/index.ts +128 -0
- package/src/resources/channel_accounts.ts +39 -0
- package/src/resources/channels.ts +52 -0
- package/src/resources/companies.ts +15 -0
- package/src/resources/contact_preferences.ts +14 -0
- package/src/resources/contacts.ts +38 -0
- package/src/resources/estates.ts +145 -0
- package/src/resources/leads.ts +65 -0
- package/src/resources/negotiators.ts +19 -0
- package/src/resources/offices.ts +12 -0
- package/src/types.ts +88 -0
- package/src/utils.ts +35 -0
- package/tsconfig.json +19 -0
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
export enum Currency {
|
|
2
|
+
EUR = 'EUR',
|
|
3
|
+
AUD = 'AUD',
|
|
4
|
+
USD = 'USD',
|
|
5
|
+
AFN = 'AFN',
|
|
6
|
+
GBP = 'GBP',
|
|
7
|
+
XPF = 'XPF',
|
|
8
|
+
MXN = 'MXN',
|
|
9
|
+
PHP = 'PHP',
|
|
10
|
+
CAD = 'CAD',
|
|
11
|
+
RON = 'RON',
|
|
12
|
+
BRL = 'BRL',
|
|
13
|
+
UYU = 'UYU',
|
|
14
|
+
HRK = 'HRK',
|
|
15
|
+
GEL = 'GEL',
|
|
16
|
+
RSD = 'RSD',
|
|
17
|
+
ILS = 'ILS',
|
|
18
|
+
ARS = 'ARS',
|
|
19
|
+
NZD = 'NZD',
|
|
20
|
+
ZAR = 'ZAR',
|
|
21
|
+
INR = 'INR',
|
|
22
|
+
DZD = 'DZD',
|
|
23
|
+
LKR = 'LKR',
|
|
24
|
+
CLP = 'CLP',
|
|
25
|
+
ALL = 'ALL',
|
|
26
|
+
RUB = 'RUB',
|
|
27
|
+
TRY = 'TRY',
|
|
28
|
+
UAH = 'UAH',
|
|
29
|
+
MUR = 'MUR',
|
|
30
|
+
COP = 'COP',
|
|
31
|
+
AED = 'AED',
|
|
32
|
+
MZN = 'MZN',
|
|
33
|
+
EGP = 'EGP',
|
|
34
|
+
AOA = 'AOA',
|
|
35
|
+
XOF = 'XOF',
|
|
36
|
+
CNY = 'CNY',
|
|
37
|
+
XCD = 'XCD',
|
|
38
|
+
VND = 'VND',
|
|
39
|
+
JPY = 'JPY',
|
|
40
|
+
MAD = 'MAD',
|
|
41
|
+
CHF = 'CHF',
|
|
42
|
+
IRR = 'IRR',
|
|
43
|
+
KHR = 'KHR',
|
|
44
|
+
XAF = 'XAF',
|
|
45
|
+
AMD = 'AMD',
|
|
46
|
+
ETB = 'ETB',
|
|
47
|
+
SGD = 'SGD',
|
|
48
|
+
NGN = 'NGN',
|
|
49
|
+
PKP = 'PKP',
|
|
50
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type Maybe<T> = T | null | undefined;
|
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
import { Currency } from '../common/currencies';
|
|
2
|
+
import { Maybe } from '../common/types';
|
|
3
|
+
|
|
4
|
+
export enum MeasurementSystem {
|
|
5
|
+
metric = 'metric',
|
|
6
|
+
imperial = 'imperial',
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
export interface OfficeSettings {
|
|
10
|
+
measurement_system: MeasurementSystem;
|
|
11
|
+
numeral_system: string;
|
|
12
|
+
currency: Currency;
|
|
13
|
+
country: string;
|
|
14
|
+
visit_duration: 30;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
export interface OfficeSettingData {
|
|
18
|
+
data: OfficeSettings;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
export interface Plan {
|
|
22
|
+
id: string;
|
|
23
|
+
max_users: number;
|
|
24
|
+
price: object;
|
|
25
|
+
interval: string;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
export interface PlanData {
|
|
29
|
+
data: Plan;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
interface Settings {
|
|
33
|
+
about_en: string;
|
|
34
|
+
'about_en-GB': string;
|
|
35
|
+
about_fr: string;
|
|
36
|
+
'about_fr-BE': string;
|
|
37
|
+
about_nl: string;
|
|
38
|
+
agency_website_hostname: string;
|
|
39
|
+
contact_additional: string;
|
|
40
|
+
contact_borough_or_district: string;
|
|
41
|
+
contact_box: string;
|
|
42
|
+
contact_city: string;
|
|
43
|
+
contact_country: string;
|
|
44
|
+
contact_county: string;
|
|
45
|
+
contact_email: string;
|
|
46
|
+
contact_number: string;
|
|
47
|
+
contact_phone: string;
|
|
48
|
+
contact_street: string;
|
|
49
|
+
contact_street_2: string;
|
|
50
|
+
contact_zip: string;
|
|
51
|
+
default_country: string;
|
|
52
|
+
default_email: string;
|
|
53
|
+
default_legal_company_name: string;
|
|
54
|
+
default_legal_VAT_number: string;
|
|
55
|
+
default_locale: string;
|
|
56
|
+
description_en: string;
|
|
57
|
+
'description_en-GB': string;
|
|
58
|
+
description_facebook: string;
|
|
59
|
+
description_fr: string;
|
|
60
|
+
'description_fr-BE': string;
|
|
61
|
+
description_instagram: string;
|
|
62
|
+
description_nl: string;
|
|
63
|
+
description_twitter: string;
|
|
64
|
+
disabled_reason: string;
|
|
65
|
+
domain_agency_id: string;
|
|
66
|
+
email: string;
|
|
67
|
+
enable_amepi: string;
|
|
68
|
+
'enable_belles-demeures': string;
|
|
69
|
+
enable_bienici: string;
|
|
70
|
+
'enable_bureau-locaux': string;
|
|
71
|
+
'enable_cession-pme': string;
|
|
72
|
+
enable_facebook: string;
|
|
73
|
+
enable_green_acres: string;
|
|
74
|
+
'enable_hotellerie-restauration': string;
|
|
75
|
+
enable_immovlan: string;
|
|
76
|
+
enable_immoweb: string;
|
|
77
|
+
'enable_immoweb-v2': string;
|
|
78
|
+
'enable_le_figaro-immo': string;
|
|
79
|
+
enable_leboncoin: string;
|
|
80
|
+
enable_logicimmo: string;
|
|
81
|
+
'enable_logicimmo-fr': string;
|
|
82
|
+
'enable_meilleurs-agents': string;
|
|
83
|
+
enable_onthemarket: string;
|
|
84
|
+
'enable_ouest-france': string;
|
|
85
|
+
'enable_paru-vendu': string;
|
|
86
|
+
'enable_propriete-le-figaro': string;
|
|
87
|
+
enable_publicapi: string;
|
|
88
|
+
enable_rightmove: string;
|
|
89
|
+
enable_seloger: string;
|
|
90
|
+
'enable_seloger-bureau-commerce': string;
|
|
91
|
+
enable_twitter: string;
|
|
92
|
+
enable_ubiflow: string;
|
|
93
|
+
'enable_vitrine-media': string;
|
|
94
|
+
enable_website: string;
|
|
95
|
+
enable_zillow: string;
|
|
96
|
+
enable_zoopla: string;
|
|
97
|
+
enable_zumper: string;
|
|
98
|
+
facebook_pixel_id: string;
|
|
99
|
+
google_analytics_id: string;
|
|
100
|
+
homepage_cover: string;
|
|
101
|
+
homepage_cover_image: string;
|
|
102
|
+
homepage_cover_video: string;
|
|
103
|
+
homepage_highlights: any[];
|
|
104
|
+
homepage_properties: string;
|
|
105
|
+
immovlan_customer_id: string;
|
|
106
|
+
immoweb_ftp_password: string;
|
|
107
|
+
immoweb_ftp_username: string;
|
|
108
|
+
integration_document_management_sweepbright_documents: boolean;
|
|
109
|
+
intercom_app_id: string;
|
|
110
|
+
invoice_address: string;
|
|
111
|
+
invoice_address_2: string;
|
|
112
|
+
invoice_city: string;
|
|
113
|
+
invoice_company_name: string;
|
|
114
|
+
invoice_country: string;
|
|
115
|
+
invoice_county: string;
|
|
116
|
+
invoice_email: string;
|
|
117
|
+
invoice_first_name: string;
|
|
118
|
+
invoice_last_name: string;
|
|
119
|
+
invoice_vat_number: string;
|
|
120
|
+
invoice_zip: string;
|
|
121
|
+
languages: string[];
|
|
122
|
+
links_facebook: string;
|
|
123
|
+
links_instagram: string;
|
|
124
|
+
links_linkedin: string;
|
|
125
|
+
links_twitter: string;
|
|
126
|
+
livechat_app_id: string;
|
|
127
|
+
logic_immo_agency_id: string;
|
|
128
|
+
new_properties_en: string;
|
|
129
|
+
'new_properties_en-GB': string;
|
|
130
|
+
new_properties_fr: string;
|
|
131
|
+
'new_properties_fr-BE': string;
|
|
132
|
+
new_properties_nl: string;
|
|
133
|
+
onthemarket_api_key: string;
|
|
134
|
+
published_url_resolvers: string[];
|
|
135
|
+
registration_number: string;
|
|
136
|
+
rent_period: string;
|
|
137
|
+
rightmove_api_key: string;
|
|
138
|
+
signup_company_name: string;
|
|
139
|
+
signup_country: string;
|
|
140
|
+
signup_email: string;
|
|
141
|
+
tagline_en: string;
|
|
142
|
+
'tagline_en-GB': string;
|
|
143
|
+
tagline_fr: string;
|
|
144
|
+
'tagline_fr-BE': string;
|
|
145
|
+
tagline_nl: string;
|
|
146
|
+
theme: string;
|
|
147
|
+
theme_buttons: string;
|
|
148
|
+
theme_custom_color: string;
|
|
149
|
+
theme_typeface: string;
|
|
150
|
+
timezone: string;
|
|
151
|
+
transaction_types: string;
|
|
152
|
+
unassigned_leads_admin_id: number;
|
|
153
|
+
zoopla_api_key: string;
|
|
154
|
+
description: string;
|
|
155
|
+
about: string;
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
export interface SettingsData {
|
|
159
|
+
data: Settings;
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
export interface Company {
|
|
163
|
+
id: string;
|
|
164
|
+
name: string;
|
|
165
|
+
locale: string;
|
|
166
|
+
referrer?: Maybe<object>;
|
|
167
|
+
member_count: number;
|
|
168
|
+
member_allowed: number;
|
|
169
|
+
contacts_count: number;
|
|
170
|
+
channels_count: number;
|
|
171
|
+
intercom_app_id: string;
|
|
172
|
+
disabled_at?: Maybe<string>;
|
|
173
|
+
created_at?: Maybe<string>;
|
|
174
|
+
updated_at?: Maybe<string>;
|
|
175
|
+
plan: PlanData;
|
|
176
|
+
settings: SettingsData;
|
|
177
|
+
}
|
|
178
|
+
|
|
179
|
+
export interface CompanyData {
|
|
180
|
+
data: Company;
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
export interface Office {
|
|
184
|
+
id: string;
|
|
185
|
+
name: string;
|
|
186
|
+
properties_count: number;
|
|
187
|
+
contacts_count: number;
|
|
188
|
+
company: CompanyData;
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
export interface OfficeData {
|
|
192
|
+
data: Office;
|
|
193
|
+
}
|