MoxiWorks Platform
.NET SDK For MoxiWorks Public API
MoxiWorks.Platform.BrandService Class Reference

Moxi Works Brand objects contain data about brand colors & logos associated with a company. For example, you can get a Company’s logo for use within your own product. More...

Inheritance diagram for MoxiWorks.Platform.BrandService:
MoxiWorks.Platform.Interfaces.IBrandService

Public Member Functions

 BrandService (IMoxiWorksClient client)
 
async Task< Response< Brand > > GetCompanyBrandAsync (string moxiWorksCompanyId)
 Find company brand More...
 
async Task< Response< BrandResults > > GetBrandsAsync (string moxiWorksCompanyId, string agentId=null)
 Returns BrandResults that contains associated Brands for the request query More...
 

Properties

IMoxiWorksClient Client [get, set]
 
- Properties inherited from MoxiWorks.Platform.Interfaces.IBrandService
IMoxiWorksClient Client [get, set]
 

Detailed Description

Moxi Works Brand objects contain data about brand colors & logos associated with a company. For example, you can get a Company’s logo for use within your own product.

Member Function Documentation

◆ GetBrandsAsync()

async Task<Response<BrandResults> > MoxiWorks.Platform.BrandService.GetBrandsAsync ( string  moxiWorksCompanyId,
string  agentId = null 
)

Returns BrandResults that contains associated Brands for the request query

Parameters
moxiWorksAgentIdThis is the Moxi Works Platform ID of the Agent. This will be a string that may take the form of an email address, or a unique identification string. agent_uuid or moxi_works_agent_id is required and must reference a valid Moxi Works Agent ID for your Agent request to be accepted.
moxiWorksCompanyIdA valid Moxi Works Company ID. Use Company Endpoint to determine what MoxiWorksCompanyID you can use.
Returns
List of brands associated with the requested Agent or Company

Implements MoxiWorks.Platform.Interfaces.IBrandService.

◆ GetCompanyBrandAsync()

async Task<Response<Brand> > MoxiWorks.Platform.BrandService.GetCompanyBrandAsync ( string  moxiWorksCompanyId)

Find company brand

Parameters
moxiWorksCompanyIdA valid Moxi Works Company ID. Use Company Endpoint to determine what MoxiWorksCompanyID you can use.
Returns
the Brand if exists or an empty Brand Object

Implements MoxiWorks.Platform.Interfaces.IBrandService.


The documentation for this class was generated from the following file: