pgbeam 0.3.13 → 0.3.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.cjs +265 -0
- package/dist/index.d.cts +5495 -1786
- package/dist/index.d.mts +5495 -1786
- package/dist/index.mjs +265 -0
- package/dist/operations.cjs +1048 -0
- package/dist/operations.d.cts +2945 -41
- package/dist/operations.d.mts +2945 -41
- package/dist/operations.mjs +1048 -0
- package/package.json +1 -1
package/dist/operations.d.mts
CHANGED
|
@@ -3406,6 +3406,2121 @@ type UpdateCacheRuleRequestConfig = {
|
|
|
3406
3406
|
url: `/v1/projects/${string}/databases/${string}/cache-rules/${string}`;
|
|
3407
3407
|
};
|
|
3408
3408
|
|
|
3409
|
+
/**
|
|
3410
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
3411
|
+
* Do not edit manually.
|
|
3412
|
+
*/
|
|
3413
|
+
/**
|
|
3414
|
+
* @description A company (customer, prospect, or partner) tracked in the CRM.
|
|
3415
|
+
* @type object
|
|
3416
|
+
*/
|
|
3417
|
+
type Company = {
|
|
3418
|
+
/**
|
|
3419
|
+
* @description Unique company identifier.
|
|
3420
|
+
* @example cmp_01j9x8y7z6w5v4u3t2s1r0q9p8
|
|
3421
|
+
* @type string
|
|
3422
|
+
*/
|
|
3423
|
+
id: string;
|
|
3424
|
+
/**
|
|
3425
|
+
* @description Organization the company belongs to.
|
|
3426
|
+
* @example org_abc123
|
|
3427
|
+
* @type string
|
|
3428
|
+
*/
|
|
3429
|
+
org_id: string;
|
|
3430
|
+
/**
|
|
3431
|
+
* @description Company name.
|
|
3432
|
+
* @example Acme Corp
|
|
3433
|
+
* @type string
|
|
3434
|
+
*/
|
|
3435
|
+
name: string;
|
|
3436
|
+
/**
|
|
3437
|
+
* @description Primary web domain, normalized to lowercase.
|
|
3438
|
+
* @example acme.com
|
|
3439
|
+
* @type string
|
|
3440
|
+
*/
|
|
3441
|
+
domain?: string | null;
|
|
3442
|
+
/**
|
|
3443
|
+
* @description Industry or sector the company operates in.
|
|
3444
|
+
* @example Software
|
|
3445
|
+
* @type string
|
|
3446
|
+
*/
|
|
3447
|
+
industry?: string | null;
|
|
3448
|
+
/**
|
|
3449
|
+
* @description Primary location (city, region, or country).
|
|
3450
|
+
* @example San Francisco, CA
|
|
3451
|
+
* @type string
|
|
3452
|
+
*/
|
|
3453
|
+
location?: string | null;
|
|
3454
|
+
/**
|
|
3455
|
+
* @description URL of the company logo.
|
|
3456
|
+
* @type string
|
|
3457
|
+
*/
|
|
3458
|
+
logo_url?: string | null;
|
|
3459
|
+
/**
|
|
3460
|
+
* @description Free-form description or research notes.
|
|
3461
|
+
* @type string
|
|
3462
|
+
*/
|
|
3463
|
+
description: string;
|
|
3464
|
+
/**
|
|
3465
|
+
* @description When the company was created.
|
|
3466
|
+
* @type string
|
|
3467
|
+
*/
|
|
3468
|
+
created_at: string;
|
|
3469
|
+
/**
|
|
3470
|
+
* @description When the company was last updated.
|
|
3471
|
+
* @type string
|
|
3472
|
+
*/
|
|
3473
|
+
updated_at: string;
|
|
3474
|
+
};
|
|
3475
|
+
|
|
3476
|
+
/**
|
|
3477
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
3478
|
+
* Do not edit manually.
|
|
3479
|
+
*/
|
|
3480
|
+
|
|
3481
|
+
/**
|
|
3482
|
+
* @description Cursor-paginated companies for an organization.
|
|
3483
|
+
* @type object
|
|
3484
|
+
*/
|
|
3485
|
+
type ListCompaniesResponse = {
|
|
3486
|
+
/**
|
|
3487
|
+
* @description Companies returned for the current page.
|
|
3488
|
+
* @type array
|
|
3489
|
+
*/
|
|
3490
|
+
companies: Company[];
|
|
3491
|
+
/**
|
|
3492
|
+
* @description Opaque token for cursor-based pagination.
|
|
3493
|
+
* @type string | undefined
|
|
3494
|
+
*/
|
|
3495
|
+
next_page_token?: string;
|
|
3496
|
+
};
|
|
3497
|
+
|
|
3498
|
+
/**
|
|
3499
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
3500
|
+
* Do not edit manually.
|
|
3501
|
+
*/
|
|
3502
|
+
|
|
3503
|
+
/**
|
|
3504
|
+
* @description Unique organization identifier.
|
|
3505
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
3506
|
+
* @example org_abc123
|
|
3507
|
+
* @type string
|
|
3508
|
+
*/
|
|
3509
|
+
type ListCrmCompaniesPathOrgId = string;
|
|
3510
|
+
/**
|
|
3511
|
+
* @description Maximum number of items to return (1-100, default 20).
|
|
3512
|
+
* @minLength 1
|
|
3513
|
+
* @maxLength 100
|
|
3514
|
+
* @default 20
|
|
3515
|
+
* @type integer | undefined
|
|
3516
|
+
*/
|
|
3517
|
+
type ListCrmCompaniesQueryPageSize = number | undefined;
|
|
3518
|
+
/**
|
|
3519
|
+
* @description Opaque token for cursor-based pagination.
|
|
3520
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
3521
|
+
* @type string | undefined
|
|
3522
|
+
*/
|
|
3523
|
+
type ListCrmCompaniesQueryPageToken = string | undefined;
|
|
3524
|
+
/**
|
|
3525
|
+
* @description Cursor-paginated companies for an organization.
|
|
3526
|
+
* @type object
|
|
3527
|
+
*/
|
|
3528
|
+
type ListCrmCompaniesStatus200 = ListCompaniesResponse;
|
|
3529
|
+
/**
|
|
3530
|
+
* @type object
|
|
3531
|
+
*/
|
|
3532
|
+
type ListCrmCompaniesRequestConfig = {
|
|
3533
|
+
data?: never;
|
|
3534
|
+
/**
|
|
3535
|
+
* @type object
|
|
3536
|
+
*/
|
|
3537
|
+
pathParams: {
|
|
3538
|
+
org_id: ListCrmCompaniesPathOrgId;
|
|
3539
|
+
};
|
|
3540
|
+
/**
|
|
3541
|
+
* @type object | undefined
|
|
3542
|
+
*/
|
|
3543
|
+
queryParams?: {
|
|
3544
|
+
page_size?: ListCrmCompaniesQueryPageSize;
|
|
3545
|
+
page_token?: ListCrmCompaniesQueryPageToken;
|
|
3546
|
+
};
|
|
3547
|
+
headerParams?: never;
|
|
3548
|
+
/**
|
|
3549
|
+
* @type string
|
|
3550
|
+
*/
|
|
3551
|
+
url: `/v1/organizations/${string}/crm/companies`;
|
|
3552
|
+
};
|
|
3553
|
+
|
|
3554
|
+
/**
|
|
3555
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
3556
|
+
* Do not edit manually.
|
|
3557
|
+
*/
|
|
3558
|
+
/**
|
|
3559
|
+
* @description Request body for creating or updating a company.
|
|
3560
|
+
* @type object
|
|
3561
|
+
*/
|
|
3562
|
+
type CompanyInput = {
|
|
3563
|
+
/**
|
|
3564
|
+
* @description Company name.
|
|
3565
|
+
* @minLength 1
|
|
3566
|
+
* @maxLength 255
|
|
3567
|
+
* @example Acme Corp
|
|
3568
|
+
* @type string
|
|
3569
|
+
*/
|
|
3570
|
+
name: string;
|
|
3571
|
+
/**
|
|
3572
|
+
* @description Primary web domain.
|
|
3573
|
+
* @maxLength 255
|
|
3574
|
+
* @example acme.com
|
|
3575
|
+
* @type string
|
|
3576
|
+
*/
|
|
3577
|
+
domain?: string | null;
|
|
3578
|
+
/**
|
|
3579
|
+
* @description Industry or sector.
|
|
3580
|
+
* @maxLength 255
|
|
3581
|
+
* @type string
|
|
3582
|
+
*/
|
|
3583
|
+
industry?: string | null;
|
|
3584
|
+
/**
|
|
3585
|
+
* @description Primary location.
|
|
3586
|
+
* @maxLength 255
|
|
3587
|
+
* @type string
|
|
3588
|
+
*/
|
|
3589
|
+
location?: string | null;
|
|
3590
|
+
/**
|
|
3591
|
+
* @description URL of the company logo.
|
|
3592
|
+
* @maxLength 2048
|
|
3593
|
+
* @type string
|
|
3594
|
+
*/
|
|
3595
|
+
logo_url?: string | null;
|
|
3596
|
+
/**
|
|
3597
|
+
* @description Free-form description or research notes.
|
|
3598
|
+
* @maxLength 10000
|
|
3599
|
+
* @type string | undefined
|
|
3600
|
+
*/
|
|
3601
|
+
description?: string;
|
|
3602
|
+
};
|
|
3603
|
+
|
|
3604
|
+
/**
|
|
3605
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
3606
|
+
* Do not edit manually.
|
|
3607
|
+
*/
|
|
3608
|
+
|
|
3609
|
+
/**
|
|
3610
|
+
* @description Unique organization identifier.
|
|
3611
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
3612
|
+
* @example org_abc123
|
|
3613
|
+
* @type string
|
|
3614
|
+
*/
|
|
3615
|
+
type CreateCrmCompanyPathOrgId = string;
|
|
3616
|
+
/**
|
|
3617
|
+
* @description A company (customer, prospect, or partner) tracked in the CRM.
|
|
3618
|
+
* @type object
|
|
3619
|
+
*/
|
|
3620
|
+
type CreateCrmCompanyStatus201 = Company;
|
|
3621
|
+
/**
|
|
3622
|
+
* @description Request body for creating or updating a company.
|
|
3623
|
+
* @type object
|
|
3624
|
+
*/
|
|
3625
|
+
type CreateCrmCompanyData = CompanyInput;
|
|
3626
|
+
/**
|
|
3627
|
+
* @type object
|
|
3628
|
+
*/
|
|
3629
|
+
type CreateCrmCompanyRequestConfig = {
|
|
3630
|
+
data?: CreateCrmCompanyData;
|
|
3631
|
+
/**
|
|
3632
|
+
* @type object
|
|
3633
|
+
*/
|
|
3634
|
+
pathParams: {
|
|
3635
|
+
org_id: CreateCrmCompanyPathOrgId;
|
|
3636
|
+
};
|
|
3637
|
+
queryParams?: never;
|
|
3638
|
+
headerParams?: never;
|
|
3639
|
+
/**
|
|
3640
|
+
* @type string
|
|
3641
|
+
*/
|
|
3642
|
+
url: `/v1/organizations/${string}/crm/companies`;
|
|
3643
|
+
};
|
|
3644
|
+
|
|
3645
|
+
/**
|
|
3646
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
3647
|
+
* Do not edit manually.
|
|
3648
|
+
*/
|
|
3649
|
+
|
|
3650
|
+
/**
|
|
3651
|
+
* @description Unique organization identifier.
|
|
3652
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
3653
|
+
* @example org_abc123
|
|
3654
|
+
* @type string
|
|
3655
|
+
*/
|
|
3656
|
+
type GetCrmCompanyPathOrgId = string;
|
|
3657
|
+
/**
|
|
3658
|
+
* @description Unique CRM company identifier (prefixed, e.g. cmp_xxx).
|
|
3659
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
3660
|
+
* @type string
|
|
3661
|
+
*/
|
|
3662
|
+
type GetCrmCompanyPathCompanyId = string;
|
|
3663
|
+
/**
|
|
3664
|
+
* @description A company (customer, prospect, or partner) tracked in the CRM.
|
|
3665
|
+
* @type object
|
|
3666
|
+
*/
|
|
3667
|
+
type GetCrmCompanyStatus200 = Company;
|
|
3668
|
+
/**
|
|
3669
|
+
* @type object
|
|
3670
|
+
*/
|
|
3671
|
+
type GetCrmCompanyRequestConfig = {
|
|
3672
|
+
data?: never;
|
|
3673
|
+
/**
|
|
3674
|
+
* @type object
|
|
3675
|
+
*/
|
|
3676
|
+
pathParams: {
|
|
3677
|
+
org_id: GetCrmCompanyPathOrgId;
|
|
3678
|
+
company_id: GetCrmCompanyPathCompanyId;
|
|
3679
|
+
};
|
|
3680
|
+
queryParams?: never;
|
|
3681
|
+
headerParams?: never;
|
|
3682
|
+
/**
|
|
3683
|
+
* @type string
|
|
3684
|
+
*/
|
|
3685
|
+
url: `/v1/organizations/${string}/crm/companies/${string}`;
|
|
3686
|
+
};
|
|
3687
|
+
|
|
3688
|
+
/**
|
|
3689
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
3690
|
+
* Do not edit manually.
|
|
3691
|
+
*/
|
|
3692
|
+
|
|
3693
|
+
/**
|
|
3694
|
+
* @description Unique organization identifier.
|
|
3695
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
3696
|
+
* @example org_abc123
|
|
3697
|
+
* @type string
|
|
3698
|
+
*/
|
|
3699
|
+
type UpdateCrmCompanyPathOrgId = string;
|
|
3700
|
+
/**
|
|
3701
|
+
* @description Unique CRM company identifier (prefixed, e.g. cmp_xxx).
|
|
3702
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
3703
|
+
* @type string
|
|
3704
|
+
*/
|
|
3705
|
+
type UpdateCrmCompanyPathCompanyId = string;
|
|
3706
|
+
/**
|
|
3707
|
+
* @description A company (customer, prospect, or partner) tracked in the CRM.
|
|
3708
|
+
* @type object
|
|
3709
|
+
*/
|
|
3710
|
+
type UpdateCrmCompanyStatus200 = Company;
|
|
3711
|
+
/**
|
|
3712
|
+
* @description Request body for creating or updating a company.
|
|
3713
|
+
* @type object
|
|
3714
|
+
*/
|
|
3715
|
+
type UpdateCrmCompanyData = CompanyInput;
|
|
3716
|
+
/**
|
|
3717
|
+
* @type object
|
|
3718
|
+
*/
|
|
3719
|
+
type UpdateCrmCompanyRequestConfig = {
|
|
3720
|
+
data?: UpdateCrmCompanyData;
|
|
3721
|
+
/**
|
|
3722
|
+
* @type object
|
|
3723
|
+
*/
|
|
3724
|
+
pathParams: {
|
|
3725
|
+
org_id: UpdateCrmCompanyPathOrgId;
|
|
3726
|
+
company_id: UpdateCrmCompanyPathCompanyId;
|
|
3727
|
+
};
|
|
3728
|
+
queryParams?: never;
|
|
3729
|
+
headerParams?: never;
|
|
3730
|
+
/**
|
|
3731
|
+
* @type string
|
|
3732
|
+
*/
|
|
3733
|
+
url: `/v1/organizations/${string}/crm/companies/${string}`;
|
|
3734
|
+
};
|
|
3735
|
+
|
|
3736
|
+
/**
|
|
3737
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
3738
|
+
* Do not edit manually.
|
|
3739
|
+
*/
|
|
3740
|
+
|
|
3741
|
+
/**
|
|
3742
|
+
* @description Unique organization identifier.
|
|
3743
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
3744
|
+
* @example org_abc123
|
|
3745
|
+
* @type string
|
|
3746
|
+
*/
|
|
3747
|
+
type DeleteCrmCompanyPathOrgId = string;
|
|
3748
|
+
/**
|
|
3749
|
+
* @description Unique CRM company identifier (prefixed, e.g. cmp_xxx).
|
|
3750
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
3751
|
+
* @type string
|
|
3752
|
+
*/
|
|
3753
|
+
type DeleteCrmCompanyPathCompanyId = string;
|
|
3754
|
+
/**
|
|
3755
|
+
* @type object
|
|
3756
|
+
*/
|
|
3757
|
+
type DeleteCrmCompanyRequestConfig = {
|
|
3758
|
+
data?: never;
|
|
3759
|
+
/**
|
|
3760
|
+
* @type object
|
|
3761
|
+
*/
|
|
3762
|
+
pathParams: {
|
|
3763
|
+
org_id: DeleteCrmCompanyPathOrgId;
|
|
3764
|
+
company_id: DeleteCrmCompanyPathCompanyId;
|
|
3765
|
+
};
|
|
3766
|
+
queryParams?: never;
|
|
3767
|
+
headerParams?: never;
|
|
3768
|
+
/**
|
|
3769
|
+
* @type string
|
|
3770
|
+
*/
|
|
3771
|
+
url: `/v1/organizations/${string}/crm/companies/${string}`;
|
|
3772
|
+
};
|
|
3773
|
+
|
|
3774
|
+
/**
|
|
3775
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
3776
|
+
* Do not edit manually.
|
|
3777
|
+
*/
|
|
3778
|
+
/**
|
|
3779
|
+
* @description A person tracked in the CRM, optionally attached to a company.
|
|
3780
|
+
* @type object
|
|
3781
|
+
*/
|
|
3782
|
+
type Contact = {
|
|
3783
|
+
/**
|
|
3784
|
+
* @description Unique contact identifier.
|
|
3785
|
+
* @example cnt_01j9x8y7z6w5v4u3t2s1r0q9p8
|
|
3786
|
+
* @type string
|
|
3787
|
+
*/
|
|
3788
|
+
id: string;
|
|
3789
|
+
/**
|
|
3790
|
+
* @description Organization the contact belongs to.
|
|
3791
|
+
* @example org_abc123
|
|
3792
|
+
* @type string
|
|
3793
|
+
*/
|
|
3794
|
+
org_id: string;
|
|
3795
|
+
/**
|
|
3796
|
+
* @description Company this contact belongs to, if any.
|
|
3797
|
+
* @example cmp_01j9x8y7z6w5v4u3t2s1r0q9p8
|
|
3798
|
+
* @type string
|
|
3799
|
+
*/
|
|
3800
|
+
company_id?: string | null;
|
|
3801
|
+
/**
|
|
3802
|
+
* @description Contact full name.
|
|
3803
|
+
* @example Jane Doe
|
|
3804
|
+
* @type string
|
|
3805
|
+
*/
|
|
3806
|
+
name: string;
|
|
3807
|
+
/**
|
|
3808
|
+
* @description Contact email address.
|
|
3809
|
+
* @example jane@acme.com
|
|
3810
|
+
* @type string
|
|
3811
|
+
*/
|
|
3812
|
+
email?: string | null;
|
|
3813
|
+
/**
|
|
3814
|
+
* @description Job title or role.
|
|
3815
|
+
* @example VP Engineering
|
|
3816
|
+
* @type string
|
|
3817
|
+
*/
|
|
3818
|
+
title?: string | null;
|
|
3819
|
+
/**
|
|
3820
|
+
* @description Phone number.
|
|
3821
|
+
* @type string
|
|
3822
|
+
*/
|
|
3823
|
+
phone?: string | null;
|
|
3824
|
+
/**
|
|
3825
|
+
* @description LinkedIn profile URL.
|
|
3826
|
+
* @type string
|
|
3827
|
+
*/
|
|
3828
|
+
linkedin_url?: string | null;
|
|
3829
|
+
/**
|
|
3830
|
+
* @description Free-form notes about the contact.
|
|
3831
|
+
* @type string
|
|
3832
|
+
*/
|
|
3833
|
+
notes: string;
|
|
3834
|
+
/**
|
|
3835
|
+
* @description When the contact was created.
|
|
3836
|
+
* @type string
|
|
3837
|
+
*/
|
|
3838
|
+
created_at: string;
|
|
3839
|
+
/**
|
|
3840
|
+
* @description When the contact was last updated.
|
|
3841
|
+
* @type string
|
|
3842
|
+
*/
|
|
3843
|
+
updated_at: string;
|
|
3844
|
+
};
|
|
3845
|
+
|
|
3846
|
+
/**
|
|
3847
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
3848
|
+
* Do not edit manually.
|
|
3849
|
+
*/
|
|
3850
|
+
|
|
3851
|
+
/**
|
|
3852
|
+
* @description Cursor-paginated contacts for an organization.
|
|
3853
|
+
* @type object
|
|
3854
|
+
*/
|
|
3855
|
+
type ListContactsResponse = {
|
|
3856
|
+
/**
|
|
3857
|
+
* @description Contacts returned for the current page.
|
|
3858
|
+
* @type array
|
|
3859
|
+
*/
|
|
3860
|
+
contacts: Contact[];
|
|
3861
|
+
/**
|
|
3862
|
+
* @description Opaque token for cursor-based pagination.
|
|
3863
|
+
* @type string | undefined
|
|
3864
|
+
*/
|
|
3865
|
+
next_page_token?: string;
|
|
3866
|
+
};
|
|
3867
|
+
|
|
3868
|
+
/**
|
|
3869
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
3870
|
+
* Do not edit manually.
|
|
3871
|
+
*/
|
|
3872
|
+
|
|
3873
|
+
/**
|
|
3874
|
+
* @description Unique organization identifier.
|
|
3875
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
3876
|
+
* @example org_abc123
|
|
3877
|
+
* @type string
|
|
3878
|
+
*/
|
|
3879
|
+
type ListCrmContactsPathOrgId = string;
|
|
3880
|
+
/**
|
|
3881
|
+
* @description Maximum number of items to return (1-100, default 20).
|
|
3882
|
+
* @minLength 1
|
|
3883
|
+
* @maxLength 100
|
|
3884
|
+
* @default 20
|
|
3885
|
+
* @type integer | undefined
|
|
3886
|
+
*/
|
|
3887
|
+
type ListCrmContactsQueryPageSize = number | undefined;
|
|
3888
|
+
/**
|
|
3889
|
+
* @description Opaque token for cursor-based pagination.
|
|
3890
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
3891
|
+
* @type string | undefined
|
|
3892
|
+
*/
|
|
3893
|
+
type ListCrmContactsQueryPageToken = string | undefined;
|
|
3894
|
+
/**
|
|
3895
|
+
* @description Cursor-paginated contacts for an organization.
|
|
3896
|
+
* @type object
|
|
3897
|
+
*/
|
|
3898
|
+
type ListCrmContactsStatus200 = ListContactsResponse;
|
|
3899
|
+
/**
|
|
3900
|
+
* @type object
|
|
3901
|
+
*/
|
|
3902
|
+
type ListCrmContactsRequestConfig = {
|
|
3903
|
+
data?: never;
|
|
3904
|
+
/**
|
|
3905
|
+
* @type object
|
|
3906
|
+
*/
|
|
3907
|
+
pathParams: {
|
|
3908
|
+
org_id: ListCrmContactsPathOrgId;
|
|
3909
|
+
};
|
|
3910
|
+
/**
|
|
3911
|
+
* @type object | undefined
|
|
3912
|
+
*/
|
|
3913
|
+
queryParams?: {
|
|
3914
|
+
page_size?: ListCrmContactsQueryPageSize;
|
|
3915
|
+
page_token?: ListCrmContactsQueryPageToken;
|
|
3916
|
+
};
|
|
3917
|
+
headerParams?: never;
|
|
3918
|
+
/**
|
|
3919
|
+
* @type string
|
|
3920
|
+
*/
|
|
3921
|
+
url: `/v1/organizations/${string}/crm/contacts`;
|
|
3922
|
+
};
|
|
3923
|
+
|
|
3924
|
+
/**
|
|
3925
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
3926
|
+
* Do not edit manually.
|
|
3927
|
+
*/
|
|
3928
|
+
/**
|
|
3929
|
+
* @description Request body for creating or updating a contact.
|
|
3930
|
+
* @type object
|
|
3931
|
+
*/
|
|
3932
|
+
type ContactInput = {
|
|
3933
|
+
/**
|
|
3934
|
+
* @description Company to attach this contact to, if any.
|
|
3935
|
+
* @maxLength 255
|
|
3936
|
+
* @type string
|
|
3937
|
+
*/
|
|
3938
|
+
company_id?: string | null;
|
|
3939
|
+
/**
|
|
3940
|
+
* @description Contact full name.
|
|
3941
|
+
* @minLength 1
|
|
3942
|
+
* @maxLength 255
|
|
3943
|
+
* @type string
|
|
3944
|
+
*/
|
|
3945
|
+
name: string;
|
|
3946
|
+
/**
|
|
3947
|
+
* @description Contact email address.
|
|
3948
|
+
* @maxLength 320
|
|
3949
|
+
* @type string
|
|
3950
|
+
*/
|
|
3951
|
+
email?: string | null;
|
|
3952
|
+
/**
|
|
3953
|
+
* @description Job title or role.
|
|
3954
|
+
* @maxLength 255
|
|
3955
|
+
* @type string
|
|
3956
|
+
*/
|
|
3957
|
+
title?: string | null;
|
|
3958
|
+
/**
|
|
3959
|
+
* @description Phone number.
|
|
3960
|
+
* @maxLength 64
|
|
3961
|
+
* @type string
|
|
3962
|
+
*/
|
|
3963
|
+
phone?: string | null;
|
|
3964
|
+
/**
|
|
3965
|
+
* @description LinkedIn profile URL.
|
|
3966
|
+
* @maxLength 2048
|
|
3967
|
+
* @type string
|
|
3968
|
+
*/
|
|
3969
|
+
linkedin_url?: string | null;
|
|
3970
|
+
/**
|
|
3971
|
+
* @description Free-form notes about the contact.
|
|
3972
|
+
* @maxLength 10000
|
|
3973
|
+
* @type string | undefined
|
|
3974
|
+
*/
|
|
3975
|
+
notes?: string;
|
|
3976
|
+
};
|
|
3977
|
+
|
|
3978
|
+
/**
|
|
3979
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
3980
|
+
* Do not edit manually.
|
|
3981
|
+
*/
|
|
3982
|
+
|
|
3983
|
+
/**
|
|
3984
|
+
* @description Unique organization identifier.
|
|
3985
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
3986
|
+
* @example org_abc123
|
|
3987
|
+
* @type string
|
|
3988
|
+
*/
|
|
3989
|
+
type CreateCrmContactPathOrgId = string;
|
|
3990
|
+
/**
|
|
3991
|
+
* @description A person tracked in the CRM, optionally attached to a company.
|
|
3992
|
+
* @type object
|
|
3993
|
+
*/
|
|
3994
|
+
type CreateCrmContactStatus201 = Contact;
|
|
3995
|
+
/**
|
|
3996
|
+
* @description Request body for creating or updating a contact.
|
|
3997
|
+
* @type object
|
|
3998
|
+
*/
|
|
3999
|
+
type CreateCrmContactData = ContactInput;
|
|
4000
|
+
/**
|
|
4001
|
+
* @type object
|
|
4002
|
+
*/
|
|
4003
|
+
type CreateCrmContactRequestConfig = {
|
|
4004
|
+
data?: CreateCrmContactData;
|
|
4005
|
+
/**
|
|
4006
|
+
* @type object
|
|
4007
|
+
*/
|
|
4008
|
+
pathParams: {
|
|
4009
|
+
org_id: CreateCrmContactPathOrgId;
|
|
4010
|
+
};
|
|
4011
|
+
queryParams?: never;
|
|
4012
|
+
headerParams?: never;
|
|
4013
|
+
/**
|
|
4014
|
+
* @type string
|
|
4015
|
+
*/
|
|
4016
|
+
url: `/v1/organizations/${string}/crm/contacts`;
|
|
4017
|
+
};
|
|
4018
|
+
|
|
4019
|
+
/**
|
|
4020
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4021
|
+
* Do not edit manually.
|
|
4022
|
+
*/
|
|
4023
|
+
|
|
4024
|
+
/**
|
|
4025
|
+
* @description Unique organization identifier.
|
|
4026
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
4027
|
+
* @example org_abc123
|
|
4028
|
+
* @type string
|
|
4029
|
+
*/
|
|
4030
|
+
type GetCrmContactPathOrgId = string;
|
|
4031
|
+
/**
|
|
4032
|
+
* @description Unique CRM contact identifier (prefixed, e.g. cnt_xxx).
|
|
4033
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
4034
|
+
* @type string
|
|
4035
|
+
*/
|
|
4036
|
+
type GetCrmContactPathContactId = string;
|
|
4037
|
+
/**
|
|
4038
|
+
* @description A person tracked in the CRM, optionally attached to a company.
|
|
4039
|
+
* @type object
|
|
4040
|
+
*/
|
|
4041
|
+
type GetCrmContactStatus200 = Contact;
|
|
4042
|
+
/**
|
|
4043
|
+
* @type object
|
|
4044
|
+
*/
|
|
4045
|
+
type GetCrmContactRequestConfig = {
|
|
4046
|
+
data?: never;
|
|
4047
|
+
/**
|
|
4048
|
+
* @type object
|
|
4049
|
+
*/
|
|
4050
|
+
pathParams: {
|
|
4051
|
+
org_id: GetCrmContactPathOrgId;
|
|
4052
|
+
contact_id: GetCrmContactPathContactId;
|
|
4053
|
+
};
|
|
4054
|
+
queryParams?: never;
|
|
4055
|
+
headerParams?: never;
|
|
4056
|
+
/**
|
|
4057
|
+
* @type string
|
|
4058
|
+
*/
|
|
4059
|
+
url: `/v1/organizations/${string}/crm/contacts/${string}`;
|
|
4060
|
+
};
|
|
4061
|
+
|
|
4062
|
+
/**
|
|
4063
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4064
|
+
* Do not edit manually.
|
|
4065
|
+
*/
|
|
4066
|
+
|
|
4067
|
+
/**
|
|
4068
|
+
* @description Unique organization identifier.
|
|
4069
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
4070
|
+
* @example org_abc123
|
|
4071
|
+
* @type string
|
|
4072
|
+
*/
|
|
4073
|
+
type UpdateCrmContactPathOrgId = string;
|
|
4074
|
+
/**
|
|
4075
|
+
* @description Unique CRM contact identifier (prefixed, e.g. cnt_xxx).
|
|
4076
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
4077
|
+
* @type string
|
|
4078
|
+
*/
|
|
4079
|
+
type UpdateCrmContactPathContactId = string;
|
|
4080
|
+
/**
|
|
4081
|
+
* @description A person tracked in the CRM, optionally attached to a company.
|
|
4082
|
+
* @type object
|
|
4083
|
+
*/
|
|
4084
|
+
type UpdateCrmContactStatus200 = Contact;
|
|
4085
|
+
/**
|
|
4086
|
+
* @description Request body for creating or updating a contact.
|
|
4087
|
+
* @type object
|
|
4088
|
+
*/
|
|
4089
|
+
type UpdateCrmContactData = ContactInput;
|
|
4090
|
+
/**
|
|
4091
|
+
* @type object
|
|
4092
|
+
*/
|
|
4093
|
+
type UpdateCrmContactRequestConfig = {
|
|
4094
|
+
data?: UpdateCrmContactData;
|
|
4095
|
+
/**
|
|
4096
|
+
* @type object
|
|
4097
|
+
*/
|
|
4098
|
+
pathParams: {
|
|
4099
|
+
org_id: UpdateCrmContactPathOrgId;
|
|
4100
|
+
contact_id: UpdateCrmContactPathContactId;
|
|
4101
|
+
};
|
|
4102
|
+
queryParams?: never;
|
|
4103
|
+
headerParams?: never;
|
|
4104
|
+
/**
|
|
4105
|
+
* @type string
|
|
4106
|
+
*/
|
|
4107
|
+
url: `/v1/organizations/${string}/crm/contacts/${string}`;
|
|
4108
|
+
};
|
|
4109
|
+
|
|
4110
|
+
/**
|
|
4111
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4112
|
+
* Do not edit manually.
|
|
4113
|
+
*/
|
|
4114
|
+
|
|
4115
|
+
/**
|
|
4116
|
+
* @description Unique organization identifier.
|
|
4117
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
4118
|
+
* @example org_abc123
|
|
4119
|
+
* @type string
|
|
4120
|
+
*/
|
|
4121
|
+
type DeleteCrmContactPathOrgId = string;
|
|
4122
|
+
/**
|
|
4123
|
+
* @description Unique CRM contact identifier (prefixed, e.g. cnt_xxx).
|
|
4124
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
4125
|
+
* @type string
|
|
4126
|
+
*/
|
|
4127
|
+
type DeleteCrmContactPathContactId = string;
|
|
4128
|
+
/**
|
|
4129
|
+
* @type object
|
|
4130
|
+
*/
|
|
4131
|
+
type DeleteCrmContactRequestConfig = {
|
|
4132
|
+
data?: never;
|
|
4133
|
+
/**
|
|
4134
|
+
* @type object
|
|
4135
|
+
*/
|
|
4136
|
+
pathParams: {
|
|
4137
|
+
org_id: DeleteCrmContactPathOrgId;
|
|
4138
|
+
contact_id: DeleteCrmContactPathContactId;
|
|
4139
|
+
};
|
|
4140
|
+
queryParams?: never;
|
|
4141
|
+
headerParams?: never;
|
|
4142
|
+
/**
|
|
4143
|
+
* @type string
|
|
4144
|
+
*/
|
|
4145
|
+
url: `/v1/organizations/${string}/crm/contacts/${string}`;
|
|
4146
|
+
};
|
|
4147
|
+
|
|
4148
|
+
/**
|
|
4149
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4150
|
+
* Do not edit manually.
|
|
4151
|
+
*/
|
|
4152
|
+
declare const dealStage: {
|
|
4153
|
+
readonly lead: "lead";
|
|
4154
|
+
readonly qualified: "qualified";
|
|
4155
|
+
readonly proposal: "proposal";
|
|
4156
|
+
readonly negotiation: "negotiation";
|
|
4157
|
+
readonly won: "won";
|
|
4158
|
+
readonly lost: "lost";
|
|
4159
|
+
};
|
|
4160
|
+
type DealStageKey = (typeof dealStage)[keyof typeof dealStage];
|
|
4161
|
+
|
|
4162
|
+
/**
|
|
4163
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4164
|
+
* Do not edit manually.
|
|
4165
|
+
*/
|
|
4166
|
+
|
|
4167
|
+
/**
|
|
4168
|
+
* @description A revenue opportunity moving through the sales pipeline.
|
|
4169
|
+
* @type object
|
|
4170
|
+
*/
|
|
4171
|
+
type Deal = {
|
|
4172
|
+
/**
|
|
4173
|
+
* @description Unique deal identifier.
|
|
4174
|
+
* @example dl_01j9x8y7z6w5v4u3t2s1r0q9p8
|
|
4175
|
+
* @type string
|
|
4176
|
+
*/
|
|
4177
|
+
id: string;
|
|
4178
|
+
/**
|
|
4179
|
+
* @description Organization the deal belongs to.
|
|
4180
|
+
* @example org_abc123
|
|
4181
|
+
* @type string
|
|
4182
|
+
*/
|
|
4183
|
+
org_id: string;
|
|
4184
|
+
/**
|
|
4185
|
+
* @description Company the deal is with, if any.
|
|
4186
|
+
* @type string
|
|
4187
|
+
*/
|
|
4188
|
+
company_id?: string | null;
|
|
4189
|
+
/**
|
|
4190
|
+
* @description Primary contact on the deal, if any.
|
|
4191
|
+
* @type string
|
|
4192
|
+
*/
|
|
4193
|
+
primary_contact_id?: string | null;
|
|
4194
|
+
/**
|
|
4195
|
+
* @description Deal title.
|
|
4196
|
+
* @example Acme - Platform expansion
|
|
4197
|
+
* @type string
|
|
4198
|
+
*/
|
|
4199
|
+
title: string;
|
|
4200
|
+
/**
|
|
4201
|
+
* @description Pipeline stage of a deal.
|
|
4202
|
+
* @type string
|
|
4203
|
+
*/
|
|
4204
|
+
stage: DealStageKey;
|
|
4205
|
+
/**
|
|
4206
|
+
* @description Deal value in the smallest currency unit (e.g. cents).
|
|
4207
|
+
* @example 5000000
|
|
4208
|
+
* @type integer
|
|
4209
|
+
*/
|
|
4210
|
+
amount_cents: number;
|
|
4211
|
+
/**
|
|
4212
|
+
* @description ISO 4217 currency code.
|
|
4213
|
+
* @example USD
|
|
4214
|
+
* @type string
|
|
4215
|
+
*/
|
|
4216
|
+
currency: string;
|
|
4217
|
+
/**
|
|
4218
|
+
* @description Deal owner (free-form, e.g. a user name or email).
|
|
4219
|
+
* @type string
|
|
4220
|
+
*/
|
|
4221
|
+
owner: string;
|
|
4222
|
+
/**
|
|
4223
|
+
* @description Expected or actual close date.
|
|
4224
|
+
* @type string
|
|
4225
|
+
*/
|
|
4226
|
+
close_date?: string | null;
|
|
4227
|
+
/**
|
|
4228
|
+
* @description When the deal was created.
|
|
4229
|
+
* @type string
|
|
4230
|
+
*/
|
|
4231
|
+
created_at: string;
|
|
4232
|
+
/**
|
|
4233
|
+
* @description When the deal was last updated.
|
|
4234
|
+
* @type string
|
|
4235
|
+
*/
|
|
4236
|
+
updated_at: string;
|
|
4237
|
+
};
|
|
4238
|
+
|
|
4239
|
+
/**
|
|
4240
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4241
|
+
* Do not edit manually.
|
|
4242
|
+
*/
|
|
4243
|
+
|
|
4244
|
+
/**
|
|
4245
|
+
* @description Cursor-paginated deals for an organization.
|
|
4246
|
+
* @type object
|
|
4247
|
+
*/
|
|
4248
|
+
type ListDealsResponse = {
|
|
4249
|
+
/**
|
|
4250
|
+
* @description Deals returned for the current page.
|
|
4251
|
+
* @type array
|
|
4252
|
+
*/
|
|
4253
|
+
deals: Deal[];
|
|
4254
|
+
/**
|
|
4255
|
+
* @description Opaque token for cursor-based pagination.
|
|
4256
|
+
* @type string | undefined
|
|
4257
|
+
*/
|
|
4258
|
+
next_page_token?: string;
|
|
4259
|
+
};
|
|
4260
|
+
|
|
4261
|
+
/**
|
|
4262
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4263
|
+
* Do not edit manually.
|
|
4264
|
+
*/
|
|
4265
|
+
|
|
4266
|
+
/**
|
|
4267
|
+
* @description Unique organization identifier.
|
|
4268
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
4269
|
+
* @example org_abc123
|
|
4270
|
+
* @type string
|
|
4271
|
+
*/
|
|
4272
|
+
type ListCrmDealsPathOrgId = string;
|
|
4273
|
+
/**
|
|
4274
|
+
* @description Maximum number of items to return (1-100, default 20).
|
|
4275
|
+
* @minLength 1
|
|
4276
|
+
* @maxLength 100
|
|
4277
|
+
* @default 20
|
|
4278
|
+
* @type integer | undefined
|
|
4279
|
+
*/
|
|
4280
|
+
type ListCrmDealsQueryPageSize = number | undefined;
|
|
4281
|
+
/**
|
|
4282
|
+
* @description Opaque token for cursor-based pagination.
|
|
4283
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
4284
|
+
* @type string | undefined
|
|
4285
|
+
*/
|
|
4286
|
+
type ListCrmDealsQueryPageToken = string | undefined;
|
|
4287
|
+
/**
|
|
4288
|
+
* @description Cursor-paginated deals for an organization.
|
|
4289
|
+
* @type object
|
|
4290
|
+
*/
|
|
4291
|
+
type ListCrmDealsStatus200 = ListDealsResponse;
|
|
4292
|
+
/**
|
|
4293
|
+
* @type object
|
|
4294
|
+
*/
|
|
4295
|
+
type ListCrmDealsRequestConfig = {
|
|
4296
|
+
data?: never;
|
|
4297
|
+
/**
|
|
4298
|
+
* @type object
|
|
4299
|
+
*/
|
|
4300
|
+
pathParams: {
|
|
4301
|
+
org_id: ListCrmDealsPathOrgId;
|
|
4302
|
+
};
|
|
4303
|
+
/**
|
|
4304
|
+
* @type object | undefined
|
|
4305
|
+
*/
|
|
4306
|
+
queryParams?: {
|
|
4307
|
+
page_size?: ListCrmDealsQueryPageSize;
|
|
4308
|
+
page_token?: ListCrmDealsQueryPageToken;
|
|
4309
|
+
};
|
|
4310
|
+
headerParams?: never;
|
|
4311
|
+
/**
|
|
4312
|
+
* @type string
|
|
4313
|
+
*/
|
|
4314
|
+
url: `/v1/organizations/${string}/crm/deals`;
|
|
4315
|
+
};
|
|
4316
|
+
|
|
4317
|
+
/**
|
|
4318
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4319
|
+
* Do not edit manually.
|
|
4320
|
+
*/
|
|
4321
|
+
|
|
4322
|
+
/**
|
|
4323
|
+
* @description Request body for creating or updating a deal.
|
|
4324
|
+
* @type object
|
|
4325
|
+
*/
|
|
4326
|
+
type DealInput = {
|
|
4327
|
+
/**
|
|
4328
|
+
* @description Company the deal is with, if any.
|
|
4329
|
+
* @maxLength 255
|
|
4330
|
+
* @type string
|
|
4331
|
+
*/
|
|
4332
|
+
company_id?: string | null;
|
|
4333
|
+
/**
|
|
4334
|
+
* @description Primary contact on the deal, if any.
|
|
4335
|
+
* @maxLength 255
|
|
4336
|
+
* @type string
|
|
4337
|
+
*/
|
|
4338
|
+
primary_contact_id?: string | null;
|
|
4339
|
+
/**
|
|
4340
|
+
* @description Deal title.
|
|
4341
|
+
* @minLength 1
|
|
4342
|
+
* @maxLength 255
|
|
4343
|
+
* @type string
|
|
4344
|
+
*/
|
|
4345
|
+
title: string;
|
|
4346
|
+
/**
|
|
4347
|
+
* @description Pipeline stage of a deal.
|
|
4348
|
+
* @type string | undefined
|
|
4349
|
+
*/
|
|
4350
|
+
stage?: DealStageKey;
|
|
4351
|
+
/**
|
|
4352
|
+
* @description Deal value in the smallest currency unit (e.g. cents).
|
|
4353
|
+
* @minLength 0
|
|
4354
|
+
* @type integer | undefined
|
|
4355
|
+
*/
|
|
4356
|
+
amount_cents?: number;
|
|
4357
|
+
/**
|
|
4358
|
+
* @description ISO 4217 currency code.
|
|
4359
|
+
* @minLength 3
|
|
4360
|
+
* @maxLength 3
|
|
4361
|
+
* @example USD
|
|
4362
|
+
* @type string | undefined
|
|
4363
|
+
*/
|
|
4364
|
+
currency?: string;
|
|
4365
|
+
/**
|
|
4366
|
+
* @description Deal owner (free-form, e.g. a user name or email).
|
|
4367
|
+
* @maxLength 255
|
|
4368
|
+
* @type string | undefined
|
|
4369
|
+
*/
|
|
4370
|
+
owner?: string;
|
|
4371
|
+
/**
|
|
4372
|
+
* @description Expected or actual close date.
|
|
4373
|
+
* @type string
|
|
4374
|
+
*/
|
|
4375
|
+
close_date?: string | null;
|
|
4376
|
+
};
|
|
4377
|
+
|
|
4378
|
+
/**
|
|
4379
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4380
|
+
* Do not edit manually.
|
|
4381
|
+
*/
|
|
4382
|
+
|
|
4383
|
+
/**
|
|
4384
|
+
* @description Unique organization identifier.
|
|
4385
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
4386
|
+
* @example org_abc123
|
|
4387
|
+
* @type string
|
|
4388
|
+
*/
|
|
4389
|
+
type CreateCrmDealPathOrgId = string;
|
|
4390
|
+
/**
|
|
4391
|
+
* @description A revenue opportunity moving through the sales pipeline.
|
|
4392
|
+
* @type object
|
|
4393
|
+
*/
|
|
4394
|
+
type CreateCrmDealStatus201 = Deal;
|
|
4395
|
+
/**
|
|
4396
|
+
* @description Request body for creating or updating a deal.
|
|
4397
|
+
* @type object
|
|
4398
|
+
*/
|
|
4399
|
+
type CreateCrmDealData = DealInput;
|
|
4400
|
+
/**
|
|
4401
|
+
* @type object
|
|
4402
|
+
*/
|
|
4403
|
+
type CreateCrmDealRequestConfig = {
|
|
4404
|
+
data?: CreateCrmDealData;
|
|
4405
|
+
/**
|
|
4406
|
+
* @type object
|
|
4407
|
+
*/
|
|
4408
|
+
pathParams: {
|
|
4409
|
+
org_id: CreateCrmDealPathOrgId;
|
|
4410
|
+
};
|
|
4411
|
+
queryParams?: never;
|
|
4412
|
+
headerParams?: never;
|
|
4413
|
+
/**
|
|
4414
|
+
* @type string
|
|
4415
|
+
*/
|
|
4416
|
+
url: `/v1/organizations/${string}/crm/deals`;
|
|
4417
|
+
};
|
|
4418
|
+
|
|
4419
|
+
/**
|
|
4420
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4421
|
+
* Do not edit manually.
|
|
4422
|
+
*/
|
|
4423
|
+
|
|
4424
|
+
/**
|
|
4425
|
+
* @description Aggregate deal count and value for a single pipeline stage.
|
|
4426
|
+
* @type object
|
|
4427
|
+
*/
|
|
4428
|
+
type PipelineStageSummary = {
|
|
4429
|
+
/**
|
|
4430
|
+
* @description Pipeline stage of a deal.
|
|
4431
|
+
* @type string
|
|
4432
|
+
*/
|
|
4433
|
+
stage: DealStageKey;
|
|
4434
|
+
/**
|
|
4435
|
+
* @description Number of deals in this stage.
|
|
4436
|
+
* @type integer
|
|
4437
|
+
*/
|
|
4438
|
+
deal_count: number;
|
|
4439
|
+
/**
|
|
4440
|
+
* @description Total value of deals in this stage, in minor currency units.
|
|
4441
|
+
* @type integer
|
|
4442
|
+
*/
|
|
4443
|
+
total_amount_cents: number;
|
|
4444
|
+
};
|
|
4445
|
+
|
|
4446
|
+
/**
|
|
4447
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4448
|
+
* Do not edit manually.
|
|
4449
|
+
*/
|
|
4450
|
+
|
|
4451
|
+
/**
|
|
4452
|
+
* @description Deal count and total value per pipeline stage.
|
|
4453
|
+
* @type object
|
|
4454
|
+
*/
|
|
4455
|
+
type PipelineSummaryResponse = {
|
|
4456
|
+
/**
|
|
4457
|
+
* @description One entry per stage that has at least one deal.
|
|
4458
|
+
* @type array
|
|
4459
|
+
*/
|
|
4460
|
+
stages: PipelineStageSummary[];
|
|
4461
|
+
};
|
|
4462
|
+
|
|
4463
|
+
/**
|
|
4464
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4465
|
+
* Do not edit manually.
|
|
4466
|
+
*/
|
|
4467
|
+
|
|
4468
|
+
/**
|
|
4469
|
+
* @description Unique organization identifier.
|
|
4470
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
4471
|
+
* @example org_abc123
|
|
4472
|
+
* @type string
|
|
4473
|
+
*/
|
|
4474
|
+
type GetCrmPipelinePathOrgId = string;
|
|
4475
|
+
/**
|
|
4476
|
+
* @description Deal count and total value per pipeline stage.
|
|
4477
|
+
* @type object
|
|
4478
|
+
*/
|
|
4479
|
+
type GetCrmPipelineStatus200 = PipelineSummaryResponse;
|
|
4480
|
+
/**
|
|
4481
|
+
* @type object
|
|
4482
|
+
*/
|
|
4483
|
+
type GetCrmPipelineRequestConfig = {
|
|
4484
|
+
data?: never;
|
|
4485
|
+
/**
|
|
4486
|
+
* @type object
|
|
4487
|
+
*/
|
|
4488
|
+
pathParams: {
|
|
4489
|
+
org_id: GetCrmPipelinePathOrgId;
|
|
4490
|
+
};
|
|
4491
|
+
queryParams?: never;
|
|
4492
|
+
headerParams?: never;
|
|
4493
|
+
/**
|
|
4494
|
+
* @type string
|
|
4495
|
+
*/
|
|
4496
|
+
url: `/v1/organizations/${string}/crm/pipeline`;
|
|
4497
|
+
};
|
|
4498
|
+
|
|
4499
|
+
/**
|
|
4500
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4501
|
+
* Do not edit manually.
|
|
4502
|
+
*/
|
|
4503
|
+
|
|
4504
|
+
/**
|
|
4505
|
+
* @description Unique organization identifier.
|
|
4506
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
4507
|
+
* @example org_abc123
|
|
4508
|
+
* @type string
|
|
4509
|
+
*/
|
|
4510
|
+
type GetCrmDealPathOrgId = string;
|
|
4511
|
+
/**
|
|
4512
|
+
* @description Unique CRM deal identifier (prefixed, e.g. dl_xxx).
|
|
4513
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
4514
|
+
* @type string
|
|
4515
|
+
*/
|
|
4516
|
+
type GetCrmDealPathDealId = string;
|
|
4517
|
+
/**
|
|
4518
|
+
* @description A revenue opportunity moving through the sales pipeline.
|
|
4519
|
+
* @type object
|
|
4520
|
+
*/
|
|
4521
|
+
type GetCrmDealStatus200 = Deal;
|
|
4522
|
+
/**
|
|
4523
|
+
* @type object
|
|
4524
|
+
*/
|
|
4525
|
+
type GetCrmDealRequestConfig = {
|
|
4526
|
+
data?: never;
|
|
4527
|
+
/**
|
|
4528
|
+
* @type object
|
|
4529
|
+
*/
|
|
4530
|
+
pathParams: {
|
|
4531
|
+
org_id: GetCrmDealPathOrgId;
|
|
4532
|
+
deal_id: GetCrmDealPathDealId;
|
|
4533
|
+
};
|
|
4534
|
+
queryParams?: never;
|
|
4535
|
+
headerParams?: never;
|
|
4536
|
+
/**
|
|
4537
|
+
* @type string
|
|
4538
|
+
*/
|
|
4539
|
+
url: `/v1/organizations/${string}/crm/deals/${string}`;
|
|
4540
|
+
};
|
|
4541
|
+
|
|
4542
|
+
/**
|
|
4543
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4544
|
+
* Do not edit manually.
|
|
4545
|
+
*/
|
|
4546
|
+
|
|
4547
|
+
/**
|
|
4548
|
+
* @description Unique organization identifier.
|
|
4549
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
4550
|
+
* @example org_abc123
|
|
4551
|
+
* @type string
|
|
4552
|
+
*/
|
|
4553
|
+
type UpdateCrmDealPathOrgId = string;
|
|
4554
|
+
/**
|
|
4555
|
+
* @description Unique CRM deal identifier (prefixed, e.g. dl_xxx).
|
|
4556
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
4557
|
+
* @type string
|
|
4558
|
+
*/
|
|
4559
|
+
type UpdateCrmDealPathDealId = string;
|
|
4560
|
+
/**
|
|
4561
|
+
* @description A revenue opportunity moving through the sales pipeline.
|
|
4562
|
+
* @type object
|
|
4563
|
+
*/
|
|
4564
|
+
type UpdateCrmDealStatus200 = Deal;
|
|
4565
|
+
/**
|
|
4566
|
+
* @description Request body for creating or updating a deal.
|
|
4567
|
+
* @type object
|
|
4568
|
+
*/
|
|
4569
|
+
type UpdateCrmDealData = DealInput;
|
|
4570
|
+
/**
|
|
4571
|
+
* @type object
|
|
4572
|
+
*/
|
|
4573
|
+
type UpdateCrmDealRequestConfig = {
|
|
4574
|
+
data?: UpdateCrmDealData;
|
|
4575
|
+
/**
|
|
4576
|
+
* @type object
|
|
4577
|
+
*/
|
|
4578
|
+
pathParams: {
|
|
4579
|
+
org_id: UpdateCrmDealPathOrgId;
|
|
4580
|
+
deal_id: UpdateCrmDealPathDealId;
|
|
4581
|
+
};
|
|
4582
|
+
queryParams?: never;
|
|
4583
|
+
headerParams?: never;
|
|
4584
|
+
/**
|
|
4585
|
+
* @type string
|
|
4586
|
+
*/
|
|
4587
|
+
url: `/v1/organizations/${string}/crm/deals/${string}`;
|
|
4588
|
+
};
|
|
4589
|
+
|
|
4590
|
+
/**
|
|
4591
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4592
|
+
* Do not edit manually.
|
|
4593
|
+
*/
|
|
4594
|
+
|
|
4595
|
+
/**
|
|
4596
|
+
* @description Unique organization identifier.
|
|
4597
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
4598
|
+
* @example org_abc123
|
|
4599
|
+
* @type string
|
|
4600
|
+
*/
|
|
4601
|
+
type DeleteCrmDealPathOrgId = string;
|
|
4602
|
+
/**
|
|
4603
|
+
* @description Unique CRM deal identifier (prefixed, e.g. dl_xxx).
|
|
4604
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
4605
|
+
* @type string
|
|
4606
|
+
*/
|
|
4607
|
+
type DeleteCrmDealPathDealId = string;
|
|
4608
|
+
/**
|
|
4609
|
+
* @type object
|
|
4610
|
+
*/
|
|
4611
|
+
type DeleteCrmDealRequestConfig = {
|
|
4612
|
+
data?: never;
|
|
4613
|
+
/**
|
|
4614
|
+
* @type object
|
|
4615
|
+
*/
|
|
4616
|
+
pathParams: {
|
|
4617
|
+
org_id: DeleteCrmDealPathOrgId;
|
|
4618
|
+
deal_id: DeleteCrmDealPathDealId;
|
|
4619
|
+
};
|
|
4620
|
+
queryParams?: never;
|
|
4621
|
+
headerParams?: never;
|
|
4622
|
+
/**
|
|
4623
|
+
* @type string
|
|
4624
|
+
*/
|
|
4625
|
+
url: `/v1/organizations/${string}/crm/deals/${string}`;
|
|
4626
|
+
};
|
|
4627
|
+
|
|
4628
|
+
/**
|
|
4629
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4630
|
+
* Do not edit manually.
|
|
4631
|
+
*/
|
|
4632
|
+
declare const agentRole: {
|
|
4633
|
+
readonly researcher: "researcher";
|
|
4634
|
+
readonly enricher: "enricher";
|
|
4635
|
+
readonly outreach: "outreach";
|
|
4636
|
+
};
|
|
4637
|
+
type AgentRoleKey = (typeof agentRole)[keyof typeof agentRole];
|
|
4638
|
+
|
|
4639
|
+
/**
|
|
4640
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4641
|
+
* Do not edit manually.
|
|
4642
|
+
*/
|
|
4643
|
+
declare const researchTaskKind: {
|
|
4644
|
+
readonly enrich_company: "enrich_company";
|
|
4645
|
+
readonly enrich_contact: "enrich_contact";
|
|
4646
|
+
readonly research_deal: "research_deal";
|
|
4647
|
+
readonly draft_outreach: "draft_outreach";
|
|
4648
|
+
readonly send_outreach: "send_outreach";
|
|
4649
|
+
readonly custom: "custom";
|
|
4650
|
+
};
|
|
4651
|
+
type ResearchTaskKindKey = (typeof researchTaskKind)[keyof typeof researchTaskKind];
|
|
4652
|
+
|
|
4653
|
+
/**
|
|
4654
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4655
|
+
* Do not edit manually.
|
|
4656
|
+
*/
|
|
4657
|
+
declare const researchTaskStatus: {
|
|
4658
|
+
readonly pending: "pending";
|
|
4659
|
+
readonly leased: "leased";
|
|
4660
|
+
readonly done: "done";
|
|
4661
|
+
readonly failed: "failed";
|
|
4662
|
+
readonly canceled: "canceled";
|
|
4663
|
+
readonly awaiting_approval: "awaiting_approval";
|
|
4664
|
+
};
|
|
4665
|
+
type ResearchTaskStatusKey = (typeof researchTaskStatus)[keyof typeof researchTaskStatus];
|
|
4666
|
+
|
|
4667
|
+
/**
|
|
4668
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4669
|
+
* Do not edit manually.
|
|
4670
|
+
*/
|
|
4671
|
+
declare const researchTaskSubjectType: {
|
|
4672
|
+
readonly company: "company";
|
|
4673
|
+
readonly contact: "contact";
|
|
4674
|
+
readonly deal: "deal";
|
|
4675
|
+
};
|
|
4676
|
+
type ResearchTaskSubjectTypeKey = (typeof researchTaskSubjectType)[keyof typeof researchTaskSubjectType];
|
|
4677
|
+
|
|
4678
|
+
/**
|
|
4679
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4680
|
+
* Do not edit manually.
|
|
4681
|
+
*/
|
|
4682
|
+
|
|
4683
|
+
/**
|
|
4684
|
+
* @description A unit of work for the autonomous research agent. Workers lease pending tasks from the queue, do the work (enrichment), and write the result back.\n
|
|
4685
|
+
* @type object
|
|
4686
|
+
*/
|
|
4687
|
+
type ResearchTask = {
|
|
4688
|
+
/**
|
|
4689
|
+
* @description Unique research task identifier.
|
|
4690
|
+
* @example ctk_01j9x8y7z6w5v4u3t2s1r0q9p8
|
|
4691
|
+
* @type string
|
|
4692
|
+
*/
|
|
4693
|
+
id: string;
|
|
4694
|
+
/**
|
|
4695
|
+
* @description Organization the task belongs to.
|
|
4696
|
+
* @example org_abc123
|
|
4697
|
+
* @type string
|
|
4698
|
+
*/
|
|
4699
|
+
org_id: string;
|
|
4700
|
+
/**
|
|
4701
|
+
* @description What the research agent should do for this task.
|
|
4702
|
+
* @type string
|
|
4703
|
+
*/
|
|
4704
|
+
kind: ResearchTaskKindKey;
|
|
4705
|
+
/**
|
|
4706
|
+
* @description Lifecycle state of a research task. awaiting_approval means the task is an irreversible action held for a human approval before it runs.\n
|
|
4707
|
+
* @type string
|
|
4708
|
+
*/
|
|
4709
|
+
status: ResearchTaskStatusKey;
|
|
4710
|
+
/**
|
|
4711
|
+
* @description Specialist agent role that owns a task. The researcher is the lead, the enricher fills in graph edges, and outreach writes and sends.\n
|
|
4712
|
+
* @type string
|
|
4713
|
+
*/
|
|
4714
|
+
role: AgentRoleKey;
|
|
4715
|
+
/**
|
|
4716
|
+
* @description Whether this task is held for human approval before it runs.
|
|
4717
|
+
* @type boolean
|
|
4718
|
+
*/
|
|
4719
|
+
requires_approval: boolean;
|
|
4720
|
+
/**
|
|
4721
|
+
* @description When the task was approved, if it required approval.
|
|
4722
|
+
* @type string
|
|
4723
|
+
*/
|
|
4724
|
+
approved_at?: string | null;
|
|
4725
|
+
/**
|
|
4726
|
+
* @description The kind of entity a research task targets.
|
|
4727
|
+
* @type string
|
|
4728
|
+
*/
|
|
4729
|
+
subject_type: ResearchTaskSubjectTypeKey;
|
|
4730
|
+
/**
|
|
4731
|
+
* @description ID of the company/contact/deal this task targets.
|
|
4732
|
+
* @type string
|
|
4733
|
+
*/
|
|
4734
|
+
subject_id: string;
|
|
4735
|
+
/**
|
|
4736
|
+
* @description Higher runs first.
|
|
4737
|
+
* @type integer
|
|
4738
|
+
*/
|
|
4739
|
+
priority: number;
|
|
4740
|
+
/**
|
|
4741
|
+
* @description Last error message, if the task has failed attempts.
|
|
4742
|
+
* @type string | undefined
|
|
4743
|
+
*/
|
|
4744
|
+
error?: string;
|
|
4745
|
+
/**
|
|
4746
|
+
* @description Number of attempts made so far.
|
|
4747
|
+
* @type integer
|
|
4748
|
+
*/
|
|
4749
|
+
attempts: number;
|
|
4750
|
+
/**
|
|
4751
|
+
* @description Maximum attempts before the task is terminal.
|
|
4752
|
+
* @type integer
|
|
4753
|
+
*/
|
|
4754
|
+
max_attempts: number;
|
|
4755
|
+
/**
|
|
4756
|
+
* @description When the task was enqueued.
|
|
4757
|
+
* @type string
|
|
4758
|
+
*/
|
|
4759
|
+
created_at: string;
|
|
4760
|
+
/**
|
|
4761
|
+
* @description When the task was last updated.
|
|
4762
|
+
* @type string
|
|
4763
|
+
*/
|
|
4764
|
+
updated_at: string;
|
|
4765
|
+
};
|
|
4766
|
+
|
|
4767
|
+
/**
|
|
4768
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4769
|
+
* Do not edit manually.
|
|
4770
|
+
*/
|
|
4771
|
+
|
|
4772
|
+
/**
|
|
4773
|
+
* @description Cursor-paginated research tasks for an organization.
|
|
4774
|
+
* @type object
|
|
4775
|
+
*/
|
|
4776
|
+
type ListResearchTasksResponse = {
|
|
4777
|
+
/**
|
|
4778
|
+
* @description Research tasks returned for the current page.
|
|
4779
|
+
* @type array
|
|
4780
|
+
*/
|
|
4781
|
+
tasks: ResearchTask[];
|
|
4782
|
+
/**
|
|
4783
|
+
* @description Opaque token for cursor-based pagination.
|
|
4784
|
+
* @type string | undefined
|
|
4785
|
+
*/
|
|
4786
|
+
next_page_token?: string;
|
|
4787
|
+
};
|
|
4788
|
+
|
|
4789
|
+
/**
|
|
4790
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4791
|
+
* Do not edit manually.
|
|
4792
|
+
*/
|
|
4793
|
+
|
|
4794
|
+
/**
|
|
4795
|
+
* @description Unique organization identifier.
|
|
4796
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
4797
|
+
* @example org_abc123
|
|
4798
|
+
* @type string
|
|
4799
|
+
*/
|
|
4800
|
+
type ListCrmResearchTasksPathOrgId = string;
|
|
4801
|
+
/**
|
|
4802
|
+
* @description Maximum number of items to return (1-100, default 20).
|
|
4803
|
+
* @minLength 1
|
|
4804
|
+
* @maxLength 100
|
|
4805
|
+
* @default 20
|
|
4806
|
+
* @type integer | undefined
|
|
4807
|
+
*/
|
|
4808
|
+
type ListCrmResearchTasksQueryPageSize = number | undefined;
|
|
4809
|
+
/**
|
|
4810
|
+
* @description Opaque token for cursor-based pagination.
|
|
4811
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
4812
|
+
* @type string | undefined
|
|
4813
|
+
*/
|
|
4814
|
+
type ListCrmResearchTasksQueryPageToken = string | undefined;
|
|
4815
|
+
/**
|
|
4816
|
+
* @description Cursor-paginated research tasks for an organization.
|
|
4817
|
+
* @type object
|
|
4818
|
+
*/
|
|
4819
|
+
type ListCrmResearchTasksStatus200 = ListResearchTasksResponse;
|
|
4820
|
+
/**
|
|
4821
|
+
* @type object
|
|
4822
|
+
*/
|
|
4823
|
+
type ListCrmResearchTasksRequestConfig = {
|
|
4824
|
+
data?: never;
|
|
4825
|
+
/**
|
|
4826
|
+
* @type object
|
|
4827
|
+
*/
|
|
4828
|
+
pathParams: {
|
|
4829
|
+
org_id: ListCrmResearchTasksPathOrgId;
|
|
4830
|
+
};
|
|
4831
|
+
/**
|
|
4832
|
+
* @type object | undefined
|
|
4833
|
+
*/
|
|
4834
|
+
queryParams?: {
|
|
4835
|
+
page_size?: ListCrmResearchTasksQueryPageSize;
|
|
4836
|
+
page_token?: ListCrmResearchTasksQueryPageToken;
|
|
4837
|
+
};
|
|
4838
|
+
headerParams?: never;
|
|
4839
|
+
/**
|
|
4840
|
+
* @type string
|
|
4841
|
+
*/
|
|
4842
|
+
url: `/v1/organizations/${string}/crm/research-tasks`;
|
|
4843
|
+
};
|
|
4844
|
+
|
|
4845
|
+
/**
|
|
4846
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4847
|
+
* Do not edit manually.
|
|
4848
|
+
*/
|
|
4849
|
+
|
|
4850
|
+
/**
|
|
4851
|
+
* @description Request body for enqueuing a research task.
|
|
4852
|
+
* @type object
|
|
4853
|
+
*/
|
|
4854
|
+
type ResearchTaskInput = {
|
|
4855
|
+
/**
|
|
4856
|
+
* @description What the research agent should do for this task.
|
|
4857
|
+
* @type string
|
|
4858
|
+
*/
|
|
4859
|
+
kind: ResearchTaskKindKey;
|
|
4860
|
+
/**
|
|
4861
|
+
* @description The kind of entity a research task targets.
|
|
4862
|
+
* @type string
|
|
4863
|
+
*/
|
|
4864
|
+
subject_type: ResearchTaskSubjectTypeKey;
|
|
4865
|
+
/**
|
|
4866
|
+
* @description ID of the company/contact/deal this task targets.
|
|
4867
|
+
* @minLength 1
|
|
4868
|
+
* @maxLength 255
|
|
4869
|
+
* @type string
|
|
4870
|
+
*/
|
|
4871
|
+
subject_id: string;
|
|
4872
|
+
/**
|
|
4873
|
+
* @description Specialist agent role that owns a task. The researcher is the lead, the enricher fills in graph edges, and outreach writes and sends.\n
|
|
4874
|
+
* @type string | undefined
|
|
4875
|
+
*/
|
|
4876
|
+
role?: AgentRoleKey;
|
|
4877
|
+
/**
|
|
4878
|
+
* @description Higher runs first.
|
|
4879
|
+
* @default 0
|
|
4880
|
+
* @type integer | undefined
|
|
4881
|
+
*/
|
|
4882
|
+
priority?: number;
|
|
4883
|
+
};
|
|
4884
|
+
|
|
4885
|
+
/**
|
|
4886
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4887
|
+
* Do not edit manually.
|
|
4888
|
+
*/
|
|
4889
|
+
|
|
4890
|
+
/**
|
|
4891
|
+
* @description Unique organization identifier.
|
|
4892
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
4893
|
+
* @example org_abc123
|
|
4894
|
+
* @type string
|
|
4895
|
+
*/
|
|
4896
|
+
type CreateCrmResearchTaskPathOrgId = string;
|
|
4897
|
+
/**
|
|
4898
|
+
* @description A unit of work for the autonomous research agent. Workers lease pending tasks from the queue, do the work (enrichment), and write the result back.\n
|
|
4899
|
+
* @type object
|
|
4900
|
+
*/
|
|
4901
|
+
type CreateCrmResearchTaskStatus201 = ResearchTask;
|
|
4902
|
+
/**
|
|
4903
|
+
* @description Request body for enqueuing a research task.
|
|
4904
|
+
* @type object
|
|
4905
|
+
*/
|
|
4906
|
+
type CreateCrmResearchTaskData = ResearchTaskInput;
|
|
4907
|
+
/**
|
|
4908
|
+
* @type object
|
|
4909
|
+
*/
|
|
4910
|
+
type CreateCrmResearchTaskRequestConfig = {
|
|
4911
|
+
data?: CreateCrmResearchTaskData;
|
|
4912
|
+
/**
|
|
4913
|
+
* @type object
|
|
4914
|
+
*/
|
|
4915
|
+
pathParams: {
|
|
4916
|
+
org_id: CreateCrmResearchTaskPathOrgId;
|
|
4917
|
+
};
|
|
4918
|
+
queryParams?: never;
|
|
4919
|
+
headerParams?: never;
|
|
4920
|
+
/**
|
|
4921
|
+
* @type string
|
|
4922
|
+
*/
|
|
4923
|
+
url: `/v1/organizations/${string}/crm/research-tasks`;
|
|
4924
|
+
};
|
|
4925
|
+
|
|
4926
|
+
/**
|
|
4927
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4928
|
+
* Do not edit manually.
|
|
4929
|
+
*/
|
|
4930
|
+
|
|
4931
|
+
/**
|
|
4932
|
+
* @description Unique organization identifier.
|
|
4933
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
4934
|
+
* @example org_abc123
|
|
4935
|
+
* @type string
|
|
4936
|
+
*/
|
|
4937
|
+
type GetCrmResearchTaskPathOrgId = string;
|
|
4938
|
+
/**
|
|
4939
|
+
* @description Unique CRM research task identifier (prefixed, e.g. ctk_xxx).
|
|
4940
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
4941
|
+
* @type string
|
|
4942
|
+
*/
|
|
4943
|
+
type GetCrmResearchTaskPathTaskId = string;
|
|
4944
|
+
/**
|
|
4945
|
+
* @description A unit of work for the autonomous research agent. Workers lease pending tasks from the queue, do the work (enrichment), and write the result back.\n
|
|
4946
|
+
* @type object
|
|
4947
|
+
*/
|
|
4948
|
+
type GetCrmResearchTaskStatus200 = ResearchTask;
|
|
4949
|
+
/**
|
|
4950
|
+
* @type object
|
|
4951
|
+
*/
|
|
4952
|
+
type GetCrmResearchTaskRequestConfig = {
|
|
4953
|
+
data?: never;
|
|
4954
|
+
/**
|
|
4955
|
+
* @type object
|
|
4956
|
+
*/
|
|
4957
|
+
pathParams: {
|
|
4958
|
+
org_id: GetCrmResearchTaskPathOrgId;
|
|
4959
|
+
task_id: GetCrmResearchTaskPathTaskId;
|
|
4960
|
+
};
|
|
4961
|
+
queryParams?: never;
|
|
4962
|
+
headerParams?: never;
|
|
4963
|
+
/**
|
|
4964
|
+
* @type string
|
|
4965
|
+
*/
|
|
4966
|
+
url: `/v1/organizations/${string}/crm/research-tasks/${string}`;
|
|
4967
|
+
};
|
|
4968
|
+
|
|
4969
|
+
/**
|
|
4970
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
4971
|
+
* Do not edit manually.
|
|
4972
|
+
*/
|
|
4973
|
+
|
|
4974
|
+
/**
|
|
4975
|
+
* @description Unique organization identifier.
|
|
4976
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
4977
|
+
* @example org_abc123
|
|
4978
|
+
* @type string
|
|
4979
|
+
*/
|
|
4980
|
+
type CancelCrmResearchTaskPathOrgId = string;
|
|
4981
|
+
/**
|
|
4982
|
+
* @description Unique CRM research task identifier (prefixed, e.g. ctk_xxx).
|
|
4983
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
4984
|
+
* @type string
|
|
4985
|
+
*/
|
|
4986
|
+
type CancelCrmResearchTaskPathTaskId = string;
|
|
4987
|
+
/**
|
|
4988
|
+
* @description A unit of work for the autonomous research agent. Workers lease pending tasks from the queue, do the work (enrichment), and write the result back.\n
|
|
4989
|
+
* @type object
|
|
4990
|
+
*/
|
|
4991
|
+
type CancelCrmResearchTaskStatus200 = ResearchTask;
|
|
4992
|
+
/**
|
|
4993
|
+
* @type object
|
|
4994
|
+
*/
|
|
4995
|
+
type CancelCrmResearchTaskRequestConfig = {
|
|
4996
|
+
data?: never;
|
|
4997
|
+
/**
|
|
4998
|
+
* @type object
|
|
4999
|
+
*/
|
|
5000
|
+
pathParams: {
|
|
5001
|
+
org_id: CancelCrmResearchTaskPathOrgId;
|
|
5002
|
+
task_id: CancelCrmResearchTaskPathTaskId;
|
|
5003
|
+
};
|
|
5004
|
+
queryParams?: never;
|
|
5005
|
+
headerParams?: never;
|
|
5006
|
+
/**
|
|
5007
|
+
* @type string
|
|
5008
|
+
*/
|
|
5009
|
+
url: `/v1/organizations/${string}/crm/research-tasks/${string}/cancel`;
|
|
5010
|
+
};
|
|
5011
|
+
|
|
5012
|
+
/**
|
|
5013
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
5014
|
+
* Do not edit manually.
|
|
5015
|
+
*/
|
|
5016
|
+
/**
|
|
5017
|
+
* @description Shared per-org CRM context the research agent reads to ground its work.
|
|
5018
|
+
* @type object
|
|
5019
|
+
*/
|
|
5020
|
+
type CrmContext = {
|
|
5021
|
+
/**
|
|
5022
|
+
* @description Organization this context belongs to.
|
|
5023
|
+
* @example org_abc123
|
|
5024
|
+
* @type string
|
|
5025
|
+
*/
|
|
5026
|
+
org_id: string;
|
|
5027
|
+
/**
|
|
5028
|
+
* @description How the org positions itself (one-liner or short paragraph).
|
|
5029
|
+
* @type string
|
|
5030
|
+
*/
|
|
5031
|
+
positioning: string;
|
|
5032
|
+
/**
|
|
5033
|
+
* @description Ideal customer profile.
|
|
5034
|
+
* @type string
|
|
5035
|
+
*/
|
|
5036
|
+
icp: string;
|
|
5037
|
+
/**
|
|
5038
|
+
* @description Preferred voice and tone for drafted content.
|
|
5039
|
+
* @type string
|
|
5040
|
+
*/
|
|
5041
|
+
tone: string;
|
|
5042
|
+
/**
|
|
5043
|
+
* @description Any other durable facts the agent should know.
|
|
5044
|
+
* @type string
|
|
5045
|
+
*/
|
|
5046
|
+
notes: string;
|
|
5047
|
+
/**
|
|
5048
|
+
* @description When the context was last updated.
|
|
5049
|
+
* @type string
|
|
5050
|
+
*/
|
|
5051
|
+
updated_at: string;
|
|
5052
|
+
};
|
|
5053
|
+
|
|
5054
|
+
/**
|
|
5055
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
5056
|
+
* Do not edit manually.
|
|
5057
|
+
*/
|
|
5058
|
+
|
|
5059
|
+
/**
|
|
5060
|
+
* @description Unique organization identifier.
|
|
5061
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
5062
|
+
* @example org_abc123
|
|
5063
|
+
* @type string
|
|
5064
|
+
*/
|
|
5065
|
+
type GetCrmContextPathOrgId = string;
|
|
5066
|
+
/**
|
|
5067
|
+
* @description Shared per-org CRM context the research agent reads to ground its work.
|
|
5068
|
+
* @type object
|
|
5069
|
+
*/
|
|
5070
|
+
type GetCrmContextStatus200 = CrmContext;
|
|
5071
|
+
/**
|
|
5072
|
+
* @type object
|
|
5073
|
+
*/
|
|
5074
|
+
type GetCrmContextRequestConfig = {
|
|
5075
|
+
data?: never;
|
|
5076
|
+
/**
|
|
5077
|
+
* @type object
|
|
5078
|
+
*/
|
|
5079
|
+
pathParams: {
|
|
5080
|
+
org_id: GetCrmContextPathOrgId;
|
|
5081
|
+
};
|
|
5082
|
+
queryParams?: never;
|
|
5083
|
+
headerParams?: never;
|
|
5084
|
+
/**
|
|
5085
|
+
* @type string
|
|
5086
|
+
*/
|
|
5087
|
+
url: `/v1/organizations/${string}/crm/context`;
|
|
5088
|
+
};
|
|
5089
|
+
|
|
5090
|
+
/**
|
|
5091
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
5092
|
+
* Do not edit manually.
|
|
5093
|
+
*/
|
|
5094
|
+
/**
|
|
5095
|
+
* @description Request body for updating the org CRM context.
|
|
5096
|
+
* @type object
|
|
5097
|
+
*/
|
|
5098
|
+
type CrmContextInput = {
|
|
5099
|
+
/**
|
|
5100
|
+
* @description How the org positions itself.
|
|
5101
|
+
* @maxLength 10000
|
|
5102
|
+
* @type string | undefined
|
|
5103
|
+
*/
|
|
5104
|
+
positioning?: string;
|
|
5105
|
+
/**
|
|
5106
|
+
* @description Ideal customer profile.
|
|
5107
|
+
* @maxLength 10000
|
|
5108
|
+
* @type string | undefined
|
|
5109
|
+
*/
|
|
5110
|
+
icp?: string;
|
|
5111
|
+
/**
|
|
5112
|
+
* @description Preferred voice and tone.
|
|
5113
|
+
* @maxLength 10000
|
|
5114
|
+
* @type string | undefined
|
|
5115
|
+
*/
|
|
5116
|
+
tone?: string;
|
|
5117
|
+
/**
|
|
5118
|
+
* @description Any other durable facts.
|
|
5119
|
+
* @maxLength 20000
|
|
5120
|
+
* @type string | undefined
|
|
5121
|
+
*/
|
|
5122
|
+
notes?: string;
|
|
5123
|
+
};
|
|
5124
|
+
|
|
5125
|
+
/**
|
|
5126
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
5127
|
+
* Do not edit manually.
|
|
5128
|
+
*/
|
|
5129
|
+
|
|
5130
|
+
/**
|
|
5131
|
+
* @description Unique organization identifier.
|
|
5132
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
5133
|
+
* @example org_abc123
|
|
5134
|
+
* @type string
|
|
5135
|
+
*/
|
|
5136
|
+
type UpdateCrmContextPathOrgId = string;
|
|
5137
|
+
/**
|
|
5138
|
+
* @description Shared per-org CRM context the research agent reads to ground its work.
|
|
5139
|
+
* @type object
|
|
5140
|
+
*/
|
|
5141
|
+
type UpdateCrmContextStatus200 = CrmContext;
|
|
5142
|
+
/**
|
|
5143
|
+
* @description Request body for updating the org CRM context.
|
|
5144
|
+
* @type object
|
|
5145
|
+
*/
|
|
5146
|
+
type UpdateCrmContextData = CrmContextInput;
|
|
5147
|
+
/**
|
|
5148
|
+
* @type object
|
|
5149
|
+
*/
|
|
5150
|
+
type UpdateCrmContextRequestConfig = {
|
|
5151
|
+
data?: UpdateCrmContextData;
|
|
5152
|
+
/**
|
|
5153
|
+
* @type object
|
|
5154
|
+
*/
|
|
5155
|
+
pathParams: {
|
|
5156
|
+
org_id: UpdateCrmContextPathOrgId;
|
|
5157
|
+
};
|
|
5158
|
+
queryParams?: never;
|
|
5159
|
+
headerParams?: never;
|
|
5160
|
+
/**
|
|
5161
|
+
* @type string
|
|
5162
|
+
*/
|
|
5163
|
+
url: `/v1/organizations/${string}/crm/context`;
|
|
5164
|
+
};
|
|
5165
|
+
|
|
5166
|
+
/**
|
|
5167
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
5168
|
+
* Do not edit manually.
|
|
5169
|
+
*/
|
|
5170
|
+
|
|
5171
|
+
/**
|
|
5172
|
+
* @description Unique organization identifier.
|
|
5173
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
5174
|
+
* @example org_abc123
|
|
5175
|
+
* @type string
|
|
5176
|
+
*/
|
|
5177
|
+
type ApproveCrmResearchTaskPathOrgId = string;
|
|
5178
|
+
/**
|
|
5179
|
+
* @description Unique CRM research task identifier (prefixed, e.g. ctk_xxx).
|
|
5180
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
5181
|
+
* @type string
|
|
5182
|
+
*/
|
|
5183
|
+
type ApproveCrmResearchTaskPathTaskId = string;
|
|
5184
|
+
/**
|
|
5185
|
+
* @description A unit of work for the autonomous research agent. Workers lease pending tasks from the queue, do the work (enrichment), and write the result back.\n
|
|
5186
|
+
* @type object
|
|
5187
|
+
*/
|
|
5188
|
+
type ApproveCrmResearchTaskStatus200 = ResearchTask;
|
|
5189
|
+
/**
|
|
5190
|
+
* @type object
|
|
5191
|
+
*/
|
|
5192
|
+
type ApproveCrmResearchTaskRequestConfig = {
|
|
5193
|
+
data?: never;
|
|
5194
|
+
/**
|
|
5195
|
+
* @type object
|
|
5196
|
+
*/
|
|
5197
|
+
pathParams: {
|
|
5198
|
+
org_id: ApproveCrmResearchTaskPathOrgId;
|
|
5199
|
+
task_id: ApproveCrmResearchTaskPathTaskId;
|
|
5200
|
+
};
|
|
5201
|
+
queryParams?: never;
|
|
5202
|
+
headerParams?: never;
|
|
5203
|
+
/**
|
|
5204
|
+
* @type string
|
|
5205
|
+
*/
|
|
5206
|
+
url: `/v1/organizations/${string}/crm/research-tasks/${string}/approve`;
|
|
5207
|
+
};
|
|
5208
|
+
|
|
5209
|
+
/**
|
|
5210
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
5211
|
+
* Do not edit manually.
|
|
5212
|
+
*/
|
|
5213
|
+
declare const artifactStatus: {
|
|
5214
|
+
readonly draft: "draft";
|
|
5215
|
+
readonly approved: "approved";
|
|
5216
|
+
readonly sent: "sent";
|
|
5217
|
+
readonly discarded: "discarded";
|
|
5218
|
+
};
|
|
5219
|
+
type ArtifactStatusKey = (typeof artifactStatus)[keyof typeof artifactStatus];
|
|
5220
|
+
|
|
5221
|
+
/**
|
|
5222
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
5223
|
+
* Do not edit manually.
|
|
5224
|
+
*/
|
|
5225
|
+
|
|
5226
|
+
/**
|
|
5227
|
+
* @description Long-form agent output (a drafted email, an account brief) for human review.
|
|
5228
|
+
* @type object
|
|
5229
|
+
*/
|
|
5230
|
+
type Artifact = {
|
|
5231
|
+
/**
|
|
5232
|
+
* @description Unique artifact identifier.
|
|
5233
|
+
* @example art_01j9x8y7z6w5v4u3t2s1r0q9p8
|
|
5234
|
+
* @type string
|
|
5235
|
+
*/
|
|
5236
|
+
id: string;
|
|
5237
|
+
/**
|
|
5238
|
+
* @description Organization the artifact belongs to.
|
|
5239
|
+
* @type string
|
|
5240
|
+
*/
|
|
5241
|
+
org_id: string;
|
|
5242
|
+
/**
|
|
5243
|
+
* @description Research task that produced this artifact, if any.
|
|
5244
|
+
* @type string
|
|
5245
|
+
*/
|
|
5246
|
+
task_id?: string | null;
|
|
5247
|
+
/**
|
|
5248
|
+
* @description The kind of entity a research task targets.
|
|
5249
|
+
* @type string
|
|
5250
|
+
*/
|
|
5251
|
+
subject_type: ResearchTaskSubjectTypeKey;
|
|
5252
|
+
/**
|
|
5253
|
+
* @description ID of the company/contact/deal this artifact is about.
|
|
5254
|
+
* @type string
|
|
5255
|
+
*/
|
|
5256
|
+
subject_id: string;
|
|
5257
|
+
/**
|
|
5258
|
+
* @description Kind of artifact (e.g. outreach_email, account_brief).
|
|
5259
|
+
* @type string
|
|
5260
|
+
*/
|
|
5261
|
+
kind: string;
|
|
5262
|
+
/**
|
|
5263
|
+
* @description Short title.
|
|
5264
|
+
* @type string
|
|
5265
|
+
*/
|
|
5266
|
+
title: string;
|
|
5267
|
+
/**
|
|
5268
|
+
* @description Long-form content.
|
|
5269
|
+
* @type string
|
|
5270
|
+
*/
|
|
5271
|
+
body: string;
|
|
5272
|
+
/**
|
|
5273
|
+
* @description Lifecycle state of an artifact.
|
|
5274
|
+
* @type string
|
|
5275
|
+
*/
|
|
5276
|
+
status: ArtifactStatusKey;
|
|
5277
|
+
/**
|
|
5278
|
+
* @description When the artifact was created.
|
|
5279
|
+
* @type string
|
|
5280
|
+
*/
|
|
5281
|
+
created_at: string;
|
|
5282
|
+
/**
|
|
5283
|
+
* @description When the artifact was last updated.
|
|
5284
|
+
* @type string
|
|
5285
|
+
*/
|
|
5286
|
+
updated_at: string;
|
|
5287
|
+
};
|
|
5288
|
+
|
|
5289
|
+
/**
|
|
5290
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
5291
|
+
* Do not edit manually.
|
|
5292
|
+
*/
|
|
5293
|
+
|
|
5294
|
+
/**
|
|
5295
|
+
* @description Cursor-paginated artifacts for an organization.
|
|
5296
|
+
* @type object
|
|
5297
|
+
*/
|
|
5298
|
+
type ListArtifactsResponse = {
|
|
5299
|
+
/**
|
|
5300
|
+
* @description Artifacts returned for the current page.
|
|
5301
|
+
* @type array
|
|
5302
|
+
*/
|
|
5303
|
+
artifacts: Artifact[];
|
|
5304
|
+
/**
|
|
5305
|
+
* @description Opaque token for cursor-based pagination.
|
|
5306
|
+
* @type string | undefined
|
|
5307
|
+
*/
|
|
5308
|
+
next_page_token?: string;
|
|
5309
|
+
};
|
|
5310
|
+
|
|
5311
|
+
/**
|
|
5312
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
5313
|
+
* Do not edit manually.
|
|
5314
|
+
*/
|
|
5315
|
+
|
|
5316
|
+
/**
|
|
5317
|
+
* @description Unique organization identifier.
|
|
5318
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
5319
|
+
* @example org_abc123
|
|
5320
|
+
* @type string
|
|
5321
|
+
*/
|
|
5322
|
+
type ListCrmArtifactsPathOrgId = string;
|
|
5323
|
+
/**
|
|
5324
|
+
* @description Maximum number of items to return (1-100, default 20).
|
|
5325
|
+
* @minLength 1
|
|
5326
|
+
* @maxLength 100
|
|
5327
|
+
* @default 20
|
|
5328
|
+
* @type integer | undefined
|
|
5329
|
+
*/
|
|
5330
|
+
type ListCrmArtifactsQueryPageSize = number | undefined;
|
|
5331
|
+
/**
|
|
5332
|
+
* @description Opaque token for cursor-based pagination.
|
|
5333
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
5334
|
+
* @type string | undefined
|
|
5335
|
+
*/
|
|
5336
|
+
type ListCrmArtifactsQueryPageToken = string | undefined;
|
|
5337
|
+
/**
|
|
5338
|
+
* @description Cursor-paginated artifacts for an organization.
|
|
5339
|
+
* @type object
|
|
5340
|
+
*/
|
|
5341
|
+
type ListCrmArtifactsStatus200 = ListArtifactsResponse;
|
|
5342
|
+
/**
|
|
5343
|
+
* @type object
|
|
5344
|
+
*/
|
|
5345
|
+
type ListCrmArtifactsRequestConfig = {
|
|
5346
|
+
data?: never;
|
|
5347
|
+
/**
|
|
5348
|
+
* @type object
|
|
5349
|
+
*/
|
|
5350
|
+
pathParams: {
|
|
5351
|
+
org_id: ListCrmArtifactsPathOrgId;
|
|
5352
|
+
};
|
|
5353
|
+
/**
|
|
5354
|
+
* @type object | undefined
|
|
5355
|
+
*/
|
|
5356
|
+
queryParams?: {
|
|
5357
|
+
page_size?: ListCrmArtifactsQueryPageSize;
|
|
5358
|
+
page_token?: ListCrmArtifactsQueryPageToken;
|
|
5359
|
+
};
|
|
5360
|
+
headerParams?: never;
|
|
5361
|
+
/**
|
|
5362
|
+
* @type string
|
|
5363
|
+
*/
|
|
5364
|
+
url: `/v1/organizations/${string}/crm/artifacts`;
|
|
5365
|
+
};
|
|
5366
|
+
|
|
5367
|
+
/**
|
|
5368
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
5369
|
+
* Do not edit manually.
|
|
5370
|
+
*/
|
|
5371
|
+
|
|
5372
|
+
/**
|
|
5373
|
+
* @description Unique organization identifier.
|
|
5374
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
5375
|
+
* @example org_abc123
|
|
5376
|
+
* @type string
|
|
5377
|
+
*/
|
|
5378
|
+
type GetCrmArtifactPathOrgId = string;
|
|
5379
|
+
/**
|
|
5380
|
+
* @description Unique CRM artifact identifier (prefixed, e.g. art_xxx).
|
|
5381
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
5382
|
+
* @type string
|
|
5383
|
+
*/
|
|
5384
|
+
type GetCrmArtifactPathArtifactId = string;
|
|
5385
|
+
/**
|
|
5386
|
+
* @description Long-form agent output (a drafted email, an account brief) for human review.
|
|
5387
|
+
* @type object
|
|
5388
|
+
*/
|
|
5389
|
+
type GetCrmArtifactStatus200 = Artifact;
|
|
5390
|
+
/**
|
|
5391
|
+
* @type object
|
|
5392
|
+
*/
|
|
5393
|
+
type GetCrmArtifactRequestConfig = {
|
|
5394
|
+
data?: never;
|
|
5395
|
+
/**
|
|
5396
|
+
* @type object
|
|
5397
|
+
*/
|
|
5398
|
+
pathParams: {
|
|
5399
|
+
org_id: GetCrmArtifactPathOrgId;
|
|
5400
|
+
artifact_id: GetCrmArtifactPathArtifactId;
|
|
5401
|
+
};
|
|
5402
|
+
queryParams?: never;
|
|
5403
|
+
headerParams?: never;
|
|
5404
|
+
/**
|
|
5405
|
+
* @type string
|
|
5406
|
+
*/
|
|
5407
|
+
url: `/v1/organizations/${string}/crm/artifacts/${string}`;
|
|
5408
|
+
};
|
|
5409
|
+
|
|
5410
|
+
/**
|
|
5411
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
5412
|
+
* Do not edit manually.
|
|
5413
|
+
*/
|
|
5414
|
+
|
|
5415
|
+
/**
|
|
5416
|
+
* @description A single entry in an entity\'s activity timeline.
|
|
5417
|
+
* @type object
|
|
5418
|
+
*/
|
|
5419
|
+
type Activity = {
|
|
5420
|
+
/**
|
|
5421
|
+
* @description Unique activity identifier.
|
|
5422
|
+
* @example act_01j9x8y7z6w5v4u3t2s1r0q9p8
|
|
5423
|
+
* @type string
|
|
5424
|
+
*/
|
|
5425
|
+
id: string;
|
|
5426
|
+
/**
|
|
5427
|
+
* @description Organization the activity belongs to.
|
|
5428
|
+
* @type string
|
|
5429
|
+
*/
|
|
5430
|
+
org_id: string;
|
|
5431
|
+
/**
|
|
5432
|
+
* @description The kind of entity a research task targets.
|
|
5433
|
+
* @type string
|
|
5434
|
+
*/
|
|
5435
|
+
subject_type: ResearchTaskSubjectTypeKey;
|
|
5436
|
+
/**
|
|
5437
|
+
* @description ID of the company/contact/deal this activity is about.
|
|
5438
|
+
* @type string
|
|
5439
|
+
*/
|
|
5440
|
+
subject_id: string;
|
|
5441
|
+
/**
|
|
5442
|
+
* @description Who performed the action (\"agent\" or a user identifier).
|
|
5443
|
+
* @type string
|
|
5444
|
+
*/
|
|
5445
|
+
actor: string;
|
|
5446
|
+
/**
|
|
5447
|
+
* @description What happened (created, enriched, drafted, approved, sent).
|
|
5448
|
+
* @type string
|
|
5449
|
+
*/
|
|
5450
|
+
verb: string;
|
|
5451
|
+
/**
|
|
5452
|
+
* @description When the action happened.
|
|
5453
|
+
* @type string
|
|
5454
|
+
*/
|
|
5455
|
+
at: string;
|
|
5456
|
+
};
|
|
5457
|
+
|
|
5458
|
+
/**
|
|
5459
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
5460
|
+
* Do not edit manually.
|
|
5461
|
+
*/
|
|
5462
|
+
|
|
5463
|
+
/**
|
|
5464
|
+
* @description Most-recent-first activities for an organization.
|
|
5465
|
+
* @type object
|
|
5466
|
+
*/
|
|
5467
|
+
type ListActivitiesResponse = {
|
|
5468
|
+
/**
|
|
5469
|
+
* @description Activities, newest first.
|
|
5470
|
+
* @type array
|
|
5471
|
+
*/
|
|
5472
|
+
activities: Activity[];
|
|
5473
|
+
};
|
|
5474
|
+
|
|
5475
|
+
/**
|
|
5476
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
5477
|
+
* Do not edit manually.
|
|
5478
|
+
*/
|
|
5479
|
+
|
|
5480
|
+
/**
|
|
5481
|
+
* @description Unique organization identifier.
|
|
5482
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
5483
|
+
* @example org_abc123
|
|
5484
|
+
* @type string
|
|
5485
|
+
*/
|
|
5486
|
+
type ListCrmActivitiesPathOrgId = string;
|
|
5487
|
+
/**
|
|
5488
|
+
* @description Maximum number of items to return (1-100, default 20).
|
|
5489
|
+
* @minLength 1
|
|
5490
|
+
* @maxLength 100
|
|
5491
|
+
* @default 20
|
|
5492
|
+
* @type integer | undefined
|
|
5493
|
+
*/
|
|
5494
|
+
type ListCrmActivitiesQueryPageSize = number | undefined;
|
|
5495
|
+
/**
|
|
5496
|
+
* @description Most-recent-first activities for an organization.
|
|
5497
|
+
* @type object
|
|
5498
|
+
*/
|
|
5499
|
+
type ListCrmActivitiesStatus200 = ListActivitiesResponse;
|
|
5500
|
+
/**
|
|
5501
|
+
* @type object
|
|
5502
|
+
*/
|
|
5503
|
+
type ListCrmActivitiesRequestConfig = {
|
|
5504
|
+
data?: never;
|
|
5505
|
+
/**
|
|
5506
|
+
* @type object
|
|
5507
|
+
*/
|
|
5508
|
+
pathParams: {
|
|
5509
|
+
org_id: ListCrmActivitiesPathOrgId;
|
|
5510
|
+
};
|
|
5511
|
+
/**
|
|
5512
|
+
* @type object | undefined
|
|
5513
|
+
*/
|
|
5514
|
+
queryParams?: {
|
|
5515
|
+
page_size?: ListCrmActivitiesQueryPageSize;
|
|
5516
|
+
};
|
|
5517
|
+
headerParams?: never;
|
|
5518
|
+
/**
|
|
5519
|
+
* @type string
|
|
5520
|
+
*/
|
|
5521
|
+
url: `/v1/organizations/${string}/crm/activities`;
|
|
5522
|
+
};
|
|
5523
|
+
|
|
3409
5524
|
/**
|
|
3410
5525
|
* Generated by Kubb (https://kubb.dev/).
|
|
3411
5526
|
* Do not edit manually.
|
|
@@ -7187,54 +9302,306 @@ type ListReplicasStatus200 = ListReplicasResponse;
|
|
|
7187
9302
|
/**
|
|
7188
9303
|
* @type object
|
|
7189
9304
|
*/
|
|
7190
|
-
type ListReplicasRequestConfig = {
|
|
9305
|
+
type ListReplicasRequestConfig = {
|
|
9306
|
+
data?: never;
|
|
9307
|
+
/**
|
|
9308
|
+
* @type object
|
|
9309
|
+
*/
|
|
9310
|
+
pathParams: {
|
|
9311
|
+
database_id: ListReplicasPathDatabaseId;
|
|
9312
|
+
};
|
|
9313
|
+
queryParams?: never;
|
|
9314
|
+
headerParams?: never;
|
|
9315
|
+
/**
|
|
9316
|
+
* @type string
|
|
9317
|
+
*/
|
|
9318
|
+
url: `/v1/databases/${string}/replicas`;
|
|
9319
|
+
};
|
|
9320
|
+
|
|
9321
|
+
/**
|
|
9322
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
9323
|
+
* Do not edit manually.
|
|
9324
|
+
*/
|
|
9325
|
+
|
|
9326
|
+
/**
|
|
9327
|
+
* @description Request body for adding a read replica to a database.
|
|
9328
|
+
* @type object
|
|
9329
|
+
*/
|
|
9330
|
+
type CreateReplicaRequest = {
|
|
9331
|
+
/**
|
|
9332
|
+
* @description PostgreSQL replica host.
|
|
9333
|
+
* @minLength 1
|
|
9334
|
+
* @pattern ^[^\s\x00]+$
|
|
9335
|
+
* @example replica.us-west-2.rds.amazonaws.com
|
|
9336
|
+
* @type string
|
|
9337
|
+
*/
|
|
9338
|
+
host: string;
|
|
9339
|
+
/**
|
|
9340
|
+
* @description PostgreSQL replica port.
|
|
9341
|
+
* @minLength 1
|
|
9342
|
+
* @maxLength 65535
|
|
9343
|
+
* @example 5432
|
|
9344
|
+
* @type integer
|
|
9345
|
+
*/
|
|
9346
|
+
port: number;
|
|
9347
|
+
/**
|
|
9348
|
+
* @description PostgreSQL SSL connection mode.
|
|
9349
|
+
* @example require
|
|
9350
|
+
* @type string | undefined
|
|
9351
|
+
*/
|
|
9352
|
+
ssl_mode?: SSLModeKey;
|
|
9353
|
+
};
|
|
9354
|
+
|
|
9355
|
+
/**
|
|
9356
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
9357
|
+
* Do not edit manually.
|
|
9358
|
+
*/
|
|
9359
|
+
|
|
9360
|
+
/**
|
|
9361
|
+
* @description Unique database identifier (prefixed, e.g. db_xxx).
|
|
9362
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
9363
|
+
* @type string
|
|
9364
|
+
*/
|
|
9365
|
+
type CreateReplicaPathDatabaseId = string;
|
|
9366
|
+
/**
|
|
9367
|
+
* @description Read replica registered for a primary database.
|
|
9368
|
+
* @type object
|
|
9369
|
+
*/
|
|
9370
|
+
type CreateReplicaStatus201 = Replica;
|
|
9371
|
+
/**
|
|
9372
|
+
* @description Request body for adding a read replica to a database.
|
|
9373
|
+
* @type object
|
|
9374
|
+
*/
|
|
9375
|
+
type CreateReplicaData = CreateReplicaRequest;
|
|
9376
|
+
/**
|
|
9377
|
+
* @type object
|
|
9378
|
+
*/
|
|
9379
|
+
type CreateReplicaRequestConfig = {
|
|
9380
|
+
data?: CreateReplicaData;
|
|
9381
|
+
/**
|
|
9382
|
+
* @type object
|
|
9383
|
+
*/
|
|
9384
|
+
pathParams: {
|
|
9385
|
+
database_id: CreateReplicaPathDatabaseId;
|
|
9386
|
+
};
|
|
9387
|
+
queryParams?: never;
|
|
9388
|
+
headerParams?: never;
|
|
9389
|
+
/**
|
|
9390
|
+
* @type string
|
|
9391
|
+
*/
|
|
9392
|
+
url: `/v1/databases/${string}/replicas`;
|
|
9393
|
+
};
|
|
9394
|
+
|
|
9395
|
+
/**
|
|
9396
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
9397
|
+
* Do not edit manually.
|
|
9398
|
+
*/
|
|
9399
|
+
|
|
9400
|
+
/**
|
|
9401
|
+
* @description Unique database identifier (prefixed, e.g. db_xxx).
|
|
9402
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
9403
|
+
* @type string
|
|
9404
|
+
*/
|
|
9405
|
+
type DeleteReplicaPathDatabaseId = string;
|
|
9406
|
+
/**
|
|
9407
|
+
* @description Unique replica identifier (prefixed, e.g. rep_xxx).
|
|
9408
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
9409
|
+
* @type string
|
|
9410
|
+
*/
|
|
9411
|
+
type DeleteReplicaPathReplicaId = string;
|
|
9412
|
+
/**
|
|
9413
|
+
* @type object
|
|
9414
|
+
*/
|
|
9415
|
+
type DeleteReplicaRequestConfig = {
|
|
9416
|
+
data?: never;
|
|
9417
|
+
/**
|
|
9418
|
+
* @type object
|
|
9419
|
+
*/
|
|
9420
|
+
pathParams: {
|
|
9421
|
+
database_id: DeleteReplicaPathDatabaseId;
|
|
9422
|
+
replica_id: DeleteReplicaPathReplicaId;
|
|
9423
|
+
};
|
|
9424
|
+
queryParams?: never;
|
|
9425
|
+
headerParams?: never;
|
|
9426
|
+
/**
|
|
9427
|
+
* @type string
|
|
9428
|
+
*/
|
|
9429
|
+
url: `/v1/databases/${string}/replicas/${string}`;
|
|
9430
|
+
};
|
|
9431
|
+
|
|
9432
|
+
/**
|
|
9433
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
9434
|
+
* Do not edit manually.
|
|
9435
|
+
*/
|
|
9436
|
+
/**
|
|
9437
|
+
* @description A human-written description for a table or column, attached by a project operator and surfaced through the agent-facing MCP catalog. When present it takes precedence over the DB-native comment for the same relation or column.\n
|
|
9438
|
+
* @type object
|
|
9439
|
+
*/
|
|
9440
|
+
type SchemaAnnotation = {
|
|
9441
|
+
/**
|
|
9442
|
+
* @description Unique annotation identifier.
|
|
9443
|
+
* @example sca_01j9x8y7z6w5v4u3t2s1r0q9p8
|
|
9444
|
+
* @type string
|
|
9445
|
+
*/
|
|
9446
|
+
id: string;
|
|
9447
|
+
/**
|
|
9448
|
+
* @description Project the annotation belongs to.
|
|
9449
|
+
* @example prj_01j9x8y7z6w5v4u3t2s1r0q9p8
|
|
9450
|
+
* @type string
|
|
9451
|
+
*/
|
|
9452
|
+
project_id: string;
|
|
9453
|
+
/**
|
|
9454
|
+
* @description Optional schema. Null matches the unqualified form, mirroring the relation allowlist normalization.\n
|
|
9455
|
+
* @example public
|
|
9456
|
+
* @type string
|
|
9457
|
+
*/
|
|
9458
|
+
schema_name?: string | null;
|
|
9459
|
+
/**
|
|
9460
|
+
* @description Relation (table or view) the annotation describes.
|
|
9461
|
+
* @example users
|
|
9462
|
+
* @type string
|
|
9463
|
+
*/
|
|
9464
|
+
table_name: string;
|
|
9465
|
+
/**
|
|
9466
|
+
* @description Optional column. Null means the annotation describes the table itself.\n
|
|
9467
|
+
* @example email
|
|
9468
|
+
* @type string
|
|
9469
|
+
*/
|
|
9470
|
+
column_name?: string | null;
|
|
9471
|
+
/**
|
|
9472
|
+
* @description The operator-written description text.
|
|
9473
|
+
* @example Primary customer account. One row per signed-up user.
|
|
9474
|
+
* @type string
|
|
9475
|
+
*/
|
|
9476
|
+
description: string;
|
|
9477
|
+
/**
|
|
9478
|
+
* @description When the annotation was created.
|
|
9479
|
+
* @type string
|
|
9480
|
+
*/
|
|
9481
|
+
created_at: string;
|
|
9482
|
+
/**
|
|
9483
|
+
* @description When the annotation was last updated.
|
|
9484
|
+
* @type string
|
|
9485
|
+
*/
|
|
9486
|
+
updated_at: string;
|
|
9487
|
+
};
|
|
9488
|
+
|
|
9489
|
+
/**
|
|
9490
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
9491
|
+
* Do not edit manually.
|
|
9492
|
+
*/
|
|
9493
|
+
|
|
9494
|
+
/**
|
|
9495
|
+
* @description Cursor-paginated schema annotations for a project.
|
|
9496
|
+
* @type object
|
|
9497
|
+
*/
|
|
9498
|
+
type ListSchemaAnnotationsResponse = {
|
|
9499
|
+
/**
|
|
9500
|
+
* @description Annotations returned for the current page.
|
|
9501
|
+
* @type array
|
|
9502
|
+
*/
|
|
9503
|
+
annotations: SchemaAnnotation[];
|
|
9504
|
+
/**
|
|
9505
|
+
* @description Opaque token for cursor-based pagination.
|
|
9506
|
+
* @type string | undefined
|
|
9507
|
+
*/
|
|
9508
|
+
next_page_token?: string;
|
|
9509
|
+
};
|
|
9510
|
+
|
|
9511
|
+
/**
|
|
9512
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
9513
|
+
* Do not edit manually.
|
|
9514
|
+
*/
|
|
9515
|
+
|
|
9516
|
+
/**
|
|
9517
|
+
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
9518
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
9519
|
+
* @type string
|
|
9520
|
+
*/
|
|
9521
|
+
type ListSchemaAnnotationsPathProjectId = string;
|
|
9522
|
+
/**
|
|
9523
|
+
* @description Maximum number of items to return (1-100, default 20).
|
|
9524
|
+
* @minLength 1
|
|
9525
|
+
* @maxLength 100
|
|
9526
|
+
* @default 20
|
|
9527
|
+
* @type integer | undefined
|
|
9528
|
+
*/
|
|
9529
|
+
type ListSchemaAnnotationsQueryPageSize = number | undefined;
|
|
9530
|
+
/**
|
|
9531
|
+
* @description Opaque token for cursor-based pagination.
|
|
9532
|
+
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
9533
|
+
* @type string | undefined
|
|
9534
|
+
*/
|
|
9535
|
+
type ListSchemaAnnotationsQueryPageToken = string | undefined;
|
|
9536
|
+
/**
|
|
9537
|
+
* @description Cursor-paginated schema annotations for a project.
|
|
9538
|
+
* @type object
|
|
9539
|
+
*/
|
|
9540
|
+
type ListSchemaAnnotationsStatus200 = ListSchemaAnnotationsResponse;
|
|
9541
|
+
/**
|
|
9542
|
+
* @type object
|
|
9543
|
+
*/
|
|
9544
|
+
type ListSchemaAnnotationsRequestConfig = {
|
|
7191
9545
|
data?: never;
|
|
7192
9546
|
/**
|
|
7193
9547
|
* @type object
|
|
7194
9548
|
*/
|
|
7195
9549
|
pathParams: {
|
|
7196
|
-
|
|
9550
|
+
project_id: ListSchemaAnnotationsPathProjectId;
|
|
9551
|
+
};
|
|
9552
|
+
/**
|
|
9553
|
+
* @type object | undefined
|
|
9554
|
+
*/
|
|
9555
|
+
queryParams?: {
|
|
9556
|
+
page_size?: ListSchemaAnnotationsQueryPageSize;
|
|
9557
|
+
page_token?: ListSchemaAnnotationsQueryPageToken;
|
|
7197
9558
|
};
|
|
7198
|
-
queryParams?: never;
|
|
7199
9559
|
headerParams?: never;
|
|
7200
9560
|
/**
|
|
7201
9561
|
* @type string
|
|
7202
9562
|
*/
|
|
7203
|
-
url: `/v1/
|
|
9563
|
+
url: `/v1/projects/${string}/schema-annotations`;
|
|
7204
9564
|
};
|
|
7205
9565
|
|
|
7206
9566
|
/**
|
|
7207
9567
|
* Generated by Kubb (https://kubb.dev/).
|
|
7208
9568
|
* Do not edit manually.
|
|
7209
9569
|
*/
|
|
7210
|
-
|
|
7211
9570
|
/**
|
|
7212
|
-
* @description Request body for
|
|
9571
|
+
* @description Request body for creating or replacing a schema annotation. Keyed by (schema_name, table_name, column_name); an existing annotation with the same key is replaced.\n
|
|
7213
9572
|
* @type object
|
|
7214
9573
|
*/
|
|
7215
|
-
type
|
|
9574
|
+
type SchemaAnnotationInput = {
|
|
7216
9575
|
/**
|
|
7217
|
-
* @description
|
|
7218
|
-
* @
|
|
7219
|
-
* @
|
|
7220
|
-
* @example replica.us-west-2.rds.amazonaws.com
|
|
9576
|
+
* @description Optional schema. Null or empty matches the unqualified form.
|
|
9577
|
+
* @maxLength 255
|
|
9578
|
+
* @example public
|
|
7221
9579
|
* @type string
|
|
7222
9580
|
*/
|
|
7223
|
-
|
|
9581
|
+
schema_name?: string | null;
|
|
7224
9582
|
/**
|
|
7225
|
-
* @description
|
|
9583
|
+
* @description Relation (table or view) the annotation describes.
|
|
7226
9584
|
* @minLength 1
|
|
7227
|
-
* @maxLength
|
|
7228
|
-
* @example
|
|
7229
|
-
* @type
|
|
9585
|
+
* @maxLength 255
|
|
9586
|
+
* @example users
|
|
9587
|
+
* @type string
|
|
7230
9588
|
*/
|
|
7231
|
-
|
|
9589
|
+
table_name: string;
|
|
7232
9590
|
/**
|
|
7233
|
-
* @description
|
|
7234
|
-
* @
|
|
7235
|
-
* @
|
|
9591
|
+
* @description Optional column. Null describes the table itself.
|
|
9592
|
+
* @maxLength 255
|
|
9593
|
+
* @example email
|
|
9594
|
+
* @type string
|
|
7236
9595
|
*/
|
|
7237
|
-
|
|
9596
|
+
column_name?: string | null;
|
|
9597
|
+
/**
|
|
9598
|
+
* @description The operator-written description text.
|
|
9599
|
+
* @minLength 1
|
|
9600
|
+
* @maxLength 4096
|
|
9601
|
+
* @example Primary customer account. One row per signed-up user.
|
|
9602
|
+
* @type string
|
|
9603
|
+
*/
|
|
9604
|
+
description: string;
|
|
7238
9605
|
};
|
|
7239
9606
|
|
|
7240
9607
|
/**
|
|
@@ -7243,38 +9610,38 @@ type CreateReplicaRequest = {
|
|
|
7243
9610
|
*/
|
|
7244
9611
|
|
|
7245
9612
|
/**
|
|
7246
|
-
* @description Unique
|
|
9613
|
+
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
7247
9614
|
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
7248
9615
|
* @type string
|
|
7249
9616
|
*/
|
|
7250
|
-
type
|
|
9617
|
+
type PutSchemaAnnotationPathProjectId = string;
|
|
7251
9618
|
/**
|
|
7252
|
-
* @description
|
|
9619
|
+
* @description A human-written description for a table or column, attached by a project operator and surfaced through the agent-facing MCP catalog. When present it takes precedence over the DB-native comment for the same relation or column.\n
|
|
7253
9620
|
* @type object
|
|
7254
9621
|
*/
|
|
7255
|
-
type
|
|
9622
|
+
type PutSchemaAnnotationStatus200 = SchemaAnnotation;
|
|
7256
9623
|
/**
|
|
7257
|
-
* @description Request body for
|
|
9624
|
+
* @description Request body for creating or replacing a schema annotation. Keyed by (schema_name, table_name, column_name); an existing annotation with the same key is replaced.\n
|
|
7258
9625
|
* @type object
|
|
7259
9626
|
*/
|
|
7260
|
-
type
|
|
9627
|
+
type PutSchemaAnnotationData = SchemaAnnotationInput;
|
|
7261
9628
|
/**
|
|
7262
9629
|
* @type object
|
|
7263
9630
|
*/
|
|
7264
|
-
type
|
|
7265
|
-
data?:
|
|
9631
|
+
type PutSchemaAnnotationRequestConfig = {
|
|
9632
|
+
data?: PutSchemaAnnotationData;
|
|
7266
9633
|
/**
|
|
7267
9634
|
* @type object
|
|
7268
9635
|
*/
|
|
7269
9636
|
pathParams: {
|
|
7270
|
-
|
|
9637
|
+
project_id: PutSchemaAnnotationPathProjectId;
|
|
7271
9638
|
};
|
|
7272
9639
|
queryParams?: never;
|
|
7273
9640
|
headerParams?: never;
|
|
7274
9641
|
/**
|
|
7275
9642
|
* @type string
|
|
7276
9643
|
*/
|
|
7277
|
-
url: `/v1/
|
|
9644
|
+
url: `/v1/projects/${string}/schema-annotations`;
|
|
7278
9645
|
};
|
|
7279
9646
|
|
|
7280
9647
|
/**
|
|
@@ -7283,35 +9650,54 @@ type CreateReplicaRequestConfig = {
|
|
|
7283
9650
|
*/
|
|
7284
9651
|
|
|
7285
9652
|
/**
|
|
7286
|
-
* @description Unique
|
|
9653
|
+
* @description Unique project identifier (prefixed, e.g. prj_xxx).
|
|
7287
9654
|
* @pattern ^[a-zA-Z0-9_.-]+$
|
|
7288
9655
|
* @type string
|
|
7289
9656
|
*/
|
|
7290
|
-
type
|
|
9657
|
+
type DeleteSchemaAnnotationPathProjectId = string;
|
|
7291
9658
|
/**
|
|
7292
|
-
* @description
|
|
7293
|
-
* @
|
|
9659
|
+
* @description Relation (table or view) the annotation describes.
|
|
9660
|
+
* @minLength 1
|
|
9661
|
+
* @maxLength 255
|
|
7294
9662
|
* @type string
|
|
7295
9663
|
*/
|
|
7296
|
-
type
|
|
9664
|
+
type DeleteSchemaAnnotationQueryTableName = string;
|
|
9665
|
+
/**
|
|
9666
|
+
* @description Optional schema. Omit to match the unqualified form.
|
|
9667
|
+
* @maxLength 255
|
|
9668
|
+
* @type string | undefined
|
|
9669
|
+
*/
|
|
9670
|
+
type DeleteSchemaAnnotationQuerySchemaName = string | undefined;
|
|
9671
|
+
/**
|
|
9672
|
+
* @description Optional column. Omit to delete a table-level annotation.
|
|
9673
|
+
* @maxLength 255
|
|
9674
|
+
* @type string | undefined
|
|
9675
|
+
*/
|
|
9676
|
+
type DeleteSchemaAnnotationQueryColumnName = string | undefined;
|
|
7297
9677
|
/**
|
|
7298
9678
|
* @type object
|
|
7299
9679
|
*/
|
|
7300
|
-
type
|
|
9680
|
+
type DeleteSchemaAnnotationRequestConfig = {
|
|
7301
9681
|
data?: never;
|
|
7302
9682
|
/**
|
|
7303
9683
|
* @type object
|
|
7304
9684
|
*/
|
|
7305
9685
|
pathParams: {
|
|
7306
|
-
|
|
7307
|
-
|
|
9686
|
+
project_id: DeleteSchemaAnnotationPathProjectId;
|
|
9687
|
+
};
|
|
9688
|
+
/**
|
|
9689
|
+
* @type object | undefined
|
|
9690
|
+
*/
|
|
9691
|
+
queryParams?: {
|
|
9692
|
+
table_name: DeleteSchemaAnnotationQueryTableName;
|
|
9693
|
+
schema_name?: DeleteSchemaAnnotationQuerySchemaName;
|
|
9694
|
+
column_name?: DeleteSchemaAnnotationQueryColumnName;
|
|
7308
9695
|
};
|
|
7309
|
-
queryParams?: never;
|
|
7310
9696
|
headerParams?: never;
|
|
7311
9697
|
/**
|
|
7312
9698
|
* @type string
|
|
7313
9699
|
*/
|
|
7314
|
-
url: `/v1/
|
|
9700
|
+
url: `/v1/projects/${string}/schema-annotations`;
|
|
7315
9701
|
};
|
|
7316
9702
|
|
|
7317
9703
|
/**
|
|
@@ -9074,6 +11460,112 @@ declare const operationsByTag: {
|
|
|
9074
11460
|
readonly path: "/v1/databases/{database_id}/replicas/{replica_id}";
|
|
9075
11461
|
};
|
|
9076
11462
|
};
|
|
11463
|
+
readonly crm: {
|
|
11464
|
+
readonly listCrmCompanies: {
|
|
11465
|
+
readonly method: "GET";
|
|
11466
|
+
readonly path: "/v1/organizations/{org_id}/crm/companies";
|
|
11467
|
+
};
|
|
11468
|
+
readonly createCrmCompany: {
|
|
11469
|
+
readonly method: "POST";
|
|
11470
|
+
readonly path: "/v1/organizations/{org_id}/crm/companies";
|
|
11471
|
+
};
|
|
11472
|
+
readonly getCrmCompany: {
|
|
11473
|
+
readonly method: "GET";
|
|
11474
|
+
readonly path: "/v1/organizations/{org_id}/crm/companies/{company_id}";
|
|
11475
|
+
};
|
|
11476
|
+
readonly updateCrmCompany: {
|
|
11477
|
+
readonly method: "PUT";
|
|
11478
|
+
readonly path: "/v1/organizations/{org_id}/crm/companies/{company_id}";
|
|
11479
|
+
};
|
|
11480
|
+
readonly deleteCrmCompany: {
|
|
11481
|
+
readonly method: "DELETE";
|
|
11482
|
+
readonly path: "/v1/organizations/{org_id}/crm/companies/{company_id}";
|
|
11483
|
+
};
|
|
11484
|
+
readonly listCrmContacts: {
|
|
11485
|
+
readonly method: "GET";
|
|
11486
|
+
readonly path: "/v1/organizations/{org_id}/crm/contacts";
|
|
11487
|
+
};
|
|
11488
|
+
readonly createCrmContact: {
|
|
11489
|
+
readonly method: "POST";
|
|
11490
|
+
readonly path: "/v1/organizations/{org_id}/crm/contacts";
|
|
11491
|
+
};
|
|
11492
|
+
readonly getCrmContact: {
|
|
11493
|
+
readonly method: "GET";
|
|
11494
|
+
readonly path: "/v1/organizations/{org_id}/crm/contacts/{contact_id}";
|
|
11495
|
+
};
|
|
11496
|
+
readonly updateCrmContact: {
|
|
11497
|
+
readonly method: "PUT";
|
|
11498
|
+
readonly path: "/v1/organizations/{org_id}/crm/contacts/{contact_id}";
|
|
11499
|
+
};
|
|
11500
|
+
readonly deleteCrmContact: {
|
|
11501
|
+
readonly method: "DELETE";
|
|
11502
|
+
readonly path: "/v1/organizations/{org_id}/crm/contacts/{contact_id}";
|
|
11503
|
+
};
|
|
11504
|
+
readonly listCrmDeals: {
|
|
11505
|
+
readonly method: "GET";
|
|
11506
|
+
readonly path: "/v1/organizations/{org_id}/crm/deals";
|
|
11507
|
+
};
|
|
11508
|
+
readonly createCrmDeal: {
|
|
11509
|
+
readonly method: "POST";
|
|
11510
|
+
readonly path: "/v1/organizations/{org_id}/crm/deals";
|
|
11511
|
+
};
|
|
11512
|
+
readonly getCrmPipeline: {
|
|
11513
|
+
readonly method: "GET";
|
|
11514
|
+
readonly path: "/v1/organizations/{org_id}/crm/pipeline";
|
|
11515
|
+
};
|
|
11516
|
+
readonly getCrmDeal: {
|
|
11517
|
+
readonly method: "GET";
|
|
11518
|
+
readonly path: "/v1/organizations/{org_id}/crm/deals/{deal_id}";
|
|
11519
|
+
};
|
|
11520
|
+
readonly updateCrmDeal: {
|
|
11521
|
+
readonly method: "PUT";
|
|
11522
|
+
readonly path: "/v1/organizations/{org_id}/crm/deals/{deal_id}";
|
|
11523
|
+
};
|
|
11524
|
+
readonly deleteCrmDeal: {
|
|
11525
|
+
readonly method: "DELETE";
|
|
11526
|
+
readonly path: "/v1/organizations/{org_id}/crm/deals/{deal_id}";
|
|
11527
|
+
};
|
|
11528
|
+
readonly listCrmResearchTasks: {
|
|
11529
|
+
readonly method: "GET";
|
|
11530
|
+
readonly path: "/v1/organizations/{org_id}/crm/research-tasks";
|
|
11531
|
+
};
|
|
11532
|
+
readonly createCrmResearchTask: {
|
|
11533
|
+
readonly method: "POST";
|
|
11534
|
+
readonly path: "/v1/organizations/{org_id}/crm/research-tasks";
|
|
11535
|
+
};
|
|
11536
|
+
readonly getCrmResearchTask: {
|
|
11537
|
+
readonly method: "GET";
|
|
11538
|
+
readonly path: "/v1/organizations/{org_id}/crm/research-tasks/{task_id}";
|
|
11539
|
+
};
|
|
11540
|
+
readonly cancelCrmResearchTask: {
|
|
11541
|
+
readonly method: "POST";
|
|
11542
|
+
readonly path: "/v1/organizations/{org_id}/crm/research-tasks/{task_id}/cancel";
|
|
11543
|
+
};
|
|
11544
|
+
readonly getCrmContext: {
|
|
11545
|
+
readonly method: "GET";
|
|
11546
|
+
readonly path: "/v1/organizations/{org_id}/crm/context";
|
|
11547
|
+
};
|
|
11548
|
+
readonly updateCrmContext: {
|
|
11549
|
+
readonly method: "PUT";
|
|
11550
|
+
readonly path: "/v1/organizations/{org_id}/crm/context";
|
|
11551
|
+
};
|
|
11552
|
+
readonly approveCrmResearchTask: {
|
|
11553
|
+
readonly method: "POST";
|
|
11554
|
+
readonly path: "/v1/organizations/{org_id}/crm/research-tasks/{task_id}/approve";
|
|
11555
|
+
};
|
|
11556
|
+
readonly listCrmArtifacts: {
|
|
11557
|
+
readonly method: "GET";
|
|
11558
|
+
readonly path: "/v1/organizations/{org_id}/crm/artifacts";
|
|
11559
|
+
};
|
|
11560
|
+
readonly getCrmArtifact: {
|
|
11561
|
+
readonly method: "GET";
|
|
11562
|
+
readonly path: "/v1/organizations/{org_id}/crm/artifacts/{artifact_id}";
|
|
11563
|
+
};
|
|
11564
|
+
readonly listCrmActivities: {
|
|
11565
|
+
readonly method: "GET";
|
|
11566
|
+
readonly path: "/v1/organizations/{org_id}/crm/activities";
|
|
11567
|
+
};
|
|
11568
|
+
};
|
|
9077
11569
|
readonly databases: {
|
|
9078
11570
|
readonly listDatabases: {
|
|
9079
11571
|
readonly method: "GET";
|
|
@@ -9162,6 +11654,20 @@ declare const operationsByTag: {
|
|
|
9162
11654
|
readonly path: "/v1/projects/{project_id}/migrations:lint";
|
|
9163
11655
|
};
|
|
9164
11656
|
};
|
|
11657
|
+
readonly schemaAnnotations: {
|
|
11658
|
+
readonly listSchemaAnnotations: {
|
|
11659
|
+
readonly method: "GET";
|
|
11660
|
+
readonly path: "/v1/projects/{project_id}/schema-annotations";
|
|
11661
|
+
};
|
|
11662
|
+
readonly putSchemaAnnotation: {
|
|
11663
|
+
readonly method: "PUT";
|
|
11664
|
+
readonly path: "/v1/projects/{project_id}/schema-annotations";
|
|
11665
|
+
};
|
|
11666
|
+
readonly deleteSchemaAnnotation: {
|
|
11667
|
+
readonly method: "DELETE";
|
|
11668
|
+
readonly path: "/v1/projects/{project_id}/schema-annotations";
|
|
11669
|
+
};
|
|
11670
|
+
};
|
|
9165
11671
|
readonly support: {
|
|
9166
11672
|
readonly listSupportCases: {
|
|
9167
11673
|
readonly method: "GET";
|
|
@@ -9343,6 +11849,136 @@ declare const operationsByPath: {
|
|
|
9343
11849
|
readonly path: "/v1/projects/{project_id}/databases/{database_id}/cache-rules/{query_hash}";
|
|
9344
11850
|
readonly operationId: "updateCacheRule";
|
|
9345
11851
|
};
|
|
11852
|
+
readonly "GET /v1/organizations/{org_id}/crm/companies": {
|
|
11853
|
+
readonly method: "GET";
|
|
11854
|
+
readonly path: "/v1/organizations/{org_id}/crm/companies";
|
|
11855
|
+
readonly operationId: "listCrmCompanies";
|
|
11856
|
+
};
|
|
11857
|
+
readonly "POST /v1/organizations/{org_id}/crm/companies": {
|
|
11858
|
+
readonly method: "POST";
|
|
11859
|
+
readonly path: "/v1/organizations/{org_id}/crm/companies";
|
|
11860
|
+
readonly operationId: "createCrmCompany";
|
|
11861
|
+
};
|
|
11862
|
+
readonly "GET /v1/organizations/{org_id}/crm/companies/{company_id}": {
|
|
11863
|
+
readonly method: "GET";
|
|
11864
|
+
readonly path: "/v1/organizations/{org_id}/crm/companies/{company_id}";
|
|
11865
|
+
readonly operationId: "getCrmCompany";
|
|
11866
|
+
};
|
|
11867
|
+
readonly "PUT /v1/organizations/{org_id}/crm/companies/{company_id}": {
|
|
11868
|
+
readonly method: "PUT";
|
|
11869
|
+
readonly path: "/v1/organizations/{org_id}/crm/companies/{company_id}";
|
|
11870
|
+
readonly operationId: "updateCrmCompany";
|
|
11871
|
+
};
|
|
11872
|
+
readonly "DELETE /v1/organizations/{org_id}/crm/companies/{company_id}": {
|
|
11873
|
+
readonly method: "DELETE";
|
|
11874
|
+
readonly path: "/v1/organizations/{org_id}/crm/companies/{company_id}";
|
|
11875
|
+
readonly operationId: "deleteCrmCompany";
|
|
11876
|
+
};
|
|
11877
|
+
readonly "GET /v1/organizations/{org_id}/crm/contacts": {
|
|
11878
|
+
readonly method: "GET";
|
|
11879
|
+
readonly path: "/v1/organizations/{org_id}/crm/contacts";
|
|
11880
|
+
readonly operationId: "listCrmContacts";
|
|
11881
|
+
};
|
|
11882
|
+
readonly "POST /v1/organizations/{org_id}/crm/contacts": {
|
|
11883
|
+
readonly method: "POST";
|
|
11884
|
+
readonly path: "/v1/organizations/{org_id}/crm/contacts";
|
|
11885
|
+
readonly operationId: "createCrmContact";
|
|
11886
|
+
};
|
|
11887
|
+
readonly "GET /v1/organizations/{org_id}/crm/contacts/{contact_id}": {
|
|
11888
|
+
readonly method: "GET";
|
|
11889
|
+
readonly path: "/v1/organizations/{org_id}/crm/contacts/{contact_id}";
|
|
11890
|
+
readonly operationId: "getCrmContact";
|
|
11891
|
+
};
|
|
11892
|
+
readonly "PUT /v1/organizations/{org_id}/crm/contacts/{contact_id}": {
|
|
11893
|
+
readonly method: "PUT";
|
|
11894
|
+
readonly path: "/v1/organizations/{org_id}/crm/contacts/{contact_id}";
|
|
11895
|
+
readonly operationId: "updateCrmContact";
|
|
11896
|
+
};
|
|
11897
|
+
readonly "DELETE /v1/organizations/{org_id}/crm/contacts/{contact_id}": {
|
|
11898
|
+
readonly method: "DELETE";
|
|
11899
|
+
readonly path: "/v1/organizations/{org_id}/crm/contacts/{contact_id}";
|
|
11900
|
+
readonly operationId: "deleteCrmContact";
|
|
11901
|
+
};
|
|
11902
|
+
readonly "GET /v1/organizations/{org_id}/crm/deals": {
|
|
11903
|
+
readonly method: "GET";
|
|
11904
|
+
readonly path: "/v1/organizations/{org_id}/crm/deals";
|
|
11905
|
+
readonly operationId: "listCrmDeals";
|
|
11906
|
+
};
|
|
11907
|
+
readonly "POST /v1/organizations/{org_id}/crm/deals": {
|
|
11908
|
+
readonly method: "POST";
|
|
11909
|
+
readonly path: "/v1/organizations/{org_id}/crm/deals";
|
|
11910
|
+
readonly operationId: "createCrmDeal";
|
|
11911
|
+
};
|
|
11912
|
+
readonly "GET /v1/organizations/{org_id}/crm/pipeline": {
|
|
11913
|
+
readonly method: "GET";
|
|
11914
|
+
readonly path: "/v1/organizations/{org_id}/crm/pipeline";
|
|
11915
|
+
readonly operationId: "getCrmPipeline";
|
|
11916
|
+
};
|
|
11917
|
+
readonly "GET /v1/organizations/{org_id}/crm/deals/{deal_id}": {
|
|
11918
|
+
readonly method: "GET";
|
|
11919
|
+
readonly path: "/v1/organizations/{org_id}/crm/deals/{deal_id}";
|
|
11920
|
+
readonly operationId: "getCrmDeal";
|
|
11921
|
+
};
|
|
11922
|
+
readonly "PUT /v1/organizations/{org_id}/crm/deals/{deal_id}": {
|
|
11923
|
+
readonly method: "PUT";
|
|
11924
|
+
readonly path: "/v1/organizations/{org_id}/crm/deals/{deal_id}";
|
|
11925
|
+
readonly operationId: "updateCrmDeal";
|
|
11926
|
+
};
|
|
11927
|
+
readonly "DELETE /v1/organizations/{org_id}/crm/deals/{deal_id}": {
|
|
11928
|
+
readonly method: "DELETE";
|
|
11929
|
+
readonly path: "/v1/organizations/{org_id}/crm/deals/{deal_id}";
|
|
11930
|
+
readonly operationId: "deleteCrmDeal";
|
|
11931
|
+
};
|
|
11932
|
+
readonly "GET /v1/organizations/{org_id}/crm/research-tasks": {
|
|
11933
|
+
readonly method: "GET";
|
|
11934
|
+
readonly path: "/v1/organizations/{org_id}/crm/research-tasks";
|
|
11935
|
+
readonly operationId: "listCrmResearchTasks";
|
|
11936
|
+
};
|
|
11937
|
+
readonly "POST /v1/organizations/{org_id}/crm/research-tasks": {
|
|
11938
|
+
readonly method: "POST";
|
|
11939
|
+
readonly path: "/v1/organizations/{org_id}/crm/research-tasks";
|
|
11940
|
+
readonly operationId: "createCrmResearchTask";
|
|
11941
|
+
};
|
|
11942
|
+
readonly "GET /v1/organizations/{org_id}/crm/research-tasks/{task_id}": {
|
|
11943
|
+
readonly method: "GET";
|
|
11944
|
+
readonly path: "/v1/organizations/{org_id}/crm/research-tasks/{task_id}";
|
|
11945
|
+
readonly operationId: "getCrmResearchTask";
|
|
11946
|
+
};
|
|
11947
|
+
readonly "POST /v1/organizations/{org_id}/crm/research-tasks/{task_id}/cancel": {
|
|
11948
|
+
readonly method: "POST";
|
|
11949
|
+
readonly path: "/v1/organizations/{org_id}/crm/research-tasks/{task_id}/cancel";
|
|
11950
|
+
readonly operationId: "cancelCrmResearchTask";
|
|
11951
|
+
};
|
|
11952
|
+
readonly "GET /v1/organizations/{org_id}/crm/context": {
|
|
11953
|
+
readonly method: "GET";
|
|
11954
|
+
readonly path: "/v1/organizations/{org_id}/crm/context";
|
|
11955
|
+
readonly operationId: "getCrmContext";
|
|
11956
|
+
};
|
|
11957
|
+
readonly "PUT /v1/organizations/{org_id}/crm/context": {
|
|
11958
|
+
readonly method: "PUT";
|
|
11959
|
+
readonly path: "/v1/organizations/{org_id}/crm/context";
|
|
11960
|
+
readonly operationId: "updateCrmContext";
|
|
11961
|
+
};
|
|
11962
|
+
readonly "POST /v1/organizations/{org_id}/crm/research-tasks/{task_id}/approve": {
|
|
11963
|
+
readonly method: "POST";
|
|
11964
|
+
readonly path: "/v1/organizations/{org_id}/crm/research-tasks/{task_id}/approve";
|
|
11965
|
+
readonly operationId: "approveCrmResearchTask";
|
|
11966
|
+
};
|
|
11967
|
+
readonly "GET /v1/organizations/{org_id}/crm/artifacts": {
|
|
11968
|
+
readonly method: "GET";
|
|
11969
|
+
readonly path: "/v1/organizations/{org_id}/crm/artifacts";
|
|
11970
|
+
readonly operationId: "listCrmArtifacts";
|
|
11971
|
+
};
|
|
11972
|
+
readonly "GET /v1/organizations/{org_id}/crm/artifacts/{artifact_id}": {
|
|
11973
|
+
readonly method: "GET";
|
|
11974
|
+
readonly path: "/v1/organizations/{org_id}/crm/artifacts/{artifact_id}";
|
|
11975
|
+
readonly operationId: "getCrmArtifact";
|
|
11976
|
+
};
|
|
11977
|
+
readonly "GET /v1/organizations/{org_id}/crm/activities": {
|
|
11978
|
+
readonly method: "GET";
|
|
11979
|
+
readonly path: "/v1/organizations/{org_id}/crm/activities";
|
|
11980
|
+
readonly operationId: "listCrmActivities";
|
|
11981
|
+
};
|
|
9346
11982
|
readonly "GET /v1/projects/{project_id}/databases": {
|
|
9347
11983
|
readonly method: "GET";
|
|
9348
11984
|
readonly path: "/v1/projects/{project_id}/databases";
|
|
@@ -9543,6 +12179,21 @@ declare const operationsByPath: {
|
|
|
9543
12179
|
readonly path: "/v1/databases/{database_id}/replicas/{replica_id}";
|
|
9544
12180
|
readonly operationId: "deleteReplica";
|
|
9545
12181
|
};
|
|
12182
|
+
readonly "GET /v1/projects/{project_id}/schema-annotations": {
|
|
12183
|
+
readonly method: "GET";
|
|
12184
|
+
readonly path: "/v1/projects/{project_id}/schema-annotations";
|
|
12185
|
+
readonly operationId: "listSchemaAnnotations";
|
|
12186
|
+
};
|
|
12187
|
+
readonly "PUT /v1/projects/{project_id}/schema-annotations": {
|
|
12188
|
+
readonly method: "PUT";
|
|
12189
|
+
readonly path: "/v1/projects/{project_id}/schema-annotations";
|
|
12190
|
+
readonly operationId: "putSchemaAnnotation";
|
|
12191
|
+
};
|
|
12192
|
+
readonly "DELETE /v1/projects/{project_id}/schema-annotations": {
|
|
12193
|
+
readonly method: "DELETE";
|
|
12194
|
+
readonly path: "/v1/projects/{project_id}/schema-annotations";
|
|
12195
|
+
readonly operationId: "deleteSchemaAnnotation";
|
|
12196
|
+
};
|
|
9546
12197
|
readonly "GET /v1/organizations/{org_id}/self-host-enrollments": {
|
|
9547
12198
|
readonly method: "GET";
|
|
9548
12199
|
readonly path: "/v1/organizations/{org_id}/self-host-enrollments";
|
|
@@ -9720,6 +12371,98 @@ type UpdateCacheRuleParams = {
|
|
|
9720
12371
|
pathParams: NonNullable<UpdateCacheRuleRequestConfig["pathParams"]>;
|
|
9721
12372
|
body: NonNullable<UpdateCacheRuleRequestConfig["data"]>;
|
|
9722
12373
|
};
|
|
12374
|
+
type ListCrmCompaniesParams = {
|
|
12375
|
+
pathParams: NonNullable<ListCrmCompaniesRequestConfig["pathParams"]>;
|
|
12376
|
+
queryParams?: NonNullable<ListCrmCompaniesRequestConfig["queryParams"]>;
|
|
12377
|
+
};
|
|
12378
|
+
type CreateCrmCompanyParams = {
|
|
12379
|
+
pathParams: NonNullable<CreateCrmCompanyRequestConfig["pathParams"]>;
|
|
12380
|
+
body: NonNullable<CreateCrmCompanyRequestConfig["data"]>;
|
|
12381
|
+
};
|
|
12382
|
+
type GetCrmCompanyParams = {
|
|
12383
|
+
pathParams: NonNullable<GetCrmCompanyRequestConfig["pathParams"]>;
|
|
12384
|
+
};
|
|
12385
|
+
type UpdateCrmCompanyParams = {
|
|
12386
|
+
pathParams: NonNullable<UpdateCrmCompanyRequestConfig["pathParams"]>;
|
|
12387
|
+
body: NonNullable<UpdateCrmCompanyRequestConfig["data"]>;
|
|
12388
|
+
};
|
|
12389
|
+
type DeleteCrmCompanyParams = {
|
|
12390
|
+
pathParams: NonNullable<DeleteCrmCompanyRequestConfig["pathParams"]>;
|
|
12391
|
+
};
|
|
12392
|
+
type ListCrmContactsParams = {
|
|
12393
|
+
pathParams: NonNullable<ListCrmContactsRequestConfig["pathParams"]>;
|
|
12394
|
+
queryParams?: NonNullable<ListCrmContactsRequestConfig["queryParams"]>;
|
|
12395
|
+
};
|
|
12396
|
+
type CreateCrmContactParams = {
|
|
12397
|
+
pathParams: NonNullable<CreateCrmContactRequestConfig["pathParams"]>;
|
|
12398
|
+
body: NonNullable<CreateCrmContactRequestConfig["data"]>;
|
|
12399
|
+
};
|
|
12400
|
+
type GetCrmContactParams = {
|
|
12401
|
+
pathParams: NonNullable<GetCrmContactRequestConfig["pathParams"]>;
|
|
12402
|
+
};
|
|
12403
|
+
type UpdateCrmContactParams = {
|
|
12404
|
+
pathParams: NonNullable<UpdateCrmContactRequestConfig["pathParams"]>;
|
|
12405
|
+
body: NonNullable<UpdateCrmContactRequestConfig["data"]>;
|
|
12406
|
+
};
|
|
12407
|
+
type DeleteCrmContactParams = {
|
|
12408
|
+
pathParams: NonNullable<DeleteCrmContactRequestConfig["pathParams"]>;
|
|
12409
|
+
};
|
|
12410
|
+
type ListCrmDealsParams = {
|
|
12411
|
+
pathParams: NonNullable<ListCrmDealsRequestConfig["pathParams"]>;
|
|
12412
|
+
queryParams?: NonNullable<ListCrmDealsRequestConfig["queryParams"]>;
|
|
12413
|
+
};
|
|
12414
|
+
type CreateCrmDealParams = {
|
|
12415
|
+
pathParams: NonNullable<CreateCrmDealRequestConfig["pathParams"]>;
|
|
12416
|
+
body: NonNullable<CreateCrmDealRequestConfig["data"]>;
|
|
12417
|
+
};
|
|
12418
|
+
type GetCrmPipelineParams = {
|
|
12419
|
+
pathParams: NonNullable<GetCrmPipelineRequestConfig["pathParams"]>;
|
|
12420
|
+
};
|
|
12421
|
+
type GetCrmDealParams = {
|
|
12422
|
+
pathParams: NonNullable<GetCrmDealRequestConfig["pathParams"]>;
|
|
12423
|
+
};
|
|
12424
|
+
type UpdateCrmDealParams = {
|
|
12425
|
+
pathParams: NonNullable<UpdateCrmDealRequestConfig["pathParams"]>;
|
|
12426
|
+
body: NonNullable<UpdateCrmDealRequestConfig["data"]>;
|
|
12427
|
+
};
|
|
12428
|
+
type DeleteCrmDealParams = {
|
|
12429
|
+
pathParams: NonNullable<DeleteCrmDealRequestConfig["pathParams"]>;
|
|
12430
|
+
};
|
|
12431
|
+
type ListCrmResearchTasksParams = {
|
|
12432
|
+
pathParams: NonNullable<ListCrmResearchTasksRequestConfig["pathParams"]>;
|
|
12433
|
+
queryParams?: NonNullable<ListCrmResearchTasksRequestConfig["queryParams"]>;
|
|
12434
|
+
};
|
|
12435
|
+
type CreateCrmResearchTaskParams = {
|
|
12436
|
+
pathParams: NonNullable<CreateCrmResearchTaskRequestConfig["pathParams"]>;
|
|
12437
|
+
body: NonNullable<CreateCrmResearchTaskRequestConfig["data"]>;
|
|
12438
|
+
};
|
|
12439
|
+
type GetCrmResearchTaskParams = {
|
|
12440
|
+
pathParams: NonNullable<GetCrmResearchTaskRequestConfig["pathParams"]>;
|
|
12441
|
+
};
|
|
12442
|
+
type CancelCrmResearchTaskParams = {
|
|
12443
|
+
pathParams: NonNullable<CancelCrmResearchTaskRequestConfig["pathParams"]>;
|
|
12444
|
+
};
|
|
12445
|
+
type GetCrmContextParams = {
|
|
12446
|
+
pathParams: NonNullable<GetCrmContextRequestConfig["pathParams"]>;
|
|
12447
|
+
};
|
|
12448
|
+
type UpdateCrmContextParams = {
|
|
12449
|
+
pathParams: NonNullable<UpdateCrmContextRequestConfig["pathParams"]>;
|
|
12450
|
+
body: NonNullable<UpdateCrmContextRequestConfig["data"]>;
|
|
12451
|
+
};
|
|
12452
|
+
type ApproveCrmResearchTaskParams = {
|
|
12453
|
+
pathParams: NonNullable<ApproveCrmResearchTaskRequestConfig["pathParams"]>;
|
|
12454
|
+
};
|
|
12455
|
+
type ListCrmArtifactsParams = {
|
|
12456
|
+
pathParams: NonNullable<ListCrmArtifactsRequestConfig["pathParams"]>;
|
|
12457
|
+
queryParams?: NonNullable<ListCrmArtifactsRequestConfig["queryParams"]>;
|
|
12458
|
+
};
|
|
12459
|
+
type GetCrmArtifactParams = {
|
|
12460
|
+
pathParams: NonNullable<GetCrmArtifactRequestConfig["pathParams"]>;
|
|
12461
|
+
};
|
|
12462
|
+
type ListCrmActivitiesParams = {
|
|
12463
|
+
pathParams: NonNullable<ListCrmActivitiesRequestConfig["pathParams"]>;
|
|
12464
|
+
queryParams?: NonNullable<ListCrmActivitiesRequestConfig["queryParams"]>;
|
|
12465
|
+
};
|
|
9723
12466
|
type ListDatabasesParams = {
|
|
9724
12467
|
pathParams: NonNullable<ListDatabasesRequestConfig["pathParams"]>;
|
|
9725
12468
|
queryParams?: NonNullable<ListDatabasesRequestConfig["queryParams"]>;
|
|
@@ -9850,6 +12593,18 @@ type CreateReplicaParams = {
|
|
|
9850
12593
|
type DeleteReplicaParams = {
|
|
9851
12594
|
pathParams: NonNullable<DeleteReplicaRequestConfig["pathParams"]>;
|
|
9852
12595
|
};
|
|
12596
|
+
type ListSchemaAnnotationsParams = {
|
|
12597
|
+
pathParams: NonNullable<ListSchemaAnnotationsRequestConfig["pathParams"]>;
|
|
12598
|
+
queryParams?: NonNullable<ListSchemaAnnotationsRequestConfig["queryParams"]>;
|
|
12599
|
+
};
|
|
12600
|
+
type PutSchemaAnnotationParams = {
|
|
12601
|
+
pathParams: NonNullable<PutSchemaAnnotationRequestConfig["pathParams"]>;
|
|
12602
|
+
body: NonNullable<PutSchemaAnnotationRequestConfig["data"]>;
|
|
12603
|
+
};
|
|
12604
|
+
type DeleteSchemaAnnotationParams = {
|
|
12605
|
+
pathParams: NonNullable<DeleteSchemaAnnotationRequestConfig["pathParams"]>;
|
|
12606
|
+
queryParams: NonNullable<DeleteSchemaAnnotationRequestConfig["queryParams"]>;
|
|
12607
|
+
};
|
|
9853
12608
|
type ListSelfHostEnrollmentsParams = {
|
|
9854
12609
|
pathParams: NonNullable<ListSelfHostEnrollmentsRequestConfig["pathParams"]>;
|
|
9855
12610
|
};
|
|
@@ -9982,6 +12737,34 @@ interface ApiOperations {
|
|
|
9982
12737
|
createReplica(params: CreateReplicaParams): Promise<CreateReplicaStatus201>;
|
|
9983
12738
|
deleteReplica(params: DeleteReplicaParams): Promise<void>;
|
|
9984
12739
|
};
|
|
12740
|
+
crm: {
|
|
12741
|
+
listCrmCompanies(params: ListCrmCompaniesParams): Promise<ListCrmCompaniesStatus200>;
|
|
12742
|
+
createCrmCompany(params: CreateCrmCompanyParams): Promise<CreateCrmCompanyStatus201>;
|
|
12743
|
+
getCrmCompany(params: GetCrmCompanyParams): Promise<GetCrmCompanyStatus200>;
|
|
12744
|
+
updateCrmCompany(params: UpdateCrmCompanyParams): Promise<UpdateCrmCompanyStatus200>;
|
|
12745
|
+
deleteCrmCompany(params: DeleteCrmCompanyParams): Promise<void>;
|
|
12746
|
+
listCrmContacts(params: ListCrmContactsParams): Promise<ListCrmContactsStatus200>;
|
|
12747
|
+
createCrmContact(params: CreateCrmContactParams): Promise<CreateCrmContactStatus201>;
|
|
12748
|
+
getCrmContact(params: GetCrmContactParams): Promise<GetCrmContactStatus200>;
|
|
12749
|
+
updateCrmContact(params: UpdateCrmContactParams): Promise<UpdateCrmContactStatus200>;
|
|
12750
|
+
deleteCrmContact(params: DeleteCrmContactParams): Promise<void>;
|
|
12751
|
+
listCrmDeals(params: ListCrmDealsParams): Promise<ListCrmDealsStatus200>;
|
|
12752
|
+
createCrmDeal(params: CreateCrmDealParams): Promise<CreateCrmDealStatus201>;
|
|
12753
|
+
getCrmPipeline(params: GetCrmPipelineParams): Promise<GetCrmPipelineStatus200>;
|
|
12754
|
+
getCrmDeal(params: GetCrmDealParams): Promise<GetCrmDealStatus200>;
|
|
12755
|
+
updateCrmDeal(params: UpdateCrmDealParams): Promise<UpdateCrmDealStatus200>;
|
|
12756
|
+
deleteCrmDeal(params: DeleteCrmDealParams): Promise<void>;
|
|
12757
|
+
listCrmResearchTasks(params: ListCrmResearchTasksParams): Promise<ListCrmResearchTasksStatus200>;
|
|
12758
|
+
createCrmResearchTask(params: CreateCrmResearchTaskParams): Promise<CreateCrmResearchTaskStatus201>;
|
|
12759
|
+
getCrmResearchTask(params: GetCrmResearchTaskParams): Promise<GetCrmResearchTaskStatus200>;
|
|
12760
|
+
cancelCrmResearchTask(params: CancelCrmResearchTaskParams): Promise<CancelCrmResearchTaskStatus200>;
|
|
12761
|
+
getCrmContext(params: GetCrmContextParams): Promise<GetCrmContextStatus200>;
|
|
12762
|
+
updateCrmContext(params: UpdateCrmContextParams): Promise<UpdateCrmContextStatus200>;
|
|
12763
|
+
approveCrmResearchTask(params: ApproveCrmResearchTaskParams): Promise<ApproveCrmResearchTaskStatus200>;
|
|
12764
|
+
listCrmArtifacts(params: ListCrmArtifactsParams): Promise<ListCrmArtifactsStatus200>;
|
|
12765
|
+
getCrmArtifact(params: GetCrmArtifactParams): Promise<GetCrmArtifactStatus200>;
|
|
12766
|
+
listCrmActivities(params: ListCrmActivitiesParams): Promise<ListCrmActivitiesStatus200>;
|
|
12767
|
+
};
|
|
9985
12768
|
databases: {
|
|
9986
12769
|
listDatabases(params: ListDatabasesParams): Promise<ListDatabasesStatus200>;
|
|
9987
12770
|
createDatabase(params: CreateDatabaseParams): Promise<CreateDatabaseStatus201>;
|
|
@@ -10010,6 +12793,11 @@ interface ApiOperations {
|
|
|
10010
12793
|
migrations: {
|
|
10011
12794
|
lintMigration(params: LintMigrationParams): Promise<LintMigrationStatus200>;
|
|
10012
12795
|
};
|
|
12796
|
+
schemaAnnotations: {
|
|
12797
|
+
listSchemaAnnotations(params: ListSchemaAnnotationsParams): Promise<ListSchemaAnnotationsStatus200>;
|
|
12798
|
+
putSchemaAnnotation(params: PutSchemaAnnotationParams): Promise<PutSchemaAnnotationStatus200>;
|
|
12799
|
+
deleteSchemaAnnotation(params: DeleteSchemaAnnotationParams): Promise<void>;
|
|
12800
|
+
};
|
|
10013
12801
|
support: {
|
|
10014
12802
|
listSupportCases(params: ListSupportCasesParams): Promise<ListSupportCasesStatus200>;
|
|
10015
12803
|
createSupportCase(params: CreateSupportCaseParams): Promise<CreateSupportCaseStatus201>;
|
|
@@ -10130,6 +12918,110 @@ interface RequestMap {
|
|
|
10130
12918
|
params: UpdateCacheRuleParams;
|
|
10131
12919
|
response: UpdateCacheRuleStatus200;
|
|
10132
12920
|
};
|
|
12921
|
+
"GET /v1/organizations/{org_id}/crm/companies": {
|
|
12922
|
+
params: ListCrmCompaniesParams;
|
|
12923
|
+
response: ListCrmCompaniesStatus200;
|
|
12924
|
+
};
|
|
12925
|
+
"POST /v1/organizations/{org_id}/crm/companies": {
|
|
12926
|
+
params: CreateCrmCompanyParams;
|
|
12927
|
+
response: CreateCrmCompanyStatus201;
|
|
12928
|
+
};
|
|
12929
|
+
"GET /v1/organizations/{org_id}/crm/companies/{company_id}": {
|
|
12930
|
+
params: GetCrmCompanyParams;
|
|
12931
|
+
response: GetCrmCompanyStatus200;
|
|
12932
|
+
};
|
|
12933
|
+
"PUT /v1/organizations/{org_id}/crm/companies/{company_id}": {
|
|
12934
|
+
params: UpdateCrmCompanyParams;
|
|
12935
|
+
response: UpdateCrmCompanyStatus200;
|
|
12936
|
+
};
|
|
12937
|
+
"DELETE /v1/organizations/{org_id}/crm/companies/{company_id}": {
|
|
12938
|
+
params: DeleteCrmCompanyParams;
|
|
12939
|
+
response: void;
|
|
12940
|
+
};
|
|
12941
|
+
"GET /v1/organizations/{org_id}/crm/contacts": {
|
|
12942
|
+
params: ListCrmContactsParams;
|
|
12943
|
+
response: ListCrmContactsStatus200;
|
|
12944
|
+
};
|
|
12945
|
+
"POST /v1/organizations/{org_id}/crm/contacts": {
|
|
12946
|
+
params: CreateCrmContactParams;
|
|
12947
|
+
response: CreateCrmContactStatus201;
|
|
12948
|
+
};
|
|
12949
|
+
"GET /v1/organizations/{org_id}/crm/contacts/{contact_id}": {
|
|
12950
|
+
params: GetCrmContactParams;
|
|
12951
|
+
response: GetCrmContactStatus200;
|
|
12952
|
+
};
|
|
12953
|
+
"PUT /v1/organizations/{org_id}/crm/contacts/{contact_id}": {
|
|
12954
|
+
params: UpdateCrmContactParams;
|
|
12955
|
+
response: UpdateCrmContactStatus200;
|
|
12956
|
+
};
|
|
12957
|
+
"DELETE /v1/organizations/{org_id}/crm/contacts/{contact_id}": {
|
|
12958
|
+
params: DeleteCrmContactParams;
|
|
12959
|
+
response: void;
|
|
12960
|
+
};
|
|
12961
|
+
"GET /v1/organizations/{org_id}/crm/deals": {
|
|
12962
|
+
params: ListCrmDealsParams;
|
|
12963
|
+
response: ListCrmDealsStatus200;
|
|
12964
|
+
};
|
|
12965
|
+
"POST /v1/organizations/{org_id}/crm/deals": {
|
|
12966
|
+
params: CreateCrmDealParams;
|
|
12967
|
+
response: CreateCrmDealStatus201;
|
|
12968
|
+
};
|
|
12969
|
+
"GET /v1/organizations/{org_id}/crm/pipeline": {
|
|
12970
|
+
params: GetCrmPipelineParams;
|
|
12971
|
+
response: GetCrmPipelineStatus200;
|
|
12972
|
+
};
|
|
12973
|
+
"GET /v1/organizations/{org_id}/crm/deals/{deal_id}": {
|
|
12974
|
+
params: GetCrmDealParams;
|
|
12975
|
+
response: GetCrmDealStatus200;
|
|
12976
|
+
};
|
|
12977
|
+
"PUT /v1/organizations/{org_id}/crm/deals/{deal_id}": {
|
|
12978
|
+
params: UpdateCrmDealParams;
|
|
12979
|
+
response: UpdateCrmDealStatus200;
|
|
12980
|
+
};
|
|
12981
|
+
"DELETE /v1/organizations/{org_id}/crm/deals/{deal_id}": {
|
|
12982
|
+
params: DeleteCrmDealParams;
|
|
12983
|
+
response: void;
|
|
12984
|
+
};
|
|
12985
|
+
"GET /v1/organizations/{org_id}/crm/research-tasks": {
|
|
12986
|
+
params: ListCrmResearchTasksParams;
|
|
12987
|
+
response: ListCrmResearchTasksStatus200;
|
|
12988
|
+
};
|
|
12989
|
+
"POST /v1/organizations/{org_id}/crm/research-tasks": {
|
|
12990
|
+
params: CreateCrmResearchTaskParams;
|
|
12991
|
+
response: CreateCrmResearchTaskStatus201;
|
|
12992
|
+
};
|
|
12993
|
+
"GET /v1/organizations/{org_id}/crm/research-tasks/{task_id}": {
|
|
12994
|
+
params: GetCrmResearchTaskParams;
|
|
12995
|
+
response: GetCrmResearchTaskStatus200;
|
|
12996
|
+
};
|
|
12997
|
+
"POST /v1/organizations/{org_id}/crm/research-tasks/{task_id}/cancel": {
|
|
12998
|
+
params: CancelCrmResearchTaskParams;
|
|
12999
|
+
response: CancelCrmResearchTaskStatus200;
|
|
13000
|
+
};
|
|
13001
|
+
"GET /v1/organizations/{org_id}/crm/context": {
|
|
13002
|
+
params: GetCrmContextParams;
|
|
13003
|
+
response: GetCrmContextStatus200;
|
|
13004
|
+
};
|
|
13005
|
+
"PUT /v1/organizations/{org_id}/crm/context": {
|
|
13006
|
+
params: UpdateCrmContextParams;
|
|
13007
|
+
response: UpdateCrmContextStatus200;
|
|
13008
|
+
};
|
|
13009
|
+
"POST /v1/organizations/{org_id}/crm/research-tasks/{task_id}/approve": {
|
|
13010
|
+
params: ApproveCrmResearchTaskParams;
|
|
13011
|
+
response: ApproveCrmResearchTaskStatus200;
|
|
13012
|
+
};
|
|
13013
|
+
"GET /v1/organizations/{org_id}/crm/artifacts": {
|
|
13014
|
+
params: ListCrmArtifactsParams;
|
|
13015
|
+
response: ListCrmArtifactsStatus200;
|
|
13016
|
+
};
|
|
13017
|
+
"GET /v1/organizations/{org_id}/crm/artifacts/{artifact_id}": {
|
|
13018
|
+
params: GetCrmArtifactParams;
|
|
13019
|
+
response: GetCrmArtifactStatus200;
|
|
13020
|
+
};
|
|
13021
|
+
"GET /v1/organizations/{org_id}/crm/activities": {
|
|
13022
|
+
params: ListCrmActivitiesParams;
|
|
13023
|
+
response: ListCrmActivitiesStatus200;
|
|
13024
|
+
};
|
|
10133
13025
|
"GET /v1/projects/{project_id}/databases": {
|
|
10134
13026
|
params: ListDatabasesParams;
|
|
10135
13027
|
response: ListDatabasesStatus200;
|
|
@@ -10290,6 +13182,18 @@ interface RequestMap {
|
|
|
10290
13182
|
params: DeleteReplicaParams;
|
|
10291
13183
|
response: void;
|
|
10292
13184
|
};
|
|
13185
|
+
"GET /v1/projects/{project_id}/schema-annotations": {
|
|
13186
|
+
params: ListSchemaAnnotationsParams;
|
|
13187
|
+
response: ListSchemaAnnotationsStatus200;
|
|
13188
|
+
};
|
|
13189
|
+
"PUT /v1/projects/{project_id}/schema-annotations": {
|
|
13190
|
+
params: PutSchemaAnnotationParams;
|
|
13191
|
+
response: PutSchemaAnnotationStatus200;
|
|
13192
|
+
};
|
|
13193
|
+
"DELETE /v1/projects/{project_id}/schema-annotations": {
|
|
13194
|
+
params: DeleteSchemaAnnotationParams;
|
|
13195
|
+
response: void;
|
|
13196
|
+
};
|
|
10293
13197
|
"GET /v1/organizations/{org_id}/self-host-enrollments": {
|
|
10294
13198
|
params: ListSelfHostEnrollmentsParams;
|
|
10295
13199
|
response: ListSelfHostEnrollmentsStatus200;
|