Skip to content
Snippets Groups Projects
Commit 1b961aaa authored by Labros Papadopoulos's avatar Labros Papadopoulos
Browse files

tmf API 674 - Geographic Site Management

parent 7110881e
Branches
1 merge request!11Party registration workflow
Pipeline #6006 failed with stage
in 2 minutes and 33 seconds
Showing
with 792 additions and 0 deletions
import { HttpParameterCodec } from '@angular/common/http';
import { Param } from './param';
export interface ConfigurationParameters {
/**
* @deprecated Since 5.0. Use credentials instead
*/
apiKeys?: {[ key: string ]: string};
username?: string;
password?: string;
/**
* @deprecated Since 5.0. Use credentials instead
*/
accessToken?: string | (() => string);
basePath?: string;
withCredentials?: boolean;
/**
* Takes care of encoding query- and form-parameters.
*/
encoder?: HttpParameterCodec;
/**
* Override the default method for encoding path parameters in various
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-values">styles</a>.
* <p>
* See {@link README.md} for more details
* </p>
*/
encodeParam?: (param: Param) => string;
/**
* The keys are the names in the securitySchemes section of the OpenAPI
* document. They should map to the value used for authentication
* minus any standard prefixes such as 'Basic' or 'Bearer'.
*/
credentials?: {[ key: string ]: string | (() => string | undefined)};
}
export class Configuration {
/**
* @deprecated Since 5.0. Use credentials instead
*/
apiKeys?: {[ key: string ]: string};
username?: string;
password?: string;
/**
* @deprecated Since 5.0. Use credentials instead
*/
accessToken?: string | (() => string);
basePath?: string;
withCredentials?: boolean;
/**
* Takes care of encoding query- and form-parameters.
*/
encoder?: HttpParameterCodec;
/**
* Encoding of various path parameter
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-values">styles</a>.
* <p>
* See {@link README.md} for more details
* </p>
*/
encodeParam: (param: Param) => string;
/**
* The keys are the names in the securitySchemes section of the OpenAPI
* document. They should map to the value used for authentication
* minus any standard prefixes such as 'Basic' or 'Bearer'.
*/
credentials: {[ key: string ]: string | (() => string | undefined)};
constructor(configurationParameters: ConfigurationParameters = {}) {
this.apiKeys = configurationParameters.apiKeys;
this.username = configurationParameters.username;
this.password = configurationParameters.password;
this.accessToken = configurationParameters.accessToken;
this.basePath = configurationParameters.basePath;
this.withCredentials = configurationParameters.withCredentials;
this.encoder = configurationParameters.encoder;
if (configurationParameters.encodeParam) {
this.encodeParam = configurationParameters.encodeParam;
}
else {
this.encodeParam = param => this.defaultEncodeParam(param);
}
if (configurationParameters.credentials) {
this.credentials = configurationParameters.credentials;
}
else {
this.credentials = {};
}
}
/**
* Select the correct content-type to use for a request.
* Uses {@link Configuration#isJsonMime} to determine the correct content-type.
* If no content type is found return the first found type if the contentTypes is not empty
* @param contentTypes - the array of content types that are available for selection
* @returns the selected content-type or <code>undefined</code> if no selection could be made.
*/
public selectHeaderContentType (contentTypes: string[]): string | undefined {
if (contentTypes.length === 0) {
return undefined;
}
const type = contentTypes.find((x: string) => this.isJsonMime(x));
if (type === undefined) {
return contentTypes[0];
}
return type;
}
/**
* Select the correct accept content-type to use for a request.
* Uses {@link Configuration#isJsonMime} to determine the correct accept content-type.
* If no content type is found return the first found type if the contentTypes is not empty
* @param accepts - the array of content types that are available for selection.
* @returns the selected content-type or <code>undefined</code> if no selection could be made.
*/
public selectHeaderAccept(accepts: string[]): string | undefined {
if (accepts.length === 0) {
return undefined;
}
const type = accepts.find((x: string) => this.isJsonMime(x));
if (type === undefined) {
return accepts[0];
}
return type;
}
/**
* Check if the given MIME is a JSON MIME.
* JSON MIME examples:
* application/json
* application/json; charset=UTF8
* APPLICATION/JSON
* application/vnd.company+json
* @param mime - MIME (Multipurpose Internet Mail Extensions)
* @return True if the given MIME is JSON, false otherwise.
*/
public isJsonMime(mime: string): boolean {
const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
}
public lookupCredential(key: string): string | undefined {
const value = this.credentials[key];
return typeof value === 'function'
? value()
: value;
}
private defaultEncodeParam(param: Param): string {
// This implementation exists as fallback for missing configuration
// and for backwards compatibility to older typescript-angular generator versions.
// It only works for the 'simple' parameter style.
// Date-handling only works for the 'date-time' format.
// All other styles and Date-formats are probably handled incorrectly.
//
// But: if that's all you need (i.e.: the most common use-case): no need for customization!
const value = param.dataFormat === 'date-time' && param.value instanceof Date
? (param.value as Date).toISOString()
: param.value;
return encodeURIComponent(String(value));
}
export class ApiConfiguration {
rootUrl: string = '//portal.openslice.io/osapi';
}
}
import { NgModule, ModuleWithProviders, SkipSelf, Optional } from '@angular/core';
import { Configuration } from './configuration';
import { HttpClient } from '@angular/common/http';
@NgModule({
imports: [],
declarations: [],
exports: [],
providers: []
})
export class ApiModule {
public static forRoot(configurationFactory: () => Configuration): ModuleWithProviders<ApiModule> {
return {
ngModule: ApiModule,
providers: [ { provide: Configuration, useFactory: configurationFactory } ]
};
}
constructor( @Optional() @SkipSelf() parentModule: ApiModule,
@Optional() http: HttpClient) {
if (parentModule) {
throw new Error('ApiModule is already loaded. Import in your base AppModule only.');
}
if (!http) {
throw new Error('You need to import the HttpClientModule in your AppModule! \n' +
'See also https://github.com/angular/angular/issues/20575');
}
}
}
import { HttpParameterCodec } from '@angular/common/http';
/**
* Custom HttpParameterCodec
* Workaround for https://github.com/angular/angular/issues/18261
*/
export class CustomHttpParameterCodec implements HttpParameterCodec {
encodeKey(k: string): string {
return encodeURIComponent(k);
}
encodeValue(v: string): string {
return encodeURIComponent(v);
}
decodeKey(k: string): string {
return decodeURIComponent(k);
}
decodeValue(v: string): string {
return decodeURIComponent(v);
}
}
export * from './api/api';
export * from './model/models';
export * from './variables';
export * from './configuration';
export * from './api.module';
export * from './param';
/**
* Geographic Site Management
* ** TMF API Reference : TMF 674 - Place - Geographic Site Management ### August 2021 This API covers the operations to manage (create, read, delete) sites that can be associated to a customer, an account, a service delivery or other entities. It defines a Site as a convenience class that allows to easily refer to places important to other entities, where a geographic place is the entity that can answer the question “where?”, allowing to determine where things are in relation to the earth\'s surface, and can be represented either in a textual structured way (geographic address) or as a geometry referred to a spatial reference system (geographic location). ### Resources - GeographicSite - Hub ### Operations Geographic Site API performs the following operations : - Retrieve a geographic site or a collection of geographic sites - Create a new site - Update a geographic site - Delete a geographic site - Notify events on geographic site Copyright © TM Forum 2021. All Rights Reserved
*
* The version of the OpenAPI document: 5.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Base schema for adressable entities
*/
export interface Addressable {
/**
* Hyperlink reference
*/
href: string;
/**
* unique identifier
*/
id: string;
}
/**
* Geographic Site Management
* ** TMF API Reference : TMF 674 - Place - Geographic Site Management ### August 2021 This API covers the operations to manage (create, read, delete) sites that can be associated to a customer, an account, a service delivery or other entities. It defines a Site as a convenience class that allows to easily refer to places important to other entities, where a geographic place is the entity that can answer the question “where?”, allowing to determine where things are in relation to the earth\'s surface, and can be represented either in a textual structured way (geographic address) or as a geometry referred to a spatial reference system (geographic location). ### Resources - GeographicSite - Hub ### Operations Geographic Site API performs the following operations : - Retrieve a geographic site or a collection of geographic sites - Create a new site - Update a geographic site - Delete a geographic site - Notify events on geographic site Copyright © TM Forum 2021. All Rights Reserved
*
* The version of the OpenAPI document: 5.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { Entity } from './entity';
export interface BaseEvent extends Entity {
event?: object;
/**
* The identifier of the notification.
*/
eventId?: string;
/**
* Time of the event occurrence.
*/
eventTime?: string;
/**
* The type of the notification.
*/
eventType?: string;
/**
* The correlation id for this event.
*/
correlationId?: string;
/**
* The domain of the event.
*/
domain?: string;
/**
* The title of the event.
*/
title?: string;
/**
* An explanatory of the event.
*/
description?: string;
/**
* A priority.
*/
priority?: string;
/**
* The time the event occured.
*/
timeOcurred?: string;
}
/**
* Geographic Site Management
* ** TMF API Reference : TMF 674 - Place - Geographic Site Management ### August 2021 This API covers the operations to manage (create, read, delete) sites that can be associated to a customer, an account, a service delivery or other entities. It defines a Site as a convenience class that allows to easily refer to places important to other entities, where a geographic place is the entity that can answer the question “where?”, allowing to determine where things are in relation to the earth\'s surface, and can be represented either in a textual structured way (geographic address) or as a geometry referred to a spatial reference system (geographic location). ### Resources - GeographicSite - Hub ### Operations Geographic Site API performs the following operations : - Retrieve a geographic site or a collection of geographic sites - Create a new site - Update a geographic site - Delete a geographic site - Notify events on geographic site Copyright © TM Forum 2021. All Rights Reserved
*
* The version of the OpenAPI document: 5.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { HourPeriod } from './hourPeriod';
export interface CalendarPeriod {
/**
* A URI to a JSON-Schema file that defines additional attributes and relationships
*/
schemaLocation?: string;
/**
* When sub-classing, this defines the super-class
*/
baseType?: string;
/**
* When sub-classing, this defines the sub-class Extensible name
*/
type?: string;
/**
* Hyperlink reference to the calendar period
*/
href?: string;
/**
* unique identifier of the calendar period
*/
id?: string;
/**
* Day where the calendar status applies (e.g.: monday, mon-to-fri, weekdays, weekend, all week, ...)
*/
day?: string;
/**
* Indication of the timezone applicable to the calendar information (e.g.: Paris, GMT+1)
*/
timeZone?: string;
hourPeriod?: Array<HourPeriod>;
/**
* Indication of the availability of the caledar period (e.g.: available, booked, etc.)
*/
status: string;
}
/**
* Geographic Site Management
* ** TMF API Reference : TMF 674 - Place - Geographic Site Management ### August 2021 This API covers the operations to manage (create, read, delete) sites that can be associated to a customer, an account, a service delivery or other entities. It defines a Site as a convenience class that allows to easily refer to places important to other entities, where a geographic place is the entity that can answer the question “where?”, allowing to determine where things are in relation to the earth\'s surface, and can be represented either in a textual structured way (geographic address) or as a geometry referred to a spatial reference system (geographic location). ### Resources - GeographicSite - Hub ### Operations Geographic Site API performs the following operations : - Retrieve a geographic site or a collection of geographic sites - Create a new site - Update a geographic site - Delete a geographic site - Notify events on geographic site Copyright © TM Forum 2021. All Rights Reserved
*
* The version of the OpenAPI document: 5.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
export interface Entity {
/**
* Hyperlink reference
*/
href: string;
/**
* unique identifier
*/
id: string;
/**
* When sub-classing, this defines the sub-class Extensible name
*/
type: string;
/**
* When sub-classing, this defines the super-class
*/
baseType?: string;
/**
* A URI to a JSON-Schema file that defines additional attributes and relationships
*/
schemaLocation?: string;
}
/**
* Geographic Site Management
* ** TMF API Reference : TMF 674 - Place - Geographic Site Management ### August 2021 This API covers the operations to manage (create, read, delete) sites that can be associated to a customer, an account, a service delivery or other entities. It defines a Site as a convenience class that allows to easily refer to places important to other entities, where a geographic place is the entity that can answer the question “where?”, allowing to determine where things are in relation to the earth\'s surface, and can be represented either in a textual structured way (geographic address) or as a geometry referred to a spatial reference system (geographic location). ### Resources - GeographicSite - Hub ### Operations Geographic Site API performs the following operations : - Retrieve a geographic site or a collection of geographic sites - Create a new site - Update a geographic site - Delete a geographic site - Notify events on geographic site Copyright © TM Forum 2021. All Rights Reserved
*
* The version of the OpenAPI document: 5.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Entity reference schema to be use for all entityRef class.
*/
export interface EntityRef {
/**
* Hyperlink reference
*/
href?: string;
}
/**
* Geographic Site Management
* ** TMF API Reference : TMF 674 - Place - Geographic Site Management ### August 2021 This API covers the operations to manage (create, read, delete) sites that can be associated to a customer, an account, a service delivery or other entities. It defines a Site as a convenience class that allows to easily refer to places important to other entities, where a geographic place is the entity that can answer the question “where?”, allowing to determine where things are in relation to the earth\'s surface, and can be represented either in a textual structured way (geographic address) or as a geometry referred to a spatial reference system (geographic location). ### Resources - GeographicSite - Hub ### Operations Geographic Site API performs the following operations : - Retrieve a geographic site or a collection of geographic sites - Create a new site - Update a geographic site - Delete a geographic site - Notify events on geographic site Copyright © TM Forum 2021. All Rights Reserved
*
* The version of the OpenAPI document: 5.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Sets the communication endpoint address the service instance must use to deliver notification information
*/
export interface EventSubscription {
/**
* Id of the listener
*/
id: string;
/**
* The callback being registered.
*/
callback: string;
/**
* additional data to be passed
*/
query?: string;
}
/**
* Geographic Site Management
* ** TMF API Reference : TMF 674 - Place - Geographic Site Management ### August 2021 This API covers the operations to manage (create, read, delete) sites that can be associated to a customer, an account, a service delivery or other entities. It defines a Site as a convenience class that allows to easily refer to places important to other entities, where a geographic place is the entity that can answer the question “where?”, allowing to determine where things are in relation to the earth\'s surface, and can be represented either in a textual structured way (geographic address) or as a geometry referred to a spatial reference system (geographic location). ### Resources - GeographicSite - Hub ### Operations Geographic Site API performs the following operations : - Retrieve a geographic site or a collection of geographic sites - Create a new site - Update a geographic site - Delete a geographic site - Notify events on geographic site Copyright © TM Forum 2021. All Rights Reserved
*
* The version of the OpenAPI document: 5.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Sets the communication endpoint address the service instance must use to deliver notification information
*/
export interface EventSubscriptionInput {
/**
* The callback being registered.
*/
callback: string;
/**
* additional data to be passed
*/
query?: string;
}
/**
* Geographic Site Management
* ** TMF API Reference : TMF 674 - Place - Geographic Site Management ### August 2021 This API covers the operations to manage (create, read, delete) sites that can be associated to a customer, an account, a service delivery or other entities. It defines a Site as a convenience class that allows to easily refer to places important to other entities, where a geographic place is the entity that can answer the question “where?”, allowing to determine where things are in relation to the earth\'s surface, and can be represented either in a textual structured way (geographic address) or as a geometry referred to a spatial reference system (geographic location). ### Resources - GeographicSite - Hub ### Operations Geographic Site API performs the following operations : - Retrieve a geographic site or a collection of geographic sites - Create a new site - Update a geographic site - Delete a geographic site - Notify events on geographic site Copyright © TM Forum 2021. All Rights Reserved
*
* The version of the OpenAPI document: 5.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
*/
export interface Extensible {
/**
* When sub-classing, this defines the sub-class Extensible name
*/
type: string;
/**
* When sub-classing, this defines the super-class
*/
baseType?: string;
/**
* A URI to a JSON-Schema file that defines additional attributes and relationships
*/
schemaLocation?: string;
}
/**
* Geographic Site Management
* ** TMF API Reference : TMF 674 - Place - Geographic Site Management ### August 2021 This API covers the operations to manage (create, read, delete) sites that can be associated to a customer, an account, a service delivery or other entities. It defines a Site as a convenience class that allows to easily refer to places important to other entities, where a geographic place is the entity that can answer the question “where?”, allowing to determine where things are in relation to the earth\'s surface, and can be represented either in a textual structured way (geographic address) or as a geometry referred to a spatial reference system (geographic location). ### Resources - GeographicSite - Hub ### Operations Geographic Site API performs the following operations : - Retrieve a geographic site or a collection of geographic sites - Create a new site - Update a geographic site - Delete a geographic site - Notify events on geographic site Copyright © TM Forum 2021. All Rights Reserved
*
* The version of the OpenAPI document: 5.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
export interface ExternalIdentifier {
/**
* A URI to a JSON-Schema file that defines additional attributes and relationships
*/
schemaLocation?: string;
/**
* When sub-classing, this defines the super-class
*/
baseType?: string;
/**
* When sub-classing, this defines the sub-class Extensible name
*/
type?: string;
/**
* Name of the external system that owns the entity.
*/
owner?: string;
/**
* Type of the identification, typically would be the type of the entity within the external system
*/
externalIdentifierType?: string;
/**
* identification of the entity within the external system.
*/
id: string;
}
/**
* Geographic Site Management
* ** TMF API Reference : TMF 674 - Place - Geographic Site Management ### August 2021 This API covers the operations to manage (create, read, delete) sites that can be associated to a customer, an account, a service delivery or other entities. It defines a Site as a convenience class that allows to easily refer to places important to other entities, where a geographic place is the entity that can answer the question “where?”, allowing to determine where things are in relation to the earth\'s surface, and can be represented either in a textual structured way (geographic address) or as a geometry referred to a spatial reference system (geographic location). ### Resources - GeographicSite - Hub ### Operations Geographic Site API performs the following operations : - Retrieve a geographic site or a collection of geographic sites - Create a new site - Update a geographic site - Delete a geographic site - Notify events on geographic site Copyright © TM Forum 2021. All Rights Reserved
*
* The version of the OpenAPI document: 5.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { PlaceRefOrValue } from './placeRefOrValue';
import { GeographicSubAddressValue } from './geographicSubAddressValue';
export interface GeographicAddressValue extends PlaceRefOrValue {
/**
* When sub-classing, this defines the sub-class Extensible name
*/
type: string;
/**
* When sub-classing, this defines the super-class
*/
baseType?: string;
/**
* A URI to a JSON-Schema file that defines additional attributes and relationships
*/
schemaLocation?: string;
/**
* An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature. [ANZLIC-STREET], or a suburb, a bounded locality within a city, town or shire principally of urban character [ANZLICSTREET]
*/
locality?: string;
/**
* descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode)
*/
postcode?: string;
/**
* the State or Province that the address is in
*/
stateOrProvince?: string;
/**
* Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses
*/
streetNr?: string;
/**
* Last number in a range of street numbers allocated to a property
*/
streetNrLast?: string;
/**
* Last street number suffix for a ranged address
*/
streetNrLastSuffix?: string;
/**
* the first street number suffix
*/
streetNrSuffix?: string;
/**
* A modifier denoting a relative direction
*/
streetSuffix?: string;
/**
* alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf
*/
streetType?: string;
geographicSubAddress?: GeographicSubAddressValue;
/**
* City that the address is in
*/
city?: string;
/**
* Country that the address is in
*/
country?: string;
/**
* Name of the street or other street type
*/
streetName?: string;
}
/**
* Geographic Site Management
* ** TMF API Reference : TMF 674 - Place - Geographic Site Management ### August 2021 This API covers the operations to manage (create, read, delete) sites that can be associated to a customer, an account, a service delivery or other entities. It defines a Site as a convenience class that allows to easily refer to places important to other entities, where a geographic place is the entity that can answer the question “where?”, allowing to determine where things are in relation to the earth\'s surface, and can be represented either in a textual structured way (geographic address) or as a geometry referred to a spatial reference system (geographic location). ### Resources - GeographicSite - Hub ### Operations Geographic Site API performs the following operations : - Retrieve a geographic site or a collection of geographic sites - Create a new site - Update a geographic site - Delete a geographic site - Notify events on geographic site Copyright © TM Forum 2021. All Rights Reserved
*
* The version of the OpenAPI document: 5.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { Entity } from './entity';
import { PlaceRefOrValue } from './placeRefOrValue';
import { ExternalIdentifier } from './externalIdentifier';
import { CalendarPeriod } from './calendarPeriod';
import { GeographicSiteRelationship } from './geographicSiteRelationship';
import { RelatedParty } from './relatedParty';
export interface GeographicSite extends Entity {
/**
* A code that may be used for some addressing schemes eg: [ANSI T1.253-1999]
*/
code?: string;
/**
* Date and time when the GeographicSite was created
*/
creationDate?: string;
/**
* Text describing additional information regarding the site
*/
description?: string;
/**
* The condition of the GeographicSite, such as planned, underConstruction, cancelled, active, inactive, former
*/
status?: string;
relatedParty?: Array<RelatedParty>;
externalIdentifier?: Array<ExternalIdentifier>;
calendar?: Array<CalendarPeriod>;
place?: Array<PlaceRefOrValue>;
siteRelationship?: Array<GeographicSiteRelationship>;
}
/**
* Geographic Site Management
* ** TMF API Reference : TMF 674 - Place - Geographic Site Management ### August 2021 This API covers the operations to manage (create, read, delete) sites that can be associated to a customer, an account, a service delivery or other entities. It defines a Site as a convenience class that allows to easily refer to places important to other entities, where a geographic place is the entity that can answer the question “where?”, allowing to determine where things are in relation to the earth\'s surface, and can be represented either in a textual structured way (geographic address) or as a geometry referred to a spatial reference system (geographic location). ### Resources - GeographicSite - Hub ### Operations Geographic Site API performs the following operations : - Retrieve a geographic site or a collection of geographic sites - Create a new site - Update a geographic site - Delete a geographic site - Notify events on geographic site Copyright © TM Forum 2021. All Rights Reserved
*
* The version of the OpenAPI document: 5.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { BaseEvent } from './baseEvent';
import { GeographicSiteEventPayload } from './geographicSiteEventPayload';
export interface GeographicSiteAttributeValueChangeEvent extends BaseEvent {
event?: GeographicSiteEventPayload;
}
/**
* Geographic Site Management
* ** TMF API Reference : TMF 674 - Place - Geographic Site Management ### August 2021 This API covers the operations to manage (create, read, delete) sites that can be associated to a customer, an account, a service delivery or other entities. It defines a Site as a convenience class that allows to easily refer to places important to other entities, where a geographic place is the entity that can answer the question “where?”, allowing to determine where things are in relation to the earth\'s surface, and can be represented either in a textual structured way (geographic address) or as a geometry referred to a spatial reference system (geographic location). ### Resources - GeographicSite - Hub ### Operations Geographic Site API performs the following operations : - Retrieve a geographic site or a collection of geographic sites - Create a new site - Update a geographic site - Delete a geographic site - Notify events on geographic site Copyright © TM Forum 2021. All Rights Reserved
*
* The version of the OpenAPI document: 5.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { PlaceRefOrValue } from './placeRefOrValue';
import { ExternalIdentifier } from './externalIdentifier';
import { CalendarPeriod } from './calendarPeriod';
import { GeographicSiteRelationship } from './geographicSiteRelationship';
import { RelatedParty } from './relatedParty';
export interface GeographicSiteCreate {
/**
* When sub-classing, this defines the sub-class Extensible name
*/
type: string;
/**
* When sub-classing, this defines the super-class
*/
baseType?: string;
/**
* A URI to a JSON-Schema file that defines additional attributes and relationships
*/
schemaLocation?: string;
/**
* A code that may be used for some addressing schemes eg: [ANSI T1.253-1999]
*/
code?: string;
/**
* Text describing additional information regarding the site
*/
description?: string;
relatedParty?: Array<RelatedParty>;
externalIdentifier?: Array<ExternalIdentifier>;
calendar?: Array<CalendarPeriod>;
place?: Array<PlaceRefOrValue>;
siteRelationship?: Array<GeographicSiteRelationship>;
}
/**
* Geographic Site Management
* ** TMF API Reference : TMF 674 - Place - Geographic Site Management ### August 2021 This API covers the operations to manage (create, read, delete) sites that can be associated to a customer, an account, a service delivery or other entities. It defines a Site as a convenience class that allows to easily refer to places important to other entities, where a geographic place is the entity that can answer the question “where?”, allowing to determine where things are in relation to the earth\'s surface, and can be represented either in a textual structured way (geographic address) or as a geometry referred to a spatial reference system (geographic location). ### Resources - GeographicSite - Hub ### Operations Geographic Site API performs the following operations : - Retrieve a geographic site or a collection of geographic sites - Create a new site - Update a geographic site - Delete a geographic site - Notify events on geographic site Copyright © TM Forum 2021. All Rights Reserved
*
* The version of the OpenAPI document: 5.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { BaseEvent } from './baseEvent';
import { GeographicSiteEventPayload } from './geographicSiteEventPayload';
export interface GeographicSiteCreateEvent extends BaseEvent {
event?: GeographicSiteEventPayload;
}
/**
* Geographic Site Management
* ** TMF API Reference : TMF 674 - Place - Geographic Site Management ### August 2021 This API covers the operations to manage (create, read, delete) sites that can be associated to a customer, an account, a service delivery or other entities. It defines a Site as a convenience class that allows to easily refer to places important to other entities, where a geographic place is the entity that can answer the question “where?”, allowing to determine where things are in relation to the earth\'s surface, and can be represented either in a textual structured way (geographic address) or as a geometry referred to a spatial reference system (geographic location). ### Resources - GeographicSite - Hub ### Operations Geographic Site API performs the following operations : - Retrieve a geographic site or a collection of geographic sites - Create a new site - Update a geographic site - Delete a geographic site - Notify events on geographic site Copyright © TM Forum 2021. All Rights Reserved
*
* The version of the OpenAPI document: 5.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { BaseEvent } from './baseEvent';
import { GeographicSiteEventPayload } from './geographicSiteEventPayload';
export interface GeographicSiteDeleteEvent extends BaseEvent {
event?: GeographicSiteEventPayload;
}
/**
* Geographic Site Management
* ** TMF API Reference : TMF 674 - Place - Geographic Site Management ### August 2021 This API covers the operations to manage (create, read, delete) sites that can be associated to a customer, an account, a service delivery or other entities. It defines a Site as a convenience class that allows to easily refer to places important to other entities, where a geographic place is the entity that can answer the question “where?”, allowing to determine where things are in relation to the earth\'s surface, and can be represented either in a textual structured way (geographic address) or as a geometry referred to a spatial reference system (geographic location). ### Resources - GeographicSite - Hub ### Operations Geographic Site API performs the following operations : - Retrieve a geographic site or a collection of geographic sites - Create a new site - Update a geographic site - Delete a geographic site - Notify events on geographic site Copyright © TM Forum 2021. All Rights Reserved
*
* The version of the OpenAPI document: 5.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { GeographicSite } from './geographicSite';
/**
* TBD
*/
export interface GeographicSiteEventPayload {
geographicSite?: GeographicSite;
}
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment