Class EpSdkEventApiVersionsServiceClass

Hierarchy

EpSdkVersionServiceClass
- EpSdkEventApiVersionsServiceClass

Index

Constructors

Methods

createEventApiVersion deepCopyLastestVersionById_IfNotExists getEpObjectVersionFromList getLatestEpObjectVersionFromList getLatestVersionForEventApiId getLatestVersionForEventApiName getLatestVersionString getObjectAndVersionListForEventApiVersionIds getVersionByVersion getVersionsForEventApiId getVersionsForEventApiName sortEpObjectVersionListByVersion validateDisplayName

Constructors

constructor

new EpSdkEventApiVersionsServiceClass(): EpSdkEventApiVersionsServiceClass
Returns EpSdkEventApiVersionsServiceClass

Inherited from EpSdkVersionServiceClass.constructor

Methods

createEventApiVersion

createEventApiVersion(__namedParameters: {
    applicationDomainId: string;
    eventApiId: string;
    eventApiVersion: EventApiVersion;
    targetLifecycleStateId: string;
    xContextId?: string;
}): Promise<EventApiVersion>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      eventApiId: string;
      eventApiVersion: EventApiVersion;
      targetLifecycleStateId: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - eventApiId: string
  - eventApiVersion: EventApiVersion
  - targetLifecycleStateId: string
  - Optional xContextId?: string
Returns Promise<EventApiVersion>
- Defined in packages/ep-sdk/src/services/EpSdkEventApiVersionsService.ts:234

deepCopyLastestVersionById_IfNotExists

deepCopyLastestVersionById_IfNotExists(__namedParameters: {
    eventApiName: string;
    fromApplicationDomainId: string;
    fromAssetsApplicationDomainId?: string;
    toApplicationDomainId: string;
    toAssetsApplicationDomainId?: string;
    xContextId?: string;
}): Promise<EventApiVersion>
Conditional deep copy of event api & event api latest version from 'fromApplicationDomain' to 'toApplicationDomain'.
- copies all referenced events, schemas, enums first from 'fromAssetApplicationDomainId' to 'toAssetApplicationDomainId'
- sets 'fromAssetApplicationDomainId' and 'toAssetApplicationDomainId' to 'fromApplicationDomainId' and 'toApplicationDomainId' respectively if not defined.
If an event api version for the event api with 'eventApiName' already exists, returns undefined.

Returns
undefined or created event api version
Parameters
- __namedParameters: {
      eventApiName: string;
      fromApplicationDomainId: string;
      fromAssetsApplicationDomainId?: string;
      toApplicationDomainId: string;
      toAssetsApplicationDomainId?: string;
      xContextId?: string;
  }
  - eventApiName: string
  - fromApplicationDomainId: string
  - Optional fromAssetsApplicationDomainId?: string
  - toApplicationDomainId: string
  - Optional toAssetsApplicationDomainId?: string
  - Optional xContextId?: string
Returns Promise<EventApiVersion>
- Defined in packages/ep-sdk/src/services/EpSdkEventApiVersionsService.ts:305

`Protected` getEpObjectVersionFromList

getEpObjectVersionFromList(__namedParameters: {
epObjectVersionList: any[];
versionString: string;
}): any
Parameters
- __namedParameters: {
  epObjectVersionList: any[];
  versionString: string;
  }
  - epObjectVersionList: any[]
  - versionString: string
Returns any
Inherited from EpSdkVersionServiceClass.getEpObjectVersionFromList
- Defined in packages/ep-sdk/src/services/EpSdkVersionService.ts:44

getLatestEpObjectVersionFromList

getLatestEpObjectVersionFromList(__namedParameters: {
epObjectVersionList: any[];
}): any
Parameters
- __namedParameters: {
  epObjectVersionList: any[];
  }
  - epObjectVersionList: any[]
Returns any
Inherited from EpSdkVersionServiceClass.getLatestEpObjectVersionFromList
- Defined in packages/ep-sdk/src/services/EpSdkVersionService.ts:10

getLatestVersionForEventApiId

getLatestVersionForEventApiId(__namedParameters: {
    applicationDomainId: string;
    eventApiId: string;
    xContextId?: string;
}): Promise<EventApiVersion>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      eventApiId: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - eventApiId: string
  - Optional xContextId?: string
Returns Promise<EventApiVersion>
- Defined in packages/ep-sdk/src/services/EpSdkEventApiVersionsService.ts:206

getLatestVersionForEventApiName

getLatestVersionForEventApiName(__namedParameters: {
    applicationDomainId: string;
    eventApiName: string;
    xContextId?: string;
}): Promise<EventApiVersion>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      eventApiName: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - eventApiName: string
  - Optional xContextId?: string
Returns Promise<EventApiVersion>
- Defined in packages/ep-sdk/src/services/EpSdkEventApiVersionsService.ts:220

getLatestVersionString

getLatestVersionString(__namedParameters: {
eventApiId: string;
xContextId?: string;
}): Promise<string>
Parameters
- __namedParameters: {
  eventApiId: string;
  xContextId?: string;
  }
  - eventApiId: string
  - Optional xContextId?: string
Returns Promise<string>
- Defined in packages/ep-sdk/src/services/EpSdkEventApiVersionsService.ts:186

getObjectAndVersionListForEventApiVersionIds

getObjectAndVersionListForEventApiVersionIds(__namedParameters: {
eventApiVersionIds?: string[];
xContextId?: string;
}): Promise<EpSdkEventApiAndVersion[]>
Retrieves Event API & Version object for a list of version ids.
Parameters
- __namedParameters: {
  eventApiVersionIds?: string[];
  xContextId?: string;
  }
  - Optional eventApiVersionIds?: string[]
  - Optional xContextId?: string
Returns Promise<EpSdkEventApiAndVersion[]>
- Defined in packages/ep-sdk/src/services/EpSdkEventApiVersionsService.ts:57

getVersionByVersion

getVersionByVersion(__namedParameters: {
    eventApiId: string;
    eventApiVersionString: string;
    xContextId?: string;
}): Promise<EventApiVersion>
Parameters
- __namedParameters: {
      eventApiId: string;
      eventApiVersionString: string;
      xContextId?: string;
  }
  - eventApiId: string
  - eventApiVersionString: string
  - Optional xContextId?: string
Returns Promise<EventApiVersion>
- Defined in packages/ep-sdk/src/services/EpSdkEventApiVersionsService.ts:109

getVersionsForEventApiId

getVersionsForEventApiId(__namedParameters: {
    eventApiId: string;
    pageSize?: number;
    xContextId?: string;
}): Promise<EventApiVersion[]>
Parameters
- __namedParameters: {
      eventApiId: string;
      pageSize?: number;
      xContextId?: string;
  }
  - eventApiId: string
  - Optional pageSize?: number
  - Optional xContextId?: string
Returns Promise<EventApiVersion[]>
- Defined in packages/ep-sdk/src/services/EpSdkEventApiVersionsService.ts:127

getVersionsForEventApiName

getVersionsForEventApiName(__namedParameters: {
    applicationDomainId: string;
    eventApiName: string;
    xContextId?: string;
}): Promise<EventApiVersion[]>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      eventApiName: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - eventApiName: string
  - Optional xContextId?: string
Returns Promise<EventApiVersion[]>
- Defined in packages/ep-sdk/src/services/EpSdkEventApiVersionsService.ts:163

sortEpObjectVersionListByVersion

sortEpObjectVersionListByVersion(__namedParameters: {
epObjectVersionList: any[];
}): any
Returns sorted list by version in semVer format. Sorts descending, i.e. latest version is the first element in the returned list.
Parameters
- __namedParameters: {
  epObjectVersionList: any[];
  }
  - epObjectVersionList: any[]
Returns any
Inherited from EpSdkVersionServiceClass.sortEpObjectVersionListByVersion
- Defined in packages/ep-sdk/src/services/EpSdkVersionService.ts:24

validateDisplayName

validateDisplayName(__namedParameters: {
displayName: string;
}): string
Parameters
- __namedParameters: {
  displayName: string;
  }
  - displayName: string
Returns string
- Defined in packages/ep-sdk/src/services/EpSdkEventApiVersionsService.ts:94

Class EpSdkEventApiVersionsServiceClass

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns EpSdkEventApiVersionsServiceClass

Methods

createEventApiVersion

Parameters

__namedParameters: { applicationDomainId: string; eventApiId: string; eventApiVersion: EventApiVersion; targetLifecycleStateId: string; xContextId?: string; }

applicationDomainId: string

eventApiId: string

eventApiVersion: EventApiVersion

targetLifecycleStateId: string

Optional xContextId?: string

Returns Promise<EventApiVersion>

deepCopyLastestVersionById_IfNotExists

Returns

Parameters

__namedParameters: { eventApiName: string; fromApplicationDomainId: string; fromAssetsApplicationDomainId?: string; toApplicationDomainId: string; toAssetsApplicationDomainId?: string; xContextId?: string; }

eventApiName: string

fromApplicationDomainId: string

Optional fromAssetsApplicationDomainId?: string

toApplicationDomainId: string

Optional toAssetsApplicationDomainId?: string

Optional xContextId?: string

Returns Promise<EventApiVersion>

Protected getEpObjectVersionFromList

Parameters

__namedParameters: { epObjectVersionList: any[]; versionString: string; }

epObjectVersionList: any[]

versionString: string

Returns any

getLatestEpObjectVersionFromList

Parameters

__namedParameters: { epObjectVersionList: any[]; }

epObjectVersionList: any[]

Returns any

getLatestVersionForEventApiId

Parameters

__namedParameters: { applicationDomainId: string; eventApiId: string; xContextId?: string; }

applicationDomainId: string

eventApiId: string

Optional xContextId?: string

Returns Promise<EventApiVersion>

getLatestVersionForEventApiName

Parameters

__namedParameters: { applicationDomainId: string; eventApiName: string; xContextId?: string; }

applicationDomainId: string

eventApiName: string

Optional xContextId?: string

Returns Promise<EventApiVersion>

getLatestVersionString

Parameters

__namedParameters: { eventApiId: string; xContextId?: string; }

eventApiId: string

Optional xContextId?: string

Returns Promise<string>

getObjectAndVersionListForEventApiVersionIds

Parameters

__namedParameters: { eventApiVersionIds?: string[]; xContextId?: string; }

Optional eventApiVersionIds?: string[]

Optional xContextId?: string

Returns Promise<EpSdkEventApiAndVersion[]>

getVersionByVersion

Parameters

__namedParameters: { eventApiId: string; eventApiVersionString: string; xContextId?: string; }

eventApiId: string

eventApiVersionString: string

Optional xContextId?: string

Returns Promise<EventApiVersion>

getVersionsForEventApiId

Parameters

__namedParameters: { eventApiId: string; pageSize?: number; xContextId?: string; }

eventApiId: string

Optional pageSize?: number

Optional xContextId?: string

Returns Promise<EventApiVersion[]>

__namedParameters: {
applicationDomainId: string;
eventApiId: string;
eventApiVersion: EventApiVersion;
targetLifecycleStateId: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
eventApiName: string;
fromApplicationDomainId: string;
fromAssetsApplicationDomainId?: string;
toApplicationDomainId: string;
toAssetsApplicationDomainId?: string;
xContextId?: string;
}

`Optional` fromAssetsApplicationDomainId?: string

`Optional` toAssetsApplicationDomainId?: string

`Optional` xContextId?: string

`Protected` getEpObjectVersionFromList

__namedParameters: {
epObjectVersionList: any[];
versionString: string;
}

__namedParameters: {
epObjectVersionList: any[];
}

__namedParameters: {
applicationDomainId: string;
eventApiId: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
applicationDomainId: string;
eventApiName: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
eventApiId: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
eventApiVersionIds?: string[];
xContextId?: string;
}

`Optional` eventApiVersionIds?: string[]

`Optional` xContextId?: string

__namedParameters: {
eventApiId: string;
eventApiVersionString: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
eventApiId: string;
pageSize?: number;
xContextId?: string;
}

`Optional` pageSize?: number

`Optional` xContextId?: string

__namedParameters: {
applicationDomainId: string;
eventApiName: string;
xContextId?: string;
}

`Optional` xContextId?: string

__namedParameters: {
epObjectVersionList: any[];
}

__namedParameters: {
displayName: string;
}