# Go API client for openapi
This is an API defintion for accesssing the Mail.Baby mail service.
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
For more information, please visit [https://www.interserver.net/contact-information.html](https://www.interserver.net/contact-information.html)
## Installation
Install the following dependencies:
```shell
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
```
Put the package under your project folder and add the following in import:
```golang
import sw "./openapi"
```
To use a proxy, set the environment variable `HTTP_PROXY`:
```golang
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
```
## Configuration of Server URL
Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification.
### Select Server Configuration
For using other server than the one defined on index 0 set context value `sw.ContextServerIndex` of type `int`.
```golang
ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)
```
### Templated Server URL
Templated server URL is formatted using default variables from configuration or from context value `sw.ContextServerVariables` of type `map[string]string`.
```golang
ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})
```
Note, enum values are always validated and all unused variables are silently ignored.
### URLs Configuration per Operation
Each operation can use different server URL defined using `OperationServers` map in the `Configuration`.
An operation is uniquely identifield by `"{classname}Service.{nickname}"` string.
Similar rules for overriding default operation server index and variables applies by using `sw.ContextOperationServerIndices` and `sw.ContextOperationServerVariables` context maps.
```
ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})
```
## Documentation for API Endpoints
All URIs are relative to *https://api.mailbaby.net*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**GetMailOrders**](docs/DefaultApi.md#getmailorders) | **Get** /mail | displays a list of mail service orders
*DefaultApi* | [**PingServer**](docs/DefaultApi.md#pingserver) | **Get** /ping | Checks if the server is running
*DefaultApi* | [**PlaceMailOrder**](docs/DefaultApi.md#placemailorder) | **Post** /mail/order | places a mail order
*DefaultApi* | [**SendAdvMail**](docs/DefaultApi.md#sendadvmail) | **Post** /mail/advsend | Sends an Email with Advanced Options
*DefaultApi* | [**SendMail**](docs/DefaultApi.md#sendmail) | **Post** /mail/send | Sends an Email
*DefaultApi* | [**ValidateMailOrder**](docs/DefaultApi.md#validatemailorder) | **Get** /mail/order | validatess order details before placing an order
*DefaultApi* | [**ViewMailLog**](docs/DefaultApi.md#viewmaillog) | **Get** /mail/log | displays the mail log

## Documentation For Models
 - [ErrorResponse](docs/ErrorResponse.md)
 - [GenericResponse](docs/GenericResponse.md)
 - [InlineResponse401](docs/InlineResponse401.md)
 - [MailAttachment](docs/MailAttachment.md)
 - [MailContact](docs/MailContact.md)
 - [MailLog](docs/MailLog.md)
 - [MailOrder](docs/MailOrder.md)
 - [SendMail](docs/SendMail.md)
 - [SendMailAdv](docs/SendMailAdv.md)
 - [SendMailAdvFrom](docs/SendMailAdvFrom.md)

## Documentation For Authorization

### apiKeyAuth
- **Type**: API key
- **API key parameter name**: X-API-KEY
- **Location**: HTTP header
Note, each API key must be added to a map of `map[string]APIKey` where the key is: X-API-KEY and passed in as the auth context for each request.

## Documentation for Utility Methods
Due to the fact that model structure members are all pointers, this package contains
a number of utility functions to easily obtain pointers to values of basic types.
Each of these functions takes a value of the given basic type and returns a pointer to it:
* `PtrBool`
* `PtrInt`
* `PtrInt32`
* `PtrInt64`
* `PtrFloat`
* `PtrFloat32`
* `PtrFloat64`
* `PtrString`
* `PtrTime`
## Author
<EMAIL>