@meshery/schemas 1.3.86 → 1.3.88

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.
@@ -14992,11 +14992,96 @@ type GetProviderCapabilitiesApiResponse = {
14992
14992
  /** True when the caller is a live member of the organization. */
14993
14993
  bound: boolean;
14994
14994
  };
14995
+ /** Whether a client application's version meets the provider's minimum for that client. A client whose `compatible` is false must update before it registers or keeps a connection alive; the provider answers those calls with 426. A client the provider has no minimum for is compatible and has no `minimumVersion`.
14996
+ */
14997
+ compatibility?: {
14998
+ /** Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it.
14999
+ */
15000
+ clientName: string;
15001
+ /** The client's version as it reported it, as `MAJOR.MINOR.PATCH` with an optional leading `v`, for example `v1.25.0`. Versions are ordered by their numeric parts, so `v1.9.0` is older than `v1.25.0`. */
15002
+ clientVersion: string;
15003
+ /** Oldest client version the provider accepts for this client. Absent when the provider sets no minimum. */
15004
+ minimumVersion?: string;
15005
+ /** True when `clientVersion` is at or above `minimumVersion`, or when there is no minimum. */
15006
+ compatible: boolean;
15007
+ /** Where the client can get an update, when the provider knows one. */
15008
+ upgradeUrl?: string;
15009
+ };
15010
+ /** The authenticated caller's session as the provider sees it: who the caller is, the caller's roles, and, for the organization named by `X-Current-Orgid` when the caller is a live member of it, that organization's roles, plan, entitlements and device usage. Present only on an authenticated request.
15011
+ */
15012
+ session?: {
15013
+ /** A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. */
15014
+ userId: string;
15015
+ /** The caller's provider-wide role names. */
15016
+ providerRoles: string[];
15017
+ /** The caller's role names in the organization. */
15018
+ organizationRoles?: string[];
15019
+ /** The plan of the organization's active subscription, when it has one. */
15020
+ plan?: {
15021
+ /** A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. */
15022
+ id: string;
15023
+ /** Display name of the plan. */
15024
+ name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
15025
+ /** Billing cadence for the plan (monthly, annually, or none). */
15026
+ cadence: "none" | "monthly" | "annually";
15027
+ /** Unit of consumption this plan charges against (e.g. user). */
15028
+ unit: "user" | "free";
15029
+ /** Minimum number of units required for the plan. */
15030
+ minimumUnits: number;
15031
+ /** Price per unit of the plan. */
15032
+ pricePerUnit: number;
15033
+ /** Currency in which the plan is priced. */
15034
+ currency: "usd";
15035
+ };
15036
+ /** The features the organization's active subscriptions entitle it to. */
15037
+ entitlements?: {
15038
+ /** Unique identifier for the feature. */
15039
+ id: string;
15040
+ /** Identifier of the plan granting this feature. */
15041
+ plan_id: string;
15042
+ /** The plan granting this feature. Populated only when the association is explicitly loaded. */
15043
+ plan?: {
15044
+ /** A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. */
15045
+ id: string;
15046
+ /** Display name of the plan. */
15047
+ name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
15048
+ /** Billing cadence for the plan (monthly, annually, or none). */
15049
+ cadence: "none" | "monthly" | "annually";
15050
+ /** Unit of consumption this plan charges against (e.g. user). */
15051
+ unit: "user" | "free";
15052
+ /** Minimum number of units required for the plan. */
15053
+ minimumUnits: number;
15054
+ /** Price per unit of the plan. */
15055
+ pricePerUnit: number;
15056
+ /** Currency in which the plan is priced. */
15057
+ currency: "usd";
15058
+ };
15059
+ /** Name of the entitled feature. */
15060
+ name: "ComponentsInDesign" | "RelationshipsInDesign" | "DesignsInWorkspace" | "WorkspacesInOrganization" | "ImageSizeInDesign" | "SizePerDesign" | "BlowhornProfiles" | "BlowhornBrowserAutomation" | "BlowhornScheduler" | "BlowhornDevicesPerSeat" | "BlowhornPlatformLinkedIn" | "BlowhornPlatformX" | "BlowhornPlatformReddit" | "BlowhornPlatformHackerNews" | "BlowhornPlatformSlack" | "BlowhornPlatformBluesky" | "BlowhornPlatformGitHub" | "BlowhornPlatformBlog";
15061
+ /** Quantity of the feature granted by the plan. For a cap-style feature this is the maximum, and the sentinel value 999999999999 denotes unlimited. For a capability-style feature any value greater than 0 grants the capability. */
15062
+ quantity: number;
15063
+ /** Timestamp when the resource was created. */
15064
+ created_at: string;
15065
+ /** Timestamp when the resource was updated. */
15066
+ updated_at: string;
15067
+ }[];
15068
+ /** Registered devices (live `desktop` connections) in the organization against the organization's device limit. Registrations over the limit are accepted; `overLimit` flags the organization instead.
15069
+ */
15070
+ deviceUsage?: {
15071
+ /** Live `desktop` connections registered in the organization. */
15072
+ registered: number;
15073
+ /** Devices the organization's subscriptions allow. Absent when unlimited or when no subscription sets a device limit. */
15074
+ limit?: number;
15075
+ /** True when `limit` is present and `registered` exceeds it. */
15076
+ overLimit: boolean;
15077
+ };
15078
+ };
14995
15079
  /** Extension points; shape owned by the provider. */
14996
15080
  extensions?: {
14997
15081
  [key: string]: any;
14998
15082
  };
14999
- /** Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. */
15083
+ /** Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. A provider serving desktop connections lists `register-connection`, `connection-heartbeat` and `deregister-desktop-connection`; an endpoint may hold `{connectionId}` or `{machineId}` placeholders.
15084
+ */
15000
15085
  capabilities?: {
15001
15086
  /** Feature name, for example `persist-connection`. */
15002
15087
  feature: string;
@@ -15013,6 +15098,9 @@ type GetProviderCapabilitiesApiArg = {
15013
15098
  version: string;
15014
15099
  /** Organization whose membership the caller wants reported. */
15015
15100
  "X-Current-Orgid"?: string;
15101
+ /** Identifier of the requesting client application, for example the product name of a desktop app. When present, the document carries `compatibility` for this client at the `{version}` path parameter.
15102
+ */
15103
+ client?: string;
15016
15104
  /** Operating system of the client, used to select packages. */
15017
15105
  os?: string;
15018
15106
  };
@@ -16568,6 +16656,10 @@ type GetNativeClientAuthorizationApiResponse = unknown;
16568
16656
  type GetNativeClientAuthorizationApiArg = {
16569
16657
  /** Display name of the native client asking to sign in. Shown on the consent page and used as the name and purpose of the minted token. */
16570
16658
  clientName: string;
16659
+ /** Identifier of the client application, as in the capabilities `client` parameter. Selects the minimum version checked against `clientVersion`. */
16660
+ client?: string;
16661
+ /** Version of the client application, for example `v1.25.0`. */
16662
+ clientVersion?: string;
16571
16663
  /** Port on 127.0.0.1 where the native client listens for the callback. */
16572
16664
  port: number;
16573
16665
  /** PKCE code challenge, BASE64URL(SHA256(codeVerifier)) without padding. */
@@ -14992,11 +14992,96 @@ type GetProviderCapabilitiesApiResponse = {
14992
14992
  /** True when the caller is a live member of the organization. */
14993
14993
  bound: boolean;
14994
14994
  };
14995
+ /** Whether a client application's version meets the provider's minimum for that client. A client whose `compatible` is false must update before it registers or keeps a connection alive; the provider answers those calls with 426. A client the provider has no minimum for is compatible and has no `minimumVersion`.
14996
+ */
14997
+ compatibility?: {
14998
+ /** Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it.
14999
+ */
15000
+ clientName: string;
15001
+ /** The client's version as it reported it, as `MAJOR.MINOR.PATCH` with an optional leading `v`, for example `v1.25.0`. Versions are ordered by their numeric parts, so `v1.9.0` is older than `v1.25.0`. */
15002
+ clientVersion: string;
15003
+ /** Oldest client version the provider accepts for this client. Absent when the provider sets no minimum. */
15004
+ minimumVersion?: string;
15005
+ /** True when `clientVersion` is at or above `minimumVersion`, or when there is no minimum. */
15006
+ compatible: boolean;
15007
+ /** Where the client can get an update, when the provider knows one. */
15008
+ upgradeUrl?: string;
15009
+ };
15010
+ /** The authenticated caller's session as the provider sees it: who the caller is, the caller's roles, and, for the organization named by `X-Current-Orgid` when the caller is a live member of it, that organization's roles, plan, entitlements and device usage. Present only on an authenticated request.
15011
+ */
15012
+ session?: {
15013
+ /** A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. */
15014
+ userId: string;
15015
+ /** The caller's provider-wide role names. */
15016
+ providerRoles: string[];
15017
+ /** The caller's role names in the organization. */
15018
+ organizationRoles?: string[];
15019
+ /** The plan of the organization's active subscription, when it has one. */
15020
+ plan?: {
15021
+ /** A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. */
15022
+ id: string;
15023
+ /** Display name of the plan. */
15024
+ name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
15025
+ /** Billing cadence for the plan (monthly, annually, or none). */
15026
+ cadence: "none" | "monthly" | "annually";
15027
+ /** Unit of consumption this plan charges against (e.g. user). */
15028
+ unit: "user" | "free";
15029
+ /** Minimum number of units required for the plan. */
15030
+ minimumUnits: number;
15031
+ /** Price per unit of the plan. */
15032
+ pricePerUnit: number;
15033
+ /** Currency in which the plan is priced. */
15034
+ currency: "usd";
15035
+ };
15036
+ /** The features the organization's active subscriptions entitle it to. */
15037
+ entitlements?: {
15038
+ /** Unique identifier for the feature. */
15039
+ id: string;
15040
+ /** Identifier of the plan granting this feature. */
15041
+ plan_id: string;
15042
+ /** The plan granting this feature. Populated only when the association is explicitly loaded. */
15043
+ plan?: {
15044
+ /** A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. */
15045
+ id: string;
15046
+ /** Display name of the plan. */
15047
+ name: "Free" | "Team Designer" | "Team Operator" | "Enterprise";
15048
+ /** Billing cadence for the plan (monthly, annually, or none). */
15049
+ cadence: "none" | "monthly" | "annually";
15050
+ /** Unit of consumption this plan charges against (e.g. user). */
15051
+ unit: "user" | "free";
15052
+ /** Minimum number of units required for the plan. */
15053
+ minimumUnits: number;
15054
+ /** Price per unit of the plan. */
15055
+ pricePerUnit: number;
15056
+ /** Currency in which the plan is priced. */
15057
+ currency: "usd";
15058
+ };
15059
+ /** Name of the entitled feature. */
15060
+ name: "ComponentsInDesign" | "RelationshipsInDesign" | "DesignsInWorkspace" | "WorkspacesInOrganization" | "ImageSizeInDesign" | "SizePerDesign" | "BlowhornProfiles" | "BlowhornBrowserAutomation" | "BlowhornScheduler" | "BlowhornDevicesPerSeat" | "BlowhornPlatformLinkedIn" | "BlowhornPlatformX" | "BlowhornPlatformReddit" | "BlowhornPlatformHackerNews" | "BlowhornPlatformSlack" | "BlowhornPlatformBluesky" | "BlowhornPlatformGitHub" | "BlowhornPlatformBlog";
15061
+ /** Quantity of the feature granted by the plan. For a cap-style feature this is the maximum, and the sentinel value 999999999999 denotes unlimited. For a capability-style feature any value greater than 0 grants the capability. */
15062
+ quantity: number;
15063
+ /** Timestamp when the resource was created. */
15064
+ created_at: string;
15065
+ /** Timestamp when the resource was updated. */
15066
+ updated_at: string;
15067
+ }[];
15068
+ /** Registered devices (live `desktop` connections) in the organization against the organization's device limit. Registrations over the limit are accepted; `overLimit` flags the organization instead.
15069
+ */
15070
+ deviceUsage?: {
15071
+ /** Live `desktop` connections registered in the organization. */
15072
+ registered: number;
15073
+ /** Devices the organization's subscriptions allow. Absent when unlimited or when no subscription sets a device limit. */
15074
+ limit?: number;
15075
+ /** True when `limit` is present and `registered` exceeds it. */
15076
+ overLimit: boolean;
15077
+ };
15078
+ };
14995
15079
  /** Extension points; shape owned by the provider. */
14996
15080
  extensions?: {
14997
15081
  [key: string]: any;
14998
15082
  };
14999
- /** Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. */
15083
+ /** Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. A provider serving desktop connections lists `register-connection`, `connection-heartbeat` and `deregister-desktop-connection`; an endpoint may hold `{connectionId}` or `{machineId}` placeholders.
15084
+ */
15000
15085
  capabilities?: {
15001
15086
  /** Feature name, for example `persist-connection`. */
15002
15087
  feature: string;
@@ -15013,6 +15098,9 @@ type GetProviderCapabilitiesApiArg = {
15013
15098
  version: string;
15014
15099
  /** Organization whose membership the caller wants reported. */
15015
15100
  "X-Current-Orgid"?: string;
15101
+ /** Identifier of the requesting client application, for example the product name of a desktop app. When present, the document carries `compatibility` for this client at the `{version}` path parameter.
15102
+ */
15103
+ client?: string;
15016
15104
  /** Operating system of the client, used to select packages. */
15017
15105
  os?: string;
15018
15106
  };
@@ -16568,6 +16656,10 @@ type GetNativeClientAuthorizationApiResponse = unknown;
16568
16656
  type GetNativeClientAuthorizationApiArg = {
16569
16657
  /** Display name of the native client asking to sign in. Shown on the consent page and used as the name and purpose of the minted token. */
16570
16658
  clientName: string;
16659
+ /** Identifier of the client application, as in the capabilities `client` parameter. Selects the minimum version checked against `clientVersion`. */
16660
+ client?: string;
16661
+ /** Version of the client application, for example `v1.25.0`. */
16662
+ clientVersion?: string;
16571
16663
  /** Port on 127.0.0.1 where the native client listens for the callback. */
16572
16664
  port: number;
16573
16665
  /** PKCE code challenge, BASE64URL(SHA256(codeVerifier)) without padding. */