README.md

Go API client for vads

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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: 2.0
• Package version: 2.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 vads "github.com/hamidfzm/arvancloud-go/vads"

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(), vads.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(), vads.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 sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

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

Documentation for API Endpoints

All URIs are relative to https://napi.arvancloud.ir/vads/2.0

Class	Method	HTTP request	Description
AdAPI	AdsAdDelete	Delete /ads/{ad}	Remove the specified ad.
AdAPI	AdsAdGet	Get /ads/{ad}	Return the specified ad.
AdAPI	AdsAdPut	Put /ads/{ad}	Update the specified ad.
AdAPI	ChannelsChannelAdsGet	Get /channels/{channel}/ads	Return all channel's ads.
AdAPI	ChannelsChannelAdsPost	Post /channels/{channel}/ads	Store a newly ad for specific channel.
AdsCategoryAPI	AdsAdCategoriesCategoryDelete	Delete /ads/{ad}/categories/{category}	Detach category from ad.
AdsCategoryAPI	AdsAdCategoriesCategoryPut	Put /ads/{ad}/categories/{category}	Attach category to ad
AdsCategoryAPI	AdsAdCategoriesGet	Get /ads/{ad}/categories	Return all ad's categories.
CampaignAPI	CampaignsCampaignDelete	Delete /campaigns/{campaign}	Remove the specified campaign.
CampaignAPI	CampaignsCampaignGet	Get /campaigns/{campaign}	Return the specified campaign.
CampaignAPI	CampaignsCampaignPut	Put /campaigns/{campaign}	Update the specified campaign.
CampaignAPI	ChannelsChannelCampaignsGet	Get /channels/{channel}/campaigns	Return all channel's campaigns.
CampaignAPI	ChannelsChannelCampaignsPost	Post /channels/{channel}/campaigns	Store a newly campaign for specific channel.
CampaignsAdAPI	CampaignsCampaignAdsAdDelete	Delete /campaigns/{campaign}/ads/{ad}	Detach ad from campaign.
CampaignsAdAPI	CampaignsCampaignAdsAdGet	Get /campaigns/{campaign}/ads/{ad}	Show attach detail of specific campaign's ad.
CampaignsAdAPI	CampaignsCampaignAdsAdPut	Put /campaigns/{campaign}/ads/{ad}	Update the specified campaign's ad.
CampaignsAdAPI	CampaignsCampaignAdsGet	Get /campaigns/{campaign}/ads	Return all campaign's ads.
CampaignsAdAPI	CampaignsCampaignAdsPost	Post /campaigns/{campaign}/ads	Attach ad to campaign
CategoryAPI	CategoriesCategoryDelete	Delete /categories/{category}	Remove the specified category.
CategoryAPI	CategoriesCategoryGet	Get /categories/{category}	Return the specified category.
CategoryAPI	CategoriesCategoryPut	Put /categories/{category}	Update the specified category.
CategoryAPI	CategoriesGet	Get /categories	Return all user categories.
CategoryAPI	CategoriesPost	Post /categories	Store a newly category.
ChannelAPI	ChannelsChannelDelete	Delete /channels/{channel}	Remove the specified channel.
ChannelAPI	ChannelsChannelGet	Get /channels/{channel}	Return the specified channel.
ChannelAPI	ChannelsChannelPut	Put /channels/{channel}	Update the specified channel.
ChannelAPI	ChannelsGet	Get /channels	Return all user channels.
ChannelAPI	ChannelsPost	Post /channels	Store a newly channel.
DomainAPI	DomainGet	Get /domain	Return User Domain.
DomainAPI	DomainPost	Post /domain	Set subdomain for VAds service.
ReportAPI	AdsAdReportsTrackEventPeriodGet	Get /ads/{ad}/reports/track/{event}/{period}	Ad track report per event.
ReportAPI	CampaignsCampaignAdsAdReportsTrackEventPeriodGet	Get /campaigns/{campaign}/ads/{ad}/reports/track/{event}/{period}	Ad in campaign track report per event.
ReportAPI	CampaignsCampaignReportsTrackEventPeriodGet	Get /campaigns/{campaign}/reports/track/{event}/{period}	Campaign track report per event.

Documentation For Models

• AdsAdPutRequest
• CampaignsCampaignAdsAdPutRequest
• CampaignsCampaignAdsPostRequest
• CampaignsCampaignAdsPostRequestQuotaInner
• CampaignsCampaignPutRequest
• CategoriesCategoryPutRequest
• CategoriesPostRequest
• ChannelsChannelCampaignsPostRequest
• ChannelsChannelPutRequest
• ChannelsPostRequest
• DomainPostRequest

Documentation For Authorization

Authentication schemes defined for the API:

api_key

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

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

Example

auth := context.WithValue(
		context.Background(),
		sw.ContextAPIKeys,
		map[string]sw.APIKey{
			"Authorization": {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