Class EpSdkSchemasServiceClass

Hierarchy

EpSdkServiceClass
- EpSdkSchemasServiceClass

Index

Constructors

constructor

Methods

deleteById deleteByName getById getByName setCustomAttributes updateSchema

Constructors

constructor

new EpSdkSchemasServiceClass(): EpSdkSchemasServiceClass
Returns EpSdkSchemasServiceClass

Inherited from EpSdkServiceClass.constructor

Methods

deleteById

deleteById(__namedParameters: {
    applicationDomainId: string;
    schemaId: string;
    xContextId?: string;
}): Promise<SchemaObject>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      schemaId: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - schemaId: string
  - Optional xContextId?: string
Returns Promise<SchemaObject>
- Defined in packages/ep-sdk/src/services/EpSdkSchemasService.ts:129

deleteByName

deleteByName(__namedParameters: {
    applicationDomainId: string;
    schemaName: string;
    xContextId?: string;
}): Promise<SchemaObject>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      schemaName: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - schemaName: string
  - Optional xContextId?: string
Returns Promise<SchemaObject>
- Defined in packages/ep-sdk/src/services/EpSdkSchemasService.ts:140

getById

getById(__namedParameters: {
schemaId: string;
xContextId?: string;
}): Promise<SchemaObject>
Parameters
- __namedParameters: {
  schemaId: string;
  xContextId?: string;
  }
  - schemaId: string
  - Optional xContextId?: string
Returns Promise<SchemaObject>
- Defined in packages/ep-sdk/src/services/EpSdkSchemasService.ts:106

getByName

getByName(__namedParameters: {
    applicationDomainId: string;
    schemaName: string;
    xContextId?: string;
}): Promise<SchemaObject>
Parameters
- __namedParameters: {
      applicationDomainId: string;
      schemaName: string;
      xContextId?: string;
  }
  - applicationDomainId: string
  - schemaName: string
  - Optional xContextId?: string
Returns Promise<SchemaObject>
- Defined in packages/ep-sdk/src/services/EpSdkSchemasService.ts:82

setCustomAttributes

setCustomAttributes(__namedParameters: {
    epSdkCustomAttributes: TEpSdkCustomAttribute[];
    schemaId: string;
    xContextId?: string;
}): Promise<SchemaObject>
Sets the custom attributes in the list on the event api product. Creates attribute definitions / adds entity type 'eventApiProduct' if it doesn't exist.
Parameters
- __namedParameters: {
      epSdkCustomAttributes: TEpSdkCustomAttribute[];
      schemaId: string;
      xContextId?: string;
  }
  - epSdkCustomAttributes: TEpSdkCustomAttribute[]
  - schemaId: string
  - Optional xContextId?: string
Returns Promise<SchemaObject>
- Defined in packages/ep-sdk/src/services/EpSdkSchemasService.ts:61

`Private` updateSchema

updateSchema(__namedParameters: {
update: SchemaObject;
xContextId?: string;
}): Promise<SchemaObject>
Parameters
- __namedParameters: {
  update: SchemaObject;
  xContextId?: string;
  }
  - update: SchemaObject
  - Optional xContextId?: string
Returns Promise<SchemaObject>
- Defined in packages/ep-sdk/src/services/EpSdkSchemasService.ts:35

Class EpSdkSchemasServiceClass

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns EpSdkSchemasServiceClass

Methods

deleteById

Parameters

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

applicationDomainId: string

schemaId: string

Optional xContextId?: string

Returns Promise<SchemaObject>

deleteByName

Parameters

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

applicationDomainId: string

schemaName: string

Optional xContextId?: string

Returns Promise<SchemaObject>

getById

Parameters

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

schemaId: string

Optional xContextId?: string

Returns Promise<SchemaObject>

getByName

Parameters

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

applicationDomainId: string

schemaName: string

Optional xContextId?: string

Returns Promise<SchemaObject>

setCustomAttributes

Parameters

__namedParameters: { epSdkCustomAttributes: TEpSdkCustomAttribute[]; schemaId: string; xContextId?: string; }

epSdkCustomAttributes: TEpSdkCustomAttribute[]

schemaId: string

Optional xContextId?: string

Returns Promise<SchemaObject>

Private updateSchema

Parameters

__namedParameters: { update: SchemaObject; xContextId?: string; }

update: SchemaObject

Optional xContextId?: string

Returns Promise<SchemaObject>

Settings

Member Visibility

Theme

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

`Optional` xContextId?: string

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

`Optional` xContextId?: string

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

`Optional` xContextId?: string

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

`Optional` xContextId?: string

__namedParameters: {
epSdkCustomAttributes: TEpSdkCustomAttribute[];
schemaId: string;
xContextId?: string;
}

`Optional` xContextId?: string

`Private` updateSchema

__namedParameters: {
update: SchemaObject;
xContextId?: string;
}

`Optional` xContextId?: string