@workbuddy/cli-vnext 1.0.13 → 1.0.14
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/dist/index.js +407 -3
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -3250,6 +3250,15 @@ var operations = [
|
|
|
3250
3250
|
required: false,
|
|
3251
3251
|
description: "integration ID"
|
|
3252
3252
|
},
|
|
3253
|
+
{
|
|
3254
|
+
name: "jobNumber",
|
|
3255
|
+
cliName: "job-number",
|
|
3256
|
+
optionKey: "jobNumber",
|
|
3257
|
+
source: "body",
|
|
3258
|
+
type: "string",
|
|
3259
|
+
required: false,
|
|
3260
|
+
description: ""
|
|
3261
|
+
},
|
|
3253
3262
|
{
|
|
3254
3263
|
name: "description",
|
|
3255
3264
|
cliName: "description",
|
|
@@ -3413,15 +3422,410 @@ var operations = [
|
|
|
3413
3422
|
required: false,
|
|
3414
3423
|
description: "Customer purchase order reference"
|
|
3415
3424
|
},
|
|
3425
|
+
{
|
|
3426
|
+
name: "startDate",
|
|
3427
|
+
cliName: "start-date",
|
|
3428
|
+
optionKey: "startDate",
|
|
3429
|
+
source: "body",
|
|
3430
|
+
type: "string",
|
|
3431
|
+
required: false,
|
|
3432
|
+
description: "Start date (ISO 8601 datetime)",
|
|
3433
|
+
format: "date-time"
|
|
3434
|
+
},
|
|
3435
|
+
{
|
|
3436
|
+
name: "dueDate",
|
|
3437
|
+
cliName: "due-date",
|
|
3438
|
+
optionKey: "dueDate",
|
|
3439
|
+
source: "body",
|
|
3440
|
+
type: "string",
|
|
3441
|
+
required: false,
|
|
3442
|
+
description: "Due date (ISO 8601 datetime)",
|
|
3443
|
+
format: "date-time"
|
|
3444
|
+
},
|
|
3445
|
+
{
|
|
3446
|
+
name: "customFields",
|
|
3447
|
+
cliName: "custom-fields",
|
|
3448
|
+
optionKey: "customFields",
|
|
3449
|
+
source: "body",
|
|
3450
|
+
type: "object",
|
|
3451
|
+
required: false,
|
|
3452
|
+
description: "Custom fields as key-value pairs — validated against tenant field definitions"
|
|
3453
|
+
},
|
|
3454
|
+
{
|
|
3455
|
+
name: "items",
|
|
3456
|
+
cliName: "items",
|
|
3457
|
+
optionKey: "items",
|
|
3458
|
+
source: "body",
|
|
3459
|
+
type: "array",
|
|
3460
|
+
required: false,
|
|
3461
|
+
description: ""
|
|
3462
|
+
},
|
|
3463
|
+
{
|
|
3464
|
+
name: "raw-body",
|
|
3465
|
+
cliName: "raw-body",
|
|
3466
|
+
optionKey: "rawBody",
|
|
3467
|
+
source: "body",
|
|
3468
|
+
type: "object",
|
|
3469
|
+
required: false,
|
|
3470
|
+
description: "Raw request body JSON (overrides individual fields)"
|
|
3471
|
+
}
|
|
3472
|
+
],
|
|
3473
|
+
hasRequestBody: true,
|
|
3474
|
+
responseFields: [
|
|
3475
|
+
{
|
|
3476
|
+
name: "id",
|
|
3477
|
+
type: "string",
|
|
3478
|
+
description: "Entity ID"
|
|
3479
|
+
},
|
|
3480
|
+
{
|
|
3481
|
+
name: "integrationId",
|
|
3482
|
+
type: "string",
|
|
3483
|
+
description: "integration ID"
|
|
3484
|
+
},
|
|
3485
|
+
{
|
|
3486
|
+
name: "jobNumber",
|
|
3487
|
+
type: "string"
|
|
3488
|
+
},
|
|
3489
|
+
{
|
|
3490
|
+
name: "name",
|
|
3491
|
+
type: "string",
|
|
3492
|
+
description: "Display name"
|
|
3493
|
+
},
|
|
3494
|
+
{
|
|
3495
|
+
name: "description",
|
|
3496
|
+
type: "string",
|
|
3497
|
+
description: "Detailed description"
|
|
3498
|
+
},
|
|
3499
|
+
{
|
|
3500
|
+
name: "status",
|
|
3501
|
+
type: "object",
|
|
3502
|
+
description: "Status filter"
|
|
3503
|
+
},
|
|
3504
|
+
{
|
|
3505
|
+
name: "customer",
|
|
3506
|
+
type: "object",
|
|
3507
|
+
description: "Inline customer object — alternative to customerId"
|
|
3508
|
+
},
|
|
3509
|
+
{
|
|
3510
|
+
name: "site",
|
|
3511
|
+
type: "string",
|
|
3512
|
+
description: "Inline site object — alternative to siteId"
|
|
3513
|
+
},
|
|
3514
|
+
{
|
|
3515
|
+
name: "contact",
|
|
3516
|
+
type: "string",
|
|
3517
|
+
description: "Inline contact object — alternative to contactId"
|
|
3518
|
+
},
|
|
3519
|
+
{
|
|
3520
|
+
name: "customerSupervisor",
|
|
3521
|
+
type: "string"
|
|
3522
|
+
},
|
|
3523
|
+
{
|
|
3524
|
+
name: "type",
|
|
3525
|
+
type: "string"
|
|
3526
|
+
},
|
|
3527
|
+
{
|
|
3528
|
+
name: "priority",
|
|
3529
|
+
type: "string"
|
|
3530
|
+
},
|
|
3531
|
+
{
|
|
3532
|
+
name: "owner",
|
|
3533
|
+
type: "string"
|
|
3534
|
+
},
|
|
3535
|
+
{
|
|
3536
|
+
name: "fieldSupervisor",
|
|
3537
|
+
type: "string"
|
|
3538
|
+
},
|
|
3539
|
+
{
|
|
3540
|
+
name: "zones",
|
|
3541
|
+
type: "array"
|
|
3542
|
+
},
|
|
3543
|
+
{
|
|
3544
|
+
name: "tags",
|
|
3545
|
+
type: "array",
|
|
3546
|
+
description: "Tag operation — use set, add, or remove (mutually exclusive: set vs add/remove)"
|
|
3547
|
+
},
|
|
3548
|
+
{
|
|
3549
|
+
name: "systemTags",
|
|
3550
|
+
type: "array"
|
|
3551
|
+
},
|
|
3552
|
+
{
|
|
3553
|
+
name: "notes",
|
|
3554
|
+
type: "string",
|
|
3555
|
+
description: "Additional notes or comments"
|
|
3556
|
+
},
|
|
3557
|
+
{
|
|
3558
|
+
name: "reference",
|
|
3559
|
+
type: "string",
|
|
3560
|
+
description: "External reference number"
|
|
3561
|
+
},
|
|
3562
|
+
{
|
|
3563
|
+
name: "customerWO",
|
|
3564
|
+
type: "string",
|
|
3565
|
+
description: "Customer work order reference"
|
|
3566
|
+
},
|
|
3567
|
+
{
|
|
3568
|
+
name: "customerPO",
|
|
3569
|
+
type: "string",
|
|
3570
|
+
description: "Customer purchase order reference"
|
|
3571
|
+
},
|
|
3572
|
+
{
|
|
3573
|
+
name: "priceBook",
|
|
3574
|
+
type: "string"
|
|
3575
|
+
},
|
|
3576
|
+
{
|
|
3577
|
+
name: "billingCompany",
|
|
3578
|
+
type: "string"
|
|
3579
|
+
},
|
|
3580
|
+
{
|
|
3581
|
+
name: "policy",
|
|
3582
|
+
type: "string"
|
|
3583
|
+
},
|
|
3584
|
+
{
|
|
3585
|
+
name: "thresholds",
|
|
3586
|
+
type: "string"
|
|
3587
|
+
},
|
|
3588
|
+
{
|
|
3589
|
+
name: "stages",
|
|
3590
|
+
type: "array"
|
|
3591
|
+
},
|
|
3592
|
+
{
|
|
3593
|
+
name: "totals",
|
|
3594
|
+
type: "object"
|
|
3595
|
+
},
|
|
3596
|
+
{
|
|
3597
|
+
name: "customFields",
|
|
3598
|
+
type: "string",
|
|
3599
|
+
description: "Custom fields as key-value pairs — validated against tenant field definitions"
|
|
3600
|
+
},
|
|
3601
|
+
{
|
|
3602
|
+
name: "dueDate",
|
|
3603
|
+
type: "string",
|
|
3604
|
+
description: "Due date (ISO 8601 datetime)"
|
|
3605
|
+
},
|
|
3606
|
+
{
|
|
3607
|
+
name: "startDate",
|
|
3608
|
+
type: "string",
|
|
3609
|
+
description: "Start date (ISO 8601 datetime)"
|
|
3610
|
+
},
|
|
3611
|
+
{
|
|
3612
|
+
name: "createdAt",
|
|
3613
|
+
type: "string"
|
|
3614
|
+
},
|
|
3615
|
+
{
|
|
3616
|
+
name: "updatedAt",
|
|
3617
|
+
type: "string",
|
|
3618
|
+
description: "For optimistic concurrency — update fails if entity was modified after this timestamp"
|
|
3619
|
+
}
|
|
3620
|
+
]
|
|
3621
|
+
},
|
|
3622
|
+
{
|
|
3623
|
+
operationId: "PublicApiJobController_createFromTemplate",
|
|
3624
|
+
displayName: "Create a new job from template",
|
|
3625
|
+
description: "Create a job using a job template. Template-owned fields win over request values before final job validation.",
|
|
3626
|
+
method: "POST",
|
|
3627
|
+
path: "/jobs/template/{templateId}",
|
|
3628
|
+
commandPath: ["jobs", "create-from-template"],
|
|
3629
|
+
options: [
|
|
3416
3630
|
{
|
|
3417
3631
|
name: "templateId",
|
|
3418
3632
|
cliName: "template-id",
|
|
3419
3633
|
optionKey: "templateId",
|
|
3634
|
+
source: "path",
|
|
3635
|
+
type: "string",
|
|
3636
|
+
required: true,
|
|
3637
|
+
description: "Job template ID",
|
|
3638
|
+
lookupEndpoint: "/settings/templates"
|
|
3639
|
+
},
|
|
3640
|
+
{
|
|
3641
|
+
name: "name",
|
|
3642
|
+
cliName: "name",
|
|
3643
|
+
optionKey: "name",
|
|
3420
3644
|
source: "body",
|
|
3421
3645
|
type: "string",
|
|
3422
3646
|
required: false,
|
|
3423
|
-
description: "
|
|
3424
|
-
|
|
3647
|
+
description: "Display name"
|
|
3648
|
+
},
|
|
3649
|
+
{
|
|
3650
|
+
name: "integrationId",
|
|
3651
|
+
cliName: "integration-id",
|
|
3652
|
+
optionKey: "integrationId",
|
|
3653
|
+
source: "body",
|
|
3654
|
+
type: "string",
|
|
3655
|
+
required: false,
|
|
3656
|
+
description: "integration ID"
|
|
3657
|
+
},
|
|
3658
|
+
{
|
|
3659
|
+
name: "jobNumber",
|
|
3660
|
+
cliName: "job-number",
|
|
3661
|
+
optionKey: "jobNumber",
|
|
3662
|
+
source: "body",
|
|
3663
|
+
type: "string",
|
|
3664
|
+
required: false,
|
|
3665
|
+
description: ""
|
|
3666
|
+
},
|
|
3667
|
+
{
|
|
3668
|
+
name: "description",
|
|
3669
|
+
cliName: "description",
|
|
3670
|
+
optionKey: "description",
|
|
3671
|
+
source: "body",
|
|
3672
|
+
type: "string",
|
|
3673
|
+
required: false,
|
|
3674
|
+
description: "Detailed description"
|
|
3675
|
+
},
|
|
3676
|
+
{
|
|
3677
|
+
name: "customerId",
|
|
3678
|
+
cliName: "customer-id",
|
|
3679
|
+
optionKey: "customerId",
|
|
3680
|
+
source: "body",
|
|
3681
|
+
type: "string",
|
|
3682
|
+
required: true,
|
|
3683
|
+
description: "Customer ID — use /crm/customers to look up",
|
|
3684
|
+
lookupEndpoint: "/crm/customers"
|
|
3685
|
+
},
|
|
3686
|
+
{
|
|
3687
|
+
name: "siteId",
|
|
3688
|
+
cliName: "site-id",
|
|
3689
|
+
optionKey: "siteId",
|
|
3690
|
+
source: "body",
|
|
3691
|
+
type: "string",
|
|
3692
|
+
required: false,
|
|
3693
|
+
description: "Site ID — use /crm/sites to look up",
|
|
3694
|
+
lookupEndpoint: "/crm/sites"
|
|
3695
|
+
},
|
|
3696
|
+
{
|
|
3697
|
+
name: "site",
|
|
3698
|
+
cliName: "site",
|
|
3699
|
+
optionKey: "site",
|
|
3700
|
+
source: "body",
|
|
3701
|
+
type: "object",
|
|
3702
|
+
required: false,
|
|
3703
|
+
description: "Inline site object — alternative to siteId"
|
|
3704
|
+
},
|
|
3705
|
+
{
|
|
3706
|
+
name: "contactId",
|
|
3707
|
+
cliName: "contact-id",
|
|
3708
|
+
optionKey: "contactId",
|
|
3709
|
+
source: "body",
|
|
3710
|
+
type: "string",
|
|
3711
|
+
required: false,
|
|
3712
|
+
description: "Contact ID — use /crm/contacts to look up",
|
|
3713
|
+
lookupEndpoint: "/crm/contacts"
|
|
3714
|
+
},
|
|
3715
|
+
{
|
|
3716
|
+
name: "contact",
|
|
3717
|
+
cliName: "contact",
|
|
3718
|
+
optionKey: "contact",
|
|
3719
|
+
source: "body",
|
|
3720
|
+
type: "object",
|
|
3721
|
+
required: false,
|
|
3722
|
+
description: "Inline contact object — alternative to contactId"
|
|
3723
|
+
},
|
|
3724
|
+
{
|
|
3725
|
+
name: "typeId",
|
|
3726
|
+
cliName: "type-id",
|
|
3727
|
+
optionKey: "typeId",
|
|
3728
|
+
source: "body",
|
|
3729
|
+
type: "string",
|
|
3730
|
+
required: false,
|
|
3731
|
+
description: "Job type ID — use /settings/job-types to look up",
|
|
3732
|
+
lookupEndpoint: "/settings/job-types"
|
|
3733
|
+
},
|
|
3734
|
+
{
|
|
3735
|
+
name: "priorityId",
|
|
3736
|
+
cliName: "priority-id",
|
|
3737
|
+
optionKey: "priorityId",
|
|
3738
|
+
source: "body",
|
|
3739
|
+
type: "string",
|
|
3740
|
+
required: false,
|
|
3741
|
+
description: "Priority ID — use /settings/priorities to look up",
|
|
3742
|
+
lookupEndpoint: "/settings/priorities"
|
|
3743
|
+
},
|
|
3744
|
+
{
|
|
3745
|
+
name: "priceBookId",
|
|
3746
|
+
cliName: "price-book-id",
|
|
3747
|
+
optionKey: "priceBookId",
|
|
3748
|
+
source: "body",
|
|
3749
|
+
type: "string",
|
|
3750
|
+
required: false,
|
|
3751
|
+
description: "Price book ID for job pricing",
|
|
3752
|
+
lookupEndpoint: "/settings/price-books"
|
|
3753
|
+
},
|
|
3754
|
+
{
|
|
3755
|
+
name: "ownerId",
|
|
3756
|
+
cliName: "owner-id",
|
|
3757
|
+
optionKey: "ownerId",
|
|
3758
|
+
source: "body",
|
|
3759
|
+
type: "string",
|
|
3760
|
+
required: false,
|
|
3761
|
+
description: "Owner (employee) ID — use /crm/employees to look up",
|
|
3762
|
+
lookupEndpoint: "/crm/employees"
|
|
3763
|
+
},
|
|
3764
|
+
{
|
|
3765
|
+
name: "fieldSupervisorId",
|
|
3766
|
+
cliName: "field-supervisor-id",
|
|
3767
|
+
optionKey: "fieldSupervisorId",
|
|
3768
|
+
source: "body",
|
|
3769
|
+
type: "string",
|
|
3770
|
+
required: false,
|
|
3771
|
+
description: "Field supervisor (employee) ID — use /crm/employees to look up",
|
|
3772
|
+
lookupEndpoint: "/crm/employees"
|
|
3773
|
+
},
|
|
3774
|
+
{
|
|
3775
|
+
name: "zoneId",
|
|
3776
|
+
cliName: "zone-id",
|
|
3777
|
+
optionKey: "zoneId",
|
|
3778
|
+
source: "body",
|
|
3779
|
+
type: "string",
|
|
3780
|
+
required: false,
|
|
3781
|
+
description: "Zone ID — use /settings/zones to look up",
|
|
3782
|
+
lookupEndpoint: "/settings/zones"
|
|
3783
|
+
},
|
|
3784
|
+
{
|
|
3785
|
+
name: "tagIds",
|
|
3786
|
+
cliName: "tag-ids",
|
|
3787
|
+
optionKey: "tagIds",
|
|
3788
|
+
source: "body",
|
|
3789
|
+
type: "array",
|
|
3790
|
+
required: false,
|
|
3791
|
+
description: 'Array of tag IDs (comma-separated, e.g. "id1,id2") — use /settings/tags to look up',
|
|
3792
|
+
lookupEndpoint: "/settings/tags"
|
|
3793
|
+
},
|
|
3794
|
+
{
|
|
3795
|
+
name: "notes",
|
|
3796
|
+
cliName: "notes",
|
|
3797
|
+
optionKey: "notes",
|
|
3798
|
+
source: "body",
|
|
3799
|
+
type: "string",
|
|
3800
|
+
required: false,
|
|
3801
|
+
description: "Additional notes or comments"
|
|
3802
|
+
},
|
|
3803
|
+
{
|
|
3804
|
+
name: "reference",
|
|
3805
|
+
cliName: "reference",
|
|
3806
|
+
optionKey: "reference",
|
|
3807
|
+
source: "body",
|
|
3808
|
+
type: "string",
|
|
3809
|
+
required: false,
|
|
3810
|
+
description: "External reference number"
|
|
3811
|
+
},
|
|
3812
|
+
{
|
|
3813
|
+
name: "customerWO",
|
|
3814
|
+
cliName: "customer-wo",
|
|
3815
|
+
optionKey: "customerWo",
|
|
3816
|
+
source: "body",
|
|
3817
|
+
type: "string",
|
|
3818
|
+
required: false,
|
|
3819
|
+
description: "Customer work order reference"
|
|
3820
|
+
},
|
|
3821
|
+
{
|
|
3822
|
+
name: "customerPO",
|
|
3823
|
+
cliName: "customer-po",
|
|
3824
|
+
optionKey: "customerPo",
|
|
3825
|
+
source: "body",
|
|
3826
|
+
type: "string",
|
|
3827
|
+
required: false,
|
|
3828
|
+
description: "Customer purchase order reference"
|
|
3425
3829
|
},
|
|
3426
3830
|
{
|
|
3427
3831
|
name: "startDate",
|
|
@@ -7698,7 +8102,7 @@ var operations = [
|
|
|
7698
8102
|
{
|
|
7699
8103
|
operationId: "PublicApiItemController_getById",
|
|
7700
8104
|
displayName: "Get item",
|
|
7701
|
-
description: "Retrieve a settings item by ID.",
|
|
8105
|
+
description: "Retrieve a settings item by ID, name, or integration ID.",
|
|
7702
8106
|
method: "GET",
|
|
7703
8107
|
path: "/settings/items/{id}",
|
|
7704
8108
|
commandPath: ["settings", "items", "get"],
|