Skip to content

Latest commit

 

History

History
165 lines (116 loc) · 5.59 KB

README.md

File metadata and controls

165 lines (116 loc) · 5.59 KB
Raw

Go API client for abuse

This API provides ways to manage the abuse reports you might receive from Leaseweb. To use this API, please request access via your account manager and/or compliance officer. LIMITED ACCESS

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: v1
  • Package version: 1.0.0
  • Generator version: 7.4.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/net/context

Put the package under your project folder and add the following in import:

import abuse "github.com/leaseweb/leaseweb-go-sdk/abuse"

To use a proxy, set the environment variable HTTP_PROXY:

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 abuse.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), abuse.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value abuse.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), abuse.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 identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using abuse.ContextOperationServerIndices and abuse.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), abuse.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), abuse.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.leaseweb.com/abuse/v1

Class Method HTTP request Description
AbuseAPI CreateReportMessage Post /reports/{reportId}/messages Create new message
AbuseAPI GetReport Get /reports/{reportId} Inspect a report
AbuseAPI GetReportAttachmentList Get /reports/{reportId}/reportAttachments/{fileId} Inspect a report attachment
AbuseAPI GetReportList Get /reports List reports
AbuseAPI GetReportMessageAttachmentList Get /reports/{reportId}/messageAttachments/{fileId} Inspect a message attachment
AbuseAPI GetReportMessageList Get /reports/{reportId}/messages List report messages
AbuseAPI GetReportResolutionList Get /reports/{reportId}/resolutions List resolution options
AbuseAPI ResolveReport Post /reports/{reportId}/resolve Resolve a report

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

  • Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), abuse.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)

X-LSW-Auth

  • Type: API key
  • API key parameter name: X-LSW-Auth
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: X-LSW-Auth and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		abuse.ContextAPIKeys,
		map[string]abuse.APIKey{
			"X-LSW-Auth": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

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