modulepackage
0.0.4
Repository: https://github.com/prolicht-dev/avaclient-go.git
Documentation: pkg.go.dev
# README
Go API client for avaclient
AVACloud API specification
Overview
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 1.16.0
- Package version: 1.16.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
Installation
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional
Put the package under your project folder and add the following in import:
import "./avaclient"
Documentation for API Endpoints
All URIs are relative to https://avacloud-api.dangl-it.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AslvConversionApi | AslvConversionConvertToAva | Post /conversion/aslv/ava | Converts Aslv files to Dangl.AVA projects |
| AslvConversionApi | AslvConversionConvertToExcel | Post /conversion/aslv/excel | Converts Aslv files to Excel |
| AslvConversionApi | AslvConversionConvertToGaeb | Post /conversion/aslv/gaeb | Converts Aslv files to GAEB files |
| AslvConversionApi | AslvConversionConvertToOenorm | Post /conversion/aslv/oenorm | Converts Aslv files to Oenorm files |
| AvaConversionApi | AvaConversionConvertToAva | Post /conversion/ava/ava | Converts Dangl.AVA projects to Dangl.AVA. This is useful when you want to generate the calculated properties. |
| AvaConversionApi | AvaConversionConvertToExcel | Post /conversion/ava/excel | Converts Dangl.AVA projects to Excel |
| AvaConversionApi | AvaConversionConvertToGaeb | Post /conversion/ava/gaeb | Converts Dangl.AVA projects to GAEB |
| AvaConversionApi | AvaConversionConvertToOenorm | Post /conversion/ava/oenorm | Converts Dangl.AVA projects to Oenorm |
| AvaConversionApi | AvaConversionConvertToReb | Post /conversion/ava/reb | Converts Dangl.AVA projects to REB |
| AvaConversionApi | AvaConversionConvertToSia | Post /conversion/ava/sia | Converts Dangl.AVA projects to SIA 451 |
| DanglIdentityApi | DanglIdentityLoginAndReturnToken | Post /identity/token-login | |
| DanglIdentityApi | DanglIdentityLoginWithCookie | Post /identity/login | |
| DanglIdentityApi | DanglIdentityRefreshToken | Post /identity/token-refresh | |
| DanglIdentityApi | DanglIdentityRegister | Post /identity/register | |
| DanglIdentityApi | DanglIdentityRequestPasswordReset | Post /identity/password-forgotten | |
| DanglIdentityApi | DanglIdentitySignOutWithSignInManager | Delete /identity/login | |
| ExcelConversionApi | ExcelConversionConvertToAva | Post /conversion/excel/ava | Converts Excel files to Dangl.AVA projects. |
| ExcelConversionApi | ExcelConversionConvertToExcel | Post /conversion/excel/excel | Converts Excel files to Excel files. Used, for example, when elements were added in excel to generate or modify a project. The Excel file can then be shared containing the full project with all formattings, formulas and styles applied. |
| ExcelConversionApi | ExcelConversionConvertToGaeb | Post /conversion/excel/gaeb | Converts Excel files to GAEB files. |
| ExcelConversionApi | ExcelConversionConvertToOenorm | Post /conversion/excel/oenorm | Converts Excel files to Oenorm files. |
| GaebConversionApi | GaebConversionConvertToAva | Post /conversion/gaeb/ava | Converts GAEB files to Dangl.AVA projects |
| GaebConversionApi | GaebConversionConvertToExcel | Post /conversion/gaeb/excel | Converts GAEB files to Excel |
| GaebConversionApi | GaebConversionConvertToGaeb | Post /conversion/gaeb/gaeb | Converts GAEB files to GAEB files. Used for example when transforming or repairing GAEB files. |
| GaebConversionApi | GaebConversionConvertToOenorm | Post /conversion/gaeb/oenorm | Converts GAEB files to Oenorm files |
| OenormConversionApi | OenormConversionConvertToAva | Post /conversion/oenorm/ava | Converts ÖNorm files to Dangl.AVA projects |
| OenormConversionApi | OenormConversionConvertToExcel | Post /conversion/oenorm/excel | Converts ÖNorm files to Excel |
| OenormConversionApi | OenormConversionConvertToGaeb | Post /conversion/oenorm/gaeb | Converts ÖNorm files to GAEB files. |
| OenormConversionApi | OenormConversionConvertToOenorm | Post /conversion/oenorm/oenorm | Converts ÖNorm files to Oenorm files. |
| RebConversionApi | RebConversionConvertToAva | Post /conversion/reb/ava | Converts REB files to Dangl.AVA projects |
| RebConversionApi | RebConversionConvertToExcel | Post /conversion/reb/excel | Converts REB files to Excel |
| RebConversionApi | RebConversionConvertToGaeb | Post /conversion/reb/gaeb | Converts REB files to GAEB files |
| RebConversionApi | RebConversionConvertToOenorm | Post /conversion/reb/oenorm | Converts REB files to Oenorm |
| SiaConversionApi | SiaConversionConvertToAva | Post /conversion/sia/ava | Converts SIA 451 files to Dangl.AVA projects |
| SiaConversionApi | SiaConversionConvertToExcel | Post /conversion/sia/excel | Converts SIA 451 files to Excel |
| SiaConversionApi | SiaConversionConvertToGaeb | Post /conversion/sia/gaeb | Converts SIA 451 files to GAEB files |
| SiaConversionApi | SiaConversionConvertToOenorm | Post /conversion/sia/oenorm | Converts SIA 451 files to Oenorm files |
| StatusApi | StatusGetStatus | Get /status | Reports the health status of the AVACloud API |
Documentation For Models
- AdditionTypeDto
- ApiError
- ArticleDataDto
- AwardTypeDto
- BankingInformationDto
- CalculationDto
- CatalogueDto
- CatalogueReferenceDto
- CatalogueTypeDto
- ComissionStatusDto
- CommercePropertiesDto
- ComplementedByQuantityDto
- DestinationGaebExchangePhase
- DestinationGaebType
- DestinationOenormType
- DurationUnitDto
- ExchangePhaseDto
- ExecutionDescriptionDto
- ExecutionDescriptionDtoAllOf
- ForgotPasswordPost
- GetStatus
- GrossPriceComponentDto
- HttpStatusCode
- IElementDto
- ItemNumberDto
- ItemNumberSchemaDto
- ItemNumberSchemaTierDto
- ItemNumberSchemaTierTypeDto
- ItemNumberTypeDto
- LabourPriceComponentDto
- LoginPost
- NoteTextDto
- NoteTextDtoAllOf
- OriginDto
- PartyInformationDto
- PositionDto
- PositionDtoAllOf
- PositionTypeDto
- PriceComponentDto
- PriceInformationDto
- PriceRoundingModeDto
- PriceTypeDto
- ProductDataDto
- ProjectDto
- ProjectInformationDto
- QuantityAssignmentDto
- RegisterPost
- ResponseErrorType
- ServiceSpecificationDto
- ServiceSpecificationGroupDto
- ServiceSpecificationGroupDtoAllOf
- ServiceTypeDto
- SpecialAwardKindDto
- StandardReferenceTypeDto
- StandardizedDescriptionDto
- StlbKeyDto
- StlbReferenceDto
- SubDescriptionDto
- TokenLoginPost
- TokenRefreshPost
- TokenResponseGet
- TradeDiscountDto
- WarrantyDurationDto
Documentation For Authorization
Dangl.Identity
- Type: OAuth
- Flow: implicit
- Authorization URL: https://identity.dangl-it.com/connect/authorize
- Scopes:
- avacloud: Access to the AVACloud API
Example
auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)
Or via OAuth2 module to automatically refresh tokens and perform user authentication.
import "golang.org/x/oauth2"
/* Perform OAuth2 round trip request and obtain a token */
tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)
Author
# Packages
No description provided by the author
# Functions
CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResonse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.
NewCustomToken retrieves a token from the auth endpoint.
NewToken retrieves a token from the default auth endpoint.
# Constants
List of AdditionTypeDto.
List of AdditionTypeDto.
List of AdditionTypeDto.
List of AwardTypeDto.
List of AwardTypeDto.
List of AwardTypeDto.
List of AwardTypeDto.
List of AwardTypeDto.
List of AwardTypeDto.
List of AwardTypeDto.
List of AwardTypeDto.
List of AwardTypeDto.
List of AwardTypeDto.
List of AwardTypeDto.
List of CatalogueTypeDto.
List of CatalogueTypeDto.
List of CatalogueTypeDto.
List of CatalogueTypeDto.
List of CatalogueTypeDto.
List of ComissionStatusDto.
List of ComissionStatusDto.
List of ComissionStatusDto.
List of ComissionStatusDto.
List of DestinationGaebExchangePhase.
List of DestinationGaebExchangePhase.
List of DestinationGaebExchangePhase.
List of DestinationGaebExchangePhase.
List of DestinationGaebExchangePhase.
List of DestinationGaebExchangePhase.
List of DestinationGaebExchangePhase.
List of DestinationGaebType.
List of DestinationGaebType.
List of DestinationGaebType.
List of DestinationGaebType.
List of DestinationGaebType.
List of DestinationGaebType.
List of DestinationGaebType.
List of DestinationGaebType.
List of DestinationOenormType.
List of DestinationOenormType.
List of DurationUnitDto.
List of DurationUnitDto.
List of ExchangePhaseDto.
List of ExchangePhaseDto.
List of ExchangePhaseDto.
List of ExchangePhaseDto.
List of ExchangePhaseDto.
List of ExchangePhaseDto.
List of ExchangePhaseDto.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of HttpStatusCode.
List of ItemNumberSchemaTierTypeDto.
List of ItemNumberSchemaTierTypeDto.
List of ItemNumberSchemaTierTypeDto.
List of ItemNumberSchemaTierTypeDto.
List of ItemNumberSchemaTierTypeDto.
List of ItemNumberTypeDto.
List of ItemNumberTypeDto.
List of OriginDto.
List of OriginDto.
List of OriginDto.
List of OriginDto.
List of OriginDto.
List of OriginDto.
List of OriginDto.
List of PositionTypeDto.
List of PositionTypeDto.
List of PositionTypeDto.
List of PriceRoundingModeDto.
List of PriceRoundingModeDto.
List of PriceRoundingModeDto.
List of PriceTypeDto.
List of PriceTypeDto.
List of ResponseErrorType.
List of ResponseErrorType.
List of ResponseErrorType.
List of ResponseErrorType.
List of ResponseErrorType.
List of ServiceTypeDto.
List of ServiceTypeDto.
List of SpecialAwardKindDto.
List of SpecialAwardKindDto.
List of SpecialAwardKindDto.
List of SpecialAwardKindDto.
List of StandardReferenceTypeDto.
List of StandardReferenceTypeDto.
List of StandardReferenceTypeDto.
List of StandardReferenceTypeDto.
# Variables
ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
# Structs
APIClient manages communication with the AVACloud API 1.16.0 API v1.16.0 In most cases there should be only one, shared, APIClient.
ApiError Data transfer class to convey api errors.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
ArticleDataDto This class represents a single article, usually used within ProductData.
AslvConversionConvertToAvaOpts Optional parameters for the method 'AslvConversionConvertToAva'.
AslvConversionConvertToExcelOpts Optional parameters for the method 'AslvConversionConvertToExcel'.
AslvConversionConvertToGaebOpts Optional parameters for the method 'AslvConversionConvertToGaeb'.
AslvConversionConvertToOenormOpts Optional parameters for the method 'AslvConversionConvertToOenorm'.
AvaConversionConvertToAvaOpts Optional parameters for the method 'AvaConversionConvertToAva'.
AvaConversionConvertToExcelOpts Optional parameters for the method 'AvaConversionConvertToExcel'.
AvaConversionConvertToGaebOpts Optional parameters for the method 'AvaConversionConvertToGaeb'.
AvaConversionConvertToOenormOpts Optional parameters for the method 'AvaConversionConvertToOenorm'.
BankingInformationDto This is a class that represents the information about a bank connection.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
CalculationDto This class holds means to calculate mathematical expressions from given strings.
CatalogueDto This class describes an external catalogue.
CatalogueReferenceDto This class is used to link data between catalogues and objects.
CommercePropertiesDto This class holds specialized information that is relevant to trade or commerce based data exchange scenarios, e.g.
ComplementedByQuantityDto This class represents the linking to a complementary position with a specific quantity set.
Configuration stores the configuration of the API client.
DanglIdentityLoginWithCookieOpts Optional parameters for the method 'DanglIdentityLoginWithCookie'.
DanglToken represents a DanglIT auth token.
ExcelConversionConvertToAvaOpts Optional parameters for the method 'ExcelConversionConvertToAva'.
ExcelConversionConvertToExcelOpts Optional parameters for the method 'ExcelConversionConvertToExcel'.
ExcelConversionConvertToGaebOpts Optional parameters for the method 'ExcelConversionConvertToGaeb'.
ExcelConversionConvertToOenormOpts Optional parameters for the method 'ExcelConversionConvertToOenorm'.
ExecutionDescriptionDto struct for ExecutionDescriptionDto.
ExecutionDescriptionDtoAllOf An ExecutionDescription is used to give more details for certain items, especially on how they are meant to be executed.
ForgotPasswordPost struct for ForgotPasswordPost.
GaebConversionConvertToAvaOpts Optional parameters for the method 'GaebConversionConvertToAva'.
GaebConversionConvertToExcelOpts Optional parameters for the method 'GaebConversionConvertToExcel'.
GaebConversionConvertToGaebOpts Optional parameters for the method 'GaebConversionConvertToGaeb'.
GaebConversionConvertToOenormOpts Optional parameters for the method 'GaebConversionConvertToOenorm'.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
GetStatus Indicates the status of the AVACloud service.
GrossPriceComponentDto This is used in an ElementContainerBase to hold the price composition.
No description provided by the author
ItemNumberDto This class represents as identifier of a certain service specification's element and is uniquely within the service specification.
ItemNumberSchemaDto The schema for ItemNumber's in a Project.
ItemNumberSchemaTierDto Represents information about a single Tier in an ItemNumber.
LabourPriceComponentDto Based on the PriceComponent, this class is responsible for labour time components.
LoginPost struct for LoginPost.
NoteTextDto struct for NoteTextDto.
NoteTextDtoAllOf Represents an element that holds text information.
OenormConversionConvertToAvaOpts Optional parameters for the method 'OenormConversionConvertToAva'.
OenormConversionConvertToExcelOpts Optional parameters for the method 'OenormConversionConvertToExcel'.
OenormConversionConvertToGaebOpts Optional parameters for the method 'OenormConversionConvertToGaeb'.
OenormConversionConvertToOenormOpts Optional parameters for the method 'OenormConversionConvertToOenorm'.
PartyInformationDto Represents information about a party (a site or an organization).
PositionDto struct for PositionDto.
PositionDtoAllOf A Position is the main item type in a ServiceSpecification, holding information about tasks to be done, their prices, description, amounts etc.
PriceComponentDto This class provides means to store information about a price and it's composition.
PriceInformationDto Holds global price information for a ServiceSpecification.
ProductDataDto This class represents data about products and their vendor.
ProjectDto A Project contains all relevant information for a construction project.
ProjectInformationDto General information about a Project.
QuantityAssignmentDto Quantity assignments are, in contrast to SubDescriptions, used to categorize parts of their parent Position.
RebConversionConvertToAvaOpts Optional parameters for the method 'RebConversionConvertToAva'.
RebConversionConvertToExcelOpts Optional parameters for the method 'RebConversionConvertToExcel'.
RebConversionConvertToGaebOpts Optional parameters for the method 'RebConversionConvertToGaeb'.
RebConversionConvertToOenormOpts Optional parameters for the method 'RebConversionConvertToOenorm'.
RegisterPost struct for RegisterPost.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
ServiceSpecificationDto This is the base class that holds information about a whole service specification.
ServiceSpecificationGroupDto struct for ServiceSpecificationGroupDto.
ServiceSpecificationGroupDtoAllOf This is a grouping IElement that holds other IElements within.
SiaConversionConvertToAvaOpts Optional parameters for the method 'SiaConversionConvertToAva'.
SiaConversionConvertToExcelOpts Optional parameters for the method 'SiaConversionConvertToExcel'.
SiaConversionConvertToGaebOpts Optional parameters for the method 'SiaConversionConvertToGaeb'.
SiaConversionConvertToOenormOpts Optional parameters for the method 'SiaConversionConvertToOenorm'.
StandardizedDescriptionDto This class represents a standardized description.
StlbKeyDto This class represents a single key reference within the German STLB \"Standardleistungsbuch Bau\".
StlbReferenceDto This class represents a specialized reference to the German STLB \"Standardleistungsbuch Bau\".
SubDescriptionDto This is appended to a Position and is used to separate the complete Position into smaller amounts to be described separately, for example concrete walls could be attached to different building storeys.
TokenLoginPost struct for TokenLoginPost.
TokenRefreshPost struct for TokenRefreshPost.
TokenResponseGet struct for TokenResponseGet.
TradeDiscountDto This class holds information about offered trade discounts (Skonto in German).
WarrantyDurationDto This class does not represent a typical `TimeSpan` but has a scalar value int Duration and a DurationUnit Unit to represent durations as typically used in contracts, e.g.
# Interfaces
IElementDto Base interface definition for elements within an ElementContainerBase.
# Type aliases
AdditionTypeDto Indicates the origin of an element.
AslvConversionApiService AslvConversionApi service.
AvaConversionApiService AvaConversionApi service.
AwardTypeDto This enumeration describes the type of the award / procurement process.
CatalogueTypeDto This enumeration describes the type of a catalogue.
ComissionStatusDto Indicates if this service specification item is commissioned (and therefore should be executed), postponed for later or undefined.
DanglIdentityApiService DanglIdentityApi service.
DestinationGaebExchangePhase The GAEB exchange phase to transform to.
DestinationGaebType Represents valid GAEB target types.
DestinationOenormType Represents valid Oenorm target types.
DurationUnitDto This enumeration represents the unit of a duration.
ExcelConversionApiService ExcelConversionApi service.
ExchangePhaseDto Indicates a ServiceSpecification's exchange phase, based on the GAEB exchange phases.
GaebConversionApiService GaebConversionApi service.
HttpStatusCode.
ItemNumberSchemaTierTypeDto Specifies the type an ItemNumberSchemaTier represents.
ItemNumberTypeDto Determines the type of an ItemNumberSchema.
OenormConversionApiService OenormConversionApi service.
OriginDto Indicates where a service specification was originally created.
PositionTypeDto This is a classification for Position elements.
PriceRoundingModeDto This enum configures rounding modes for price calculations in projects.
PriceTypeDto This indicates the price type of a IPricedElement.
RebConversionApiService RebConversionApi service.
ResponseErrorType.
ServiceTypeDto The service type describes the type of service a Position represents.
SiaConversionApiService SiaConversionApi service.
SpecialAwardKindDto This enumeration describes awards for project that are not just a regular procurement.
StandardReferenceTypeDto This enumeration identifies a pre-known standard used for referencing standardized descriptions.
StatusApiService StatusApi service.