@epilot/sdk 2.2.1 → 2.2.2
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/access-token-runtime.json +1 -0
- package/definitions/access-token.json +663 -0
- package/definitions/address-runtime.json +1 -0
- package/definitions/address-suggestions-runtime.json +1 -0
- package/definitions/address-suggestions.json +582 -0
- package/definitions/address.json +578 -0
- package/definitions/ai-agents-runtime.json +1 -0
- package/definitions/ai-agents.json +1711 -0
- package/definitions/app-runtime.json +1 -0
- package/definitions/app.json +4493 -0
- package/definitions/audit-logs-runtime.json +1 -0
- package/definitions/audit-logs.json +305 -0
- package/definitions/automation-runtime.json +1 -0
- package/definitions/automation.json +4819 -0
- package/definitions/billing-runtime.json +1 -0
- package/definitions/billing.json +837 -0
- package/definitions/blueprint-manifest-runtime.json +1 -0
- package/definitions/blueprint-manifest.json +3490 -0
- package/definitions/consent-runtime.json +1 -0
- package/definitions/consent.json +344 -0
- package/definitions/customer-portal-runtime.json +1 -0
- package/definitions/customer-portal.json +15676 -0
- package/definitions/dashboard-runtime.json +1 -0
- package/definitions/dashboard.json +484 -0
- package/definitions/data-management-runtime.json +1 -0
- package/definitions/data-management.json +972 -0
- package/definitions/deduplication-runtime.json +1 -0
- package/definitions/deduplication.json +183 -0
- package/definitions/design-runtime.json +1 -0
- package/definitions/design.json +1423 -0
- package/definitions/document-runtime.json +1 -0
- package/definitions/document.json +758 -0
- package/definitions/email-settings-runtime.json +1 -0
- package/definitions/email-settings.json +2748 -0
- package/definitions/email-template-runtime.json +1 -0
- package/definitions/email-template.json +1441 -0
- package/definitions/entity-mapping-runtime.json +1 -0
- package/definitions/entity-mapping.json +1642 -0
- package/definitions/entity-runtime.json +1 -0
- package/definitions/entity.json +10404 -0
- package/definitions/environments-runtime.json +1 -0
- package/definitions/environments.json +363 -0
- package/definitions/erp-integration-runtime.json +1 -0
- package/definitions/erp-integration.json +6780 -0
- package/definitions/event-catalog-runtime.json +1 -0
- package/definitions/event-catalog.json +1051 -0
- package/definitions/file-runtime.json +1 -0
- package/definitions/file.json +2842 -0
- package/definitions/iban-runtime.json +1 -0
- package/definitions/iban.json +132 -0
- package/definitions/journey-runtime.json +1 -0
- package/definitions/journey.json +2603 -0
- package/definitions/kanban-runtime.json +1 -0
- package/definitions/kanban.json +1505 -0
- package/definitions/message-runtime.json +1 -0
- package/definitions/message.json +2660 -0
- package/definitions/metering-runtime.json +1 -0
- package/definitions/metering.json +2321 -0
- package/definitions/notes-runtime.json +1 -0
- package/definitions/notes.json +1531 -0
- package/definitions/notification-runtime.json +1 -0
- package/definitions/notification.json +1425 -0
- package/definitions/organization-runtime.json +1 -0
- package/definitions/organization.json +1192 -0
- package/definitions/partner-directory-runtime.json +1 -0
- package/definitions/partner-directory.json +2284 -0
- package/definitions/permissions-runtime.json +1 -0
- package/definitions/permissions.json +1515 -0
- package/definitions/pricing-runtime.json +1 -0
- package/definitions/pricing-tier-runtime.json +1 -0
- package/definitions/pricing-tier.json +105 -0
- package/definitions/pricing.json +9884 -0
- package/definitions/purpose-runtime.json +1 -0
- package/definitions/purpose.json +524 -0
- package/definitions/sandbox-runtime.json +1 -0
- package/definitions/sandbox.json +453 -0
- package/definitions/submission-runtime.json +1 -0
- package/definitions/submission.json +313 -0
- package/definitions/targeting-runtime.json +1 -0
- package/definitions/targeting.json +1474 -0
- package/definitions/template-variables-runtime.json +1 -0
- package/definitions/template-variables.json +1408 -0
- package/definitions/user-runtime.json +1 -0
- package/definitions/user.json +2408 -0
- package/definitions/validation-rules-runtime.json +1 -0
- package/definitions/validation-rules.json +1491 -0
- package/definitions/webhooks-runtime.json +1 -0
- package/definitions/webhooks.json +1634 -0
- package/definitions/workflow-definition-runtime.json +1 -0
- package/definitions/workflow-definition.json +3417 -0
- package/definitions/workflow-runtime.json +1 -0
- package/definitions/workflow.json +4146 -0
- 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.d.cts +2 -2
- package/dist/apis/automation.d.ts +2 -2
- 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 +6 -6
- package/dist/apis/customer-portal.js +1 -1
- 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 +8 -8
- package/dist/apis/entity.d.cts +2 -2
- package/dist/apis/entity.d.ts +2 -2
- package/dist/apis/entity.js +2 -2
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/erp-integration.cjs +8 -8
- package/dist/apis/erp-integration.d.cts +2 -2
- package/dist/apis/erp-integration.d.ts +2 -2
- package/dist/apis/erp-integration.js +2 -2
- 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.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/{automation.d-KOiZ6ru5.d.cts → automation.d-D7BzN7Gq.d.cts} +4 -0
- package/dist/{automation.d-KOiZ6ru5.d.ts → automation.d-D7BzN7Gq.d.ts} +4 -0
- package/dist/{chunk-G33CBNJD.js → chunk-K7HKCNT2.js} +4 -4
- package/dist/{chunk-TPA4HEAO.js → chunk-LHVRAAFH.js} +1 -1
- package/dist/{chunk-IGVVJMX7.cjs → chunk-ODD4JQVS.cjs} +1 -1
- package/dist/chunk-RKSUIRD2.js +14 -0
- package/dist/{chunk-6TKKEGYU.cjs → chunk-TG2P4RWZ.cjs} +4 -4
- package/dist/chunk-XLQ4ZRBF.cjs +14 -0
- package/dist/entity-RCWJZZXM.cjs +7 -0
- package/dist/entity-X374X6EQ.js +7 -0
- package/dist/{entity-runtime-QSFVEFJ6.js → entity-runtime-CWQUEFCS.js} +1 -1
- package/dist/entity-runtime-EOWSEXC7.cjs +5 -0
- package/dist/{entity.d-DtiajmaY.d.cts → entity.d-t9R21446.d.cts} +140 -4
- package/dist/{entity.d-DtiajmaY.d.ts → entity.d-t9R21446.d.ts} +140 -4
- package/dist/erp-integration-6I4B4BIU.cjs +7 -0
- package/dist/erp-integration-G54BMGGE.js +7 -0
- package/dist/{erp-integration-runtime-FNJXDO75.js → erp-integration-runtime-6SBLYZ34.js} +1 -1
- package/dist/{erp-integration-runtime-WXZIQCLJ.cjs → erp-integration-runtime-HZI2P4X7.cjs} +2 -2
- package/dist/{erp-integration.d-DOhxy4P5.d.cts → erp-integration.d-BV3Rv9e6.d.cts} +479 -14
- package/dist/{erp-integration.d-DOhxy4P5.d.ts → erp-integration.d-BV3Rv9e6.d.ts} +479 -14
- package/dist/index.cjs +12 -12
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +3 -3
- package/docs/entity.md +337 -5
- package/docs/erp-integration.md +643 -16
- package/package.json +1 -1
- package/dist/chunk-24T6CJTG.js +0 -14
- package/dist/chunk-TTNPMFXL.cjs +0 -14
- package/dist/entity-FA6PZX6S.js +0 -7
- package/dist/entity-IX5NSHPX.cjs +0 -7
- package/dist/entity-runtime-XSAICIVR.cjs +0 -5
- package/dist/erp-integration-EP2XFEH5.js +0 -7
- package/dist/erp-integration-NNV72VFI.cjs +0 -7
|
@@ -3881,6 +3881,14 @@ declare namespace Components {
|
|
|
3881
3881
|
id?: string;
|
|
3882
3882
|
type?: string;
|
|
3883
3883
|
};
|
|
3884
|
+
/**
|
|
3885
|
+
* Indicates this schema is currently frozen. Present when the returned version is the frozen version.
|
|
3886
|
+
*/
|
|
3887
|
+
frozen?: boolean;
|
|
3888
|
+
/**
|
|
3889
|
+
* Indicates this is the latest version of the schema. Both frozen and latest can be true if no changes were made since freezing.
|
|
3890
|
+
*/
|
|
3891
|
+
latest?: boolean;
|
|
3884
3892
|
/**
|
|
3885
3893
|
* Indicates this is a truncated summary schema (attributes trimmed to summary_attributes only, no capabilities or group_settings)
|
|
3886
3894
|
*/
|
|
@@ -11221,6 +11229,37 @@ declare namespace Paths {
|
|
|
11221
11229
|
Components.Responses.TooManyRequestsError;
|
|
11222
11230
|
}
|
|
11223
11231
|
}
|
|
11232
|
+
namespace FreezeSchema {
|
|
11233
|
+
namespace Parameters {
|
|
11234
|
+
export type Slug = /**
|
|
11235
|
+
* URL-friendly identifier for the entity schema
|
|
11236
|
+
* example:
|
|
11237
|
+
* contact
|
|
11238
|
+
*/
|
|
11239
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
11240
|
+
}
|
|
11241
|
+
export interface PathParameters {
|
|
11242
|
+
slug: Parameters.Slug;
|
|
11243
|
+
}
|
|
11244
|
+
export interface RequestBody {
|
|
11245
|
+
/**
|
|
11246
|
+
* Freeze to a specific version ID. Defaults to the current version.
|
|
11247
|
+
*/
|
|
11248
|
+
version_id?: /* Generated uuid for schema */ Components.Schemas.SchemaId /* uuid */;
|
|
11249
|
+
}
|
|
11250
|
+
namespace Responses {
|
|
11251
|
+
export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
|
|
11252
|
+
export type $404 = /**
|
|
11253
|
+
* A generic error returned by the API
|
|
11254
|
+
* example:
|
|
11255
|
+
* {
|
|
11256
|
+
* "status": 404,
|
|
11257
|
+
* "error": "Not Found"
|
|
11258
|
+
* }
|
|
11259
|
+
*/
|
|
11260
|
+
Components.Responses.NotFoundError;
|
|
11261
|
+
}
|
|
11262
|
+
}
|
|
11224
11263
|
namespace GetActivity {
|
|
11225
11264
|
namespace Parameters {
|
|
11226
11265
|
export type Id = /**
|
|
@@ -12131,6 +12170,7 @@ declare namespace Paths {
|
|
|
12131
12170
|
namespace GetSchema {
|
|
12132
12171
|
namespace Parameters {
|
|
12133
12172
|
export type Id = /* Generated uuid for schema */ Components.Schemas.SchemaId /* uuid */;
|
|
12173
|
+
export type Latest = boolean;
|
|
12134
12174
|
export type Slug = /**
|
|
12135
12175
|
* URL-friendly identifier for the entity schema
|
|
12136
12176
|
* example:
|
|
@@ -12143,6 +12183,7 @@ declare namespace Paths {
|
|
|
12143
12183
|
}
|
|
12144
12184
|
export interface QueryParameters {
|
|
12145
12185
|
id?: Parameters.Id;
|
|
12186
|
+
latest?: Parameters.Latest;
|
|
12146
12187
|
}
|
|
12147
12188
|
namespace Responses {
|
|
12148
12189
|
export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
|
|
@@ -12347,6 +12388,10 @@ declare namespace Paths {
|
|
|
12347
12388
|
* Pagination: Whether more drafts are available
|
|
12348
12389
|
*/
|
|
12349
12390
|
drafts_more?: boolean;
|
|
12391
|
+
/**
|
|
12392
|
+
* The version ID that is currently frozen, if any
|
|
12393
|
+
*/
|
|
12394
|
+
frozen_version?: /* Generated uuid for schema */ Components.Schemas.SchemaId /* uuid */;
|
|
12350
12395
|
}
|
|
12351
12396
|
}
|
|
12352
12397
|
}
|
|
@@ -12585,10 +12630,12 @@ declare namespace Paths {
|
|
|
12585
12630
|
namespace Parameters {
|
|
12586
12631
|
export type Exclude = string[];
|
|
12587
12632
|
export type Include = string[];
|
|
12633
|
+
export type Latest = boolean;
|
|
12588
12634
|
export type Unpublished = boolean;
|
|
12589
12635
|
}
|
|
12590
12636
|
export interface QueryParameters {
|
|
12591
12637
|
unpublished?: Parameters.Unpublished;
|
|
12638
|
+
latest?: Parameters.Latest;
|
|
12592
12639
|
exclude?: Parameters.Exclude;
|
|
12593
12640
|
include?: Parameters.Include;
|
|
12594
12641
|
}
|
|
@@ -12603,11 +12650,13 @@ declare namespace Paths {
|
|
|
12603
12650
|
export type Exclude = string[];
|
|
12604
12651
|
export type Full = boolean;
|
|
12605
12652
|
export type Include = string[];
|
|
12653
|
+
export type Latest = boolean;
|
|
12606
12654
|
export type Unpublished = boolean;
|
|
12607
12655
|
}
|
|
12608
12656
|
export interface QueryParameters {
|
|
12609
12657
|
full?: Parameters.Full;
|
|
12610
12658
|
unpublished?: Parameters.Unpublished;
|
|
12659
|
+
latest?: Parameters.Latest;
|
|
12611
12660
|
exclude?: Parameters.Exclude;
|
|
12612
12661
|
include?: Parameters.Include;
|
|
12613
12662
|
}
|
|
@@ -13241,6 +13290,31 @@ declare namespace Paths {
|
|
|
13241
13290
|
}
|
|
13242
13291
|
}
|
|
13243
13292
|
}
|
|
13293
|
+
namespace UnfreezeSchema {
|
|
13294
|
+
namespace Parameters {
|
|
13295
|
+
export type Slug = /**
|
|
13296
|
+
* URL-friendly identifier for the entity schema
|
|
13297
|
+
* example:
|
|
13298
|
+
* contact
|
|
13299
|
+
*/
|
|
13300
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
13301
|
+
}
|
|
13302
|
+
export interface PathParameters {
|
|
13303
|
+
slug: Parameters.Slug;
|
|
13304
|
+
}
|
|
13305
|
+
namespace Responses {
|
|
13306
|
+
export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
|
|
13307
|
+
export type $404 = /**
|
|
13308
|
+
* A generic error returned by the API
|
|
13309
|
+
* example:
|
|
13310
|
+
* {
|
|
13311
|
+
* "status": 404,
|
|
13312
|
+
* "error": "Not Found"
|
|
13313
|
+
* }
|
|
13314
|
+
*/
|
|
13315
|
+
Components.Responses.NotFoundError;
|
|
13316
|
+
}
|
|
13317
|
+
}
|
|
13244
13318
|
namespace UpdateClassificationsForTaxonomy {
|
|
13245
13319
|
namespace Parameters {
|
|
13246
13320
|
export type TaxonomySlug = string;
|
|
@@ -13843,7 +13917,10 @@ interface OperationMethods {
|
|
|
13843
13917
|
/**
|
|
13844
13918
|
* getSchema - getSchema
|
|
13845
13919
|
*
|
|
13846
|
-
* By default gets the
|
|
13920
|
+
* By default gets the current version of the Schema (frozen version if frozen, otherwise latest).
|
|
13921
|
+
* Pass ?latest=true to get the latest version when the schema is frozen.
|
|
13922
|
+
* Pass ?id= to get a specific version by ID.
|
|
13923
|
+
*
|
|
13847
13924
|
*/
|
|
13848
13925
|
'getSchema'(
|
|
13849
13926
|
parameters?: Parameters<Paths.GetSchema.QueryParameters & Paths.GetSchema.PathParameters> | null,
|
|
@@ -13853,7 +13930,9 @@ interface OperationMethods {
|
|
|
13853
13930
|
/**
|
|
13854
13931
|
* putSchema - putSchema
|
|
13855
13932
|
*
|
|
13856
|
-
* Create or update a schema with a new version
|
|
13933
|
+
* Create or update a schema with a new version.
|
|
13934
|
+
* When the schema is frozen, writes update the latest version without affecting the frozen version.
|
|
13935
|
+
*
|
|
13857
13936
|
*/
|
|
13858
13937
|
'putSchema'(
|
|
13859
13938
|
parameters?: Parameters<Paths.PutSchema.QueryParameters & Paths.PutSchema.PathParameters> | null,
|
|
@@ -13900,6 +13979,30 @@ interface OperationMethods {
|
|
|
13900
13979
|
data?: any,
|
|
13901
13980
|
config?: AxiosRequestConfig
|
|
13902
13981
|
): OperationResponse<Paths.GetSchemaVersions.Responses.$200>
|
|
13982
|
+
/**
|
|
13983
|
+
* freezeSchema - freezeSchema
|
|
13984
|
+
*
|
|
13985
|
+
* Freeze a schema at its current version, or at a specific version.
|
|
13986
|
+
* When frozen, getSchema returns the frozen version by default.
|
|
13987
|
+
* New edits via putSchema update the latest version without affecting the frozen version.
|
|
13988
|
+
*
|
|
13989
|
+
*/
|
|
13990
|
+
'freezeSchema'(
|
|
13991
|
+
parameters?: Parameters<Paths.FreezeSchema.PathParameters> | null,
|
|
13992
|
+
data?: Paths.FreezeSchema.RequestBody,
|
|
13993
|
+
config?: AxiosRequestConfig
|
|
13994
|
+
): OperationResponse<Paths.FreezeSchema.Responses.$200>
|
|
13995
|
+
/**
|
|
13996
|
+
* unfreezeSchema - unfreezeSchema
|
|
13997
|
+
*
|
|
13998
|
+
* Unfreeze a schema. Promotes the latest version to the current version for all users.
|
|
13999
|
+
*
|
|
14000
|
+
*/
|
|
14001
|
+
'unfreezeSchema'(
|
|
14002
|
+
parameters?: Parameters<Paths.UnfreezeSchema.PathParameters> | null,
|
|
14003
|
+
data?: any,
|
|
14004
|
+
config?: AxiosRequestConfig
|
|
14005
|
+
): OperationResponse<Paths.UnfreezeSchema.Responses.$200>
|
|
13903
14006
|
/**
|
|
13904
14007
|
* listAvailableCapabilities - listAvailableCapabilities
|
|
13905
14008
|
*
|
|
@@ -14962,7 +15065,10 @@ interface PathsDictionary {
|
|
|
14962
15065
|
/**
|
|
14963
15066
|
* getSchema - getSchema
|
|
14964
15067
|
*
|
|
14965
|
-
* By default gets the
|
|
15068
|
+
* By default gets the current version of the Schema (frozen version if frozen, otherwise latest).
|
|
15069
|
+
* Pass ?latest=true to get the latest version when the schema is frozen.
|
|
15070
|
+
* Pass ?id= to get a specific version by ID.
|
|
15071
|
+
*
|
|
14966
15072
|
*/
|
|
14967
15073
|
'get'(
|
|
14968
15074
|
parameters?: Parameters<Paths.GetSchema.QueryParameters & Paths.GetSchema.PathParameters> | null,
|
|
@@ -14972,7 +15078,9 @@ interface PathsDictionary {
|
|
|
14972
15078
|
/**
|
|
14973
15079
|
* putSchema - putSchema
|
|
14974
15080
|
*
|
|
14975
|
-
* Create or update a schema with a new version
|
|
15081
|
+
* Create or update a schema with a new version.
|
|
15082
|
+
* When the schema is frozen, writes update the latest version without affecting the frozen version.
|
|
15083
|
+
*
|
|
14976
15084
|
*/
|
|
14977
15085
|
'put'(
|
|
14978
15086
|
parameters?: Parameters<Paths.PutSchema.QueryParameters & Paths.PutSchema.PathParameters> | null,
|
|
@@ -15026,6 +15134,34 @@ interface PathsDictionary {
|
|
|
15026
15134
|
config?: AxiosRequestConfig
|
|
15027
15135
|
): OperationResponse<Paths.GetSchemaVersions.Responses.$200>
|
|
15028
15136
|
}
|
|
15137
|
+
['/v1/entity/schemas/{slug}/freeze']: {
|
|
15138
|
+
/**
|
|
15139
|
+
* freezeSchema - freezeSchema
|
|
15140
|
+
*
|
|
15141
|
+
* Freeze a schema at its current version, or at a specific version.
|
|
15142
|
+
* When frozen, getSchema returns the frozen version by default.
|
|
15143
|
+
* New edits via putSchema update the latest version without affecting the frozen version.
|
|
15144
|
+
*
|
|
15145
|
+
*/
|
|
15146
|
+
'post'(
|
|
15147
|
+
parameters?: Parameters<Paths.FreezeSchema.PathParameters> | null,
|
|
15148
|
+
data?: Paths.FreezeSchema.RequestBody,
|
|
15149
|
+
config?: AxiosRequestConfig
|
|
15150
|
+
): OperationResponse<Paths.FreezeSchema.Responses.$200>
|
|
15151
|
+
}
|
|
15152
|
+
['/v1/entity/schemas/{slug}/unfreeze']: {
|
|
15153
|
+
/**
|
|
15154
|
+
* unfreezeSchema - unfreezeSchema
|
|
15155
|
+
*
|
|
15156
|
+
* Unfreeze a schema. Promotes the latest version to the current version for all users.
|
|
15157
|
+
*
|
|
15158
|
+
*/
|
|
15159
|
+
'post'(
|
|
15160
|
+
parameters?: Parameters<Paths.UnfreezeSchema.PathParameters> | null,
|
|
15161
|
+
data?: any,
|
|
15162
|
+
config?: AxiosRequestConfig
|
|
15163
|
+
): OperationResponse<Paths.UnfreezeSchema.Responses.$200>
|
|
15164
|
+
}
|
|
15029
15165
|
['/v1/entity/schemas/{slug}/capabilities/available']: {
|
|
15030
15166
|
/**
|
|
15031
15167
|
* listAvailableCapabilities - listAvailableCapabilities
|
|
@@ -3881,6 +3881,14 @@ declare namespace Components {
|
|
|
3881
3881
|
id?: string;
|
|
3882
3882
|
type?: string;
|
|
3883
3883
|
};
|
|
3884
|
+
/**
|
|
3885
|
+
* Indicates this schema is currently frozen. Present when the returned version is the frozen version.
|
|
3886
|
+
*/
|
|
3887
|
+
frozen?: boolean;
|
|
3888
|
+
/**
|
|
3889
|
+
* Indicates this is the latest version of the schema. Both frozen and latest can be true if no changes were made since freezing.
|
|
3890
|
+
*/
|
|
3891
|
+
latest?: boolean;
|
|
3884
3892
|
/**
|
|
3885
3893
|
* Indicates this is a truncated summary schema (attributes trimmed to summary_attributes only, no capabilities or group_settings)
|
|
3886
3894
|
*/
|
|
@@ -11221,6 +11229,37 @@ declare namespace Paths {
|
|
|
11221
11229
|
Components.Responses.TooManyRequestsError;
|
|
11222
11230
|
}
|
|
11223
11231
|
}
|
|
11232
|
+
namespace FreezeSchema {
|
|
11233
|
+
namespace Parameters {
|
|
11234
|
+
export type Slug = /**
|
|
11235
|
+
* URL-friendly identifier for the entity schema
|
|
11236
|
+
* example:
|
|
11237
|
+
* contact
|
|
11238
|
+
*/
|
|
11239
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
11240
|
+
}
|
|
11241
|
+
export interface PathParameters {
|
|
11242
|
+
slug: Parameters.Slug;
|
|
11243
|
+
}
|
|
11244
|
+
export interface RequestBody {
|
|
11245
|
+
/**
|
|
11246
|
+
* Freeze to a specific version ID. Defaults to the current version.
|
|
11247
|
+
*/
|
|
11248
|
+
version_id?: /* Generated uuid for schema */ Components.Schemas.SchemaId /* uuid */;
|
|
11249
|
+
}
|
|
11250
|
+
namespace Responses {
|
|
11251
|
+
export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
|
|
11252
|
+
export type $404 = /**
|
|
11253
|
+
* A generic error returned by the API
|
|
11254
|
+
* example:
|
|
11255
|
+
* {
|
|
11256
|
+
* "status": 404,
|
|
11257
|
+
* "error": "Not Found"
|
|
11258
|
+
* }
|
|
11259
|
+
*/
|
|
11260
|
+
Components.Responses.NotFoundError;
|
|
11261
|
+
}
|
|
11262
|
+
}
|
|
11224
11263
|
namespace GetActivity {
|
|
11225
11264
|
namespace Parameters {
|
|
11226
11265
|
export type Id = /**
|
|
@@ -12131,6 +12170,7 @@ declare namespace Paths {
|
|
|
12131
12170
|
namespace GetSchema {
|
|
12132
12171
|
namespace Parameters {
|
|
12133
12172
|
export type Id = /* Generated uuid for schema */ Components.Schemas.SchemaId /* uuid */;
|
|
12173
|
+
export type Latest = boolean;
|
|
12134
12174
|
export type Slug = /**
|
|
12135
12175
|
* URL-friendly identifier for the entity schema
|
|
12136
12176
|
* example:
|
|
@@ -12143,6 +12183,7 @@ declare namespace Paths {
|
|
|
12143
12183
|
}
|
|
12144
12184
|
export interface QueryParameters {
|
|
12145
12185
|
id?: Parameters.Id;
|
|
12186
|
+
latest?: Parameters.Latest;
|
|
12146
12187
|
}
|
|
12147
12188
|
namespace Responses {
|
|
12148
12189
|
export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
|
|
@@ -12347,6 +12388,10 @@ declare namespace Paths {
|
|
|
12347
12388
|
* Pagination: Whether more drafts are available
|
|
12348
12389
|
*/
|
|
12349
12390
|
drafts_more?: boolean;
|
|
12391
|
+
/**
|
|
12392
|
+
* The version ID that is currently frozen, if any
|
|
12393
|
+
*/
|
|
12394
|
+
frozen_version?: /* Generated uuid for schema */ Components.Schemas.SchemaId /* uuid */;
|
|
12350
12395
|
}
|
|
12351
12396
|
}
|
|
12352
12397
|
}
|
|
@@ -12585,10 +12630,12 @@ declare namespace Paths {
|
|
|
12585
12630
|
namespace Parameters {
|
|
12586
12631
|
export type Exclude = string[];
|
|
12587
12632
|
export type Include = string[];
|
|
12633
|
+
export type Latest = boolean;
|
|
12588
12634
|
export type Unpublished = boolean;
|
|
12589
12635
|
}
|
|
12590
12636
|
export interface QueryParameters {
|
|
12591
12637
|
unpublished?: Parameters.Unpublished;
|
|
12638
|
+
latest?: Parameters.Latest;
|
|
12592
12639
|
exclude?: Parameters.Exclude;
|
|
12593
12640
|
include?: Parameters.Include;
|
|
12594
12641
|
}
|
|
@@ -12603,11 +12650,13 @@ declare namespace Paths {
|
|
|
12603
12650
|
export type Exclude = string[];
|
|
12604
12651
|
export type Full = boolean;
|
|
12605
12652
|
export type Include = string[];
|
|
12653
|
+
export type Latest = boolean;
|
|
12606
12654
|
export type Unpublished = boolean;
|
|
12607
12655
|
}
|
|
12608
12656
|
export interface QueryParameters {
|
|
12609
12657
|
full?: Parameters.Full;
|
|
12610
12658
|
unpublished?: Parameters.Unpublished;
|
|
12659
|
+
latest?: Parameters.Latest;
|
|
12611
12660
|
exclude?: Parameters.Exclude;
|
|
12612
12661
|
include?: Parameters.Include;
|
|
12613
12662
|
}
|
|
@@ -13241,6 +13290,31 @@ declare namespace Paths {
|
|
|
13241
13290
|
}
|
|
13242
13291
|
}
|
|
13243
13292
|
}
|
|
13293
|
+
namespace UnfreezeSchema {
|
|
13294
|
+
namespace Parameters {
|
|
13295
|
+
export type Slug = /**
|
|
13296
|
+
* URL-friendly identifier for the entity schema
|
|
13297
|
+
* example:
|
|
13298
|
+
* contact
|
|
13299
|
+
*/
|
|
13300
|
+
Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
|
|
13301
|
+
}
|
|
13302
|
+
export interface PathParameters {
|
|
13303
|
+
slug: Parameters.Slug;
|
|
13304
|
+
}
|
|
13305
|
+
namespace Responses {
|
|
13306
|
+
export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
|
|
13307
|
+
export type $404 = /**
|
|
13308
|
+
* A generic error returned by the API
|
|
13309
|
+
* example:
|
|
13310
|
+
* {
|
|
13311
|
+
* "status": 404,
|
|
13312
|
+
* "error": "Not Found"
|
|
13313
|
+
* }
|
|
13314
|
+
*/
|
|
13315
|
+
Components.Responses.NotFoundError;
|
|
13316
|
+
}
|
|
13317
|
+
}
|
|
13244
13318
|
namespace UpdateClassificationsForTaxonomy {
|
|
13245
13319
|
namespace Parameters {
|
|
13246
13320
|
export type TaxonomySlug = string;
|
|
@@ -13843,7 +13917,10 @@ interface OperationMethods {
|
|
|
13843
13917
|
/**
|
|
13844
13918
|
* getSchema - getSchema
|
|
13845
13919
|
*
|
|
13846
|
-
* By default gets the
|
|
13920
|
+
* By default gets the current version of the Schema (frozen version if frozen, otherwise latest).
|
|
13921
|
+
* Pass ?latest=true to get the latest version when the schema is frozen.
|
|
13922
|
+
* Pass ?id= to get a specific version by ID.
|
|
13923
|
+
*
|
|
13847
13924
|
*/
|
|
13848
13925
|
'getSchema'(
|
|
13849
13926
|
parameters?: Parameters<Paths.GetSchema.QueryParameters & Paths.GetSchema.PathParameters> | null,
|
|
@@ -13853,7 +13930,9 @@ interface OperationMethods {
|
|
|
13853
13930
|
/**
|
|
13854
13931
|
* putSchema - putSchema
|
|
13855
13932
|
*
|
|
13856
|
-
* Create or update a schema with a new version
|
|
13933
|
+
* Create or update a schema with a new version.
|
|
13934
|
+
* When the schema is frozen, writes update the latest version without affecting the frozen version.
|
|
13935
|
+
*
|
|
13857
13936
|
*/
|
|
13858
13937
|
'putSchema'(
|
|
13859
13938
|
parameters?: Parameters<Paths.PutSchema.QueryParameters & Paths.PutSchema.PathParameters> | null,
|
|
@@ -13900,6 +13979,30 @@ interface OperationMethods {
|
|
|
13900
13979
|
data?: any,
|
|
13901
13980
|
config?: AxiosRequestConfig
|
|
13902
13981
|
): OperationResponse<Paths.GetSchemaVersions.Responses.$200>
|
|
13982
|
+
/**
|
|
13983
|
+
* freezeSchema - freezeSchema
|
|
13984
|
+
*
|
|
13985
|
+
* Freeze a schema at its current version, or at a specific version.
|
|
13986
|
+
* When frozen, getSchema returns the frozen version by default.
|
|
13987
|
+
* New edits via putSchema update the latest version without affecting the frozen version.
|
|
13988
|
+
*
|
|
13989
|
+
*/
|
|
13990
|
+
'freezeSchema'(
|
|
13991
|
+
parameters?: Parameters<Paths.FreezeSchema.PathParameters> | null,
|
|
13992
|
+
data?: Paths.FreezeSchema.RequestBody,
|
|
13993
|
+
config?: AxiosRequestConfig
|
|
13994
|
+
): OperationResponse<Paths.FreezeSchema.Responses.$200>
|
|
13995
|
+
/**
|
|
13996
|
+
* unfreezeSchema - unfreezeSchema
|
|
13997
|
+
*
|
|
13998
|
+
* Unfreeze a schema. Promotes the latest version to the current version for all users.
|
|
13999
|
+
*
|
|
14000
|
+
*/
|
|
14001
|
+
'unfreezeSchema'(
|
|
14002
|
+
parameters?: Parameters<Paths.UnfreezeSchema.PathParameters> | null,
|
|
14003
|
+
data?: any,
|
|
14004
|
+
config?: AxiosRequestConfig
|
|
14005
|
+
): OperationResponse<Paths.UnfreezeSchema.Responses.$200>
|
|
13903
14006
|
/**
|
|
13904
14007
|
* listAvailableCapabilities - listAvailableCapabilities
|
|
13905
14008
|
*
|
|
@@ -14962,7 +15065,10 @@ interface PathsDictionary {
|
|
|
14962
15065
|
/**
|
|
14963
15066
|
* getSchema - getSchema
|
|
14964
15067
|
*
|
|
14965
|
-
* By default gets the
|
|
15068
|
+
* By default gets the current version of the Schema (frozen version if frozen, otherwise latest).
|
|
15069
|
+
* Pass ?latest=true to get the latest version when the schema is frozen.
|
|
15070
|
+
* Pass ?id= to get a specific version by ID.
|
|
15071
|
+
*
|
|
14966
15072
|
*/
|
|
14967
15073
|
'get'(
|
|
14968
15074
|
parameters?: Parameters<Paths.GetSchema.QueryParameters & Paths.GetSchema.PathParameters> | null,
|
|
@@ -14972,7 +15078,9 @@ interface PathsDictionary {
|
|
|
14972
15078
|
/**
|
|
14973
15079
|
* putSchema - putSchema
|
|
14974
15080
|
*
|
|
14975
|
-
* Create or update a schema with a new version
|
|
15081
|
+
* Create or update a schema with a new version.
|
|
15082
|
+
* When the schema is frozen, writes update the latest version without affecting the frozen version.
|
|
15083
|
+
*
|
|
14976
15084
|
*/
|
|
14977
15085
|
'put'(
|
|
14978
15086
|
parameters?: Parameters<Paths.PutSchema.QueryParameters & Paths.PutSchema.PathParameters> | null,
|
|
@@ -15026,6 +15134,34 @@ interface PathsDictionary {
|
|
|
15026
15134
|
config?: AxiosRequestConfig
|
|
15027
15135
|
): OperationResponse<Paths.GetSchemaVersions.Responses.$200>
|
|
15028
15136
|
}
|
|
15137
|
+
['/v1/entity/schemas/{slug}/freeze']: {
|
|
15138
|
+
/**
|
|
15139
|
+
* freezeSchema - freezeSchema
|
|
15140
|
+
*
|
|
15141
|
+
* Freeze a schema at its current version, or at a specific version.
|
|
15142
|
+
* When frozen, getSchema returns the frozen version by default.
|
|
15143
|
+
* New edits via putSchema update the latest version without affecting the frozen version.
|
|
15144
|
+
*
|
|
15145
|
+
*/
|
|
15146
|
+
'post'(
|
|
15147
|
+
parameters?: Parameters<Paths.FreezeSchema.PathParameters> | null,
|
|
15148
|
+
data?: Paths.FreezeSchema.RequestBody,
|
|
15149
|
+
config?: AxiosRequestConfig
|
|
15150
|
+
): OperationResponse<Paths.FreezeSchema.Responses.$200>
|
|
15151
|
+
}
|
|
15152
|
+
['/v1/entity/schemas/{slug}/unfreeze']: {
|
|
15153
|
+
/**
|
|
15154
|
+
* unfreezeSchema - unfreezeSchema
|
|
15155
|
+
*
|
|
15156
|
+
* Unfreeze a schema. Promotes the latest version to the current version for all users.
|
|
15157
|
+
*
|
|
15158
|
+
*/
|
|
15159
|
+
'post'(
|
|
15160
|
+
parameters?: Parameters<Paths.UnfreezeSchema.PathParameters> | null,
|
|
15161
|
+
data?: any,
|
|
15162
|
+
config?: AxiosRequestConfig
|
|
15163
|
+
): OperationResponse<Paths.UnfreezeSchema.Responses.$200>
|
|
15164
|
+
}
|
|
15029
15165
|
['/v1/entity/schemas/{slug}/capabilities/available']: {
|
|
15030
15166
|
/**
|
|
15031
15167
|
* listAvailableCapabilities - listAvailableCapabilities
|