/** * 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, EnvelopeListSystemString, EnvelopeListVariantModelsReadVariant, EnvelopeVariantModelsReadVariantGroup, VariantModelsWriteVariant, VariantModelsWriteVariantGroup } from '../models'; export interface AddProductToVariantGroupRequest { groupId: number; productId: string; variant: Array; productIdType?: AddProductToVariantGroupProductIdTypeEnum; include?: string; } export interface AddProductToVariantGroupProductRequest { productId1: string; productId2: string; productIdType?: AddProductToVariantGroupProductProductIdTypeEnum; include?: string; } export interface CreateVariantGroupRequest { variantGroup: VariantModelsWriteVariantGroup; include?: string; } export interface CreateVariantGroupProductRequest { productId: string; variantGroup: VariantModelsWriteVariantGroup; productIdType?: CreateVariantGroupProductProductIdTypeEnum; include?: string; } export interface DeleteVariantGroupGroupIdRequest { groupId: number; } export interface DeleteVariantGroupProductIdRequest { productId: string; productIdType?: DeleteVariantGroupProductIdProductIdTypeEnum; } export interface GetVariantGroupGroupIdRequest { groupId: number; include?: string; } export interface GetVariantGroupProductIdRequest { productId: string; productIdType?: GetVariantGroupProductIdProductIdTypeEnum; include?: string; } export interface RemoveProductFromVariantGroupRequest { productId: string; productIdType?: RemoveProductFromVariantGroupProductIdTypeEnum; include?: string; } export interface UpdateVariantRequest { productId: string; variant: Array; productIdType?: UpdateVariantProductIdTypeEnum; } export interface UpdateVariantGroupRequest { groupId: number; variantGroup: VariantModelsWriteVariantGroup; include?: string; } /** * */ export declare class VariantApi extends runtime.BaseAPI { /** * Adds a product to an existing variant group. * Add product to variant group */ addProductToVariantGroupRaw(requestParameters: AddProductToVariantGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Adds a product to an existing variant group. * Add product to variant group */ addProductToVariantGroup(requestParameters: AddProductToVariantGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Adds a product to an existing variant group from another product. * Add product to variant group (product) */ addProductToVariantGroupProductRaw(requestParameters: AddProductToVariantGroupProductRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Adds a product to an existing variant group from another product. * Add product to variant group (product) */ addProductToVariantGroupProduct(requestParameters: AddProductToVariantGroupProductRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates a new variant group. * Create variant group */ createVariantGroupRaw(requestParameters: CreateVariantGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new variant group. * Create variant group */ createVariantGroup(requestParameters: CreateVariantGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Create a new variant group for the provided product id. * Create variant group (product) */ createVariantGroupProductRaw(requestParameters: CreateVariantGroupProductRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create a new variant group for the provided product id. * Create variant group (product) */ createVariantGroupProduct(requestParameters: CreateVariantGroupProductRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Deletes an entire variant group. * Delete variant group (group id) */ deleteVariantGroupGroupIdRaw(requestParameters: DeleteVariantGroupGroupIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Deletes an entire variant group. * Delete variant group (group id) */ deleteVariantGroupGroupId(requestParameters: DeleteVariantGroupGroupIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Deletes an entire variant group based on product id. * Delete variant group (product id) */ deleteVariantGroupProductIdRaw(requestParameters: DeleteVariantGroupProductIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Deletes an entire variant group based on product id. * Delete variant group (product id) */ deleteVariantGroupProductId(requestParameters: DeleteVariantGroupProductIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Gets a specific variant group. * Get variant group (group id) */ getVariantGroupGroupIdRaw(requestParameters: GetVariantGroupGroupIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Gets a specific variant group. * Get variant group (group id) */ getVariantGroupGroupId(requestParameters: GetVariantGroupGroupIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Gets the variant group for the provided product id. * Get variant group (product id) */ getVariantGroupProductIdRaw(requestParameters: GetVariantGroupProductIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Gets the variant group for the provided product id. * Get variant group (product id) */ getVariantGroupProductId(requestParameters: GetVariantGroupProductIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Gets all valid variant labels. * Get variant labels */ getVariantLabelsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Gets all valid variant labels. * Get variant labels */ getVariantLabels(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Removes a product from its variant group. * Remove product from variant group */ removeProductFromVariantGroupRaw(requestParameters: RemoveProductFromVariantGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Removes a product from its variant group. * Remove product from variant group */ removeProductFromVariantGroup(requestParameters: RemoveProductFromVariantGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Updates the variant details for the product with the provided id. * Update variant */ updateVariantRaw(requestParameters: UpdateVariantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Updates the variant details for the product with the provided id. * Update variant */ updateVariant(requestParameters: UpdateVariantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Updates the settings of a variant group. * Update variant group */ updateVariantGroupRaw(requestParameters: UpdateVariantGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Updates the settings of a variant group. * Update variant group */ updateVariantGroup(requestParameters: UpdateVariantGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const AddProductToVariantGroupProductIdTypeEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; readonly NUMBER_2: 2; readonly NUMBER_3: 3; }; export type AddProductToVariantGroupProductIdTypeEnum = typeof AddProductToVariantGroupProductIdTypeEnum[keyof typeof AddProductToVariantGroupProductIdTypeEnum]; /** * @export */ export declare const AddProductToVariantGroupProductProductIdTypeEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; readonly NUMBER_2: 2; readonly NUMBER_3: 3; }; export type AddProductToVariantGroupProductProductIdTypeEnum = typeof AddProductToVariantGroupProductProductIdTypeEnum[keyof typeof AddProductToVariantGroupProductProductIdTypeEnum]; /** * @export */ export declare const CreateVariantGroupProductProductIdTypeEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; readonly NUMBER_2: 2; readonly NUMBER_3: 3; }; export type CreateVariantGroupProductProductIdTypeEnum = typeof CreateVariantGroupProductProductIdTypeEnum[keyof typeof CreateVariantGroupProductProductIdTypeEnum]; /** * @export */ export declare const DeleteVariantGroupProductIdProductIdTypeEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; readonly NUMBER_2: 2; readonly NUMBER_3: 3; }; export type DeleteVariantGroupProductIdProductIdTypeEnum = typeof DeleteVariantGroupProductIdProductIdTypeEnum[keyof typeof DeleteVariantGroupProductIdProductIdTypeEnum]; /** * @export */ export declare const GetVariantGroupProductIdProductIdTypeEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; readonly NUMBER_2: 2; readonly NUMBER_3: 3; }; export type GetVariantGroupProductIdProductIdTypeEnum = typeof GetVariantGroupProductIdProductIdTypeEnum[keyof typeof GetVariantGroupProductIdProductIdTypeEnum]; /** * @export */ export declare const RemoveProductFromVariantGroupProductIdTypeEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; readonly NUMBER_2: 2; readonly NUMBER_3: 3; }; export type RemoveProductFromVariantGroupProductIdTypeEnum = typeof RemoveProductFromVariantGroupProductIdTypeEnum[keyof typeof RemoveProductFromVariantGroupProductIdTypeEnum]; /** * @export */ export declare const UpdateVariantProductIdTypeEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; readonly NUMBER_2: 2; readonly NUMBER_3: 3; }; export type UpdateVariantProductIdTypeEnum = typeof UpdateVariantProductIdTypeEnum[keyof typeof UpdateVariantProductIdTypeEnum];