@epilot/sdk 2.1.7 → 2.1.9
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/definitions/customer-portal-runtime.json +1 -1
- package/definitions/customer-portal.json +261 -19
- package/definitions/kanban.json +25 -1
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +8 -8
- package/dist/apis/customer-portal.d.cts +2 -2
- package/dist/apis/customer-portal.d.ts +2 -2
- package/dist/apis/customer-portal.js +2 -2
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-management.cjs +6 -6
- package/dist/apis/data-management.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/erp-integration.cjs +6 -6
- package/dist/apis/erp-integration.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.d.cts +2 -2
- package/dist/apis/kanban.d.ts +2 -2
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/{chunk-PITTHLH4.js → chunk-6D5AZZ2F.js} +3 -3
- package/dist/{chunk-4LDVICOS.cjs → chunk-FXN6IHCZ.cjs} +3 -3
- package/dist/chunk-XT54462S.js +14 -0
- package/dist/chunk-YWDWPVIC.cjs +14 -0
- package/dist/customer-portal-AEFMNNYP.cjs +7 -0
- package/dist/customer-portal-Y3GLUVMW.js +7 -0
- package/dist/{customer-portal-runtime-MRVZ7JR4.js → customer-portal-runtime-374XJ6LB.js} +1 -1
- package/dist/{customer-portal-runtime-VGK7RMLC.cjs → customer-portal-runtime-3LTXCTKD.cjs} +2 -2
- package/dist/{customer-portal.d-uN6lOpvy.d.cts → customer-portal.d-BJNWYMt9.d.cts} +221 -16
- package/dist/{customer-portal.d-uN6lOpvy.d.ts → customer-portal.d-BJNWYMt9.d.ts} +221 -16
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/dist/kanban-E2UOBVBK.cjs +7 -0
- package/dist/kanban-PMG5TXE5.js +7 -0
- package/dist/{kanban.d-CtSt3uX2.d.ts → kanban.d-B99GucT_.d.cts} +18 -3
- package/dist/{kanban.d-CtSt3uX2.d.cts → kanban.d-B99GucT_.d.ts} +18 -3
- package/docs/customer-portal.md +245 -16
- package/docs/kanban.md +39 -1
- package/package.json +1 -1
- package/dist/chunk-5NKXJA43.js +0 -14
- package/dist/chunk-COQMJFAB.cjs +0 -14
- package/dist/customer-portal-5JVN4Y5Y.js +0 -7
- package/dist/customer-portal-T7KIY3AE.cjs +0 -7
- package/dist/kanban-CHTH2ZSY.cjs +0 -7
- package/dist/kanban-HI6LL5WY.js +0 -7
|
@@ -4576,6 +4576,12 @@ declare namespace Components {
|
|
|
4576
4576
|
* 2021-02-09T12:41:43.662Z
|
|
4577
4577
|
*/
|
|
4578
4578
|
last_modified_at?: string; // date-time
|
|
4579
|
+
/**
|
|
4580
|
+
* The id of the portal
|
|
4581
|
+
* example:
|
|
4582
|
+
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
4583
|
+
*/
|
|
4584
|
+
portal_id?: string;
|
|
4579
4585
|
}
|
|
4580
4586
|
export interface PageRequest {
|
|
4581
4587
|
[name: string]: any;
|
|
@@ -7496,6 +7502,7 @@ declare namespace Paths {
|
|
|
7496
7502
|
}
|
|
7497
7503
|
namespace CheckContactExistsV3 {
|
|
7498
7504
|
namespace Parameters {
|
|
7505
|
+
export type Domain = string;
|
|
7499
7506
|
export type PortalId = /**
|
|
7500
7507
|
* ID of the portal
|
|
7501
7508
|
* example:
|
|
@@ -7504,7 +7511,8 @@ declare namespace Paths {
|
|
|
7504
7511
|
Components.Schemas.PortalId;
|
|
7505
7512
|
}
|
|
7506
7513
|
export interface QueryParameters {
|
|
7507
|
-
portal_id
|
|
7514
|
+
portal_id?: Parameters.PortalId;
|
|
7515
|
+
domain?: Parameters.Domain;
|
|
7508
7516
|
}
|
|
7509
7517
|
export type RequestBody = Components.Schemas.ContactExistsRequest;
|
|
7510
7518
|
namespace Responses {
|
|
@@ -7745,6 +7753,7 @@ declare namespace Paths {
|
|
|
7745
7753
|
}
|
|
7746
7754
|
namespace CreateUserV3 {
|
|
7747
7755
|
namespace Parameters {
|
|
7756
|
+
export type Domain = string;
|
|
7748
7757
|
export type PortalId = /**
|
|
7749
7758
|
* ID of the portal
|
|
7750
7759
|
* example:
|
|
@@ -7753,7 +7762,8 @@ declare namespace Paths {
|
|
|
7753
7762
|
Components.Schemas.PortalId;
|
|
7754
7763
|
}
|
|
7755
7764
|
export interface QueryParameters {
|
|
7756
|
-
portal_id
|
|
7765
|
+
portal_id?: Parameters.PortalId;
|
|
7766
|
+
domain?: Parameters.Domain;
|
|
7757
7767
|
}
|
|
7758
7768
|
export type RequestBody = Components.Schemas.CreateUserRequest;
|
|
7759
7769
|
namespace Responses {
|
|
@@ -10621,6 +10631,32 @@ declare namespace Paths {
|
|
|
10621
10631
|
export type $500 = Components.Responses.InternalServerError;
|
|
10622
10632
|
}
|
|
10623
10633
|
}
|
|
10634
|
+
namespace GetPortalWidgetsV3 {
|
|
10635
|
+
namespace Parameters {
|
|
10636
|
+
export type ContractId = /**
|
|
10637
|
+
* Entity ID
|
|
10638
|
+
* example:
|
|
10639
|
+
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
10640
|
+
*/
|
|
10641
|
+
Components.Schemas.EntityId /* uuid */;
|
|
10642
|
+
export type PortalId = /**
|
|
10643
|
+
* ID of the portal
|
|
10644
|
+
* example:
|
|
10645
|
+
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
10646
|
+
*/
|
|
10647
|
+
Components.Schemas.PortalId;
|
|
10648
|
+
}
|
|
10649
|
+
export interface QueryParameters {
|
|
10650
|
+
portal_id: Parameters.PortalId;
|
|
10651
|
+
contract_id?: Parameters.ContractId;
|
|
10652
|
+
}
|
|
10653
|
+
namespace Responses {
|
|
10654
|
+
export type $200 = Components.Schemas.UpsertPortalWidget;
|
|
10655
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
10656
|
+
export type $403 = Components.Responses.Forbidden;
|
|
10657
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
10658
|
+
}
|
|
10659
|
+
}
|
|
10624
10660
|
namespace GetPrices {
|
|
10625
10661
|
namespace Parameters {
|
|
10626
10662
|
export type AppId = string;
|
|
@@ -11445,6 +11481,10 @@ declare namespace Paths {
|
|
|
11445
11481
|
* The portal ID to look up the portal config. When provided, takes precedence over origin.
|
|
11446
11482
|
*/
|
|
11447
11483
|
portal_id?: string;
|
|
11484
|
+
/**
|
|
11485
|
+
* Portal domain for identification. Alternative to portal_id or origin.
|
|
11486
|
+
*/
|
|
11487
|
+
domain?: string;
|
|
11448
11488
|
}
|
|
11449
11489
|
namespace Responses {
|
|
11450
11490
|
export interface $200 {
|
|
@@ -11781,6 +11821,30 @@ declare namespace Paths {
|
|
|
11781
11821
|
export type $500 = Components.Responses.InternalServerError;
|
|
11782
11822
|
}
|
|
11783
11823
|
}
|
|
11824
|
+
namespace SavePortalFilesV3 {
|
|
11825
|
+
namespace Parameters {
|
|
11826
|
+
export type PortalId = /**
|
|
11827
|
+
* ID of the portal
|
|
11828
|
+
* example:
|
|
11829
|
+
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
11830
|
+
*/
|
|
11831
|
+
Components.Schemas.PortalId;
|
|
11832
|
+
}
|
|
11833
|
+
export interface QueryParameters {
|
|
11834
|
+
portal_id: Parameters.PortalId;
|
|
11835
|
+
}
|
|
11836
|
+
export type RequestBody = Components.Schemas.SavePortalFile;
|
|
11837
|
+
namespace Responses {
|
|
11838
|
+
export interface $201 {
|
|
11839
|
+
createdFiles?: /* The file entity */ Components.Schemas.File[];
|
|
11840
|
+
}
|
|
11841
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
11842
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
11843
|
+
export type $403 = Components.Responses.Forbidden;
|
|
11844
|
+
export type $404 = Components.Responses.NotFound;
|
|
11845
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
11846
|
+
}
|
|
11847
|
+
}
|
|
11784
11848
|
namespace SearchPaymentRelationsInEntities {
|
|
11785
11849
|
namespace Parameters {
|
|
11786
11850
|
export type Id = /**
|
|
@@ -11892,6 +11956,7 @@ declare namespace Paths {
|
|
|
11892
11956
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
11893
11957
|
*/
|
|
11894
11958
|
export type ContactId = string; // uuid
|
|
11959
|
+
export type Domain = string;
|
|
11895
11960
|
/**
|
|
11896
11961
|
* example:
|
|
11897
11962
|
* 123
|
|
@@ -11905,12 +11970,13 @@ declare namespace Paths {
|
|
|
11905
11970
|
Components.Schemas.PortalId;
|
|
11906
11971
|
}
|
|
11907
11972
|
export interface QueryParameters {
|
|
11908
|
-
portal_id
|
|
11909
|
-
org_id
|
|
11973
|
+
portal_id?: Parameters.PortalId;
|
|
11974
|
+
org_id?: /**
|
|
11910
11975
|
* example:
|
|
11911
11976
|
* 123
|
|
11912
11977
|
*/
|
|
11913
11978
|
Parameters.OrgId;
|
|
11979
|
+
domain?: Parameters.Domain;
|
|
11914
11980
|
contact_id?: /**
|
|
11915
11981
|
* example:
|
|
11916
11982
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
@@ -12069,6 +12135,7 @@ declare namespace Paths {
|
|
|
12069
12135
|
}
|
|
12070
12136
|
namespace TriggerEntityAccessEventV3 {
|
|
12071
12137
|
namespace Parameters {
|
|
12138
|
+
export type Domain = string;
|
|
12072
12139
|
export type EntityId = /**
|
|
12073
12140
|
* Entity ID
|
|
12074
12141
|
* example:
|
|
@@ -12096,7 +12163,8 @@ declare namespace Paths {
|
|
|
12096
12163
|
}
|
|
12097
12164
|
export interface QueryParameters {
|
|
12098
12165
|
entity_id?: Parameters.EntityId;
|
|
12099
|
-
portal_id
|
|
12166
|
+
portal_id?: Parameters.PortalId;
|
|
12167
|
+
domain?: Parameters.Domain;
|
|
12100
12168
|
}
|
|
12101
12169
|
namespace Responses {
|
|
12102
12170
|
export interface $200 {
|
|
@@ -12473,6 +12541,27 @@ declare namespace Paths {
|
|
|
12473
12541
|
export type $500 = Components.Responses.InternalServerError;
|
|
12474
12542
|
}
|
|
12475
12543
|
}
|
|
12544
|
+
namespace UpsertPortalWidgetV3 {
|
|
12545
|
+
namespace Parameters {
|
|
12546
|
+
export type PortalId = /**
|
|
12547
|
+
* ID of the portal
|
|
12548
|
+
* example:
|
|
12549
|
+
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
12550
|
+
*/
|
|
12551
|
+
Components.Schemas.PortalId;
|
|
12552
|
+
}
|
|
12553
|
+
export interface QueryParameters {
|
|
12554
|
+
portal_id: Parameters.PortalId;
|
|
12555
|
+
}
|
|
12556
|
+
export type RequestBody = Components.Schemas.UpsertPortalWidget;
|
|
12557
|
+
namespace Responses {
|
|
12558
|
+
export type $201 = Components.Schemas.UpsertPortalWidget;
|
|
12559
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
12560
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
12561
|
+
export type $403 = Components.Responses.Forbidden;
|
|
12562
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
12563
|
+
}
|
|
12564
|
+
}
|
|
12476
12565
|
namespace UserExists {
|
|
12477
12566
|
namespace Parameters {
|
|
12478
12567
|
/**
|
|
@@ -12518,6 +12607,7 @@ declare namespace Paths {
|
|
|
12518
12607
|
}
|
|
12519
12608
|
namespace UserExistsV3 {
|
|
12520
12609
|
namespace Parameters {
|
|
12610
|
+
export type Domain = string;
|
|
12521
12611
|
/**
|
|
12522
12612
|
* Email Address of the portal user
|
|
12523
12613
|
* example:
|
|
@@ -12525,7 +12615,7 @@ declare namespace Paths {
|
|
|
12525
12615
|
*/
|
|
12526
12616
|
export type Email = string;
|
|
12527
12617
|
/**
|
|
12528
|
-
* Organization ID
|
|
12618
|
+
* Organization ID (required if domain is not provided)
|
|
12529
12619
|
* example:
|
|
12530
12620
|
* 123
|
|
12531
12621
|
*/
|
|
@@ -12544,13 +12634,14 @@ declare namespace Paths {
|
|
|
12544
12634
|
* user@example.com
|
|
12545
12635
|
*/
|
|
12546
12636
|
Parameters.Email;
|
|
12547
|
-
org_id
|
|
12548
|
-
* Organization ID
|
|
12637
|
+
org_id?: /**
|
|
12638
|
+
* Organization ID (required if domain is not provided)
|
|
12549
12639
|
* example:
|
|
12550
12640
|
* 123
|
|
12551
12641
|
*/
|
|
12552
12642
|
Parameters.OrgId;
|
|
12553
12643
|
portal_id?: Parameters.PortalId;
|
|
12644
|
+
domain?: Parameters.Domain;
|
|
12554
12645
|
}
|
|
12555
12646
|
namespace Responses {
|
|
12556
12647
|
export interface $200 {
|
|
@@ -12782,7 +12873,11 @@ interface OperationMethods {
|
|
|
12782
12873
|
/**
|
|
12783
12874
|
* createUserV3 - createUserV3
|
|
12784
12875
|
*
|
|
12785
|
-
* Registers a portal user
|
|
12876
|
+
* Registers a portal user.
|
|
12877
|
+
* Supports two identification methods:
|
|
12878
|
+
* 1. Using portal_id
|
|
12879
|
+
* 2. Using domain
|
|
12880
|
+
*
|
|
12786
12881
|
*/
|
|
12787
12882
|
'createUserV3'(
|
|
12788
12883
|
parameters?: Parameters<Paths.CreateUserV3.QueryParameters> | null,
|
|
@@ -13083,6 +13178,36 @@ interface OperationMethods {
|
|
|
13083
13178
|
data?: Paths.UpsertPortalWidget.RequestBody,
|
|
13084
13179
|
config?: AxiosRequestConfig
|
|
13085
13180
|
): OperationResponse<Paths.UpsertPortalWidget.Responses.$201>
|
|
13181
|
+
/**
|
|
13182
|
+
* getPortalWidgetsV3 - getPortalWidgetsV3
|
|
13183
|
+
*
|
|
13184
|
+
* Retrieves the widgets of a portal by portal_id.
|
|
13185
|
+
*/
|
|
13186
|
+
'getPortalWidgetsV3'(
|
|
13187
|
+
parameters?: Parameters<Paths.GetPortalWidgetsV3.QueryParameters> | null,
|
|
13188
|
+
data?: any,
|
|
13189
|
+
config?: AxiosRequestConfig
|
|
13190
|
+
): OperationResponse<Paths.GetPortalWidgetsV3.Responses.$200>
|
|
13191
|
+
/**
|
|
13192
|
+
* upsertPortalWidgetV3 - upsertPortalWidgetV3
|
|
13193
|
+
*
|
|
13194
|
+
* Upsert widget for a portal by portal_id.
|
|
13195
|
+
*/
|
|
13196
|
+
'upsertPortalWidgetV3'(
|
|
13197
|
+
parameters?: Parameters<Paths.UpsertPortalWidgetV3.QueryParameters> | null,
|
|
13198
|
+
data?: Paths.UpsertPortalWidgetV3.RequestBody,
|
|
13199
|
+
config?: AxiosRequestConfig
|
|
13200
|
+
): OperationResponse<Paths.UpsertPortalWidgetV3.Responses.$201>
|
|
13201
|
+
/**
|
|
13202
|
+
* savePortalFilesV3 - savePortalFilesV3
|
|
13203
|
+
*
|
|
13204
|
+
* Add files to portal by portal_id
|
|
13205
|
+
*/
|
|
13206
|
+
'savePortalFilesV3'(
|
|
13207
|
+
parameters?: Parameters<Paths.SavePortalFilesV3.QueryParameters> | null,
|
|
13208
|
+
data?: Paths.SavePortalFilesV3.RequestBody,
|
|
13209
|
+
config?: AxiosRequestConfig
|
|
13210
|
+
): OperationResponse<Paths.SavePortalFilesV3.Responses.$201>
|
|
13086
13211
|
/**
|
|
13087
13212
|
* replaceECPTemplateVariables - replaceECPTemplateVariables
|
|
13088
13213
|
*
|
|
@@ -13207,6 +13332,10 @@ interface OperationMethods {
|
|
|
13207
13332
|
* checkContactExistsV3 - checkContactExistsV3
|
|
13208
13333
|
*
|
|
13209
13334
|
* True if contact with given identifiers exists.
|
|
13335
|
+
* Supports two identification methods:
|
|
13336
|
+
* 1. Using portal_id
|
|
13337
|
+
* 2. Using domain
|
|
13338
|
+
*
|
|
13210
13339
|
*/
|
|
13211
13340
|
'checkContactExistsV3'(
|
|
13212
13341
|
parameters?: Parameters<Paths.CheckContactExistsV3.QueryParameters> | null,
|
|
@@ -13316,7 +13445,11 @@ interface OperationMethods {
|
|
|
13316
13445
|
/**
|
|
13317
13446
|
* userExistsV3 - userExistsV3
|
|
13318
13447
|
*
|
|
13319
|
-
* Checks whether a user exists in the portal
|
|
13448
|
+
* Checks whether a user exists in the portal.
|
|
13449
|
+
* Supports two identification methods:
|
|
13450
|
+
* 1. Using org_id + portal_id
|
|
13451
|
+
* 2. Using domain
|
|
13452
|
+
*
|
|
13320
13453
|
*/
|
|
13321
13454
|
'userExistsV3'(
|
|
13322
13455
|
parameters?: Parameters<Paths.UserExistsV3.QueryParameters> | null,
|
|
@@ -13663,6 +13796,11 @@ interface OperationMethods {
|
|
|
13663
13796
|
*
|
|
13664
13797
|
* Token is valid for 5 minutes.
|
|
13665
13798
|
*
|
|
13799
|
+
* Supports three identification methods (at least one required):
|
|
13800
|
+
* 1. Using portal_id (takes precedence)
|
|
13801
|
+
* 2. Using domain
|
|
13802
|
+
* 3. Using origin (legacy)
|
|
13803
|
+
*
|
|
13666
13804
|
*/
|
|
13667
13805
|
'loginToPortalAsUser'(
|
|
13668
13806
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -13682,7 +13820,11 @@ interface OperationMethods {
|
|
|
13682
13820
|
/**
|
|
13683
13821
|
* triggerEntityAccessEventV3 - triggerEntityAccessEventV3
|
|
13684
13822
|
*
|
|
13685
|
-
* Trigger entity access event for a portal user
|
|
13823
|
+
* Trigger entity access event for a portal user.
|
|
13824
|
+
* Supports two identification methods:
|
|
13825
|
+
* 1. Using portal_id
|
|
13826
|
+
* 2. Using domain
|
|
13827
|
+
*
|
|
13686
13828
|
*/
|
|
13687
13829
|
'triggerEntityAccessEventV3'(
|
|
13688
13830
|
parameters?: Parameters<Paths.TriggerEntityAccessEventV3.QueryParameters & Paths.TriggerEntityAccessEventV3.PathParameters> | null,
|
|
@@ -13802,7 +13944,11 @@ interface OperationMethods {
|
|
|
13802
13944
|
*
|
|
13803
13945
|
* Verifies the user with the issuer and matches the identity to an epilot user (or creates a new user).
|
|
13804
13946
|
*
|
|
13805
|
-
* Returns parameters to be used with CUSTOM_AUTH flow against Cognito
|
|
13947
|
+
* Returns parameters to be used with CUSTOM_AUTH flow against Cognito.
|
|
13948
|
+
*
|
|
13949
|
+
* Supports two identification methods:
|
|
13950
|
+
* 1. Using org_id + portal_id
|
|
13951
|
+
* 2. Using domain
|
|
13806
13952
|
*
|
|
13807
13953
|
*/
|
|
13808
13954
|
'ssoLoginV3'(
|
|
@@ -14165,7 +14311,11 @@ interface PathsDictionary {
|
|
|
14165
14311
|
/**
|
|
14166
14312
|
* createUserV3 - createUserV3
|
|
14167
14313
|
*
|
|
14168
|
-
* Registers a portal user
|
|
14314
|
+
* Registers a portal user.
|
|
14315
|
+
* Supports two identification methods:
|
|
14316
|
+
* 1. Using portal_id
|
|
14317
|
+
* 2. Using domain
|
|
14318
|
+
*
|
|
14169
14319
|
*/
|
|
14170
14320
|
'post'(
|
|
14171
14321
|
parameters?: Parameters<Paths.CreateUserV3.QueryParameters> | null,
|
|
@@ -14517,6 +14667,40 @@ interface PathsDictionary {
|
|
|
14517
14667
|
config?: AxiosRequestConfig
|
|
14518
14668
|
): OperationResponse<Paths.GetPortalWidgets.Responses.$200>
|
|
14519
14669
|
}
|
|
14670
|
+
['/v3/portal/widgets']: {
|
|
14671
|
+
/**
|
|
14672
|
+
* getPortalWidgetsV3 - getPortalWidgetsV3
|
|
14673
|
+
*
|
|
14674
|
+
* Retrieves the widgets of a portal by portal_id.
|
|
14675
|
+
*/
|
|
14676
|
+
'get'(
|
|
14677
|
+
parameters?: Parameters<Paths.GetPortalWidgetsV3.QueryParameters> | null,
|
|
14678
|
+
data?: any,
|
|
14679
|
+
config?: AxiosRequestConfig
|
|
14680
|
+
): OperationResponse<Paths.GetPortalWidgetsV3.Responses.$200>
|
|
14681
|
+
/**
|
|
14682
|
+
* upsertPortalWidgetV3 - upsertPortalWidgetV3
|
|
14683
|
+
*
|
|
14684
|
+
* Upsert widget for a portal by portal_id.
|
|
14685
|
+
*/
|
|
14686
|
+
'post'(
|
|
14687
|
+
parameters?: Parameters<Paths.UpsertPortalWidgetV3.QueryParameters> | null,
|
|
14688
|
+
data?: Paths.UpsertPortalWidgetV3.RequestBody,
|
|
14689
|
+
config?: AxiosRequestConfig
|
|
14690
|
+
): OperationResponse<Paths.UpsertPortalWidgetV3.Responses.$201>
|
|
14691
|
+
}
|
|
14692
|
+
['/v3/portal/portal/files']: {
|
|
14693
|
+
/**
|
|
14694
|
+
* savePortalFilesV3 - savePortalFilesV3
|
|
14695
|
+
*
|
|
14696
|
+
* Add files to portal by portal_id
|
|
14697
|
+
*/
|
|
14698
|
+
'post'(
|
|
14699
|
+
parameters?: Parameters<Paths.SavePortalFilesV3.QueryParameters> | null,
|
|
14700
|
+
data?: Paths.SavePortalFilesV3.RequestBody,
|
|
14701
|
+
config?: AxiosRequestConfig
|
|
14702
|
+
): OperationResponse<Paths.SavePortalFilesV3.Responses.$201>
|
|
14703
|
+
}
|
|
14520
14704
|
['/v2/portal/replace-ecp-template-variables']: {
|
|
14521
14705
|
/**
|
|
14522
14706
|
* replaceECPTemplateVariables - replaceECPTemplateVariables
|
|
@@ -14664,6 +14848,10 @@ interface PathsDictionary {
|
|
|
14664
14848
|
* checkContactExistsV3 - checkContactExistsV3
|
|
14665
14849
|
*
|
|
14666
14850
|
* True if contact with given identifiers exists.
|
|
14851
|
+
* Supports two identification methods:
|
|
14852
|
+
* 1. Using portal_id
|
|
14853
|
+
* 2. Using domain
|
|
14854
|
+
*
|
|
14667
14855
|
*/
|
|
14668
14856
|
'post'(
|
|
14669
14857
|
parameters?: Parameters<Paths.CheckContactExistsV3.QueryParameters> | null,
|
|
@@ -14791,7 +14979,11 @@ interface PathsDictionary {
|
|
|
14791
14979
|
/**
|
|
14792
14980
|
* userExistsV3 - userExistsV3
|
|
14793
14981
|
*
|
|
14794
|
-
* Checks whether a user exists in the portal
|
|
14982
|
+
* Checks whether a user exists in the portal.
|
|
14983
|
+
* Supports two identification methods:
|
|
14984
|
+
* 1. Using org_id + portal_id
|
|
14985
|
+
* 2. Using domain
|
|
14986
|
+
*
|
|
14795
14987
|
*/
|
|
14796
14988
|
'get'(
|
|
14797
14989
|
parameters?: Parameters<Paths.UserExistsV3.QueryParameters> | null,
|
|
@@ -15198,6 +15390,11 @@ interface PathsDictionary {
|
|
|
15198
15390
|
*
|
|
15199
15391
|
* Token is valid for 5 minutes.
|
|
15200
15392
|
*
|
|
15393
|
+
* Supports three identification methods (at least one required):
|
|
15394
|
+
* 1. Using portal_id (takes precedence)
|
|
15395
|
+
* 2. Using domain
|
|
15396
|
+
* 3. Using origin (legacy)
|
|
15397
|
+
*
|
|
15201
15398
|
*/
|
|
15202
15399
|
'post'(
|
|
15203
15400
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -15221,7 +15418,11 @@ interface PathsDictionary {
|
|
|
15221
15418
|
/**
|
|
15222
15419
|
* triggerEntityAccessEventV3 - triggerEntityAccessEventV3
|
|
15223
15420
|
*
|
|
15224
|
-
* Trigger entity access event for a portal user
|
|
15421
|
+
* Trigger entity access event for a portal user.
|
|
15422
|
+
* Supports two identification methods:
|
|
15423
|
+
* 1. Using portal_id
|
|
15424
|
+
* 2. Using domain
|
|
15425
|
+
*
|
|
15225
15426
|
*/
|
|
15226
15427
|
'post'(
|
|
15227
15428
|
parameters?: Parameters<Paths.TriggerEntityAccessEventV3.QueryParameters & Paths.TriggerEntityAccessEventV3.PathParameters> | null,
|
|
@@ -15363,7 +15564,11 @@ interface PathsDictionary {
|
|
|
15363
15564
|
*
|
|
15364
15565
|
* Verifies the user with the issuer and matches the identity to an epilot user (or creates a new user).
|
|
15365
15566
|
*
|
|
15366
|
-
* Returns parameters to be used with CUSTOM_AUTH flow against Cognito
|
|
15567
|
+
* Returns parameters to be used with CUSTOM_AUTH flow against Cognito.
|
|
15568
|
+
*
|
|
15569
|
+
* Supports two identification methods:
|
|
15570
|
+
* 1. Using org_id + portal_id
|
|
15571
|
+
* 2. Using domain
|
|
15367
15572
|
*
|
|
15368
15573
|
*/
|
|
15369
15574
|
'post'(
|
package/dist/index.cjs
CHANGED
|
@@ -102,7 +102,7 @@ var _chunkD32L2HMXcjs = require('./chunk-D32L2HMX.cjs');
|
|
|
102
102
|
var _chunkBM6NCHPLcjs = require('./chunk-BM6NCHPL.cjs');
|
|
103
103
|
|
|
104
104
|
|
|
105
|
-
var
|
|
105
|
+
var _chunkYWDWPVICcjs = require('./chunk-YWDWPVIC.cjs');
|
|
106
106
|
|
|
107
107
|
|
|
108
108
|
var _chunkM2UDF7PYcjs = require('./chunk-M2UDF7PY.cjs');
|
|
@@ -143,7 +143,7 @@ var _chunkRXMOHUBPcjs = require('./chunk-RXMOHUBP.cjs');
|
|
|
143
143
|
|
|
144
144
|
|
|
145
145
|
|
|
146
|
-
var
|
|
146
|
+
var _chunkFXN6IHCZcjs = require('./chunk-FXN6IHCZ.cjs');
|
|
147
147
|
|
|
148
148
|
|
|
149
149
|
var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
|
|
@@ -210,7 +210,7 @@ var resolveClient = (params) => {
|
|
|
210
210
|
}
|
|
211
211
|
if (!entry.instance) {
|
|
212
212
|
const definition = entry.loader();
|
|
213
|
-
entry.instance =
|
|
213
|
+
entry.instance = _chunkFXN6IHCZcjs.createApiClient.call(void 0, {
|
|
214
214
|
definition,
|
|
215
215
|
token: state.token,
|
|
216
216
|
headers: state.globalHeaders,
|
|
@@ -243,7 +243,7 @@ var resetAllClients = (registry) => {
|
|
|
243
243
|
};
|
|
244
244
|
|
|
245
245
|
// src/apis/_registry.ts
|
|
246
|
-
var expandDef = (mod) =>
|
|
246
|
+
var expandDef = (mod) => _chunkFXN6IHCZcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
|
|
247
247
|
var registerBuiltinApis = (registry) => {
|
|
248
248
|
registerApi({
|
|
249
249
|
registry,
|
|
@@ -298,7 +298,7 @@ var registerBuiltinApis = (registry) => {
|
|
|
298
298
|
registerApi({
|
|
299
299
|
registry,
|
|
300
300
|
name: "customerPortal",
|
|
301
|
-
loader: () => expandDef(
|
|
301
|
+
loader: () => expandDef(_chunkYWDWPVICcjs.require_customer_portal_runtime.call(void 0, ))
|
|
302
302
|
});
|
|
303
303
|
registerApi({
|
|
304
304
|
registry,
|
|
@@ -545,9 +545,9 @@ var createSDK = () => {
|
|
|
545
545
|
const available = [...registry.keys()].join(", ");
|
|
546
546
|
throw new Error(`Unknown API: "${name}". Available: ${available}`);
|
|
547
547
|
}
|
|
548
|
-
return
|
|
548
|
+
return _chunkFXN6IHCZcjs.createApiHandle.call(void 0, {
|
|
549
549
|
resolveClient: () => resolveClient({ registry, name, state }),
|
|
550
|
-
createClient: () =>
|
|
550
|
+
createClient: () => _chunkFXN6IHCZcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
|
|
551
551
|
apiName: name
|
|
552
552
|
});
|
|
553
553
|
};
|
|
@@ -595,9 +595,9 @@ var createSDK = () => {
|
|
|
595
595
|
return interceptorUse;
|
|
596
596
|
}
|
|
597
597
|
case "help":
|
|
598
|
-
return (apiName) =>
|
|
598
|
+
return (apiName) => _chunkFXN6IHCZcjs.help.call(void 0, apiName);
|
|
599
599
|
case "openapi":
|
|
600
|
-
return (apiName) =>
|
|
600
|
+
return (apiName) => _chunkFXN6IHCZcjs.openapi.call(void 0, apiName);
|
|
601
601
|
case "then":
|
|
602
602
|
case "catch":
|
|
603
603
|
case "finally":
|
|
@@ -624,4 +624,4 @@ var epilot = createSDK();
|
|
|
624
624
|
|
|
625
625
|
|
|
626
626
|
|
|
627
|
-
exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize =
|
|
627
|
+
exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkFXN6IHCZcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkFXN6IHCZcjs.help; exports.openapi = _chunkFXN6IHCZcjs.openapi;
|
package/dist/index.d.cts
CHANGED
|
@@ -13,7 +13,7 @@ import { C as Client$6 } from './automation.d-KOiZ6ru5.cjs';
|
|
|
13
13
|
import { C as Client$7 } from './billing.d-Bs8Ku9qE.cjs';
|
|
14
14
|
import { C as Client$8 } from './blueprint-manifest.d-DECw6HdM.cjs';
|
|
15
15
|
import { C as Client$9 } from './consent.d-C2PROHhX.cjs';
|
|
16
|
-
import { C as Client$a } from './customer-portal.d-
|
|
16
|
+
import { C as Client$a } from './customer-portal.d-BJNWYMt9.cjs';
|
|
17
17
|
import { C as Client$b } from './dashboard.d-CsGcA74I.cjs';
|
|
18
18
|
import { C as Client$c } from './data-management.d-CkDmJwpx.cjs';
|
|
19
19
|
import { C as Client$d } from './deduplication.d-w_2aJD5f.cjs';
|
|
@@ -29,7 +29,7 @@ import { C as Client$m } from './event-catalog.d-ENw6HO-w.cjs';
|
|
|
29
29
|
import { C as Client$n } from './file.d-DcTJxjp7.cjs';
|
|
30
30
|
import { C as Client$o } from './iban.d-BwdiGbxi.cjs';
|
|
31
31
|
import { C as Client$p } from './journey.d-C4N4t1Rh.cjs';
|
|
32
|
-
import { C as Client$q } from './kanban.d-
|
|
32
|
+
import { C as Client$q } from './kanban.d-B99GucT_.cjs';
|
|
33
33
|
import { C as Client$r } from './message.d-YEv1kmQd.cjs';
|
|
34
34
|
import { C as Client$s } from './metering.d-DvtPv7wk.cjs';
|
|
35
35
|
import { C as Client$t } from './notes.d-BC-scR42.cjs';
|
package/dist/index.d.ts
CHANGED
|
@@ -13,7 +13,7 @@ import { C as Client$6 } from './automation.d-KOiZ6ru5.js';
|
|
|
13
13
|
import { C as Client$7 } from './billing.d-Bs8Ku9qE.js';
|
|
14
14
|
import { C as Client$8 } from './blueprint-manifest.d-DECw6HdM.js';
|
|
15
15
|
import { C as Client$9 } from './consent.d-C2PROHhX.js';
|
|
16
|
-
import { C as Client$a } from './customer-portal.d-
|
|
16
|
+
import { C as Client$a } from './customer-portal.d-BJNWYMt9.js';
|
|
17
17
|
import { C as Client$b } from './dashboard.d-CsGcA74I.js';
|
|
18
18
|
import { C as Client$c } from './data-management.d-CkDmJwpx.js';
|
|
19
19
|
import { C as Client$d } from './deduplication.d-w_2aJD5f.js';
|
|
@@ -29,7 +29,7 @@ import { C as Client$m } from './event-catalog.d-ENw6HO-w.js';
|
|
|
29
29
|
import { C as Client$n } from './file.d-DcTJxjp7.js';
|
|
30
30
|
import { C as Client$o } from './iban.d-BwdiGbxi.js';
|
|
31
31
|
import { C as Client$p } from './journey.d-C4N4t1Rh.js';
|
|
32
|
-
import { C as Client$q } from './kanban.d-
|
|
32
|
+
import { C as Client$q } from './kanban.d-B99GucT_.js';
|
|
33
33
|
import { C as Client$r } from './message.d-YEv1kmQd.js';
|
|
34
34
|
import { C as Client$s } from './metering.d-DvtPv7wk.js';
|
|
35
35
|
import { C as Client$t } from './notes.d-BC-scR42.js';
|
package/dist/index.js
CHANGED
|
@@ -102,7 +102,7 @@ import {
|
|
|
102
102
|
} from "./chunk-2BPBDRRO.js";
|
|
103
103
|
import {
|
|
104
104
|
require_customer_portal_runtime
|
|
105
|
-
} from "./chunk-
|
|
105
|
+
} from "./chunk-XT54462S.js";
|
|
106
106
|
import {
|
|
107
107
|
require_dashboard_runtime
|
|
108
108
|
} from "./chunk-SZMCMLOQ.js";
|
|
@@ -143,7 +143,7 @@ import {
|
|
|
143
143
|
expand,
|
|
144
144
|
help,
|
|
145
145
|
openapi
|
|
146
|
-
} from "./chunk-
|
|
146
|
+
} from "./chunk-6D5AZZ2F.js";
|
|
147
147
|
import {
|
|
148
148
|
__require
|
|
149
149
|
} from "./chunk-YPSWSI3M.js";
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
+
|
|
3
|
+
// src/docs/kanban.json
|
|
4
|
+
var kanban_default = '# Kanban API\n\n- **Base URL:** `https://kanban.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/kanban](https://docs.epilot.io/api/kanban)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.kanban.createKanbanBoard(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/kanban\'\n\nconst kanbanClient = getClient()\nauthorize(kanbanClient, () => \'<token>\')\nconst { data } = await kanbanClient.createKanbanBoard(...)\n```\n\n## Operations\n\n**Kanban**\n- [`createKanbanBoard`](#createkanbanboard)\n- [`getKanbanBoards`](#getkanbanboards)\n- [`getKanbanBoard`](#getkanbanboard)\n- [`updateKanbanBoard`](#updatekanbanboard)\n- [`patchKanbanBoard`](#patchkanbanboard)\n- [`deleteKanbanBoard`](#deletekanbanboard)\n- [`setDefaultKanbanBoard`](#setdefaultkanbanboard)\n- [`clearDefaultKanbanBoard`](#cleardefaultkanbanboard)\n\n**Query**\n- [`flowsAutocomplete`](#flowsautocomplete)\n- [`executeFlowsQuery`](#executeflowsquery)\n\n**Schemas**\n- [`Error`](#error)\n- [`BoardSummary`](#boardsummary)\n- [`Board`](#board)\n- [`Swimlane`](#swimlane)\n- [`Sorting`](#sorting)\n- [`GroupBy`](#groupby)\n- [`BoardFilter`](#boardfilter)\n- [`FilterGroup`](#filtergroup)\n- [`FilterOperator`](#filteroperator)\n- [`DynamicDateValue`](#dynamicdatevalue)\n- [`ValueType`](#valuetype)\n- [`FlowsQueryRequest`](#flowsqueryrequest)\n- [`FlowsQueryResult`](#flowsqueryresult)\n- [`FilterItem`](#filteritem)\n\n### `createKanbanBoard`\n\nCreates a new Kanban board with the provided configuration.\n\n`POST /v1/kanban/board`\n\n```ts\nconst { data } = await client.createKanbanBoard(\n null,\n {\n id: \'string\',\n title: \'Board 1\',\n description: \'Board description\',\n created_at: \'1970-01-01T00:00:00.000Z\',\n updated_at: \'1970-01-01T00:00:00.000Z\',\n created_by: \'string\',\n org_id: \'string\',\n updated_by: \'string\',\n shared_with: [\'string\'],\n shared_with_org: true,\n owners: [\'string\'],\n config: {\n dataset: \'workflow_tasks_overview\',\n swimlanes: [\n {\n id: \'string\',\n title: \'Swimlane 1\',\n position: 1,\n filter: {\n items: [\n {\n key: \'assignee\',\n operator: \'EQUALS\',\n value: \'100020\',\n data_type: \'string\'\n }\n ],\n combination: \'OR\'\n },\n title_chip_variant: \'success\'\n }\n ],\n card_config: {\n fields: [\'assignee\']\n },\n board_filter: {\n items: [\n {\n key: \'assignee\',\n operator: \'EQUALS\',\n value: \'100020\',\n data_type: \'string\'\n }\n ],\n combination: \'OR\'\n },\n sorting: {\n field: \'created_at\',\n direction: \'asc\'\n },\n group_by: {\n field: \'context_entity\'\n },\n search_query: \'task 1\'\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "title": "Board 1",\n "description": "Board description",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "created_by": "string",\n "org_id": "string",\n "updated_by": "string",\n "shared_with": ["string"],\n "shared_with_org": true,\n "owners": ["string"],\n "config": {\n "dataset": "workflow_tasks_overview",\n "swimlanes": [\n {\n "id": "string",\n "title": "Swimlane 1",\n "position": 1,\n "filter": {\n "items": [\n {\n "key": "assignee",\n "operator": "EQUALS",\n "value": "100020",\n "data_type": "string"\n }\n ],\n "combination": "OR"\n },\n "title_chip_variant": "success"\n }\n ],\n "card_config": {\n "fields": ["assignee"]\n },\n "board_filter": {\n "items": [\n {\n "key": "assignee",\n "operator": "EQUALS",\n "value": "100020",\n "data_type": "string"\n }\n ],\n "combination": "OR"\n },\n "sorting": {\n "field": "created_at",\n "direction": "asc"\n },\n "group_by": {\n "field": "context_entity"\n },\n "search_query": "task 1"\n }\n}\n```\n\n</details>\n\n---\n\n### `getKanbanBoards`\n\nReturns a list of all Kanban boards accessible to the authenticated user.\n\n`GET /v1/kanban/boards`\n\n```ts\nconst { data } = await client.getKanbanBoards({\n filter: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "id": "string",\n "title": "Board 1",\n "description": "Board description",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "created_by": "string",\n "org_id": "string",\n "updated_by": "string",\n "shared_with": ["string"],\n "shared_with_org": true,\n "owners": ["string"]\n }\n]\n```\n\n</details>\n\n---\n\n### `getKanbanBoard`\n\nRetrieves a Kanban board by ID, including its full configuration (swimlanes, filters, sorting, card fields).\n\n`GET /v1/kanban/board/{boardId}`\n\n```ts\nconst { data } = await client.getKanbanBoard({\n boardId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "title": "Board 1",\n "description": "Board description",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "created_by": "string",\n "org_id": "string",\n "updated_by": "string",\n "shared_with": ["string"],\n "shared_with_org": true,\n "owners": ["string"],\n "config": {\n "dataset": "workflow_tasks_overview",\n "swimlanes": [\n {\n "id": "string",\n "title": "Swimlane 1",\n "position": 1,\n "filter": {\n "items": [\n {\n "key": "assignee",\n "operator": "EQUALS",\n "value": "100020",\n "data_type": "string"\n }\n ],\n "combination": "OR"\n },\n "title_chip_variant": "success"\n }\n ],\n "card_config": {\n "fields": ["assignee"]\n },\n "board_filter": {\n "items": [\n {\n "key": "assignee",\n "operator": "EQUALS",\n "value": "100020",\n "data_type": "string"\n }\n ],\n "combination": "OR"\n },\n "sorting": {\n "field": "created_at",\n "direction": "asc"\n },\n "group_by": {\n "field": "context_entity"\n },\n "search_query": "task 1"\n }\n}\n```\n\n</details>\n\n---\n\n### `updateKanbanBoard`\n\nFully replaces the configuration of an existing Kanban board by ID.\n\n`PUT /v1/kanban/board/{boardId}`\n\n```ts\nconst { data } = await client.updateKanbanBoard(\n {\n boardId: \'example\',\n },\n {\n id: \'string\',\n title: \'Board 1\',\n description: \'Board description\',\n created_at: \'1970-01-01T00:00:00.000Z\',\n updated_at: \'1970-01-01T00:00:00.000Z\',\n created_by: \'string\',\n org_id: \'string\',\n updated_by: \'string\',\n shared_with: [\'string\'],\n shared_with_org: true,\n owners: [\'string\'],\n config: {\n dataset: \'workflow_tasks_overview\',\n swimlanes: [\n {\n id: \'string\',\n title: \'Swimlane 1\',\n position: 1,\n filter: {\n items: [\n {\n key: \'assignee\',\n operator: \'EQUALS\',\n value: \'100020\',\n data_type: \'string\'\n }\n ],\n combination: \'OR\'\n },\n title_chip_variant: \'success\'\n }\n ],\n card_config: {\n fields: [\'assignee\']\n },\n board_filter: {\n items: [\n {\n key: \'assignee\',\n operator: \'EQUALS\',\n value: \'100020\',\n data_type: \'string\'\n }\n ],\n combination: \'OR\'\n },\n sorting: {\n field: \'created_at\',\n direction: \'asc\'\n },\n group_by: {\n field: \'context_entity\'\n },\n search_query: \'task 1\'\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "title": "Board 1",\n "description": "Board description",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "created_by": "string",\n "org_id": "string",\n "updated_by": "string",\n "shared_with": ["string"],\n "shared_with_org": true,\n "owners": ["string"],\n "config": {\n "dataset": "workflow_tasks_overview",\n "swimlanes": [\n {\n "id": "string",\n "title": "Swimlane 1",\n "position": 1,\n "filter": {\n "items": [\n {\n "key": "assignee",\n "operator": "EQUALS",\n "value": "100020",\n "data_type": "string"\n }\n ],\n "combination": "OR"\n },\n "title_chip_variant": "success"\n }\n ],\n "card_config": {\n "fields": ["assignee"]\n },\n "board_filter": {\n "items": [\n {\n "key": "assignee",\n "operator": "EQUALS",\n "value": "100020",\n "data_type": "string"\n }\n ],\n "combination": "OR"\n },\n "sorting": {\n "field": "created_at",\n "direction": "asc"\n },\n "group_by": {\n "field": "context_entity"\n },\n "search_query": "task 1"\n }\n}\n```\n\n</details>\n\n---\n\n### `patchKanbanBoard`\n\nPartially updates fields of an existing Kanban board by ID.\n\n`PATCH /v1/kanban/board/{boardId}`\n\n```ts\nconst { data } = await client.patchKanbanBoard(\n {\n boardId: \'example\',\n },\n {\n title: \'Board 1\',\n description: \'Board description\',\n shared_with: [\'string\'],\n shared_with_org: true,\n owners: [\'string\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "string",\n "title": "Board 1",\n "description": "Board description",\n "created_at": "1970-01-01T00:00:00.000Z",\n "updated_at": "1970-01-01T00:00:00.000Z",\n "created_by": "string",\n "org_id": "string",\n "updated_by": "string",\n "shared_with": ["string"],\n "shared_with_org": true,\n "owners": ["string"],\n "config": {\n "dataset": "workflow_tasks_overview",\n "swimlanes": [\n {\n "id": "string",\n "title": "Swimlane 1",\n "position": 1,\n "filter": {\n "items": [\n {\n "key": "assignee",\n "operator": "EQUALS",\n "value": "100020",\n "data_type": "string"\n }\n ],\n "combination": "OR"\n },\n "title_chip_variant": "success"\n }\n ],\n "card_config": {\n "fields": ["assignee"]\n },\n "board_filter": {\n "items": [\n {\n "key": "assignee",\n "operator": "EQUALS",\n "value": "100020",\n "data_type": "string"\n }\n ],\n "combination": "OR"\n },\n "sorting": {\n "field": "created_at",\n "direction": "asc"\n },\n "group_by": {\n "field": "context_entity"\n },\n "search_query": "task 1"\n }\n}\n```\n\n</details>\n\n---\n\n### `deleteKanbanBoard`\n\nPermanently deletes a Kanban board by ID. This action is irreversible.\n\n`DELETE /v1/kanban/board/{boardId}`\n\n```ts\nconst { data } = await client.deleteKanbanBoard({\n boardId: \'example\',\n})\n```\n\n---\n\n### `setDefaultKanbanBoard`\n\nSets a Kanban board as the default board for the organization.\n\n`PUT /v1/kanban/org/default-board`\n\n```ts\nconst { data } = await client.setDefaultKanbanBoard({\n boardId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "message": "string",\n "default_board_id": "string"\n}\n```\n\n</details>\n\n---\n\n### `clearDefaultKanbanBoard`\n\nRemoves the default board configuration for the organization.\n\n`DELETE /v1/kanban/org/default-board`\n\n```ts\nconst { data } = await client.clearDefaultKanbanBoard()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "message": "string",\n "default_board_id": "string"\n}\n```\n\n</details>\n\n---\n\n### `flowsAutocomplete`\n\nReturns autocomplete suggestions for a given attribute in the Flows dataset.\n\n`GET /v1/kanban/query/flows:autocomplete`\n\n```ts\nconst { data } = await client.flowsAutocomplete({\n input: \'example\',\n attribute: \'example\',\n size: 1,\n from: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": ["value"],\n "hits": 42\n}\n```\n\n</details>\n\n---\n\n### `executeFlowsQuery`\n\nExecutes a query against the Flows dataset and returns paginated results for use in Kanban card rendering.\n\n`POST /v1/kanban/query/flows:execute`\n\n```ts\nconst { data } = await client.executeFlowsQuery(\n null,\n {\n filters: {\n items: [\n {\n key: \'assignee\',\n operator: \'EQUALS\',\n value: \'100020\',\n data_type: \'string\'\n }\n ],\n combination: \'OR\'\n },\n sorting: {\n field: \'created_at\',\n direction: \'asc\'\n },\n group_by: {\n field: \'context_entity\'\n },\n from: 0,\n size: 10\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {}\n ],\n "hits": 42,\n "page_number": 1,\n "page_size": 10,\n "total_pages": 5\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `Error`\n\nStandard error response\n\n```ts\ntype Error = {\n message?: string\n status?: number\n}\n```\n\n### `BoardSummary`\n\nSummary representation of a Kanban board, returned in list responses. Does not include swimlane and filter configuration details.\n\n```ts\ntype BoardSummary = {\n id?: string\n title?: string\n description?: string\n created_at?: string // date-time\n updated_at?: string // date-time\n created_by?: string\n org_id?: string\n updated_by?: string\n shared_with?: string[]\n shared_with_org?: boolean\n owners?: string[]\n}\n```\n\n### `Board`\n\nFull representation of a Kanban board, including swimlane layout, filter configuration, card display fields, and sorting options.\n\n```ts\ntype Board = {\n id?: string\n title: string\n description?: string\n created_at?: string // date-time\n updated_at?: string // date-time\n created_by?: string\n org_id?: string\n updated_by?: string\n shared_with?: string[]\n shared_with_org?: boolean\n owners?: string[]\n config: {\n dataset?: string\n swimlanes?: Array<{\n id?: { ... }\n title?: { ... }\n position?: { ... }\n filter?: { ... }\n title_chip_variant?: { ... }\n }>\n card_config?: {\n fields?: { ... }\n }\n board_filter?: {\n items: { ... }\n combination: { ... }\n }\n sorting?: {\n field: { ... }\n direction?: { ... }\n }\n group_by?: {\n field: { ... }\n }\n search_query?: string\n }\n}\n```\n\n### `Swimlane`\n\nA vertical column in a Kanban board that groups workflow tasks or entities matching its filter criteria. Each swimlane has an independent filter and a display position.\n\n```ts\ntype Swimlane = {\n id?: string\n title?: string\n position?: number\n filter?: {\n items: Array<{\n key: { ... }\n operator: { ... }\n value?: { ... }\n data_type?: { ... }\n } | {\n items: { ... }\n combination: { ... }\n }>\n combination: "AND" | "OR"\n }\n title_chip_variant?: string\n}\n```\n\n### `Sorting`\n\nDefines how query results should be sorted. Specify a field name and sort direction.\n\n```ts\ntype Sorting = {\n field: string\n direction?: "asc" | "desc"\n}\n```\n\n### `GroupBy`\n\nDefines how tasks should be grouped within each swimlane. Tasks with the same group value are returned adjacently in the result set.\n\n```ts\ntype GroupBy = {\n field: "context_entity" | "phase"\n}\n```\n\n### `BoardFilter`\n\nA filter group containing one or more filter items or nested filter groups. Items are combined using the specified logical operator (AND/OR).\n\n```ts\ntype BoardFilter = {\n items: Array<{\n key: string\n operator: "EQUALS" | "NOT_EQUALS" | "EMPTY" | "NOT_EMPTY" | "CONTAINS" | "NOT_CONTAINS" | "IS_ONE_OF" | "IS_NONE_OF" | "GREATER_THAN" | "LESS_THAN" | "GREATER_THAN_OR_EQUAL" | "LESS_THAN_OR_EQUAL"\n value?: string | "TODAY" | "TOMORROW" | "YESTERDAY" | "IN_THE_FUTURE" | "IN_THE_PAST" | "THIS_WEEK" | "NEXT_WEEK" | "LAST_WEEK" | "THIS_MONTH" | "NEXT_MONTH" | "LAST_MONTH" | "TODAY_OR_EARLIER" | number | boolean | string | "TODAY" | "TOMORROW" | "YESTERDAY" | "IN_THE_FUTURE" | "IN_THE_PAST" | "THIS_WEEK" | "NEXT_WEEK" | "LAST_WEEK" | "THIS_MONTH" | "NEXT_MONTH" | "LAST_MONTH" | "TODAY_OR_EARLIER" | number | boolean[]\n data_type?: "string" | "number" | "boolean" | "date"\n } | {\n items: Array<{\n key: { ... }\n operator: { ... }\n value?: { ... }\n data_type?: { ... }\n }>\n combination: "AND" | "OR"\n }>\n combination: "AND" | "OR"\n}\n```\n\n### `FilterGroup`\n\n```ts\ntype FilterGroup = {\n items: Array<{\n key: string\n operator: "EQUALS" | "NOT_EQUALS" | "EMPTY" | "NOT_EMPTY" | "CONTAINS" | "NOT_CONTAINS" | "IS_ONE_OF" | "IS_NONE_OF" | "GREATER_THAN" | "LESS_THAN" | "GREATER_THAN_OR_EQUAL" | "LESS_THAN_OR_EQUAL"\n value?: string | "TODAY" | "TOMORROW" | "YESTERDAY" | "IN_THE_FUTURE" | "IN_THE_PAST" | "THIS_WEEK" | "NEXT_WEEK" | "LAST_WEEK" | "THIS_MONTH" | "NEXT_MONTH" | "LAST_MONTH" | "TODAY_OR_EARLIER" | number | boolean | string | "TODAY" | "TOMORROW" | "YESTERDAY" | "IN_THE_FUTURE" | "IN_THE_PAST" | "THIS_WEEK" | "NEXT_WEEK" | "LAST_WEEK" | "THIS_MONTH" | "NEXT_MONTH" | "LAST_MONTH" | "TODAY_OR_EARLIER" | number | boolean[]\n data_type?: "string" | "number" | "boolean" | "date"\n }>\n combination: "AND" | "OR"\n}\n```\n\n### `FilterOperator`\n\nThe comparison operator for filtering\n\n```ts\ntype FilterOperator = "EQUALS" | "NOT_EQUALS" | "EMPTY" | "NOT_EMPTY" | "CONTAINS" | "NOT_CONTAINS" | "IS_ONE_OF" | "IS_NONE_OF" | "GREATER_THAN" | "LESS_THAN" | "GREATER_THAN_OR_EQUAL" | "LESS_THAN_OR_EQUAL"\n```\n\n### `DynamicDateValue`\n\nDynamic date keywords that resolve to actual dates at runtime\n\n```ts\ntype DynamicDateValue = "TODAY" | "TOMORROW" | "YESTERDAY" | "IN_THE_FUTURE" | "IN_THE_PAST" | "THIS_WEEK" | "NEXT_WEEK" | "LAST_WEEK" | "THIS_MONTH" | "NEXT_MONTH" | "LAST_MONTH" | "TODAY_OR_EARLIER"\n```\n\n### `ValueType`\n\nThe value to compare against - can be a single value (string, number, boolean, or dynamic date) or an array of values\n\n```ts\ntype ValueType = string | "TODAY" | "TOMORROW" | "YESTERDAY" | "IN_THE_FUTURE" | "IN_THE_PAST" | "THIS_WEEK" | "NEXT_WEEK" | "LAST_WEEK" | "THIS_MONTH" | "NEXT_MONTH" | "LAST_MONTH" | "TODAY_OR_EARLIER" | number | boolean | string | "TODAY" | "TOMORROW" | "YESTERDAY" | "IN_THE_FUTURE" | "IN_THE_PAST" | "THIS_WEEK" | "NEXT_WEEK" | "LAST_WEEK" | "THIS_MONTH" | "NEXT_MONTH" | "LAST_MONTH" | "TODAY_OR_EARLIER" | number | boolean[]\n```\n\n### `FlowsQueryRequest`\n\nRequest payload for executing a query against the Flows dataset. Supports filter conditions, sorting, grouping, and offset-based pagination.\n\n```ts\ntype FlowsQueryRequest = {\n filters?: {\n items: Array<{\n key: { ... }\n operator: { ... }\n value?: { ... }\n data_type?: { ... }\n } | {\n items: { ... }\n combination: { ... }\n }>\n combination: "AND" | "OR"\n }\n sorting?: {\n field: string\n direction?: "asc" | "desc"\n }\n group_by?: {\n field: "context_entity" | "phase"\n }\n from?: number\n size?: number\n}\n```\n\n### `FlowsQueryResult`\n\nPaginated result set returned from a Flows query. Each item in `results` is a workflow task record with dynamic fields depending on the dataset configuration.\n\n```ts\ntype FlowsQueryResult = {\n results?: Record<string, unknown>[]\n hits?: number\n page_number?: number\n page_size?: number\n total_pages?: number\n}\n```\n\n### `FilterItem`\n\n```ts\ntype FilterItem = {\n key: string\n operator: "EQUALS" | "NOT_EQUALS" | "EMPTY" | "NOT_EMPTY" | "CONTAINS" | "NOT_CONTAINS" | "IS_ONE_OF" | "IS_NONE_OF" | "GREATER_THAN" | "LESS_THAN" | "GREATER_THAN_OR_EQUAL" | "LESS_THAN_OR_EQUAL"\n value?: string | "TODAY" | "TOMORROW" | "YESTERDAY" | "IN_THE_FUTURE" | "IN_THE_PAST" | "THIS_WEEK" | "NEXT_WEEK" | "LAST_WEEK" | "THIS_MONTH" | "NEXT_MONTH" | "LAST_MONTH" | "TODAY_OR_EARLIER" | number | boolean | string | "TODAY" | "TOMORROW" | "YESTERDAY" | "IN_THE_FUTURE" | "IN_THE_PAST" | "THIS_WEEK" | "NEXT_WEEK" | "LAST_WEEK" | "THIS_MONTH" | "NEXT_MONTH" | "LAST_MONTH" | "TODAY_OR_EARLIER" | number | boolean[]\n data_type?: "string" | "number" | "boolean" | "date"\n}\n```\n';
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
exports.default = kanban_default;
|