@teemill/gfn-catalog 0.1.0

package/src/apis/VariantsApi.ts

@@ -0,0 +1,176 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * GFN Catalog API
+ * Manage Teemill GFN Products  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 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 {
+  ApiError,
+  Variant,
+  VariantsResponse,
+} from '../models/index';
+import {
+    ApiErrorFromJSON,
+    ApiErrorToJSON,
+    VariantFromJSON,
+    VariantToJSON,
+    VariantsResponseFromJSON,
+    VariantsResponseToJSON,
+} from '../models/index';
+
+export interface GetVariantRequest {
+    project: string;
+    variantId: string;
+    fields?: string;
+}
+
+export interface ListVariantsRequest {
+    project: string;
+    fields?: string;
+    search?: string;
+}
+
+/**
+ * 
+ */
+export class VariantsApi extends runtime.BaseAPI {
+
+    /**
+     * Gets a GFN variant by the given id
+     * Get a GFN variant
+     */
+    async getVariantRaw(requestParameters: GetVariantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Variant>> {
+        if (requestParameters.project === null || requestParameters.project === undefined) {
+            throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling getVariant.');
+        }
+
+        if (requestParameters.variantId === null || requestParameters.variantId === undefined) {
+            throw new runtime.RequiredError('variantId','Required parameter requestParameters.variantId was null or undefined when calling getVariant.');
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters.project !== undefined) {
+            queryParameters['project'] = requestParameters.project;
+        }
+
+        if (requestParameters.fields !== undefined) {
+            queryParameters['fields'] = requestParameters.fields;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/gfn/catalog/variants/{variantId}`.replace(`{${"variantId"}}`, encodeURIComponent(String(requestParameters.variantId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => VariantFromJSON(jsonValue));
+    }
+
+    /**
+     * Gets a GFN variant by the given id
+     * Get a GFN variant
+     */
+    async getVariant(
+        project: string, variantId: string, 
+        optionalParameters: runtime.OptionalOnly<GetVariantRequest> = {},
+        initOverrides?: RequestInit | runtime.InitOverrideFunction
+    ): Promise<Variant> {
+        const response = await this.getVariantRaw(
+            {
+                project: project,variantId: variantId,
+                ...optionalParameters,
+            },
+            initOverrides
+        );
+
+        return await response.value();
+    }
+
+    /**
+     * Lists GFN variants
+     * List GFN variants
+     */
+    async listVariantsRaw(requestParameters: ListVariantsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VariantsResponse>> {
+        if (requestParameters.project === null || requestParameters.project === undefined) {
+            throw new runtime.RequiredError('project','Required parameter requestParameters.project was null or undefined when calling listVariants.');
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters.project !== undefined) {
+            queryParameters['project'] = requestParameters.project;
+        }
+
+        if (requestParameters.fields !== undefined) {
+            queryParameters['fields'] = requestParameters.fields;
+        }
+
+        if (requestParameters.search !== undefined) {
+            queryParameters['search'] = requestParameters.search;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("session-oauth", []);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // api-key authentication
+        }
+
+        const response = await this.request({
+            path: `/v1/gfn/catalog/variants`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => VariantsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Lists GFN variants
+     * List GFN variants
+     */
+    async listVariants(
+        project: string, 
+        optionalParameters: runtime.OptionalOnly<ListVariantsRequest> = {},
+        initOverrides?: RequestInit | runtime.InitOverrideFunction
+    ): Promise<VariantsResponse> {
+        const response = await this.listVariantsRaw(
+            {
+                project: project,
+                ...optionalParameters,
+            },
+            initOverrides
+        );
+
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -0,0 +1,4 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './ProductsApi';
+export * from './VariantsApi';

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/ApiError.ts

@@ -0,0 +1,74 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * GFN Catalog API
+ * Manage Teemill GFN Products  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 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 ApiError
+ */
+export interface ApiError {
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiError
+     */
+    code?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ApiError
+     */
+    message: string;
+}
+
+/**
+ * Check if a given object implements the ApiError interface.
+ */
+export function instanceOfApiError(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "message" in value;
+
+    return isInstance;
+}
+
+export function ApiErrorFromJSON(json: any): ApiError {
+    return ApiErrorFromJSONTyped(json, false);
+}
+
+export function ApiErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiError {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'code': !exists(json, 'code') ? undefined : json['code'],
+        'message': json['message'],
+    };
+}
+
+export function ApiErrorToJSON(value?: ApiError | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'code': value.code,
+        'message': value.message,
+    };
+}
+

package/src/models/Attribute.ts

@@ -0,0 +1,98 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * GFN Catalog API
+ * Manage Teemill GFN Products  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 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 { AttributeThumbnail } from './AttributeThumbnail';
+import {
+    AttributeThumbnailFromJSON,
+    AttributeThumbnailFromJSONTyped,
+    AttributeThumbnailToJSON,
+} from './AttributeThumbnail';
+
+/**
+ * 
+ * @export
+ * @interface Attribute
+ */
+export interface Attribute {
+    /**
+     * Attribute name
+     * @type {string}
+     * @memberof Attribute
+     */
+    name: string;
+    /**
+     * Attribute value
+     * @type {string}
+     * @memberof Attribute
+     */
+    value: string;
+    /**
+     * 
+     * @type {AttributeThumbnail}
+     * @memberof Attribute
+     */
+    thumbnail?: AttributeThumbnail;
+    /**
+     * Attribute tags
+     * @type {Array<string>}
+     * @memberof Attribute
+     */
+    tags?: Array<string>;
+}
+
+/**
+ * Check if a given object implements the Attribute interface.
+ */
+export function instanceOfAttribute(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "value" in value;
+
+    return isInstance;
+}
+
+export function AttributeFromJSON(json: any): Attribute {
+    return AttributeFromJSONTyped(json, false);
+}
+
+export function AttributeFromJSONTyped(json: any, ignoreDiscriminator: boolean): Attribute {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'value': json['value'],
+        'thumbnail': !exists(json, 'thumbnail') ? undefined : AttributeThumbnailFromJSON(json['thumbnail']),
+        'tags': !exists(json, 'tags') ? undefined : json['tags'],
+    };
+}
+
+export function AttributeToJSON(value?: Attribute | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'name': value.name,
+        'value': value.value,
+        'thumbnail': AttributeThumbnailToJSON(value.thumbnail),
+        'tags': value.tags,
+    };
+}
+

package/src/models/AttributeThumbnail.ts

@@ -0,0 +1,85 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * GFN Catalog API
+ * Manage Teemill GFN Products  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 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';
+/**
+ * Attribute thumbnail
+ * @export
+ * @interface AttributeThumbnail
+ */
+export interface AttributeThumbnail {
+    /**
+     * 
+     * @type {string}
+     * @memberof AttributeThumbnail
+     */
+    type?: AttributeThumbnailTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof AttributeThumbnail
+     */
+    value?: string;
+}
+
+
+/**
+ * @export
+ */
+export const AttributeThumbnailTypeEnum = {
+    Text: 'text',
+    Color: 'color',
+    Image: 'image'
+} as const;
+export type AttributeThumbnailTypeEnum = typeof AttributeThumbnailTypeEnum[keyof typeof AttributeThumbnailTypeEnum];
+
+
+/**
+ * Check if a given object implements the AttributeThumbnail interface.
+ */
+export function instanceOfAttributeThumbnail(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function AttributeThumbnailFromJSON(json: any): AttributeThumbnail {
+    return AttributeThumbnailFromJSONTyped(json, false);
+}
+
+export function AttributeThumbnailFromJSONTyped(json: any, ignoreDiscriminator: boolean): AttributeThumbnail {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'type': !exists(json, 'type') ? undefined : json['type'],
+        'value': !exists(json, 'value') ? undefined : json['value'],
+    };
+}
+
+export function AttributeThumbnailToJSON(value?: AttributeThumbnail | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'type': value.type,
+        'value': value.value,
+    };
+}
+

package/src/models/Image.ts

@@ -0,0 +1,113 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * GFN Catalog API
+ * Manage Teemill GFN Products  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 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';
+/**
+ * Image description
+ * @export
+ * @interface Image
+ */
+export interface Image {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof Image
+     */
+    id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Image
+     */
+    src?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Image
+     */
+    alt?: string;
+    /**
+     * List of variant Ids
+     * @type {Array<string>}
+     * @memberof Image
+     */
+    variantIds?: Array<string>;
+    /**
+     * 
+     * @type {number}
+     * @memberof Image
+     */
+    sortOrder?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof Image
+     */
+    createdAt?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Image
+     */
+    updatedAt?: string;
+}
+
+/**
+ * Check if a given object implements the Image interface.
+ */
+export function instanceOfImage(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function ImageFromJSON(json: any): Image {
+    return ImageFromJSONTyped(json, false);
+}
+
+export function ImageFromJSONTyped(json: any, ignoreDiscriminator: boolean): Image {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'id': !exists(json, 'id') ? undefined : json['id'],
+        'src': !exists(json, 'src') ? undefined : json['src'],
+        'alt': !exists(json, 'alt') ? undefined : json['alt'],
+        'variantIds': !exists(json, 'variantIds') ? undefined : json['variantIds'],
+        'sortOrder': !exists(json, 'sortOrder') ? undefined : json['sortOrder'],
+        'createdAt': !exists(json, 'createdAt') ? undefined : json['createdAt'],
+        'updatedAt': !exists(json, 'updatedAt') ? undefined : json['updatedAt'],
+    };
+}
+
+export function ImageToJSON(value?: Image | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'id': value.id,
+        'src': value.src,
+        'alt': value.alt,
+        'variantIds': value.variantIds,
+        'sortOrder': value.sortOrder,
+        'createdAt': value.createdAt,
+        'updatedAt': value.updatedAt,
+    };
+}
+

package/src/models/Product.ts

@@ -0,0 +1,105 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * GFN Catalog API
+ * Manage Teemill GFN Products  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 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 { Image } from './Image';
+import {
+    ImageFromJSON,
+    ImageFromJSONTyped,
+    ImageToJSON,
+} from './Image';
+
+/**
+ * 
+ * @export
+ * @interface Product
+ */
+export interface Product {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof Product
+     */
+    id?: string;
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof Product
+     */
+    ref?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Product
+     */
+    title: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Product
+     */
+    sku?: string;
+    /**
+     * Images
+     * @type {Array<Image>}
+     * @memberof Product
+     */
+    images?: Array<Image>;
+}
+
+/**
+ * Check if a given object implements the Product interface.
+ */
+export function instanceOfProduct(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "title" in value;
+
+    return isInstance;
+}
+
+export function ProductFromJSON(json: any): Product {
+    return ProductFromJSONTyped(json, false);
+}
+
+export function ProductFromJSONTyped(json: any, ignoreDiscriminator: boolean): Product {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'id': !exists(json, 'id') ? undefined : json['id'],
+        'ref': !exists(json, 'ref') ? undefined : json['ref'],
+        'title': json['title'],
+        'sku': !exists(json, 'sku') ? undefined : json['sku'],
+        'images': !exists(json, 'images') ? undefined : ((json['images'] as Array<any>).map(ImageFromJSON)),
+    };
+}
+
+export function ProductToJSON(value?: Product | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'id': value.id,
+        'ref': value.ref,
+        'title': value.title,
+        'sku': value.sku,
+        'images': value.images === undefined ? undefined : ((value.images as Array<any>).map(ImageToJSON)),
+    };
+}
+