Giter Site home page Giter Site logo

sdk-powershell's Introduction

PSOpenAPITools - the PowerShell module for the Geins Management API

Geins Management API is an RESTful api to power your applications who manages 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 With this API, you can build custom applications and integrate with third-party systems, 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 key. You can create as many API keys as you need. Each API key is connected to a specific account so you can keep track of operations and manage keys. You can find your API key in the geins merchant center.

Fast track

Use one of our SDKs 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

Authentication

Two authentication methods are supported:

  • API Key
  • Basic Auth

This PowerShell module is automatically generated by the OpenAPI Generator project:

  • API version: v1.7
  • SDK version: 0.1.2
  • Build package: org.openapitools.codegen.languages.PowerShellClientCodegen

Frameworks supported

  • PowerShell 6.2 or later

Dependencies

Installation

To install from the source, run the following command to build and install the PowerShell module locally:

Build.ps1
Import-Module -Name '.\src\PSOpenAPITools' -Verbose

To avoid function name collision, one can use -Prefix, e.g. Import-Module -Name '.\src\PSOpenAPITools' -Prefix prefix

To uninstall the module, simply run:

Remove-Module -FullyQualifiedName @{ModuleName = "PSOpenAPITools"; ModuleVersion = "0.1.2"}

Tests

To install and run Pester, please execute the following commands in the terminal:

Install-module -name Pester -force

Invoke-Pester

For troubleshooting, please run $DebugPreference = 'Continue' to turn on debugging and disable it with $DebugPreference = 'SilentlyContinue' when done with the troubleshooting.

Documentation for API Endpoints

All URIs are relative to https://mgmtapi.geins.io

Class Method HTTP request Description
BrandApi New-Brand POST /API/Brand Create a new brand
BrandApi Get-BrandById GET /API/Brand/{id} Get a specific brand
BrandApi Invoke-QueryBrands POST /API/Brand/Query Query brands
BrandApi Update-Brand PUT /API/Brand/{id} Updates a brand
CategoryApi New-Category POST /API/Category Create a new category
CategoryApi Get-CategoryById GET /API/Category/{id} Get a specific category
CategoryApi Invoke-QueryCategories POST /API/Category/Query Query categories
CategoryApi Update-Category PUT /API/Category/{id} Update a category
MarketApi Get-MarketById GET /API/Market/{marketId} Get a specific market
MarketApi Invoke-ListMarkets GET /API/Market/List Gets a list of all markets
OrderApi Add-CommentToOrder POST /API/Order/{id}/Comment Adds a comment to the order
OrderApi New-Order POST /API/Order Post a new order
OrderApi New-OrderId POST /API/Order/Id Create a new order id
OrderApi Invoke-DeleteOrder DELETE /API/Order/{id} Deletes or deactivates an order
OrderApi Get-CaptureById GET /API/Order/Capture/{captureId} Get Capture by Id
OrderApi Get-OrderById GET /API/Order/{id}/{include} Get an instance of a order
OrderApi Get-OrderStatuses GET /API/Order/Statuses Get a list of available order statuses
OrderApi Get-RefundById GET /API/Order/Refund/{refundId} Get Refund by Id
OrderApi Invoke-PartialUpdateOfOrder PATCH /API/Order/{id} Partial update of an order
OrderApi Invoke-QueryOrders POST /API/Order/Query Query the order repository
OrderApi Set-CaptureAsProcessed POST /API/Order/Capture/SetAsProcessed Set a capture as processed (= captured)
OrderApi Set-PaymentAsPayed POST /API/Order/PaymentDetail/{paymentDetailId}/SetAsPayed Set Payment Detail as payed
OrderApi Set-RefundAsProcessed POST /API/Order/Refund/SetAsProcessed Set a refund as processed (= settled)
OrderApi Update-OrderStatus POST /API/Order/{id}/Status/{status}/{transactionId}/{secondaryTransactionId} Update order status
OrderApi Update-TransactionData POST /API/Order/{id}/TransactionData Updates transaction data on an order
OrderApi Confirm-Order POST /API/Order/ValidateCreation Validates order data for order creation.
PageAreaApi New-OrUpdateAPageArea POST /API/PageArea Create or update a page area
PageAreaApi New-OrUpdatePageAreaFamily POST /API/PageAreaFamily Create or update a page area family
PageAreaApi Get-PageArea GET /API/PageArea/{name} Get a specific page area
PageAreaApi Get-PageAreaFamily GET /API/PageAreaFamily/{familyId} Get a specific page area family
PageAreaApi Invoke-ListPageAreaFamilies GET /API/PageAreaFamily/List Gets a list of all page area families, including nested data
PaymentApi Invoke-QueryPaymentOptions POST /API/Payment/Query Query payment options
PriceListApi Invoke-ListPriceLists GET /API/PriceList/List Get all price list definitions
PriceListApi Update-PricelistPrices PUT /API/PriceList/Price Updates price list prices
ProductApi Add-ImageToProduct PUT /API/Product/{productId}/Image/{imageName} Adds an image relation to a product
ProductApi Add-AvailabilityMonitor POST /API/Product/MonitorAvailability Add a product availability monitor
ProductApi Add-CategoryToProduct PUT /API/Product/{productId}/Category Adds a category relation to a product
ProductApi Add-RelatedProductsToProduct PUT /API/Product/{productId}/Related Add related products to a product
ProductApi Invoke-BatchUpdateProductItems PUT /API/Product/Items Updates product items in batch
ProductApi Invoke-BatchUpdateStockValues PUT /API/Product/Stock Update stock values for multiple product items
ProductApi New-Product POST /API/Product Create a new product
ProductApi New-ProductItems POST /API/Product/{productId}/Item Create a new product item
ProductApi Get-ProductById GET /API/Product/{productId} Get a specific product
ProductApi Get-ProductItemById GET /API/Product/Item/{itemId} Get a specific product item
ProductApi Invoke-LinkRelatedProductsByRelationId PUT /API/Product/{productId}/Related/{relationTypeId} Add related products to a product using a fixed relation type
ProductApi Invoke-ListAllProductItemsPaged GET /API/Product/Items/{page} Get all product items with pagination
ProductApi Invoke-ListFeeds GET /API/Product/Feeds Gets a list of all feeds
ProductApi Invoke-ListProductItems GET /API/Product/Items Get all product items
ProductApi Invoke-ListProductRelationTypes GET /API/Product/RelationTypes Gets a list of product relation types
ProductApi Invoke-QueryProducts POST /API/Product/Query Query products
ProductApi Invoke-QueryProductsPaged POST /API/Product/Query/{page} Query products with pagination
ProductApi Invoke-QueryStock POST /API/Product/Stock/Query Query stock
ProductApi Update-Product PUT /API/Product/{productId} Updates a product
ProductApi Update-ProductItem PUT /API/Product/Item/{itemId} Updates a product item
ProductParameterApi Invoke-BatchReplaceProductParameterValues POST /API/ProductParameter/Values Replace multiple product parameter values
ProductParameterApi Invoke-BatchUpdateProductParameterValues PUT /API/ProductParameter/Values Update multiple product parameter values
ProductParameterApi New-OrUpdateProductParameterValue POST /API/ProductParameter/Value Create or update a new product parameter value
ProductParameterApi New-ProductParameter POST /API/ProductParameter Create a new product parameter
ProductParameterApi New-ProductParameterGroup POST /API/ProductParameter/Group Create a new product parameter group
ProductParameterApi New-ProductParameterPredefinedValue POST /API/ProductParameter/PredefinedValue Create a new predefined value for a product parameter
ProductParameterApi Get-ProductParameterById GET /API/ProductParameter/{id} Get a specific product parameter
ProductParameterApi Get-ProductParameterGroupById GET /API/ProductParameter/Group/{id} Get a specific product parameter group
ProductParameterApi Get-ProductParameterPredefinedValue GET /API/ProductParameter/PredefinedValue/{id} Get a specific predefined value for a product parameter
ProductParameterApi Get-ProductParameterValue GET /API/ProductParameter/Value/{id} Get a specific product parameter value
ProductParameterApi Update-ProductParameter PUT /API/ProductParameter/{id} Updates a product parameter
ProductParameterApi Update-ProductParameterGroup PUT /API/ProductParameter/Group/{id} Update a product parameter group
ShippingApi New-ParcelGroup POST /API/Shipping/ParcelGroup Create a new parcel group
ShippingApi Invoke-QueryShippingOptions POST /API/Shipping/Query Query shipping options
SupplierApi New-Supplier POST /API/Supplier Create a new supplier
SupplierApi Get-SupplierById GET /API/Supplier/{id} Get a specific supplier
SupplierApi Invoke-QuerySuppliers POST /API/Supplier/Query Query suppliers
SupplierApi Update-Supplier PUT /API/Supplier/{id} Updates a supplier
UserApi New-UserProfile POST /API/User Create user profile
UserApi Invoke-DeleteUserProfile DELETE /API/User/email Delete user profile
UserApi Get-UserProfile POST /API/User/Query Get a specific user profile
UserApi Update-UserProfile PUT /API/User Update user profile
VariantApi Add-ProductToVariantGroup PUT /API/VariantGroup/{groupId}/{productId} Adds a product to an existing group
VariantApi Add-ProductToVariantGroupByProductId PUT /API/Variant/{productId1}/{productId2} Adds a product to an existing group
VariantApi New-VariantGroup POST /API/VariantGroup Create a new variant group
VariantApi New-VariantGroupWithProduct POST /API/Variant/{productId}/VariantGroup Create a new group for the provided product id
VariantApi Invoke-DeleteVariantGroup DELETE /API/VariantGroup/{groupId} Delete an entire variant group
VariantApi Invoke-DeleteVariantGroupByProductId DELETE /API/Variant/{productId}/VariantGroup Delete an entire variant group
VariantApi Get-VariantGroup GET /API/VariantGroup/{groupId} Get a specific variant group
VariantApi Get-VariantGroupByProductId GET /API/Variant/{productId}/VariantGroup Get the variant group for the provided id
VariantApi Get-VariantLabels GET /API/Variant/Labels Get all valid variant labels
VariantApi Remove-ProductFromVariantGroup DELETE /API/Variant/{productId} Remove a product from its variant group
VariantApi Update-Variant PUT /API/Variant/{productId} Adds the variant details for the product with the provided ID
VariantApi Update-VariantGroup PUT /API/VariantGroup/{groupId} Updates the settings of a group

Documentation for Models

Documentation for Authorization

apiKey

  • Type: API key

  • API key parameter name: x-apikey

  • Location: HTTP header

basicAuth

  • Type: HTTP basic authentication

sdk-powershell's People

Contributors

arvidsson-geins avatar

Watchers

Kristian Arvidsson avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.