BoutiqueApi

The Boutique: ready-made designs (solitaires, trilogies, halos, bands, earrings…) grouped in collections that are downloaded from the RhinoArtisan catalog to this computer and imported into the document like the Boutique window does.

from ArtisanPlugin.Scripting import BoutiqueApi

See also the Python package, ra.boutique.

Methods

Method
Catalog	The kits of the online Boutique catalog (rhinoartisan.com), each with whether it is installed and up to date.
Designs	The designs of the Boutique collections installed on this computer.
Download	Downloads and installs Boutique kits from the online catalog: the ones named in names (kit name or folder), or, when omitted, every kit not installed yet or updated since.
Insert	Imports a Boutique design into the document, like the Boutique window’s Open: design is its id or SKU (collection, a name or folder, narrows the search when several collections use the same one).

Catalog

IReadOnlyList<BoutiqueKit> BoutiqueApi.Catalog()

The kits of the online Boutique catalog (rhinoartisan.com), each with whether it is installed and up to date. Needs the internet; read-only.

Returns IReadOnlyList<BoutiqueKit>.

Designs

IReadOnlyList<BoutiqueCatalogDesign> BoutiqueApi.Designs(
    string query = null,
    string collection = null)

The designs of the Boutique collections installed on this computer. query keeps those whose collection, name, description, SKU or id contain every word of it (case-insensitive); collection keeps one collection (name or folder). Read-only. Install more collections with Download().

Parameter	Type	Default
query	string	null
collection	string	null

Returns IReadOnlyList<BoutiqueCatalogDesign>.

Download

IReadOnlyList<BoutiqueKit> BoutiqueApi.Download(IEnumerable<string> names = null)

Downloads and installs Boutique kits from the online catalog: the ones named in names (kit name or folder), or, when omitted, every kit not installed yet or updated since. An update replaces the kit’s folder. Returns the kits installed. Needs the internet.

Parameter	Type	Default
names	IEnumerable<string>	null

Returns IReadOnlyList<BoutiqueKit>.

Insert

IReadOnlyList<Guid> BoutiqueApi.Insert(
    string design,
    string collection = null,
    string metal = null)

Imports a Boutique design into the document, like the Boutique window’s Open: design is its id or SKU (collection, a name or folder, narrows the search when several collections use the same one). metal WHITE, YELLOW or ROSE also sets the document’s metal to that 18K gold, as the window’s metal selector does. Returns the ids of the imported objects.

Parameter	Type	Default
design	string	required
collection	string	null
metal	string	null

Returns IReadOnlyList<Guid>.