/** * 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 * as runtime from '../runtime'; import type { BaseEnvelope, EnvelopeProductParameterModelsReadProductParameter, EnvelopeProductParameterModelsReadProductParameterGroup, EnvelopeProductParameterModelsReadProductParameterPredefinedValue, EnvelopeProductParameterModelsReadProductParameterValue, ProductParameterModelsWriteProductParameter, ProductParameterModelsWriteProductParameterGroup, ProductParameterModelsWriteProductParameterPredefinedValue, ProductParameterModelsWriteProductParameterValue, ProductParameterModelsWriteProductParameterValueBatch } from '../models'; export interface CreateOrUpdateProductParameterValueRequest { productParameterValue: ProductParameterModelsWriteProductParameterValue; } export interface CreateProductParameterRequest { productParameter: ProductParameterModelsWriteProductParameter; } export interface CreateProductParameterGroupRequest { productParameterGroup: ProductParameterModelsWriteProductParameterGroup; } export interface CreateProductParameterPredefinedValueRequest { productParameterPredefinedValue: ProductParameterModelsWriteProductParameterPredefinedValue; } export interface GetProductParameterRequest { id: number; } export interface GetProductParameterGroupRequest { id: number; } export interface GetProductParameterPredefinedValueRequest { id: number; } export interface GetProductParameterValueRequest { id: number; predefinedValueId?: string; } export interface ReplaceProductParameterValuesBatchRequest { productParameterBatch: ProductParameterModelsWriteProductParameterValueBatch; } export interface UpdateProductParameterRequest { id: number; productParameter: ProductParameterModelsWriteProductParameter; } export interface UpdateProductParameterGroupRequest { id: number; productParameterGroup: ProductParameterModelsWriteProductParameterGroup; } export interface UpdateProductParameterValuesBatchRequest { productParameterBatch: ProductParameterModelsWriteProductParameterValueBatch; } /** * */ export declare class ProductParameterApi extends runtime.BaseAPI { /** * Creates or updates a new product parameter value. * Create/update product parameter value */ createOrUpdateProductParameterValueRaw(requestParameters: CreateOrUpdateProductParameterValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates or updates a new product parameter value. * Create/update product parameter value */ createOrUpdateProductParameterValue(requestParameters: CreateOrUpdateProductParameterValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates a new product parameter. * Create product parameter */ createProductParameterRaw(requestParameters: CreateProductParameterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new product parameter. * Create product parameter */ createProductParameter(requestParameters: CreateProductParameterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates a new product parameter group. * Create product parameter group */ createProductParameterGroupRaw(requestParameters: CreateProductParameterGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new product parameter group. * Create product parameter group */ createProductParameterGroup(requestParameters: CreateProductParameterGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates a new predefined value for a product parameter. * Create product parameter predefined value */ createProductParameterPredefinedValueRaw(requestParameters: CreateProductParameterPredefinedValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new predefined value for a product parameter. * Create product parameter predefined value */ createProductParameterPredefinedValue(requestParameters: CreateProductParameterPredefinedValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Gets a specific product parameter * Get product parameter */ getProductParameterRaw(requestParameters: GetProductParameterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Gets a specific product parameter * Get product parameter */ getProductParameter(requestParameters: GetProductParameterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Gets a specific product parameter group. * Get product parameter group */ getProductParameterGroupRaw(requestParameters: GetProductParameterGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Gets a specific product parameter group. * Get product parameter group */ getProductParameterGroup(requestParameters: GetProductParameterGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Gets a specific predefined value for a product parameter. * Get product parameter predefined value */ getProductParameterPredefinedValueRaw(requestParameters: GetProductParameterPredefinedValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Gets a specific predefined value for a product parameter. * Get product parameter predefined value */ getProductParameterPredefinedValue(requestParameters: GetProductParameterPredefinedValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Gets a specific product parameter value. * Get product parameter value */ getProductParameterValueRaw(requestParameters: GetProductParameterValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Gets a specific product parameter value. * Get product parameter value */ getProductParameterValue(requestParameters: GetProductParameterValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Replaces multiple product parameter values. * Replace product parameter values (batch) */ replaceProductParameterValuesBatchRaw(requestParameters: ReplaceProductParameterValuesBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Replaces multiple product parameter values. * Replace product parameter values (batch) */ replaceProductParameterValuesBatch(requestParameters: ReplaceProductParameterValuesBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Updates a product parameter. Leaving out a property will ensure no changes are made to that property. Collection properties will delete and/or add as necessary to match the supplied data. * Update product parameter */ updateProductParameterRaw(requestParameters: UpdateProductParameterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Updates a product parameter. Leaving out a property will ensure no changes are made to that property. Collection properties will delete and/or add as necessary to match the supplied data. * Update product parameter */ updateProductParameter(requestParameters: UpdateProductParameterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Updates a product parameter group. Leaving out a property will ensure no changes are made to that property. Collection properties will delete and/or add as necessary to match the supplied data. * Update product parameter group */ updateProductParameterGroupRaw(requestParameters: UpdateProductParameterGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Updates a product parameter group. Leaving out a property will ensure no changes are made to that property. Collection properties will delete and/or add as necessary to match the supplied data. * Update product parameter group */ updateProductParameterGroup(requestParameters: UpdateProductParameterGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Updates multiple product parameter values. * Update product parameter values (batch) */ updateProductParameterValuesBatchRaw(requestParameters: UpdateProductParameterValuesBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Updates multiple product parameter values. * Update product parameter values (batch) */ updateProductParameterValuesBatch(requestParameters: UpdateProductParameterValuesBatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }