@epilot/sdk 2.3.7-rc1 → 2.3.7
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/design.json +257 -4
- package/definitions/entity-runtime.json +1 -1
- package/definitions/entity.json +4 -354
- 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/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.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-governance.cjs +6 -6
- package/dist/apis/data-governance.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.d.cts +2 -2
- package/dist/apis/design.d.ts +2 -2
- 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.js +2 -2
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.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/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.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/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.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/bin/cli.js +1 -1
- package/dist/chunk-F7W62NKV.js +14 -0
- package/dist/{chunk-OU5NVIJW.js → chunk-KY7TIDRJ.js} +3 -3
- package/dist/{chunk-FCT6W5UM.cjs → chunk-NOYX4W47.cjs} +3 -3
- package/dist/chunk-QA2OYK7N.cjs +14 -0
- package/dist/design-DROLIWS3.js +7 -0
- package/dist/design-XZKOZLTR.cjs +7 -0
- package/dist/design.d-BRre8iLg.d.cts +2346 -0
- package/dist/design.d-BRre8iLg.d.ts +2346 -0
- package/dist/entity-CK76MXVN.js +7 -0
- package/dist/entity-TFMH5VTZ.cjs +7 -0
- package/dist/{entity-runtime-LNAZILIN.js → entity-runtime-D4DV5XRM.js} +1 -1
- package/dist/entity-runtime-DUJTRYLQ.cjs +5 -0
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -2
- package/dist/{js-yaml-UPZKYVRY.js → js-yaml-DLCVPJ7G.js} +17 -15
- package/docs/design.md +665 -341
- package/docs/entity.md +39 -965
- package/package.json +1 -1
- package/dist/chunk-M6Z6ES3I.js +0 -14
- package/dist/chunk-UBQCDPW6.cjs +0 -14
- package/dist/design-NISDHPFD.cjs +0 -7
- package/dist/design-WL4AZIGX.js +0 -7
- package/dist/design.d-DTo29S0F.d.cts +0 -960
- package/dist/design.d-DTo29S0F.d.ts +0 -960
- package/dist/entity-VDUN7SYC.cjs +0 -7
- package/dist/entity-WWM2Z7BU.js +0 -7
- package/dist/entity-runtime-3J5EDLXP.cjs +0 -5
package/package.json
CHANGED
package/dist/chunk-M6Z6ES3I.js
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import {
|
|
2
|
-
__commonJS
|
|
3
|
-
} from "./chunk-YPSWSI3M.js";
|
|
4
|
-
|
|
5
|
-
// src/definitions/entity-runtime.json
|
|
6
|
-
var require_entity_runtime = __commonJS({
|
|
7
|
-
"src/definitions/entity-runtime.json"(exports, module) {
|
|
8
|
-
module.exports = { s: "https://entity.sls.epilot.io", o: [["listSchemas", "get", "/v1/entity/schemas", [["unpublished", "q"], ["latest", "q"], ["exclude", "q", false, "form", false], ["include", "q", false, "form", false]]], ["listSchemasV2", "get", "/v2/entity/schemas", [["full", "q"], ["unpublished", "q"], ["latest", "q"], ["exclude", "q", false, "form", false], ["include", "q", false, "form", false]]], ["getSchema", "get", "/v1/entity/schemas/{slug}", [["EntitySlugPathParam"], ["id", "q"], ["latest", "q"]]], ["putSchema", "put", "/v1/entity/schemas/{slug}", [["EntitySlugPathParam"], ["draft", "q"]], 1], ["deleteSchema", "delete", "/v1/entity/schemas/{slug}", [["EntitySlugPathParam"]]], ["getJsonSchema", "get", "/v1/entity/schemas/{slug}/json/schema", [["EntitySlugPathParam"], ["dereference", "q"]]], ["getSchemaExample", "get", "/v1/entity/schemas/{slug}/json/example", [["EntitySlugPathParam"]]], ["getSchemaVersions", "get", "/v1/entity/schemas/{slug}/versions", [["EntitySlugPathParam"], ["versions_from", "q"], ["versions_size", "q"], ["drafts_from", "q"], ["drafts_size", "q"], ["fields", "q", false, "form", false]]], ["freezeSchema", "post", "/v1/entity/schemas/{slug}/freeze", [["EntitySlugPathParam"]], 1], ["unfreezeSchema", "post", "/v1/entity/schemas/{slug}/unfreeze", [["EntitySlugPathParam"]]], ["listAvailableCapabilities", "get", "/v1/entity/schemas/{slug}/capabilities/available", [["EntitySlugPathParam"]]], ["listSchemaBlueprints", "get", "/v1/entity/schemas/blueprints"], ["searchEntities", "post", "/v1/entity:search", null, 1], ["listEntities", "post", "/v1/entity:list", null, 1], ["queryEntityGraph", "post", "/v1/entity:graph", null, 1], ["createEntity", "post", "/v1/entity/{slug}", [["EntitySlugPathParam"], ["ActivityIdQueryParam"], ["FillActivityQueryParam"], ["AsyncOperationQueryParam"], ["ValidateEntityQueryParam"]], 1], ["validateEntity", "post", "/v1/entity/{slug}:validate", [["EntitySlugPathPriceParam"]], 1], ["validateEntityV2", "post", "/v2/entity/{slug}:validate", [["EntitySlugPathPriceParam"]], 1], ["upsertEntity", "patch", "/v1/entity/{slug}:upsert", [["EntitySlugPathParam"], ["ActivityIdQueryParam"], ["FillActivityQueryParam"], ["DryRunQueryParam"], ["AsyncOperationQueryParam"], ["ValidateEntityQueryParam"], ["strict", "q"]], 1], ["getEntityV2", "get", "/v2/entity/{slug}/{id}", [["EntityIdPathParam"], ["EntitySlugPathParam"], ["HydrateEntitiesQueryParam"], ["fields", "q", false, "form", false], ["ApplyChangesetsQueryParam"]]], ["restoreEntity", "patch", "/v1/entity/{slug}/{id}:restore", [["EntityIdPathParam"], ["EntitySlugPathParam"], ["ActivityIdQueryParam"]], 1], ["reindexEntity", "post", "/v1/entity/{slug}/{id}:reindex", [["EntityIdPathParam"], ["EntitySlugPathParam"]], 1], ["getEntity", "get", "/v1/entity/{slug}/{id}", [["EntityIdPathParam"], ["EntitySlugPathParam"], ["HydrateEntitiesQueryParam"]]], ["updateEntity", "put", "/v1/entity/{slug}/{id}", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["ActivityIdQueryParam"], ["FillActivityQueryParam"], ["AsyncOperationQueryParam"], ["ValidateEntityQueryParam"], ["DirectQueryParam"]], 1], ["patchEntity", "patch", "/v1/entity/{slug}/{id}", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["ActivityIdQueryParam"], ["FillActivityQueryParam"], ["DryRunQueryParam"], ["AsyncOperationQueryParam"], ["ValidateEntityQueryParam"], ["DirectQueryParam"]], 1], ["deleteEntity", "delete", "/v1/entity/{slug}/{id}", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["ActivityIdQueryParam"], ["purge", "q"]]], ["autocomplete", "get", "/v1/entity:autocomplete", [["input", "q"], ["attribute", "q", true], ["slug", "q"], ["size", "q"]]], ["wipeAllEntities", "post", "/v1/entity:wipeAllEntities", null, 1], ["createActivity", "post", "/v1/entity/activity", [["entities", "q", false, "form", false]], 1], ["getActivity", "get", "/v1/entity/activity/{id}", [["ActivityIdPathParam"], ["operations_size", "q"], ["operations_from", "q"]]], ["attachActivity", "post", "/v1/entity/activity/{id}:attach", [["ActivityIdPathParam"], ["entities", "q", false, "form", false]]], ["applyChangeset", "post", "/v1/entity/{slug}/{id}/changesets/{attribute}:apply", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["attribute", "p", true]]], ["dismissChangeset", "post", "/v1/entity/{slug}/{id}/changesets/{attribute}:dismiss", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["attribute", "p", true]], 1], ["listChangesets", "get", "/v1/entity/{slug}/{id}/changesets", [["EntitySlugPathParam"], ["EntityIdPathParam"]]], ["getEntityActivityFeed", "get", "/v1/entity/{slug}/{id}/activity", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["after", "q"], ["before", "q"], ["start_date", "q"], ["end_date", "q"], ["preset_range", "q"], ["FromPageQueryParam"], ["size", "q"], ["type", "q", false, "form", false], ["include_relations", "q"], ["exclude_activity_groups", "q"]]], ["getRelations", "get", "/v1/entity/{slug}/{id}/relations", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["HydrateEntitiesQueryParam"], ["IncludeReverseQueryParam"], ["FromPageQueryParam"], ["size", "q"], ["IncludeSchemasQueryParam"], ["ExcludeSchemasQueryParam"]]], ["addRelations", "post", "/v1/entity/{slug}/{id}/relations", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["AsyncOperationQueryParam"], ["ActivityIdQueryParam"]], 1], ["removeRelations", "delete", "/v1/entity/{slug}/{id}/relations", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["AsyncOperationQueryParam"], ["ActivityIdQueryParam"]], 1], ["getRelationsV2", "get", "/v2/entity/{slug}/{id}/relations", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["HydrateEntitiesQueryParam"], ["query", "q"], ["IncludeReverseQueryParam"], ["FromPageQueryParam"], ["size", "q"], ["fields", "q"]]], ["getRelationsV3", "get", "/v3/entity/{slug}/{id}/relations", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["HydrateEntitiesQueryParam"], ["IncludeReverseDeprecatedQueryParam"], ["FromPageQueryParam"], ["size", "q"], ["IncludeSchemasQueryParam"], ["ExcludeSchemasQueryParam"], ["EntityRelationsModeQueryParam"], ["fields", "q"], ["include_deleted", "q"]]], ["getRelatedEntitiesCount", "get", "/v2/entity/{slug}/{id}/relations/count", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["ExcludeSchemasQueryParam"]]], ["updateRelation", "put", "/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["attribute", "p", true], ["entity_id", "p", true], ["AsyncOperationQueryParam"], ["ActivityIdQueryParam"]], 1], ["deleteRelation", "delete", "/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["attribute", "p", true], ["entity_id", "p", true], ["AsyncOperationQueryParam"], ["ActivityIdQueryParam"]]], ["exportEntities", "post", "/v1/entity:export", [["job_id", "q"], ["is_template", "q"], ["language", "q"]], 1], ["importEntities", "post", "/v1/entity:import", [["job_id", "q"]], 1], ["listSavedViews", "get", "/v1/entity/views", [["slug", "q"], ["sort", "q"], ["from", "q"], ["size", "q"], ["fields", "q"]]], ["createSavedView", "post", "/v1/entity/view", null, 1], ["getSavedView", "get", "/v1/entity/view/{id}", [["SavedViewIdPathParam"]]], ["updateSavedView", "put", "/v1/entity/view/{id}", [["SavedViewIdPathParam"]], 1], ["patchSavedView", "patch", "/v1/entity/view/{id}", [["SavedViewIdPathParam"]], 1], ["deleteSavedView", "delete", "/v1/entity/view/{id}", [["SavedViewIdPathParam"]]], ["listFavoriteViewsForUser", "get", "/v1/entity/views/favorites"], ["listTaxonomies", "get", "/v1/entity/taxonomies", [["include_disabled", "q"], ["type", "q"]]], ["createTaxonomy", "post", "/v1/entity/taxonomies", null, 1], ["getTaxonomy", "get", "/v1/entity/taxonomies/{taxonomySlug}", [["TaxonomySlugPathParam"]]], ["updateTaxonomy", "put", "/v1/entity/taxonomies/{taxonomySlug}", [["TaxonomySlugPathParam"]], 1], ["deleteTaxonomy", "delete", "/v1/entity/taxonomies/{taxonomySlug}", [["TaxonomySlugPathParam"], ["permanent", "q"]]], ["updateClassificationsForTaxonomy", "post", "/v1/entity/taxonomies/{taxonomySlug}/classifications", [["TaxonomySlugPathParam"]], 1], ["createTaxonomyClassification", "post", "/v2/entity/taxonomies/classifications", null, 1], ["getTaxonomyClassification", "get", "/v2/entity/taxonomies/classifications/{classificationSlug}", [["TaxonomyClassificationSlugPathParam"]]], ["updateTaxonomyClassification", "put", "/v2/entity/taxonomies/classifications/{classificationSlug}", [["TaxonomyClassificationSlugPathParam"]], 1], ["deleteTaxonomyClassification", "delete", "/v2/entity/taxonomies/classifications/{classificationSlug}", [["TaxonomyClassificationSlugPathParam"]]], ["taxonomyAutocomplete", "get", "/v1/entity/taxonomies/{taxonomySlug}:autocomplete", [["TaxonomySlugPathParam"], ["query", "q"], ["size", "q"]]], ["taxonomiesClassificationsSearch", "post", "/v1/entity/taxonomies/classifications:search", [["taxonomySlug", "q"], ["query", "q"], ["archived", "q"], ["include_archived", "q"], ["exclude_types", "q"]], 1], ["listTaxonomyClassificationsForSchema", "get", "/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}", [["EntitySlugPathParam"], ["TaxonomySlugPathParam"], ["query", "q"], ["size", "q"]]], ["getTaxonomyBulkActionJobs", "get", "/v1/entity/taxonomies/bulk-jobs", [["status", "q"], ["size", "q"], ["created_after", "q"], ["sort_pending_first", "q"], ["scope", "q"]]], ["getTaxonomyBulkActionJobById", "get", "/v1/entity/taxonomies/bulk-jobs/{job_id}", [["job_id", "p", true]]], ["cancelBulkAction", "post", "/v1/entity/taxonomies/bulk-jobs/{job_id}/cancel", [["job_id", "p", true]]], ["bulkMoveClassifications", "post", "/v1/entity/taxonomies/classifications:move", null, 1], ["bulkMergeClassifications", "post", "/v1/entity/taxonomies/classifications:merge", null, 1], ["bulkDeleteClassifications", "post", "/v1/entity/taxonomies/classifications:delete", null, 1], ["createSchemaAttribute", "post", "/v1/entity/schemas/attributes", null, 1], ["getSchemaAttribute", "get", "/v1/entity/schemas/attributes/{composite_id}", [["composite_id", "p", true]]], ["putSchemaAttribute", "put", "/v1/entity/schemas/attributes/{composite_id}", [["composite_id", "p", true]], 1], ["deleteSchemaAttribute", "delete", "/v1/entity/schemas/attributes/{composite_id}", [["composite_id", "p", true]]], ["createSchemaCapability", "post", "/v1/entity/schemas/capabilities", null, 1], ["getSchemaCapability", "get", "/v1/entity/schemas/capabilities/{composite_id}", [["composite_id", "p", true]]], ["putSchemaCapability", "put", "/v1/entity/schemas/capabilities/{composite_id}", [["composite_id", "p", true]], 1], ["deleteSchemaCapability", "delete", "/v1/entity/schemas/capabilities/{composite_id}", [["composite_id", "p", true]]], ["createSchemaGroup", "post", "/v1/entity/schemas/group", null, 1], ["getSchemaGroup", "get", "/v1/entity/schemas/group/{composite_id}", [["composite_id", "p", true]]], ["putSchemaGroup", "put", "/v1/entity/schemas/group/{composite_id}", [["composite_id", "p", true]], 1], ["deleteSchemaGroup", "delete", "/v1/entity/schemas/group/{composite_id}", [["composite_id", "p", true]]], ["createSchemaGroupHeadline", "post", "/v1/entity/schemas/headline", null, 1], ["getSchemaGroupHeadline", "get", "/v1/entity/schemas/headline/{composite_id}", [["composite_id", "p", true]]], ["putSchemaGroupHeadline", "put", "/v1/entity/schemas/headline/{composite_id}", [["composite_id", "p", true]], 1], ["deleteSchemaGroupHeadline", "delete", "/v1/entity/schemas/headline/{composite_id}", [["composite_id", "p", true]]]], cp: { EntityIdPathParam: ["id", "p", true], EntitySlugPathParam: ["slug", "p", true], EntitySlugPathPriceParam: ["slug", "p", true], TaxonomySlugQueryParam: ["taxonomySlug", "q", true], TaxonomySlugPathParam: ["taxonomySlug", "p", true], TaxonomySlugQueryParamOptional: ["taxonomySlug", "q"], TaxonomyClassificationSlugPathParam: ["classificationSlug", "p", true], SavedViewIdPathParam: ["id", "p", true], AsyncOperationQueryParam: ["async", "q"], HydrateEntitiesQueryParam: ["hydrate", "q"], ActivityIdQueryParam: ["activity_id", "q"], ActivityIdPathParam: ["id", "p", true], FromPageQueryParam: ["from", "q"], IncludeReverseDeprecatedQueryParam: ["include_reverse", "q"], IncludeReverseQueryParam: ["include_reverse", "q"], IncludeSchemasQueryParam: ["include_schemas", "q", false, "form", false], ExcludeSchemasQueryParam: ["exclude_schemas", "q", false, "form", false], EntityRelationsModeQueryParam: ["mode", "q"], DryRunQueryParam: ["dry_run", "q"], FillActivityQueryParam: ["fill_activity", "q"], ValidateEntityQueryParam: ["validate", "q"], DirectQueryParam: ["direct", "q"], ApplyChangesetsQueryParam: ["apply_changesets", "q"] } };
|
|
9
|
-
}
|
|
10
|
-
});
|
|
11
|
-
|
|
12
|
-
export {
|
|
13
|
-
require_entity_runtime
|
|
14
|
-
};
|
package/dist/chunk-UBQCDPW6.cjs
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports, "__esModule", {value: true});
|
|
2
|
-
|
|
3
|
-
var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
|
|
4
|
-
|
|
5
|
-
// src/definitions/entity-runtime.json
|
|
6
|
-
var require_entity_runtime = _chunkNJK5F5TFcjs.__commonJS.call(void 0, {
|
|
7
|
-
"src/definitions/entity-runtime.json"(exports, module) {
|
|
8
|
-
module.exports = { s: "https://entity.sls.epilot.io", o: [["listSchemas", "get", "/v1/entity/schemas", [["unpublished", "q"], ["latest", "q"], ["exclude", "q", false, "form", false], ["include", "q", false, "form", false]]], ["listSchemasV2", "get", "/v2/entity/schemas", [["full", "q"], ["unpublished", "q"], ["latest", "q"], ["exclude", "q", false, "form", false], ["include", "q", false, "form", false]]], ["getSchema", "get", "/v1/entity/schemas/{slug}", [["EntitySlugPathParam"], ["id", "q"], ["latest", "q"]]], ["putSchema", "put", "/v1/entity/schemas/{slug}", [["EntitySlugPathParam"], ["draft", "q"]], 1], ["deleteSchema", "delete", "/v1/entity/schemas/{slug}", [["EntitySlugPathParam"]]], ["getJsonSchema", "get", "/v1/entity/schemas/{slug}/json/schema", [["EntitySlugPathParam"], ["dereference", "q"]]], ["getSchemaExample", "get", "/v1/entity/schemas/{slug}/json/example", [["EntitySlugPathParam"]]], ["getSchemaVersions", "get", "/v1/entity/schemas/{slug}/versions", [["EntitySlugPathParam"], ["versions_from", "q"], ["versions_size", "q"], ["drafts_from", "q"], ["drafts_size", "q"], ["fields", "q", false, "form", false]]], ["freezeSchema", "post", "/v1/entity/schemas/{slug}/freeze", [["EntitySlugPathParam"]], 1], ["unfreezeSchema", "post", "/v1/entity/schemas/{slug}/unfreeze", [["EntitySlugPathParam"]]], ["listAvailableCapabilities", "get", "/v1/entity/schemas/{slug}/capabilities/available", [["EntitySlugPathParam"]]], ["listSchemaBlueprints", "get", "/v1/entity/schemas/blueprints"], ["searchEntities", "post", "/v1/entity:search", null, 1], ["listEntities", "post", "/v1/entity:list", null, 1], ["queryEntityGraph", "post", "/v1/entity:graph", null, 1], ["createEntity", "post", "/v1/entity/{slug}", [["EntitySlugPathParam"], ["ActivityIdQueryParam"], ["FillActivityQueryParam"], ["AsyncOperationQueryParam"], ["ValidateEntityQueryParam"]], 1], ["validateEntity", "post", "/v1/entity/{slug}:validate", [["EntitySlugPathPriceParam"]], 1], ["validateEntityV2", "post", "/v2/entity/{slug}:validate", [["EntitySlugPathPriceParam"]], 1], ["upsertEntity", "patch", "/v1/entity/{slug}:upsert", [["EntitySlugPathParam"], ["ActivityIdQueryParam"], ["FillActivityQueryParam"], ["DryRunQueryParam"], ["AsyncOperationQueryParam"], ["ValidateEntityQueryParam"], ["strict", "q"]], 1], ["getEntityV2", "get", "/v2/entity/{slug}/{id}", [["EntityIdPathParam"], ["EntitySlugPathParam"], ["HydrateEntitiesQueryParam"], ["fields", "q", false, "form", false], ["ApplyChangesetsQueryParam"]]], ["restoreEntity", "patch", "/v1/entity/{slug}/{id}:restore", [["EntityIdPathParam"], ["EntitySlugPathParam"], ["ActivityIdQueryParam"]], 1], ["reindexEntity", "post", "/v1/entity/{slug}/{id}:reindex", [["EntityIdPathParam"], ["EntitySlugPathParam"]], 1], ["getEntity", "get", "/v1/entity/{slug}/{id}", [["EntityIdPathParam"], ["EntitySlugPathParam"], ["HydrateEntitiesQueryParam"]]], ["updateEntity", "put", "/v1/entity/{slug}/{id}", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["ActivityIdQueryParam"], ["FillActivityQueryParam"], ["AsyncOperationQueryParam"], ["ValidateEntityQueryParam"], ["DirectQueryParam"]], 1], ["patchEntity", "patch", "/v1/entity/{slug}/{id}", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["ActivityIdQueryParam"], ["FillActivityQueryParam"], ["DryRunQueryParam"], ["AsyncOperationQueryParam"], ["ValidateEntityQueryParam"], ["DirectQueryParam"]], 1], ["deleteEntity", "delete", "/v1/entity/{slug}/{id}", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["ActivityIdQueryParam"], ["purge", "q"]]], ["autocomplete", "get", "/v1/entity:autocomplete", [["input", "q"], ["attribute", "q", true], ["slug", "q"], ["size", "q"]]], ["wipeAllEntities", "post", "/v1/entity:wipeAllEntities", null, 1], ["createActivity", "post", "/v1/entity/activity", [["entities", "q", false, "form", false]], 1], ["getActivity", "get", "/v1/entity/activity/{id}", [["ActivityIdPathParam"], ["operations_size", "q"], ["operations_from", "q"]]], ["attachActivity", "post", "/v1/entity/activity/{id}:attach", [["ActivityIdPathParam"], ["entities", "q", false, "form", false]]], ["applyChangeset", "post", "/v1/entity/{slug}/{id}/changesets/{attribute}:apply", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["attribute", "p", true]]], ["dismissChangeset", "post", "/v1/entity/{slug}/{id}/changesets/{attribute}:dismiss", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["attribute", "p", true]], 1], ["listChangesets", "get", "/v1/entity/{slug}/{id}/changesets", [["EntitySlugPathParam"], ["EntityIdPathParam"]]], ["getEntityActivityFeed", "get", "/v1/entity/{slug}/{id}/activity", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["after", "q"], ["before", "q"], ["start_date", "q"], ["end_date", "q"], ["preset_range", "q"], ["FromPageQueryParam"], ["size", "q"], ["type", "q", false, "form", false], ["include_relations", "q"], ["exclude_activity_groups", "q"]]], ["getRelations", "get", "/v1/entity/{slug}/{id}/relations", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["HydrateEntitiesQueryParam"], ["IncludeReverseQueryParam"], ["FromPageQueryParam"], ["size", "q"], ["IncludeSchemasQueryParam"], ["ExcludeSchemasQueryParam"]]], ["addRelations", "post", "/v1/entity/{slug}/{id}/relations", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["AsyncOperationQueryParam"], ["ActivityIdQueryParam"]], 1], ["removeRelations", "delete", "/v1/entity/{slug}/{id}/relations", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["AsyncOperationQueryParam"], ["ActivityIdQueryParam"]], 1], ["getRelationsV2", "get", "/v2/entity/{slug}/{id}/relations", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["HydrateEntitiesQueryParam"], ["query", "q"], ["IncludeReverseQueryParam"], ["FromPageQueryParam"], ["size", "q"], ["fields", "q"]]], ["getRelationsV3", "get", "/v3/entity/{slug}/{id}/relations", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["HydrateEntitiesQueryParam"], ["IncludeReverseDeprecatedQueryParam"], ["FromPageQueryParam"], ["size", "q"], ["IncludeSchemasQueryParam"], ["ExcludeSchemasQueryParam"], ["EntityRelationsModeQueryParam"], ["fields", "q"], ["include_deleted", "q"]]], ["getRelatedEntitiesCount", "get", "/v2/entity/{slug}/{id}/relations/count", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["ExcludeSchemasQueryParam"]]], ["updateRelation", "put", "/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["attribute", "p", true], ["entity_id", "p", true], ["AsyncOperationQueryParam"], ["ActivityIdQueryParam"]], 1], ["deleteRelation", "delete", "/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}", [["EntitySlugPathParam"], ["EntityIdPathParam"], ["attribute", "p", true], ["entity_id", "p", true], ["AsyncOperationQueryParam"], ["ActivityIdQueryParam"]]], ["exportEntities", "post", "/v1/entity:export", [["job_id", "q"], ["is_template", "q"], ["language", "q"]], 1], ["importEntities", "post", "/v1/entity:import", [["job_id", "q"]], 1], ["listSavedViews", "get", "/v1/entity/views", [["slug", "q"], ["sort", "q"], ["from", "q"], ["size", "q"], ["fields", "q"]]], ["createSavedView", "post", "/v1/entity/view", null, 1], ["getSavedView", "get", "/v1/entity/view/{id}", [["SavedViewIdPathParam"]]], ["updateSavedView", "put", "/v1/entity/view/{id}", [["SavedViewIdPathParam"]], 1], ["patchSavedView", "patch", "/v1/entity/view/{id}", [["SavedViewIdPathParam"]], 1], ["deleteSavedView", "delete", "/v1/entity/view/{id}", [["SavedViewIdPathParam"]]], ["listFavoriteViewsForUser", "get", "/v1/entity/views/favorites"], ["listTaxonomies", "get", "/v1/entity/taxonomies", [["include_disabled", "q"], ["type", "q"]]], ["createTaxonomy", "post", "/v1/entity/taxonomies", null, 1], ["getTaxonomy", "get", "/v1/entity/taxonomies/{taxonomySlug}", [["TaxonomySlugPathParam"]]], ["updateTaxonomy", "put", "/v1/entity/taxonomies/{taxonomySlug}", [["TaxonomySlugPathParam"]], 1], ["deleteTaxonomy", "delete", "/v1/entity/taxonomies/{taxonomySlug}", [["TaxonomySlugPathParam"], ["permanent", "q"]]], ["updateClassificationsForTaxonomy", "post", "/v1/entity/taxonomies/{taxonomySlug}/classifications", [["TaxonomySlugPathParam"]], 1], ["createTaxonomyClassification", "post", "/v2/entity/taxonomies/classifications", null, 1], ["getTaxonomyClassification", "get", "/v2/entity/taxonomies/classifications/{classificationSlug}", [["TaxonomyClassificationSlugPathParam"]]], ["updateTaxonomyClassification", "put", "/v2/entity/taxonomies/classifications/{classificationSlug}", [["TaxonomyClassificationSlugPathParam"]], 1], ["deleteTaxonomyClassification", "delete", "/v2/entity/taxonomies/classifications/{classificationSlug}", [["TaxonomyClassificationSlugPathParam"]]], ["taxonomyAutocomplete", "get", "/v1/entity/taxonomies/{taxonomySlug}:autocomplete", [["TaxonomySlugPathParam"], ["query", "q"], ["size", "q"]]], ["taxonomiesClassificationsSearch", "post", "/v1/entity/taxonomies/classifications:search", [["taxonomySlug", "q"], ["query", "q"], ["archived", "q"], ["include_archived", "q"], ["exclude_types", "q"]], 1], ["listTaxonomyClassificationsForSchema", "get", "/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}", [["EntitySlugPathParam"], ["TaxonomySlugPathParam"], ["query", "q"], ["size", "q"]]], ["getTaxonomyBulkActionJobs", "get", "/v1/entity/taxonomies/bulk-jobs", [["status", "q"], ["size", "q"], ["created_after", "q"], ["sort_pending_first", "q"], ["scope", "q"]]], ["getTaxonomyBulkActionJobById", "get", "/v1/entity/taxonomies/bulk-jobs/{job_id}", [["job_id", "p", true]]], ["cancelBulkAction", "post", "/v1/entity/taxonomies/bulk-jobs/{job_id}/cancel", [["job_id", "p", true]]], ["bulkMoveClassifications", "post", "/v1/entity/taxonomies/classifications:move", null, 1], ["bulkMergeClassifications", "post", "/v1/entity/taxonomies/classifications:merge", null, 1], ["bulkDeleteClassifications", "post", "/v1/entity/taxonomies/classifications:delete", null, 1], ["createSchemaAttribute", "post", "/v1/entity/schemas/attributes", null, 1], ["getSchemaAttribute", "get", "/v1/entity/schemas/attributes/{composite_id}", [["composite_id", "p", true]]], ["putSchemaAttribute", "put", "/v1/entity/schemas/attributes/{composite_id}", [["composite_id", "p", true]], 1], ["deleteSchemaAttribute", "delete", "/v1/entity/schemas/attributes/{composite_id}", [["composite_id", "p", true]]], ["createSchemaCapability", "post", "/v1/entity/schemas/capabilities", null, 1], ["getSchemaCapability", "get", "/v1/entity/schemas/capabilities/{composite_id}", [["composite_id", "p", true]]], ["putSchemaCapability", "put", "/v1/entity/schemas/capabilities/{composite_id}", [["composite_id", "p", true]], 1], ["deleteSchemaCapability", "delete", "/v1/entity/schemas/capabilities/{composite_id}", [["composite_id", "p", true]]], ["createSchemaGroup", "post", "/v1/entity/schemas/group", null, 1], ["getSchemaGroup", "get", "/v1/entity/schemas/group/{composite_id}", [["composite_id", "p", true]]], ["putSchemaGroup", "put", "/v1/entity/schemas/group/{composite_id}", [["composite_id", "p", true]], 1], ["deleteSchemaGroup", "delete", "/v1/entity/schemas/group/{composite_id}", [["composite_id", "p", true]]], ["createSchemaGroupHeadline", "post", "/v1/entity/schemas/headline", null, 1], ["getSchemaGroupHeadline", "get", "/v1/entity/schemas/headline/{composite_id}", [["composite_id", "p", true]]], ["putSchemaGroupHeadline", "put", "/v1/entity/schemas/headline/{composite_id}", [["composite_id", "p", true]], 1], ["deleteSchemaGroupHeadline", "delete", "/v1/entity/schemas/headline/{composite_id}", [["composite_id", "p", true]]]], cp: { EntityIdPathParam: ["id", "p", true], EntitySlugPathParam: ["slug", "p", true], EntitySlugPathPriceParam: ["slug", "p", true], TaxonomySlugQueryParam: ["taxonomySlug", "q", true], TaxonomySlugPathParam: ["taxonomySlug", "p", true], TaxonomySlugQueryParamOptional: ["taxonomySlug", "q"], TaxonomyClassificationSlugPathParam: ["classificationSlug", "p", true], SavedViewIdPathParam: ["id", "p", true], AsyncOperationQueryParam: ["async", "q"], HydrateEntitiesQueryParam: ["hydrate", "q"], ActivityIdQueryParam: ["activity_id", "q"], ActivityIdPathParam: ["id", "p", true], FromPageQueryParam: ["from", "q"], IncludeReverseDeprecatedQueryParam: ["include_reverse", "q"], IncludeReverseQueryParam: ["include_reverse", "q"], IncludeSchemasQueryParam: ["include_schemas", "q", false, "form", false], ExcludeSchemasQueryParam: ["exclude_schemas", "q", false, "form", false], EntityRelationsModeQueryParam: ["mode", "q"], DryRunQueryParam: ["dry_run", "q"], FillActivityQueryParam: ["fill_activity", "q"], ValidateEntityQueryParam: ["validate", "q"], DirectQueryParam: ["direct", "q"], ApplyChangesetsQueryParam: ["apply_changesets", "q"] } };
|
|
9
|
-
}
|
|
10
|
-
});
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
exports.require_entity_runtime = require_entity_runtime;
|
package/dist/design-NISDHPFD.cjs
DELETED
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
-
|
|
3
|
-
// src/docs/design.json
|
|
4
|
-
var design_default = '# Design Builder API v2\n\n- **Base URL:** `https://design-builder-api.{environment}.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/design](https://docs.epilot.io/api/design)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.design.getAllDesigns(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/design\'\n\nconst designClient = getClient()\nauthorize(designClient, () => \'<token>\')\nconst { data } = await designClient.getAllDesigns(...)\n```\n\n## Operations\n\n**design-builder**\n- [`getAllDesigns`](#getalldesigns)\n- [`addDesign`](#adddesign)\n- [`getDesign`](#getdesign)\n- [`deleteDesign`](#deletedesign)\n- [`updateDesign`](#updatedesign)\n- [`getThemeFromDesign`](#getthemefromdesign)\n- [`uploadFile`](#uploadfile)\n- [`getFiles`](#getfiles)\n- [`getConsumerDesign`](#getconsumerdesign)\n- [`addConsumer`](#addconsumer)\n- [`removeConsumer`](#removeconsumer)\n\n**Schemas**\n- [`UploadFileReq`](#uploadfilereq)\n- [`UploadFileRes`](#uploadfileres)\n- [`GetFilesRes`](#getfilesres)\n- [`GetAllDesignsRes`](#getalldesignsres)\n- [`GetBrandsRes`](#getbrandsres)\n- [`AddDesignReq`](#adddesignreq)\n- [`AddDesignRes`](#adddesignres)\n- [`GetDesignRes`](#getdesignres)\n- [`UpdateDesignReq`](#updatedesignreq)\n- [`ItemMetada`](#itemmetada)\n- [`AddConsumerReq`](#addconsumerreq)\n- [`RemoveConsumerReq`](#removeconsumerreq)\n- [`DesignItem`](#designitem)\n- [`BrandItem`](#branditem)\n- [`Custom_Style`](#custom_style)\n- [`Journey`](#journey)\n- [`ConsumerData`](#consumerdata)\n- [`WidgetData`](#widgetdata)\n- [`CustomerPortalData`](#customerportaldata)\n- [`LogoData`](#logodata)\n- [`PaletteData`](#palettedata)\n- [`TypographyData`](#typographydata)\n- [`ShapeData`](#shapedata)\n- [`FontData`](#fontdata)\n- [`FontResponseUrl`](#fontresponseurl)\n- [`WidgetPortalData`](#widgetportaldata)\n- [`ErrorResp`](#errorresp)\n- [`FileData`](#filedata)\n- [`DesignId`](#designid)\n- [`Theme`](#theme)\n- [`Application`](#application)\n- [`DesignParameters`](#designparameters)\n\n### `getAllDesigns`\n\nScan all designs linked to a organization, based in orgId attribute from JWT auth token\n\n`GET /v1/designs`\n\n```ts\nconst { data } = await client.getAllDesigns()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "designs": [\n {\n "id": "string",\n "created_at": "2021-01-30T08:30:00Z",\n "created_by": "string",\n "edited": true,\n "last_modified_at": "string",\n "brand_id": "string",\n "brand_name": "string",\n "user": {\n "emailaddress": "string",\n "fullname": "string",\n "name": "string",\n "userid": "string"\n },\n "style_name": "string",\n "style": {\n "logo": {\n "main": {\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "string"\n }\n },\n "palette": {\n "primary": "string",\n "secondary": "string",\n "error": "string",\n "background": "string",\n "paper": "string",\n "navbar": "string",\n "portal_login_background": "string"\n },\n "typography": {\n "font": {\n "font_id": "string",\n "font_name": "string",\n "font_family": "string",\n "font_weight_regular": "string",\n "font_weight_medium": "string",\n "font_weight_bold": "string",\n "urls": [\n {\n "type": "WOFF2",\n "url": "string"\n }\n ]\n },\n "primary": "string",\n "secondary": "string"\n },\n "shape": {\n "border_radius": 0\n },\n "consumer": {\n "widgets": [\n {\n "id": "string",\n "name": "string"\n }\n ],\n "customer_portals": [\n {\n "id": "string",\n "name": "string"\n }\n ]\n }\n },\n "is_default": true,\n "_manifest": ["string"],\n "custom_theme": "string",\n "use_custom_theme": true,\n "design_tokens": {\n "coupon": "string",\n "cashback": "string",\n "custom_css": "string"\n }\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `addDesign`\n\nCreate a brand new design linked to a organization, based in orgId attribute from JWT auth token\n\n`POST /v1/designs`\n\n```ts\nconst { data } = await client.addDesign(\n null,\n {\n design: {\n brand_id: \'string\',\n brand_name: \'string\',\n user: {\n emailaddress: \'string\',\n fullname: \'string\',\n name: \'string\',\n userid: \'string\'\n },\n style_name: \'string\',\n style: {\n logo: {\n main: {\n name: \'string\',\n display_name: \'string\',\n file_type: \'LOGO\',\n s3_object_key: \'string\',\n url: \'string\'\n }\n },\n palette: {\n primary: \'string\',\n secondary: \'string\',\n error: \'string\',\n background: \'string\',\n paper: \'string\',\n navbar: \'string\',\n portal_login_background: \'string\'\n },\n typography: {\n font: {\n font_id: \'string\',\n font_name: \'string\',\n font_family: \'string\',\n font_weight_regular: \'string\',\n font_weight_medium: \'string\',\n font_weight_bold: \'string\',\n urls: [\n {\n type: \'WOFF2\',\n url: \'string\'\n }\n ]\n },\n primary: \'string\',\n secondary: \'string\'\n },\n shape: {\n border_radius: 0\n },\n consumer: {\n widgets: [\n {\n id: \'string\',\n name: \'string\'\n }\n ],\n customer_portals: [\n {\n id: \'string\',\n name: \'string\'\n }\n ]\n }\n },\n is_default: true,\n _manifest: [\'string\'],\n custom_theme: \'string\',\n use_custom_theme: true,\n design_tokens: {\n coupon: \'string\',\n cashback: \'string\',\n custom_css: \'string\'\n }\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "design": {\n "id": "string",\n "created_at": "2021-01-30T08:30:00Z",\n "created_by": "string",\n "edited": true,\n "last_modified_at": "string",\n "brand_id": "string",\n "brand_name": "string",\n "user": {\n "emailaddress": "string",\n "fullname": "string",\n "name": "string",\n "userid": "string"\n },\n "style_name": "string",\n "style": {\n "logo": {\n "main": {\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "string"\n }\n },\n "palette": {\n "primary": "string",\n "secondary": "string",\n "error": "string",\n "background": "string",\n "paper": "string",\n "navbar": "string",\n "portal_login_background": "string"\n },\n "typography": {\n "font": {\n "font_id": "string",\n "font_name": "string",\n "font_family": "string",\n "font_weight_regular": "string",\n "font_weight_medium": "string",\n "font_weight_bold": "string",\n "urls": [\n {\n "type": "WOFF2",\n "url": "string"\n }\n ]\n },\n "primary": "string",\n "secondary": "string"\n },\n "shape": {\n "border_radius": 0\n },\n "consumer": {\n "widgets": [\n {\n "id": "string",\n "name": "string"\n }\n ],\n "customer_portals": [\n {\n "id": "string",\n "name": "string"\n }\n ]\n }\n },\n "is_default": true,\n "_manifest": ["string"],\n "custom_theme": "string",\n "use_custom_theme": true,\n "design_tokens": {\n "coupon": "string",\n "cashback": "string",\n "custom_css": "string"\n }\n }\n}\n```\n\n</details>\n\n---\n\n### `getDesign`\n\nSearch for a especific design owned by user organization\n\n`GET /v1/designs/{designId}`\n\n```ts\nconst { data } = await client.getDesign({\n designId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "design": {\n "id": "string",\n "created_at": "2021-01-30T08:30:00Z",\n "created_by": "string",\n "edited": true,\n "last_modified_at": "string",\n "brand_id": "string",\n "brand_name": "string",\n "user": {\n "emailaddress": "string",\n "fullname": "string",\n "name": "string",\n "userid": "string"\n },\n "style_name": "string",\n "style": {\n "logo": {\n "main": {\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "string"\n }\n },\n "palette": {\n "primary": "string",\n "secondary": "string",\n "error": "string",\n "background": "string",\n "paper": "string",\n "navbar": "string",\n "portal_login_background": "string"\n },\n "typography": {\n "font": {\n "font_id": "string",\n "font_name": "string",\n "font_family": "string",\n "font_weight_regular": "string",\n "font_weight_medium": "string",\n "font_weight_bold": "string",\n "urls": [\n {\n "type": "WOFF2",\n "url": "string"\n }\n ]\n },\n "primary": "string",\n "secondary": "string"\n },\n "shape": {\n "border_radius": 0\n },\n "consumer": {\n "widgets": [\n {\n "id": "string",\n "name": "string"\n }\n ],\n "customer_portals": [\n {\n "id": "string",\n "name": "string"\n }\n ]\n }\n },\n "is_default": true,\n "_manifest": ["string"],\n "custom_theme": "string",\n "use_custom_theme": true,\n "design_tokens": {\n "coupon": "string",\n "cashback": "string",\n "custom_css": "string"\n }\n }\n}\n```\n\n</details>\n\n---\n\n### `deleteDesign`\n\nSearch and delete for a especific design owned by user organization\n\n`DELETE /v1/designs/{designId}`\n\n```ts\nconst { data } = await client.deleteDesign({\n designId: \'example\',\n})\n```\n\n---\n\n### `updateDesign`\n\nUpdate a especific design owned by user organization\n\n`PUT /v1/designs/{designId}`\n\n```ts\nconst { data } = await client.updateDesign(\n {\n designId: \'example\',\n },\n {\n design: {\n brand_id: \'string\',\n brand_name: \'string\',\n user: {\n emailaddress: \'string\',\n fullname: \'string\',\n name: \'string\',\n userid: \'string\'\n },\n style_name: \'string\',\n style: {\n logo: {\n main: {\n name: \'string\',\n display_name: \'string\',\n file_type: \'LOGO\',\n s3_object_key: \'string\',\n url: \'string\'\n }\n },\n palette: {\n primary: \'string\',\n secondary: \'string\',\n error: \'string\',\n background: \'string\',\n paper: \'string\',\n navbar: \'string\',\n portal_login_background: \'string\'\n },\n typography: {\n font: {\n font_id: \'string\',\n font_name: \'string\',\n font_family: \'string\',\n font_weight_regular: \'string\',\n font_weight_medium: \'string\',\n font_weight_bold: \'string\',\n urls: [\n {\n type: \'WOFF2\',\n url: \'string\'\n }\n ]\n },\n primary: \'string\',\n secondary: \'string\'\n },\n shape: {\n border_radius: 0\n },\n consumer: {\n widgets: [\n {\n id: \'string\',\n name: \'string\'\n }\n ],\n customer_portals: [\n {\n id: \'string\',\n name: \'string\'\n }\n ]\n }\n },\n is_default: true,\n _manifest: [\'string\'],\n custom_theme: \'string\',\n use_custom_theme: true,\n design_tokens: {\n coupon: \'string\',\n cashback: \'string\',\n custom_css: \'string\'\n }\n }\n },\n)\n```\n\n---\n\n### `getThemeFromDesign`\n\nSearch for a especific design owned by user organization and parse them to a new or old theme\n\n`GET /v1/designs/{designId}/parse`\n\n```ts\nconst { data } = await client.getThemeFromDesign({\n designId: \'example\',\n orgId: \'example\',\n theme: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `uploadFile`\n\nUpload a new file for the user organization bucket\n\n`POST /v1/designs/files`\n\n```ts\nconst { data } = await client.uploadFile()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "string"\n}\n```\n\n</details>\n\n---\n\n### `getFiles`\n\nList all files for the user organization bucket\n\n`GET /v1/designs/files`\n\n```ts\nconst { data } = await client.getFiles({\n type: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "string"\n }\n]\n```\n\n</details>\n\n---\n\n### `getConsumerDesign`\n\nSearch for a especific design owned by user organization\n\n`GET /v1/designs/consumer/{application}/{consumerId}`\n\n```ts\nconst { data } = await client.getConsumerDesign({\n consumerId: \'example\',\n application: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "design": {\n "id": "string",\n "created_at": "2021-01-30T08:30:00Z",\n "created_by": "string",\n "edited": true,\n "last_modified_at": "string",\n "brand_id": "string",\n "brand_name": "string",\n "user": {\n "emailaddress": "string",\n "fullname": "string",\n "name": "string",\n "userid": "string"\n },\n "style_name": "string",\n "style": {\n "logo": {\n "main": {\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "string"\n }\n },\n "palette": {\n "primary": "string",\n "secondary": "string",\n "error": "string",\n "background": "string",\n "paper": "string",\n "navbar": "string",\n "portal_login_background": "string"\n },\n "typography": {\n "font": {\n "font_id": "string",\n "font_name": "string",\n "font_family": "string",\n "font_weight_regular": "string",\n "font_weight_medium": "string",\n "font_weight_bold": "string",\n "urls": [\n {\n "type": "WOFF2",\n "url": "string"\n }\n ]\n },\n "primary": "string",\n "secondary": "string"\n },\n "shape": {\n "border_radius": 0\n },\n "consumer": {\n "widgets": [\n {\n "id": "string",\n "name": "string"\n }\n ],\n "customer_portals": [\n {\n "id": "string",\n "name": "string"\n }\n ]\n }\n },\n "is_default": true,\n "_manifest": ["string"],\n "custom_theme": "string",\n "use_custom_theme": true,\n "design_tokens": {\n "coupon": "string",\n "cashback": "string",\n "custom_css": "string"\n }\n }\n}\n```\n\n</details>\n\n---\n\n### `addConsumer`\n\nAdd a consumer that uses a specific design\n\n`PUT /v1/designs/addConsumer/{application}/{designId}`\n\n```ts\nconst { data } = await client.addConsumer(\n {\n designId: \'example\',\n application: \'example\',\n },\n {\n consumer_id: \'4a062990-a6a3-11eb-9828-4f3da7d4935a\',\n consumer_name: \'string\',\n should_delete: \'string\'\n },\n)\n```\n\n---\n\n### `removeConsumer`\n\nRemove a consumer that uses a specific design\n\n`PUT /v1/designs/removeConsumer/{application}/{designId}`\n\n```ts\nconst { data } = await client.removeConsumer(\n {\n designId: \'example\',\n application: \'example\',\n },\n {\n consumer_id: \'4a062990-a6a3-11eb-9828-4f3da7d4935a\',\n should_delete: \'string\'\n },\n)\n```\n\n---\n\n## Schemas\n\n### `UploadFileReq`\n\n```ts\ntype UploadFileReq = {\n file_type: "LOGO" | "FONT"\n file_data: string // base64\n display_name?: string\n file_name: string\n}\n```\n\n### `UploadFileRes`\n\n```ts\ntype UploadFileRes = {\n name: string\n display_name?: string\n file_type?: "LOGO" | "FONT"\n s3_object_key: string\n url: string\n}\n```\n\n### `GetFilesRes`\n\n```ts\ntype GetFilesRes = Array<{\n name: string\n display_name?: string\n file_type?: "LOGO" | "FONT"\n s3_object_key: string\n url: string\n}>\n```\n\n### `GetAllDesignsRes`\n\n```ts\ntype GetAllDesignsRes = {\n designs?: Array<{\n id?: string\n created_at?: string\n created_by?: string\n edited: boolean\n last_modified_at?: string\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n }\n }>\n}\n```\n\n### `GetBrandsRes`\n\n```ts\ntype GetBrandsRes = {\n brands?: Array<{\n id: string\n name: string\n created_by?: string\n created_date?: string\n main_brand?: string\n organization_id?: string\n updated_date?: string\n updated_by?: string\n status?: string\n }>\n}\n```\n\n### `AddDesignReq`\n\n```ts\ntype AddDesignReq = {\n design: {\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n }\n }\n}\n```\n\n### `AddDesignRes`\n\n```ts\ntype AddDesignRes = {\n design?: {\n id?: string\n created_at?: string\n created_by?: string\n edited: boolean\n last_modified_at?: string\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n }\n }\n}\n```\n\n### `GetDesignRes`\n\n```ts\ntype GetDesignRes = {\n design?: {\n id?: string\n created_at?: string\n created_by?: string\n edited: boolean\n last_modified_at?: string\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n }\n }\n}\n```\n\n### `UpdateDesignReq`\n\n```ts\ntype UpdateDesignReq = {\n design: {\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n }\n }\n}\n```\n\n### `ItemMetada`\n\n```ts\ntype ItemMetada = {\n id?: string\n created_at?: string\n created_by?: string\n edited?: boolean\n last_modified_at?: string\n}\n```\n\n### `AddConsumerReq`\n\n```ts\ntype AddConsumerReq = {\n consumer_id: string\n consumer_name: string\n should_delete?: string\n}\n```\n\n### `RemoveConsumerReq`\n\n```ts\ntype RemoveConsumerReq = {\n consumer_id: string\n should_delete?: string\n}\n```\n\n### `DesignItem`\n\n```ts\ntype DesignItem = {\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: string\n fullname?: string\n name?: string\n userid?: string\n }\n style_name: string\n style: {\n logo?: {\n main?: { ... }\n }\n palette: {\n primary: { ... }\n secondary: { ... }\n error: { ... }\n background: { ... }\n paper: { ... }\n navbar: { ... }\n portal_login_background?: { ... }\n }\n typography: {\n font: { ... }\n primary: { ... }\n secondary: { ... }\n }\n shape?: {\n border_radius?: { ... }\n }\n consumer: {\n widgets: { ... }\n customer_portals: { ... }\n }\n }\n is_default?: boolean\n _manifest?: string[]\n}\n```\n\n### `BrandItem`\n\n```ts\ntype BrandItem = {\n id: string\n name: string\n created_by?: string\n created_date?: string\n main_brand?: string\n organization_id?: string\n updated_date?: string\n updated_by?: string\n status?: string\n}\n```\n\n### `Custom_Style`\n\n```ts\ntype Custom_Style = {\n custom_theme?: string\n use_custom_theme?: boolean\n}\n```\n\n### `Journey`\n\n```ts\ntype Journey = {\n design_tokens?: {\n coupon?: string\n cashback?: string\n custom_css?: string\n }\n}\n```\n\n### `ConsumerData`\n\n```ts\ntype ConsumerData = {\n widgets: Array<{\n id: string\n name: string\n }>\n customer_portals: Array<{\n id: string\n name: string\n }>\n}\n```\n\n### `WidgetData`\n\n```ts\ntype WidgetData = {\n id: string\n name: string\n}\n```\n\n### `CustomerPortalData`\n\n```ts\ntype CustomerPortalData = {\n id: string\n name: string\n}\n```\n\n### `LogoData`\n\n```ts\ntype LogoData = {\n main?: {\n name: string\n display_name?: string\n file_type?: "LOGO" | "FONT"\n s3_object_key: string\n url: string\n }\n}\n```\n\n### `PaletteData`\n\n```ts\ntype PaletteData = {\n primary: string\n secondary: string\n error: string\n background: string\n paper: string\n navbar: string\n portal_login_background?: string\n}\n```\n\n### `TypographyData`\n\n```ts\ntype TypographyData = {\n font: {\n font_id: string\n font_name: string\n font_family?: string\n font_weight_regular?: string\n font_weight_medium?: string\n font_weight_bold?: string\n urls: Array<{\n type?: { ... }\n url?: { ... }\n }>\n }\n primary: string\n secondary: string\n}\n```\n\n### `ShapeData`\n\n```ts\ntype ShapeData = {\n border_radius?: number\n}\n```\n\n### `FontData`\n\n```ts\ntype FontData = {\n font_id: string\n font_name: string\n font_family?: string\n font_weight_regular?: string\n font_weight_medium?: string\n font_weight_bold?: string\n urls: Array<{\n type?: "WOFF2" | "WOFF" | "TTF" | "EOT"\n url?: string\n }>\n}\n```\n\n### `FontResponseUrl`\n\n```ts\ntype FontResponseUrl = {\n type?: "WOFF2" | "WOFF" | "TTF" | "EOT"\n url?: string\n}\n```\n\n### `WidgetPortalData`\n\n```ts\ntype WidgetPortalData = {\n id: string\n name: string\n}\n```\n\n### `ErrorResp`\n\n```ts\ntype ErrorResp = {\n message?: string\n error?: object\n}\n```\n\n### `FileData`\n\n```ts\ntype FileData = {\n name: string\n display_name?: string\n file_type?: "LOGO" | "FONT"\n s3_object_key: string\n url: string\n}\n```\n\n### `DesignId`\n\nId of the design\n\n```ts\ntype DesignId = string\n```\n\n### `Theme`\n\nType of theme to be parsed and returned\n\n```ts\ntype Theme = "NEW" | "OLD"\n```\n\n### `Application`\n\nType of application that uses the design\n\n```ts\ntype Application = string\n```\n\n### `DesignParameters`\n\n```ts\ntype DesignParameters = {\n designId?: string\n theme?: "NEW" | "OLD"\n application?: string\n}\n```\n';
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
exports.default = design_default;
|
package/dist/design-WL4AZIGX.js
DELETED
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import "./chunk-YPSWSI3M.js";
|
|
2
|
-
|
|
3
|
-
// src/docs/design.json
|
|
4
|
-
var design_default = '# Design Builder API v2\n\n- **Base URL:** `https://design-builder-api.{environment}.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/design](https://docs.epilot.io/api/design)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.design.getAllDesigns(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/design\'\n\nconst designClient = getClient()\nauthorize(designClient, () => \'<token>\')\nconst { data } = await designClient.getAllDesigns(...)\n```\n\n## Operations\n\n**design-builder**\n- [`getAllDesigns`](#getalldesigns)\n- [`addDesign`](#adddesign)\n- [`getDesign`](#getdesign)\n- [`deleteDesign`](#deletedesign)\n- [`updateDesign`](#updatedesign)\n- [`getThemeFromDesign`](#getthemefromdesign)\n- [`uploadFile`](#uploadfile)\n- [`getFiles`](#getfiles)\n- [`getConsumerDesign`](#getconsumerdesign)\n- [`addConsumer`](#addconsumer)\n- [`removeConsumer`](#removeconsumer)\n\n**Schemas**\n- [`UploadFileReq`](#uploadfilereq)\n- [`UploadFileRes`](#uploadfileres)\n- [`GetFilesRes`](#getfilesres)\n- [`GetAllDesignsRes`](#getalldesignsres)\n- [`GetBrandsRes`](#getbrandsres)\n- [`AddDesignReq`](#adddesignreq)\n- [`AddDesignRes`](#adddesignres)\n- [`GetDesignRes`](#getdesignres)\n- [`UpdateDesignReq`](#updatedesignreq)\n- [`ItemMetada`](#itemmetada)\n- [`AddConsumerReq`](#addconsumerreq)\n- [`RemoveConsumerReq`](#removeconsumerreq)\n- [`DesignItem`](#designitem)\n- [`BrandItem`](#branditem)\n- [`Custom_Style`](#custom_style)\n- [`Journey`](#journey)\n- [`ConsumerData`](#consumerdata)\n- [`WidgetData`](#widgetdata)\n- [`CustomerPortalData`](#customerportaldata)\n- [`LogoData`](#logodata)\n- [`PaletteData`](#palettedata)\n- [`TypographyData`](#typographydata)\n- [`ShapeData`](#shapedata)\n- [`FontData`](#fontdata)\n- [`FontResponseUrl`](#fontresponseurl)\n- [`WidgetPortalData`](#widgetportaldata)\n- [`ErrorResp`](#errorresp)\n- [`FileData`](#filedata)\n- [`DesignId`](#designid)\n- [`Theme`](#theme)\n- [`Application`](#application)\n- [`DesignParameters`](#designparameters)\n\n### `getAllDesigns`\n\nScan all designs linked to a organization, based in orgId attribute from JWT auth token\n\n`GET /v1/designs`\n\n```ts\nconst { data } = await client.getAllDesigns()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "designs": [\n {\n "id": "string",\n "created_at": "2021-01-30T08:30:00Z",\n "created_by": "string",\n "edited": true,\n "last_modified_at": "string",\n "brand_id": "string",\n "brand_name": "string",\n "user": {\n "emailaddress": "string",\n "fullname": "string",\n "name": "string",\n "userid": "string"\n },\n "style_name": "string",\n "style": {\n "logo": {\n "main": {\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "string"\n }\n },\n "palette": {\n "primary": "string",\n "secondary": "string",\n "error": "string",\n "background": "string",\n "paper": "string",\n "navbar": "string",\n "portal_login_background": "string"\n },\n "typography": {\n "font": {\n "font_id": "string",\n "font_name": "string",\n "font_family": "string",\n "font_weight_regular": "string",\n "font_weight_medium": "string",\n "font_weight_bold": "string",\n "urls": [\n {\n "type": "WOFF2",\n "url": "string"\n }\n ]\n },\n "primary": "string",\n "secondary": "string"\n },\n "shape": {\n "border_radius": 0\n },\n "consumer": {\n "widgets": [\n {\n "id": "string",\n "name": "string"\n }\n ],\n "customer_portals": [\n {\n "id": "string",\n "name": "string"\n }\n ]\n }\n },\n "is_default": true,\n "_manifest": ["string"],\n "custom_theme": "string",\n "use_custom_theme": true,\n "design_tokens": {\n "coupon": "string",\n "cashback": "string",\n "custom_css": "string"\n }\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `addDesign`\n\nCreate a brand new design linked to a organization, based in orgId attribute from JWT auth token\n\n`POST /v1/designs`\n\n```ts\nconst { data } = await client.addDesign(\n null,\n {\n design: {\n brand_id: \'string\',\n brand_name: \'string\',\n user: {\n emailaddress: \'string\',\n fullname: \'string\',\n name: \'string\',\n userid: \'string\'\n },\n style_name: \'string\',\n style: {\n logo: {\n main: {\n name: \'string\',\n display_name: \'string\',\n file_type: \'LOGO\',\n s3_object_key: \'string\',\n url: \'string\'\n }\n },\n palette: {\n primary: \'string\',\n secondary: \'string\',\n error: \'string\',\n background: \'string\',\n paper: \'string\',\n navbar: \'string\',\n portal_login_background: \'string\'\n },\n typography: {\n font: {\n font_id: \'string\',\n font_name: \'string\',\n font_family: \'string\',\n font_weight_regular: \'string\',\n font_weight_medium: \'string\',\n font_weight_bold: \'string\',\n urls: [\n {\n type: \'WOFF2\',\n url: \'string\'\n }\n ]\n },\n primary: \'string\',\n secondary: \'string\'\n },\n shape: {\n border_radius: 0\n },\n consumer: {\n widgets: [\n {\n id: \'string\',\n name: \'string\'\n }\n ],\n customer_portals: [\n {\n id: \'string\',\n name: \'string\'\n }\n ]\n }\n },\n is_default: true,\n _manifest: [\'string\'],\n custom_theme: \'string\',\n use_custom_theme: true,\n design_tokens: {\n coupon: \'string\',\n cashback: \'string\',\n custom_css: \'string\'\n }\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "design": {\n "id": "string",\n "created_at": "2021-01-30T08:30:00Z",\n "created_by": "string",\n "edited": true,\n "last_modified_at": "string",\n "brand_id": "string",\n "brand_name": "string",\n "user": {\n "emailaddress": "string",\n "fullname": "string",\n "name": "string",\n "userid": "string"\n },\n "style_name": "string",\n "style": {\n "logo": {\n "main": {\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "string"\n }\n },\n "palette": {\n "primary": "string",\n "secondary": "string",\n "error": "string",\n "background": "string",\n "paper": "string",\n "navbar": "string",\n "portal_login_background": "string"\n },\n "typography": {\n "font": {\n "font_id": "string",\n "font_name": "string",\n "font_family": "string",\n "font_weight_regular": "string",\n "font_weight_medium": "string",\n "font_weight_bold": "string",\n "urls": [\n {\n "type": "WOFF2",\n "url": "string"\n }\n ]\n },\n "primary": "string",\n "secondary": "string"\n },\n "shape": {\n "border_radius": 0\n },\n "consumer": {\n "widgets": [\n {\n "id": "string",\n "name": "string"\n }\n ],\n "customer_portals": [\n {\n "id": "string",\n "name": "string"\n }\n ]\n }\n },\n "is_default": true,\n "_manifest": ["string"],\n "custom_theme": "string",\n "use_custom_theme": true,\n "design_tokens": {\n "coupon": "string",\n "cashback": "string",\n "custom_css": "string"\n }\n }\n}\n```\n\n</details>\n\n---\n\n### `getDesign`\n\nSearch for a especific design owned by user organization\n\n`GET /v1/designs/{designId}`\n\n```ts\nconst { data } = await client.getDesign({\n designId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "design": {\n "id": "string",\n "created_at": "2021-01-30T08:30:00Z",\n "created_by": "string",\n "edited": true,\n "last_modified_at": "string",\n "brand_id": "string",\n "brand_name": "string",\n "user": {\n "emailaddress": "string",\n "fullname": "string",\n "name": "string",\n "userid": "string"\n },\n "style_name": "string",\n "style": {\n "logo": {\n "main": {\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "string"\n }\n },\n "palette": {\n "primary": "string",\n "secondary": "string",\n "error": "string",\n "background": "string",\n "paper": "string",\n "navbar": "string",\n "portal_login_background": "string"\n },\n "typography": {\n "font": {\n "font_id": "string",\n "font_name": "string",\n "font_family": "string",\n "font_weight_regular": "string",\n "font_weight_medium": "string",\n "font_weight_bold": "string",\n "urls": [\n {\n "type": "WOFF2",\n "url": "string"\n }\n ]\n },\n "primary": "string",\n "secondary": "string"\n },\n "shape": {\n "border_radius": 0\n },\n "consumer": {\n "widgets": [\n {\n "id": "string",\n "name": "string"\n }\n ],\n "customer_portals": [\n {\n "id": "string",\n "name": "string"\n }\n ]\n }\n },\n "is_default": true,\n "_manifest": ["string"],\n "custom_theme": "string",\n "use_custom_theme": true,\n "design_tokens": {\n "coupon": "string",\n "cashback": "string",\n "custom_css": "string"\n }\n }\n}\n```\n\n</details>\n\n---\n\n### `deleteDesign`\n\nSearch and delete for a especific design owned by user organization\n\n`DELETE /v1/designs/{designId}`\n\n```ts\nconst { data } = await client.deleteDesign({\n designId: \'example\',\n})\n```\n\n---\n\n### `updateDesign`\n\nUpdate a especific design owned by user organization\n\n`PUT /v1/designs/{designId}`\n\n```ts\nconst { data } = await client.updateDesign(\n {\n designId: \'example\',\n },\n {\n design: {\n brand_id: \'string\',\n brand_name: \'string\',\n user: {\n emailaddress: \'string\',\n fullname: \'string\',\n name: \'string\',\n userid: \'string\'\n },\n style_name: \'string\',\n style: {\n logo: {\n main: {\n name: \'string\',\n display_name: \'string\',\n file_type: \'LOGO\',\n s3_object_key: \'string\',\n url: \'string\'\n }\n },\n palette: {\n primary: \'string\',\n secondary: \'string\',\n error: \'string\',\n background: \'string\',\n paper: \'string\',\n navbar: \'string\',\n portal_login_background: \'string\'\n },\n typography: {\n font: {\n font_id: \'string\',\n font_name: \'string\',\n font_family: \'string\',\n font_weight_regular: \'string\',\n font_weight_medium: \'string\',\n font_weight_bold: \'string\',\n urls: [\n {\n type: \'WOFF2\',\n url: \'string\'\n }\n ]\n },\n primary: \'string\',\n secondary: \'string\'\n },\n shape: {\n border_radius: 0\n },\n consumer: {\n widgets: [\n {\n id: \'string\',\n name: \'string\'\n }\n ],\n customer_portals: [\n {\n id: \'string\',\n name: \'string\'\n }\n ]\n }\n },\n is_default: true,\n _manifest: [\'string\'],\n custom_theme: \'string\',\n use_custom_theme: true,\n design_tokens: {\n coupon: \'string\',\n cashback: \'string\',\n custom_css: \'string\'\n }\n }\n },\n)\n```\n\n---\n\n### `getThemeFromDesign`\n\nSearch for a especific design owned by user organization and parse them to a new or old theme\n\n`GET /v1/designs/{designId}/parse`\n\n```ts\nconst { data } = await client.getThemeFromDesign({\n designId: \'example\',\n orgId: \'example\',\n theme: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `uploadFile`\n\nUpload a new file for the user organization bucket\n\n`POST /v1/designs/files`\n\n```ts\nconst { data } = await client.uploadFile()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "string"\n}\n```\n\n</details>\n\n---\n\n### `getFiles`\n\nList all files for the user organization bucket\n\n`GET /v1/designs/files`\n\n```ts\nconst { data } = await client.getFiles({\n type: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "string"\n }\n]\n```\n\n</details>\n\n---\n\n### `getConsumerDesign`\n\nSearch for a especific design owned by user organization\n\n`GET /v1/designs/consumer/{application}/{consumerId}`\n\n```ts\nconst { data } = await client.getConsumerDesign({\n consumerId: \'example\',\n application: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "design": {\n "id": "string",\n "created_at": "2021-01-30T08:30:00Z",\n "created_by": "string",\n "edited": true,\n "last_modified_at": "string",\n "brand_id": "string",\n "brand_name": "string",\n "user": {\n "emailaddress": "string",\n "fullname": "string",\n "name": "string",\n "userid": "string"\n },\n "style_name": "string",\n "style": {\n "logo": {\n "main": {\n "name": "string",\n "display_name": "string",\n "file_type": "LOGO",\n "s3_object_key": "string",\n "url": "string"\n }\n },\n "palette": {\n "primary": "string",\n "secondary": "string",\n "error": "string",\n "background": "string",\n "paper": "string",\n "navbar": "string",\n "portal_login_background": "string"\n },\n "typography": {\n "font": {\n "font_id": "string",\n "font_name": "string",\n "font_family": "string",\n "font_weight_regular": "string",\n "font_weight_medium": "string",\n "font_weight_bold": "string",\n "urls": [\n {\n "type": "WOFF2",\n "url": "string"\n }\n ]\n },\n "primary": "string",\n "secondary": "string"\n },\n "shape": {\n "border_radius": 0\n },\n "consumer": {\n "widgets": [\n {\n "id": "string",\n "name": "string"\n }\n ],\n "customer_portals": [\n {\n "id": "string",\n "name": "string"\n }\n ]\n }\n },\n "is_default": true,\n "_manifest": ["string"],\n "custom_theme": "string",\n "use_custom_theme": true,\n "design_tokens": {\n "coupon": "string",\n "cashback": "string",\n "custom_css": "string"\n }\n }\n}\n```\n\n</details>\n\n---\n\n### `addConsumer`\n\nAdd a consumer that uses a specific design\n\n`PUT /v1/designs/addConsumer/{application}/{designId}`\n\n```ts\nconst { data } = await client.addConsumer(\n {\n designId: \'example\',\n application: \'example\',\n },\n {\n consumer_id: \'4a062990-a6a3-11eb-9828-4f3da7d4935a\',\n consumer_name: \'string\',\n should_delete: \'string\'\n },\n)\n```\n\n---\n\n### `removeConsumer`\n\nRemove a consumer that uses a specific design\n\n`PUT /v1/designs/removeConsumer/{application}/{designId}`\n\n```ts\nconst { data } = await client.removeConsumer(\n {\n designId: \'example\',\n application: \'example\',\n },\n {\n consumer_id: \'4a062990-a6a3-11eb-9828-4f3da7d4935a\',\n should_delete: \'string\'\n },\n)\n```\n\n---\n\n## Schemas\n\n### `UploadFileReq`\n\n```ts\ntype UploadFileReq = {\n file_type: "LOGO" | "FONT"\n file_data: string // base64\n display_name?: string\n file_name: string\n}\n```\n\n### `UploadFileRes`\n\n```ts\ntype UploadFileRes = {\n name: string\n display_name?: string\n file_type?: "LOGO" | "FONT"\n s3_object_key: string\n url: string\n}\n```\n\n### `GetFilesRes`\n\n```ts\ntype GetFilesRes = Array<{\n name: string\n display_name?: string\n file_type?: "LOGO" | "FONT"\n s3_object_key: string\n url: string\n}>\n```\n\n### `GetAllDesignsRes`\n\n```ts\ntype GetAllDesignsRes = {\n designs?: Array<{\n id?: string\n created_at?: string\n created_by?: string\n edited: boolean\n last_modified_at?: string\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n }\n }>\n}\n```\n\n### `GetBrandsRes`\n\n```ts\ntype GetBrandsRes = {\n brands?: Array<{\n id: string\n name: string\n created_by?: string\n created_date?: string\n main_brand?: string\n organization_id?: string\n updated_date?: string\n updated_by?: string\n status?: string\n }>\n}\n```\n\n### `AddDesignReq`\n\n```ts\ntype AddDesignReq = {\n design: {\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n }\n }\n}\n```\n\n### `AddDesignRes`\n\n```ts\ntype AddDesignRes = {\n design?: {\n id?: string\n created_at?: string\n created_by?: string\n edited: boolean\n last_modified_at?: string\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n }\n }\n}\n```\n\n### `GetDesignRes`\n\n```ts\ntype GetDesignRes = {\n design?: {\n id?: string\n created_at?: string\n created_by?: string\n edited: boolean\n last_modified_at?: string\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n }\n }\n}\n```\n\n### `UpdateDesignReq`\n\n```ts\ntype UpdateDesignReq = {\n design: {\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: { ... }\n fullname?: { ... }\n name?: { ... }\n userid?: { ... }\n }\n style_name: string\n style: {\n logo?: { ... }\n palette: { ... }\n typography: { ... }\n shape?: { ... }\n consumer: { ... }\n }\n is_default?: boolean\n _manifest?: string[]\n custom_theme?: string\n use_custom_theme?: boolean\n design_tokens?: {\n coupon?: { ... }\n cashback?: { ... }\n custom_css?: { ... }\n }\n }\n}\n```\n\n### `ItemMetada`\n\n```ts\ntype ItemMetada = {\n id?: string\n created_at?: string\n created_by?: string\n edited?: boolean\n last_modified_at?: string\n}\n```\n\n### `AddConsumerReq`\n\n```ts\ntype AddConsumerReq = {\n consumer_id: string\n consumer_name: string\n should_delete?: string\n}\n```\n\n### `RemoveConsumerReq`\n\n```ts\ntype RemoveConsumerReq = {\n consumer_id: string\n should_delete?: string\n}\n```\n\n### `DesignItem`\n\n```ts\ntype DesignItem = {\n brand_id?: string\n brand_name?: string\n user?: {\n emailaddress?: string\n fullname?: string\n name?: string\n userid?: string\n }\n style_name: string\n style: {\n logo?: {\n main?: { ... }\n }\n palette: {\n primary: { ... }\n secondary: { ... }\n error: { ... }\n background: { ... }\n paper: { ... }\n navbar: { ... }\n portal_login_background?: { ... }\n }\n typography: {\n font: { ... }\n primary: { ... }\n secondary: { ... }\n }\n shape?: {\n border_radius?: { ... }\n }\n consumer: {\n widgets: { ... }\n customer_portals: { ... }\n }\n }\n is_default?: boolean\n _manifest?: string[]\n}\n```\n\n### `BrandItem`\n\n```ts\ntype BrandItem = {\n id: string\n name: string\n created_by?: string\n created_date?: string\n main_brand?: string\n organization_id?: string\n updated_date?: string\n updated_by?: string\n status?: string\n}\n```\n\n### `Custom_Style`\n\n```ts\ntype Custom_Style = {\n custom_theme?: string\n use_custom_theme?: boolean\n}\n```\n\n### `Journey`\n\n```ts\ntype Journey = {\n design_tokens?: {\n coupon?: string\n cashback?: string\n custom_css?: string\n }\n}\n```\n\n### `ConsumerData`\n\n```ts\ntype ConsumerData = {\n widgets: Array<{\n id: string\n name: string\n }>\n customer_portals: Array<{\n id: string\n name: string\n }>\n}\n```\n\n### `WidgetData`\n\n```ts\ntype WidgetData = {\n id: string\n name: string\n}\n```\n\n### `CustomerPortalData`\n\n```ts\ntype CustomerPortalData = {\n id: string\n name: string\n}\n```\n\n### `LogoData`\n\n```ts\ntype LogoData = {\n main?: {\n name: string\n display_name?: string\n file_type?: "LOGO" | "FONT"\n s3_object_key: string\n url: string\n }\n}\n```\n\n### `PaletteData`\n\n```ts\ntype PaletteData = {\n primary: string\n secondary: string\n error: string\n background: string\n paper: string\n navbar: string\n portal_login_background?: string\n}\n```\n\n### `TypographyData`\n\n```ts\ntype TypographyData = {\n font: {\n font_id: string\n font_name: string\n font_family?: string\n font_weight_regular?: string\n font_weight_medium?: string\n font_weight_bold?: string\n urls: Array<{\n type?: { ... }\n url?: { ... }\n }>\n }\n primary: string\n secondary: string\n}\n```\n\n### `ShapeData`\n\n```ts\ntype ShapeData = {\n border_radius?: number\n}\n```\n\n### `FontData`\n\n```ts\ntype FontData = {\n font_id: string\n font_name: string\n font_family?: string\n font_weight_regular?: string\n font_weight_medium?: string\n font_weight_bold?: string\n urls: Array<{\n type?: "WOFF2" | "WOFF" | "TTF" | "EOT"\n url?: string\n }>\n}\n```\n\n### `FontResponseUrl`\n\n```ts\ntype FontResponseUrl = {\n type?: "WOFF2" | "WOFF" | "TTF" | "EOT"\n url?: string\n}\n```\n\n### `WidgetPortalData`\n\n```ts\ntype WidgetPortalData = {\n id: string\n name: string\n}\n```\n\n### `ErrorResp`\n\n```ts\ntype ErrorResp = {\n message?: string\n error?: object\n}\n```\n\n### `FileData`\n\n```ts\ntype FileData = {\n name: string\n display_name?: string\n file_type?: "LOGO" | "FONT"\n s3_object_key: string\n url: string\n}\n```\n\n### `DesignId`\n\nId of the design\n\n```ts\ntype DesignId = string\n```\n\n### `Theme`\n\nType of theme to be parsed and returned\n\n```ts\ntype Theme = "NEW" | "OLD"\n```\n\n### `Application`\n\nType of application that uses the design\n\n```ts\ntype Application = string\n```\n\n### `DesignParameters`\n\n```ts\ntype DesignParameters = {\n designId?: string\n theme?: "NEW" | "OLD"\n application?: string\n}\n```\n';
|
|
5
|
-
export {
|
|
6
|
-
design_default as default
|
|
7
|
-
};
|