@homespot-sdk/core 0.0.346 → 0.0.347

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.
@@ -2901,763 +2901,108 @@ export const StageCardsResponseSchema = {
2901
2901
  },
2902
2902
  required: ['data', 'members'],
2903
2903
  };
2904
- export const BoardWinRateSchema = {
2904
+ export const BucketSchema = {
2905
2905
  type: 'object',
2906
2906
  properties: {
2907
- boardId: {
2908
- type: 'string',
2909
- format: 'uuid',
2910
- },
2911
- name: {
2912
- type: 'string',
2913
- },
2914
- won: {
2915
- type: 'integer',
2916
- format: 'int64',
2917
- },
2918
- lost: {
2907
+ count: {
2919
2908
  type: 'integer',
2920
2909
  format: 'int64',
2921
2910
  },
2922
- winRatePct: {
2911
+ value: {
2923
2912
  type: 'number',
2924
- format: 'double',
2925
- },
2926
- },
2927
- required: ['boardId', 'lost', 'name', 'winRatePct', 'won'],
2928
- };
2929
- export const MemberWinRateSchema = {
2930
- type: 'object',
2931
- properties: {
2932
- memberId: {
2933
- type: 'string',
2934
- format: 'uuid',
2935
- },
2936
- won: {
2937
- type: 'integer',
2938
- format: 'int64',
2939
- },
2940
- lost: {
2941
- type: 'integer',
2942
- format: 'int64',
2943
2913
  },
2944
- winRatePct: {
2914
+ commission: {
2945
2915
  type: 'number',
2946
- format: 'double',
2947
2916
  },
2948
2917
  },
2949
- required: ['lost', 'memberId', 'winRatePct', 'won'],
2950
2918
  };
2951
- export const StatsEnvelopeWinRateStatsSchema = {
2919
+ export const PipelineCommissionResponseSchema = {
2952
2920
  type: 'object',
2953
2921
  properties: {
2954
- period: {
2922
+ from: {
2955
2923
  type: 'string',
2924
+ format: 'date',
2956
2925
  },
2957
- computedAt: {
2926
+ to: {
2958
2927
  type: 'string',
2959
- format: 'date-time',
2960
- },
2961
- data: {
2962
- $ref: '#/components/schemas/WinRateStats',
2928
+ format: 'date',
2963
2929
  },
2964
- },
2965
- required: ['computedAt', 'data', 'period'],
2966
- };
2967
- export const WinRateStatsSchema = {
2968
- type: 'object',
2969
- properties: {
2970
2930
  won: {
2971
- type: 'integer',
2972
- format: 'int64',
2931
+ $ref: '#/components/schemas/Bucket',
2973
2932
  },
2974
2933
  lost: {
2975
- type: 'integer',
2976
- format: 'int64',
2977
- },
2978
- winRatePct: {
2979
- type: 'number',
2980
- format: 'double',
2981
- },
2982
- boards: {
2983
- type: 'array',
2984
- items: {
2985
- $ref: '#/components/schemas/BoardWinRate',
2986
- },
2987
- },
2988
- members: {
2989
- type: 'array',
2990
- items: {
2991
- $ref: '#/components/schemas/MemberWinRate',
2992
- },
2993
- },
2994
- },
2995
- required: ['boards', 'lost', 'members', 'winRatePct', 'won'],
2996
- };
2997
- export const StageVelocitySchema = {
2998
- type: 'object',
2999
- properties: {
3000
- boardId: {
3001
- type: 'string',
3002
- format: 'uuid',
3003
- },
3004
- boardName: {
3005
- type: 'string',
3006
- },
3007
- stageId: {
3008
- type: 'string',
3009
- format: 'uuid',
3010
- },
3011
- stageName: {
3012
- type: 'string',
3013
- },
3014
- position: {
3015
- type: 'integer',
3016
- format: 'int32',
3017
- },
3018
- avgDaysInStage: {
3019
- type: 'number',
3020
- format: 'double',
3021
- },
3022
- samples: {
3023
- type: 'integer',
3024
- format: 'int64',
3025
- description: 'Completed stays measured',
3026
- },
3027
- },
3028
- required: [
3029
- 'avgDaysInStage',
3030
- 'boardId',
3031
- 'boardName',
3032
- 'position',
3033
- 'samples',
3034
- 'stageId',
3035
- 'stageName',
3036
- ],
3037
- };
3038
- export const StatsEnvelopeTaskVelocityStatsSchema = {
3039
- type: 'object',
3040
- properties: {
3041
- period: {
3042
- type: 'string',
2934
+ $ref: '#/components/schemas/Bucket',
3043
2935
  },
3044
- computedAt: {
3045
- type: 'string',
3046
- format: 'date-time',
3047
- },
3048
- data: {
3049
- $ref: '#/components/schemas/TaskVelocityStats',
2936
+ pending: {
2937
+ $ref: '#/components/schemas/Bucket',
3050
2938
  },
3051
- },
3052
- required: ['computedAt', 'data', 'period'],
3053
- };
3054
- export const TaskVelocityStatsSchema = {
3055
- type: 'object',
3056
- properties: {
3057
- stages: {
3058
- type: 'array',
3059
- items: {
3060
- $ref: '#/components/schemas/StageVelocity',
3061
- },
2939
+ total: {
2940
+ $ref: '#/components/schemas/Bucket',
3062
2941
  },
3063
2942
  },
3064
- required: ['stages'],
3065
2943
  };
3066
- export const BoardFunnelSchema = {
2944
+ export const ChannelSeriesSchema = {
3067
2945
  type: 'object',
3068
2946
  properties: {
3069
- boardId: {
3070
- type: 'string',
3071
- format: 'uuid',
3072
- },
3073
- name: {
3074
- type: 'string',
3075
- },
3076
- kind: {
2947
+ channel: {
3077
2948
  type: 'string',
2949
+ enum: [
2950
+ 'MY_HOME',
2951
+ 'SS',
2952
+ 'HOME_SPOT',
2953
+ 'AGENCY_MEMBER',
2954
+ 'FACEBOOK',
2955
+ 'INSTAGRAM',
2956
+ 'WHATSAPP',
2957
+ 'UNKNOWN',
2958
+ ],
3078
2959
  },
3079
- stages: {
2960
+ points: {
3080
2961
  type: 'array',
3081
2962
  items: {
3082
- $ref: '#/components/schemas/StageSlice',
2963
+ type: 'integer',
2964
+ format: 'int64',
3083
2965
  },
3084
2966
  },
3085
- },
3086
- required: ['boardId', 'name', 'stages'],
3087
- };
3088
- export const StageSliceSchema = {
3089
- type: 'object',
3090
- properties: {
3091
- stageId: {
3092
- type: 'string',
3093
- format: 'uuid',
3094
- },
3095
- name: {
3096
- type: 'string',
3097
- },
3098
- position: {
3099
- type: 'integer',
3100
- format: 'int32',
3101
- },
3102
- openTasks: {
2967
+ total: {
3103
2968
  type: 'integer',
3104
2969
  format: 'int64',
3105
2970
  },
3106
- openValue: {
3107
- type: 'number',
3108
- },
3109
2971
  },
3110
- required: ['name', 'openTasks', 'openValue', 'position', 'stageId'],
3111
2972
  };
3112
- export const StatsEnvelopeTaskFunnelStatsSchema = {
2973
+ export const ContactAcquisitionResponseSchema = {
3113
2974
  type: 'object',
3114
2975
  properties: {
3115
- period: {
2976
+ from: {
3116
2977
  type: 'string',
2978
+ format: 'date',
3117
2979
  },
3118
- computedAt: {
2980
+ to: {
3119
2981
  type: 'string',
3120
- format: 'date-time',
3121
- },
3122
- data: {
3123
- $ref: '#/components/schemas/TaskFunnelStats',
3124
- },
3125
- },
3126
- required: ['computedAt', 'data', 'period'],
3127
- };
3128
- export const TaskFunnelStatsSchema = {
3129
- type: 'object',
3130
- properties: {
3131
- boards: {
3132
- type: 'array',
3133
- items: {
3134
- $ref: '#/components/schemas/BoardFunnel',
3135
- },
2982
+ format: 'date',
3136
2983
  },
3137
- },
3138
- required: ['boards'],
3139
- };
3140
- export const DealTypePriceSchema = {
3141
- type: 'object',
3142
- properties: {
3143
- listingType: {
2984
+ granularity: {
3144
2985
  type: 'string',
3145
- enum: ['SALE', 'RENT', 'DAILY_RENT', 'PLEDGE'],
2986
+ enum: ['DAY', 'WEEK', 'MONTH'],
3146
2987
  },
3147
2988
  buckets: {
3148
2989
  type: 'array',
3149
2990
  items: {
3150
- $ref: '#/components/schemas/Slice',
3151
- },
3152
- },
3153
- },
3154
- };
3155
- export const LocationCountSchema = {
3156
- type: 'object',
3157
- properties: {
3158
- location: {
3159
- $ref: '#/components/schemas/LocationResponse',
3160
- },
3161
- count: {
3162
- type: 'integer',
3163
- format: 'int64',
3164
- },
3165
- },
3166
- };
3167
- export const SliceSchema = {
3168
- type: 'object',
3169
- properties: {
3170
- key: {
3171
- type: 'string',
3172
- },
3173
- count: {
3174
- type: 'integer',
3175
- format: 'int64',
3176
- },
3177
- },
3178
- required: ['count', 'key'],
3179
- };
3180
- export const StatsEnvelopeSupplyStatsSchema = {
3181
- type: 'object',
3182
- properties: {
3183
- period: {
3184
- type: 'string',
3185
- },
3186
- computedAt: {
3187
- type: 'string',
3188
- format: 'date-time',
3189
- },
3190
- data: {
3191
- $ref: '#/components/schemas/SupplyStats',
3192
- },
3193
- },
3194
- required: ['computedAt', 'data', 'period'],
3195
- };
3196
- export const SupplyStatsSchema = {
3197
- type: 'object',
3198
- properties: {
3199
- activeListings: {
3200
- type: 'integer',
3201
- format: 'int64',
3202
- },
3203
- byListingType: {
3204
- type: 'array',
3205
- items: {
3206
- $ref: '#/components/schemas/Slice',
3207
- },
3208
- },
3209
- byPropertyType: {
3210
- type: 'array',
3211
- items: {
3212
- $ref: '#/components/schemas/Slice',
3213
- },
3214
- },
3215
- priceByDealType: {
3216
- type: 'array',
3217
- items: {
3218
- $ref: '#/components/schemas/DealTypePrice',
2991
+ type: 'string',
2992
+ format: 'date',
3219
2993
  },
3220
2994
  },
3221
- topDistricts: {
2995
+ series: {
3222
2996
  type: 'array',
3223
2997
  items: {
3224
- $ref: '#/components/schemas/LocationCount',
2998
+ $ref: '#/components/schemas/ChannelSeries',
3225
2999
  },
3226
3000
  },
3227
- },
3228
- };
3229
- export const ExpiringAgreementSchema = {
3230
- type: 'object',
3231
- properties: {
3232
- propertyId: {
3233
- type: 'integer',
3234
- format: 'int64',
3235
- },
3236
- externalId: {
3237
- type: 'string',
3238
- format: 'uuid',
3239
- },
3240
- title: {
3241
- type: 'string',
3242
- },
3243
- expiresAt: {
3244
- type: 'string',
3245
- format: 'date',
3246
- },
3247
- },
3248
- };
3249
- export const ExpiringPlatformListingSchema = {
3250
- type: 'object',
3251
- properties: {
3252
- platform: {
3253
- type: 'string',
3254
- enum: ['SS', 'MY_HOME'],
3255
- },
3256
- platformId: {
3001
+ total: {
3257
3002
  type: 'integer',
3258
3003
  format: 'int64',
3259
3004
  },
3260
- propertyTitle: {
3261
- type: 'string',
3262
- },
3263
- expiresAt: {
3264
- type: 'string',
3265
- format: 'date',
3266
- },
3267
- },
3268
- };
3269
- export const ListingTypeAggSchema = {
3270
- type: 'object',
3271
- properties: {
3272
- listingType: {
3273
- type: 'string',
3274
- enum: ['SALE', 'RENT', 'DAILY_RENT', 'PLEDGE'],
3275
- },
3276
- count: {
3277
- type: 'integer',
3278
- format: 'int64',
3279
- },
3280
- pipelineValue: {
3281
- type: 'number',
3282
- },
3283
- estimatedCommission: {
3284
- type: 'number',
3285
- },
3286
- },
3287
- };
3288
- export const PortfolioStatsSchema = {
3289
- type: 'object',
3290
- properties: {
3291
- propertiesByState: {
3292
- type: 'array',
3293
- items: {
3294
- $ref: '#/components/schemas/Slice',
3295
- },
3296
- },
3297
- listings: {
3298
- type: 'array',
3299
- items: {
3300
- $ref: '#/components/schemas/ListingTypeAgg',
3301
- },
3302
- },
3303
- expiringAgreementsCount: {
3304
- type: 'integer',
3305
- format: 'int64',
3306
- },
3307
- expiringAgreements: {
3308
- type: 'array',
3309
- items: {
3310
- $ref: '#/components/schemas/ExpiringAgreement',
3311
- },
3312
- },
3313
- expiringPlatformCount: {
3314
- type: 'integer',
3315
- format: 'int64',
3316
- },
3317
- expiringPlatformListings: {
3318
- type: 'array',
3319
- items: {
3320
- $ref: '#/components/schemas/ExpiringPlatformListing',
3321
- },
3322
- },
3323
- },
3324
- required: [
3325
- 'expiringAgreements',
3326
- 'expiringAgreementsCount',
3327
- 'expiringPlatformCount',
3328
- 'expiringPlatformListings',
3329
- 'listings',
3330
- 'propertiesByState',
3331
- ],
3332
- };
3333
- export const StatsEnvelopePortfolioStatsSchema = {
3334
- type: 'object',
3335
- properties: {
3336
- period: {
3337
- type: 'string',
3338
- },
3339
- computedAt: {
3340
- type: 'string',
3341
- format: 'date-time',
3342
- },
3343
- data: {
3344
- $ref: '#/components/schemas/PortfolioStats',
3345
- },
3346
- },
3347
- required: ['computedAt', 'data', 'period'],
3348
- };
3349
- export const PipelineStatsSchema = {
3350
- type: 'object',
3351
- properties: {
3352
- total: {
3353
- type: 'integer',
3354
- format: 'int64',
3355
- },
3356
- unassigned: {
3357
- type: 'integer',
3358
- format: 'int64',
3359
- },
3360
- newContactsTrend: {
3361
- type: 'array',
3362
- items: {
3363
- $ref: '#/components/schemas/TrendPoint',
3364
- },
3365
- },
3366
- sourceAttribution: {
3367
- type: 'array',
3368
- items: {
3369
- $ref: '#/components/schemas/Slice',
3370
- },
3371
- },
3372
- },
3373
- required: ['newContactsTrend', 'sourceAttribution', 'total', 'unassigned'],
3374
- };
3375
- export const StatsEnvelopePipelineStatsSchema = {
3376
- type: 'object',
3377
- properties: {
3378
- period: {
3379
- type: 'string',
3380
- },
3381
- computedAt: {
3382
- type: 'string',
3383
- format: 'date-time',
3384
- },
3385
- data: {
3386
- $ref: '#/components/schemas/PipelineStats',
3387
- },
3388
- },
3389
- required: ['computedAt', 'data', 'period'],
3390
- };
3391
- export const TrendPointSchema = {
3392
- type: 'object',
3393
- properties: {
3394
- date: {
3395
- type: 'string',
3396
- format: 'date',
3397
- },
3398
- count: {
3399
- type: 'integer',
3400
- format: 'int64',
3401
- },
3402
- },
3403
- };
3404
- export const LeaderboardStatsSchema = {
3405
- type: 'object',
3406
- properties: {
3407
- rows: {
3408
- type: 'array',
3409
- items: {
3410
- $ref: '#/components/schemas/Row',
3411
- },
3412
- },
3413
- },
3414
- required: ['rows'],
3415
- };
3416
- export const RowSchema = {
3417
- type: 'object',
3418
- properties: {
3419
- memberId: {
3420
- type: 'string',
3421
- format: 'uuid',
3422
- },
3423
- firstName: {
3424
- type: 'string',
3425
- },
3426
- lastName: {
3427
- type: 'string',
3428
- },
3429
- photo: {
3430
- type: 'string',
3431
- },
3432
- tasksWon: {
3433
- type: 'integer',
3434
- format: 'int64',
3435
- },
3436
- wonValue: {
3437
- type: 'number',
3438
- },
3439
- commission: {
3440
- type: 'number',
3441
- description: 'Fixed amount, or rate/factor × task value (null-value tasks skipped)',
3442
- },
3443
- recommendationsSent: {
3444
- type: 'integer',
3445
- format: 'int64',
3446
- },
3447
- recommendationsRated: {
3448
- type: 'integer',
3449
- format: 'int64',
3450
- },
3451
- likeRatePct: {
3452
- type: 'number',
3453
- format: 'double',
3454
- },
3455
- },
3456
- required: [
3457
- 'commission',
3458
- 'firstName',
3459
- 'lastName',
3460
- 'likeRatePct',
3461
- 'memberId',
3462
- 'photo',
3463
- 'recommendationsRated',
3464
- 'recommendationsSent',
3465
- 'tasksWon',
3466
- 'wonValue',
3467
- ],
3468
- };
3469
- export const StatsEnvelopeLeaderboardStatsSchema = {
3470
- type: 'object',
3471
- properties: {
3472
- period: {
3473
- type: 'string',
3474
- },
3475
- computedAt: {
3476
- type: 'string',
3477
- format: 'date-time',
3478
- },
3479
- data: {
3480
- $ref: '#/components/schemas/LeaderboardStats',
3481
- },
3482
- },
3483
- required: ['computedAt', 'data', 'period'],
3484
- };
3485
- export const AwaitingConversationSchema = {
3486
- type: 'object',
3487
- properties: {
3488
- conversationId: {
3489
- type: 'string',
3490
- format: 'uuid',
3491
- },
3492
- contactId: {
3493
- type: 'integer',
3494
- format: 'int64',
3495
- },
3496
- firstName: {
3497
- type: 'string',
3498
- },
3499
- lastName: {
3500
- type: 'string',
3501
- },
3502
- channelType: {
3503
- type: 'string',
3504
- enum: ['FACEBOOK', 'INSTAGRAM', 'WHATSAPP'],
3505
- },
3506
- lastMessagePreview: {
3507
- type: 'string',
3508
- },
3509
- lastInboundAt: {
3510
- type: 'string',
3511
- format: 'date-time',
3512
- },
3513
- unreadCount: {
3514
- type: 'integer',
3515
- format: 'int32',
3516
- },
3517
- reachable: {
3518
- type: 'boolean',
3519
- },
3520
- },
3521
- required: [
3522
- 'channelType',
3523
- 'contactId',
3524
- 'conversationId',
3525
- 'lastInboundAt',
3526
- 'lastMessagePreview',
3527
- 'reachable',
3528
- 'unreadCount',
3529
- ],
3530
- };
3531
- export const InboxStatsSchema = {
3532
- type: 'object',
3533
- properties: {
3534
- openConversations: {
3535
- type: 'integer',
3536
- format: 'int64',
3537
- },
3538
- unreadMessages: {
3539
- type: 'integer',
3540
- format: 'int64',
3541
- },
3542
- newConversations: {
3543
- type: 'integer',
3544
- format: 'int64',
3545
- },
3546
- awaitingReplyCount: {
3547
- type: 'integer',
3548
- format: 'int64',
3549
- },
3550
- awaitingUnreachableCount: {
3551
- type: 'integer',
3552
- format: 'int64',
3553
- },
3554
- awaitingReply: {
3555
- type: 'array',
3556
- items: {
3557
- $ref: '#/components/schemas/AwaitingConversation',
3558
- },
3559
- },
3560
- medianResponseSeconds: {
3561
- type: 'integer',
3562
- format: 'int64',
3563
- },
3564
- inboundByChannel: {
3565
- type: 'array',
3566
- items: {
3567
- $ref: '#/components/schemas/Slice',
3568
- },
3569
- },
3570
- },
3571
- required: [
3572
- 'awaitingReply',
3573
- 'awaitingReplyCount',
3574
- 'awaitingUnreachableCount',
3575
- 'inboundByChannel',
3576
- 'medianResponseSeconds',
3577
- 'newConversations',
3578
- 'openConversations',
3579
- 'unreadMessages',
3580
- ],
3581
- };
3582
- export const StatsEnvelopeInboxStatsSchema = {
3583
- type: 'object',
3584
- properties: {
3585
- period: {
3586
- type: 'string',
3587
- },
3588
- computedAt: {
3589
- type: 'string',
3590
- format: 'date-time',
3591
- },
3592
- data: {
3593
- $ref: '#/components/schemas/InboxStats',
3594
- },
3595
- },
3596
- required: ['computedAt', 'data', 'period'],
3597
- };
3598
- export const DealTypeBudgetSchema = {
3599
- type: 'object',
3600
- properties: {
3601
- listingType: {
3602
- type: 'string',
3603
- enum: ['SALE', 'RENT', 'DAILY_RENT', 'PLEDGE'],
3604
- },
3605
- buckets: {
3606
- type: 'array',
3607
- items: {
3608
- $ref: '#/components/schemas/Slice',
3609
- },
3610
- },
3611
- },
3612
- };
3613
- export const DemandStatsSchema = {
3614
- type: 'object',
3615
- properties: {
3616
- activeInterests: {
3617
- type: 'integer',
3618
- format: 'int64',
3619
- },
3620
- byListingType: {
3621
- type: 'array',
3622
- items: {
3623
- $ref: '#/components/schemas/Slice',
3624
- },
3625
- },
3626
- byPropertyType: {
3627
- type: 'array',
3628
- items: {
3629
- $ref: '#/components/schemas/Slice',
3630
- },
3631
- },
3632
- budgetByDealType: {
3633
- type: 'array',
3634
- items: {
3635
- $ref: '#/components/schemas/DealTypeBudget',
3636
- },
3637
- },
3638
- topDistricts: {
3639
- type: 'array',
3640
- items: {
3641
- $ref: '#/components/schemas/LocationCount',
3642
- },
3643
- },
3644
- },
3645
- };
3646
- export const StatsEnvelopeDemandStatsSchema = {
3647
- type: 'object',
3648
- properties: {
3649
- period: {
3650
- type: 'string',
3651
- },
3652
- computedAt: {
3653
- type: 'string',
3654
- format: 'date-time',
3655
- },
3656
- data: {
3657
- $ref: '#/components/schemas/DemandStats',
3658
- },
3659
3005
  },
3660
- required: ['computedAt', 'data', 'period'],
3661
3006
  };
3662
3007
  export const PageMetadataSchema = {
3663
3008
  type: 'object',