A(i)ppealing Companies

Companies

getCompany

Get company

Get company and its a(i)ppealing associations


/companies/{companyId}

Usage and SDK Samples

curl -X GET \
-H "X-Api-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://aippealing-companies.herokuapp.com/companies/{companyId}?material=plush&mode=fuzzy"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CompaniesApi;

import java.io.File;
import java.util.*;

public class CompaniesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CompaniesApi apiInstance = new CompaniesApi();
        String companyId = daimler; // String | Company ID
        String material = plush; // String | Material to use for the product
        String mode = fuzzy; // String | Mode to use for the product, exact and fuzzy operate on the curated list of products, ai uses AI to generate all aspects of the product

        try {
            Company result = apiInstance.getCompany(companyId, material, mode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompaniesApi#getCompany");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CompaniesApi;

public class CompaniesApiExample {
    public static void main(String[] args) {
        CompaniesApi apiInstance = new CompaniesApi();
        String companyId = daimler; // String | Company ID
        String material = plush; // String | Material to use for the product
        String mode = fuzzy; // String | Mode to use for the product, exact and fuzzy operate on the curated list of products, ai uses AI to generate all aspects of the product

        try {
            Company result = apiInstance.getCompany(companyId, material, mode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompaniesApi#getCompany");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Api-Key"];


// Create an instance of the API class
CompaniesApi *apiInstance = [[CompaniesApi alloc] init];
String *companyId = daimler; // Company ID (default to null)
String *material = plush; // Material to use for the product (optional) (default to lego)
String *mode = fuzzy; // Mode to use for the product, exact and fuzzy operate on the curated list of products, ai uses AI to generate all aspects of the product (optional) (default to fuzzy)

// Get company
[apiInstance getCompanyWith:companyId
    material:material
    mode:mode
              completionHandler: ^(Company output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AIppealingCompanies = require('a_ippealing_companies');
var defaultClient = AIppealingCompanies.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['X-Api-Key'] = "Token";

// Create an instance of the API class
var api = new AIppealingCompanies.CompaniesApi()
var companyId = daimler; // {String} Company ID
var opts = {
  'material': plush, // {String} Material to use for the product
  'mode': fuzzy // {String} Mode to use for the product, exact and fuzzy operate on the curated list of products, ai uses AI to generate all aspects of the product
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCompany(companyId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCompanyExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("X-Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Api-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new CompaniesApi();
            var companyId = daimler;  // String | Company ID (default to null)
            var material = plush;  // String | Material to use for the product (optional)  (default to lego)
            var mode = fuzzy;  // String | Mode to use for the product, exact and fuzzy operate on the curated list of products, ai uses AI to generate all aspects of the product (optional)  (default to fuzzy)

            try {
                // Get company
                Company result = apiInstance.getCompany(companyId, material, mode);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CompaniesApi.getCompany: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Api-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CompaniesApi();
$companyId = daimler; // String | Company ID
$material = plush; // String | Material to use for the product
$mode = fuzzy; // String | Mode to use for the product, exact and fuzzy operate on the curated list of products, ai uses AI to generate all aspects of the product

try {
    $result = $api_instance->getCompany($companyId, $material, $mode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompaniesApi->getCompany: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CompaniesApi;

# Configure API key authorization: ApiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-Api-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CompaniesApi->new();
my $companyId = daimler; # String | Company ID
my $material = plush; # String | Material to use for the product
my $mode = fuzzy; # String | Mode to use for the product, exact and fuzzy operate on the curated list of products, ai uses AI to generate all aspects of the product

eval {
    my $result = $api_instance->getCompany(companyId => $companyId, material => $material, mode => $mode);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CompaniesApi->getCompany: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
openapi_client.configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CompaniesApi()
companyId = daimler # String | Company ID (default to null)
material = plush # String | Material to use for the product (optional) (default to lego)
mode = fuzzy # String | Mode to use for the product, exact and fuzzy operate on the curated list of products, ai uses AI to generate all aspects of the product (optional) (default to fuzzy)

try:
    # Get company
    api_response = api_instance.get_company(companyId, material=material, mode=mode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CompaniesApi->getCompany: %s\n" % e)
extern crate CompaniesApi;

pub fn main() {
    let companyId = daimler; // String
    let material = plush; // String
    let mode = fuzzy; // String

    let mut context = CompaniesApi::Context::default();
    let result = client.getCompany(companyId, material, mode, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
companyId*
String
Company ID
Required
Query parameters
Name Description
material
String
Material to use for the product
mode
String
Mode to use for the product, exact and fuzzy operate on the curated list of products, ai uses AI to generate all aspects of the product

Responses


listCompanies

List all companies

List all companies and their a(i)ppealing associations


/companies

Usage and SDK Samples

curl -X GET \
-H "X-Api-Key: [[apiKey]]" \
 -H "Accept: application/json" \
 "https://aippealing-companies.herokuapp.com/companies"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CompaniesApi;

import java.io.File;
import java.util.*;

public class CompaniesApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKey
        ApiKeyAuth ApiKey = (ApiKeyAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKey.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CompaniesApi apiInstance = new CompaniesApi();

        try {
            array[Company] result = apiInstance.listCompanies();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompaniesApi#listCompanies");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CompaniesApi;

public class CompaniesApiExample {
    public static void main(String[] args) {
        CompaniesApi apiInstance = new CompaniesApi();

        try {
            array[Company] result = apiInstance.listCompanies();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompaniesApi#listCompanies");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Api-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Api-Key"];


// Create an instance of the API class
CompaniesApi *apiInstance = [[CompaniesApi alloc] init];

// List all companies
[apiInstance listCompaniesWithCompletionHandler: 
              ^(array[Company] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AIppealingCompanies = require('a_ippealing_companies');
var defaultClient = AIppealingCompanies.ApiClient.instance;

// Configure API key authorization: ApiKey
var ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix['X-Api-Key'] = "Token";

// Create an instance of the API class
var api = new AIppealingCompanies.CompaniesApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCompanies(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listCompaniesExample
    {
        public void main()
        {
            // Configure API key authorization: ApiKey
            Configuration.Default.ApiKey.Add("X-Api-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("X-Api-Key", "Bearer");

            // Create an instance of the API class
            var apiInstance = new CompaniesApi();

            try {
                // List all companies
                array[Company] result = apiInstance.listCompanies();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CompaniesApi.listCompanies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKey
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Api-Key', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CompaniesApi();

try {
    $result = $api_instance->listCompanies();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompaniesApi->listCompanies: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CompaniesApi;

# Configure API key authorization: ApiKey
$WWW::OPenAPIClient::Configuration::api_key->{'X-Api-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'X-Api-Key'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CompaniesApi->new();

eval {
    my $result = $api_instance->listCompanies();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CompaniesApi->listCompanies: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKey
openapi_client.configuration.api_key['X-Api-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['X-Api-Key'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CompaniesApi()

try:
    # List all companies
    api_response = api_instance.list_companies()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CompaniesApi->listCompanies: %s\n" % e)
extern crate CompaniesApi;

pub fn main() {

    let mut context = CompaniesApi::Context::default();
    let result = client.listCompanies(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses