@keboola/api-client 0.1.0

package/dist/vault/types.d.cts

@@ -0,0 +1,390 @@
+import { b as OpenapiBodyType, d as OpenapiPathType, A as ArrayElement, a as OpenapiReturnType, c as OpenapiQueryType } from '../types-C7mpAfq-.cjs';
+
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+type paths = {
+  '/health-check': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    /**
+     * Health-check endpoint
+     * @description Checks the service is up & running.
+     *
+     */
+    post: operations['healthCheck'];
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/variables': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * List variables
+     * @description Lists variables.
+     *
+     */
+    get: operations['listVariables'];
+    put?: never;
+    /**
+     * Create variable
+     * @description Creates a new variable.
+     *
+     */
+    post: operations['createVariable'];
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/variables/{hash}': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    post?: never;
+    /**
+     * Delete variable
+     * @description Deletes a variable.
+     *
+     */
+    delete: operations['deleteVariable'];
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/variables/merged/branch': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * List variables variables available in scope of the branch
+     * @deprecated
+     * @description List variables variables available in scope of the branch.
+     *
+     */
+    get: {
+      parameters: {
+        query: {
+          /** @description Branch ID */
+          branchId: string;
+        };
+        header?: never;
+        path?: never;
+        cookie?: never;
+      };
+      requestBody?: never;
+      responses: {
+        /** @description OK */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            'application/json': components['schemas']['VariableWithHash'][];
+          };
+        };
+        401: components['responses']['401_Unauthorized'];
+        403: components['responses']['403_Forbidden'];
+      };
+    };
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+  '/variables/scoped/branch/{branchId}': {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    /**
+     * List variables variables available in scope of the branch
+     * @description List variables variables available in scope of the branch.
+     *
+     */
+    get: operations['listBranchVariables'];
+    put?: never;
+    post?: never;
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
+};
+type components = {
+  schemas: {
+    Variable: {
+      /** @example mysql_host */
+      key: string;
+      value: string;
+      /** @default [] */
+      flags: ('encrypted' | 'oauthCredentialsId')[];
+      /** @example MySQL Credentials */
+      group?: string;
+      /**
+       * @description Key-value map of additional attributes.
+       *
+       *     Attributes are part of the variable identity, so two variables with the same key but different attributes
+       *     are considered different.
+       *
+       * @default {}
+       */
+      attributes: {
+        branchId?: string;
+      } & {
+        [key: string]: string;
+      };
+    };
+    VariableWithHash: components['schemas']['Variable'] & {
+      /** @description SHA-256 hash of the variable key + attributes */
+      hash?: string;
+    };
+    Error: {
+      error: string;
+      code: number;
+      exceptionId: string;
+      /** @enum {unknown} */
+      status: 'error';
+      context?: Record<string, never>;
+    };
+  };
+  responses: {
+    /** @description Bad request */
+    '400_BadRequest': {
+      headers: {
+        [name: string]: unknown;
+      };
+      content: {
+        'application/json': components['schemas']['Error'];
+      };
+    };
+    /** @description Unauthorized */
+    '401_Unauthorized': {
+      headers: {
+        [name: string]: unknown;
+      };
+      content: {
+        'application/json': components['schemas']['Error'];
+      };
+    };
+    /** @description Forbidden */
+    '403_Forbidden': {
+      headers: {
+        [name: string]: unknown;
+      };
+      content: {
+        'application/json': components['schemas']['Error'];
+      };
+    };
+  };
+  parameters: never;
+  requestBodies: never;
+  headers: never;
+  pathItems: never;
+};
+type operations = {
+  healthCheck: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description OK */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': {
+            api?: string;
+            /** Format: url */
+            documentation?: string;
+          };
+        };
+      };
+    };
+  };
+  listVariables: {
+    parameters: {
+      query?: {
+        /** @description Variable key */
+        key?: string;
+        /** @description Attributes to match */
+        attributes?: {
+          branchId?: string;
+        };
+        /** @description Pagination offset */
+        offset?: number;
+        /** @description Maximum number of items to return */
+        limit?: number;
+      };
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description OK */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['VariableWithHash'][];
+        };
+      };
+      401: components['responses']['401_Unauthorized'];
+      403: components['responses']['403_Forbidden'];
+      /** @description Invalid request parameters */
+      404: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
+  createVariable: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    requestBody: {
+      content: {
+        'application/json': components['schemas']['Variable'];
+      };
+    };
+    responses: {
+      /** @description Variable created */
+      201: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['VariableWithHash'];
+        };
+      };
+      400: components['responses']['400_BadRequest'];
+      401: components['responses']['401_Unauthorized'];
+      403: components['responses']['403_Forbidden'];
+      /** @description Invalid request payload */
+      422: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
+  deleteVariable: {
+    parameters: {
+      query?: never;
+      header?: never;
+      path: {
+        /** @description Variable hash */
+        hash: string;
+      };
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description Variable deleted */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+      401: components['responses']['401_Unauthorized'];
+      403: components['responses']['403_Forbidden'];
+      /** @description Variable not found */
+      404: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content?: never;
+      };
+    };
+  };
+  listBranchVariables: {
+    parameters: {
+      query?: {
+        /** @description Variable key. If set, only variables with given key are returned. */
+        key?: string;
+        /** @description Other attributes to match.
+         *     * if attribute is set with value, only variables with given attribute value are returned
+         *     * if attribute is set without value (empty string), only variables without the attribute are returned
+         *     * any attribute not set is not matched, variables are returned regardless if they have the attribute or not
+         *      */
+        attributes?: Record<string, never>;
+      };
+      header?: never;
+      path: {
+        /** @description ID of the branch */
+        branchId: string;
+      };
+      cookie?: never;
+    };
+    requestBody?: never;
+    responses: {
+      /** @description OK */
+      200: {
+        headers: {
+          [name: string]: unknown;
+        };
+        content: {
+          'application/json': components['schemas']['VariableWithHash'][];
+        };
+      };
+      401: components['responses']['401_Unauthorized'];
+      403: components['responses']['403_Forbidden'];
+    };
+  };
+};
+
+type GetVariablesQuery = OpenapiQueryType<paths['/variables']['get']>;
+type DeleteVariablePath = OpenapiPathType<paths['/variables/{hash}']['delete']>;
+type CreateVariableBody = OpenapiBodyType<paths['/variables']['post']>;
+type GetVariablesByBranchId = OpenapiPathType<paths['/variables/scoped/branch/{branchId}']['get']>;
+type VariableWithHashRaw = ArrayElement<OpenapiReturnType<paths['/variables']['get']>>;
+type VariableWithHash = Omit<VariableWithHashRaw, 'hash'> & {
+    hash: string;
+};
+
+export type { CreateVariableBody, DeleteVariablePath, GetVariablesByBranchId, GetVariablesQuery, VariableWithHash };