@gewis/grooster-backend-ts 1.2.1 → 1.3.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gewis/grooster-backend-ts",
   "main": "./dist/index.js",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "types": "./dist/index.d.ts",
   "repository": {
     "url": "git+https://github.com/GEWIS/grooster-backend.git",

package/src/.openapi-generator/FILES

@@ -19,6 +19,7 @@ docs/RosterShiftApi.md
 docs/RosterShiftCreateRequest.md
 docs/RosterTemplate.md
 docs/RosterTemplateCreateRequest.md
+docs/RosterTemplateUpdateParams.md
 docs/RosterUpdateRequest.md
 docs/SavedShift.md
 docs/SavedShiftApi.md

package/src/api.ts

@@ -430,6 +430,25 @@ export interface RosterTemplateCreateRequest {
      */
     'shifts'?: Array<string>;
 }
+/**
+ * 
+ * @export
+ * @interface RosterTemplateUpdateParams
+ */
+export interface RosterTemplateUpdateParams {
+    /**
+     * 
+     * @type {string}
+     * @memberof RosterTemplateUpdateParams
+     */
+    'name'?: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof RosterTemplateUpdateParams
+     */
+    'shifts'?: Array<string>;
+}
 /**
  * 
  * @export
@@ -1134,6 +1153,47 @@ export const RosterApiAxiosParamCreator = function (configuration?: Configuratio
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
             localVarRequestOptions.data = serializeDataIfNeeded(updateParams, localVarRequestOptions, configuration)
 
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Updates a roster template by ID
+         * @param {number} id Template ID
+         * @param {RosterTemplateUpdateParams} [params] Update params
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateRosterTemplate: async (id: number, params?: RosterTemplateUpdateParams, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('updateRosterTemplate', 'id', id)
+            const localVarPath = `/roster/template/{id}`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // 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: 'PUT', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication BearerAuth required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(params, localVarRequestOptions, configuration)
+
             return {
                 url: toPathString(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -1169,7 +1229,7 @@ export const RosterApiFp = function(configuration?: Configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async createRosterTemplate(params?: RosterTemplateCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SavedShift>>> {
+        async createRosterTemplate(params?: RosterTemplateCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RosterTemplate>>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.createRosterTemplate(params, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['RosterApi.createRosterTemplate']?.[localVarOperationServerIndex]?.url;
@@ -1268,6 +1328,20 @@ export const RosterApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['RosterApi.updateRoster']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * 
+         * @summary Updates a roster template by ID
+         * @param {number} id Template ID
+         * @param {RosterTemplateUpdateParams} [params] Update params
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async updateRosterTemplate(id: number, params?: RosterTemplateUpdateParams, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RosterTemplate>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.updateRosterTemplate(id, params, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['RosterApi.updateRosterTemplate']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
     }
 };
 
@@ -1295,7 +1369,7 @@ export const RosterApiFactory = function (configuration?: Configuration, basePat
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createRosterTemplate(params?: RosterTemplateCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<SavedShift>> {
+        createRosterTemplate(params?: RosterTemplateCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<RosterTemplate>> {
             return localVarFp.createRosterTemplate(params, options).then((request) => request(axios, basePath));
         },
         /**
@@ -1370,6 +1444,17 @@ export const RosterApiFactory = function (configuration?: Configuration, basePat
         updateRoster(id: number, updateParams: RosterUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<Roster> {
             return localVarFp.updateRoster(id, updateParams, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 
+         * @summary Updates a roster template by ID
+         * @param {number} id Template ID
+         * @param {RosterTemplateUpdateParams} [params] Update params
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateRosterTemplate(id: number, params?: RosterTemplateUpdateParams, options?: RawAxiosRequestConfig): AxiosPromise<RosterTemplate> {
+            return localVarFp.updateRosterTemplate(id, params, options).then((request) => request(axios, basePath));
+        },
     };
 };
 
@@ -1489,6 +1574,19 @@ export class RosterApi extends BaseAPI {
     public updateRoster(id: number, updateParams: RosterUpdateRequest, options?: RawAxiosRequestConfig) {
         return RosterApiFp(this.configuration).updateRoster(id, updateParams, options).then((request) => request(this.axios, this.basePath));
     }
+
+    /**
+     * 
+     * @summary Updates a roster template by ID
+     * @param {number} id Template ID
+     * @param {RosterTemplateUpdateParams} [params] Update params
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RosterApi
+     */
+    public updateRosterTemplate(id: number, params?: RosterTemplateUpdateParams, options?: RawAxiosRequestConfig) {
+        return RosterApiFp(this.configuration).updateRosterTemplate(id, params, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 
 

package/src/docs/RosterApi.md

@@ -13,6 +13,7 @@ All URIs are relative to *http://localhost*
 |[**getRosterTemplates**](#getrostertemplates) | **GET** /roster/template | Get all rosters templates or query by organ ID|
 |[**getRosters**](#getrosters) | **GET** /roster | Get all rosters or query by date and organ|
 |[**updateRoster**](#updateroster) | **PATCH** /roster/{id} | Update a roster|
+|[**updateRosterTemplate**](#updaterostertemplate) | **PUT** /roster/template/{id} | Updates a roster template by ID|
 
 # **createRoster**
 > Roster createRoster(createParams)
@@ -67,7 +68,7 @@ const { status, data } = await apiInstance.createRoster(
 [[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)
 
 # **createRosterTemplate**
-> Array<SavedShift> createRosterTemplate()
+> Array<RosterTemplate> createRosterTemplate()
 
 
 ### Example
@@ -98,7 +99,7 @@ const { status, data } = await apiInstance.createRosterTemplate(
 
 ### Return type
 
-**Array<SavedShift>**
+**Array<RosterTemplate>**
 
 ### Authorization
 
@@ -486,3 +487,59 @@ const { status, data } = await apiInstance.updateRoster(
 
 [[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)
 
+# **updateRosterTemplate**
+> RosterTemplate updateRosterTemplate()
+
+
+### Example
+
+```typescript
+import {
+    RosterApi,
+    Configuration,
+    RosterTemplateUpdateParams
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new RosterApi(configuration);
+
+let id: number; //Template ID (default to undefined)
+let params: RosterTemplateUpdateParams; //Update params (optional)
+
+const { status, data } = await apiInstance.updateRosterTemplate(
+    id,
+    params
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **params** | **RosterTemplateUpdateParams**| Update params | |
+| **id** | [**number**] | Template ID | defaults to undefined|
+
+
+### Return type
+
+**RosterTemplate**
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**400** | Bad Request |  -  |
+|**404** | Not Found |  -  |
+
+[[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)
+

package/src/docs/RosterTemplateUpdateParams.md

@@ -0,0 +1,22 @@
+# RosterTemplateUpdateParams
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**shifts** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RosterTemplateUpdateParams } from './api';
+
+const instance: RosterTemplateUpdateParams = {
+    name,
+    shifts,
+};
+```
+
+[[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/src/index.ts

@@ -1,5 +1,5 @@
 /* tslint:disable */
-/* eslint-disable */
+ 
 /**
  * GRooster
  * A GEWIS Rooster maker