@planqk/planqk-service-sdk 1.6.0 → 1.7.0

package/dist/sdk/api/resources/serviceApi/client/requests/StartExecutionRequest.d.ts

@@ -8,5 +8,7 @@ import * as PlanqkServiceApi from "../../../..";
  */
 export interface StartExecutionRequest {
     data?: PlanqkServiceApi.InputData;
+    dataRef?: PlanqkServiceApi.InputDataRef;
     params?: PlanqkServiceApi.InputParams;
+    paramsRef?: PlanqkServiceApi.InputParamsRef;
 }

package/dist/sdk/api/resources/serviceApi/types/GetResultResponse.d.ts

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as PlanqkServiceApi from "../../..";
-export type GetResultResponse = PlanqkServiceApi.ResultResponse | PlanqkServiceApi.ErrorResponse;
+export type GetResultResponse = PlanqkServiceApi.ObjectResponse | PlanqkServiceApi.StringResponse | PlanqkServiceApi.NumberResponse | PlanqkServiceApi.ArrayResponse;

package/dist/sdk/api/types/ArrayResponse.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type ArrayResponse = Record<string, any>[];

package/dist/sdk/api/types/InputDataRef.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface InputDataRef {
+    dataPoolId: string;
+    dataSourceDescriptorId: string;
+    fileId: string;
+}

package/dist/sdk/api/types/InputParamsRef.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface InputParamsRef {
+    dataPoolId: string;
+    dataSourceDescriptorId: string;
+    fileId: string;
+}

package/dist/sdk/api/types/InputParamsRef.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/sdk/api/types/{ErrorResponse.d.ts → NumberResponse.d.ts}

@@ -1,4 +1,4 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type ErrorResponse = Record<string, any>;
+export type NumberResponse = number;

package/dist/sdk/api/types/NumberResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/sdk/api/types/{ResultResponse.d.ts → ObjectResponse.d.ts}

@@ -1,4 +1,4 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type ResultResponse = Record<string, any>;
+export type ObjectResponse = Record<string, any>;

package/dist/sdk/api/types/ObjectResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/sdk/api/types/StringResponse.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type StringResponse = string;

package/dist/sdk/api/types/StringResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/sdk/api/types/index.d.ts

@@ -1,7 +1,11 @@
 export * from "./InputData";
+export * from "./InputDataRef";
 export * from "./InputParams";
+export * from "./InputParamsRef";
 export * from "./InterimResultResponse";
-export * from "./ResultResponse";
-export * from "./ErrorResponse";
+export * from "./ObjectResponse";
+export * from "./StringResponse";
+export * from "./NumberResponse";
+export * from "./ArrayResponse";
 export * from "./JobStatus";
 export * from "./Job";

package/dist/sdk/api/types/index.js

@@ -15,9 +15,13 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./InputData"), exports);
+__exportStar(require("./InputDataRef"), exports);
 __exportStar(require("./InputParams"), exports);
+__exportStar(require("./InputParamsRef"), exports);
 __exportStar(require("./InterimResultResponse"), exports);
-__exportStar(require("./ResultResponse"), exports);
-__exportStar(require("./ErrorResponse"), exports);
+__exportStar(require("./ObjectResponse"), exports);
+__exportStar(require("./StringResponse"), exports);
+__exportStar(require("./NumberResponse"), exports);
+__exportStar(require("./ArrayResponse"), exports);
 __exportStar(require("./JobStatus"), exports);
 __exportStar(require("./Job"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planqk/planqk-service-sdk",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Typescript SDK to execute PlanQK Managed Services.",
   "author": "Kipu Quantum GmbH",
   "contributors": [

package/src/sdk/api/resources/serviceApi/client/requests/StartExecutionRequest.ts

@@ -10,5 +10,7 @@ import * as PlanqkServiceApi from "../../../..";
  */
 export interface StartExecutionRequest {
     data?: PlanqkServiceApi.InputData;
+    dataRef?: PlanqkServiceApi.InputDataRef;
     params?: PlanqkServiceApi.InputParams;
+    paramsRef?: PlanqkServiceApi.InputParamsRef;
 }

package/src/sdk/api/resources/serviceApi/types/GetResultResponse.ts

@@ -4,4 +4,8 @@
 
 import * as PlanqkServiceApi from "../../..";
 
-export type GetResultResponse = PlanqkServiceApi.ResultResponse | PlanqkServiceApi.ErrorResponse;
+export type GetResultResponse =
+    | PlanqkServiceApi.ObjectResponse
+    | PlanqkServiceApi.StringResponse
+    | PlanqkServiceApi.NumberResponse
+    | PlanqkServiceApi.ArrayResponse;

package/src/sdk/api/types/ArrayResponse.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export type ArrayResponse = Record<string, any>[];

package/src/sdk/api/types/InputDataRef.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export interface InputDataRef {
+    dataPoolId: string;
+    dataSourceDescriptorId: string;
+    fileId: string;
+}

package/src/sdk/api/types/InputParamsRef.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export interface InputParamsRef {
+    dataPoolId: string;
+    dataSourceDescriptorId: string;
+    fileId: string;
+}

package/src/sdk/api/types/{ErrorResponse.ts → NumberResponse.ts}

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-export type ErrorResponse = Record<string, any>;
+export type NumberResponse = number;

package/src/sdk/api/types/{ResultResponse.ts → ObjectResponse.ts}

@@ -2,4 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 
-export type ResultResponse = Record<string, any>;
+export type ObjectResponse = Record<string, any>;

package/src/sdk/api/types/StringResponse.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export type StringResponse = string;

package/src/sdk/api/types/index.ts

@@ -1,7 +1,11 @@
 export * from "./InputData";
+export * from "./InputDataRef";
 export * from "./InputParams";
+export * from "./InputParamsRef";
 export * from "./InterimResultResponse";
-export * from "./ResultResponse";
-export * from "./ErrorResponse";
+export * from "./ObjectResponse";
+export * from "./StringResponse";
+export * from "./NumberResponse";
+export * from "./ArrayResponse";
 export * from "./JobStatus";
 export * from "./Job";

package/tests/integration.test.ts

@@ -1,6 +1,6 @@
 import {PlanqkServiceAuth, PlanqkServiceClient} from '../src'
 import {PlanqkServiceApiClient} from '../src/sdk'
-import {JobStatus} from '../src/sdk/api'
+import {JobStatus, StartExecutionRequest} from '../src/sdk/api'
 import {complexInput} from './fixtures/complex-input'
 
 const serviceEndpoint = process.env.SERVICE_ENDPOINT
@@ -59,3 +59,31 @@ test('should use client abstraction', async () => {
   job = await client.getStatus(job.id!)
   expect(job.status).toBe(JobStatus.Succeeded)
 }, 5 * 60 * 1000)
+
+test('should execute with data pool ref', async () => {
+  const client = new PlanqkServiceClient(serviceEndpoint, consumerKey, consumerSecret)
+
+  const health = await client.healthCheck()
+  expect(health.status).toBe('Service is up and running')
+
+  const request: StartExecutionRequest = {
+    dataRef: {
+      dataPoolId: 'e3859bb2-1959-4d3d-852b-62ee81b28a72',
+      dataSourceDescriptorId: '1c8d341e-1c86-4e19-acae-2f84bcab55ca',
+      fileId: 'f5251675-49c6-49f3-a3a6-de75b8335d76',
+    },
+    params: {},
+  }
+
+  let job = await client.startExecution(request)
+  expect(job.id).toBeDefined()
+  expect(job.status).toBe(JobStatus.Pending)
+
+  job = await client.getStatus(job.id!)
+
+  const result = await client.getResult(job.id!)
+  expect(result).toBeDefined()
+
+  job = await client.getStatus(job.id!)
+  expect(job.status).toBe(JobStatus.Succeeded)
+}, 5 * 60 * 1000)