@workbuddy/sdk-js-vnext 1.0.158 → 1.0.159

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.
Files changed (3) hide show
  1. package/index.d.ts +423 -1
  2. package/index.js +183 -3
  3. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -6714,6 +6714,263 @@ export interface WorkBuddyWebhooksDeleteParams extends WorkBuddyRequestParams {
6714
6714
  id: string;
6715
6715
  }
6716
6716
 
6717
+ export interface WorkBuddyWebhooksJobsRegisterJobParams extends WorkBuddyRequestParams {
6718
+ /**
6719
+ * Display name
6720
+ */
6721
+ name: string;
6722
+ /**
6723
+ * Webhook callback URL
6724
+ */
6725
+ url: string;
6726
+ /**
6727
+ * Event names to subscribe to
6728
+ */
6729
+ events: ('Job Created' | 'Job Updated' | 'Job Status Changed')[];
6730
+
6731
+ filters?: {
6732
+ customer?: string[];
6733
+ billingCompany?: string[];
6734
+ tag?: string[];
6735
+ site?: string[];
6736
+ type?: string[];
6737
+ priority?: string[];
6738
+ owner?: string[];
6739
+ zone?: string[];
6740
+ status?: { match: 'id' | 'systemStatus' | 'systemName'; value: string }[];
6741
+ fieldSupervisor?: string[];
6742
+ priceBook?: string[];
6743
+ timezone?: string[];
6744
+ state?: string[];
6745
+ };
6746
+
6747
+ businessHours?: { enabled: boolean; timezone?: string };
6748
+
6749
+ workflow?: { platform: 'activepieces' | 'n8n' | 'zapier' | 'custom'; integrationId: string; flowId?: string };
6750
+ }
6751
+
6752
+ export interface WorkBuddyWebhooksStagesRegisterStageParams extends WorkBuddyRequestParams {
6753
+ /**
6754
+ * Display name
6755
+ */
6756
+ name: string;
6757
+ /**
6758
+ * Webhook callback URL
6759
+ */
6760
+ url: string;
6761
+ /**
6762
+ * Event names to subscribe to
6763
+ */
6764
+ events: ('Stage Created' | 'Stage Updated' | 'Stage Status Changed' | 'Stage Deleted')[];
6765
+
6766
+ filters?: {
6767
+ customer?: string[];
6768
+ billingCompany?: string[];
6769
+ tag?: string[];
6770
+ resource?: string[];
6771
+ workCategory?: string[];
6772
+ stageStatus?: { match: 'id' | 'systemStatus' | 'systemName'; value: string }[];
6773
+ schedulingTag?: string[];
6774
+ fieldSupervisor?: string[];
6775
+ priceBook?: string[];
6776
+ zone?: string[];
6777
+ timezone?: string[];
6778
+ state?: string[];
6779
+ };
6780
+
6781
+ businessHours?: { enabled: boolean; timezone?: string };
6782
+
6783
+ workflow?: { platform: 'activepieces' | 'n8n' | 'zapier' | 'custom'; integrationId: string; flowId?: string };
6784
+ }
6785
+
6786
+ export interface WorkBuddyWebhooksActivitiesRegisterActivityParams extends WorkBuddyRequestParams {
6787
+ /**
6788
+ * Display name
6789
+ */
6790
+ name: string;
6791
+ /**
6792
+ * Webhook callback URL
6793
+ */
6794
+ url: string;
6795
+ /**
6796
+ * Event names to subscribe to
6797
+ */
6798
+ events: ('Activity Created' | 'Activity Updated' | 'Activity Deleted')[];
6799
+
6800
+ filters?: { activityEntity?: string[]; activityKind?: string[]; activityType?: string[] };
6801
+
6802
+ businessHours?: { enabled: boolean; timezone?: string };
6803
+
6804
+ workflow?: { platform: 'activepieces' | 'n8n' | 'zapier' | 'custom'; integrationId: string; flowId?: string };
6805
+ }
6806
+
6807
+ export interface WorkBuddyWebhooksInvoicesRegisterInvoiceParams extends WorkBuddyRequestParams {
6808
+ /**
6809
+ * Display name
6810
+ */
6811
+ name: string;
6812
+ /**
6813
+ * Webhook callback URL
6814
+ */
6815
+ url: string;
6816
+ /**
6817
+ * Event names to subscribe to
6818
+ */
6819
+ events: ('Invoice Created' | 'Invoice Status Changed')[];
6820
+
6821
+ filters?: {
6822
+ customer?: string[];
6823
+ billingCompany?: string[];
6824
+ tag?: string[];
6825
+ status?: { match: 'id' | 'systemStatus' | 'systemName'; value: string }[];
6826
+ priceBook?: string[];
6827
+ };
6828
+
6829
+ businessHours?: { enabled: boolean; timezone?: string };
6830
+
6831
+ workflow?: { platform: 'activepieces' | 'n8n' | 'zapier' | 'custom'; integrationId: string; flowId?: string };
6832
+ }
6833
+
6834
+ export interface WorkBuddyWebhooksBillsRegisterBillParams extends WorkBuddyRequestParams {
6835
+ /**
6836
+ * Display name
6837
+ */
6838
+ name: string;
6839
+ /**
6840
+ * Webhook callback URL
6841
+ */
6842
+ url: string;
6843
+ /**
6844
+ * Event names to subscribe to
6845
+ */
6846
+ events: ('Bill Created' | 'Bill Status Changed')[];
6847
+
6848
+ filters?: {
6849
+ customer?: string[];
6850
+ billingCompany?: string[];
6851
+ tag?: string[];
6852
+ status?: { match: 'id' | 'systemStatus' | 'systemName'; value: string }[];
6853
+ priceBook?: string[];
6854
+ };
6855
+
6856
+ businessHours?: { enabled: boolean; timezone?: string };
6857
+
6858
+ workflow?: { platform: 'activepieces' | 'n8n' | 'zapier' | 'custom'; integrationId: string; flowId?: string };
6859
+ }
6860
+
6861
+ export interface WorkBuddyWebhooksQuotesRegisterQuoteParams extends WorkBuddyRequestParams {
6862
+ /**
6863
+ * Display name
6864
+ */
6865
+ name: string;
6866
+ /**
6867
+ * Webhook callback URL
6868
+ */
6869
+ url: string;
6870
+ /**
6871
+ * Event names to subscribe to
6872
+ */
6873
+ events: ('Quote Created' | 'Quote Updated' | 'Quote Status Changed' | 'Quote Deleted')[];
6874
+
6875
+ filters?: {
6876
+ owner?: string[];
6877
+ customer?: string[];
6878
+ billingCompany?: string[];
6879
+ tag?: string[];
6880
+ status?: { match: 'id' | 'systemStatus' | 'systemName'; value: string }[];
6881
+ priceBook?: string[];
6882
+ timezone?: string[];
6883
+ state?: string[];
6884
+ };
6885
+
6886
+ businessHours?: { enabled: boolean; timezone?: string };
6887
+
6888
+ workflow?: { platform: 'activepieces' | 'n8n' | 'zapier' | 'custom'; integrationId: string; flowId?: string };
6889
+ }
6890
+
6891
+ export interface WorkBuddyWebhooksOpportunitiesRegisterOpportunityParams extends WorkBuddyRequestParams {
6892
+ /**
6893
+ * Display name
6894
+ */
6895
+ name: string;
6896
+ /**
6897
+ * Webhook callback URL
6898
+ */
6899
+ url: string;
6900
+ /**
6901
+ * Event names to subscribe to
6902
+ */
6903
+ events: ('Opportunity Created' | 'Opportunity Updated' | 'Opportunity Status Changed' | 'Opportunity Deleted')[];
6904
+
6905
+ filters?: {
6906
+ customer?: string[];
6907
+ billingCompany?: string[];
6908
+ tag?: string[];
6909
+ opportunityStage?: string[];
6910
+ owner?: string[];
6911
+ zone?: string[];
6912
+ timezone?: string[];
6913
+ state?: string[];
6914
+ };
6915
+
6916
+ businessHours?: { enabled: boolean; timezone?: string };
6917
+
6918
+ workflow?: { platform: 'activepieces' | 'n8n' | 'zapier' | 'custom'; integrationId: string; flowId?: string };
6919
+ }
6920
+
6921
+ export interface WorkBuddyWebhooksLeadsRegisterLeadParams extends WorkBuddyRequestParams {
6922
+ /**
6923
+ * Display name
6924
+ */
6925
+ name: string;
6926
+ /**
6927
+ * Webhook callback URL
6928
+ */
6929
+ url: string;
6930
+ /**
6931
+ * Event names to subscribe to
6932
+ */
6933
+ events: ('Lead Created' | 'Lead Updated' | 'Lead Status Changed' | 'Lead Deleted' | 'Lead Converted')[];
6934
+
6935
+ filters?: {
6936
+ customer?: string[];
6937
+ billingCompany?: string[];
6938
+ tag?: string[];
6939
+ leadStage?: string[];
6940
+ leadSource?: string[];
6941
+ owner?: string[];
6942
+ type?: string[];
6943
+ zone?: string[];
6944
+ timezone?: string[];
6945
+ state?: string[];
6946
+ };
6947
+
6948
+ businessHours?: { enabled: boolean; timezone?: string };
6949
+
6950
+ workflow?: { platform: 'activepieces' | 'n8n' | 'zapier' | 'custom'; integrationId: string; flowId?: string };
6951
+ }
6952
+
6953
+ export interface WorkBuddyWebhooksTasksRegisterTaskParams extends WorkBuddyRequestParams {
6954
+ /**
6955
+ * Display name
6956
+ */
6957
+ name: string;
6958
+ /**
6959
+ * Webhook callback URL
6960
+ */
6961
+ url: string;
6962
+ /**
6963
+ * Event names to subscribe to
6964
+ */
6965
+ events: ('Task Created' | 'Task Updated' | 'Task Status Changed' | 'Task Deleted')[];
6966
+
6967
+ filters?: { tag?: string[] };
6968
+
6969
+ businessHours?: { enabled: boolean; timezone?: string };
6970
+
6971
+ workflow?: { platform: 'activepieces' | 'n8n' | 'zapier' | 'custom'; integrationId: string; flowId?: string };
6972
+ }
6973
+
6717
6974
  export interface WorkBuddyWebhooksRegenerateSecretRegenerateSecretParams extends WorkBuddyRequestParams {
6718
6975
  /**
6719
6976
  * Entity ID
@@ -16482,6 +16739,7 @@ export type WorkBuddyJobsActivitiesGetResponse = {
16482
16739
  | 'agent'
16483
16740
  | 'system'
16484
16741
  | 'thread';
16742
+ parent?: string;
16485
16743
  body?: string;
16486
16744
  attachments?: string;
16487
16745
  createdAt?: string;
@@ -16505,6 +16763,7 @@ export type WorkBuddyJobsActivitiesNoteCreateNoteResponse = {
16505
16763
  | 'agent'
16506
16764
  | 'system'
16507
16765
  | 'thread';
16766
+ parent?: string;
16508
16767
  body?: string;
16509
16768
  attachments?: string;
16510
16769
  createdAt?: string;
@@ -16527,6 +16786,7 @@ export type WorkBuddyJobsActivitiesEmailCreateEmailResponse = {
16527
16786
  | 'agent'
16528
16787
  | 'system'
16529
16788
  | 'thread';
16789
+ parent?: string;
16530
16790
  body?: string;
16531
16791
  attachments?: string;
16532
16792
  createdAt?: string;
@@ -16549,6 +16809,7 @@ export type WorkBuddyJobsActivitiesSmsCreateSmsResponse = {
16549
16809
  | 'agent'
16550
16810
  | 'system'
16551
16811
  | 'thread';
16812
+ parent?: string;
16552
16813
  body?: string;
16553
16814
  attachments?: string;
16554
16815
  createdAt?: string;
@@ -16645,6 +16906,7 @@ export type WorkBuddyJobsActivitiesPhoneCreatePhoneResponse = {
16645
16906
  | 'agent'
16646
16907
  | 'system'
16647
16908
  | 'thread';
16909
+ parent?: string;
16648
16910
  body?: string;
16649
16911
  attachments?: string;
16650
16912
  createdAt?: string;
@@ -16667,6 +16929,7 @@ export type WorkBuddyJobsActivitiesIntegrationCreateIntegrationResponse = {
16667
16929
  | 'agent'
16668
16930
  | 'system'
16669
16931
  | 'thread';
16932
+ parent?: string;
16670
16933
  body?: string;
16671
16934
  attachments?: string;
16672
16935
  createdAt?: string;
@@ -16689,6 +16952,7 @@ export type WorkBuddyJobsActivitiesThreadCreateThreadResponse = {
16689
16952
  | 'agent'
16690
16953
  | 'system'
16691
16954
  | 'thread';
16955
+ parent?: string;
16692
16956
  body?: string;
16693
16957
  attachments?: string;
16694
16958
  createdAt?: string;
@@ -16732,6 +16996,7 @@ export type WorkBuddyJobsStagesActivitiesGetResponse = {
16732
16996
  | 'agent'
16733
16997
  | 'system'
16734
16998
  | 'thread';
16999
+ parent?: string;
16735
17000
  body?: string;
16736
17001
  attachments?: string;
16737
17002
  createdAt?: string;
@@ -16755,6 +17020,7 @@ export type WorkBuddyJobsStagesActivitiesNoteCreateNoteResponse = {
16755
17020
  | 'agent'
16756
17021
  | 'system'
16757
17022
  | 'thread';
17023
+ parent?: string;
16758
17024
  body?: string;
16759
17025
  attachments?: string;
16760
17026
  createdAt?: string;
@@ -16777,6 +17043,7 @@ export type WorkBuddyJobsStagesActivitiesEmailCreateEmailResponse = {
16777
17043
  | 'agent'
16778
17044
  | 'system'
16779
17045
  | 'thread';
17046
+ parent?: string;
16780
17047
  body?: string;
16781
17048
  attachments?: string;
16782
17049
  createdAt?: string;
@@ -16799,6 +17066,7 @@ export type WorkBuddyJobsStagesActivitiesSmsCreateSmsResponse = {
16799
17066
  | 'agent'
16800
17067
  | 'system'
16801
17068
  | 'thread';
17069
+ parent?: string;
16802
17070
  body?: string;
16803
17071
  attachments?: string;
16804
17072
  createdAt?: string;
@@ -16895,6 +17163,7 @@ export type WorkBuddyJobsStagesActivitiesPhoneCreatePhoneResponse = {
16895
17163
  | 'agent'
16896
17164
  | 'system'
16897
17165
  | 'thread';
17166
+ parent?: string;
16898
17167
  body?: string;
16899
17168
  attachments?: string;
16900
17169
  createdAt?: string;
@@ -16917,6 +17186,7 @@ export type WorkBuddyJobsStagesActivitiesIntegrationCreateIntegrationResponse =
16917
17186
  | 'agent'
16918
17187
  | 'system'
16919
17188
  | 'thread';
17189
+ parent?: string;
16920
17190
  body?: string;
16921
17191
  attachments?: string;
16922
17192
  createdAt?: string;
@@ -16939,6 +17209,7 @@ export type WorkBuddyJobsStagesActivitiesThreadCreateThreadResponse = {
16939
17209
  | 'agent'
16940
17210
  | 'system'
16941
17211
  | 'thread';
17212
+ parent?: string;
16942
17213
  body?: string;
16943
17214
  attachments?: string;
16944
17215
  createdAt?: string;
@@ -16950,6 +17221,8 @@ export type WorkBuddyJobsStagesActivitiesThreadCreateThreadResponse = {
16950
17221
  export type WorkBuddyJobsFilesListResponse = {
16951
17222
  items: {
16952
17223
  id: string;
17224
+ kind?: string;
17225
+ parent?: string;
16953
17226
  title: string;
16954
17227
  attachments: {
16955
17228
  id: string;
@@ -16969,6 +17242,8 @@ export type WorkBuddyJobsFilesListResponse = {
16969
17242
  };
16970
17243
  export type WorkBuddyJobsFilesCreateResponse = {
16971
17244
  id: string;
17245
+ kind?: string;
17246
+ parent?: string;
16972
17247
  title: string;
16973
17248
  attachments: {
16974
17249
  id: string;
@@ -16986,6 +17261,8 @@ export type WorkBuddyJobsFilesCreateResponse = {
16986
17261
  };
16987
17262
  export type WorkBuddyJobsFilesGetResponse = {
16988
17263
  id: string;
17264
+ kind?: string;
17265
+ parent?: string;
16989
17266
  title: string;
16990
17267
  attachments: {
16991
17268
  id: string;
@@ -17005,6 +17282,8 @@ export type WorkBuddyJobsFilesDeleteResponse = { deleted: boolean };
17005
17282
  export type WorkBuddyJobsStagesFilesListResponse = {
17006
17283
  items: {
17007
17284
  id: string;
17285
+ kind?: string;
17286
+ parent?: string;
17008
17287
  title: string;
17009
17288
  attachments: {
17010
17289
  id: string;
@@ -17024,6 +17303,8 @@ export type WorkBuddyJobsStagesFilesListResponse = {
17024
17303
  };
17025
17304
  export type WorkBuddyJobsStagesFilesCreateResponse = {
17026
17305
  id: string;
17306
+ kind?: string;
17307
+ parent?: string;
17027
17308
  title: string;
17028
17309
  attachments: {
17029
17310
  id: string;
@@ -17041,6 +17322,8 @@ export type WorkBuddyJobsStagesFilesCreateResponse = {
17041
17322
  };
17042
17323
  export type WorkBuddyJobsStagesFilesGetResponse = {
17043
17324
  id: string;
17325
+ kind?: string;
17326
+ parent?: string;
17044
17327
  title: string;
17045
17328
  attachments: {
17046
17329
  id: string;
@@ -19910,6 +20193,15 @@ export type WorkBuddyWebhooksCreateResponse = unknown;
19910
20193
  export type WorkBuddyWebhooksGetResponse = unknown;
19911
20194
  export type WorkBuddyWebhooksUpdateResponse = unknown;
19912
20195
  export type WorkBuddyWebhooksDeleteResponse = unknown;
20196
+ export type WorkBuddyWebhooksJobsRegisterJobResponse = unknown;
20197
+ export type WorkBuddyWebhooksStagesRegisterStageResponse = unknown;
20198
+ export type WorkBuddyWebhooksActivitiesRegisterActivityResponse = unknown;
20199
+ export type WorkBuddyWebhooksInvoicesRegisterInvoiceResponse = unknown;
20200
+ export type WorkBuddyWebhooksBillsRegisterBillResponse = unknown;
20201
+ export type WorkBuddyWebhooksQuotesRegisterQuoteResponse = unknown;
20202
+ export type WorkBuddyWebhooksOpportunitiesRegisterOpportunityResponse = unknown;
20203
+ export type WorkBuddyWebhooksLeadsRegisterLeadResponse = unknown;
20204
+ export type WorkBuddyWebhooksTasksRegisterTaskResponse = unknown;
19913
20205
  export type WorkBuddyWebhooksRegenerateSecretRegenerateSecretResponse = unknown;
19914
20206
  export type WorkBuddyWebhooksTestTestResponse = unknown;
19915
20207
  export type WorkBuddyWebhooksDeliveriesListResponse = unknown;
@@ -22492,6 +22784,7 @@ export type WorkBuddyQuotesActivitiesGetResponse = {
22492
22784
  | 'agent'
22493
22785
  | 'system'
22494
22786
  | 'thread';
22787
+ parent?: string;
22495
22788
  body?: string;
22496
22789
  attachments?: string;
22497
22790
  createdAt?: string;
@@ -22515,6 +22808,7 @@ export type WorkBuddyQuotesActivitiesNoteCreateNoteResponse = {
22515
22808
  | 'agent'
22516
22809
  | 'system'
22517
22810
  | 'thread';
22811
+ parent?: string;
22518
22812
  body?: string;
22519
22813
  attachments?: string;
22520
22814
  createdAt?: string;
@@ -22537,6 +22831,7 @@ export type WorkBuddyQuotesActivitiesEmailCreateEmailResponse = {
22537
22831
  | 'agent'
22538
22832
  | 'system'
22539
22833
  | 'thread';
22834
+ parent?: string;
22540
22835
  body?: string;
22541
22836
  attachments?: string;
22542
22837
  createdAt?: string;
@@ -22559,6 +22854,7 @@ export type WorkBuddyQuotesActivitiesSmsCreateSmsResponse = {
22559
22854
  | 'agent'
22560
22855
  | 'system'
22561
22856
  | 'thread';
22857
+ parent?: string;
22562
22858
  body?: string;
22563
22859
  attachments?: string;
22564
22860
  createdAt?: string;
@@ -22655,6 +22951,7 @@ export type WorkBuddyQuotesActivitiesPhoneCreatePhoneResponse = {
22655
22951
  | 'agent'
22656
22952
  | 'system'
22657
22953
  | 'thread';
22954
+ parent?: string;
22658
22955
  body?: string;
22659
22956
  attachments?: string;
22660
22957
  createdAt?: string;
@@ -22677,6 +22974,7 @@ export type WorkBuddyQuotesActivitiesIntegrationCreateIntegrationResponse = {
22677
22974
  | 'agent'
22678
22975
  | 'system'
22679
22976
  | 'thread';
22977
+ parent?: string;
22680
22978
  body?: string;
22681
22979
  attachments?: string;
22682
22980
  createdAt?: string;
@@ -22699,6 +22997,7 @@ export type WorkBuddyQuotesActivitiesThreadCreateThreadResponse = {
22699
22997
  | 'agent'
22700
22998
  | 'system'
22701
22999
  | 'thread';
23000
+ parent?: string;
22702
23001
  body?: string;
22703
23002
  attachments?: string;
22704
23003
  createdAt?: string;
@@ -22759,6 +23058,8 @@ export type WorkBuddyQuotesContactsDeleteResponse = { deleted: boolean };
22759
23058
  export type WorkBuddyQuotesFilesListResponse = {
22760
23059
  items: {
22761
23060
  id: string;
23061
+ kind?: string;
23062
+ parent?: string;
22762
23063
  title: string;
22763
23064
  attachments: {
22764
23065
  id: string;
@@ -22778,6 +23079,8 @@ export type WorkBuddyQuotesFilesListResponse = {
22778
23079
  };
22779
23080
  export type WorkBuddyQuotesFilesCreateResponse = {
22780
23081
  id: string;
23082
+ kind?: string;
23083
+ parent?: string;
22781
23084
  title: string;
22782
23085
  attachments: {
22783
23086
  id: string;
@@ -22795,6 +23098,8 @@ export type WorkBuddyQuotesFilesCreateResponse = {
22795
23098
  };
22796
23099
  export type WorkBuddyQuotesFilesGetResponse = {
22797
23100
  id: string;
23101
+ kind?: string;
23102
+ parent?: string;
22798
23103
  title: string;
22799
23104
  attachments: {
22800
23105
  id: string;
@@ -26652,6 +26957,24 @@ export interface WorkBuddyCrmSitesContactsResource {
26652
26957
  export interface WorkBuddyWebhooksResource {
26653
26958
  /** Entities API operations. */
26654
26959
  entities: WorkBuddyWebhooksEntitiesResource;
26960
+ /** Jobs API operations. */
26961
+ jobs: WorkBuddyWebhooksJobsResource;
26962
+ /** Stages API operations. */
26963
+ stages: WorkBuddyWebhooksStagesResource;
26964
+ /** Activities API operations. */
26965
+ activities: WorkBuddyWebhooksActivitiesResource;
26966
+ /** Invoices API operations. */
26967
+ invoices: WorkBuddyWebhooksInvoicesResource;
26968
+ /** Bills API operations. */
26969
+ bills: WorkBuddyWebhooksBillsResource;
26970
+ /** Quotes API operations. */
26971
+ quotes: WorkBuddyWebhooksQuotesResource;
26972
+ /** Opportunities API operations. */
26973
+ opportunities: WorkBuddyWebhooksOpportunitiesResource;
26974
+ /** Leads API operations. */
26975
+ leads: WorkBuddyWebhooksLeadsResource;
26976
+ /** Tasks API operations. */
26977
+ tasks: WorkBuddyWebhooksTasksResource;
26655
26978
  /** Regenerate Secret API operations. */
26656
26979
  regenerateSecret: WorkBuddyWebhooksRegenerateSecretResource;
26657
26980
  /** Test API operations. */
@@ -26741,6 +27064,105 @@ export interface WorkBuddyWebhooksEntitiesFiltersResource {
26741
27064
  ): Promise<TResponse>;
26742
27065
  }
26743
27066
 
27067
+ export interface WorkBuddyWebhooksJobsResource {
27068
+ /**
27069
+ * Register a job webhook
27070
+ * Operation: PublicApiWebhookV2Controller_registerJob
27071
+ */
27072
+ registerJob<TResponse = WorkBuddyWebhooksJobsRegisterJobResponse>(
27073
+ params: WorkBuddyWebhooksJobsRegisterJobParams,
27074
+ options?: WorkBuddyRequestOptions
27075
+ ): Promise<TResponse>;
27076
+ }
27077
+
27078
+ export interface WorkBuddyWebhooksStagesResource {
27079
+ /**
27080
+ * Register a stage webhook
27081
+ * Operation: PublicApiWebhookV2Controller_registerStage
27082
+ */
27083
+ registerStage<TResponse = WorkBuddyWebhooksStagesRegisterStageResponse>(
27084
+ params: WorkBuddyWebhooksStagesRegisterStageParams,
27085
+ options?: WorkBuddyRequestOptions
27086
+ ): Promise<TResponse>;
27087
+ }
27088
+
27089
+ export interface WorkBuddyWebhooksActivitiesResource {
27090
+ /**
27091
+ * Register a activity webhook
27092
+ * Operation: PublicApiWebhookV2Controller_registerActivity
27093
+ */
27094
+ registerActivity<TResponse = WorkBuddyWebhooksActivitiesRegisterActivityResponse>(
27095
+ params: WorkBuddyWebhooksActivitiesRegisterActivityParams,
27096
+ options?: WorkBuddyRequestOptions
27097
+ ): Promise<TResponse>;
27098
+ }
27099
+
27100
+ export interface WorkBuddyWebhooksInvoicesResource {
27101
+ /**
27102
+ * Register a invoice webhook
27103
+ * Operation: PublicApiWebhookV2Controller_registerInvoice
27104
+ */
27105
+ registerInvoice<TResponse = WorkBuddyWebhooksInvoicesRegisterInvoiceResponse>(
27106
+ params: WorkBuddyWebhooksInvoicesRegisterInvoiceParams,
27107
+ options?: WorkBuddyRequestOptions
27108
+ ): Promise<TResponse>;
27109
+ }
27110
+
27111
+ export interface WorkBuddyWebhooksBillsResource {
27112
+ /**
27113
+ * Register a bill webhook
27114
+ * Operation: PublicApiWebhookV2Controller_registerBill
27115
+ */
27116
+ registerBill<TResponse = WorkBuddyWebhooksBillsRegisterBillResponse>(
27117
+ params: WorkBuddyWebhooksBillsRegisterBillParams,
27118
+ options?: WorkBuddyRequestOptions
27119
+ ): Promise<TResponse>;
27120
+ }
27121
+
27122
+ export interface WorkBuddyWebhooksQuotesResource {
27123
+ /**
27124
+ * Register a quote webhook
27125
+ * Operation: PublicApiWebhookV2Controller_registerQuote
27126
+ */
27127
+ registerQuote<TResponse = WorkBuddyWebhooksQuotesRegisterQuoteResponse>(
27128
+ params: WorkBuddyWebhooksQuotesRegisterQuoteParams,
27129
+ options?: WorkBuddyRequestOptions
27130
+ ): Promise<TResponse>;
27131
+ }
27132
+
27133
+ export interface WorkBuddyWebhooksOpportunitiesResource {
27134
+ /**
27135
+ * Register a opportunity webhook
27136
+ * Operation: PublicApiWebhookV2Controller_registerOpportunity
27137
+ */
27138
+ registerOpportunity<TResponse = WorkBuddyWebhooksOpportunitiesRegisterOpportunityResponse>(
27139
+ params: WorkBuddyWebhooksOpportunitiesRegisterOpportunityParams,
27140
+ options?: WorkBuddyRequestOptions
27141
+ ): Promise<TResponse>;
27142
+ }
27143
+
27144
+ export interface WorkBuddyWebhooksLeadsResource {
27145
+ /**
27146
+ * Register a lead webhook
27147
+ * Operation: PublicApiWebhookV2Controller_registerLead
27148
+ */
27149
+ registerLead<TResponse = WorkBuddyWebhooksLeadsRegisterLeadResponse>(
27150
+ params: WorkBuddyWebhooksLeadsRegisterLeadParams,
27151
+ options?: WorkBuddyRequestOptions
27152
+ ): Promise<TResponse>;
27153
+ }
27154
+
27155
+ export interface WorkBuddyWebhooksTasksResource {
27156
+ /**
27157
+ * Register a task webhook
27158
+ * Operation: PublicApiWebhookV2Controller_registerTask
27159
+ */
27160
+ registerTask<TResponse = WorkBuddyWebhooksTasksRegisterTaskResponse>(
27161
+ params: WorkBuddyWebhooksTasksRegisterTaskParams,
27162
+ options?: WorkBuddyRequestOptions
27163
+ ): Promise<TResponse>;
27164
+ }
27165
+
26744
27166
  export interface WorkBuddyWebhooksRegenerateSecretResource {
26745
27167
  /**
26746
27168
  * Regenerate the signing secret for a webhook subscription
@@ -26754,7 +27176,7 @@ export interface WorkBuddyWebhooksRegenerateSecretResource {
26754
27176
 
26755
27177
  export interface WorkBuddyWebhooksTestResource {
26756
27178
  /**
26757
- * Send a test event to a webhook subscription
27179
+ * Queue a signed webhook.test event for this subscription
26758
27180
  * Operation: PublicApiWebhookV2Controller_test
26759
27181
  */
26760
27182
  test<TResponse = WorkBuddyWebhooksTestTestResponse>(
package/index.js CHANGED
@@ -1638,6 +1638,78 @@ Requires scope: settings:read
1638
1638
  */
1639
1639
  list: (params = {}, options = {}) => this.request('PublicApiWebhookV2Controller_listEntities', params, options),
1640
1640
  },
1641
+ jobs: {
1642
+ /**
1643
+ * Register a job webhook
1644
+ * Operation: PublicApiWebhookV2Controller_registerJob
1645
+ */
1646
+ registerJob: (params = {}, options = {}) =>
1647
+ this.request('PublicApiWebhookV2Controller_registerJob', params, options),
1648
+ },
1649
+ stages: {
1650
+ /**
1651
+ * Register a stage webhook
1652
+ * Operation: PublicApiWebhookV2Controller_registerStage
1653
+ */
1654
+ registerStage: (params = {}, options = {}) =>
1655
+ this.request('PublicApiWebhookV2Controller_registerStage', params, options),
1656
+ },
1657
+ activities: {
1658
+ /**
1659
+ * Register a activity webhook
1660
+ * Operation: PublicApiWebhookV2Controller_registerActivity
1661
+ */
1662
+ registerActivity: (params = {}, options = {}) =>
1663
+ this.request('PublicApiWebhookV2Controller_registerActivity', params, options),
1664
+ },
1665
+ invoices: {
1666
+ /**
1667
+ * Register a invoice webhook
1668
+ * Operation: PublicApiWebhookV2Controller_registerInvoice
1669
+ */
1670
+ registerInvoice: (params = {}, options = {}) =>
1671
+ this.request('PublicApiWebhookV2Controller_registerInvoice', params, options),
1672
+ },
1673
+ bills: {
1674
+ /**
1675
+ * Register a bill webhook
1676
+ * Operation: PublicApiWebhookV2Controller_registerBill
1677
+ */
1678
+ registerBill: (params = {}, options = {}) =>
1679
+ this.request('PublicApiWebhookV2Controller_registerBill', params, options),
1680
+ },
1681
+ quotes: {
1682
+ /**
1683
+ * Register a quote webhook
1684
+ * Operation: PublicApiWebhookV2Controller_registerQuote
1685
+ */
1686
+ registerQuote: (params = {}, options = {}) =>
1687
+ this.request('PublicApiWebhookV2Controller_registerQuote', params, options),
1688
+ },
1689
+ opportunities: {
1690
+ /**
1691
+ * Register a opportunity webhook
1692
+ * Operation: PublicApiWebhookV2Controller_registerOpportunity
1693
+ */
1694
+ registerOpportunity: (params = {}, options = {}) =>
1695
+ this.request('PublicApiWebhookV2Controller_registerOpportunity', params, options),
1696
+ },
1697
+ leads: {
1698
+ /**
1699
+ * Register a lead webhook
1700
+ * Operation: PublicApiWebhookV2Controller_registerLead
1701
+ */
1702
+ registerLead: (params = {}, options = {}) =>
1703
+ this.request('PublicApiWebhookV2Controller_registerLead', params, options),
1704
+ },
1705
+ tasks: {
1706
+ /**
1707
+ * Register a task webhook
1708
+ * Operation: PublicApiWebhookV2Controller_registerTask
1709
+ */
1710
+ registerTask: (params = {}, options = {}) =>
1711
+ this.request('PublicApiWebhookV2Controller_registerTask', params, options),
1712
+ },
1641
1713
  regenerateSecret: {
1642
1714
  /**
1643
1715
  * Regenerate the signing secret for a webhook subscription
@@ -1648,7 +1720,7 @@ Requires scope: settings:read
1648
1720
  },
1649
1721
  test: {
1650
1722
  /**
1651
- * Send a test event to a webhook subscription
1723
+ * Queue a signed webhook.test event for this subscription
1652
1724
  * Operation: PublicApiWebhookV2Controller_test
1653
1725
  */
1654
1726
  test: (params = {}, options = {}) => this.request('PublicApiWebhookV2Controller_test', params, options),
@@ -5500,6 +5572,114 @@ export const operations = [
5500
5572
  queryParams: [],
5501
5573
  hasRequestBody: false,
5502
5574
  },
5575
+ {
5576
+ operationId: 'PublicApiWebhookV2Controller_registerJob',
5577
+ resourcePath: ['webhooks', 'jobs'],
5578
+ actionName: 'registerJob',
5579
+ displayName: 'Register a job webhook',
5580
+ description: 'Register a job webhook',
5581
+ method: 'POST',
5582
+ path: '/webhooks/jobs',
5583
+ pathParams: [],
5584
+ queryParams: [],
5585
+ hasRequestBody: true,
5586
+ },
5587
+ {
5588
+ operationId: 'PublicApiWebhookV2Controller_registerStage',
5589
+ resourcePath: ['webhooks', 'stages'],
5590
+ actionName: 'registerStage',
5591
+ displayName: 'Register a stage webhook',
5592
+ description: 'Register a stage webhook',
5593
+ method: 'POST',
5594
+ path: '/webhooks/stages',
5595
+ pathParams: [],
5596
+ queryParams: [],
5597
+ hasRequestBody: true,
5598
+ },
5599
+ {
5600
+ operationId: 'PublicApiWebhookV2Controller_registerActivity',
5601
+ resourcePath: ['webhooks', 'activities'],
5602
+ actionName: 'registerActivity',
5603
+ displayName: 'Register a activity webhook',
5604
+ description: 'Register a activity webhook',
5605
+ method: 'POST',
5606
+ path: '/webhooks/activities',
5607
+ pathParams: [],
5608
+ queryParams: [],
5609
+ hasRequestBody: true,
5610
+ },
5611
+ {
5612
+ operationId: 'PublicApiWebhookV2Controller_registerInvoice',
5613
+ resourcePath: ['webhooks', 'invoices'],
5614
+ actionName: 'registerInvoice',
5615
+ displayName: 'Register a invoice webhook',
5616
+ description: 'Register a invoice webhook',
5617
+ method: 'POST',
5618
+ path: '/webhooks/invoices',
5619
+ pathParams: [],
5620
+ queryParams: [],
5621
+ hasRequestBody: true,
5622
+ },
5623
+ {
5624
+ operationId: 'PublicApiWebhookV2Controller_registerBill',
5625
+ resourcePath: ['webhooks', 'bills'],
5626
+ actionName: 'registerBill',
5627
+ displayName: 'Register a bill webhook',
5628
+ description: 'Register a bill webhook',
5629
+ method: 'POST',
5630
+ path: '/webhooks/bills',
5631
+ pathParams: [],
5632
+ queryParams: [],
5633
+ hasRequestBody: true,
5634
+ },
5635
+ {
5636
+ operationId: 'PublicApiWebhookV2Controller_registerQuote',
5637
+ resourcePath: ['webhooks', 'quotes'],
5638
+ actionName: 'registerQuote',
5639
+ displayName: 'Register a quote webhook',
5640
+ description: 'Register a quote webhook',
5641
+ method: 'POST',
5642
+ path: '/webhooks/quotes',
5643
+ pathParams: [],
5644
+ queryParams: [],
5645
+ hasRequestBody: true,
5646
+ },
5647
+ {
5648
+ operationId: 'PublicApiWebhookV2Controller_registerOpportunity',
5649
+ resourcePath: ['webhooks', 'opportunities'],
5650
+ actionName: 'registerOpportunity',
5651
+ displayName: 'Register a opportunity webhook',
5652
+ description: 'Register a opportunity webhook',
5653
+ method: 'POST',
5654
+ path: '/webhooks/opportunities',
5655
+ pathParams: [],
5656
+ queryParams: [],
5657
+ hasRequestBody: true,
5658
+ },
5659
+ {
5660
+ operationId: 'PublicApiWebhookV2Controller_registerLead',
5661
+ resourcePath: ['webhooks', 'leads'],
5662
+ actionName: 'registerLead',
5663
+ displayName: 'Register a lead webhook',
5664
+ description: 'Register a lead webhook',
5665
+ method: 'POST',
5666
+ path: '/webhooks/leads',
5667
+ pathParams: [],
5668
+ queryParams: [],
5669
+ hasRequestBody: true,
5670
+ },
5671
+ {
5672
+ operationId: 'PublicApiWebhookV2Controller_registerTask',
5673
+ resourcePath: ['webhooks', 'tasks'],
5674
+ actionName: 'registerTask',
5675
+ displayName: 'Register a task webhook',
5676
+ description: 'Register a task webhook',
5677
+ method: 'POST',
5678
+ path: '/webhooks/tasks',
5679
+ pathParams: [],
5680
+ queryParams: [],
5681
+ hasRequestBody: true,
5682
+ },
5503
5683
  {
5504
5684
  operationId: 'PublicApiWebhookV2Controller_regenerateSecret',
5505
5685
  resourcePath: ['webhooks', 'regenerateSecret'],
@@ -5516,8 +5696,8 @@ export const operations = [
5516
5696
  operationId: 'PublicApiWebhookV2Controller_test',
5517
5697
  resourcePath: ['webhooks', 'test'],
5518
5698
  actionName: 'test',
5519
- displayName: 'Send a test event to a webhook subscription',
5520
- description: 'Send a test event to a webhook subscription',
5699
+ displayName: 'Queue a signed webhook.test event for this subscription',
5700
+ description: 'Queue a signed webhook.test event for this subscription',
5521
5701
  method: 'POST',
5522
5702
  path: '/webhooks/{id}/test',
5523
5703
  pathParams: ['id'],
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@workbuddy/sdk-js-vnext",
3
- "version": "1.0.158",
3
+ "version": "1.0.159",
4
4
  "description": "WorkBuddy Public API JavaScript client",
5
5
  "license": "MIT",
6
6
  "type": "module",