yellowgrid-api-ts 3.2.285 → 3.2.286

package/.openapi-generator/FILES

@@ -282,6 +282,7 @@ docs/ScannedItemModel.md
 docs/ScopeModel.md
 docs/Sdr.md
 docs/SdrReferenceType.md
+docs/SearchSchoolModel.md
 docs/SerialNumberRequestModel.md
 docs/SeriesDTO.md
 docs/Service.md

package/README.md

@@ -242,6 +242,7 @@ Class | Method | HTTP request | Description
 *Class3CXIntegrationsApi* | [**getGetPrice**](docs/Class3CXIntegrationsApi.md#getgetprice) | **GET** /tcx/integrations/edtechpro/prices | 
 *Class3CXIntegrationsApi* | [**getGetSchools**](docs/Class3CXIntegrationsApi.md#getgetschools) | **GET** /tcx/integrations/edtechpro/schools | 
 *Class3CXIntegrationsApi* | [**getGetTrusts**](docs/Class3CXIntegrationsApi.md#getgettrusts) | **GET** /tcx/integrations/edtechpro/trusts | 
+*Class3CXIntegrationsApi* | [**getSearchSchools**](docs/Class3CXIntegrationsApi.md#getsearchschools) | **GET** /tcx/integrations/edtechpro/search/schools | 
 *Class3CXIntegrationsApi* | [**patchUpdateEtpOrderReference**](docs/Class3CXIntegrationsApi.md#patchupdateetporderreference) | **PATCH** /tcx/integrations/edtechpro/{clientId}/schools/{schoolId}/orderReference | 
 *Class3CXIntegrationsApi* | [**postOrderEdTechPro**](docs/Class3CXIntegrationsApi.md#postorderedtechpro) | **POST** /tcx/integrations/edtechpro/orders | 
 *Class3CXIntegrationsApi* | [**postUpgradeEdTechPro**](docs/Class3CXIntegrationsApi.md#postupgradeedtechpro) | **POST** /tcx/integrations/edtechpro/upgrades | 
@@ -696,6 +697,7 @@ Class | Method | HTTP request | Description
  - [ScopeModel](docs/ScopeModel.md)
  - [Sdr](docs/Sdr.md)
  - [SdrReferenceType](docs/SdrReferenceType.md)
+ - [SearchSchoolModel](docs/SearchSchoolModel.md)
  - [SerialNumberRequestModel](docs/SerialNumberRequestModel.md)
  - [SeriesDTO](docs/SeriesDTO.md)
  - [Service](docs/Service.md)

package/api.ts

@@ -7411,6 +7411,43 @@ export const SdrReferenceType = {
 export type SdrReferenceType = typeof SdrReferenceType[keyof typeof SdrReferenceType];
 
 
+/**
+ * EdTechPro School Information
+ */
+export interface SearchSchoolModel {
+    /**
+     * School ID
+     */
+    'id': number;
+    /**
+     * URN Number
+     */
+    'urn': string;
+    /**
+     * DFE Code
+     */
+    'dfe': string;
+    /**
+     * School Name
+     */
+    'name': string;
+    /**
+     * Phase of Education
+     */
+    'phaseOfEducation': string;
+    /**
+     * Text Display
+     */
+    'text': string;
+    /**
+     * MIS
+     */
+    'mis': string;
+    /**
+     * Address
+     */
+    'address': string;
+}
 /**
  * Serial Number Request
  */
@@ -24600,6 +24637,42 @@ export const Class3CXIntegrationsApiAxiosParamCreator = function (configuration?
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Seach EdTechPro Schools
+         * @param {string} search School Name, Dfe code or URN
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSearchSchools: async (search: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'search' is not null or undefined
+            assertParamExists('getSearchSchools', 'search', search)
+            const localVarPath = `/tcx/integrations/edtechpro/search/schools`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Update EdTechPro School Order Reference
          * @param {number} clientId ETP Client ID
@@ -24754,6 +24827,18 @@ export const Class3CXIntegrationsApiFp = function(configuration?: Configuration)
             const localVarOperationServerBasePath = operationServerMap['Class3CXIntegrationsApi.getGetTrusts']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Seach EdTechPro Schools
+         * @param {string} search School Name, Dfe code or URN
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getSearchSchools(search: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SearchSchoolModel>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getSearchSchools(search, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['Class3CXIntegrationsApi.getSearchSchools']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Update EdTechPro School Order Reference
          * @param {number} clientId ETP Client ID
@@ -24830,6 +24915,15 @@ export const Class3CXIntegrationsApiFactory = function (configuration?: Configur
         getGetTrusts(options?: RawAxiosRequestConfig): AxiosPromise<Array<EdTechProClientEntity>> {
             return localVarFp.getGetTrusts(options).then((request) => request(axios, basePath));
         },
+        /**
+         * Seach EdTechPro Schools
+         * @param {string} search School Name, Dfe code or URN
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSearchSchools(search: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<SearchSchoolModel>> {
+            return localVarFp.getSearchSchools(search, options).then((request) => request(axios, basePath));
+        },
         /**
          * Update EdTechPro School Order Reference
          * @param {number} clientId ETP Client ID
@@ -24898,6 +24992,16 @@ export class Class3CXIntegrationsApi extends BaseAPI {
         return Class3CXIntegrationsApiFp(this.configuration).getGetTrusts(options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Seach EdTechPro Schools
+     * @param {string} search School Name, Dfe code or URN
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getSearchSchools(search: string, options?: RawAxiosRequestConfig) {
+        return Class3CXIntegrationsApiFp(this.configuration).getSearchSchools(search, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Update EdTechPro School Order Reference
      * @param {number} clientId ETP Client ID

package/dist/api.d.ts

@@ -7282,6 +7282,43 @@ export declare const SdrReferenceType: {
     readonly Crm: "CRM";
 };
 export type SdrReferenceType = typeof SdrReferenceType[keyof typeof SdrReferenceType];
+/**
+ * EdTechPro School Information
+ */
+export interface SearchSchoolModel {
+    /**
+     * School ID
+     */
+    'id': number;
+    /**
+     * URN Number
+     */
+    'urn': string;
+    /**
+     * DFE Code
+     */
+    'dfe': string;
+    /**
+     * School Name
+     */
+    'name': string;
+    /**
+     * Phase of Education
+     */
+    'phaseOfEducation': string;
+    /**
+     * Text Display
+     */
+    'text': string;
+    /**
+     * MIS
+     */
+    'mis': string;
+    /**
+     * Address
+     */
+    'address': string;
+}
 /**
  * Serial Number Request
  */
@@ -17085,6 +17122,13 @@ export declare const Class3CXIntegrationsApiAxiosParamCreator: (configuration?:
      * @throws {RequiredError}
      */
     getGetTrusts: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Seach EdTechPro Schools
+     * @param {string} search School Name, Dfe code or URN
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSearchSchools: (search: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Update EdTechPro School Order Reference
      * @param {number} clientId ETP Client ID
@@ -17136,6 +17180,13 @@ export declare const Class3CXIntegrationsApiFp: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     getGetTrusts(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EdTechProClientEntity>>>;
+    /**
+     * Seach EdTechPro Schools
+     * @param {string} search School Name, Dfe code or URN
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSearchSchools(search: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SearchSchoolModel>>>;
     /**
      * Update EdTechPro School Order Reference
      * @param {number} clientId ETP Client ID
@@ -17187,6 +17238,13 @@ export declare const Class3CXIntegrationsApiFactory: (configuration?: Configurat
      * @throws {RequiredError}
      */
     getGetTrusts(options?: RawAxiosRequestConfig): AxiosPromise<Array<EdTechProClientEntity>>;
+    /**
+     * Seach EdTechPro Schools
+     * @param {string} search School Name, Dfe code or URN
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSearchSchools(search: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<SearchSchoolModel>>;
     /**
      * Update EdTechPro School Order Reference
      * @param {number} clientId ETP Client ID
@@ -17238,6 +17296,13 @@ export declare class Class3CXIntegrationsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getGetTrusts(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EdTechProClientEntity[], any, {}>>;
+    /**
+     * Seach EdTechPro Schools
+     * @param {string} search School Name, Dfe code or URN
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSearchSchools(search: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchSchoolModel[], any, {}>>;
     /**
      * Update EdTechPro School Order Reference
      * @param {number} clientId ETP Client ID

package/dist/api.js

@@ -16729,6 +16729,45 @@ var Class3CXIntegrationsApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         * Seach EdTechPro Schools
+         * @param {string} search School Name, Dfe code or URN
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSearchSchools: function (search_1) {
+            var args_1 = [];
+            for (var _i = 1; _i < arguments.length; _i++) {
+                args_1[_i - 1] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([search_1], args_1, true), void 0, function (search, options) {
+                var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                if (options === void 0) { options = {}; }
+                return __generator(this, function (_a) {
+                    // verify required parameter 'search' is not null or undefined
+                    (0, common_1.assertParamExists)('getSearchSchools', 'search', search);
+                    localVarPath = "/tcx/integrations/edtechpro/search/schools";
+                    localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                    if (configuration) {
+                        baseOptions = configuration.baseOptions;
+                    }
+                    localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
+                    localVarHeaderParameter = {};
+                    localVarQueryParameter = {};
+                    if (search !== undefined) {
+                        localVarQueryParameter['search'] = search;
+                    }
+                    localVarHeaderParameter['Accept'] = 'application/json';
+                    (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+                    headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                    localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                    return [2 /*return*/, {
+                            url: (0, common_1.toPathString)(localVarUrlObj),
+                            options: localVarRequestOptions,
+                        }];
+                });
+            });
+        },
         /**
          * Update EdTechPro School Order Reference
          * @param {number} clientId ETP Client ID
@@ -16924,6 +16963,28 @@ var Class3CXIntegrationsApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         * Seach EdTechPro Schools
+         * @param {string} search School Name, Dfe code or URN
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSearchSchools: function (search, options) {
+            return __awaiter(this, void 0, void 0, function () {
+                var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
+                var _a, _b, _c;
+                return __generator(this, function (_d) {
+                    switch (_d.label) {
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSearchSchools(search, options)];
+                        case 1:
+                            localVarAxiosArgs = _d.sent();
+                            localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                            localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['Class3CXIntegrationsApi.getSearchSchools']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                            return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
+                    }
+                });
+            });
+        },
         /**
          * Update EdTechPro School Order Reference
          * @param {number} clientId ETP Client ID
@@ -17030,6 +17091,15 @@ var Class3CXIntegrationsApiFactory = function (configuration, basePath, axios) {
         getGetTrusts: function (options) {
             return localVarFp.getGetTrusts(options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * Seach EdTechPro Schools
+         * @param {string} search School Name, Dfe code or URN
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSearchSchools: function (search, options) {
+            return localVarFp.getSearchSchools(search, options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Update EdTechPro School Order Reference
          * @param {number} clientId ETP Client ID
@@ -17102,6 +17172,16 @@ var Class3CXIntegrationsApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.Class3CXIntegrationsApiFp)(this.configuration).getGetTrusts(options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     * Seach EdTechPro Schools
+     * @param {string} search School Name, Dfe code or URN
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    Class3CXIntegrationsApi.prototype.getSearchSchools = function (search, options) {
+        var _this = this;
+        return (0, exports.Class3CXIntegrationsApiFp)(this.configuration).getSearchSchools(search, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Update EdTechPro School Order Reference
      * @param {number} clientId ETP Client ID

package/docs/Class3CXIntegrationsApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *https://bitbucket.org*
 |[**getGetPrice**](#getgetprice) | **GET** /tcx/integrations/edtechpro/prices | |
 |[**getGetSchools**](#getgetschools) | **GET** /tcx/integrations/edtechpro/schools | |
 |[**getGetTrusts**](#getgettrusts) | **GET** /tcx/integrations/edtechpro/trusts | |
+|[**getSearchSchools**](#getsearchschools) | **GET** /tcx/integrations/edtechpro/search/schools | |
 |[**patchUpdateEtpOrderReference**](#patchupdateetporderreference) | **PATCH** /tcx/integrations/edtechpro/{clientId}/schools/{schoolId}/orderReference | |
 |[**postOrderEdTechPro**](#postorderedtechpro) | **POST** /tcx/integrations/edtechpro/orders | |
 |[**postUpgradeEdTechPro**](#postupgradeedtechpro) | **POST** /tcx/integrations/edtechpro/upgrades | |
@@ -172,6 +173,57 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **getSearchSchools**
+> Array<SearchSchoolModel> getSearchSchools()
+
+Seach EdTechPro Schools
+
+### Example
+
+```typescript
+import {
+    Class3CXIntegrationsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXIntegrationsApi(configuration);
+
+let search: string; //School Name, Dfe code or URN (default to undefined)
+
+const { status, data } = await apiInstance.getSearchSchools(
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **search** | [**string**] | School Name, Dfe code or URN | defaults to undefined|
+
+
+### Return type
+
+**Array<SearchSchoolModel>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | EdTechPro Schools |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **patchUpdateEtpOrderReference**
 > patchUpdateEtpOrderReference()
 

package/docs/SearchSchoolModel.md

@@ -0,0 +1,35 @@
+# SearchSchoolModel
+
+EdTechPro School Information
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | School ID | [default to undefined]
+**urn** | **string** | URN Number | [default to undefined]
+**dfe** | **string** | DFE Code | [default to undefined]
+**name** | **string** | School Name | [default to undefined]
+**phaseOfEducation** | **string** | Phase of Education | [default to undefined]
+**text** | **string** | Text Display | [default to undefined]
+**mis** | **string** | MIS | [default to undefined]
+**address** | **string** | Address | [default to undefined]
+
+## Example
+
+```typescript
+import { SearchSchoolModel } from 'yellowgrid-api-ts';
+
+const instance: SearchSchoolModel = {
+    id,
+    urn,
+    dfe,
+    name,
+    phaseOfEducation,
+    text,
+    mis,
+    address,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.2.285",
+  "version": "3.2.286",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {