C# Class BalihooBlipDotNet.Blip

The BLIP object and its methods.

Datei anzeigen Open project: balihoo/balihoo-blip-sdk-net

Private Properties

Property	Type	Description
IsValidEmail	bool
IsValidUrl	bool

Public Methods

Method	Description
Blip ( string apiKey, string secretKey, string endpoint = "https://blip.balihoo-cloud.com" ) : System	The Blip constructor.
BulkLoad ( string brandKey, string source, string filePath, bool implicitDelete, int expectedRecordCount, string successEmail = null, string failEmail = null, string successCallbackUrl = null, string failCallbackUrl = null ) : BlipResponse	Load a bulk location file into BLIP.
DeleteLocation ( string brandKey, string locationKey, string source ) : BlipResponse	Delete a location.
GetBrandKeys ( ) : BlipResponse	Get a list of brandKeys that the API user is authorized to access.
GetBrandProjections ( string brandKey ) : BlipResponse	Get a list of data projections available for an individual brand.
GetBrandSources ( string brandKey ) : BlipResponse	Get a list of data sources available for an individual brand.
GetLocation ( string brandKey, string locationKey, string projection = "universal", bool includeRefs = false ) : BlipResponse	Get data for an individual location that belongs to the specified brand.
GetLocationKeys ( string brandKey, string projection = "universal" ) : BlipResponse	Get a list of locationKeys for all locations belonging to the specified brand.
Ping ( ) : BlipResponse	Ping the BLIP API.
PutLocation ( string brandKey, string locationKey, string source, string locationData ) : BlipResponse	Add or update a location.
QueryLocations ( string brandKey, string query, string view = "full", int pageSize, int pageNumber, string sortColumn = "locationKey", string sortDirection = "asc" ) : BlipResponse	Get data for locations in a single brand that match the specified BLIP query.

Private Methods

Method	Description
IsValidEmail ( string email ) : bool	Validate email address or comma delimited list of email addresses.
IsValidUrl ( string url ) : bool	Validate URL.

Method Details

Blip() public method

The Blip constructor.

public Blip ( string apiKey, string secretKey, string endpoint = "https://blip.balihoo-cloud.com" ) : System
apiKey	string	The key used to access the BLIP API.
secretKey	string	The secret key used to access the BLIP API.
endpoint	string	The BLIP endpoint to target. Defaults to Balihoo's production environment.
return	System

BulkLoad() public method

Load a bulk location file into BLIP.

public BulkLoad ( string brandKey, string source, string filePath, bool implicitDelete, int expectedRecordCount, string successEmail = null, string failEmail = null, string successCallbackUrl = null, string failCallbackUrl = null ) : BlipResponse
brandKey	string	The unique identifier for a single brand.
source	string	The unique identifier for the data source.
filePath	string	The full path to the bulk location file.
implicitDelete	bool	Whether or not to delete locations from BLIP if they're missing from the file.
expectedRecordCount	int	The number of location records to expect in the file.
successEmail	string	An optional email address to notify upon success. Can be a comma-delimited list.
failEmail	string	An optional email address to notify upon failure. Can be a comma-delimited list.
successCallbackUrl	string	An optional URL to call upon success.
failCallbackUrl	string	An optional URL to call upon failure.
return	BlipResponse

DeleteLocation() public method

Delete a location.

public DeleteLocation ( string brandKey, string locationKey, string source ) : BlipResponse
brandKey	string	The unique identifier for a single brand.
locationKey	string	The unique identifier for a single location within the brand.
source	string	The unique identifier for the data source being used to delete the location.
return	BlipResponse

GetBrandKeys() public method

Get a list of brandKeys that the API user is authorized to access.

public GetBrandKeys ( ) : BlipResponse
return	BlipResponse

GetBrandProjections() public method

Get a list of data projections available for an individual brand.

public GetBrandProjections ( string brandKey ) : BlipResponse
brandKey	string	The unique identifier for a single brand.
return	BlipResponse

GetBrandSources() public method

Get a list of data sources available for an individual brand.

public GetBrandSources ( string brandKey ) : BlipResponse
brandKey	string	The unique identifier for a single brand.
return	BlipResponse

GetLocation() public method

Get data for an individual location that belongs to the specified brand.

public GetLocation ( string brandKey, string locationKey, string projection = "universal", bool includeRefs = false ) : BlipResponse
brandKey	string	The unique identifier for a single brand.
locationKey	string	The unique identifier for a single location within the brand.
projection	string	Optionally filter data in a single projection. Defaults to "universal".
includeRefs	bool	Optionally include objects referenced by the location in its data. Defaults to false.
return	BlipResponse

GetLocationKeys() public method

Get a list of locationKeys for all locations belonging to the specified brand.

public GetLocationKeys ( string brandKey, string projection = "universal" ) : BlipResponse
brandKey	string	The unique identifier for a single brand.
projection	string	Optionally filter data to locations in a single projecttion. Defaults to "universal".
return	BlipResponse

Ping() public method

Ping the BLIP API.

public Ping ( ) : BlipResponse
return	BlipResponse

PutLocation() public method

Add or update a location.

public PutLocation ( string brandKey, string locationKey, string source, string locationData ) : BlipResponse
brandKey	string	The unique identifier for a single brand.
locationKey	string	The unique identifier for a single location within the brand.
source	string	The unique identifier for the data source being used to add/update the location.
locationData	string	The stringified JSON location document.
return	BlipResponse

QueryLocations() public method

Get data for locations in a single brand that match the specified BLIP query.

public QueryLocations ( string brandKey, string query, string view = "full", int pageSize, int pageNumber, string sortColumn = "locationKey", string sortDirection = "asc" ) : BlipResponse
brandKey	string	The unique identifier for a single brand.
query	string	A stringified JSON query used to filter locations in BLIP.
view	string	Optionally specify the view returned. Defaults to "full".
pageSize	int	Optionally specify the number of results to include in each page of results.
pageNumber	int	Optionally specify the page index to return.
sortColumn	string	The column by which to sort results. ('name' or 'locationKey' -- defaults to 'locationKey').
sortDirection	string	The direction to sort results. ('asc' or 'desc' -- defaults to 'asc').
return	BlipResponse