Skip to content

Latest commit

 

History

History
419 lines (307 loc) · 11.9 KB

BrandsApi.md

File metadata and controls

419 lines (307 loc) · 11.9 KB

IO.Swagger.Api.BrandsApi

All URIs are relative to https://api.facestore.local/v1

Method HTTP request Description
AddBrands POST /brands
DeleteBrandById DELETE /brands/{id}/
GetBrandById GET /brands/{id}/
GetBrands GET /brands
UpdateCategoryById PUT /brands/{id}/
UpdateCategoryById_0 PATCH /brands/{id}/

AddBrands

InlineResponse201 AddBrands (Brand brand)

Creates a new brand in the store.

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BrandsApi();
            var brand = new Brand(); // Brand | Brand to add to the store

            try
            {
                InlineResponse201 result = apiInstance.AddBrands(brand);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BrandsApi.AddBrands: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
brand Brand Brand to add to the store

Return type

InlineResponse201

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteBrandById

void DeleteBrandById (long? id)

Deletes a single brand based on the ID supplied

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BrandsApi();
            var id = 789;  // long? | ID of brand to delete

            try
            {
                apiInstance.DeleteBrandById(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BrandsApi.DeleteBrandById: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id long? ID of brand to delete

Return type

void (empty response body)

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBrandById

InlineResponse201 GetBrandById (long? id, List includes, int? limit)

Returns a brand based on a single ID ### Includes You can give the following values on includea parameter: routes, products

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BrandsApi();
            var id = 789;  // long? | ID of brand to fetch
            var includes = new List<string>(); // List<string> | Include associated objects within response (optional) 
            var limit = 56;  // int? | max records to return (optional) 

            try
            {
                InlineResponse201 result = apiInstance.GetBrandById(id, includes, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BrandsApi.GetBrandById: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id long? ID of brand to fetch
includes List Include associated objects within response [optional]
limit int? max records to return [optional]

Return type

InlineResponse201

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBrands

InlineResponse200 GetBrands (List includes, int? limit, List orderBy)

Returns all brands from the system that the user has access to ### Includes You can give the following values on includes parameter: routes, products

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BrandsApi();
            var includes = new List<string>(); // List<string> | Include associated objects within response (optional) 
            var limit = 56;  // int? | max records to return (optional) 
            var orderBy = new List<string>(); // List<string> | Specify the field to be sorted, examples:  - `?order_by=id|desc` - `?order_by=updated_at|desc,position|asc`  (optional) 

            try
            {
                InlineResponse200 result = apiInstance.GetBrands(includes, limit, orderBy);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BrandsApi.GetBrands: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
includes List Include associated objects within response [optional]
limit int? max records to return [optional]
orderBy List Specify the field to be sorted, examples: - `?order_by=id desc` - `?order_by=updated_at

Return type

InlineResponse200

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateCategoryById

void UpdateCategoryById (long? id, Object brand)

Update a single brand based on the ID supplied

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BrandsApi();
            var id = 789;  // long? | ID of brand to update
            var brand = ;  // Object | Brand to update in store

            try
            {
                apiInstance.UpdateCategoryById(id, brand);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BrandsApi.UpdateCategoryById: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id long? ID of brand to update
brand Object Brand to update in store

Return type

void (empty response body)

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateCategoryById_0

void UpdateCategoryById_0 (long? id, Object brand)

Update a single brand based on the ID supplied

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BrandsApi();
            var id = 789;  // long? | ID of brand to update
            var brand = ;  // Object | Brand to update in store

            try
            {
                apiInstance.UpdateCategoryById_0(id, brand);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BrandsApi.UpdateCategoryById_0: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id long? ID of brand to update
brand Object Brand to update in store

Return type

void (empty response body)

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]