Skip to content

groupby/gb-retailapi-csharp-client

BranchesTags

Repository files navigation

GroupByInc.RetailApi.Client - the C# library for the GroupBy Retail

GroupBy Retail API

This C# SDK is automatically generated by the OpenAPI Generator project:

  • API version: 0.0.0
  • SDK version: 1.0.0
  • Build package: org.openapitools.codegen.languages.CSharpClientCodegen

Frameworks supported

Dependencies

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

Installation

Run the following command to generate the DLL

  • [Mac/Linux] /bin/sh build.sh
  • [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using GroupByInc.RetailApi.Client.Api;
using GroupByInc.RetailApi.Client.Client;
using GroupByInc.RetailApi.Client.Model;

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out GroupByInc.RetailApi.Client.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using GroupByInc.RetailApi.Client.Api;
using GroupByInc.RetailApi.Client.Client;
using GroupByInc.RetailApi.Client.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "http://localhost";
            // Configure HTTP basic authorization: GroupByIncEmployee
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";
            // Configure API key authorization: ClientKey
            config.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AutocompleteApi(config);
            var xGroupbyCustomerId = "xGroupbyCustomerId_example";  // string | Header on incoming HTTP requests that is populated by the API gateway and indicates the customer ID.
            var identity = new Identity(); // Identity | 
            var merchandiser = new Merchandiser(); // Merchandiser | 
            var request = new Request?(); // Request? | Object which is represent autocomplete request and encapsulate all passed parameters.  (optional) 

            try
            {
                SearchResults result = apiInstance.Autocompletesearch(xGroupbyCustomerId, identity, merchandiser, request);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AutocompleteApi.Autocompletesearch: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AutocompleteApi Autocompletesearch GET /api/request
ProductApi GetByProductIds GET /api/search/product Provided product search functionality
RecommendationsAPIApi Predict POST /api/predict Provide Recommendations AI functionality.
RecommendationsAPIApi PredictV2 POST /api/recommendation Provide Recommendations AI functionality.
SearchApi FacetSearch POST /api/search/facet Provided search functionality
SearchApi Search POST /api/search Provided search functionality

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

ClientKey

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

GroupByIncEmployee

  • Type: HTTP basic authentication

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages