@teemill/pickfaces 0.1.1

package/src/apis/PickfacesApi.ts

@@ -0,0 +1,304 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Pickfaces API
+ * Manage Teemill Pickfaces  Currently this API is in development and is not yet publicly accessible. All paths and models are subject to change.  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
+ *
+ * The version of the OpenAPI document: 0.1.1
+ * Contact: hello@teemill.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  CreatePickfaceRequest,
+  GetPickfaces200Response,
+  Pickface,
+  UpdatePickfaceRequest,
+} from '../models/index';
+import {
+    CreatePickfaceRequestFromJSON,
+    CreatePickfaceRequestToJSON,
+    GetPickfaces200ResponseFromJSON,
+    GetPickfaces200ResponseToJSON,
+    PickfaceFromJSON,
+    PickfaceToJSON,
+    UpdatePickfaceRequestFromJSON,
+    UpdatePickfaceRequestToJSON,
+} from '../models/index';
+
+export interface CreatePickfaceOperationRequest {
+    project: string;
+    createPickfaceRequest: CreatePickfaceRequest;
+}
+
+export interface DeletePickfaceRequest {
+    project: string;
+    pickfaceId: string;
+}
+
+export interface GetPickfaceRequest {
+    project: string;
+    pickfaceId: string;
+}
+
+export interface GetPickfacesRequest {
+    project: string;
+    search?: string;
+    pageToken?: number;
+    pageSize?: number;
+}
+
+export interface UpdatePickfaceOperationRequest {
+    project: string;
+    pickfaceId: string;
+    updatePickfaceRequest: UpdatePickfaceRequest;
+}
+
+/**
+ * 
+ */
+export class PickfacesApi extends runtime.BaseAPI {
+
+    /**
+     * Create a Pickface
+     * Create Pickface
+     */
+    async createPickfaceRaw(requestParameters: CreatePickfaceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Pickface>> {
+        if (requestParameters.project === null || requestParameters.project === undefined) {
+            throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling createPickface.');
+        }
+
+        if (requestParameters.createPickfaceRequest === null || requestParameters.createPickfaceRequest === undefined) {
+            throw new runtime.RequiredError('createPickfaceRequest','Required parameter requestParameters.createPickfaceRequest was null or undefined when calling createPickface.');
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters.project !== undefined) {
+            queryParameters['project'] = requestParameters.project;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/pickfaces`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreatePickfaceRequestToJSON(requestParameters.createPickfaceRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PickfaceFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a Pickface
+     * Create Pickface
+     */
+    async createPickface(requestParameters: CreatePickfaceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Pickface> {
+        const response = await this.createPickfaceRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Delete a Pickface
+     * Delete Pickface
+     */
+    async deletePickfaceRaw(requestParameters: DeletePickfaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.project === null || requestParameters.project === undefined) {
+            throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling deletePickface.');
+        }
+
+        if (requestParameters.pickfaceId === null || requestParameters.pickfaceId === undefined) {
+            throw new runtime.RequiredError('pickfaceId','Required parameter requestParameters.pickfaceId was null or undefined when calling deletePickface.');
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters.project !== undefined) {
+            queryParameters['project'] = requestParameters.project;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/pickfaces/{pickfaceId}`.replace(`{${"pickfaceId"}}`, encodeURIComponent(String(requestParameters.pickfaceId))),
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete a Pickface
+     * Delete Pickface
+     */
+    async deletePickface(requestParameters: DeletePickfaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deletePickfaceRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Get a pickface
+     * Get pickface
+     */
+    async getPickfaceRaw(requestParameters: GetPickfaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Pickface>> {
+        if (requestParameters.project === null || requestParameters.project === undefined) {
+            throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling getPickface.');
+        }
+
+        if (requestParameters.pickfaceId === null || requestParameters.pickfaceId === undefined) {
+            throw new runtime.RequiredError('pickfaceId','Required parameter requestParameters.pickfaceId was null or undefined when calling getPickface.');
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters.project !== undefined) {
+            queryParameters['project'] = requestParameters.project;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/pickfaces/{pickfaceId}`.replace(`{${"pickfaceId"}}`, encodeURIComponent(String(requestParameters.pickfaceId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PickfaceFromJSON(jsonValue));
+    }
+
+    /**
+     * Get a pickface
+     * Get pickface
+     */
+    async getPickface(requestParameters: GetPickfaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Pickface> {
+        const response = await this.getPickfaceRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Lists all pickfaces available paginated into chunks
+     * List pickfaces
+     */
+    async getPickfacesRaw(requestParameters: GetPickfacesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPickfaces200Response>> {
+        if (requestParameters.project === null || requestParameters.project === undefined) {
+            throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling getPickfaces.');
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters.project !== undefined) {
+            queryParameters['project'] = requestParameters.project;
+        }
+
+        if (requestParameters.search !== undefined) {
+            queryParameters['search'] = requestParameters.search;
+        }
+
+        if (requestParameters.pageToken !== undefined) {
+            queryParameters['pageToken'] = requestParameters.pageToken;
+        }
+
+        if (requestParameters.pageSize !== undefined) {
+            queryParameters['pageSize'] = requestParameters.pageSize;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/pickfaces`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetPickfaces200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Lists all pickfaces available paginated into chunks
+     * List pickfaces
+     */
+    async getPickfaces(requestParameters: GetPickfacesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPickfaces200Response> {
+        const response = await this.getPickfacesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Update a Pickface
+     * Update Pickface
+     */
+    async updatePickfaceRaw(requestParameters: UpdatePickfaceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Pickface>> {
+        if (requestParameters.project === null || requestParameters.project === undefined) {
+            throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling updatePickface.');
+        }
+
+        if (requestParameters.pickfaceId === null || requestParameters.pickfaceId === undefined) {
+            throw new runtime.RequiredError('pickfaceId','Required parameter requestParameters.pickfaceId was null or undefined when calling updatePickface.');
+        }
+
+        if (requestParameters.updatePickfaceRequest === null || requestParameters.updatePickfaceRequest === undefined) {
+            throw new runtime.RequiredError('updatePickfaceRequest','Required parameter requestParameters.updatePickfaceRequest was null or undefined when calling updatePickface.');
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters.project !== undefined) {
+            queryParameters['project'] = requestParameters.project;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/pickfaces/{pickfaceId}`.replace(`{${"pickfaceId"}}`, encodeURIComponent(String(requestParameters.pickfaceId))),
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: UpdatePickfaceRequestToJSON(requestParameters.updatePickfaceRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PickfaceFromJSON(jsonValue));
+    }
+
+    /**
+     * Update a Pickface
+     * Update Pickface
+     */
+    async updatePickface(requestParameters: UpdatePickfaceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Pickface> {
+        const response = await this.updatePickfaceRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -0,0 +1,3 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './PickfacesApi';

package/src/index.ts

@@ -0,0 +1,5 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './runtime';
+export * from './apis/index';
+export * from './models/index';

package/src/models/CreatePickfaceRequest.ts

@@ -0,0 +1,80 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Pickfaces API
+ * Manage Teemill Pickfaces  Currently this API is in development and is not yet publicly accessible. All paths and models are subject to change.  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
+ *
+ * The version of the OpenAPI document: 0.1.1
+ * Contact: hello@teemill.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import type { CreatePickfaceRequestDimensions } from './CreatePickfaceRequestDimensions';
+import {
+    CreatePickfaceRequestDimensionsFromJSON,
+    CreatePickfaceRequestDimensionsFromJSONTyped,
+    CreatePickfaceRequestDimensionsToJSON,
+} from './CreatePickfaceRequestDimensions';
+
+/**
+ * 
+ * @export
+ * @interface CreatePickfaceRequest
+ */
+export interface CreatePickfaceRequest {
+    /**
+     * The location of the pickface
+     * @type {string}
+     * @memberof CreatePickfaceRequest
+     */
+    location?: string;
+    /**
+     * 
+     * @type {CreatePickfaceRequestDimensions}
+     * @memberof CreatePickfaceRequest
+     */
+    dimensions?: CreatePickfaceRequestDimensions;
+}
+
+/**
+ * Check if a given object implements the CreatePickfaceRequest interface.
+ */
+export function instanceOfCreatePickfaceRequest(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function CreatePickfaceRequestFromJSON(json: any): CreatePickfaceRequest {
+    return CreatePickfaceRequestFromJSONTyped(json, false);
+}
+
+export function CreatePickfaceRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreatePickfaceRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'location': !exists(json, 'location') ? undefined : json['location'],
+        'dimensions': !exists(json, 'dimensions') ? undefined : CreatePickfaceRequestDimensionsFromJSON(json['dimensions']),
+    };
+}
+
+export function CreatePickfaceRequestToJSON(value?: CreatePickfaceRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'location': value.location,
+        'dimensions': CreatePickfaceRequestDimensionsToJSON(value.dimensions),
+    };
+}
+

package/src/models/CreatePickfaceRequestDimensions.ts

@@ -0,0 +1,81 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Pickfaces API
+ * Manage Teemill Pickfaces  Currently this API is in development and is not yet publicly accessible. All paths and models are subject to change.  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
+ *
+ * The version of the OpenAPI document: 0.1.1
+ * Contact: hello@teemill.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface CreatePickfaceRequestDimensions
+ */
+export interface CreatePickfaceRequestDimensions {
+    /**
+     * The width of the pickface in millimetres
+     * @type {number}
+     * @memberof CreatePickfaceRequestDimensions
+     */
+    width?: number;
+    /**
+     * The depth of the pickface in millimetres
+     * @type {number}
+     * @memberof CreatePickfaceRequestDimensions
+     */
+    depth?: number;
+    /**
+     * The height of the pickface in millimetres
+     * @type {number}
+     * @memberof CreatePickfaceRequestDimensions
+     */
+    height?: number;
+}
+
+/**
+ * Check if a given object implements the CreatePickfaceRequestDimensions interface.
+ */
+export function instanceOfCreatePickfaceRequestDimensions(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function CreatePickfaceRequestDimensionsFromJSON(json: any): CreatePickfaceRequestDimensions {
+    return CreatePickfaceRequestDimensionsFromJSONTyped(json, false);
+}
+
+export function CreatePickfaceRequestDimensionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreatePickfaceRequestDimensions {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'width': !exists(json, 'width') ? undefined : json['width'],
+        'depth': !exists(json, 'depth') ? undefined : json['depth'],
+        'height': !exists(json, 'height') ? undefined : json['height'],
+    };
+}
+
+export function CreatePickfaceRequestDimensionsToJSON(value?: CreatePickfaceRequestDimensions | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'width': value.width,
+        'depth': value.depth,
+        'height': value.height,
+    };
+}
+

package/src/models/GetPickfaces200Response.ts

@@ -0,0 +1,80 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Pickfaces API
+ * Manage Teemill Pickfaces  Currently this API is in development and is not yet publicly accessible. All paths and models are subject to change.  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
+ *
+ * The version of the OpenAPI document: 0.1.1
+ * Contact: hello@teemill.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import type { Pickface } from './Pickface';
+import {
+    PickfaceFromJSON,
+    PickfaceFromJSONTyped,
+    PickfaceToJSON,
+} from './Pickface';
+
+/**
+ * 
+ * @export
+ * @interface GetPickfaces200Response
+ */
+export interface GetPickfaces200Response {
+    /**
+     * 
+     * @type {Array<Pickface>}
+     * @memberof GetPickfaces200Response
+     */
+    pickfaces?: Array<Pickface>;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetPickfaces200Response
+     */
+    nextPageToken?: number;
+}
+
+/**
+ * Check if a given object implements the GetPickfaces200Response interface.
+ */
+export function instanceOfGetPickfaces200Response(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function GetPickfaces200ResponseFromJSON(json: any): GetPickfaces200Response {
+    return GetPickfaces200ResponseFromJSONTyped(json, false);
+}
+
+export function GetPickfaces200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPickfaces200Response {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'pickfaces': !exists(json, 'pickfaces') ? undefined : ((json['pickfaces'] as Array<any>).map(PickfaceFromJSON)),
+        'nextPageToken': !exists(json, 'nextPageToken') ? undefined : json['nextPageToken'],
+    };
+}
+
+export function GetPickfaces200ResponseToJSON(value?: GetPickfaces200Response | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'pickfaces': value.pickfaces === undefined ? undefined : ((value.pickfaces as Array<any>).map(PickfaceToJSON)),
+        'nextPageToken': value.nextPageToken,
+    };
+}
+

package/src/models/ModelError.ts

@@ -0,0 +1,74 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Pickfaces API
+ * Manage Teemill Pickfaces  Currently this API is in development and is not yet publicly accessible. All paths and models are subject to change.  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
+ *
+ * The version of the OpenAPI document: 0.1.1
+ * Contact: hello@teemill.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ModelError
+ */
+export interface ModelError {
+    /**
+     * 
+     * @type {string}
+     * @memberof ModelError
+     */
+    code?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ModelError
+     */
+    message: string;
+}
+
+/**
+ * Check if a given object implements the ModelError interface.
+ */
+export function instanceOfModelError(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "message" in value;
+
+    return isInstance;
+}
+
+export function ModelErrorFromJSON(json: any): ModelError {
+    return ModelErrorFromJSONTyped(json, false);
+}
+
+export function ModelErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelError {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'code': !exists(json, 'code') ? undefined : json['code'],
+        'message': json['message'],
+    };
+}
+
+export function ModelErrorToJSON(value?: ModelError | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'code': value.code,
+        'message': value.message,
+    };
+}
+