@researchdatabox/raido-openapi-generated-node 0.0.1 → 0.0.3

package/README.md

@@ -1,3 +1,3 @@
 Generate using `npm run generate`
 
-Currently manually deployed to NPM registry.
+Currently manually deployed to the NPM registry.

package/dist/api/apis.js

@@ -15,14 +15,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.APIS = exports.HttpError = void 0;
-__exportStar(require("./adminExperimentalApi"), exports);
-const adminExperimentalApi_1 = require("./adminExperimentalApi");
-__exportStar(require("./basicRaidExperimentalApi"), exports);
-const basicRaidExperimentalApi_1 = require("./basicRaidExperimentalApi");
-__exportStar(require("./publicExperimentalApi"), exports);
-const publicExperimentalApi_1 = require("./publicExperimentalApi");
-__exportStar(require("./unauthzExperimentalApi"), exports);
-const unauthzExperimentalApi_1 = require("./unauthzExperimentalApi");
+__exportStar(require("./raidApi"), exports);
+const raidApi_1 = require("./raidApi");
+__exportStar(require("./servicePointApi"), exports);
+const servicePointApi_1 = require("./servicePointApi");
 class HttpError extends Error {
     response;
     body;
@@ -36,4 +32,4 @@ class HttpError extends Error {
     }
 }
 exports.HttpError = HttpError;
-exports.APIS = [adminExperimentalApi_1.AdminExperimentalApi, basicRaidExperimentalApi_1.BasicRaidExperimentalApi, publicExperimentalApi_1.PublicExperimentalApi, unauthzExperimentalApi_1.UnauthzExperimentalApi];
+exports.APIS = [raidApi_1.RaidApi, servicePointApi_1.ServicePointApi];

package/dist/api/{basicRaidExperimentalApi.js → raidApi.js}

@@ -1,7 +1,7 @@
 "use strict";
 /**
  * RAID v2 API
- * This file is where all the endpoint paths are defined, it\'s the \"top level\' of the OpenAPI definition that links all the different files together. The `3.0` in the filename refers to this file being based on OpenAPI 3.0  as opposed to OpenAPI 3.1, which the tooling doesn\'t support yet. The `2.0.0` in the version field refers to the fact that there\'s already  a `1.0.0` used for the legacy RAiD application (not this project).
+ * This file is where all the endpoint paths are defined, it\'s the \"top level\' of the OpenAPI definition that links all the different files together. The `3.0` in the filename refers to this file being based on OpenAPI 3.0  as opposed to OpenAPI 3.1, which the tooling doesn\'t support yet. The `2.0.0` in the version field refers to the fact that there\'s already  a `1.0.0` used for the legacy RAiD application. Note that swagger ui doesn\'t currently work with our spec,  see https://github.com/swagger-api/swagger-ui/issues/7724 But the spec works fine with openapi-generator tooling.
  *
  * The version of the OpenAPI document: 2.0.0
  * Contact: contact@raid.org
@@ -14,25 +14,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BasicRaidExperimentalApi = exports.BasicRaidExperimentalApiApiKeys = void 0;
+exports.RaidApi = exports.RaidApiApiKeys = void 0;
 const request_1 = __importDefault(require("request"));
 const models_1 = require("../model/models");
 const models_2 = require("../model/models");
 const apis_1 = require("./apis");
-let defaultBasePath = 'https://demo.raido-infra.com';
+let defaultBasePath = 'https://api.prod.raid.org.au';
 // ===============================================
 // This file is autogenerated - Please do not edit
 // ===============================================
-var BasicRaidExperimentalApiApiKeys;
-(function (BasicRaidExperimentalApiApiKeys) {
-})(BasicRaidExperimentalApiApiKeys = exports.BasicRaidExperimentalApiApiKeys || (exports.BasicRaidExperimentalApiApiKeys = {}));
-class BasicRaidExperimentalApi {
+var RaidApiApiKeys;
+(function (RaidApiApiKeys) {
+})(RaidApiApiKeys = exports.RaidApiApiKeys || (exports.RaidApiApiKeys = {}));
+class RaidApi {
     _basePath = defaultBasePath;
     _defaultHeaders = {};
     _useQuerystring = false;
     authentications = {
         'default': new models_1.VoidAuth(),
-        'BearerAuth': new models_2.HttpBearerAuth(),
+        'bearerAuth': new models_2.HttpBearerAuth(),
     };
     interceptors = [];
     constructor(basePathOrUsername, password, basePath) {
@@ -66,10 +66,10 @@ class BasicRaidExperimentalApi {
         this.authentications.default = auth;
     }
     setApiKey(key, value) {
-        this.authentications[BasicRaidExperimentalApiApiKeys[key]].apiKey = value;
+        this.authentications[RaidApiApiKeys[key]].apiKey = value;
     }
     set accessToken(accessToken) {
-        this.authentications.BearerAuth.accessToken = accessToken;
+        this.authentications.bearerAuth.accessToken = accessToken;
     }
     addInterceptor(interceptor) {
         this.interceptors.push(interceptor);
@@ -77,10 +77,11 @@ class BasicRaidExperimentalApi {
     /**
      *
      * @summary list raids
-     * @param raidListRequestV2
+     * @param servicePointId
+     * @param includeFields The top level fields to include in each RAiD in the response body. Excludes all other fields.
      */
-    async listRaidV2(raidListRequestV2, options = { headers: {} }) {
-        const localVarPath = this.basePath + '/v2/experimental/list-raid/v2';
+    async findAllRaids(servicePointId, includeFields, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/raid/';
         let localVarQueryParameters = {};
         let localVarHeaderParams = Object.assign({}, this._defaultHeaders);
         const produces = ['application/json'];
@@ -92,24 +93,25 @@ class BasicRaidExperimentalApi {
             localVarHeaderParams.Accept = produces.join(',');
         }
         let localVarFormParams = {};
-        // verify required parameter 'raidListRequestV2' is not null or undefined
-        if (raidListRequestV2 === null || raidListRequestV2 === undefined) {
-            throw new Error('Required parameter raidListRequestV2 was null or undefined when calling listRaidV2.');
+        if (servicePointId !== undefined) {
+            localVarQueryParameters['servicePointId'] = models_1.ObjectSerializer.serialize(servicePointId, "number");
+        }
+        if (includeFields !== undefined) {
+            localVarQueryParameters['includeFields'] = models_1.ObjectSerializer.serialize(includeFields, "Array<string>");
         }
         Object.assign(localVarHeaderParams, options.headers);
         let localVarUseFormData = false;
         let localVarRequestOptions = {
-            method: 'POST',
+            method: 'GET',
             qs: localVarQueryParameters,
             headers: localVarHeaderParams,
             uri: localVarPath,
             useQuerystring: this._useQuerystring,
             json: true,
-            body: models_1.ObjectSerializer.serialize(raidListRequestV2, "RaidListRequestV2")
         };
         let authenticationPromise = Promise.resolve();
-        if (this.authentications.BearerAuth.accessToken) {
-            authenticationPromise = authenticationPromise.then(() => this.authentications.BearerAuth.applyToRequest(localVarRequestOptions));
+        if (this.authentications.bearerAuth.accessToken) {
+            authenticationPromise = authenticationPromise.then(() => this.authentications.bearerAuth.applyToRequest(localVarRequestOptions));
         }
         authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
         let interceptorPromise = authenticationPromise;
@@ -132,7 +134,7 @@ class BasicRaidExperimentalApi {
                     }
                     else {
                         if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
-                            body = models_1.ObjectSerializer.deserialize(body, "Array<RaidListItemV2>");
+                            body = models_1.ObjectSerializer.deserialize(body, "Array<RaidDto>");
                             resolve({ response: response, body: body });
                         }
                         else {
@@ -145,11 +147,15 @@ class BasicRaidExperimentalApi {
     }
     /**
      *
-     * @summary mint a raido-metadata-schema-v1 raid
-     * @param mintRaidoSchemaV1Request
+     * @summary read a raid, caller must be authorized
+     * @param prefix Prefix of the raid handle
+     * @param suffix Suffix of the raid handle
+     * @param version The version of the raid
      */
-    async mintRaidoSchemaV1(mintRaidoSchemaV1Request, options = { headers: {} }) {
-        const localVarPath = this.basePath + '/v2/experimental/mint-raido-schema/v1';
+    async findRaidByName(prefix, suffix, version, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/raid/{prefix}/{suffix}'
+            .replace('{' + 'prefix' + '}', encodeURIComponent(String(prefix)))
+            .replace('{' + 'suffix' + '}', encodeURIComponent(String(suffix)));
         let localVarQueryParameters = {};
         let localVarHeaderParams = Object.assign({}, this._defaultHeaders);
         const produces = ['application/json'];
@@ -161,24 +167,30 @@ class BasicRaidExperimentalApi {
             localVarHeaderParams.Accept = produces.join(',');
         }
         let localVarFormParams = {};
-        // verify required parameter 'mintRaidoSchemaV1Request' is not null or undefined
-        if (mintRaidoSchemaV1Request === null || mintRaidoSchemaV1Request === undefined) {
-            throw new Error('Required parameter mintRaidoSchemaV1Request was null or undefined when calling mintRaidoSchemaV1.');
+        // verify required parameter 'prefix' is not null or undefined
+        if (prefix === null || prefix === undefined) {
+            throw new Error('Required parameter prefix was null or undefined when calling findRaidByName.');
+        }
+        // verify required parameter 'suffix' is not null or undefined
+        if (suffix === null || suffix === undefined) {
+            throw new Error('Required parameter suffix was null or undefined when calling findRaidByName.');
+        }
+        if (version !== undefined) {
+            localVarQueryParameters['version'] = models_1.ObjectSerializer.serialize(version, "number");
         }
         Object.assign(localVarHeaderParams, options.headers);
         let localVarUseFormData = false;
         let localVarRequestOptions = {
-            method: 'POST',
+            method: 'GET',
             qs: localVarQueryParameters,
             headers: localVarHeaderParams,
             uri: localVarPath,
             useQuerystring: this._useQuerystring,
             json: true,
-            body: models_1.ObjectSerializer.serialize(mintRaidoSchemaV1Request, "MintRaidoSchemaV1Request")
         };
         let authenticationPromise = Promise.resolve();
-        if (this.authentications.BearerAuth.accessToken) {
-            authenticationPromise = authenticationPromise.then(() => this.authentications.BearerAuth.applyToRequest(localVarRequestOptions));
+        if (this.authentications.bearerAuth.accessToken) {
+            authenticationPromise = authenticationPromise.then(() => this.authentications.bearerAuth.applyToRequest(localVarRequestOptions));
         }
         authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
         let interceptorPromise = authenticationPromise;
@@ -201,7 +213,7 @@ class BasicRaidExperimentalApi {
                     }
                     else {
                         if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
-                            body = models_1.ObjectSerializer.deserialize(body, "MintResponse");
+                            body = models_1.ObjectSerializer.deserialize(body, "RaidDto");
                             resolve({ response: response, body: body });
                         }
                         else {
@@ -214,11 +226,11 @@ class BasicRaidExperimentalApi {
     }
     /**
      *
-     * @summary read a raid, caller must be authorized
-     * @param readRaidV2Request
+     * @summary mint a raid
+     * @param raidCreateRequest
      */
-    async readRaidV2(readRaidV2Request, options = { headers: {} }) {
-        const localVarPath = this.basePath + '/v2/experimental/read-raid/v2';
+    async mintRaid(raidCreateRequest, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/raid/';
         let localVarQueryParameters = {};
         let localVarHeaderParams = Object.assign({}, this._defaultHeaders);
         const produces = ['application/json'];
@@ -230,9 +242,9 @@ class BasicRaidExperimentalApi {
             localVarHeaderParams.Accept = produces.join(',');
         }
         let localVarFormParams = {};
-        // verify required parameter 'readRaidV2Request' is not null or undefined
-        if (readRaidV2Request === null || readRaidV2Request === undefined) {
-            throw new Error('Required parameter readRaidV2Request was null or undefined when calling readRaidV2.');
+        // verify required parameter 'raidCreateRequest' is not null or undefined
+        if (raidCreateRequest === null || raidCreateRequest === undefined) {
+            throw new Error('Required parameter raidCreateRequest was null or undefined when calling mintRaid.');
         }
         Object.assign(localVarHeaderParams, options.headers);
         let localVarUseFormData = false;
@@ -243,11 +255,11 @@ class BasicRaidExperimentalApi {
             uri: localVarPath,
             useQuerystring: this._useQuerystring,
             json: true,
-            body: models_1.ObjectSerializer.serialize(readRaidV2Request, "ReadRaidV2Request")
+            body: models_1.ObjectSerializer.serialize(raidCreateRequest, "RaidCreateRequest")
         };
         let authenticationPromise = Promise.resolve();
-        if (this.authentications.BearerAuth.accessToken) {
-            authenticationPromise = authenticationPromise.then(() => this.authentications.BearerAuth.applyToRequest(localVarRequestOptions));
+        if (this.authentications.bearerAuth.accessToken) {
+            authenticationPromise = authenticationPromise.then(() => this.authentications.bearerAuth.applyToRequest(localVarRequestOptions));
         }
         authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
         let interceptorPromise = authenticationPromise;
@@ -270,7 +282,7 @@ class BasicRaidExperimentalApi {
                     }
                     else {
                         if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
-                            body = models_1.ObjectSerializer.deserialize(body, "ReadRaidResponseV2");
+                            body = models_1.ObjectSerializer.deserialize(body, "RaidDto");
                             resolve({ response: response, body: body });
                         }
                         else {
@@ -283,11 +295,14 @@ class BasicRaidExperimentalApi {
     }
     /**
      *
-     * @summary update a raido-metadata-schema-v1 raid
-     * @param updateRaidoSchemaV1Request
+     * @summary A list of the changes to the raid
+     * @param prefix Prefix of the raid handle
+     * @param suffix Suffix of the raid handle
      */
-    async updateRaidoSchemaV1(updateRaidoSchemaV1Request, options = { headers: {} }) {
-        const localVarPath = this.basePath + '/v2/experimental/update-raido-schema/v1';
+    async raidHistory(prefix, suffix, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/raid/{prefix}/{suffix}/history'
+            .replace('{' + 'prefix' + '}', encodeURIComponent(String(prefix)))
+            .replace('{' + 'suffix' + '}', encodeURIComponent(String(suffix)));
         let localVarQueryParameters = {};
         let localVarHeaderParams = Object.assign({}, this._defaultHeaders);
         const produces = ['application/json'];
@@ -299,24 +314,27 @@ class BasicRaidExperimentalApi {
             localVarHeaderParams.Accept = produces.join(',');
         }
         let localVarFormParams = {};
-        // verify required parameter 'updateRaidoSchemaV1Request' is not null or undefined
-        if (updateRaidoSchemaV1Request === null || updateRaidoSchemaV1Request === undefined) {
-            throw new Error('Required parameter updateRaidoSchemaV1Request was null or undefined when calling updateRaidoSchemaV1.');
+        // verify required parameter 'prefix' is not null or undefined
+        if (prefix === null || prefix === undefined) {
+            throw new Error('Required parameter prefix was null or undefined when calling raidHistory.');
+        }
+        // verify required parameter 'suffix' is not null or undefined
+        if (suffix === null || suffix === undefined) {
+            throw new Error('Required parameter suffix was null or undefined when calling raidHistory.');
         }
         Object.assign(localVarHeaderParams, options.headers);
         let localVarUseFormData = false;
         let localVarRequestOptions = {
-            method: 'POST',
+            method: 'GET',
             qs: localVarQueryParameters,
             headers: localVarHeaderParams,
             uri: localVarPath,
             useQuerystring: this._useQuerystring,
             json: true,
-            body: models_1.ObjectSerializer.serialize(updateRaidoSchemaV1Request, "UpdateRaidoSchemaV1Request")
         };
         let authenticationPromise = Promise.resolve();
-        if (this.authentications.BearerAuth.accessToken) {
-            authenticationPromise = authenticationPromise.then(() => this.authentications.BearerAuth.applyToRequest(localVarRequestOptions));
+        if (this.authentications.bearerAuth.accessToken) {
+            authenticationPromise = authenticationPromise.then(() => this.authentications.bearerAuth.applyToRequest(localVarRequestOptions));
         }
         authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
         let interceptorPromise = authenticationPromise;
@@ -339,7 +357,7 @@ class BasicRaidExperimentalApi {
                     }
                     else {
                         if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
-                            body = models_1.ObjectSerializer.deserialize(body, "MintResponse");
+                            body = models_1.ObjectSerializer.deserialize(body, "Array<RaidChange>");
                             resolve({ response: response, body: body });
                         }
                         else {
@@ -352,11 +370,14 @@ class BasicRaidExperimentalApi {
     }
     /**
      *
-     * @summary upgrade (i.e. change the schema) of a legacy raid to be a  raido-metadata-schema-v1 raid, but supplying the missing data
-     * @param updateRaidoSchemaV1Request
+     * @param prefix Prefix of the raid handle
+     * @param suffix Suffix of the raid handle
+     * @param raidUpdateRequest
      */
-    async upgradeLegacyToRaidoSchema(updateRaidoSchemaV1Request, options = { headers: {} }) {
-        const localVarPath = this.basePath + '/v2/experimental/upgrade-legacy-to-raido-schema/v1';
+    async updateRaid(prefix, suffix, raidUpdateRequest, options = { headers: {} }) {
+        const localVarPath = this.basePath + '/raid/{prefix}/{suffix}'
+            .replace('{' + 'prefix' + '}', encodeURIComponent(String(prefix)))
+            .replace('{' + 'suffix' + '}', encodeURIComponent(String(suffix)));
         let localVarQueryParameters = {};
         let localVarHeaderParams = Object.assign({}, this._defaultHeaders);
         const produces = ['application/json'];
@@ -368,24 +389,32 @@ class BasicRaidExperimentalApi {
             localVarHeaderParams.Accept = produces.join(',');
         }
         let localVarFormParams = {};
-        // verify required parameter 'updateRaidoSchemaV1Request' is not null or undefined
-        if (updateRaidoSchemaV1Request === null || updateRaidoSchemaV1Request === undefined) {
-            throw new Error('Required parameter updateRaidoSchemaV1Request was null or undefined when calling upgradeLegacyToRaidoSchema.');
+        // verify required parameter 'prefix' is not null or undefined
+        if (prefix === null || prefix === undefined) {
+            throw new Error('Required parameter prefix was null or undefined when calling updateRaid.');
+        }
+        // verify required parameter 'suffix' is not null or undefined
+        if (suffix === null || suffix === undefined) {
+            throw new Error('Required parameter suffix was null or undefined when calling updateRaid.');
+        }
+        // verify required parameter 'raidUpdateRequest' is not null or undefined
+        if (raidUpdateRequest === null || raidUpdateRequest === undefined) {
+            throw new Error('Required parameter raidUpdateRequest was null or undefined when calling updateRaid.');
         }
         Object.assign(localVarHeaderParams, options.headers);
         let localVarUseFormData = false;
         let localVarRequestOptions = {
-            method: 'POST',
+            method: 'PUT',
             qs: localVarQueryParameters,
             headers: localVarHeaderParams,
             uri: localVarPath,
             useQuerystring: this._useQuerystring,
             json: true,
-            body: models_1.ObjectSerializer.serialize(updateRaidoSchemaV1Request, "UpdateRaidoSchemaV1Request")
+            body: models_1.ObjectSerializer.serialize(raidUpdateRequest, "RaidUpdateRequest")
         };
         let authenticationPromise = Promise.resolve();
-        if (this.authentications.BearerAuth.accessToken) {
-            authenticationPromise = authenticationPromise.then(() => this.authentications.BearerAuth.applyToRequest(localVarRequestOptions));
+        if (this.authentications.bearerAuth.accessToken) {
+            authenticationPromise = authenticationPromise.then(() => this.authentications.bearerAuth.applyToRequest(localVarRequestOptions));
         }
         authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
         let interceptorPromise = authenticationPromise;
@@ -408,7 +437,7 @@ class BasicRaidExperimentalApi {
                     }
                     else {
                         if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
-                            body = models_1.ObjectSerializer.deserialize(body, "MintResponse");
+                            body = models_1.ObjectSerializer.deserialize(body, "RaidDto");
                             resolve({ response: response, body: body });
                         }
                         else {
@@ -420,4 +449,4 @@ class BasicRaidExperimentalApi {
         });
     }
 }
-exports.BasicRaidExperimentalApi = BasicRaidExperimentalApi;
+exports.RaidApi = RaidApi;