@workbuddy/sdk-js-vnext 1.0.50 → 1.0.52
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/index.d.ts +810 -2
- package/index.js +299 -3
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -2769,6 +2769,145 @@ export interface WorkBuddyCrmCustomersContactsListParams extends WorkBuddyReques
|
|
|
2769
2769
|
limit?: number;
|
|
2770
2770
|
}
|
|
2771
2771
|
|
|
2772
|
+
export interface WorkBuddyCrmCustomersContactsCreateContactParams extends WorkBuddyRequestParams {
|
|
2773
|
+
/**
|
|
2774
|
+
* Customer ID
|
|
2775
|
+
*/
|
|
2776
|
+
customerId: string;
|
|
2777
|
+
|
|
2778
|
+
firstName: string;
|
|
2779
|
+
|
|
2780
|
+
lastName: string;
|
|
2781
|
+
/**
|
|
2782
|
+
* Email address
|
|
2783
|
+
*/
|
|
2784
|
+
email?: string;
|
|
2785
|
+
/**
|
|
2786
|
+
* Phone number
|
|
2787
|
+
*/
|
|
2788
|
+
phone?: string;
|
|
2789
|
+
/**
|
|
2790
|
+
* Mobile phone number
|
|
2791
|
+
*/
|
|
2792
|
+
mobile?: string;
|
|
2793
|
+
|
|
2794
|
+
title?: string;
|
|
2795
|
+
|
|
2796
|
+
note?: string;
|
|
2797
|
+
/**
|
|
2798
|
+
* integration ID
|
|
2799
|
+
*/
|
|
2800
|
+
integrationId?: string;
|
|
2801
|
+
|
|
2802
|
+
login: boolean;
|
|
2803
|
+
/**
|
|
2804
|
+
* role ID
|
|
2805
|
+
*/
|
|
2806
|
+
roleId?: string;
|
|
2807
|
+
|
|
2808
|
+
sendEmail?: boolean;
|
|
2809
|
+
}
|
|
2810
|
+
|
|
2811
|
+
export interface WorkBuddyCrmCustomersContactsGetContactParams extends WorkBuddyRequestParams {
|
|
2812
|
+
/**
|
|
2813
|
+
* Customer ID
|
|
2814
|
+
*/
|
|
2815
|
+
customerId: string;
|
|
2816
|
+
/**
|
|
2817
|
+
* Contact ID
|
|
2818
|
+
*/
|
|
2819
|
+
contactId: string;
|
|
2820
|
+
}
|
|
2821
|
+
|
|
2822
|
+
export interface WorkBuddyCrmCustomersContactsUpdateContactParams extends WorkBuddyRequestParams {
|
|
2823
|
+
/**
|
|
2824
|
+
* Customer ID
|
|
2825
|
+
*/
|
|
2826
|
+
customerId: string;
|
|
2827
|
+
/**
|
|
2828
|
+
* Contact ID
|
|
2829
|
+
*/
|
|
2830
|
+
contactId: string;
|
|
2831
|
+
|
|
2832
|
+
firstName?: string;
|
|
2833
|
+
|
|
2834
|
+
lastName?: string;
|
|
2835
|
+
/**
|
|
2836
|
+
* Email address
|
|
2837
|
+
*/
|
|
2838
|
+
email?: string;
|
|
2839
|
+
/**
|
|
2840
|
+
* Phone number
|
|
2841
|
+
*/
|
|
2842
|
+
phone?: string;
|
|
2843
|
+
/**
|
|
2844
|
+
* Mobile phone number
|
|
2845
|
+
*/
|
|
2846
|
+
mobile?: string;
|
|
2847
|
+
|
|
2848
|
+
title?: string;
|
|
2849
|
+
|
|
2850
|
+
note?: string;
|
|
2851
|
+
/**
|
|
2852
|
+
* integration ID
|
|
2853
|
+
*/
|
|
2854
|
+
integrationId?: string;
|
|
2855
|
+
}
|
|
2856
|
+
|
|
2857
|
+
export interface WorkBuddyCrmCustomersContactsDeleteContactParams extends WorkBuddyRequestParams {
|
|
2858
|
+
/**
|
|
2859
|
+
* Customer ID
|
|
2860
|
+
*/
|
|
2861
|
+
customerId: string;
|
|
2862
|
+
/**
|
|
2863
|
+
* Contact ID
|
|
2864
|
+
*/
|
|
2865
|
+
contactId: string;
|
|
2866
|
+
}
|
|
2867
|
+
|
|
2868
|
+
export interface WorkBuddyCrmCustomersContactsInviteInviteContactParams extends WorkBuddyRequestParams {
|
|
2869
|
+
/**
|
|
2870
|
+
* Customer ID
|
|
2871
|
+
*/
|
|
2872
|
+
customerId: string;
|
|
2873
|
+
/**
|
|
2874
|
+
* Contact ID
|
|
2875
|
+
*/
|
|
2876
|
+
contactId: string;
|
|
2877
|
+
/**
|
|
2878
|
+
* Email address
|
|
2879
|
+
*/
|
|
2880
|
+
email?: string;
|
|
2881
|
+
/**
|
|
2882
|
+
* role ID
|
|
2883
|
+
*/
|
|
2884
|
+
roleId?: string;
|
|
2885
|
+
|
|
2886
|
+
sendEmail?: boolean;
|
|
2887
|
+
}
|
|
2888
|
+
|
|
2889
|
+
export interface WorkBuddyCrmCustomersContactsActivateActivateContactParams extends WorkBuddyRequestParams {
|
|
2890
|
+
/**
|
|
2891
|
+
* Customer ID
|
|
2892
|
+
*/
|
|
2893
|
+
customerId: string;
|
|
2894
|
+
/**
|
|
2895
|
+
* Contact ID
|
|
2896
|
+
*/
|
|
2897
|
+
contactId: string;
|
|
2898
|
+
}
|
|
2899
|
+
|
|
2900
|
+
export interface WorkBuddyCrmCustomersContactsDeactivateDeactivateContactParams extends WorkBuddyRequestParams {
|
|
2901
|
+
/**
|
|
2902
|
+
* Customer ID
|
|
2903
|
+
*/
|
|
2904
|
+
customerId: string;
|
|
2905
|
+
/**
|
|
2906
|
+
* Contact ID
|
|
2907
|
+
*/
|
|
2908
|
+
contactId: string;
|
|
2909
|
+
}
|
|
2910
|
+
|
|
2772
2911
|
export interface WorkBuddyCrmCustomersSitesListParams extends WorkBuddyRequestParams {
|
|
2773
2912
|
/**
|
|
2774
2913
|
* Customer ID
|
|
@@ -2948,6 +3087,156 @@ export interface WorkBuddyCrmContractorsStatusUpdateStatusParams extends WorkBud
|
|
|
2948
3087
|
note?: string;
|
|
2949
3088
|
}
|
|
2950
3089
|
|
|
3090
|
+
export interface WorkBuddyCrmContractorsContactsListParams extends WorkBuddyRequestParams {
|
|
3091
|
+
/**
|
|
3092
|
+
* Contractor ID
|
|
3093
|
+
*/
|
|
3094
|
+
contractorId: string;
|
|
3095
|
+
|
|
3096
|
+
cursor?: string;
|
|
3097
|
+
|
|
3098
|
+
limit?: number;
|
|
3099
|
+
}
|
|
3100
|
+
|
|
3101
|
+
export interface WorkBuddyCrmContractorsContactsCreateContactParams extends WorkBuddyRequestParams {
|
|
3102
|
+
/**
|
|
3103
|
+
* Contractor ID
|
|
3104
|
+
*/
|
|
3105
|
+
contractorId: string;
|
|
3106
|
+
|
|
3107
|
+
firstName: string;
|
|
3108
|
+
|
|
3109
|
+
lastName: string;
|
|
3110
|
+
/**
|
|
3111
|
+
* Email address
|
|
3112
|
+
*/
|
|
3113
|
+
email?: string;
|
|
3114
|
+
/**
|
|
3115
|
+
* Phone number
|
|
3116
|
+
*/
|
|
3117
|
+
phone?: string;
|
|
3118
|
+
/**
|
|
3119
|
+
* Mobile phone number
|
|
3120
|
+
*/
|
|
3121
|
+
mobile?: string;
|
|
3122
|
+
|
|
3123
|
+
title?: string;
|
|
3124
|
+
|
|
3125
|
+
note?: string;
|
|
3126
|
+
/**
|
|
3127
|
+
* integration ID
|
|
3128
|
+
*/
|
|
3129
|
+
integrationId?: string;
|
|
3130
|
+
|
|
3131
|
+
login: boolean;
|
|
3132
|
+
/**
|
|
3133
|
+
* role ID
|
|
3134
|
+
*/
|
|
3135
|
+
roleId?: string;
|
|
3136
|
+
|
|
3137
|
+
sendEmail?: boolean;
|
|
3138
|
+
}
|
|
3139
|
+
|
|
3140
|
+
export interface WorkBuddyCrmContractorsContactsGetContactParams extends WorkBuddyRequestParams {
|
|
3141
|
+
/**
|
|
3142
|
+
* Contractor ID
|
|
3143
|
+
*/
|
|
3144
|
+
contractorId: string;
|
|
3145
|
+
/**
|
|
3146
|
+
* Contact ID
|
|
3147
|
+
*/
|
|
3148
|
+
contactId: string;
|
|
3149
|
+
}
|
|
3150
|
+
|
|
3151
|
+
export interface WorkBuddyCrmContractorsContactsUpdateContactParams extends WorkBuddyRequestParams {
|
|
3152
|
+
/**
|
|
3153
|
+
* Contractor ID
|
|
3154
|
+
*/
|
|
3155
|
+
contractorId: string;
|
|
3156
|
+
/**
|
|
3157
|
+
* Contact ID
|
|
3158
|
+
*/
|
|
3159
|
+
contactId: string;
|
|
3160
|
+
|
|
3161
|
+
firstName?: string;
|
|
3162
|
+
|
|
3163
|
+
lastName?: string;
|
|
3164
|
+
/**
|
|
3165
|
+
* Email address
|
|
3166
|
+
*/
|
|
3167
|
+
email?: string;
|
|
3168
|
+
/**
|
|
3169
|
+
* Phone number
|
|
3170
|
+
*/
|
|
3171
|
+
phone?: string;
|
|
3172
|
+
/**
|
|
3173
|
+
* Mobile phone number
|
|
3174
|
+
*/
|
|
3175
|
+
mobile?: string;
|
|
3176
|
+
|
|
3177
|
+
title?: string;
|
|
3178
|
+
|
|
3179
|
+
note?: string;
|
|
3180
|
+
/**
|
|
3181
|
+
* integration ID
|
|
3182
|
+
*/
|
|
3183
|
+
integrationId?: string;
|
|
3184
|
+
}
|
|
3185
|
+
|
|
3186
|
+
export interface WorkBuddyCrmContractorsContactsDeleteContactParams extends WorkBuddyRequestParams {
|
|
3187
|
+
/**
|
|
3188
|
+
* Contractor ID
|
|
3189
|
+
*/
|
|
3190
|
+
contractorId: string;
|
|
3191
|
+
/**
|
|
3192
|
+
* Contact ID
|
|
3193
|
+
*/
|
|
3194
|
+
contactId: string;
|
|
3195
|
+
}
|
|
3196
|
+
|
|
3197
|
+
export interface WorkBuddyCrmContractorsContactsInviteInviteContactParams extends WorkBuddyRequestParams {
|
|
3198
|
+
/**
|
|
3199
|
+
* Contractor ID
|
|
3200
|
+
*/
|
|
3201
|
+
contractorId: string;
|
|
3202
|
+
/**
|
|
3203
|
+
* Contact ID
|
|
3204
|
+
*/
|
|
3205
|
+
contactId: string;
|
|
3206
|
+
/**
|
|
3207
|
+
* Email address
|
|
3208
|
+
*/
|
|
3209
|
+
email?: string;
|
|
3210
|
+
/**
|
|
3211
|
+
* role ID
|
|
3212
|
+
*/
|
|
3213
|
+
roleId?: string;
|
|
3214
|
+
|
|
3215
|
+
sendEmail?: boolean;
|
|
3216
|
+
}
|
|
3217
|
+
|
|
3218
|
+
export interface WorkBuddyCrmContractorsContactsActivateActivateContactParams extends WorkBuddyRequestParams {
|
|
3219
|
+
/**
|
|
3220
|
+
* Contractor ID
|
|
3221
|
+
*/
|
|
3222
|
+
contractorId: string;
|
|
3223
|
+
/**
|
|
3224
|
+
* Contact ID
|
|
3225
|
+
*/
|
|
3226
|
+
contactId: string;
|
|
3227
|
+
}
|
|
3228
|
+
|
|
3229
|
+
export interface WorkBuddyCrmContractorsContactsDeactivateDeactivateContactParams extends WorkBuddyRequestParams {
|
|
3230
|
+
/**
|
|
3231
|
+
* Contractor ID
|
|
3232
|
+
*/
|
|
3233
|
+
contractorId: string;
|
|
3234
|
+
/**
|
|
3235
|
+
* Contact ID
|
|
3236
|
+
*/
|
|
3237
|
+
contactId: string;
|
|
3238
|
+
}
|
|
3239
|
+
|
|
2951
3240
|
export interface WorkBuddyCrmSuppliersListParams extends WorkBuddyRequestParams {
|
|
2952
3241
|
/**
|
|
2953
3242
|
* Search by name, phone, email or legal name
|
|
@@ -4801,11 +5090,18 @@ export type WorkBuddyCrmCustomersListResponse = {
|
|
|
4801
5090
|
id: string;
|
|
4802
5091
|
name: string;
|
|
4803
5092
|
type: string;
|
|
5093
|
+
firstName?: string;
|
|
5094
|
+
lastName?: string;
|
|
5095
|
+
title?: string;
|
|
4804
5096
|
integrationId?: string;
|
|
4805
5097
|
address?: string;
|
|
4806
5098
|
phone?: string;
|
|
4807
5099
|
mobile?: string;
|
|
4808
5100
|
email?: string;
|
|
5101
|
+
login?: boolean;
|
|
5102
|
+
invitePending?: boolean;
|
|
5103
|
+
locked?: boolean;
|
|
5104
|
+
note?: string;
|
|
4809
5105
|
}[];
|
|
4810
5106
|
pagination: { limit: number; hasMore: boolean; nextCursor: string };
|
|
4811
5107
|
};
|
|
@@ -4910,14 +5206,136 @@ export type WorkBuddyCrmCustomersContactsListResponse = {
|
|
|
4910
5206
|
id: string;
|
|
4911
5207
|
name: string;
|
|
4912
5208
|
type: string;
|
|
5209
|
+
firstName?: string;
|
|
5210
|
+
lastName?: string;
|
|
5211
|
+
title?: string;
|
|
4913
5212
|
integrationId?: string;
|
|
4914
5213
|
address?: string;
|
|
4915
5214
|
phone?: string;
|
|
4916
5215
|
mobile?: string;
|
|
4917
5216
|
email?: string;
|
|
5217
|
+
login?: boolean;
|
|
5218
|
+
invitePending?: boolean;
|
|
5219
|
+
locked?: boolean;
|
|
5220
|
+
note?: string;
|
|
4918
5221
|
}[];
|
|
4919
5222
|
pagination: { limit: number; hasMore: boolean; nextCursor: string };
|
|
4920
5223
|
};
|
|
5224
|
+
export type WorkBuddyCrmCustomersContactsCreateContactResponse = {
|
|
5225
|
+
item: {
|
|
5226
|
+
id: string;
|
|
5227
|
+
name: string;
|
|
5228
|
+
type: string;
|
|
5229
|
+
firstName?: string;
|
|
5230
|
+
lastName?: string;
|
|
5231
|
+
title?: string;
|
|
5232
|
+
integrationId?: string;
|
|
5233
|
+
address?: string;
|
|
5234
|
+
phone?: string;
|
|
5235
|
+
mobile?: string;
|
|
5236
|
+
email?: string;
|
|
5237
|
+
login?: boolean;
|
|
5238
|
+
invitePending?: boolean;
|
|
5239
|
+
locked?: boolean;
|
|
5240
|
+
note?: string;
|
|
5241
|
+
};
|
|
5242
|
+
};
|
|
5243
|
+
export type WorkBuddyCrmCustomersContactsGetContactResponse = {
|
|
5244
|
+
item: {
|
|
5245
|
+
id: string;
|
|
5246
|
+
name: string;
|
|
5247
|
+
type: string;
|
|
5248
|
+
firstName?: string;
|
|
5249
|
+
lastName?: string;
|
|
5250
|
+
title?: string;
|
|
5251
|
+
integrationId?: string;
|
|
5252
|
+
address?: string;
|
|
5253
|
+
phone?: string;
|
|
5254
|
+
mobile?: string;
|
|
5255
|
+
email?: string;
|
|
5256
|
+
login?: boolean;
|
|
5257
|
+
invitePending?: boolean;
|
|
5258
|
+
locked?: boolean;
|
|
5259
|
+
note?: string;
|
|
5260
|
+
};
|
|
5261
|
+
};
|
|
5262
|
+
export type WorkBuddyCrmCustomersContactsUpdateContactResponse = {
|
|
5263
|
+
item: {
|
|
5264
|
+
id: string;
|
|
5265
|
+
name: string;
|
|
5266
|
+
type: string;
|
|
5267
|
+
firstName?: string;
|
|
5268
|
+
lastName?: string;
|
|
5269
|
+
title?: string;
|
|
5270
|
+
integrationId?: string;
|
|
5271
|
+
address?: string;
|
|
5272
|
+
phone?: string;
|
|
5273
|
+
mobile?: string;
|
|
5274
|
+
email?: string;
|
|
5275
|
+
login?: boolean;
|
|
5276
|
+
invitePending?: boolean;
|
|
5277
|
+
locked?: boolean;
|
|
5278
|
+
note?: string;
|
|
5279
|
+
};
|
|
5280
|
+
};
|
|
5281
|
+
export type WorkBuddyCrmCustomersContactsDeleteContactResponse = unknown;
|
|
5282
|
+
export type WorkBuddyCrmCustomersContactsInviteInviteContactResponse = {
|
|
5283
|
+
item: {
|
|
5284
|
+
id: string;
|
|
5285
|
+
name: string;
|
|
5286
|
+
type: string;
|
|
5287
|
+
firstName?: string;
|
|
5288
|
+
lastName?: string;
|
|
5289
|
+
title?: string;
|
|
5290
|
+
integrationId?: string;
|
|
5291
|
+
address?: string;
|
|
5292
|
+
phone?: string;
|
|
5293
|
+
mobile?: string;
|
|
5294
|
+
email?: string;
|
|
5295
|
+
login?: boolean;
|
|
5296
|
+
invitePending?: boolean;
|
|
5297
|
+
locked?: boolean;
|
|
5298
|
+
note?: string;
|
|
5299
|
+
};
|
|
5300
|
+
};
|
|
5301
|
+
export type WorkBuddyCrmCustomersContactsActivateActivateContactResponse = {
|
|
5302
|
+
item: {
|
|
5303
|
+
id: string;
|
|
5304
|
+
name: string;
|
|
5305
|
+
type: string;
|
|
5306
|
+
firstName?: string;
|
|
5307
|
+
lastName?: string;
|
|
5308
|
+
title?: string;
|
|
5309
|
+
integrationId?: string;
|
|
5310
|
+
address?: string;
|
|
5311
|
+
phone?: string;
|
|
5312
|
+
mobile?: string;
|
|
5313
|
+
email?: string;
|
|
5314
|
+
login?: boolean;
|
|
5315
|
+
invitePending?: boolean;
|
|
5316
|
+
locked?: boolean;
|
|
5317
|
+
note?: string;
|
|
5318
|
+
};
|
|
5319
|
+
};
|
|
5320
|
+
export type WorkBuddyCrmCustomersContactsDeactivateDeactivateContactResponse = {
|
|
5321
|
+
item: {
|
|
5322
|
+
id: string;
|
|
5323
|
+
name: string;
|
|
5324
|
+
type: string;
|
|
5325
|
+
firstName?: string;
|
|
5326
|
+
lastName?: string;
|
|
5327
|
+
title?: string;
|
|
5328
|
+
integrationId?: string;
|
|
5329
|
+
address?: string;
|
|
5330
|
+
phone?: string;
|
|
5331
|
+
mobile?: string;
|
|
5332
|
+
email?: string;
|
|
5333
|
+
login?: boolean;
|
|
5334
|
+
invitePending?: boolean;
|
|
5335
|
+
locked?: boolean;
|
|
5336
|
+
note?: string;
|
|
5337
|
+
};
|
|
5338
|
+
};
|
|
4921
5339
|
export type WorkBuddyCrmCustomersSitesListResponse = {
|
|
4922
5340
|
items: { id: string; name: string; address: string }[];
|
|
4923
5341
|
pagination: { limit: number; hasMore: boolean; nextCursor: string };
|
|
@@ -4927,11 +5345,18 @@ export type WorkBuddyCrmEmployeesListResponse = {
|
|
|
4927
5345
|
id: string;
|
|
4928
5346
|
name: string;
|
|
4929
5347
|
type: string;
|
|
5348
|
+
firstName?: string;
|
|
5349
|
+
lastName?: string;
|
|
5350
|
+
title?: string;
|
|
4930
5351
|
integrationId?: string;
|
|
4931
5352
|
address?: string;
|
|
4932
5353
|
phone?: string;
|
|
4933
5354
|
mobile?: string;
|
|
4934
5355
|
email?: string;
|
|
5356
|
+
login?: boolean;
|
|
5357
|
+
invitePending?: boolean;
|
|
5358
|
+
locked?: boolean;
|
|
5359
|
+
note?: string;
|
|
4935
5360
|
}[];
|
|
4936
5361
|
pagination: { limit: number; hasMore: boolean; nextCursor: string };
|
|
4937
5362
|
};
|
|
@@ -4940,11 +5365,18 @@ export type WorkBuddyCrmEmployeesGetResponse = {
|
|
|
4940
5365
|
id: string;
|
|
4941
5366
|
name: string;
|
|
4942
5367
|
type: string;
|
|
5368
|
+
firstName?: string;
|
|
5369
|
+
lastName?: string;
|
|
5370
|
+
title?: string;
|
|
4943
5371
|
integrationId?: string;
|
|
4944
5372
|
address?: string;
|
|
4945
5373
|
phone?: string;
|
|
4946
5374
|
mobile?: string;
|
|
4947
5375
|
email?: string;
|
|
5376
|
+
login?: boolean;
|
|
5377
|
+
invitePending?: boolean;
|
|
5378
|
+
locked?: boolean;
|
|
5379
|
+
note?: string;
|
|
4948
5380
|
};
|
|
4949
5381
|
};
|
|
4950
5382
|
export type WorkBuddyCrmContractorsListResponse = {
|
|
@@ -4952,11 +5384,18 @@ export type WorkBuddyCrmContractorsListResponse = {
|
|
|
4952
5384
|
id: string;
|
|
4953
5385
|
name: string;
|
|
4954
5386
|
type: string;
|
|
5387
|
+
firstName?: string;
|
|
5388
|
+
lastName?: string;
|
|
5389
|
+
title?: string;
|
|
4955
5390
|
integrationId?: string;
|
|
4956
5391
|
address?: string;
|
|
4957
5392
|
phone?: string;
|
|
4958
5393
|
mobile?: string;
|
|
4959
5394
|
email?: string;
|
|
5395
|
+
login?: boolean;
|
|
5396
|
+
invitePending?: boolean;
|
|
5397
|
+
locked?: boolean;
|
|
5398
|
+
note?: string;
|
|
4960
5399
|
}[];
|
|
4961
5400
|
pagination: { limit: number; hasMore: boolean; nextCursor: string };
|
|
4962
5401
|
};
|
|
@@ -5088,16 +5527,158 @@ export type WorkBuddyCrmContractorsStatusUpdateStatusResponse = {
|
|
|
5088
5527
|
pricebook: string;
|
|
5089
5528
|
};
|
|
5090
5529
|
};
|
|
5530
|
+
export type WorkBuddyCrmContractorsContactsListResponse = {
|
|
5531
|
+
items: {
|
|
5532
|
+
id: string;
|
|
5533
|
+
name: string;
|
|
5534
|
+
type: string;
|
|
5535
|
+
firstName?: string;
|
|
5536
|
+
lastName?: string;
|
|
5537
|
+
title?: string;
|
|
5538
|
+
integrationId?: string;
|
|
5539
|
+
address?: string;
|
|
5540
|
+
phone?: string;
|
|
5541
|
+
mobile?: string;
|
|
5542
|
+
email?: string;
|
|
5543
|
+
login?: boolean;
|
|
5544
|
+
invitePending?: boolean;
|
|
5545
|
+
locked?: boolean;
|
|
5546
|
+
note?: string;
|
|
5547
|
+
}[];
|
|
5548
|
+
pagination: { limit: number; hasMore: boolean; nextCursor: string };
|
|
5549
|
+
};
|
|
5550
|
+
export type WorkBuddyCrmContractorsContactsCreateContactResponse = {
|
|
5551
|
+
item: {
|
|
5552
|
+
id: string;
|
|
5553
|
+
name: string;
|
|
5554
|
+
type: string;
|
|
5555
|
+
firstName?: string;
|
|
5556
|
+
lastName?: string;
|
|
5557
|
+
title?: string;
|
|
5558
|
+
integrationId?: string;
|
|
5559
|
+
address?: string;
|
|
5560
|
+
phone?: string;
|
|
5561
|
+
mobile?: string;
|
|
5562
|
+
email?: string;
|
|
5563
|
+
login?: boolean;
|
|
5564
|
+
invitePending?: boolean;
|
|
5565
|
+
locked?: boolean;
|
|
5566
|
+
note?: string;
|
|
5567
|
+
};
|
|
5568
|
+
};
|
|
5569
|
+
export type WorkBuddyCrmContractorsContactsGetContactResponse = {
|
|
5570
|
+
item: {
|
|
5571
|
+
id: string;
|
|
5572
|
+
name: string;
|
|
5573
|
+
type: string;
|
|
5574
|
+
firstName?: string;
|
|
5575
|
+
lastName?: string;
|
|
5576
|
+
title?: string;
|
|
5577
|
+
integrationId?: string;
|
|
5578
|
+
address?: string;
|
|
5579
|
+
phone?: string;
|
|
5580
|
+
mobile?: string;
|
|
5581
|
+
email?: string;
|
|
5582
|
+
login?: boolean;
|
|
5583
|
+
invitePending?: boolean;
|
|
5584
|
+
locked?: boolean;
|
|
5585
|
+
note?: string;
|
|
5586
|
+
};
|
|
5587
|
+
};
|
|
5588
|
+
export type WorkBuddyCrmContractorsContactsUpdateContactResponse = {
|
|
5589
|
+
item: {
|
|
5590
|
+
id: string;
|
|
5591
|
+
name: string;
|
|
5592
|
+
type: string;
|
|
5593
|
+
firstName?: string;
|
|
5594
|
+
lastName?: string;
|
|
5595
|
+
title?: string;
|
|
5596
|
+
integrationId?: string;
|
|
5597
|
+
address?: string;
|
|
5598
|
+
phone?: string;
|
|
5599
|
+
mobile?: string;
|
|
5600
|
+
email?: string;
|
|
5601
|
+
login?: boolean;
|
|
5602
|
+
invitePending?: boolean;
|
|
5603
|
+
locked?: boolean;
|
|
5604
|
+
note?: string;
|
|
5605
|
+
};
|
|
5606
|
+
};
|
|
5607
|
+
export type WorkBuddyCrmContractorsContactsDeleteContactResponse = unknown;
|
|
5608
|
+
export type WorkBuddyCrmContractorsContactsInviteInviteContactResponse = {
|
|
5609
|
+
item: {
|
|
5610
|
+
id: string;
|
|
5611
|
+
name: string;
|
|
5612
|
+
type: string;
|
|
5613
|
+
firstName?: string;
|
|
5614
|
+
lastName?: string;
|
|
5615
|
+
title?: string;
|
|
5616
|
+
integrationId?: string;
|
|
5617
|
+
address?: string;
|
|
5618
|
+
phone?: string;
|
|
5619
|
+
mobile?: string;
|
|
5620
|
+
email?: string;
|
|
5621
|
+
login?: boolean;
|
|
5622
|
+
invitePending?: boolean;
|
|
5623
|
+
locked?: boolean;
|
|
5624
|
+
note?: string;
|
|
5625
|
+
};
|
|
5626
|
+
};
|
|
5627
|
+
export type WorkBuddyCrmContractorsContactsActivateActivateContactResponse = {
|
|
5628
|
+
item: {
|
|
5629
|
+
id: string;
|
|
5630
|
+
name: string;
|
|
5631
|
+
type: string;
|
|
5632
|
+
firstName?: string;
|
|
5633
|
+
lastName?: string;
|
|
5634
|
+
title?: string;
|
|
5635
|
+
integrationId?: string;
|
|
5636
|
+
address?: string;
|
|
5637
|
+
phone?: string;
|
|
5638
|
+
mobile?: string;
|
|
5639
|
+
email?: string;
|
|
5640
|
+
login?: boolean;
|
|
5641
|
+
invitePending?: boolean;
|
|
5642
|
+
locked?: boolean;
|
|
5643
|
+
note?: string;
|
|
5644
|
+
};
|
|
5645
|
+
};
|
|
5646
|
+
export type WorkBuddyCrmContractorsContactsDeactivateDeactivateContactResponse = {
|
|
5647
|
+
item: {
|
|
5648
|
+
id: string;
|
|
5649
|
+
name: string;
|
|
5650
|
+
type: string;
|
|
5651
|
+
firstName?: string;
|
|
5652
|
+
lastName?: string;
|
|
5653
|
+
title?: string;
|
|
5654
|
+
integrationId?: string;
|
|
5655
|
+
address?: string;
|
|
5656
|
+
phone?: string;
|
|
5657
|
+
mobile?: string;
|
|
5658
|
+
email?: string;
|
|
5659
|
+
login?: boolean;
|
|
5660
|
+
invitePending?: boolean;
|
|
5661
|
+
locked?: boolean;
|
|
5662
|
+
note?: string;
|
|
5663
|
+
};
|
|
5664
|
+
};
|
|
5091
5665
|
export type WorkBuddyCrmSuppliersListResponse = {
|
|
5092
5666
|
items: {
|
|
5093
5667
|
id: string;
|
|
5094
5668
|
name: string;
|
|
5095
5669
|
type: string;
|
|
5670
|
+
firstName?: string;
|
|
5671
|
+
lastName?: string;
|
|
5672
|
+
title?: string;
|
|
5096
5673
|
integrationId?: string;
|
|
5097
5674
|
address?: string;
|
|
5098
5675
|
phone?: string;
|
|
5099
5676
|
mobile?: string;
|
|
5100
5677
|
email?: string;
|
|
5678
|
+
login?: boolean;
|
|
5679
|
+
invitePending?: boolean;
|
|
5680
|
+
locked?: boolean;
|
|
5681
|
+
note?: string;
|
|
5101
5682
|
}[];
|
|
5102
5683
|
pagination: { limit: number; hasMore: boolean; nextCursor: string };
|
|
5103
5684
|
};
|
|
@@ -5238,10 +5819,17 @@ export type WorkBuddyCrmCompaniesListResponse = {
|
|
|
5238
5819
|
id: string;
|
|
5239
5820
|
name: string;
|
|
5240
5821
|
type: string;
|
|
5822
|
+
firstName?: string;
|
|
5823
|
+
lastName?: string;
|
|
5824
|
+
title?: string;
|
|
5241
5825
|
integrationId?: string;
|
|
5242
5826
|
address?: string;
|
|
5243
5827
|
phone?: string;
|
|
5244
5828
|
email?: string;
|
|
5829
|
+
login?: boolean;
|
|
5830
|
+
invitePending?: boolean;
|
|
5831
|
+
locked?: boolean;
|
|
5832
|
+
note?: string;
|
|
5245
5833
|
}[];
|
|
5246
5834
|
pagination: { limit: number; hasMore: boolean; nextCursor: string };
|
|
5247
5835
|
};
|
|
@@ -5250,10 +5838,17 @@ export type WorkBuddyCrmCompaniesGetResponse = {
|
|
|
5250
5838
|
id: string;
|
|
5251
5839
|
name: string;
|
|
5252
5840
|
type: string;
|
|
5841
|
+
firstName?: string;
|
|
5842
|
+
lastName?: string;
|
|
5843
|
+
title?: string;
|
|
5253
5844
|
integrationId?: string;
|
|
5254
5845
|
address?: string;
|
|
5255
5846
|
phone?: string;
|
|
5256
5847
|
email?: string;
|
|
5848
|
+
login?: boolean;
|
|
5849
|
+
invitePending?: boolean;
|
|
5850
|
+
locked?: boolean;
|
|
5851
|
+
note?: string;
|
|
5257
5852
|
};
|
|
5258
5853
|
};
|
|
5259
5854
|
export type WorkBuddyCrmExternalUsersListResponse = {
|
|
@@ -5261,11 +5856,18 @@ export type WorkBuddyCrmExternalUsersListResponse = {
|
|
|
5261
5856
|
id: string;
|
|
5262
5857
|
name: string;
|
|
5263
5858
|
type: string;
|
|
5859
|
+
firstName?: string;
|
|
5860
|
+
lastName?: string;
|
|
5861
|
+
title?: string;
|
|
5264
5862
|
integrationId?: string;
|
|
5265
5863
|
address?: string;
|
|
5266
5864
|
phone?: string;
|
|
5267
5865
|
mobile?: string;
|
|
5268
5866
|
email?: string;
|
|
5867
|
+
login?: boolean;
|
|
5868
|
+
invitePending?: boolean;
|
|
5869
|
+
locked?: boolean;
|
|
5870
|
+
note?: string;
|
|
5269
5871
|
}[];
|
|
5270
5872
|
pagination: { limit: number; hasMore: boolean; nextCursor: string };
|
|
5271
5873
|
};
|
|
@@ -5274,11 +5876,18 @@ export type WorkBuddyCrmExternalUsersGetResponse = {
|
|
|
5274
5876
|
id: string;
|
|
5275
5877
|
name: string;
|
|
5276
5878
|
type: string;
|
|
5879
|
+
firstName?: string;
|
|
5880
|
+
lastName?: string;
|
|
5881
|
+
title?: string;
|
|
5277
5882
|
integrationId?: string;
|
|
5278
5883
|
address?: string;
|
|
5279
5884
|
phone?: string;
|
|
5280
5885
|
mobile?: string;
|
|
5281
5886
|
email?: string;
|
|
5887
|
+
login?: boolean;
|
|
5888
|
+
invitePending?: boolean;
|
|
5889
|
+
locked?: boolean;
|
|
5890
|
+
note?: string;
|
|
5282
5891
|
};
|
|
5283
5892
|
};
|
|
5284
5893
|
export type WorkBuddyCrmContactsListResponse = {
|
|
@@ -5286,11 +5895,18 @@ export type WorkBuddyCrmContactsListResponse = {
|
|
|
5286
5895
|
id: string;
|
|
5287
5896
|
name: string;
|
|
5288
5897
|
type: string;
|
|
5898
|
+
firstName?: string;
|
|
5899
|
+
lastName?: string;
|
|
5900
|
+
title?: string;
|
|
5289
5901
|
integrationId?: string;
|
|
5290
5902
|
address?: string;
|
|
5291
5903
|
phone?: string;
|
|
5292
5904
|
mobile?: string;
|
|
5293
5905
|
email?: string;
|
|
5906
|
+
login?: boolean;
|
|
5907
|
+
invitePending?: boolean;
|
|
5908
|
+
locked?: boolean;
|
|
5909
|
+
note?: string;
|
|
5294
5910
|
}[];
|
|
5295
5911
|
pagination: { limit: number; hasMore: boolean; nextCursor: string };
|
|
5296
5912
|
};
|
|
@@ -5299,11 +5915,18 @@ export type WorkBuddyCrmContactsGetResponse = {
|
|
|
5299
5915
|
id: string;
|
|
5300
5916
|
name: string;
|
|
5301
5917
|
type: string;
|
|
5918
|
+
firstName?: string;
|
|
5919
|
+
lastName?: string;
|
|
5920
|
+
title?: string;
|
|
5302
5921
|
integrationId?: string;
|
|
5303
5922
|
address?: string;
|
|
5304
5923
|
phone?: string;
|
|
5305
5924
|
mobile?: string;
|
|
5306
5925
|
email?: string;
|
|
5926
|
+
login?: boolean;
|
|
5927
|
+
invitePending?: boolean;
|
|
5928
|
+
locked?: boolean;
|
|
5929
|
+
note?: string;
|
|
5307
5930
|
};
|
|
5308
5931
|
};
|
|
5309
5932
|
export type WorkBuddyCrmInvitesListResponse = {
|
|
@@ -5311,11 +5934,18 @@ export type WorkBuddyCrmInvitesListResponse = {
|
|
|
5311
5934
|
id: string;
|
|
5312
5935
|
name: string;
|
|
5313
5936
|
type: string;
|
|
5937
|
+
firstName?: string;
|
|
5938
|
+
lastName?: string;
|
|
5939
|
+
title?: string;
|
|
5314
5940
|
integrationId?: string;
|
|
5315
5941
|
address?: string;
|
|
5316
5942
|
phone?: string;
|
|
5317
5943
|
mobile?: string;
|
|
5318
5944
|
email?: string;
|
|
5945
|
+
login?: boolean;
|
|
5946
|
+
invitePending?: boolean;
|
|
5947
|
+
locked?: boolean;
|
|
5948
|
+
note?: string;
|
|
5319
5949
|
}[];
|
|
5320
5950
|
pagination: { limit: number; hasMore: boolean; nextCursor: string };
|
|
5321
5951
|
};
|
|
@@ -5324,11 +5954,18 @@ export type WorkBuddyCrmInvitesGetResponse = {
|
|
|
5324
5954
|
id: string;
|
|
5325
5955
|
name: string;
|
|
5326
5956
|
type: string;
|
|
5957
|
+
firstName?: string;
|
|
5958
|
+
lastName?: string;
|
|
5959
|
+
title?: string;
|
|
5327
5960
|
integrationId?: string;
|
|
5328
5961
|
address?: string;
|
|
5329
5962
|
phone?: string;
|
|
5330
5963
|
mobile?: string;
|
|
5331
5964
|
email?: string;
|
|
5965
|
+
login?: boolean;
|
|
5966
|
+
invitePending?: boolean;
|
|
5967
|
+
locked?: boolean;
|
|
5968
|
+
note?: string;
|
|
5332
5969
|
};
|
|
5333
5970
|
};
|
|
5334
5971
|
export type WorkBuddyCrmSitesListResponse = {
|
|
@@ -6661,8 +7298,14 @@ export interface WorkBuddyCrmCustomersStatusResource {
|
|
|
6661
7298
|
}
|
|
6662
7299
|
|
|
6663
7300
|
export interface WorkBuddyCrmCustomersContactsResource {
|
|
6664
|
-
/**
|
|
6665
|
-
|
|
7301
|
+
/** Invite API operations. */
|
|
7302
|
+
invite: WorkBuddyCrmCustomersContactsInviteResource;
|
|
7303
|
+
/** Activate API operations. */
|
|
7304
|
+
activate: WorkBuddyCrmCustomersContactsActivateResource;
|
|
7305
|
+
/** Deactivate API operations. */
|
|
7306
|
+
deactivate: WorkBuddyCrmCustomersContactsDeactivateResource;
|
|
7307
|
+
/**
|
|
7308
|
+
* List contacts for customer (contacts + external users)
|
|
6666
7309
|
* Operation: PublicCrmCustomerController_listContacts
|
|
6667
7310
|
*/
|
|
6668
7311
|
list<TResponse = WorkBuddyCrmCustomersContactsListResponse>(
|
|
@@ -6679,6 +7322,74 @@ export interface WorkBuddyCrmCustomersContactsResource {
|
|
|
6679
7322
|
params: WorkBuddyCrmCustomersContactsListParams,
|
|
6680
7323
|
options?: WorkBuddyRequestOptions
|
|
6681
7324
|
): AsyncIterable<TPage>;
|
|
7325
|
+
/**
|
|
7326
|
+
* Create customer contact. login=false creates a contact; login=true invites an external user (email required and must be free via ID validate).
|
|
7327
|
+
* Operation: PublicCrmCustomerController_createContact
|
|
7328
|
+
*/
|
|
7329
|
+
createContact<TResponse = WorkBuddyCrmCustomersContactsCreateContactResponse>(
|
|
7330
|
+
params: WorkBuddyCrmCustomersContactsCreateContactParams,
|
|
7331
|
+
options?: WorkBuddyRequestOptions
|
|
7332
|
+
): Promise<TResponse>;
|
|
7333
|
+
|
|
7334
|
+
/**
|
|
7335
|
+
* Get customer contact by ID
|
|
7336
|
+
* Operation: PublicCrmCustomerController_getContact
|
|
7337
|
+
*/
|
|
7338
|
+
getContact<TResponse = WorkBuddyCrmCustomersContactsGetContactResponse>(
|
|
7339
|
+
params: WorkBuddyCrmCustomersContactsGetContactParams,
|
|
7340
|
+
options?: WorkBuddyRequestOptions
|
|
7341
|
+
): Promise<TResponse>;
|
|
7342
|
+
|
|
7343
|
+
/**
|
|
7344
|
+
* Update customer contact
|
|
7345
|
+
* Operation: PublicCrmCustomerController_updateContact
|
|
7346
|
+
*/
|
|
7347
|
+
updateContact<TResponse = WorkBuddyCrmCustomersContactsUpdateContactResponse>(
|
|
7348
|
+
params: WorkBuddyCrmCustomersContactsUpdateContactParams,
|
|
7349
|
+
options?: WorkBuddyRequestOptions
|
|
7350
|
+
): Promise<TResponse>;
|
|
7351
|
+
|
|
7352
|
+
/**
|
|
7353
|
+
* Delete customer contact
|
|
7354
|
+
* Operation: PublicCrmCustomerController_deleteContact
|
|
7355
|
+
*/
|
|
7356
|
+
deleteContact<TResponse = WorkBuddyCrmCustomersContactsDeleteContactResponse>(
|
|
7357
|
+
params: WorkBuddyCrmCustomersContactsDeleteContactParams,
|
|
7358
|
+
options?: WorkBuddyRequestOptions
|
|
7359
|
+
): Promise<TResponse>;
|
|
7360
|
+
}
|
|
7361
|
+
|
|
7362
|
+
export interface WorkBuddyCrmCustomersContactsInviteResource {
|
|
7363
|
+
/**
|
|
7364
|
+
* Promote an existing contact to external user and send invite (CRM)
|
|
7365
|
+
* Operation: PublicCrmCustomerController_inviteContact
|
|
7366
|
+
*/
|
|
7367
|
+
inviteContact<TResponse = WorkBuddyCrmCustomersContactsInviteInviteContactResponse>(
|
|
7368
|
+
params: WorkBuddyCrmCustomersContactsInviteInviteContactParams,
|
|
7369
|
+
options?: WorkBuddyRequestOptions
|
|
7370
|
+
): Promise<TResponse>;
|
|
7371
|
+
}
|
|
7372
|
+
|
|
7373
|
+
export interface WorkBuddyCrmCustomersContactsActivateResource {
|
|
7374
|
+
/**
|
|
7375
|
+
* Unlock portal login for an external user (CRM)
|
|
7376
|
+
* Operation: PublicCrmCustomerController_activateContact
|
|
7377
|
+
*/
|
|
7378
|
+
activateContact<TResponse = WorkBuddyCrmCustomersContactsActivateActivateContactResponse>(
|
|
7379
|
+
params: WorkBuddyCrmCustomersContactsActivateActivateContactParams,
|
|
7380
|
+
options?: WorkBuddyRequestOptions
|
|
7381
|
+
): Promise<TResponse>;
|
|
7382
|
+
}
|
|
7383
|
+
|
|
7384
|
+
export interface WorkBuddyCrmCustomersContactsDeactivateResource {
|
|
7385
|
+
/**
|
|
7386
|
+
* Lock portal login for an external user (CRM)
|
|
7387
|
+
* Operation: PublicCrmCustomerController_deactivateContact
|
|
7388
|
+
*/
|
|
7389
|
+
deactivateContact<TResponse = WorkBuddyCrmCustomersContactsDeactivateDeactivateContactResponse>(
|
|
7390
|
+
params: WorkBuddyCrmCustomersContactsDeactivateDeactivateContactParams,
|
|
7391
|
+
options?: WorkBuddyRequestOptions
|
|
7392
|
+
): Promise<TResponse>;
|
|
6682
7393
|
}
|
|
6683
7394
|
|
|
6684
7395
|
export interface WorkBuddyCrmCustomersSitesResource {
|
|
@@ -6734,6 +7445,8 @@ export interface WorkBuddyCrmEmployeesResource {
|
|
|
6734
7445
|
export interface WorkBuddyCrmContractorsResource {
|
|
6735
7446
|
/** Status API operations. */
|
|
6736
7447
|
status: WorkBuddyCrmContractorsStatusResource;
|
|
7448
|
+
/** Contacts API operations. */
|
|
7449
|
+
contacts: WorkBuddyCrmContractorsContactsResource;
|
|
6737
7450
|
/**
|
|
6738
7451
|
* List contractors
|
|
6739
7452
|
* Operation: PublicCrmContractorController_list
|
|
@@ -6791,6 +7504,101 @@ export interface WorkBuddyCrmContractorsStatusResource {
|
|
|
6791
7504
|
): Promise<TResponse>;
|
|
6792
7505
|
}
|
|
6793
7506
|
|
|
7507
|
+
export interface WorkBuddyCrmContractorsContactsResource {
|
|
7508
|
+
/** Invite API operations. */
|
|
7509
|
+
invite: WorkBuddyCrmContractorsContactsInviteResource;
|
|
7510
|
+
/** Activate API operations. */
|
|
7511
|
+
activate: WorkBuddyCrmContractorsContactsActivateResource;
|
|
7512
|
+
/** Deactivate API operations. */
|
|
7513
|
+
deactivate: WorkBuddyCrmContractorsContactsDeactivateResource;
|
|
7514
|
+
/**
|
|
7515
|
+
* List contacts for contractor (contacts + external users)
|
|
7516
|
+
* Operation: PublicCrmContractorController_listContacts
|
|
7517
|
+
*/
|
|
7518
|
+
list<TResponse = WorkBuddyCrmContractorsContactsListResponse>(
|
|
7519
|
+
params: WorkBuddyCrmContractorsContactsListParams,
|
|
7520
|
+
options?: WorkBuddyRequestOptions
|
|
7521
|
+
): Promise<TResponse>;
|
|
7522
|
+
/** Iterate all items by following cursor pagination for list(). */
|
|
7523
|
+
all<TItem = WorkBuddyPageItem<WorkBuddyCrmContractorsContactsListResponse>>(
|
|
7524
|
+
params: WorkBuddyCrmContractorsContactsListParams,
|
|
7525
|
+
options?: WorkBuddyRequestOptions
|
|
7526
|
+
): AsyncIterable<TItem>;
|
|
7527
|
+
/** Iterate raw pages by following cursor pagination for list(). */
|
|
7528
|
+
pages<TPage = WorkBuddyCrmContractorsContactsListResponse>(
|
|
7529
|
+
params: WorkBuddyCrmContractorsContactsListParams,
|
|
7530
|
+
options?: WorkBuddyRequestOptions
|
|
7531
|
+
): AsyncIterable<TPage>;
|
|
7532
|
+
/**
|
|
7533
|
+
* Create contractor contact. login=false creates a contact; login=true invites an external user (email required and must be free via ID validate).
|
|
7534
|
+
* Operation: PublicCrmContractorController_createContact
|
|
7535
|
+
*/
|
|
7536
|
+
createContact<TResponse = WorkBuddyCrmContractorsContactsCreateContactResponse>(
|
|
7537
|
+
params: WorkBuddyCrmContractorsContactsCreateContactParams,
|
|
7538
|
+
options?: WorkBuddyRequestOptions
|
|
7539
|
+
): Promise<TResponse>;
|
|
7540
|
+
|
|
7541
|
+
/**
|
|
7542
|
+
* Get contractor contact by ID
|
|
7543
|
+
* Operation: PublicCrmContractorController_getContact
|
|
7544
|
+
*/
|
|
7545
|
+
getContact<TResponse = WorkBuddyCrmContractorsContactsGetContactResponse>(
|
|
7546
|
+
params: WorkBuddyCrmContractorsContactsGetContactParams,
|
|
7547
|
+
options?: WorkBuddyRequestOptions
|
|
7548
|
+
): Promise<TResponse>;
|
|
7549
|
+
|
|
7550
|
+
/**
|
|
7551
|
+
* Update contractor contact
|
|
7552
|
+
* Operation: PublicCrmContractorController_updateContact
|
|
7553
|
+
*/
|
|
7554
|
+
updateContact<TResponse = WorkBuddyCrmContractorsContactsUpdateContactResponse>(
|
|
7555
|
+
params: WorkBuddyCrmContractorsContactsUpdateContactParams,
|
|
7556
|
+
options?: WorkBuddyRequestOptions
|
|
7557
|
+
): Promise<TResponse>;
|
|
7558
|
+
|
|
7559
|
+
/**
|
|
7560
|
+
* Delete contractor contact
|
|
7561
|
+
* Operation: PublicCrmContractorController_deleteContact
|
|
7562
|
+
*/
|
|
7563
|
+
deleteContact<TResponse = WorkBuddyCrmContractorsContactsDeleteContactResponse>(
|
|
7564
|
+
params: WorkBuddyCrmContractorsContactsDeleteContactParams,
|
|
7565
|
+
options?: WorkBuddyRequestOptions
|
|
7566
|
+
): Promise<TResponse>;
|
|
7567
|
+
}
|
|
7568
|
+
|
|
7569
|
+
export interface WorkBuddyCrmContractorsContactsInviteResource {
|
|
7570
|
+
/**
|
|
7571
|
+
* Promote an existing contact to external user and send invite (CRM > Contractors)
|
|
7572
|
+
* Operation: PublicCrmContractorController_inviteContact
|
|
7573
|
+
*/
|
|
7574
|
+
inviteContact<TResponse = WorkBuddyCrmContractorsContactsInviteInviteContactResponse>(
|
|
7575
|
+
params: WorkBuddyCrmContractorsContactsInviteInviteContactParams,
|
|
7576
|
+
options?: WorkBuddyRequestOptions
|
|
7577
|
+
): Promise<TResponse>;
|
|
7578
|
+
}
|
|
7579
|
+
|
|
7580
|
+
export interface WorkBuddyCrmContractorsContactsActivateResource {
|
|
7581
|
+
/**
|
|
7582
|
+
* Unlock portal login for an external user (CRM > Contractors)
|
|
7583
|
+
* Operation: PublicCrmContractorController_activateContact
|
|
7584
|
+
*/
|
|
7585
|
+
activateContact<TResponse = WorkBuddyCrmContractorsContactsActivateActivateContactResponse>(
|
|
7586
|
+
params: WorkBuddyCrmContractorsContactsActivateActivateContactParams,
|
|
7587
|
+
options?: WorkBuddyRequestOptions
|
|
7588
|
+
): Promise<TResponse>;
|
|
7589
|
+
}
|
|
7590
|
+
|
|
7591
|
+
export interface WorkBuddyCrmContractorsContactsDeactivateResource {
|
|
7592
|
+
/**
|
|
7593
|
+
* Lock portal login for an external user (CRM > Contractors)
|
|
7594
|
+
* Operation: PublicCrmContractorController_deactivateContact
|
|
7595
|
+
*/
|
|
7596
|
+
deactivateContact<TResponse = WorkBuddyCrmContractorsContactsDeactivateDeactivateContactResponse>(
|
|
7597
|
+
params: WorkBuddyCrmContractorsContactsDeactivateDeactivateContactParams,
|
|
7598
|
+
options?: WorkBuddyRequestOptions
|
|
7599
|
+
): Promise<TResponse>;
|
|
7600
|
+
}
|
|
7601
|
+
|
|
6794
7602
|
export interface WorkBuddyCrmSuppliersResource {
|
|
6795
7603
|
/** Status API operations. */
|
|
6796
7604
|
status: WorkBuddyCrmSuppliersStatusResource;
|
package/index.js
CHANGED
|
@@ -729,8 +729,32 @@ export class WorkBuddyClient {
|
|
|
729
729
|
this.request('PublicCrmCustomerController_updateStatus', params, options),
|
|
730
730
|
},
|
|
731
731
|
contacts: {
|
|
732
|
+
invite: {
|
|
733
|
+
/**
|
|
734
|
+
* Promote an existing contact to external user and send invite (CRM)
|
|
735
|
+
* Operation: PublicCrmCustomerController_inviteContact
|
|
736
|
+
*/
|
|
737
|
+
inviteContact: (params = {}, options = {}) =>
|
|
738
|
+
this.request('PublicCrmCustomerController_inviteContact', params, options),
|
|
739
|
+
},
|
|
740
|
+
activate: {
|
|
741
|
+
/**
|
|
742
|
+
* Unlock portal login for an external user (CRM)
|
|
743
|
+
* Operation: PublicCrmCustomerController_activateContact
|
|
744
|
+
*/
|
|
745
|
+
activateContact: (params = {}, options = {}) =>
|
|
746
|
+
this.request('PublicCrmCustomerController_activateContact', params, options),
|
|
747
|
+
},
|
|
748
|
+
deactivate: {
|
|
749
|
+
/**
|
|
750
|
+
* Lock portal login for an external user (CRM)
|
|
751
|
+
* Operation: PublicCrmCustomerController_deactivateContact
|
|
752
|
+
*/
|
|
753
|
+
deactivateContact: (params = {}, options = {}) =>
|
|
754
|
+
this.request('PublicCrmCustomerController_deactivateContact', params, options),
|
|
755
|
+
},
|
|
732
756
|
/**
|
|
733
|
-
* List contacts for customer
|
|
757
|
+
* List contacts for customer (contacts + external users)
|
|
734
758
|
* Operation: PublicCrmCustomerController_listContacts
|
|
735
759
|
*/
|
|
736
760
|
list: (params = {}, options = {}) =>
|
|
@@ -741,6 +765,30 @@ export class WorkBuddyClient {
|
|
|
741
765
|
/** Iterate raw pages by following cursor pagination for list(). */
|
|
742
766
|
pages: (params = {}, options = {}) =>
|
|
743
767
|
this.paginatePages('PublicCrmCustomerController_listContacts', params, options),
|
|
768
|
+
/**
|
|
769
|
+
* Create customer contact. login=false creates a contact; login=true invites an external user (email required and must be free via ID validate).
|
|
770
|
+
* Operation: PublicCrmCustomerController_createContact
|
|
771
|
+
*/
|
|
772
|
+
createContact: (params = {}, options = {}) =>
|
|
773
|
+
this.request('PublicCrmCustomerController_createContact', params, options),
|
|
774
|
+
/**
|
|
775
|
+
* Get customer contact by ID
|
|
776
|
+
* Operation: PublicCrmCustomerController_getContact
|
|
777
|
+
*/
|
|
778
|
+
getContact: (params = {}, options = {}) =>
|
|
779
|
+
this.request('PublicCrmCustomerController_getContact', params, options),
|
|
780
|
+
/**
|
|
781
|
+
* Update customer contact
|
|
782
|
+
* Operation: PublicCrmCustomerController_updateContact
|
|
783
|
+
*/
|
|
784
|
+
updateContact: (params = {}, options = {}) =>
|
|
785
|
+
this.request('PublicCrmCustomerController_updateContact', params, options),
|
|
786
|
+
/**
|
|
787
|
+
* Delete customer contact
|
|
788
|
+
* Operation: PublicCrmCustomerController_deleteContact
|
|
789
|
+
*/
|
|
790
|
+
deleteContact: (params = {}, options = {}) =>
|
|
791
|
+
this.request('PublicCrmCustomerController_deleteContact', params, options),
|
|
744
792
|
},
|
|
745
793
|
sites: {
|
|
746
794
|
/**
|
|
@@ -804,6 +852,68 @@ export class WorkBuddyClient {
|
|
|
804
852
|
updateStatus: (params = {}, options = {}) =>
|
|
805
853
|
this.request('PublicCrmContractorController_updateStatus', params, options),
|
|
806
854
|
},
|
|
855
|
+
contacts: {
|
|
856
|
+
invite: {
|
|
857
|
+
/**
|
|
858
|
+
* Promote an existing contact to external user and send invite (CRM > Contractors)
|
|
859
|
+
* Operation: PublicCrmContractorController_inviteContact
|
|
860
|
+
*/
|
|
861
|
+
inviteContact: (params = {}, options = {}) =>
|
|
862
|
+
this.request('PublicCrmContractorController_inviteContact', params, options),
|
|
863
|
+
},
|
|
864
|
+
activate: {
|
|
865
|
+
/**
|
|
866
|
+
* Unlock portal login for an external user (CRM > Contractors)
|
|
867
|
+
* Operation: PublicCrmContractorController_activateContact
|
|
868
|
+
*/
|
|
869
|
+
activateContact: (params = {}, options = {}) =>
|
|
870
|
+
this.request('PublicCrmContractorController_activateContact', params, options),
|
|
871
|
+
},
|
|
872
|
+
deactivate: {
|
|
873
|
+
/**
|
|
874
|
+
* Lock portal login for an external user (CRM > Contractors)
|
|
875
|
+
* Operation: PublicCrmContractorController_deactivateContact
|
|
876
|
+
*/
|
|
877
|
+
deactivateContact: (params = {}, options = {}) =>
|
|
878
|
+
this.request('PublicCrmContractorController_deactivateContact', params, options),
|
|
879
|
+
},
|
|
880
|
+
/**
|
|
881
|
+
* List contacts for contractor (contacts + external users)
|
|
882
|
+
* Operation: PublicCrmContractorController_listContacts
|
|
883
|
+
*/
|
|
884
|
+
list: (params = {}, options = {}) =>
|
|
885
|
+
this.request('PublicCrmContractorController_listContacts', params, options),
|
|
886
|
+
/** Iterate all items by following cursor pagination for list(). */
|
|
887
|
+
all: (params = {}, options = {}) =>
|
|
888
|
+
this.paginate('PublicCrmContractorController_listContacts', params, options),
|
|
889
|
+
/** Iterate raw pages by following cursor pagination for list(). */
|
|
890
|
+
pages: (params = {}, options = {}) =>
|
|
891
|
+
this.paginatePages('PublicCrmContractorController_listContacts', params, options),
|
|
892
|
+
/**
|
|
893
|
+
* Create contractor contact. login=false creates a contact; login=true invites an external user (email required and must be free via ID validate).
|
|
894
|
+
* Operation: PublicCrmContractorController_createContact
|
|
895
|
+
*/
|
|
896
|
+
createContact: (params = {}, options = {}) =>
|
|
897
|
+
this.request('PublicCrmContractorController_createContact', params, options),
|
|
898
|
+
/**
|
|
899
|
+
* Get contractor contact by ID
|
|
900
|
+
* Operation: PublicCrmContractorController_getContact
|
|
901
|
+
*/
|
|
902
|
+
getContact: (params = {}, options = {}) =>
|
|
903
|
+
this.request('PublicCrmContractorController_getContact', params, options),
|
|
904
|
+
/**
|
|
905
|
+
* Update contractor contact
|
|
906
|
+
* Operation: PublicCrmContractorController_updateContact
|
|
907
|
+
*/
|
|
908
|
+
updateContact: (params = {}, options = {}) =>
|
|
909
|
+
this.request('PublicCrmContractorController_updateContact', params, options),
|
|
910
|
+
/**
|
|
911
|
+
* Delete contractor contact
|
|
912
|
+
* Operation: PublicCrmContractorController_deleteContact
|
|
913
|
+
*/
|
|
914
|
+
deleteContact: (params = {}, options = {}) =>
|
|
915
|
+
this.request('PublicCrmContractorController_deleteContact', params, options),
|
|
916
|
+
},
|
|
807
917
|
/**
|
|
808
918
|
* List contractors
|
|
809
919
|
* Operation: PublicCrmContractorController_list
|
|
@@ -2573,14 +2683,100 @@ export const operations = [
|
|
|
2573
2683
|
actionName: 'list',
|
|
2574
2684
|
paginatedItemsActionName: 'all',
|
|
2575
2685
|
paginatedPagesActionName: 'pages',
|
|
2576
|
-
displayName: 'List contacts for customer',
|
|
2577
|
-
description: 'List contacts for customer',
|
|
2686
|
+
displayName: 'List contacts for customer (contacts + external users)',
|
|
2687
|
+
description: 'List contacts for customer (contacts + external users)',
|
|
2578
2688
|
method: 'GET',
|
|
2579
2689
|
path: '/customers/{customerId}/contacts',
|
|
2580
2690
|
pathParams: ['customerId'],
|
|
2581
2691
|
queryParams: ['cursor', 'limit'],
|
|
2582
2692
|
hasRequestBody: false,
|
|
2583
2693
|
},
|
|
2694
|
+
{
|
|
2695
|
+
operationId: 'PublicCrmCustomerController_createContact',
|
|
2696
|
+
resourcePath: ['crm', 'customers', 'contacts'],
|
|
2697
|
+
actionName: 'createContact',
|
|
2698
|
+
displayName:
|
|
2699
|
+
'Create customer contact. login=false creates a contact; login=true invites an external user (email required and must be free via ID validate).',
|
|
2700
|
+
description:
|
|
2701
|
+
'Create customer contact. login=false creates a contact; login=true invites an external user (email required and must be free via ID validate).',
|
|
2702
|
+
method: 'POST',
|
|
2703
|
+
path: '/customers/{customerId}/contacts',
|
|
2704
|
+
pathParams: ['customerId'],
|
|
2705
|
+
queryParams: [],
|
|
2706
|
+
hasRequestBody: true,
|
|
2707
|
+
},
|
|
2708
|
+
{
|
|
2709
|
+
operationId: 'PublicCrmCustomerController_getContact',
|
|
2710
|
+
resourcePath: ['crm', 'customers', 'contacts'],
|
|
2711
|
+
actionName: 'getContact',
|
|
2712
|
+
displayName: 'Get customer contact by ID',
|
|
2713
|
+
description: 'Get customer contact by ID',
|
|
2714
|
+
method: 'GET',
|
|
2715
|
+
path: '/customers/{customerId}/contacts/{contactId}',
|
|
2716
|
+
pathParams: ['customerId', 'contactId'],
|
|
2717
|
+
queryParams: [],
|
|
2718
|
+
hasRequestBody: false,
|
|
2719
|
+
},
|
|
2720
|
+
{
|
|
2721
|
+
operationId: 'PublicCrmCustomerController_updateContact',
|
|
2722
|
+
resourcePath: ['crm', 'customers', 'contacts'],
|
|
2723
|
+
actionName: 'updateContact',
|
|
2724
|
+
displayName: 'Update customer contact',
|
|
2725
|
+
description: 'Update customer contact',
|
|
2726
|
+
method: 'PATCH',
|
|
2727
|
+
path: '/customers/{customerId}/contacts/{contactId}',
|
|
2728
|
+
pathParams: ['customerId', 'contactId'],
|
|
2729
|
+
queryParams: [],
|
|
2730
|
+
hasRequestBody: true,
|
|
2731
|
+
},
|
|
2732
|
+
{
|
|
2733
|
+
operationId: 'PublicCrmCustomerController_deleteContact',
|
|
2734
|
+
resourcePath: ['crm', 'customers', 'contacts'],
|
|
2735
|
+
actionName: 'deleteContact',
|
|
2736
|
+
displayName: 'Delete customer contact',
|
|
2737
|
+
description: 'Delete customer contact',
|
|
2738
|
+
method: 'DELETE',
|
|
2739
|
+
path: '/customers/{customerId}/contacts/{contactId}',
|
|
2740
|
+
pathParams: ['customerId', 'contactId'],
|
|
2741
|
+
queryParams: [],
|
|
2742
|
+
hasRequestBody: false,
|
|
2743
|
+
},
|
|
2744
|
+
{
|
|
2745
|
+
operationId: 'PublicCrmCustomerController_inviteContact',
|
|
2746
|
+
resourcePath: ['crm', 'customers', 'contacts', 'invite'],
|
|
2747
|
+
actionName: 'inviteContact',
|
|
2748
|
+
displayName: 'Promote an existing contact to external user and send invite (CRM)',
|
|
2749
|
+
description: 'Promote an existing contact to external user and send invite (CRM)',
|
|
2750
|
+
method: 'POST',
|
|
2751
|
+
path: '/customers/{customerId}/contacts/{contactId}/invite',
|
|
2752
|
+
pathParams: ['customerId', 'contactId'],
|
|
2753
|
+
queryParams: [],
|
|
2754
|
+
hasRequestBody: true,
|
|
2755
|
+
},
|
|
2756
|
+
{
|
|
2757
|
+
operationId: 'PublicCrmCustomerController_activateContact',
|
|
2758
|
+
resourcePath: ['crm', 'customers', 'contacts', 'activate'],
|
|
2759
|
+
actionName: 'activateContact',
|
|
2760
|
+
displayName: 'Unlock portal login for an external user (CRM)',
|
|
2761
|
+
description: 'Unlock portal login for an external user (CRM)',
|
|
2762
|
+
method: 'POST',
|
|
2763
|
+
path: '/customers/{customerId}/contacts/{contactId}/activate',
|
|
2764
|
+
pathParams: ['customerId', 'contactId'],
|
|
2765
|
+
queryParams: [],
|
|
2766
|
+
hasRequestBody: false,
|
|
2767
|
+
},
|
|
2768
|
+
{
|
|
2769
|
+
operationId: 'PublicCrmCustomerController_deactivateContact',
|
|
2770
|
+
resourcePath: ['crm', 'customers', 'contacts', 'deactivate'],
|
|
2771
|
+
actionName: 'deactivateContact',
|
|
2772
|
+
displayName: 'Lock portal login for an external user (CRM)',
|
|
2773
|
+
description: 'Lock portal login for an external user (CRM)',
|
|
2774
|
+
method: 'POST',
|
|
2775
|
+
path: '/customers/{customerId}/contacts/{contactId}/deactivate',
|
|
2776
|
+
pathParams: ['customerId', 'contactId'],
|
|
2777
|
+
queryParams: [],
|
|
2778
|
+
hasRequestBody: false,
|
|
2779
|
+
},
|
|
2584
2780
|
{
|
|
2585
2781
|
operationId: 'PublicCrmCustomerController_listSites',
|
|
2586
2782
|
resourcePath: ['crm', 'customers', 'sites'],
|
|
@@ -2683,6 +2879,106 @@ export const operations = [
|
|
|
2683
2879
|
queryParams: [],
|
|
2684
2880
|
hasRequestBody: true,
|
|
2685
2881
|
},
|
|
2882
|
+
{
|
|
2883
|
+
operationId: 'PublicCrmContractorController_listContacts',
|
|
2884
|
+
resourcePath: ['crm', 'contractors', 'contacts'],
|
|
2885
|
+
actionName: 'list',
|
|
2886
|
+
paginatedItemsActionName: 'all',
|
|
2887
|
+
paginatedPagesActionName: 'pages',
|
|
2888
|
+
displayName: 'List contacts for contractor (contacts + external users)',
|
|
2889
|
+
description: 'List contacts for contractor (contacts + external users)',
|
|
2890
|
+
method: 'GET',
|
|
2891
|
+
path: '/contractors/{contractorId}/contacts',
|
|
2892
|
+
pathParams: ['contractorId'],
|
|
2893
|
+
queryParams: ['cursor', 'limit'],
|
|
2894
|
+
hasRequestBody: false,
|
|
2895
|
+
},
|
|
2896
|
+
{
|
|
2897
|
+
operationId: 'PublicCrmContractorController_createContact',
|
|
2898
|
+
resourcePath: ['crm', 'contractors', 'contacts'],
|
|
2899
|
+
actionName: 'createContact',
|
|
2900
|
+
displayName:
|
|
2901
|
+
'Create contractor contact. login=false creates a contact; login=true invites an external user (email required and must be free via ID validate).',
|
|
2902
|
+
description:
|
|
2903
|
+
'Create contractor contact. login=false creates a contact; login=true invites an external user (email required and must be free via ID validate).',
|
|
2904
|
+
method: 'POST',
|
|
2905
|
+
path: '/contractors/{contractorId}/contacts',
|
|
2906
|
+
pathParams: ['contractorId'],
|
|
2907
|
+
queryParams: [],
|
|
2908
|
+
hasRequestBody: true,
|
|
2909
|
+
},
|
|
2910
|
+
{
|
|
2911
|
+
operationId: 'PublicCrmContractorController_getContact',
|
|
2912
|
+
resourcePath: ['crm', 'contractors', 'contacts'],
|
|
2913
|
+
actionName: 'getContact',
|
|
2914
|
+
displayName: 'Get contractor contact by ID',
|
|
2915
|
+
description: 'Get contractor contact by ID',
|
|
2916
|
+
method: 'GET',
|
|
2917
|
+
path: '/contractors/{contractorId}/contacts/{contactId}',
|
|
2918
|
+
pathParams: ['contractorId', 'contactId'],
|
|
2919
|
+
queryParams: [],
|
|
2920
|
+
hasRequestBody: false,
|
|
2921
|
+
},
|
|
2922
|
+
{
|
|
2923
|
+
operationId: 'PublicCrmContractorController_updateContact',
|
|
2924
|
+
resourcePath: ['crm', 'contractors', 'contacts'],
|
|
2925
|
+
actionName: 'updateContact',
|
|
2926
|
+
displayName: 'Update contractor contact',
|
|
2927
|
+
description: 'Update contractor contact',
|
|
2928
|
+
method: 'PATCH',
|
|
2929
|
+
path: '/contractors/{contractorId}/contacts/{contactId}',
|
|
2930
|
+
pathParams: ['contractorId', 'contactId'],
|
|
2931
|
+
queryParams: [],
|
|
2932
|
+
hasRequestBody: true,
|
|
2933
|
+
},
|
|
2934
|
+
{
|
|
2935
|
+
operationId: 'PublicCrmContractorController_deleteContact',
|
|
2936
|
+
resourcePath: ['crm', 'contractors', 'contacts'],
|
|
2937
|
+
actionName: 'deleteContact',
|
|
2938
|
+
displayName: 'Delete contractor contact',
|
|
2939
|
+
description: 'Delete contractor contact',
|
|
2940
|
+
method: 'DELETE',
|
|
2941
|
+
path: '/contractors/{contractorId}/contacts/{contactId}',
|
|
2942
|
+
pathParams: ['contractorId', 'contactId'],
|
|
2943
|
+
queryParams: [],
|
|
2944
|
+
hasRequestBody: false,
|
|
2945
|
+
},
|
|
2946
|
+
{
|
|
2947
|
+
operationId: 'PublicCrmContractorController_inviteContact',
|
|
2948
|
+
resourcePath: ['crm', 'contractors', 'contacts', 'invite'],
|
|
2949
|
+
actionName: 'inviteContact',
|
|
2950
|
+
displayName: 'Promote an existing contact to external user and send invite (CRM > Contractors)',
|
|
2951
|
+
description: 'Promote an existing contact to external user and send invite (CRM > Contractors)',
|
|
2952
|
+
method: 'POST',
|
|
2953
|
+
path: '/contractors/{contractorId}/contacts/{contactId}/invite',
|
|
2954
|
+
pathParams: ['contractorId', 'contactId'],
|
|
2955
|
+
queryParams: [],
|
|
2956
|
+
hasRequestBody: true,
|
|
2957
|
+
},
|
|
2958
|
+
{
|
|
2959
|
+
operationId: 'PublicCrmContractorController_activateContact',
|
|
2960
|
+
resourcePath: ['crm', 'contractors', 'contacts', 'activate'],
|
|
2961
|
+
actionName: 'activateContact',
|
|
2962
|
+
displayName: 'Unlock portal login for an external user (CRM > Contractors)',
|
|
2963
|
+
description: 'Unlock portal login for an external user (CRM > Contractors)',
|
|
2964
|
+
method: 'POST',
|
|
2965
|
+
path: '/contractors/{contractorId}/contacts/{contactId}/activate',
|
|
2966
|
+
pathParams: ['contractorId', 'contactId'],
|
|
2967
|
+
queryParams: [],
|
|
2968
|
+
hasRequestBody: false,
|
|
2969
|
+
},
|
|
2970
|
+
{
|
|
2971
|
+
operationId: 'PublicCrmContractorController_deactivateContact',
|
|
2972
|
+
resourcePath: ['crm', 'contractors', 'contacts', 'deactivate'],
|
|
2973
|
+
actionName: 'deactivateContact',
|
|
2974
|
+
displayName: 'Lock portal login for an external user (CRM > Contractors)',
|
|
2975
|
+
description: 'Lock portal login for an external user (CRM > Contractors)',
|
|
2976
|
+
method: 'POST',
|
|
2977
|
+
path: '/contractors/{contractorId}/contacts/{contactId}/deactivate',
|
|
2978
|
+
pathParams: ['contractorId', 'contactId'],
|
|
2979
|
+
queryParams: [],
|
|
2980
|
+
hasRequestBody: false,
|
|
2981
|
+
},
|
|
2686
2982
|
{
|
|
2687
2983
|
operationId: 'PublicCrmSupplierController_list',
|
|
2688
2984
|
resourcePath: ['crm', 'suppliers'],
|