liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
926 lines (925 loc) • 30.6 kB
TypeScript
export type AssetLibrary = {
/**
* Block of actions allowed by the user making the request.
*/
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
/**
* The asset library's key.
*/
assetLibraryKey?: string;
/**
* The asset library's creator user ID.
*/
readonly creatorUserId?: number;
/**
* The asset library's creation date.
*/
readonly dateCreated?: string;
/**
* The last time a field of the asset library changed.
*/
readonly dateModified?: string;
/**
* The asset library's description.
*/
description?: string;
/**
* The localized asset library's description.
*/
description_i18n?: {
[key: string]: string;
};
/**
* The asset library's external reference code.
*/
externalReferenceCode?: string;
/**
* The asset library's ID.
*/
readonly id?: number;
/**
* The asset library's name.
*/
name?: string;
/**
* The localized asset library's name.
*/
name_i18n?: {
[key: string]: string;
};
/**
* The number of this asset library's sites.
*/
readonly numberOfSites?: number;
/**
* The number of this asset library's associated users.
*/
readonly numberOfUserAccounts?: number;
/**
* The number of this asset library's associated user groups.
*/
readonly numberOfUserGroups?: number;
settings?: Settings;
/**
* The asset library's site ID.
*/
readonly siteId?: number;
/**
* The asset library's connected sites.
*/
readonly sites?: Array<Site>;
/**
* The asset library's associated users.
*/
readonly userAccounts?: Array<UserAccount>;
/**
* The asset library's associated user groups.
*/
readonly userGroups?: Array<UserGroup>;
readonly 'x-class-name'?: string;
};
export type Facet = {
facetCriteria?: string;
facetValues?: Array<FacetValue>;
};
export type FacetValue = {
numberOfOccurrences?: number;
term?: string;
};
export type MimeTypeLimit = {
maximumSize?: number;
mimeType?: string;
readonly 'x-class-name'?: string;
};
export type PageAssetLibrary = {
items?: Array<AssetLibrary>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
/**
* The list of roles associated with this user group.
*/
export type Role = {
/**
* The role's external reference code.
*/
readonly externalReferenceCode?: string;
/**
* The role's ID.
*/
readonly id?: number;
/**
* The role's name.
*/
readonly name?: string;
/**
* The localized role's name.
*/
readonly name_i18n?: {
[key: string]: string;
};
/**
* The role's type.
*/
readonly roleType?: number;
readonly 'x-class-name'?: string;
};
/**
* The asset library's settings.
*/
export type Settings = {
autoTaggingEnabled?: boolean;
availableLanguageIds?: Array<string>;
defaultLanguageId?: string;
logoColor?: string;
mimeTypeLimits?: Array<MimeTypeLimit>;
sharingEnabled?: boolean;
useCustomLanguages?: boolean;
readonly 'x-class-name'?: string;
};
export type Site = {
/**
* The site's external reference code.
*/
readonly externalReferenceCode?: string;
/**
* The site's ID.
*/
readonly id?: number;
/**
* The site's logo.
*/
readonly logo?: string;
/**
* The site's name.
*/
readonly name?: string;
readonly name_i18n?: {
[key: string]: string;
};
searchable?: boolean;
readonly 'x-class-name'?: string;
};
export type UserAccount = {
/**
* The user's external reference code
*/
readonly externalReferenceCode?: string;
/**
* The user's ID.
*/
readonly id?: number;
/**
* A relative URL to the user's profile image.
*/
readonly image?: string;
/**
* The user's full name.
*/
readonly name?: string;
/**
* A list of the user's roles.
*/
readonly roles?: Array<Role>;
readonly 'x-class-name'?: string;
};
export type UserGroup = {
/**
* The user group's external reference code.
*/
readonly externalReferenceCode?: string;
/**
* The user group's ID.
*/
readonly id?: number;
/**
* The user group's name.
*/
readonly name?: string;
readonly name_i18n?: {
[key: string]: string;
};
/**
* The number of this user group's associated users.
*/
readonly numberOfUserAccounts?: number;
/**
* The list of roles associated with this user group.
*/
readonly roles?: Array<Role>;
readonly 'x-class-name'?: string;
};
export type PageSite = {
items?: Array<Site>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageUserAccount = {
items?: Array<UserAccount>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageUserGroup = {
items?: Array<UserGroup>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type DeleteAssetLibraryData = {
body?: never;
path: {
assetLibraryId: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/{assetLibraryId}';
};
export type DeleteAssetLibraryResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAssetLibraryData = {
body?: never;
path: {
assetLibraryId: string;
};
query?: {
fields?: string;
nestedFields?: string;
restrictFields?: string;
};
url: '/o/headless-asset-library/v1.0/asset-libraries/{assetLibraryId}';
};
export type GetAssetLibraryResponses = {
/**
* default response
*/
default: AssetLibrary;
};
export type GetAssetLibraryResponse = GetAssetLibraryResponses[keyof GetAssetLibraryResponses];
export type PatchAssetLibraryData = {
body?: AssetLibrary;
path: {
assetLibraryId: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/{assetLibraryId}';
};
export type PatchAssetLibraryResponses = {
/**
* default response
*/
default: AssetLibrary;
};
export type PatchAssetLibraryResponse = PatchAssetLibraryResponses[keyof PatchAssetLibraryResponses];
export type DeleteAssetLibraryBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-asset-library/v1.0/asset-libraries/batch';
};
export type DeleteAssetLibraryBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostAssetLibraryBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-asset-library/v1.0/asset-libraries/batch';
};
export type PostAssetLibraryBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteAssetLibraryByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/by-external-reference-code/{externalReferenceCode}';
};
export type DeleteAssetLibraryByExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAssetLibraryByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
fields?: string;
nestedFields?: string;
restrictFields?: string;
};
url: '/o/headless-asset-library/v1.0/asset-libraries/by-external-reference-code/{externalReferenceCode}';
};
export type GetAssetLibraryByExternalReferenceCodeResponses = {
/**
* default response
*/
default: AssetLibrary;
};
export type GetAssetLibraryByExternalReferenceCodeResponse = GetAssetLibraryByExternalReferenceCodeResponses[keyof GetAssetLibraryByExternalReferenceCodeResponses];
export type PatchAssetLibraryByExternalReferenceCodeData = {
body?: AssetLibrary;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/by-external-reference-code/{externalReferenceCode}';
};
export type PatchAssetLibraryByExternalReferenceCodeResponses = {
/**
* default response
*/
default: AssetLibrary;
};
export type PatchAssetLibraryByExternalReferenceCodeResponse = PatchAssetLibraryByExternalReferenceCodeResponses[keyof PatchAssetLibraryByExternalReferenceCodeResponses];
export type PutAssetLibraryByExternalReferenceCodeData = {
body?: AssetLibrary;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/by-external-reference-code/{externalReferenceCode}';
};
export type PutAssetLibraryByExternalReferenceCodeResponses = {
/**
* default response
*/
default: AssetLibrary;
};
export type PutAssetLibraryByExternalReferenceCodeResponse = PutAssetLibraryByExternalReferenceCodeResponses[keyof PutAssetLibraryByExternalReferenceCodeResponses];
export type DeleteAssetLibraryByExternalReferenceCodePinData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/by-external-reference-code/{externalReferenceCode}/pins';
};
export type DeleteAssetLibraryByExternalReferenceCodePinResponses = {
/**
* default response
*/
default: unknown;
};
export type PutAssetLibraryByExternalReferenceCodePinData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/by-external-reference-code/{externalReferenceCode}/pins';
};
export type PutAssetLibraryByExternalReferenceCodePinResponses = {
/**
* default response
*/
default: AssetLibrary;
};
export type PutAssetLibraryByExternalReferenceCodePinResponse = PutAssetLibraryByExternalReferenceCodePinResponses[keyof PutAssetLibraryByExternalReferenceCodePinResponses];
export type DeleteAssetLibraryPinData = {
body?: never;
path: {
assetLibraryId: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/{assetLibraryId}/pins';
};
export type DeleteAssetLibraryPinResponses = {
/**
* default response
*/
default: unknown;
};
export type PutAssetLibraryPinData = {
body?: never;
path: {
assetLibraryId: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/{assetLibraryId}/pins';
};
export type PutAssetLibraryPinResponses = {
/**
* default response
*/
default: AssetLibrary;
};
export type PutAssetLibraryPinResponse = PutAssetLibraryPinResponses[keyof PutAssetLibraryPinResponses];
export type GetAssetLibrariesPageData = {
body?: never;
path?: never;
query?: {
filter?: string;
keywords?: string;
nestedFields?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
};
url: '/o/headless-asset-library/v1.0/asset-libraries';
};
export type GetAssetLibrariesPageResponses = {
/**
* default response
*/
default: PageAssetLibrary;
};
export type GetAssetLibrariesPageResponse = GetAssetLibrariesPageResponses[keyof GetAssetLibrariesPageResponses];
export type PostAssetLibraryData = {
body?: AssetLibrary;
path?: never;
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries';
};
export type PostAssetLibraryResponses = {
/**
* default response
*/
default: AssetLibrary;
};
export type PostAssetLibraryResponse = PostAssetLibraryResponses[keyof PostAssetLibraryResponses];
export type GetAssetLibrariesPinnedByMePageData = {
body?: never;
path?: never;
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-asset-library/v1.0/asset-libraries/pinned-by-me';
};
export type GetAssetLibrariesPinnedByMePageResponses = {
/**
* default response
*/
default: PageAssetLibrary;
};
export type GetAssetLibrariesPinnedByMePageResponse = GetAssetLibrariesPinnedByMePageResponses[keyof GetAssetLibrariesPinnedByMePageResponses];
export type DeleteAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeData = {
body?: never;
path: {
assetLibraryExternalReferenceCode: string;
siteExternalReferenceCode: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/by-external-reference-code/{assetLibraryExternalReferenceCode}/sites/by-external-reference-code/{siteExternalReferenceCode}';
};
export type DeleteAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeData = {
body?: never;
path: {
assetLibraryExternalReferenceCode: string;
siteExternalReferenceCode: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/by-external-reference-code/{assetLibraryExternalReferenceCode}/sites/by-external-reference-code/{siteExternalReferenceCode}';
};
export type GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeResponses = {
/**
* default response
*/
default: Site;
};
export type GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeResponse = GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeResponses[keyof GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeResponses];
export type PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeData = {
body?: Site;
path: {
assetLibraryExternalReferenceCode: string;
siteExternalReferenceCode: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/by-external-reference-code/{assetLibraryExternalReferenceCode}/sites/by-external-reference-code/{siteExternalReferenceCode}';
};
export type PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeResponses = {
/**
* default response
*/
default: Site;
};
export type PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeResponse = PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeResponses[keyof PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeSiteByExternalReferenceCodeSiteExternalReferenceCodeResponses];
export type DeleteAssetLibrarySiteData = {
body?: never;
path: {
assetLibraryId: string;
siteId: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/{assetLibraryId}/sites/{siteId}';
};
export type DeleteAssetLibrarySiteResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAssetLibrarySiteData = {
body?: never;
path: {
assetLibraryId: string;
siteId: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/{assetLibraryId}/sites/{siteId}';
};
export type GetAssetLibrarySiteResponses = {
/**
* default response
*/
default: Site;
};
export type GetAssetLibrarySiteResponse = GetAssetLibrarySiteResponses[keyof GetAssetLibrarySiteResponses];
export type PutAssetLibrarySiteData = {
body?: Site;
path: {
assetLibraryId: string;
siteId: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/{assetLibraryId}/sites/{siteId}';
};
export type PutAssetLibrarySiteResponses = {
/**
* default response
*/
default: Site;
};
export type PutAssetLibrarySiteResponse = PutAssetLibrarySiteResponses[keyof PutAssetLibrarySiteResponses];
export type GetAssetLibraryByExternalReferenceCodeSitesPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
nestedFields?: string;
page?: string;
pageSize?: string;
};
url: '/o/headless-asset-library/v1.0/asset-libraries/by-external-reference-code/{externalReferenceCode}/sites';
};
export type GetAssetLibraryByExternalReferenceCodeSitesPageResponses = {
/**
* default response
*/
default: PageSite;
};
export type GetAssetLibraryByExternalReferenceCodeSitesPageResponse = GetAssetLibraryByExternalReferenceCodeSitesPageResponses[keyof GetAssetLibraryByExternalReferenceCodeSitesPageResponses];
export type GetAssetLibrarySitesPageData = {
body?: never;
path: {
assetLibraryId: string;
};
query?: {
nestedFields?: string;
page?: string;
pageSize?: string;
};
url: '/o/headless-asset-library/v1.0/asset-libraries/{assetLibraryId}/sites';
};
export type GetAssetLibrarySitesPageResponses = {
/**
* default response
*/
default: PageSite;
};
export type GetAssetLibrarySitesPageResponse = GetAssetLibrarySitesPageResponses[keyof GetAssetLibrarySitesPageResponses];
export type DeleteAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeData = {
body?: never;
path: {
assetLibraryExternalReferenceCode: string;
userExternalReferenceCode: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/by-external-reference-code/{assetLibraryExternalReferenceCode}/user-accounts/by-external-reference-code/{userExternalReferenceCode}';
};
export type DeleteAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeData = {
body?: never;
path: {
assetLibraryExternalReferenceCode: string;
userExternalReferenceCode: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/by-external-reference-code/{assetLibraryExternalReferenceCode}/user-accounts/by-external-reference-code/{userExternalReferenceCode}';
};
export type GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeResponses = {
/**
* default response
*/
default: UserAccount;
};
export type GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeResponse = GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeResponses[keyof GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeResponses];
export type PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeData = {
body?: never;
path: {
assetLibraryExternalReferenceCode: string;
userExternalReferenceCode: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/by-external-reference-code/{assetLibraryExternalReferenceCode}/user-accounts/by-external-reference-code/{userExternalReferenceCode}';
};
export type PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeResponses = {
/**
* default response
*/
default: UserAccount;
};
export type PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeResponse = PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeResponses[keyof PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserAccountByExternalReferenceCodeUserExternalReferenceCodeResponses];
export type DeleteAssetLibraryUserAccountData = {
body?: never;
path: {
assetLibraryId: string;
userId: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/{assetLibraryId}/user-accounts/{userId}';
};
export type DeleteAssetLibraryUserAccountResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAssetLibraryUserAccountData = {
body?: never;
path: {
assetLibraryId: string;
userId: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/{assetLibraryId}/user-accounts/{userId}';
};
export type GetAssetLibraryUserAccountResponses = {
/**
* default response
*/
default: UserAccount;
};
export type GetAssetLibraryUserAccountResponse = GetAssetLibraryUserAccountResponses[keyof GetAssetLibraryUserAccountResponses];
export type PutAssetLibraryUserAccountData = {
body?: never;
path: {
assetLibraryId: string;
userId: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/{assetLibraryId}/user-accounts/{userId}';
};
export type PutAssetLibraryUserAccountResponses = {
/**
* default response
*/
default: UserAccount;
};
export type PutAssetLibraryUserAccountResponse = PutAssetLibraryUserAccountResponses[keyof PutAssetLibraryUserAccountResponses];
export type GetAssetLibraryByExternalReferenceCodeUserAccountsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
keywords?: string;
nestedFields?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
};
url: '/o/headless-asset-library/v1.0/asset-libraries/by-external-reference-code/{externalReferenceCode}/user-accounts';
};
export type GetAssetLibraryByExternalReferenceCodeUserAccountsPageResponses = {
/**
* default response
*/
default: PageUserAccount;
};
export type GetAssetLibraryByExternalReferenceCodeUserAccountsPageResponse = GetAssetLibraryByExternalReferenceCodeUserAccountsPageResponses[keyof GetAssetLibraryByExternalReferenceCodeUserAccountsPageResponses];
export type GetAssetLibraryUserAccountsPageData = {
body?: never;
path: {
assetLibraryId: string;
};
query?: {
keywords?: string;
nestedFields?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
};
url: '/o/headless-asset-library/v1.0/asset-libraries/{assetLibraryId}/user-accounts';
};
export type GetAssetLibraryUserAccountsPageResponses = {
/**
* default response
*/
default: PageUserAccount;
};
export type GetAssetLibraryUserAccountsPageResponse = GetAssetLibraryUserAccountsPageResponses[keyof GetAssetLibraryUserAccountsPageResponses];
export type DeleteAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeData = {
body?: never;
path: {
assetLibraryExternalReferenceCode: string;
userGroupExternalReferenceCode: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/by-external-reference-code/{assetLibraryExternalReferenceCode}/user-groups/by-external-reference-code/{userGroupExternalReferenceCode}';
};
export type DeleteAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeData = {
body?: never;
path: {
assetLibraryExternalReferenceCode: string;
userGroupExternalReferenceCode: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/by-external-reference-code/{assetLibraryExternalReferenceCode}/user-groups/by-external-reference-code/{userGroupExternalReferenceCode}';
};
export type GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeResponses = {
/**
* default response
*/
default: UserGroup;
};
export type GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeResponse = GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeResponses[keyof GetAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeResponses];
export type PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeData = {
body?: never;
path: {
assetLibraryExternalReferenceCode: string;
userGroupExternalReferenceCode: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/by-external-reference-code/{assetLibraryExternalReferenceCode}/user-groups/by-external-reference-code/{userGroupExternalReferenceCode}';
};
export type PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeResponses = {
/**
* default response
*/
default: UserGroup;
};
export type PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeResponse = PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeResponses[keyof PutAssetLibraryByExternalReferenceCodeAssetLibraryExternalReferenceCodeUserGroupByExternalReferenceCodeUserGroupExternalReferenceCodeResponses];
export type DeleteAssetLibraryUserGroupData = {
body?: never;
path: {
assetLibraryId: string;
userGroupId: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/{assetLibraryId}/user-groups/{userGroupId}';
};
export type DeleteAssetLibraryUserGroupResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAssetLibraryUserGroupData = {
body?: never;
path: {
assetLibraryId: string;
userGroupId: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/{assetLibraryId}/user-groups/{userGroupId}';
};
export type GetAssetLibraryUserGroupResponses = {
/**
* default response
*/
default: UserGroup;
};
export type GetAssetLibraryUserGroupResponse = GetAssetLibraryUserGroupResponses[keyof GetAssetLibraryUserGroupResponses];
export type PutAssetLibraryUserGroupData = {
body?: never;
path: {
assetLibraryId: string;
userGroupId: string;
};
query?: never;
url: '/o/headless-asset-library/v1.0/asset-libraries/{assetLibraryId}/user-groups/{userGroupId}';
};
export type PutAssetLibraryUserGroupResponses = {
/**
* default response
*/
default: UserGroup;
};
export type PutAssetLibraryUserGroupResponse = PutAssetLibraryUserGroupResponses[keyof PutAssetLibraryUserGroupResponses];
export type GetAssetLibraryByExternalReferenceCodeUserGroupsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
keywords?: string;
nestedFields?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
};
url: '/o/headless-asset-library/v1.0/asset-libraries/by-external-reference-code/{externalReferenceCode}/user-groups';
};
export type GetAssetLibraryByExternalReferenceCodeUserGroupsPageResponses = {
/**
* default response
*/
default: PageUserGroup;
};
export type GetAssetLibraryByExternalReferenceCodeUserGroupsPageResponse = GetAssetLibraryByExternalReferenceCodeUserGroupsPageResponses[keyof GetAssetLibraryByExternalReferenceCodeUserGroupsPageResponses];
export type GetAssetLibraryUserGroupsPageData = {
body?: never;
path: {
assetLibraryId: string;
};
query?: {
keywords?: string;
nestedFields?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
};
url: '/o/headless-asset-library/v1.0/asset-libraries/{assetLibraryId}/user-groups';
};
export type GetAssetLibraryUserGroupsPageResponses = {
/**
* default response
*/
default: PageUserGroup;
};
export type GetAssetLibraryUserGroupsPageResponse = GetAssetLibraryUserGroupsPageResponses[keyof GetAssetLibraryUserGroupsPageResponses];
export type ClientOptions = {
baseUrl: 'http://localhost:8080' | (string & {});
};