/* 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 * as runtime from '../runtime'; import type { BaseEnvelope, EnvelopeListPageAreaModelsReadPageAreaFamily, EnvelopePageAreaModelsReadPageArea, EnvelopePageAreaModelsReadPageAreaFamily, PageAreaModelsWritePageArea, PageAreaModelsWritePageAreaFamily, } from '../models'; import { BaseEnvelopeFromJSON, BaseEnvelopeToJSON, EnvelopeListPageAreaModelsReadPageAreaFamilyFromJSON, EnvelopeListPageAreaModelsReadPageAreaFamilyToJSON, EnvelopePageAreaModelsReadPageAreaFromJSON, EnvelopePageAreaModelsReadPageAreaToJSON, EnvelopePageAreaModelsReadPageAreaFamilyFromJSON, EnvelopePageAreaModelsReadPageAreaFamilyToJSON, PageAreaModelsWritePageAreaFromJSON, PageAreaModelsWritePageAreaToJSON, PageAreaModelsWritePageAreaFamilyFromJSON, PageAreaModelsWritePageAreaFamilyToJSON, } from '../models'; export interface CreateUpdatePageAreaRequest { area: PageAreaModelsWritePageArea; } export interface CreateUpdatePageAreaFamilyRequest { family: PageAreaModelsWritePageAreaFamily; } export interface GetPageAreaRequest { name: string; } export interface GetPageAreaFamilyRequest { familyId: number; } /** * */ export class PageAreaApi extends runtime.BaseAPI { /** * Creates or updates a page area. * Create/update page area */ async createUpdatePageAreaRaw(requestParameters: CreateUpdatePageAreaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters.area === null || requestParameters.area === undefined) { throw new runtime.RequiredError('area','Required parameter requestParameters.area was null or undefined when calling createUpdatePageArea.'); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; headerParameters['Content-Type'] = 'application/json'; if (this.configuration && this.configuration.apiKey) { headerParameters["X-ApiKey"] = this.configuration.apiKey("X-ApiKey"); // apiKey authentication } if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } const response = await this.request({ path: `/API/PageArea`, method: 'POST', headers: headerParameters, query: queryParameters, body: PageAreaModelsWritePageAreaToJSON(requestParameters.area), }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => EnvelopePageAreaModelsReadPageAreaFromJSON(jsonValue)); } /** * Creates or updates a page area. * Create/update page area */ async createUpdatePageArea(requestParameters: CreateUpdatePageAreaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.createUpdatePageAreaRaw(requestParameters, initOverrides); return await response.value(); } /** * Creates or updates a page area family. * Create/update page area family */ async createUpdatePageAreaFamilyRaw(requestParameters: CreateUpdatePageAreaFamilyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters.family === null || requestParameters.family === undefined) { throw new runtime.RequiredError('family','Required parameter requestParameters.family was null or undefined when calling createUpdatePageAreaFamily.'); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; headerParameters['Content-Type'] = 'application/json'; if (this.configuration && this.configuration.apiKey) { headerParameters["X-ApiKey"] = this.configuration.apiKey("X-ApiKey"); // apiKey authentication } if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } const response = await this.request({ path: `/API/PageAreaFamily`, method: 'POST', headers: headerParameters, query: queryParameters, body: PageAreaModelsWritePageAreaFamilyToJSON(requestParameters.family), }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => EnvelopePageAreaModelsReadPageAreaFamilyFromJSON(jsonValue)); } /** * Creates or updates a page area family. * Create/update page area family */ async createUpdatePageAreaFamily(requestParameters: CreateUpdatePageAreaFamilyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.createUpdatePageAreaFamilyRaw(requestParameters, initOverrides); return await response.value(); } /** * Gets a specific page area. * Get page area */ async getPageAreaRaw(requestParameters: GetPageAreaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters.name === null || requestParameters.name === undefined) { throw new runtime.RequiredError('name','Required parameter requestParameters.name was null or undefined when calling getPageArea.'); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && this.configuration.apiKey) { headerParameters["X-ApiKey"] = this.configuration.apiKey("X-ApiKey"); // apiKey authentication } if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } const response = await this.request({ path: `/API/PageArea/{name}`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters.name))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => EnvelopePageAreaModelsReadPageAreaFromJSON(jsonValue)); } /** * Gets a specific page area. * Get page area */ async getPageArea(requestParameters: GetPageAreaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.getPageAreaRaw(requestParameters, initOverrides); return await response.value(); } /** * Gets a specific page area family. * Get page area family */ async getPageAreaFamilyRaw(requestParameters: GetPageAreaFamilyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { if (requestParameters.familyId === null || requestParameters.familyId === undefined) { throw new runtime.RequiredError('familyId','Required parameter requestParameters.familyId was null or undefined when calling getPageAreaFamily.'); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && this.configuration.apiKey) { headerParameters["X-ApiKey"] = this.configuration.apiKey("X-ApiKey"); // apiKey authentication } if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } const response = await this.request({ path: `/API/PageAreaFamily/{familyId}`.replace(`{${"familyId"}}`, encodeURIComponent(String(requestParameters.familyId))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => EnvelopePageAreaModelsReadPageAreaFamilyFromJSON(jsonValue)); } /** * Gets a specific page area family. * Get page area family */ async getPageAreaFamily(requestParameters: GetPageAreaFamilyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.getPageAreaFamilyRaw(requestParameters, initOverrides); return await response.value(); } /** * Gets a list of all page area families, including nested data. * List page area families */ async listPageAreaFamiliesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (this.configuration && this.configuration.apiKey) { headerParameters["X-ApiKey"] = this.configuration.apiKey("X-ApiKey"); // apiKey authentication } if (this.configuration && (this.configuration.username !== undefined || this.configuration.password !== undefined)) { headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password); } const response = await this.request({ path: `/API/PageAreaFamily/List`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => EnvelopeListPageAreaModelsReadPageAreaFamilyFromJSON(jsonValue)); } /** * Gets a list of all page area families, including nested data. * List page area families */ async listPageAreaFamilies(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise { const response = await this.listPageAreaFamiliesRaw(initOverrides); return await response.value(); } }