@meshery/schemas 1.3.7 → 1.3.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/dist/cloudApi.d.mts +62 -45
  2. package/dist/cloudApi.d.ts +62 -45
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1beta1/feature/Feature.d.ts +207 -83
  6. package/dist/constructs/v1beta1/feature/FeatureSchema.js +1 -1
  7. package/dist/constructs/v1beta1/feature/FeatureSchema.mjs +1 -1
  8. package/dist/index.d.mts +123 -42
  9. package/dist/index.d.ts +123 -42
  10. package/package.json +1 -1
package/dist/constructs/v1beta1/feature/FeatureSchema.mjs CHANGED
@@ -1,2 +1,2 @@
1
- var e={openapi:"3.0.0",info:{title:"Feature",description:"OpenAPI schema for the Features construct with entitlement-related properties.",version:"v1beta1",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]}],tags:[{name:"Features",description:"Operations related to features and entitlements"}],paths:{"/api/entitlement/features":{get:{"x-internal":["cloud"],operationId:"getFeatures",tags:["Features"],summary:"Get all features associated with plans",responses:{200:{description:"Features response",content:{"application/json":{schema:{type:"array",items:{"x-go-type":"Feature",type:"object",required:["id","plan_id","quantity","name"],properties:{id:{"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan_id:{"x-oapi-codegen-extra-tags":{db:"plan_id"},type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan:{"x-go-type":"planv1beta1.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/plan",name:"planv1beta1"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",json:"plan,omitempty"},type:"object",properties:{id:{"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"},type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},description:"Name of the plan",enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{"x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["monthly","yearly"]},unit:{"x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimum_units:{type:"integer",description:"Minimum number of units required for the plan","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimum_units",csv:"minimum_units"}},price_per_unit:{type:"number",description:"Price per unit of the plan","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"price_per_unit",csv:"price_per_unit"}},currency:{"x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}},required:["id","name","cadence","unit","price_per_unit","minimum_units","currency"]},name:{"x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name"},type:"string","x-enum-casing-exempt":true,enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign"],description:"Enumeration of possible feature types"},quantity:{type:"number",description:"Quantity of the feature allowed, use 9999999999 for unlimited","x-oapi-codegen-extra-tags":{db:"quantity"},minimum:0},created_at:{"x-oapi-codegen-extra-tags":{db:"created_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}},additionalProperties:false}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/entitlement/subscriptions/organizations/{organizationId}/features":{get:{"x-internal":["cloud"],operationId:"getFeaturesByOrganization",tags:["Features"],summary:"Get all features associated with plans",parameters:[{name:"organizationId",in:"path",description:"The ID of the organization",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Features response",content:{"application/json":{schema:{type:"array",items:{"x-go-type":"Feature",type:"object",required:["id","plan_id","quantity","name"],properties:{id:{"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan_id:{"x-oapi-codegen-extra-tags":{db:"plan_id"},type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan:{"x-go-type":"planv1beta1.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/plan",name:"planv1beta1"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",json:"plan,omitempty"},type:"object",properties:{id:{"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"},type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},description:"Name of the plan",enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{"x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["monthly","yearly"]},unit:{"x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimum_units:{type:"integer",description:"Minimum number of units required for the plan","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimum_units",csv:"minimum_units"}},price_per_unit:{type:"number",description:"Price per unit of the plan","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"price_per_unit",csv:"price_per_unit"}},currency:{"x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}},required:["id","name","cadence","unit","price_per_unit","minimum_units","currency"]},name:{"x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name"},type:"string","x-enum-casing-exempt":true,enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign"],description:"Enumeration of possible feature types"},quantity:{type:"number",description:"Quantity of the feature allowed, use 9999999999 for unlimited","x-oapi-codegen-extra-tags":{db:"quantity"},minimum:0},created_at:{"x-oapi-codegen-extra-tags":{db:"created_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}},additionalProperties:false}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},parameters:{organization_id:{name:"organizationId",in:"path",description:"The ID of the organization",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}},schemas:{FeaturesPage:{type:"array",items:{"x-go-type":"Feature",type:"object",required:["id","plan_id","quantity","name"],properties:{id:{"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan_id:{"x-oapi-codegen-extra-tags":{db:"plan_id"},type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan:{"x-go-type":"planv1beta1.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/plan",name:"planv1beta1"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",json:"plan,omitempty"},type:"object",properties:{id:{"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"},type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},description:"Name of the plan",enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{"x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["monthly","yearly"]},unit:{"x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimum_units:{type:"integer",description:"Minimum number of units required for the plan","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimum_units",csv:"minimum_units"}},price_per_unit:{type:"number",description:"Price per unit of the plan","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"price_per_unit",csv:"price_per_unit"}},currency:{"x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}},required:["id","name","cadence","unit","price_per_unit","minimum_units","currency"]},name:{"x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name"},type:"string","x-enum-casing-exempt":true,enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign"],description:"Enumeration of possible feature types"},quantity:{type:"number",description:"Quantity of the feature allowed, use 9999999999 for unlimited","x-oapi-codegen-extra-tags":{db:"quantity"},minimum:0},created_at:{"x-oapi-codegen-extra-tags":{db:"created_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}},additionalProperties:false}},FeatureName:{type:"string","x-enum-casing-exempt":true,enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign"],description:"Enumeration of possible feature types"},Feature:{type:"object",required:["id","plan_id","quantity","name"],properties:{id:{"x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan_id:{"x-oapi-codegen-extra-tags":{db:"plan_id"},type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan:{"x-go-type":"planv1beta1.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/plan",name:"planv1beta1"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",json:"plan,omitempty"},type:"object",properties:{id:{"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"},type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},description:"Name of the plan",enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{"x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["monthly","yearly"]},unit:{"x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimum_units:{type:"integer",description:"Minimum number of units required for the plan","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimum_units",csv:"minimum_units"}},price_per_unit:{type:"number",description:"Price per unit of the plan","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"price_per_unit",csv:"price_per_unit"}},currency:{"x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}},required:["id","name","cadence","unit","price_per_unit","minimum_units","currency"]},name:{"x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name"},type:"string","x-enum-casing-exempt":true,enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign"],description:"Enumeration of possible feature types"},quantity:{type:"number",description:"Quantity of the feature allowed, use 9999999999 for unlimited","x-oapi-codegen-extra-tags":{db:"quantity"},minimum:0},created_at:{"x-oapi-codegen-extra-tags":{db:"created_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}},additionalProperties:false}}}},t=e;
1
+ var e={openapi:"3.0.0",info:{title:"Feature",description:"OpenAPI schema for the Features construct - the quantified entitlements granted by Meshery Cloud subscription plans.",version:"v1beta1",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]}],tags:[{name:"Features",description:"Operations related to features and entitlements"}],paths:{"/api/entitlement/features":{get:{"x-internal":["cloud"],tags:["Features"],summary:"Get all features defined across plans",operationId:"getFeatures",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}}],responses:{200:{description:"Features response",content:{"application/json":{schema:{type:"array",description:"List of features.",items:{"x-go-type":"Feature",type:"object",additionalProperties:false,description:"A feature is a quantified entitlement granted to an organization through its subscription plan, such as the number of components allowed in a design.",required:["id","plan_id","name","quantity","created_at","updated_at"],properties:{id:{description:"Unique identifier for the feature.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",csv:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan_id:{description:"Identifier of the plan granting this feature.","x-go-name":"PlanId","x-oapi-codegen-extra-tags":{db:"plan_id",csv:"plan_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan:{description:"The plan granting this feature. Populated only when the association is explicitly loaded.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",json:"plan,omitempty"},"x-order":3,type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{description:"Unique identifier for the plan.","x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},name:{description:"Name of the entitled feature.","x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name",csv:"name"},"x-order":4,type:"string","x-enum-casing-exempt":true,enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign"]},quantity:{type:"number",format:"double",description:"Quantity of the feature granted by the plan. The sentinel value 999999999999 denotes unlimited.",minimum:0,"x-oapi-codegen-extra-tags":{db:"quantity",csv:"quantity"},"x-order":5},created_at:{"x-order":6,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":7,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/entitlement/subscriptions/organizations/{orgId}/features":{get:{"x-internal":["cloud"],tags:["Features"],summary:"Get the active features entitled to an organization through its subscriptions",operationId:"getFeaturesByOrganization",parameters:[{name:"orgId",in:"path",description:"The ID of the organization",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Features response",content:{"application/json":{schema:{type:"array",description:"List of features.",items:{"x-go-type":"Feature",type:"object",additionalProperties:false,description:"A feature is a quantified entitlement granted to an organization through its subscription plan, such as the number of components allowed in a design.",required:["id","plan_id","name","quantity","created_at","updated_at"],properties:{id:{description:"Unique identifier for the feature.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",csv:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan_id:{description:"Identifier of the plan granting this feature.","x-go-name":"PlanId","x-oapi-codegen-extra-tags":{db:"plan_id",csv:"plan_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan:{description:"The plan granting this feature. Populated only when the association is explicitly loaded.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",json:"plan,omitempty"},"x-order":3,type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{description:"Unique identifier for the plan.","x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},name:{description:"Name of the entitled feature.","x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name",csv:"name"},"x-order":4,type:"string","x-enum-casing-exempt":true,enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign"]},quantity:{type:"number",format:"double",description:"Quantity of the feature granted by the plan. The sentinel value 999999999999 denotes unlimited.",minimum:0,"x-oapi-codegen-extra-tags":{db:"quantity",csv:"quantity"},"x-order":5},created_at:{"x-order":6,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":7,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{responses:{400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},parameters:{orgId:{name:"orgId",in:"path",description:"The ID of the organization",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},pagesize:{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}}},securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{Feature:{type:"object",additionalProperties:false,description:"A feature is a quantified entitlement granted to an organization through its subscription plan, such as the number of components allowed in a design.",required:["id","plan_id","name","quantity","created_at","updated_at"],properties:{id:{description:"Unique identifier for the feature.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",csv:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan_id:{description:"Identifier of the plan granting this feature.","x-go-name":"PlanId","x-oapi-codegen-extra-tags":{db:"plan_id",csv:"plan_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan:{description:"The plan granting this feature. Populated only when the association is explicitly loaded.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",json:"plan,omitempty"},"x-order":3,type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{description:"Unique identifier for the plan.","x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},name:{description:"Name of the entitled feature.","x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name",csv:"name"},"x-order":4,type:"string","x-enum-casing-exempt":true,enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign"]},quantity:{type:"number",format:"double",description:"Quantity of the feature granted by the plan. The sentinel value 999999999999 denotes unlimited.",minimum:0,"x-oapi-codegen-extra-tags":{db:"quantity",csv:"quantity"},"x-order":5},created_at:{"x-order":6,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":7,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},FeatureName:{type:"string","x-enum-casing-exempt":true,enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign"],description:"Enumeration of feature names that can be granted by a plan."},FeaturesPage:{type:"array",description:"List of features.",items:{"x-go-type":"Feature",type:"object",additionalProperties:false,description:"A feature is a quantified entitlement granted to an organization through its subscription plan, such as the number of components allowed in a design.",required:["id","plan_id","name","quantity","created_at","updated_at"],properties:{id:{description:"Unique identifier for the feature.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",csv:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan_id:{description:"Identifier of the plan granting this feature.","x-go-name":"PlanId","x-oapi-codegen-extra-tags":{db:"plan_id",csv:"plan_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan:{description:"The plan granting this feature. Populated only when the association is explicitly loaded.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",json:"plan,omitempty"},"x-order":3,type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{description:"Unique identifier for the plan.","x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},name:{description:"Name of the entitled feature.","x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name",csv:"name"},"x-order":4,type:"string","x-enum-casing-exempt":true,enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign"]},quantity:{type:"number",format:"double",description:"Quantity of the feature granted by the plan. The sentinel value 999999999999 denotes unlimited.",minimum:0,"x-oapi-codegen-extra-tags":{db:"quantity",csv:"quantity"},"x-order":5},created_at:{"x-order":6,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":7,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}}}}},t=e;
2
2
  export{t as default};
package/dist/index.d.mts CHANGED
@@ -13314,106 +13314,187 @@ interface components$n {
13314
13314
 
13315
13315
  interface components$m {
13316
13316
  schemas: {
13317
- FeaturesPage: {
13317
+ /** @description A feature is a quantified entitlement granted to an organization through its subscription plan, such as the number of components allowed in a design. */
13318
+ Feature: {
13318
13319
  /**
13319
13320
  * Format: uuid
13320
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
13321
+ * @description Unique identifier for the feature.
13321
13322
  */
13322
13323
  id: string;
13323
13324
  /**
13324
13325
  * Format: uuid
13325
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
13326
+ * @description Identifier of the plan granting this feature.
13326
13327
  */
13327
13328
  plan_id: string;
13329
+ /** @description The plan granting this feature. Populated only when the association is explicitly loaded. */
13328
13330
  plan?: {
13329
13331
  /**
13330
13332
  * Format: uuid
13331
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
13333
+ * @description Unique identifier for the plan.
13332
13334
  */
13333
13335
  id: string;
13334
13336
  /**
13335
- * @description Name of the plan
13337
+ * @description Display name of the plan.
13336
13338
  * @enum {string}
13337
13339
  */
13338
13340
  name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
13339
- /** @enum {string} */
13340
- cadence: "monthly" | "yearly";
13341
- /** @enum {string} */
13341
+ /**
13342
+ * @description Billing cadence for the plan (monthly, annually, or none).
13343
+ * @enum {string}
13344
+ */
13345
+ cadence: "none" | "monthly" | "annually";
13346
+ /**
13347
+ * @description Unit of consumption this plan charges against (e.g. user).
13348
+ * @enum {string}
13349
+ */
13342
13350
  unit: "user" | "free";
13343
- /** @description Minimum number of units required for the plan */
13344
- minimum_units: number;
13345
- /** @description Price per unit of the plan */
13346
- price_per_unit: number;
13347
- /** @enum {string} */
13351
+ /** @description Minimum number of units required for the plan. */
13352
+ minimumUnits: number;
13353
+ /** @description Price per unit of the plan. */
13354
+ pricePerUnit: number;
13355
+ /**
13356
+ * @description Currency in which the plan is priced.
13357
+ * @enum {string}
13358
+ */
13348
13359
  currency: "usd";
13349
13360
  };
13350
13361
  /**
13351
- * @description Enumeration of possible feature types
13362
+ * @description Name of the entitled feature.
13352
13363
  * @enum {string}
13353
13364
  */
13354
13365
  name: "ComponentsInDesign" | "RelationshipsInDesign" | "DesignsInWorkspace" | "WorkspacesInOrganization" | "ImageSizeInDesign" | "SizePerDesign";
13355
- /** @description Quantity of the feature allowed, use 9999999999 for unlimited */
13366
+ /**
13367
+ * Format: double
13368
+ * @description Quantity of the feature granted by the plan. The sentinel value 999999999999 denotes unlimited.
13369
+ */
13356
13370
  quantity: number;
13357
- /** Format: date-time */
13358
- created_at?: string;
13359
- /** Format: date-time */
13360
- updated_at?: string;
13361
- }[];
13371
+ /**
13372
+ * Format: date-time
13373
+ * @description Timestamp when the resource was created.
13374
+ */
13375
+ created_at: string;
13376
+ /**
13377
+ * Format: date-time
13378
+ * @description Timestamp when the resource was updated.
13379
+ */
13380
+ updated_at: string;
13381
+ };
13362
13382
  /**
13363
- * @description Enumeration of possible feature types
13383
+ * @description Enumeration of feature names that can be granted by a plan.
13364
13384
  * @enum {string}
13365
13385
  */
13366
13386
  FeatureName: "ComponentsInDesign" | "RelationshipsInDesign" | "DesignsInWorkspace" | "WorkspacesInOrganization" | "ImageSizeInDesign" | "SizePerDesign";
13367
- Feature: {
13387
+ /** @description List of features. */
13388
+ FeaturesPage: {
13368
13389
  /**
13369
13390
  * Format: uuid
13370
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
13391
+ * @description Unique identifier for the feature.
13371
13392
  */
13372
13393
  id: string;
13373
13394
  /**
13374
13395
  * Format: uuid
13375
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
13396
+ * @description Identifier of the plan granting this feature.
13376
13397
  */
13377
13398
  plan_id: string;
13399
+ /** @description The plan granting this feature. Populated only when the association is explicitly loaded. */
13378
13400
  plan?: {
13379
13401
  /**
13380
13402
  * Format: uuid
13381
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
13403
+ * @description Unique identifier for the plan.
13382
13404
  */
13383
13405
  id: string;
13384
13406
  /**
13385
- * @description Name of the plan
13407
+ * @description Display name of the plan.
13386
13408
  * @enum {string}
13387
13409
  */
13388
13410
  name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
13389
- /** @enum {string} */
13390
- cadence: "monthly" | "yearly";
13391
- /** @enum {string} */
13411
+ /**
13412
+ * @description Billing cadence for the plan (monthly, annually, or none).
13413
+ * @enum {string}
13414
+ */
13415
+ cadence: "none" | "monthly" | "annually";
13416
+ /**
13417
+ * @description Unit of consumption this plan charges against (e.g. user).
13418
+ * @enum {string}
13419
+ */
13392
13420
  unit: "user" | "free";
13393
- /** @description Minimum number of units required for the plan */
13394
- minimum_units: number;
13395
- /** @description Price per unit of the plan */
13396
- price_per_unit: number;
13397
- /** @enum {string} */
13421
+ /** @description Minimum number of units required for the plan. */
13422
+ minimumUnits: number;
13423
+ /** @description Price per unit of the plan. */
13424
+ pricePerUnit: number;
13425
+ /**
13426
+ * @description Currency in which the plan is priced.
13427
+ * @enum {string}
13428
+ */
13398
13429
  currency: "usd";
13399
13430
  };
13400
13431
  /**
13401
- * @description Enumeration of possible feature types
13432
+ * @description Name of the entitled feature.
13402
13433
  * @enum {string}
13403
13434
  */
13404
13435
  name: "ComponentsInDesign" | "RelationshipsInDesign" | "DesignsInWorkspace" | "WorkspacesInOrganization" | "ImageSizeInDesign" | "SizePerDesign";
13405
- /** @description Quantity of the feature allowed, use 9999999999 for unlimited */
13436
+ /**
13437
+ * Format: double
13438
+ * @description Quantity of the feature granted by the plan. The sentinel value 999999999999 denotes unlimited.
13439
+ */
13406
13440
  quantity: number;
13407
- /** Format: date-time */
13408
- created_at?: string;
13409
- /** Format: date-time */
13410
- updated_at?: string;
13441
+ /**
13442
+ * Format: date-time
13443
+ * @description Timestamp when the resource was created.
13444
+ */
13445
+ created_at: string;
13446
+ /**
13447
+ * Format: date-time
13448
+ * @description Timestamp when the resource was updated.
13449
+ */
13450
+ updated_at: string;
13451
+ }[];
13452
+ };
13453
+ responses: {
13454
+ /** @description Invalid request body or request param */
13455
+ 400: {
13456
+ headers: {
13457
+ [name: string]: unknown;
13458
+ };
13459
+ content: {
13460
+ "text/plain": string;
13461
+ };
13462
+ };
13463
+ /** @description Expired JWT token used or insufficient privilege */
13464
+ 401: {
13465
+ headers: {
13466
+ [name: string]: unknown;
13467
+ };
13468
+ content: {
13469
+ "text/plain": string;
13470
+ };
13471
+ };
13472
+ /** @description Result not found */
13473
+ 404: {
13474
+ headers: {
13475
+ [name: string]: unknown;
13476
+ };
13477
+ content: {
13478
+ "text/plain": string;
13479
+ };
13480
+ };
13481
+ /** @description Internal server error */
13482
+ 500: {
13483
+ headers: {
13484
+ [name: string]: unknown;
13485
+ };
13486
+ content: {
13487
+ "text/plain": string;
13488
+ };
13411
13489
  };
13412
13490
  };
13413
- responses: never;
13414
13491
  parameters: {
13415
13492
  /** @description The ID of the organization */
13416
- organization_id: string;
13493
+ orgId: string;
13494
+ /** @description Get responses by page */
13495
+ page: string;
13496
+ /** @description Get responses by pagesize */
13497
+ pagesize: string;
13417
13498
  };
13418
13499
  requestBodies: never;
13419
13500
  headers: never;
package/dist/index.d.ts CHANGED
@@ -13314,106 +13314,187 @@ interface components$n {
13314
13314
 
13315
13315
  interface components$m {
13316
13316
  schemas: {
13317
- FeaturesPage: {
13317
+ /** @description A feature is a quantified entitlement granted to an organization through its subscription plan, such as the number of components allowed in a design. */
13318
+ Feature: {
13318
13319
  /**
13319
13320
  * Format: uuid
13320
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
13321
+ * @description Unique identifier for the feature.
13321
13322
  */
13322
13323
  id: string;
13323
13324
  /**
13324
13325
  * Format: uuid
13325
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
13326
+ * @description Identifier of the plan granting this feature.
13326
13327
  */
13327
13328
  plan_id: string;
13329
+ /** @description The plan granting this feature. Populated only when the association is explicitly loaded. */
13328
13330
  plan?: {
13329
13331
  /**
13330
13332
  * Format: uuid
13331
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
13333
+ * @description Unique identifier for the plan.
13332
13334
  */
13333
13335
  id: string;
13334
13336
  /**
13335
- * @description Name of the plan
13337
+ * @description Display name of the plan.
13336
13338
  * @enum {string}
13337
13339
  */
13338
13340
  name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
13339
- /** @enum {string} */
13340
- cadence: "monthly" | "yearly";
13341
- /** @enum {string} */
13341
+ /**
13342
+ * @description Billing cadence for the plan (monthly, annually, or none).
13343
+ * @enum {string}
13344
+ */
13345
+ cadence: "none" | "monthly" | "annually";
13346
+ /**
13347
+ * @description Unit of consumption this plan charges against (e.g. user).
13348
+ * @enum {string}
13349
+ */
13342
13350
  unit: "user" | "free";
13343
- /** @description Minimum number of units required for the plan */
13344
- minimum_units: number;
13345
- /** @description Price per unit of the plan */
13346
- price_per_unit: number;
13347
- /** @enum {string} */
13351
+ /** @description Minimum number of units required for the plan. */
13352
+ minimumUnits: number;
13353
+ /** @description Price per unit of the plan. */
13354
+ pricePerUnit: number;
13355
+ /**
13356
+ * @description Currency in which the plan is priced.
13357
+ * @enum {string}
13358
+ */
13348
13359
  currency: "usd";
13349
13360
  };
13350
13361
  /**
13351
- * @description Enumeration of possible feature types
13362
+ * @description Name of the entitled feature.
13352
13363
  * @enum {string}
13353
13364
  */
13354
13365
  name: "ComponentsInDesign" | "RelationshipsInDesign" | "DesignsInWorkspace" | "WorkspacesInOrganization" | "ImageSizeInDesign" | "SizePerDesign";
13355
- /** @description Quantity of the feature allowed, use 9999999999 for unlimited */
13366
+ /**
13367
+ * Format: double
13368
+ * @description Quantity of the feature granted by the plan. The sentinel value 999999999999 denotes unlimited.
13369
+ */
13356
13370
  quantity: number;
13357
- /** Format: date-time */
13358
- created_at?: string;
13359
- /** Format: date-time */
13360
- updated_at?: string;
13361
- }[];
13371
+ /**
13372
+ * Format: date-time
13373
+ * @description Timestamp when the resource was created.
13374
+ */
13375
+ created_at: string;
13376
+ /**
13377
+ * Format: date-time
13378
+ * @description Timestamp when the resource was updated.
13379
+ */
13380
+ updated_at: string;
13381
+ };
13362
13382
  /**
13363
- * @description Enumeration of possible feature types
13383
+ * @description Enumeration of feature names that can be granted by a plan.
13364
13384
  * @enum {string}
13365
13385
  */
13366
13386
  FeatureName: "ComponentsInDesign" | "RelationshipsInDesign" | "DesignsInWorkspace" | "WorkspacesInOrganization" | "ImageSizeInDesign" | "SizePerDesign";
13367
- Feature: {
13387
+ /** @description List of features. */
13388
+ FeaturesPage: {
13368
13389
  /**
13369
13390
  * Format: uuid
13370
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
13391
+ * @description Unique identifier for the feature.
13371
13392
  */
13372
13393
  id: string;
13373
13394
  /**
13374
13395
  * Format: uuid
13375
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
13396
+ * @description Identifier of the plan granting this feature.
13376
13397
  */
13377
13398
  plan_id: string;
13399
+ /** @description The plan granting this feature. Populated only when the association is explicitly loaded. */
13378
13400
  plan?: {
13379
13401
  /**
13380
13402
  * Format: uuid
13381
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
13403
+ * @description Unique identifier for the plan.
13382
13404
  */
13383
13405
  id: string;
13384
13406
  /**
13385
- * @description Name of the plan
13407
+ * @description Display name of the plan.
13386
13408
  * @enum {string}
13387
13409
  */
13388
13410
  name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
13389
- /** @enum {string} */
13390
- cadence: "monthly" | "yearly";
13391
- /** @enum {string} */
13411
+ /**
13412
+ * @description Billing cadence for the plan (monthly, annually, or none).
13413
+ * @enum {string}
13414
+ */
13415
+ cadence: "none" | "monthly" | "annually";
13416
+ /**
13417
+ * @description Unit of consumption this plan charges against (e.g. user).
13418
+ * @enum {string}
13419
+ */
13392
13420
  unit: "user" | "free";
13393
- /** @description Minimum number of units required for the plan */
13394
- minimum_units: number;
13395
- /** @description Price per unit of the plan */
13396
- price_per_unit: number;
13397
- /** @enum {string} */
13421
+ /** @description Minimum number of units required for the plan. */
13422
+ minimumUnits: number;
13423
+ /** @description Price per unit of the plan. */
13424
+ pricePerUnit: number;
13425
+ /**
13426
+ * @description Currency in which the plan is priced.
13427
+ * @enum {string}
13428
+ */
13398
13429
  currency: "usd";
13399
13430
  };
13400
13431
  /**
13401
- * @description Enumeration of possible feature types
13432
+ * @description Name of the entitled feature.
13402
13433
  * @enum {string}
13403
13434
  */
13404
13435
  name: "ComponentsInDesign" | "RelationshipsInDesign" | "DesignsInWorkspace" | "WorkspacesInOrganization" | "ImageSizeInDesign" | "SizePerDesign";
13405
- /** @description Quantity of the feature allowed, use 9999999999 for unlimited */
13436
+ /**
13437
+ * Format: double
13438
+ * @description Quantity of the feature granted by the plan. The sentinel value 999999999999 denotes unlimited.
13439
+ */
13406
13440
  quantity: number;
13407
- /** Format: date-time */
13408
- created_at?: string;
13409
- /** Format: date-time */
13410
- updated_at?: string;
13441
+ /**
13442
+ * Format: date-time
13443
+ * @description Timestamp when the resource was created.
13444
+ */
13445
+ created_at: string;
13446
+ /**
13447
+ * Format: date-time
13448
+ * @description Timestamp when the resource was updated.
13449
+ */
13450
+ updated_at: string;
13451
+ }[];
13452
+ };
13453
+ responses: {
13454
+ /** @description Invalid request body or request param */
13455
+ 400: {
13456
+ headers: {
13457
+ [name: string]: unknown;
13458
+ };
13459
+ content: {
13460
+ "text/plain": string;
13461
+ };
13462
+ };
13463
+ /** @description Expired JWT token used or insufficient privilege */
13464
+ 401: {
13465
+ headers: {
13466
+ [name: string]: unknown;
13467
+ };
13468
+ content: {
13469
+ "text/plain": string;
13470
+ };
13471
+ };
13472
+ /** @description Result not found */
13473
+ 404: {
13474
+ headers: {
13475
+ [name: string]: unknown;
13476
+ };
13477
+ content: {
13478
+ "text/plain": string;
13479
+ };
13480
+ };
13481
+ /** @description Internal server error */
13482
+ 500: {
13483
+ headers: {
13484
+ [name: string]: unknown;
13485
+ };
13486
+ content: {
13487
+ "text/plain": string;
13488
+ };
13411
13489
  };
13412
13490
  };
13413
- responses: never;
13414
13491
  parameters: {
13415
13492
  /** @description The ID of the organization */
13416
- organization_id: string;
13493
+ orgId: string;
13494
+ /** @description Get responses by page */
13495
+ page: string;
13496
+ /** @description Get responses by pagesize */
13497
+ pagesize: string;
13417
13498
  };
13418
13499
  requestBodies: never;
13419
13500
  headers: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@meshery/schemas",
3
- "version": "1.3.7",
3
+ "version": "1.3.8",
4
4
  "description": "<p style=\"text-align:center;\" align=\"center\"><a href=\"https://meshery.io\"><picture> <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/meshery/meshery/master/.github/assets/images/readme/meshery-logo-light-text-side.svg\"> <source media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/meshery/meshery/master/.github/assets/images/readme/meshery-logo-dark-text-side.svg\"> <img src=\"https://raw.githubusercontent.com/meshery/meshery/master/.github/assets/images/readme/meshery-logo-dark-text-side.svg\" alt=\"Meshery Logo\" width=\"70%\" /></picture></a><br /><br /></p> <p align=\"center\"> <a href=\"https://hub.docker.com/r/meshery/meshery\" alt=\"Docker pulls\"> <img src=\"https://img.shields.io/docker/pulls/meshery/meshery.svg\" /></a> <a href=\"https://github.com/issues?q=is%3Aopen+is%3Aissue+archived%3Afalse+org%meshery+org%3Ameshery+org%3Aservice-mesh-performance+org%3Aservice-mesh-patterns+org%3A+label%3A%22help+wanted%22+\" alt=\"GitHub issues by-label\"> <img src=\"https://img.shields.io/github/issues/meshery/meshery/help%20wanted.svg?color=informational\" /></a> <a href=\"https://github.com/meshery/meshery/blob/master/LICENSE\" alt=\"LICENSE\"> <img src=\"https://img.shields.io/github/license/meshery/meshery?color=brightgreen\" /></a> <a href=\"https://artifacthub.io/packages/helm/meshery/meshery\" alt=\"Artifact Hub Meshery\"> <img src=\"https://img.shields.io/endpoint?color=brightgreen&label=Helm%20Chart&style=plastic&url=https%3A%2F%2Fartifacthub.io%2Fbadge%2Frepository%2Fartifact-hub\" /></a> <a href=\"https://goreportcard.com/report/github.com/meshery/meshery\" alt=\"Go Report Card\"> <img src=\"https://goreportcard.com/badge/github.com/meshery/meshery\" /></a> <a href=\"https://github.com/meshery/meshery/actions\" alt=\"Build Status\"> <img src=\"https://img.shields.io/github/actions/workflow/status/meshery/meshery/release-drafter.yml\" /></a> <a href=\"https://bestpractices.coreinfrastructure.org/projects/3564\" alt=\"CLI Best Practices\"> <img src=\"https://bestpractices.coreinfrastructure.org/projects/3564/badge\" /></a> <a href=\"http://discuss.meshery.io\" alt=\"Discuss Users\"> <img src=\"https://img.shields.io/discourse/users?label=discuss&logo=discourse&server=https%3A%2F%2Fdiscuss.meshery.io\" /></a> <a href=\"https://slack.meshery.io\" alt=\"Join Slack\"> <img src=\"https://img.shields.io/badge/Slack-@meshery.svg?logo=slack\" /></a> <a href=\"https://twitter.com/intent/follow?screen_name=mesheryio\" alt=\"Twitter Follow\"> <img src=\"https://img.shields.io/twitter/follow/mesheryio.svg?label=Follow+Meshery&style=social\" /></a> <a href=\"https://github.com/meshery/meshery/releases\" alt=\"Meshery Downloads\"> <img src=\"https://img.shields.io/github/downloads/meshery/meshery/total\" /></a> <!-- <a href=\"https://app.fossa.com/projects/git%2Bgithub.com%2Fmeshery%2Fmeshery?ref=badge_shield\" alt=\"License Scan Report\"> <img src=\"https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmeshery%2Fmeshery.svg?type=shield\"/></a> --> </p>",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",