Go API client for apm

Anypoint Partner Manager - Partners API

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.0.0
• Package version: 1.0.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

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

import sw "./apm"

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

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.

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://anypoint.mulesoft.com/partnermanager/partners/api/v1

Class	Method	HTTP request	Description
DefaultApi	CreateConfiguration	Post /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/ediFormats/{format}/configurations
DefaultApi	CreateContact	Post /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/contacts
DefaultApi	CreateCustomAttribute	Post /organizations/{organizationId}/environments/{environmentId}/customAttributes
DefaultApi	CreateDeploymentConfiguration	Post /organizations/{organizationId}/environments/{environmentId}/deployments
DefaultApi	CreateDocument	Post /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/documents
DefaultApi	CreateDocumentflow	Post /organizations/{organizationId}/environments/{environmentId}/documentflows
DefaultApi	CreateEdiFormatDocument	Post /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/ediFormats/{format}/documents
DefaultApi	CreateEndpoint	Post /organizations/{organizationId}/environments/{environmentId}/endpoints
DefaultApi	CreateIdentifier	Post /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/identifiers
DefaultApi	CreateMapping	Post /organizations/{organizationId}/environments/{environmentId}/documentflows/{documentflowId}/mappings
DefaultApi	CreatePartner	Post /organizations/{organizationId}/environments/{environmentId}/partners
DefaultApi	CreatePartnerCertificate	Post /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/certificates
DefaultApi	CreatePartnerProfile	Post /organizations/{organizationId}/environments/{environmentId}/partnerprofiles
DefaultApi	DeleteConfiguration	Delete /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/ediFormats/{format}/configurations/{configId}
DefaultApi	DeleteContact	Delete /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/contacts/{contactId}
DefaultApi	DeleteCustomAttribute	Delete /organizations/{organizationId}/environments/{environmentId}/customAttributes/{customAttributeId}
DefaultApi	DeleteDocument	Delete /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/documents/{documentById}
DefaultApi	DeleteDocumentflow	Delete /organizations/{organizationId}/environments/{environmentId}/documentflows/{documentflowId}
DefaultApi	DeleteEdiFormatDocument	Delete /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/ediFormats/{format}/documents/{docId}
DefaultApi	DeleteEndpoint	Delete /organizations/{organizationId}/environments/{environmentId}/endpoints/{endpointId}
DefaultApi	DeleteIdentifier	Delete /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/identifiers/{identifierId}
DefaultApi	DeleteMapping	Delete /organizations/{organizationId}/environments/{environmentId}/documentflows/{documentflowId}/mappings/{mappingsId}
DefaultApi	DeletePartner	Delete /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}
DefaultApi	DeletePartnerProfile	Delete /organizations/{organizationId}/environments/{environmentId}/partnerprofiles/{partnerId}
DefaultApi	GetAllCertificates	Get /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/certificates
DefaultApi	GetAllConfigurations	Get /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/ediFormats/{format}/configurations
DefaultApi	GetAllContactTypes	Get /organizations/{organizationId}/environments/{environmentId}/contactTypes
DefaultApi	GetAllContacts	Get /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/contacts
DefaultApi	GetAllDocumentflows	Get /organizations/{organizationId}/environments/{environmentId}/documentflows
DefaultApi	GetAllDocuments	Get /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/documents
DefaultApi	GetAllEdiDocumentTypes	Get /organizations/{organizationId}/environments/{environmentId}/ediFormats/{format}/ediFormatVersions/{versionId}/ediDocumentTypes
DefaultApi	GetAllEdiFormatVersions	Get /organizations/{organizationId}/environments/{environmentId}/ediFormats/{format}/ediFormatVersions
DefaultApi	GetAllEdiFormats	Get /organizations/{organizationId}/environments/{environmentId}/ediFormats
DefaultApi	GetAllEndpoints	Get /organizations/{organizationId}/environments/{environmentId}/endpoints
DefaultApi	GetAllIdentifierTypes	Get /organizations/{organizationId}/environments/{environmentId}/identifierTypes
DefaultApi	GetAllIdentifiers	Get /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/identifiers
DefaultApi	GetAllMappings	Get /organizations/{organizationId}/environments/{environmentId}/documentflows/{documentflowId}/mappings
DefaultApi	GetAllPartnerProfiles	Get /organizations/{organizationId}/environments/{environmentId}/partnerprofiles
DefaultApi	GetAllPartners	Get /organizations/{organizationId}/environments/{environmentId}/partners
DefaultApi	GetConfiguration	Get /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/ediFormats/{format}/configurations/{configId}
DefaultApi	GetContact	Get /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/contacts/{contactId}
DefaultApi	GetCustomAttribute	Get /organizations/{organizationId}/environments/{environmentId}/customAttributes/{customAttributeId}
DefaultApi	GetDeployment	Get /organizations/{organizationId}/environments/{environmentId}/deployments/{deploymentId}
DefaultApi	GetDeploymentConfigurations	Get /organizations/{organizationId}/environments/{environmentId}/deployments
DefaultApi	GetDocument	Get /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/documents/{documentById}
DefaultApi	GetDocumentflow	Get /organizations/{organizationId}/environments/{environmentId}/documentflows/{documentflowId}
DefaultApi	GetEdiFormat	Get /organizations/{organizationId}/environments/{environmentId}/ediFormats/{format}
DefaultApi	GetEdiFormatDocument	Get /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/ediFormats/{format}/documents/{docId}
DefaultApi	GetEdiFormatDocuments	Get /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/ediFormats/{format}/documents
DefaultApi	GetEdiFormatVersion	Get /organizations/{organizationId}/environments/{environmentId}/ediFormats/{format}/ediFormatVersions/{versionId}
DefaultApi	GetEndpoint	Get /organizations/{organizationId}/environments/{environmentId}/endpoints/{endpointId}
DefaultApi	GetIdentifier	Get /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/identifiers/{identifierId}
DefaultApi	GetIdentifierType	Get /organizations/{organizationId}/environments/{environmentId}/identifierTypes/{identifierTypeId}
DefaultApi	GetMapping	Get /organizations/{organizationId}/environments/{environmentId}/documentflows/{documentflowId}/mappings/{mappingsId}
DefaultApi	GetPartner	Get /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}
DefaultApi	GetPartnerCertificate	Get /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/certificates/{certificateId}
DefaultApi	GetPartnerLogo	Get /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/logo
DefaultApi	GetPartnerProfile	Get /organizations/{organizationId}/environments/{environmentId}/partnerprofiles/{partnerId}
DefaultApi	GetStatus	Get /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/statuses/{statusId}
DefaultApi	ReplaceConfiguration	Put /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/ediFormats/{format}/configurations/{configId}
DefaultApi	ReplaceContact	Put /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/contacts/{contactId}
DefaultApi	ReplaceDocument	Put /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/documents/{documentById}
DefaultApi	ReplaceDocumentflow	Put /organizations/{organizationId}/environments/{environmentId}/documentflows/{documentflowId}
DefaultApi	ReplaceEdiFormatDocument	Put /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/ediFormats/{format}/documents/{docId}
DefaultApi	ReplaceEndpoint	Put /organizations/{organizationId}/environments/{environmentId}/endpoints/{endpointId}
DefaultApi	ReplaceIdentifier	Put /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}/identifiers/{identifierId}
DefaultApi	ReplaceMapping	Put /organizations/{organizationId}/environments/{environmentId}/documentflows/{documentflowId}/mappings/{mappingsId}
DefaultApi	ReplacePartner	Put /organizations/{organizationId}/environments/{environmentId}/partners/{partnerId}
DefaultApi	UpdateCustomAttribute	Patch /organizations/{organizationId}/environments/{environmentId}/customAttributes/{customAttributeId}
DefaultApi	UpdateDocumentflow	Patch /organizations/{organizationId}/environments/{environmentId}/documentflows/{documentflowId}

Documentation For Models

• AckConfigX12
• AckConfigX12AllOf
• Address
• AddressAllOf
• ApiKey
• AuthModeAPIKey
• AuthModeAPIKeyAllOf
• AuthModeBaseConfig
• AuthModeBasic
• AuthModeBasicAllOf
• AuthModeClientCredentials
• AuthModeClientCredentialsAllOf
• AuthModeConfig
• AuthModeOAuth
• AuthModeOAuthAllOf
• AuthModePKI
• AuthModePKIAllOf
• BaseAckConfig
• BaseEdiDocument
• BaseEndpoint
• BaseEndpointConfig
• CSMSecret
• CSMSecretGrant
• CodeKeyVal
• Contact
• ContactAllOf
• ContactType
• ContactTypeAllOf
• CreateEntityResponse
• CreateEntityResponseAllOf
• CustomAttribute
• DeploymentPostRequest
• DeploymentStatusMessage
• DeploymentStatusType
• DirectionType
• Document
• DocumentFlow
• DocumentFlowAllOf
• DocumentFlowConfig
• DocumentFlowConfigAllOf
• DocumentFlowConfigAllOfPartnerIdentifiersConfig
• DocumentFlowConfigInstance
• DocumentFlowDeploymentSummary
• DocumentFlowDeploymentSummaryAllOf
• DocumentFlowStatusType
• DocumentFlowSummary
• DocumentFlowSummaryAllOf
• DocumentMappingConfig
• EdiConfig
• EdiDocument
• EdiDocumentType
• EdiFormat
• EdiFormatConfiguration
• EdiFormatConfigurationAcknowledgementSettings
• EdiFormatConfigurationCharacterSetAndDelimitersSettings
• EdiFormatConfigurationCharacterSetAndEncoding
• EdiFormatConfigurationCharacterSetEncoding
• EdiFormatConfigurationControlNumberSettings
• EdiFormatConfigurationEdifactControlNumberSettings
• EdiFormatConfigurationEdifactParserSettings
• EdiFormatConfigurationEnvelopeHeaders
• EdiFormatConfigurationParserSettings
• EdiFormatConfigurationSeparators
• EdiFormatConfigurationTerminatorDelimiter
• EdiFormatConfigurationWriteSettings
• EdiFormatConfigurationWriterSettings
• EdiFormatPartner
• EdiFormatTypes
• EdiFormatVersion
• Endpoint
• EndpointConfig
• EndpointConfigVpc
• EndpointDeployment
• EndpointRoleType
• GroupCode
• Http
• HttpAllOf
• HttpConfig
• HttpConfigAllOf
• HttpResponseMessage
• Identifier
• IdentifierAllOf
• IdentifierType
• IdentifierTypeAllOf
• IdentifierTypeQualifier
• IdentifierTypeQualifierAllOf
• InlineResponse202
• Logo
• Partner
• PartnerAllOf
• PartnerIdentifiersConfigIdentifiers
• PartnerProfile
• PartnerProfileAllOf
• Partnerprofile
• Partnerprofileidentifier
• Sftp
• SftpAllOf
• SftpConfig
• SftpConfigAllOf
• TLSContext
• TimedStatus
• TimedStatusAllOf
• UsedInDeployments
• UsedInDeploymentsAllOf
• UserDetail
• UserDetailAllOf
• X12Config
• X12ConfigAllOf
• X12Document
• X12DocumentAllOf

Documentation For Authorization

oauth_2_0

• Type: OAuth
• Flow: implicit
• Authorization URL: https://anypoint.mulesoft.com/accounts/oauth2/authorize
• Scopes: N/A

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)

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