Class PortfolioApi

PortfolioApi - object-oriented interface export PortfolioApi

Hierarchy (view full)

BaseAPI
- PortfolioApi

Index

Constructors

constructor

new PortfolioApi(configuration?, basePath?, axios?): PortfolioApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns PortfolioApi
Inherited from BaseAPI.constructor
- Defined in src/api/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

createCatalog

createCatalog(externalId?, title?, description?, details?, href?, type?, subType?, explicit?, minimumAgeRequirement?, catalogs?, externalUrls?, externalImages?, attributions?, partitionKey?, accountId?, importExternalImages?, options?): Promise<AxiosResponse<PortfolioCatalog, any>>
summary Create a PortfolioCatalog
Parameters
- OptionalexternalId: string
  The idea from the source third party
- Optionaltitle: string
  The Title
- Optionaldescription: string
  The decription
- Optionaldetails: {
  [key: string]: string;
  }
  A keyed list of other details related to the catalog such as additional product details
  - [key: string]: string
- Optionalhref: string
  The external href (optional)
- Optionaltype: string
  The type of catalog, such as album, video channel, shopping category, etc.
- OptionalsubType: string
  The sub type of catalog
- Optionalexplicit: boolean
  True if the catalog content is deemed explicit, otherwise false
- OptionalminimumAgeRequirement: number
  Minimum age in years if there is an age requirement such as 18+, otherise null or zero
- Optionalcatalogs: CatalogEntryDeets[]
  List of the PortfolioCatalogs this PortfolioItem belongs to
- OptionalexternalUrls: {
  [key: string]: string;
  }
  The external url
  - [key: string]: string
- OptionalexternalImages: ExternalImageDeets[]
  Collection of external images
- Optionalattributions: AttributionDeets[]
  Attributions are the credits or roles attaching Contact items to this PortfolioItem
- OptionalpartitionKey: string
- OptionalaccountId: string
  Tenant account ID
- OptionalimportExternalImages: boolean
  When set to true Mozaic will import the external images for the portfolio items and raise an 'import_completed' shared event when complete
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PortfolioCatalog, any>>
Throws
memberof PortfolioApi
- Defined in src/api/api.ts:24019

createItem

createItem(externalId?, title?, addressCommonName?, addressAddress1?, addressAddress2?, addressCityName?, addressGeoPoint?, addressRegionId?, addressPostalCode?, addressRegionName?, addressCountryCode?, description?, details?, href?, type?, subType?, explicit?, durationMilliseconds?, minimumAgeRequirement?, catalogs?, externalUrls?, externalImages?, attributions?, partitionKey?, accountId?, importExternalImages?, options?): Promise<AxiosResponse<PortfolioItem, any>>
summary Create a PortfolioItem
Parameters
- OptionalexternalId: string
  The idea from the source third party
- Optionaltitle: string
  The Title
- OptionaladdressCommonName: string
  Common name of the address like Central Park, If we already have this in our db, it will pick that address by default
- OptionaladdressAddress1: string
  Address line 1
- OptionaladdressAddress2: string
  Address line 2
- OptionaladdressCityName: string
  City name
- OptionaladdressGeoPoint: string
  Latitude and Longitude
- OptionaladdressRegionId: number
- OptionaladdressPostalCode: string
  Postal code or ZIP code
- OptionaladdressRegionName: string
  State, region or province
- OptionaladdressCountryCode: string
  Two-letter country code <see href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\">ISO 3166-1 alpha-2</see>
- Optionaldescription: string
  The decription
- Optionaldetails: {
  [key: string]: string;
  }
  A keyed list of other details related to the item such as additional product details
  - [key: string]: string
- Optionalhref: string
  The external href (optional)
- Optionaltype: string
  The type of item audio, video, game, podcast, physical, location, destination, experience, tip-link, invoice
- OptionalsubType: string
  The type of item audio, video, game, podcast, physical, location, destination, experience, tip-link, invoice
- Optionalexplicit: boolean
  True if the content is deemd explicity, otherwise false
- OptionaldurationMilliseconds: number
  Duration in ms
- OptionalminimumAgeRequirement: number
  Minimum age in years if there is an age requirement such as 18+, otherise null or zero
- Optionalcatalogs: CatalogEntryDeets[]
  List of the PortfolioCatalogs this PortfolioItem belongs to
- OptionalexternalUrls: {
  [key: string]: string;
  }
  The external url
  - [key: string]: string
- OptionalexternalImages: ExternalImageDeets[]
  Collection of external images
- Optionalattributions: AttributionDeets[]
  Attributions are the credits or roles attaching Contact items to this PortfolioItem
- OptionalpartitionKey: string
- OptionalaccountId: string
  Tenant account ID
- OptionalimportExternalImages: boolean
  When set to true Mozaic will import the external images for the portfolio items and raise an 'import_completed' shared event when complete
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PortfolioItem, any>>
Throws
memberof PortfolioApi
- Defined in src/api/api.ts:24056

getCatalogs

getCatalogs(limit?, page?, userId?, options?): Promise<AxiosResponse<PortfolioCatalogListResponse, any>>
summary Retrieve a list of PortfolioCatalogs
Parameters
- Optionallimit: number
  A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25
- Optionalpage: number
  1-based page index for paginated results
- OptionaluserId: string
  The user id to operate on their behalf (tenants only)
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PortfolioCatalogListResponse, any>>
Throws
memberof PortfolioApi
- Defined in src/api/api.ts:24070

getItems

getItems(keywords?, channelId?, limit?, page?, userId?, options?): Promise<AxiosResponse<PortfolioItemListResponse, any>>
summary Retrieve a list of PortfolioItems
Parameters
- Optionalkeywords: string
- OptionalchannelId: string
- Optionallimit: number
  A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25
- Optionalpage: number
  1-based page index for paginated results
- OptionaluserId: string
  The user id to operate on their behalf (tenants only)
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PortfolioItemListResponse, any>>
Throws
memberof PortfolioApi
- Defined in src/api/api.ts:24086

updateCatalog

updateCatalog(id, externalId?, title?, addressCommonName?, addressAddress1?, addressAddress2?, addressCityName?, addressGeoPoint?, addressRegionId?, addressPostalCode?, addressRegionName?, addressCountryCode?, description?, details?, href?, type?, subType?, explicit?, durationMilliseconds?, minimumAgeRequirement?, externalUrls?, externalImages?, attributions?, importExternalImages?, userId?, options?): Promise<AxiosResponse<PortfolioCatalog, any>>
summary Create or update an PortfolioCatalog
Parameters
- id: string
  The id of the record you wish to retrieve
- OptionalexternalId: string
  The idea from the source third party
- Optionaltitle: string
  The Title
- OptionaladdressCommonName: string
  Common name of the address like Central Park, If we already have this in our db, it will pick that address by default
- OptionaladdressAddress1: string
  Address line 1
- OptionaladdressAddress2: string
  Address line 2
- OptionaladdressCityName: string
  City name
- OptionaladdressGeoPoint: string
  Latitude and Longitude
- OptionaladdressRegionId: number
- OptionaladdressPostalCode: string
  Postal code or ZIP code
- OptionaladdressRegionName: string
  State, region or province
- OptionaladdressCountryCode: string
  Two-letter country code <see href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\">ISO 3166-1 alpha-2</see>
- Optionaldescription: string
  The decription
- Optionaldetails: {
  [key: string]: string;
  }
  A keyed list of other details related to the item such as additional product details
  - [key: string]: string
- Optionalhref: string
  The external href (optional)
- Optionaltype: string
  The type of item audio, video, game, podcast, physical, location, destination, experience, tip-link, invoice
- OptionalsubType: string
  The type of item audio, video, game, podcast, physical, location, destination, experience, tip-link, invoice
- Optionalexplicit: boolean
  True if the content is deemd explicity, otherwise false
- OptionaldurationMilliseconds: number
  Duration in ms
- OptionalminimumAgeRequirement: number
  Minimum age in years if there is an age requirement such as 18+, otherise null or zero
- OptionalexternalUrls: {
  [key: string]: string;
  }
  The external url
  - [key: string]: string
- OptionalexternalImages: ExternalImageDeets[]
  Collection of external images
- Optionalattributions: AttributionDeets[]
  Attributions are the credits or roles attaching Contact items to this PortfolioItem
- OptionalimportExternalImages: boolean
  When set to true Mozaic will import the external images for the portfolio items and raise an 'import_completed' shared event when complete
- OptionaluserId: string
  The user id to operate on their behalf (tenants only)
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PortfolioCatalog, any>>
Throws
memberof PortfolioApi
- Defined in src/api/api.ts:24122

updateItem

updateItem(id, externalId?, title?, addressCommonName?, addressAddress1?, addressAddress2?, addressCityName?, addressGeoPoint?, addressRegionId?, addressPostalCode?, addressRegionName?, addressCountryCode?, description?, details?, href?, type?, subType?, explicit?, durationMilliseconds?, minimumAgeRequirement?, catalogs?, externalUrls?, externalImages?, attributions?, importExternalImages?, userId?, options?): Promise<AxiosResponse<PortfolioItem, any>>
summary Create or update an PortfolioItem
Parameters
- id: string
  The id of the record you wish to retrieve
- OptionalexternalId: string
  The idea from the source third party
- Optionaltitle: string
  The Title
- OptionaladdressCommonName: string
  Common name of the address like Central Park, If we already have this in our db, it will pick that address by default
- OptionaladdressAddress1: string
  Address line 1
- OptionaladdressAddress2: string
  Address line 2
- OptionaladdressCityName: string
  City name
- OptionaladdressGeoPoint: string
  Latitude and Longitude
- OptionaladdressRegionId: number
- OptionaladdressPostalCode: string
  Postal code or ZIP code
- OptionaladdressRegionName: string
  State, region or province
- OptionaladdressCountryCode: string
  Two-letter country code <see href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\">ISO 3166-1 alpha-2</see>
- Optionaldescription: string
  The decription
- Optionaldetails: {
  [key: string]: string;
  }
  A keyed list of other details related to the item such as additional product details
  - [key: string]: string
- Optionalhref: string
  The external href (optional)
- Optionaltype: string
  The type of item audio, video, game, podcast, physical, location, destination, experience, tip-link, invoice
- OptionalsubType: string
  The type of item audio, video, game, podcast, physical, location, destination, experience, tip-link, invoice
- Optionalexplicit: boolean
  True if the content is deemd explicity, otherwise false
- OptionaldurationMilliseconds: number
  Duration in ms
- OptionalminimumAgeRequirement: number
  Minimum age in years if there is an age requirement such as 18+, otherise null or zero
- Optionalcatalogs: CatalogEntryDeets[]
  List of the PortfolioCatalogs this PortfolioItem belongs to
- OptionalexternalUrls: {
  [key: string]: string;
  }
  The external url
  - [key: string]: string
- OptionalexternalImages: ExternalImageDeets[]
  Collection of external images
- Optionalattributions: AttributionDeets[]
  Attributions are the credits or roles attaching Contact items to this PortfolioItem
- OptionalimportExternalImages: boolean
  When set to true Mozaic will import the external images for the portfolio items and raise an 'import_completed' shared event when complete
- OptionaluserId: string
  The user id to operate on their behalf (tenants only)
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PortfolioItem, any>>
Throws
memberof PortfolioApi
- Defined in src/api/api.ts:24159

Class PortfolioApi

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PortfolioApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

createCatalog

Parameters

[key: string]: string

[key: string]: string

Returns Promise<AxiosResponse<PortfolioCatalog, any>>

Throws

createItem

Parameters

[key: string]: string

[key: string]: string

Returns Promise<AxiosResponse<PortfolioItem, any>>

Throws

getCatalogs

Parameters

Returns Promise<AxiosResponse<PortfolioCatalogListResponse, any>>

Throws

getItems

Parameters

Returns Promise<AxiosResponse<PortfolioItemListResponse, any>>

Throws

updateCatalog

Parameters

[key: string]: string

[key: string]: string

Returns Promise<AxiosResponse<PortfolioCatalog, any>>

Throws

updateItem

Parameters

[key: string]: string

[key: string]: string

Returns Promise<AxiosResponse<PortfolioItem, any>>

Throws

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration