/* tslint:disable */ /* eslint-disable */ /** * Geins Management API * Geins Management API is a RESTful api that powers your applications and helps you manage your Geins services. Geins provides an easy-to-use and scalable solution for managing all aspects of an online store, from product listings and customer information to order processing and payment transactions. :::tip Tip With this API, you can build custom applications and integrate with third-party systems, feeds, dashboards and other bussiness logic apps. ::: ## Getting started Once you have created an account, you can start using the Management API by creating an `API User`. You can create as many API users as you need. Each `API user` is connected to a specific account so you can keep track of operations and manage keys. You can find all your API credentials in `Geins Merchant Center`. ### Fast track Use one of our [SDKs](https://docs.geins.io/docs/sdk/introduction) to get started quickly. The SDKs are available for the most popular programming languages and frameworks. Or, if you prefer to just take it for a test run: [![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/25895885-aaf6598f-1a7c-4949-85d7-ba846c42d553?action=collection%2Ffork&collection-url=entityId%3D25895885-aaf6598f-1a7c-4949-85d7-ba846c42d553%26entityType%3Dcollection%26workspaceId%3Da2a179ce-158e-46b0-8d06-e9640f45112c) ### Authentication Two authentication methods are required: - `Basic Auth` - `API Key` All API credentials can be found in `Geins Merchant Center`. #### Basic Auth A Basic auth `Authorization` header needs to be included in every request. The value should be `Basic ` where `` is the Base64 encoding of your `API username` and `API password` joined by a single colon `:`. See [Wikipedia](https://en.wikipedia.org/wiki/Basic_access_authentication) for more information on Basic auth. #### API Key An `X-ApiKey` header needs to be included in every request. This header should contain the value of your `API key`. #### Example ```bash curl -X GET \"https://mgmtapi.geins.io/API/Market/List\" \\ -H \"Authorization: Basic [USER-CREDENTIALS-BASE64-ENCODED]\" \\ -H \"X-ApiKey: [API-KEY]\" ``` * * The version of the OpenAPI document: v1.10.1 * * * 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'; /** * An existing product parameter. * @export * @interface ProductParameterModelsReadProductParameter */ export interface ProductParameterModelsReadProductParameter { /** * The unique identifier for the parameter. * @type {number} * @memberof ProductParameterModelsReadProductParameter */ parameterId?: number; /** * The unique identifier of the group that this parameter belongs to. * @type {number} * @memberof ProductParameterModelsReadProductParameter */ groupId?: number; /** * The name of the group that this parameter belongs to. * @type {string} * @memberof ProductParameterModelsReadProductParameter */ groupName?: string; /** * The type of parameter. * 1 = String. Any string value. * 2 = Float. Any floating point number. * Period as decimal separator and no thousands separator. * Eg: 10001.789. * 3 = DateTime. Any ISO 8601 date. * Eg: 2017-03-06T16:31:24+02:00. * 4 = Multi. A string value from a predefined set of values. * This type may occur multiple times for the same parameter. * 5 = Single. A string value from a predefined set of values. * 6 = Headline. A string value used mainly for grouping in layout. * 7 = Tags. A pipe-separated list of product specific values. * Eg: red|green|blue. * @type {number} * @memberof ProductParameterModelsReadProductParameter */ parameterType?: ProductParameterModelsReadProductParameterParameterTypeEnum; /** * The non-localized name of the parameter. * @type {string} * @memberof ProductParameterModelsReadProductParameter */ name?: string; } /** * @export */ export const ProductParameterModelsReadProductParameterParameterTypeEnum = { NUMBER_1: 1, NUMBER_2: 2, NUMBER_3: 3, NUMBER_4: 4, NUMBER_5: 5, NUMBER_6: 6, NUMBER_7: 7 } as const; export type ProductParameterModelsReadProductParameterParameterTypeEnum = typeof ProductParameterModelsReadProductParameterParameterTypeEnum[keyof typeof ProductParameterModelsReadProductParameterParameterTypeEnum]; /** * Check if a given object implements the ProductParameterModelsReadProductParameter interface. */ export function instanceOfProductParameterModelsReadProductParameter(value: object): boolean { let isInstance = true; return isInstance; } export function ProductParameterModelsReadProductParameterFromJSON(json: any): ProductParameterModelsReadProductParameter { return ProductParameterModelsReadProductParameterFromJSONTyped(json, false); } export function ProductParameterModelsReadProductParameterFromJSONTyped(json: any, ignoreDiscriminator: boolean): ProductParameterModelsReadProductParameter { if ((json === undefined) || (json === null)) { return json; } return { 'parameterId': !exists(json, 'ParameterId') ? undefined : json['ParameterId'], 'groupId': !exists(json, 'GroupId') ? undefined : json['GroupId'], 'groupName': !exists(json, 'GroupName') ? undefined : json['GroupName'], 'parameterType': !exists(json, 'ParameterType') ? undefined : json['ParameterType'], 'name': !exists(json, 'Name') ? undefined : json['Name'], }; } export function ProductParameterModelsReadProductParameterToJSON(value?: ProductParameterModelsReadProductParameter | null): any { if (value === undefined) { return undefined; } if (value === null) { return null; } return { 'ParameterId': value.parameterId, 'GroupId': value.groupId, 'GroupName': value.groupName, 'ParameterType': value.parameterType, 'Name': value.name, }; }