liferay-headless-rest-client/dist/clients/analytics-settings-rest-v1.0/types.gen.d.ts

A collection of Headless Clients used in Liferay Portal

export type Channel={channelId?:string;commerceSyncEnabled?:boolean;createDate?:string;dataSources?:Array<DataSource>;name?:string;readonly'x-class-name'?:string;};export type DataSource={commerceChannelIds?:Array<number>;dataSourceId?:string;siteIds?:Array<number>;readonly'x-class-name'?:string;};export type Facet={facetCriteria?:string;facetValues?:Array<FacetValue>;};export type FacetValue={numberOfOccurrences?:number;term?:string;};export type PageChannel={items?:Array<Channel>;lastPage?:number;totalCount?:number;actions?:{[key:string]:{[key:string]:string;};};facets?:Array<Facet>;page?:number;pageSize?:number;};export type CommerceChannel={channelName?:string;id?:number;name?:string;siteName?:string;readonly'x-class-name'?:string;};export type PageCommerceChannel={items?:Array<CommerceChannel>;lastPage?:number;totalCount?:number;actions?:{[key:string]:{[key:string]:string;};};facets?:Array<Facet>;page?:number;pageSize?:number;};export type ContactAccountGroup={id?:number;name?:string;selected?:boolean;readonly'x-class-name'?:string;};export type PageContactAccountGroup={items?:Array<ContactAccountGroup>;lastPage?:number;totalCount?:number;actions?:{[key:string]:{[key:string]:string;};};facets?:Array<Facet>;page?:number;pageSize?:number;};export type ContactConfiguration={syncAllAccounts?:boolean;syncAllContacts?:boolean;syncedAccountGroupIds?:Array<string>;syncedOrganizationIds?:Array<string>;syncedUserGroupIds?:Array<string>;readonly'x-class-name'?:string;};export type ContactOrganization={id?:number;name?:string;selected?:boolean;readonly'x-class-name'?:string;};export type PageContactOrganization={items?:Array<ContactOrganization>;lastPage?:number;totalCount?:number;actions?:{[key:string]:{[key:string]:string;};};facets?:Array<Facet>;page?:number;pageSize?:number;};export type ContactUserGroup={id?:number;name?:string;selected?:boolean;readonly'x-class-name'?:string;};export type PageContactUserGroup={items?:Array<ContactUserGroup>;lastPage?:number;totalCount?:number;actions?:{[key:string]:{[key:string]:string;};};facets?:Array<Facet>;page?:number;pageSize?:number;};export type DataSourceLiferayAnalyticsUrl={liferayAnalyticsURL?:string;readonly'x-class-name'?:string;};export type DataSourceToken={token?:string;readonly'x-class-name'?:string;};export type Field={example?:string;name?:string;required?:boolean;selected?:boolean;source?:string;type?:string;readonly'x-class-name'?:string;};export type PageField={items?:Array<Field>;lastPage?:number;totalCount?:number;actions?:{[key:string]:{[key:string]:string;};};facets?:Array<Facet>;page?:number;pageSize?:number;};export type FieldSummary={account?:number;order?:number;people?:number;product?:number;readonly'x-class-name'?:string;};export type RecommendationConfiguration={contentRecommenderMostPopularItems?:RecommendationItem;contentRecommenderUserPersonalization?:RecommendationItem;readonly'x-class-name'?:string;};export type RecommendationItem={enabled?:boolean;readonly'x-class-name'?:string;status?:'Configuring'|'Disabled'|'Enabled'|'Failed';};export type PageSite={items?:Array<Site>;lastPage?:number;totalCount?:number;actions?:{[key:string]:{[key:string]:string;};};facets?:Array<Facet>;page?:number;pageSize?:number;};export type Site={channelName?:string;friendlyURL?:string;id?:number;name?:string;readonly'x-class-name'?:string;};export type PostConfigurationWizardModeData={body?:never;path?:never;query?:never;url:'/o/analytics-settings-rest/v1.0/configuration/wizard-mode';};export type PostConfigurationWizardModeResponses={default:unknown;};export type GetChannelsPageData={body?:never;path?:never;query?:{keywords?:string;page?:string;pageSize?:string;sort?:string;nestedFields?:string;};url:'/o/analytics-settings-rest/v1.0/channels';};export type GetChannelsPageResponses={default:PageChannel;};export type GetChannelsPageResponse=GetChannelsPageResponses[keyof GetChannelsPageResponses];export type PatchChannelData={body?:Channel;path?:never;query?:never;url:'/o/analytics-settings-rest/v1.0/channels';};export type PatchChannelResponses={default:Channel;};export type PatchChannelResponse=PatchChannelResponses[keyof PatchChannelResponses];export type PostChannelData={body?:Channel;path?:never;query?:never;url:'/o/analytics-settings-rest/v1.0/channels';};export type PostChannelResponses={default:Channel;};export type PostChannelResponse=PostChannelResponses[keyof PostChannelResponses];export type GetCommerceChannelsPageData={body?:never;path?:never;query?:{keywords?:string;page?:string;pageSize?:string;sort?:string;nestedFields?:string;};url:'/o/analytics-settings-rest/v1.0/commerce-channels';};export type GetCommerceChannelsPageResponses={default:PageCommerceChannel;};export type GetCommerceChannelsPageResponse=GetCommerceChannelsPageResponses[keyof GetCommerceChannelsPageResponses];export type GetContactAccountGroupsPageData={body?:never;path?:never;query?:{keywords?:string;page?:string;pageSize?:string;sort?:string;nestedFields?:string;};url:'/o/analytics-settings-rest/v1.0/contacts/account-groups';};export type GetContactAccountGroupsPageResponses={default:PageContactAccountGroup;};export type GetContactAccountGroupsPageResponse=GetContactAccountGroupsPageResponses[keyof GetContactAccountGroupsPageResponses];export type GetContactConfigurationData={body?:never;path?:never;query?:never;url:'/o/analytics-settings-rest/v1.0/contacts/configuration';};export type GetContactConfigurationResponses={default:ContactConfiguration;};export type GetContactConfigurationResponse=GetContactConfigurationResponses[keyof GetContactConfigurationResponses];export type PutContactConfigurationData={body?:ContactConfiguration;path?:never;query?:never;url:'/o/analytics-settings-rest/v1.0/contacts/configuration';};export type PutContactConfigurationResponses={default:unknown;};export type GetContactOrganizationsPageData={body?:never;path?:never;query?:{keywords?:string;page?:string;pageSize?:string;sort?:string;nestedFields?:string;};url:'/o/analytics-settings-rest/v1.0/contacts/organizations';};export type GetContactOrganizationsPageResponses={default:PageContactOrganization;};export type GetContactOrganizationsPageResponse=GetContactOrganizationsPageResponses[keyof GetContactOrganizationsPageResponses];export type GetContactUserGroupsPageData={body?:never;path?:never;query?:{keywords?:string;page?:string;pageSize?:string;sort?:string;nestedFields?:string;};url:'/o/analytics-settings-rest/v1.0/contacts/user-groups';};export type GetContactUserGroupsPageResponses={default:PageContactUserGroup;};export type GetContactUserGroupsPageResponse=GetContactUserGroupsPageResponses[keyof GetContactUserGroupsPageResponses];export type DeleteDataSourceData={body?:never;path?:never;query?:never;url:'/o/analytics-settings-rest/v1.0/data-sources';};export type DeleteDataSourceResponses={default:unknown;};export type PostDataSourceData={body?:DataSourceToken;path?:never;query?:never;url:'/o/analytics-settings-rest/v1.0/data-sources';};export type PostDataSourceResponses={default:DataSourceLiferayAnalyticsUrl;};export type PostDataSourceResponse=PostDataSourceResponses[keyof PostDataSourceResponses];export type GetFieldsAccountsPageData={body?:never;path?:never;query?:{keyword?:string;page?:string;pageSize?:string;sort?:string;nestedFields?:string;};url:'/o/analytics-settings-rest/v1.0/fields/accounts';};export type GetFieldsAccountsPageResponses={default:PageField;};export type GetFieldsAccountsPageResponse=GetFieldsAccountsPageResponses[keyof GetFieldsAccountsPageResponses];export type PatchFieldAccountData={body?:Array<Field>;path?:never;query?:never;url:'/o/analytics-settings-rest/v1.0/fields/accounts';};export type PatchFieldAccountResponses={default:unknown;};export type GetFieldsOrdersPageData={body?:never;path?:never;query?:{keyword?:string;page?:string;pageSize?:string;sort?:string;nestedFields?:string;};url:'/o/analytics-settings-rest/v1.0/fields/orders';};export type GetFieldsOrdersPageResponses={default:PageField;};export type GetFieldsOrdersPageResponse=GetFieldsOrdersPageResponses[keyof GetFieldsOrdersPageResponses];export type PatchFieldOrderData={body?:Array<Field>;path?:never;query?:never;url:'/o/analytics-settings-rest/v1.0/fields/orders';};export type PatchFieldOrderResponses={default:unknown;};export type GetFieldsPeoplePageData={body?:never;path?:never;query?:{keyword?:string;page?:string;pageSize?:string;sort?:string;nestedFields?:string;};url:'/o/analytics-settings-rest/v1.0/fields/people';};export type GetFieldsPeoplePageResponses={default:PageField;};export type GetFieldsPeoplePageResponse=GetFieldsPeoplePageResponses[keyof GetFieldsPeoplePageResponses];export type PatchFieldPeopleData={body?:Array<Field>;path?:never;query?:never;url:'/o/analytics-settings-rest/v1.0/fields/people';};export type PatchFieldPeopleResponses={default:unknown;};export type GetFieldsProductsPageData={body?:never;path?:never;query?:{keyword?:string;page?:string;pageSize?:string;sort?:string;nestedFields?:string;};url:'/o/analytics-settings-rest/v1.0/fields/products';};export type GetFieldsProductsPageResponses={default:PageField;};export type GetFieldsProductsPageResponse=GetFieldsProductsPageResponses[keyof GetFieldsProductsPageResponses];export type PatchFieldProductData={body?:Array<Field>;path?:never;query?:never;url:'/o/analytics-settings-rest/v1.0/fields/products';};export type PatchFieldProductResponses={default:unknown;};export type GetFieldData={body?:never;path?:never;query?:never;url:'/o/analytics-settings-rest/v1.0/fields';};export type GetFieldResponses={default:FieldSummary;};export type GetFieldResponse=GetFieldResponses[keyof GetFieldResponses];export type GetRecommendationConfigurationData={body?:never;path?:never;query?:never;url:'/o/analytics-settings-rest/v1.0/recommendation/configuration';};export type GetRecommendationConfigurationResponses={default:RecommendationConfiguration;};export type GetRecommendationConfigurationResponse=GetRecommendationConfigurationResponses[keyof GetRecommendationConfigurationResponses];export type PutRecommendationConfigurationData={body?:RecommendationConfiguration;path?:never;query?:never;url:'/o/analytics-settings-rest/v1.0/recommendation/configuration';};export type PutRecommendationConfigurationResponses={default:unknown;};export type GetSitesPageData={body?:never;path?:never;query?:{keywords?:string;page?:string;pageSize?:string;sort?:string;nestedFields?:string;};url:'/o/analytics-settings-rest/v1.0/sites';};export type GetSitesPageResponses={default:PageSite;};export type GetSitesPageResponse=GetSitesPageResponses[keyof GetSitesPageResponses];export type ClientOptions={baseUrl:'http://localhost:8080'|(string&{});};