@versori/run 0.3.0-beta.7 → 0.3.0-beta.9

package/esm/src/services/platform/generated/types.gen.d.ts

@@ -8,6 +8,7 @@ export type Activation = {
 export type ActivationsList = Array<Activation>;
 /**
  * ActivationCreate is the request payload to activate an environment for End User
+ *
  */
 export type ActivationCreate = {
     /**
@@ -39,6 +40,7 @@ export type ConnectionCreate = {
      * An example is where the system's baseURL is https://shopifyplaceholder.com and you want to connect to your own shopify
      * which is at https://myshopify.com. Everything after the top-level domain will be ignored. If the scheme is missing, then
      * https:// will be used.
+     *
      */
     baseUrl?: string;
 };
@@ -48,6 +50,7 @@ export type EnvSystemConnectionCreate = {
 };
 /**
  * LinkConnectionEnvironment is the request payload to link an existing connection to an environment.
+ *
  */
 export type LinkConnectionEnvironment = {
     connectionTemplateId: TemplateId;
@@ -117,6 +120,7 @@ export type ProjectsList = {
 };
 /**
  * The Project represents a deployable unit within our platform that includes both the functional components (files) and configuration. It serves as the backbone of custom or predefined functionalities, allowing organizations to create, update, and manage APIs and projects.
+ *
  */
 export type ProjectSummary = {
     /**
@@ -127,17 +131,20 @@ export type ProjectSummary = {
     createdAt: string;
     /**
      * List of environments for the project.
+     *
      */
     environments: Array<ProjectEnvironment>;
 };
 /**
  * DynamicVariablesSchema is the JSON schema for the project's dynamic variables.
+ *
  */
 export type DynamicVariablesSchema = {
     [key: string]: unknown;
 };
 /**
  * DynamicVariablesSchemaPatch is the request body for updating the project's dynamic variables.
+ *
  */
 export type DynamicVariablesSchemaPatch = {
     op: 'add' | 'remove' | 'replace';
@@ -157,11 +164,13 @@ export type DynamicVariablesSchemaPatch = {
      * ```
      *
      * The path would be `/properties/newVar`.
+     *
      */
     path: string;
     /**
      * The value to set the field to. This should be valid JSON schema containing the name of the variable, its type
      * and any other properties. An example would be `{"newVar": {"type": "string"}}`.
+     *
      */
     value?: {
         [key: string]: unknown;
@@ -169,6 +178,7 @@ export type DynamicVariablesSchemaPatch = {
 };
 /**
  * The Project represents a deployable unit within our platform that includes both the functional components (files) and configuration. It serves as the backbone of custom or predefined functionalities, allowing organizations to create, update, and manage APIs and projects.
+ *
  */
 export type Project = {
     /**
@@ -177,6 +187,7 @@ export type Project = {
     id: string;
     /**
      * List of environments for the project.
+     *
      */
     environments: Array<ProjectEnvironment>;
     name: string;
@@ -224,6 +235,7 @@ export type Files = {
     /**
      * The labels associated with the project. Labels are stored as key-value pairs.
      * Only string-string values are allowed
+     *
      */
     labels: {
         [key: string]: unknown;
@@ -236,6 +248,7 @@ export type ErrorField = {
     /**
      * Field is the name of the field which has an error, this may be a path to a nested field, including array
      * elements. The format of this field is of the form: "field1.field2[0].field3"
+     *
      */
     field: string;
     /**
@@ -278,10 +291,12 @@ export type PageInfo = {
 };
 /**
  * This is the ID of the template that the connection is created against.
+ *
  */
 export type TemplateId = string;
 /**
  * ConnectionUpdate is the request payload to update an existing connection.
+ *
  */
 export type ConnectionUpdate = {
     /**
@@ -296,17 +311,20 @@ export type ConnectionUpdate = {
      * For example, a user may have their own instance of shopify and their url is `https://myshopify.com`. They can
      * override the base url of the connection to `https://myshopify.com` and all requests will be made to this url.
      * If it is left as an empty string, it will be ignored.
+     *
      */
     baseUrl: string;
 };
 /**
  * Connection defines the credentials for the owning Connector, and additional variables
  * which can be used to customize the Connector in a particular connection.
+ *
  */
 export type Connection = {
     /**
      * ID is the unique identifier of the Connection. Typically this is only used internally and most (if not all)
      * public-facing APIs will use the `name` in combination with the Connector's `id` instead.
+     *
      */
     id: string;
     /**
@@ -321,6 +339,7 @@ export type Connection = {
      * For example, a user may have their own instance of shopify and their url is `https://myshopify.com`. They can
      * override the base url of the connection to `https://myshopify.com` and all requests will be made to this url.
      * If it is left as an empty string, it will be ignored.
+     *
      */
     baseUrl?: string;
     /**
@@ -341,6 +360,7 @@ export type Connection = {
  * ConnectionCredentials defines the credentials for the owning Connector. If multiple
  * credentials are defined for each type, they are applied to the request in the order they are defined. This is to
  * enable Connectors which require both a user session token and an API key to be provided in the request.
+ *
  */
 export type ConnectionCredentials = Array<ConnectionCredential>;
 /**
@@ -360,6 +380,7 @@ export type ConnectionCredential = {
 /**
  * CredentialBase is the base type for all credentials. It contains the common properties which are shared across
  * all credential types.
+ *
  */
 export type Credential = {
     /**
@@ -379,6 +400,7 @@ export type Credential = {
      * Errors is a list of errors which occurred when attempting to validate the credential. This field may be
      * undefined, which implies that validation has not occurred and the consumer cannot assume whether this
      * Credential is valid or not. An empty array indicates that the Credential is valid.
+     *
      */
     errors?: Array<string>;
     data?: CredentialData;
@@ -386,6 +408,7 @@ export type Credential = {
      * ExpiresAt denotes the time this credential should be automatically deleted. External systems can subscribe
      * to deletion events and if the reason is "expired", can trigger the correct notifications to interested
      * parties (such as un-publishing jobs which rely on the credential and emailing the owner to rectify it).
+     *
      */
     expiresAt?: string;
 };
@@ -417,12 +440,14 @@ export type CredentialData = {
  * - oauth1: The credential is an OAuth1 access_token to be used for OAuth1 authentication.
  * - oauth1-token: The credential is the oatuh1 token allowing bypassing the user authorization step.
  * - certificate: The credential is a PEM encoded certificate, key and CA to be used for TLS client authentication.
+ *
  */
 export type CredentialType = 'none' | 'string' | 'binary' | 'basic-auth' | 'oauth2-client' | 'oauth1' | 'oauth1-token' | 'oauth2-code' | 'oauth2-password' | 'oauth2-token' | 'certificate';
 /**
  * None
  * CredentialDataNone contains no data as no credential is required to authenticate with the Connector. It is used
  * purely as a placeholder to implement a consistent interface across all CredentialType/AuthSchemeTypes.
+ *
  */
 export type CredentialDataNone = {
     [key: string]: never;
@@ -431,10 +456,12 @@ export type CredentialDataNone = {
  * String
  * CredentialDataString contains a string value and nothing else and is commonly used for API keys. This value
  * will be redacted when returned in a response.
+ *
  */
 export type CredentialDataString = {
     /**
      * Value is a UTF-8 string containing the credential data. When read from the API this field will be redacted.
+     *
      */
     value: string;
 };
@@ -442,26 +469,31 @@ export type CredentialDataString = {
  * JWT
  * CredentialJWTBearer contains the username and password required to authenticate with the Connector. The
  * `secret` property will be redacted when returned in a response.
+ *
  */
 export type CredentialJwtBearer = {
     algorithm: 'HS256' | 'HS384' | 'HS512' | 'RS256' | 'RS384' | 'RS512';
     /**
      * Secret is the base64 encoded secret used to sign new JWTs.
+     *
      */
     secret: string;
     /**
      * Payload is stringified JSON object containing the default set of claims to include in the JWT payload.
      * Issued JWTs may contain additional claims and may overwrite ones defined here, such as `exp` and `iat`.
+     *
      */
     payload: string;
     /**
      * Expires in is a duration in the form `1h2m3s` (see Go's `time.Duration` documentation) which defined
      * how long a newly issued JWT should be valid for.
+     *
      */
     expiresIn: string;
     /**
      * AuthorizationHeaderPrefix is the prefix to use when setting the Authorization header, for example,
      * "Bearer" or "JWT".
+     *
      */
     authorizationHeaderPrefix: string;
 };
@@ -469,6 +501,7 @@ export type CredentialJwtBearer = {
  * Username/Password
  * CredentialDataBasicAuth contains the username and password required to authenticate with the Connector. The
  * `password` property will be redacted when returned in a response.
+ *
  */
 export type CredentialDataBasicAuth = {
     /**
@@ -478,12 +511,14 @@ export type CredentialDataBasicAuth = {
     /**
      * Password is the password used to authenticate with the Connector. Will be redacted when returned in a
      * response.
+     *
      */
     password: string;
 };
 /**
  * Certificate
  * CredentialDataCertificate contains the Certificate, Certificate key and CA(Certificate authority).
+ *
  */
 export type CredentialDataCertificate = {
     /**
@@ -503,6 +538,7 @@ export type CredentialDataCertificate = {
  * OAuth 2.0 Password
  * CredentialDataOAuth2Password contains the username and password of a Resource Owner within an OAuth 2.0
  * application. The `password` property will be redacted when returned in a response.
+ *
  */
 export type CredentialDataOAuth2Password = {
     /**
@@ -512,6 +548,7 @@ export type CredentialDataOAuth2Password = {
     /**
      * Password is the password used to authenticate with the Connector. Will be redacted when returned in a
      * response.
+     *
      */
     password: string;
 };
@@ -520,15 +557,18 @@ export type CredentialDataOAuth2Password = {
  * CredentialDataOAuth2Client contains the OAuth2 client credentials required to either issue an access token from
  * a refresh_token, or via the `client_credentials` and `authorization_code` grant types. The `clientSecret` property will be redacted when
  * returned in a response.
+ *
  */
 export type CredentialDataOAuth2Client = {
     /**
      * ClientID is the OAuth2 client ID used to authenticate with the Connector.
+     *
      */
     clientId: string;
     /**
      * ClientSecret is the OAuth2 client secret used to authenticate with the Connector. Will be redacted when
      * returned in a response.
+     *
      */
     clientSecret: string;
     /**
@@ -539,12 +579,14 @@ export type CredentialDataOAuth2Client = {
      * Scopes is a list of scopes which should be requested when issuing an access token. This is only required if
      * this credential is being used on a `client_credentials` grant type, for `authorization_code` grant types the
      * requested scopes come from the `CredentialDataOAuth2Token` credential.
+     *
      */
     scopes?: Array<string>;
     /**
      * AdditionalParams is a URL-encoded query string which can be used to pass additional
      * parameters to the OAuth 2.0 token endpoint. These parameters are attached to the body
      * in the formatted as the `application/x-www-form-urlencoded` content-type.
+     *
      */
     additionalParams?: string;
     /**
@@ -552,11 +594,13 @@ export type CredentialDataOAuth2Client = {
      * communicating with the OAuth2 provider. If enabled, the `mTLSCredentialId` field must be set, or it must be
      * created via the `CreateConnection` endpoint with an associated mTLS credential defined beforehand, in which
      * case the mTLSCredentialID field will be populated upon saving by the API.
+     *
      */
     mTLSEnabled?: boolean;
     /**
      * MTLSCredentialID is an optional reference to another credential being created.
      * If set the certificate credential will be used when making a request to the tokenUrl.
+     *
      */
     mTLSCredentialId?: string;
 };
@@ -567,6 +611,7 @@ export type CredentialDataOAuth2Client = {
  * via the API are the `scopes` which the user has granted consent for. This can be used to determine whether
  * the user should be prompted to re-authorize the application with additional scopes in the event they choose to
  * use a new endpoint which requires additional scopes to what they've already consented to.
+ *
  */
 export type CredentialDataOAuth2Token = {
     /**
@@ -576,10 +621,12 @@ export type CredentialDataOAuth2Token = {
     /**
      * AccessToken is the OAuth2 access token which can be used to authenticate with the Connector. This
      * information is redacted when read from the API.
+     *
      */
     accessToken?: string;
     /**
      * TokenType is the type of token which is being issued. Defaults to "Bearer" if not set.
+     *
      */
     tokenType?: string;
     /**
@@ -587,6 +634,7 @@ export type CredentialDataOAuth2Token = {
      * reused until a 401 response is received from the Connector, at which point the token should be refreshed
      * with the provided `refreshToken`. Ideally this should be provided so that erroneous failures can be
      * avoided.
+     *
      */
     expiresAt?: string;
     /**
@@ -596,6 +644,7 @@ export type CredentialDataOAuth2Token = {
      * This is a required field as it is used to refresh the access token when it expires. If users are providing
      * an access token which does not expire using this credential type, then the same functionality may be
      * achieved by using a simple API key and OAuth 2.0 need not be used.
+     *
      */
     refreshToken: string;
 };
@@ -606,14 +655,17 @@ export type CredentialDataOAuth2Token = {
  * This is only used when creating or updating an OAuth 2.0 connection using the
  * `authorization_code` grant type. Retrieving this credential will return a payload of
  * type `oauth2-token` in the shape of a `CredentialDataOAuth2Token` object.
+ *
  */
 export type CredentialDataOAuth2Code = {
     /**
      * Code is the authorization code which will be exchanged for an access token.
+     *
      */
     code: string;
     /**
      * State is the state value which is propagated through the OAuth2 flow.
+     *
      */
     state: string;
 };
@@ -641,12 +693,14 @@ export type AdditionalParam = {
  * Binary
  * CredentialDataBinary is commonly used to store non-string data such as binary files or encryption keys. This
  * value will be redacted when returned in a response.
+ *
  */
 export type CredentialDataBinary = {
     /**
      * Value is a base64 encoded string containing the credential data. This could decode to a valid utf-8 string,
      * or it could decode to a binary file such as a private key etc. When read from the API this field will be
      * redacted.
+     *
      */
     valueBase64: string;
 };
@@ -657,6 +711,7 @@ export type CredentialDataBinary = {
  * This type contains a string called `type` which denotes which field in this object should be populated.
  * For example if the `type` is `api-key`, then the `apiKey` field will be populated with an
  * `AuthSchemeConfigAPIKey` object.
+ *
  */
 export type AuthSchemeConfig = {
     type: AuthSchemeType;
@@ -671,6 +726,7 @@ export type AuthSchemeConfig = {
 /**
  * API Key
  * AuthSchemeConfigAPIKey defines how a Connector uses an API key credential to authenticate with the system.
+ *
  */
 export type AuthSchemeConfigApiKey = AuthSchemeConfigBase & {
     /**
@@ -681,25 +737,30 @@ export type AuthSchemeConfigApiKey = AuthSchemeConfigBase & {
 };
 /**
  * AuthSchemeConfigAPIKeyIn defines the location of the API key in the request.
+ *
  */
 export type AuthSchemeConfigApiKeyIn = 'query' | 'header' | 'cookie';
 /**
  * Type is a unique identifier of the AuthScheme, this is a kebab-case formatted string, see
  * enum values for possible options.
+ *
  */
 export type AuthSchemeType = 'none' | 'api-key' | 'basic-auth' | 'oauth2' | 'hmac' | 'jwt-bearer' | 'certificate' | 'oauth1' | 'secret';
 /**
  * OAuth2Scope represents a single scope which can be requested by an OAuth2 application.
+ *
  */
 export type OAuth2Scope = {
     /**
      * Name is the name of the scope as determined by the application to which this Connector
      * is connecting to.
+     *
      */
     name: string;
     /**
      * Description describes the scope in human-friendly terminology. This text may be
      * displayed to users via a help tooltip or similar.
+     *
      */
     description?: string;
 };
@@ -707,11 +768,13 @@ export type AuthSchemeConfigBase = {
     /**
      * ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and
      * only requires to be unique amongst the elements of the array in which is it contained.
+     *
      */
     id: string;
     /**
      * Description enables users to distinguish multiple configurations which use the same
      * schemeType.
+     *
      */
     description: string;
     /**
@@ -720,6 +783,7 @@ export type AuthSchemeConfigBase = {
      * creating or updating the AuthSchemeConfig.
      *
      * This field will be ignored if sent to the API.
+     *
      */
     validationMessages?: Array<Message>;
 };
@@ -736,27 +800,32 @@ export type AuthSchemeConfigOAuth2GrantType = 'authorizationCode' | 'clientCrede
  * - Otherwise, both the credential and the database are updated using JSON Merge Patch, with
  * undefined properties not being updated.
  * - Any other permutation will result in a 400 Bad Request.
+ *
  */
 export type AuthSchemeConfigOAuth2GrantAuthorizationCode = {
     /**
      * CredentialID is the unique identifier of the Credential which contains the client ID and
      * client secret to be used as part of the `password` flow.
+     *
      */
     credentialId?: string;
     /**
      * OrganisationID is the unique identifier of the Organisation that owns the Credential.
      * This can be different to the Connector's OrganisationID since some may be imported from
      * Versori's public library.
+     *
      */
     organisationId?: string;
     /**
      * ClientID is the OAuth 2.0 client's identifier. This is not a sensitive value and may be
      * presented to the user in plaintext.
+     *
      */
     clientId?: string;
     /**
      * ClientSecret is the OAuth 2.0 client's secret. This is a sensitive value and will not be
      * displayed to the user.
+     *
      */
     clientSecret?: string;
 };
@@ -778,26 +847,31 @@ export type AuthSchemeConfigOAuth2GrantClientCredentials = {
  * database.
  * - Otherwise, both the credential and the database are updated using JSON Merge Patch.
  * - Any other permutation will result in a 400 Bad Request.
+ *
  */
 export type AuthSchemeConfigOAuth2GrantPassword = {
     /**
      * CredentialID is the unique identifier of the Credential which contains the client ID and
      * client secret to be used as part of the `password` flow.
+     *
      */
     credentialId?: string;
     /**
      * OrganisationID is the unique identifier of the Organisation that owns the Credential. This can be different
      * to the Connector's OrganisationID since some may be imported from Versori's public library.
+     *
      */
     organisationId?: string;
     /**
      * ClientID is the OAuth 2.0 client's identifier. This is not a sensitive value and may be presented to the
      * user in plaintext.
+     *
      */
     clientId?: string;
     /**
      * ClientSecret is the OAuth 2.0 client's secret. This is a sensitive value and will not be displayed to the
      * user. It may be populated when updating the Credential.
+     *
      */
     clientSecret?: string;
 };
@@ -811,18 +885,21 @@ export type AuthSchemeConfigOAuth2Grant = {
  * None
  * AuthSchemeConfigNone is a placeholder object with the schemeType set to `none`. There is no other configuration
  * required.
+ *
  */
 export type AuthSchemeConfigNone = AuthSchemeConfigBase;
 /**
  * Basic Auth
  * AuthSchemeConfigBasicAuth is a placeholder object with the schemeType set to `basic-auth`. There is no other
  * configuration required.
+ *
  */
 export type AuthSchemeConfigBasicAuth = AuthSchemeConfigBase;
 /**
  * TLS Certificate
  * AuthSchemeConfigCertificate is a placeholder object with the schemeType set to `certificate`.
  * There is no other config required
+ *
  */
 export type AuthSchemeConfigCertificate = AuthSchemeConfigBase;
 /**
@@ -833,26 +910,31 @@ export type AuthSchemeConfigCertificate = AuthSchemeConfigBase;
  * `client_credentials` grant type, where the user provides the Client ID  and Client Secret at
  * the point where they connect, should use the `AuthSchemeConfigOAuth2ClientCredentials` type
  * instead.
+ *
  */
 export type AuthSchemeConfigOAuth2 = AuthSchemeConfigBase & {
     /**
      * AuthorizeURL is the URL which the user will be redirected to in order to authorize
      * the application.
+     *
      */
     authorizeUrl?: string;
     /**
      * TokenURL is the URL which the application will use to issue an access token.
+     *
      */
     tokenUrl: string;
     /**
      * Scopes is the list of all OAuth2 scopes which the application supports. The user
      * will be allowed to choose which scopes to request when configuring the Connection.
+     *
      */
     scopes: Array<OAuth2Scope>;
     /**
      * DefaultScopes is the list of scopes which will be requested by default when the user
      * connects the Connector. This is useful for Connectors which require a specific set
      * of scopes to function correctly.
+     *
      */
     defaultScopes: Array<string>;
     /**
@@ -862,18 +944,21 @@ export type AuthSchemeConfigOAuth2 = AuthSchemeConfigBase & {
      *
      * This value is only used by the UI to drive the default values when connecting, the
      * API to `InitialiseOAuth2Connection` can be provided a different value if required.
+     *
      */
     additionalAuthorizeParams?: string;
     /**
      * AdditionalTokenParams is a URL-encoded string following the
      * `application/x-www-form-urlencoded` mime-type, which can be used to pass additional
      * parameters to the OAuth 2.0 token endpoint within the request body.
+     *
      */
     additionalTokenParams?: string;
     /**
      * MTLSEnabled is a flag which determines whether the Connector should use Mutual TLS
      * (mTLS) to authenticate with the OAuth 2.0 token endpoint. This is useful for
      * Connectors which require a higher level of security.
+     *
      */
     mtlsEnabled?: boolean;
     /**
@@ -883,6 +968,7 @@ export type AuthSchemeConfigOAuth2 = AuthSchemeConfigBase & {
      * This may be unset when creating a connection, in which case if `mtlsEnabled` is
      * true, then the API will find an associated AuthSchemeConfigCertificate and link
      * them automatically.
+     *
      */
     mtlsCredentialId?: string;
     pkce?: boolean;
@@ -895,6 +981,7 @@ export type AuthSchemeConfigOAuth1 = AuthSchemeConfigBase & {
     /**
      * If set to 'true' the endpoints are optional but when connecting you need to use oauth1-token credentials and provide the token and token secret.
      * If left empty or set to 'false' you need to provide all the endpoint and connect using the oauth1 credentials which uses the browser authorize flow.
+     *
      */
     tokenAuth?: boolean;
     consumerKey: string;
@@ -946,6 +1033,7 @@ export type AuthSchemeConfigHmacIn = 'query' | 'header' | 'cookie';
  *
  * This may be used on outbound requests to sign the request body, however it is more commonly used on inbound
  * requests (i.e. from Webhook Triggers) to verify the sender of the request is allowed to invoke the Trigger.
+ *
  */
 export type AuthSchemeConfigHmac = AuthSchemeConfigBase & {
     /**
@@ -961,16 +1049,19 @@ export type AuthSchemeConfigHmac = AuthSchemeConfigBase & {
      * AuthSchemeConfigHMACInputs defines what parts of a HTTP request are consumed to generate the HMAC signature. Some systems
      * only generate the signature from the request body, others may include the URL. The order of this array
      * defines the order in which the input is fed into the hashing function.
+     *
      */
     digestInputs: Array<'body' | 'url'>;
     /**
      * Encoding defines how the HMAC signature was encoded. This can be one of `hex`, `base64` or `base64url`.
+     *
      */
     encoding: 'hex' | 'base64' | 'base64url';
 };
 /**
  * Message is a message to be displayed to the user to indicate some information about the
  * preceding request.
+ *
  */
 export type Message = {
     /**
@@ -981,12 +1072,14 @@ export type Message = {
     /**
      * Details contains additional information about the message. This is intended to be used
      * to provide more information about the message, such as a list of validation errors.
+     *
      */
     detail?: Array<string>;
 };
 export type MessageSeverity = 'info' | 'warning' | 'error';
 /**
  * InitialiseOAuth2ConnectionRequest is the payload to initialise an OAuth 2.0 connection.
+ *
  */
 export type InitialiseOAuth2ConnectionRequest = {
     credential: {
@@ -994,23 +1087,27 @@ export type InitialiseOAuth2ConnectionRequest = {
          * ID is the unique identifier of the credential which is being used to
          * initialise the connection. This is used to load the client_secret when the authorisation
          * code is exchanged for an access token.
+         *
          */
         id: string;
         /**
          * OrganisationID is the unique identifier of the organisation which the credential is
          * associated with. This is used to ensure that the credential is only used to initialise
          * connections for the organisation which owns the credential.
+         *
          */
         organisationId: string;
     };
     /**
      * AuthorizeURL is the URL which the user will be redirected to in order to authorize
      * the application.
+     *
      */
     authorizeUrl: string;
     /**
      * ClientID is the OAuth 2.0 client ID which is used to identify the application to the
      * OAuth 2.0 provider.
+     *
      */
     clientId: string;
     /**
@@ -1018,6 +1115,7 @@ export type InitialiseOAuth2ConnectionRequest = {
      *
      * Unless `disableOfflineAccess` is set to true, the API will also include the standard
      * `offline_access` scope in addition to the ones provided here.
+     *
      */
     scopes?: Array<string>;
     /**
@@ -1026,6 +1124,7 @@ export type InitialiseOAuth2ConnectionRequest = {
      * `scopes` to make it clear that the API will always include the `offline_access` scope
      * by default, but can be disabled if the system does not implement the standards so that
      * the user can define their own custom scope as part of `scopes`.
+     *
      */
     disableOfflineAccess?: boolean;
     /**
@@ -1041,6 +1140,7 @@ export type InitialiseOAuth2ConnectionRequest = {
      * If not provided, this API defaults to "login", unless `additionalParams` contains the
      * `approval_prompt` parameter (thanks, Google refresh tokens), in which case this value
      * does not default to anything.
+     *
      */
     prompt?: string;
     /**
@@ -1049,12 +1149,14 @@ export type InitialiseOAuth2ConnectionRequest = {
      * other parameters defined by the request, an attempt to do so will result in an error.
      *
      * These parameters are attached to returned URL as query parameters.
+     *
      */
     additionalParams?: string;
 };
 /**
  * InitialiseOAuth2ConnectionResponse contains the URL to redirect the user to in order to
  * initiate an OAuth 2.0 `authorization_code` grant flow.
+ *
  */
 export type InitialiseOAuth2ConnectionResponse = {
     /**
@@ -1064,6 +1166,7 @@ export type InitialiseOAuth2ConnectionResponse = {
 };
 /**
  * InitialiseOAuth1ConnectionRequest is the payload to initialise an OAuth 1.0 connection.
+ *
  */
 export type InitialiseOAuth1ConnectionRequest = {
     credential: {
@@ -1082,16 +1185,19 @@ export type EndUser = {
     /**
      * ID is the Versori identifier for the user. Most APIs will not use this field but instead reference
      * users by their externalId.
+     *
      */
     id: string;
     /**
      * ExternalID is the identifier for the user as determined by the organisation. This typically should
      * be the same as the user's ID on the organisations system. Regardless of the value, it must
      * be unique within the Organisation.
+     *
      */
     externalId: string;
     /**
      * DisplayName is an optional human-readable name for the user. If not set, the default is an empty string.
+     *
      */
     displayName: string;
     /**
@@ -1212,6 +1318,7 @@ export type LinkSystem = {
      * If the connections to the system need to be dynamic or static.
      * Dynamic connections are used when the integration runs for multiple end users.
      * Defaults to false if not set.
+     *
      */
     dynamic?: boolean;
 };
@@ -1245,6 +1352,7 @@ export type Action = {
     /**
      * ContentType is the content type that this action expects to receive in the request body if any, and the
      * content type of the response body if any. If this field is left blank, then "application/json" is assumed.
+     *
      */
     contentType?: string;
     summary?: string;
@@ -1254,6 +1362,7 @@ export type Action = {
      * Path is the path of the action, which may contain templated values in curly braces.
      * For example, `/users/{userId}`. The path should be the full path relative to the base URL of the system,
      * the base URL containing everything before (and including) the top-level domain (.com, .gov, .org etc).
+     *
      */
     path: string;
     /**
@@ -1261,18 +1370,22 @@ export type Action = {
      * used to set values in the path, query string or headers of the request. Note that when creating an action,
      * if the path contains templated values in curly braces, these will automatically be converted into
      * parameters of type `path` with the name of the parameter being the name of the templated value.
+     *
      */
     parameters: Array<ActionParameter>;
     /**
      * GraphQLQuery is the GraphQL query to execute for the action. This is only used if the action type is `graphql`.
+     *
      */
     graphqlQuery?: string;
     /**
      * Request is the request body of the action. This is only used if the action type is `http`.
+     *
      */
     request?: string;
     /**
      * Response is the response body of the action. This is only used if the action type is `http`.
+     *
      */
     response?: string;
 };
@@ -1298,6 +1411,7 @@ export type CreateActions = {
         /**
          * ContentType is the content type that this action expects to receive in the request body if any, and the
          * content type of the response body if any. If this field is left blank, then "application/json" is assumed.
+         *
          */
         contentType?: string;
         parameters?: Array<ActionParameter>;
@@ -1325,6 +1439,7 @@ export type UpdateConnectionTemplate = {
     /**
      * The IDs of the auth scheme config to use for this connection template. The overwhelming majority of the time,
      * this will only be a single ID. To see about multiple auth scheme configs, see ConnectionTemplate for details.
+     *
      */
     authSchemeConfigIds?: Array<string>;
 };
@@ -1346,6 +1461,7 @@ export type ConnectionTemplate = {
      * configs for different authentication methods. The overwhelming majority of the time, this will be a single config.
      * There does exist cases where credentials may need to be applied in sequence, such as mTLS. If there are multiple
      * auth scheme configs here, it acts like a queue and they are applied in order.
+     *
      */
     authSchemeConfigs: Array<AuthSchemeConfig>;
     templateBaseUrl: string;
@@ -1368,6 +1484,7 @@ export type SystemPage = PageInfo & {
  * Labels is a map of key-value pairs that can be used to store arbitrary metadata about a resource.
  * Keys must start with a letter and can only contain letters, numbers, and underscores.
  * Values can be any string.
+ *
  */
 export type Labels = {
     [key: string]: unknown;
@@ -1740,6 +1857,7 @@ export type ActivationId = string;
 /**
  * The static query parameter is used to list the static activation/user on endpoints.
  * This query parameter is really only intended for internal use or by the UI.
+ *
  */
 export type Static = boolean;
 export type EnvSystemId = string;
@@ -2116,6 +2234,7 @@ export type ListTracesData = {
          * - "url.path"
          * - "url.query"
          * - "url.scheme"
+         *
          */
         filter?: string;
         error?: boolean;
@@ -2316,11 +2435,13 @@ export type ListEndUsersData = {
         /**
          * Search is a string that is used to filter the list of End Users. The search string is matched against the
          * id, externalId and displayName fields.
+         *
          */
         search?: string;
         /**
          * Filter users by their activation status. Must be used together with environment_id.
          * If not provided, returns all users regardless of activation status.
+         *
          */
         activated?: boolean;
         /**
@@ -2328,6 +2449,7 @@ export type ListEndUsersData = {
          * When combined with 'activated=true', it returns users that are activated in the specified environment.
          * When combined with 'activated=false', it returns users that are not activated in this specific environment.
          * If not provided, returns users from all environments.
+         *
          */
         environment_id?: string;
     };
@@ -2696,6 +2818,7 @@ export type ListActivationsData = {
         /**
          * The static query parameter is used to list the static activation/user on endpoints.
          * This query parameter is really only intended for internal use or by the UI.
+         *
          */
         static?: boolean;
     };
@@ -3484,26 +3607,31 @@ export type ListIssuesData = {
         /**
          * Which date to use in after and before queries. If not provided, defaults to createdAt.
          * The result will also be ordered by this date.
+         *
          */
         search_date?: 'createdAt' | 'lastSeenAt';
         /**
          * Filter issues by status. Can be one of 'open', 'closed', 'acked' or 'resolved'.
          * If not provided, defaults to getting issues of all statuses.
+         *
          */
         status?: IssueStatusEnum;
         /**
          * Filter issues by project ID. If not provided, issues from all projects are returned.
          * This is useful for filtering issues related to a specific project.
+         *
          */
         project_id?: string;
         /**
          * Filter issues by environment ID. If not provided, issues from all projects are returned.
          * This is useful for filtering issues related to a specific environment.
+         *
          */
         environment_id?: string;
         /**
          * Filter issues by severity. Can be one of 'low', 'medium', or 'high'.
          * If not provided, issues of all severities are returned.
+         *
          */
         severity?: IssueSeverityEnum;
     };