/** * 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, EnvelopeListUserModelsReadBalanceTransaction, EnvelopeListUserModelsReadBalanceType, EnvelopeUserModelsReadBalance, EnvelopeUserModelsReadUserProfile, PagedEnvelopeListUserModelsReadUserProfile, UserModelsUserProfileQuery, UserModelsWriteBalanceTransaction, UserModelsWriteUserProfile } from '../models'; export interface AddUserBalanceRequest { userId: number; balanceTransaction: UserModelsWriteBalanceTransaction; } export interface CreateUserProfileRequest { userProfile: UserModelsWriteUserProfile; } export interface DeleteUserProfileEmailRequest { email: string; } export interface DeleteUserProfileIdRequest { userId: number; } export interface GetUserBalanceRequest { userId: number; currency: string; } export interface GetUserBalanceTransactionsRequest { userId: number; currency: string; } export interface GetUserProfileEmailRequest { email: string; } export interface GetUserProfileIdRequest { userId: number; } export interface QueryUserProfilesRequest { page: number; query: UserModelsUserProfileQuery; } export interface UpdateUserProfileRequest { userId: number; user: UserModelsWriteUserProfile; } /** * */ export declare class UserApi extends runtime.BaseAPI { /** * Adds a balance transaction to a specific user. * Add user balance */ addUserBalanceRaw(requestParameters: AddUserBalanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Adds a balance transaction to a specific user. * Add user balance */ addUserBalance(requestParameters: AddUserBalanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Create user profile */ createUserProfileRaw(requestParameters: CreateUserProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create user profile */ createUserProfile(requestParameters: CreateUserProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Delete user profile (email) */ deleteUserProfileEmailRaw(requestParameters: DeleteUserProfileEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Delete user profile (email) */ deleteUserProfileEmail(requestParameters: DeleteUserProfileEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Delete user profile (id) */ deleteUserProfileIdRaw(requestParameters: DeleteUserProfileIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Delete user profile (id) */ deleteUserProfileId(requestParameters: DeleteUserProfileIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Gets the balance for a specific user. * Get user balance */ getUserBalanceRaw(requestParameters: GetUserBalanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Gets the balance for a specific user. * Get user balance */ getUserBalance(requestParameters: GetUserBalanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Gets all balance transactions for a specific user. * Get user balance transactions */ getUserBalanceTransactionsRaw(requestParameters: GetUserBalanceTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Gets all balance transactions for a specific user. * Get user balance transactions */ getUserBalanceTransactions(requestParameters: GetUserBalanceTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Gets all available balance types. * Get user balance types */ getUserBalanceTypesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Gets all available balance types. * Get user balance types */ getUserBalanceTypes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Gets a specific user profile via email. * Get user profile (email) */ getUserProfileEmailRaw(requestParameters: GetUserProfileEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Gets a specific user profile via email. * Get user profile (email) */ getUserProfileEmail(requestParameters: GetUserProfileEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Gets a specific user profile via user id. * Get user profile (id) */ getUserProfileIdRaw(requestParameters: GetUserProfileIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Gets a specific user profile via user id. * Get user profile (id) */ getUserProfileId(requestParameters: GetUserProfileIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Queries user profiles and stores the result in a batch. Results are fetched from this batch one page at a time via subsequent requests. BatchId is mandatory when fetching any page other than the first page. If no BatchId is provided for the first page, a new batch is created and the id for that batch can be found in the response. * Query user profiles */ queryUserProfilesRaw(requestParameters: QueryUserProfilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Queries user profiles and stores the result in a batch. Results are fetched from this batch one page at a time via subsequent requests. BatchId is mandatory when fetching any page other than the first page. If no BatchId is provided for the first page, a new batch is created and the id for that batch can be found in the response. * Query user profiles */ queryUserProfiles(requestParameters: QueryUserProfilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Updates a user profile. Any fields not specified in the request or with null value will be left unchanged. * Update user profile */ updateUserProfileRaw(requestParameters: UpdateUserProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Updates a user profile. Any fields not specified in the request or with null value will be left unchanged. * Update user profile */ updateUserProfile(requestParameters: UpdateUserProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }