Skip to content

TagsAPI.md

Latest commit

 

History

History
414 lines (259 loc) · 9.8 KB

TagsAPI.md

File metadata and controls

414 lines (259 loc) · 9.8 KB
Raw

\TagsAPI

All URIs are relative to https://up.go-adserver.com

Method HTTP request Description
ApiV1TagsGet Get /api/v1/tags List tags.
ApiV1TagsIdDelete Delete /api/v1/tags/{id} Delete a tag.
ApiV1TagsIdGet Get /api/v1/tags/{id} Show a tag.
ApiV1TagsIdPut Put /api/v1/tags/{id} Rename or move a tag.
ApiV1TagsMassDeletePost Post /api/v1/tags/mass-delete Delete several tags.
ApiV1TagsPost Post /api/v1/tags Create a tag.

ApiV1TagsGet

ApiV1TagsGet(ctx).Page(page).PerPage(perPage).Search(search).Execute()

List tags.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	page := int32(56) // int32 |  (optional) (default to 1)
	perPage := "perPage_example" // string | Max 100, or `all`. (optional) (default to "20")
	search := "search_example" // string |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.TagsAPI.ApiV1TagsGet(context.Background()).Page(page).PerPage(perPage).Search(search).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TagsAPI.ApiV1TagsGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiApiV1TagsGetRequest struct via the builder pattern

Name Type Description Notes
page int32 [default to 1]
perPage string Max 100, or `all`. [default to "20"]
search string

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1TagsIdDelete

ApiV1TagsIdDelete(ctx, id).Execute()

Delete a tag.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.TagsAPI.ApiV1TagsIdDelete(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TagsAPI.ApiV1TagsIdDelete``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1TagsIdDeleteRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1TagsIdGet

ApiV1TagsIdGet(ctx, id).Execute()

Show a tag.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.TagsAPI.ApiV1TagsIdGet(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TagsAPI.ApiV1TagsIdGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1TagsIdGetRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1TagsIdPut

ApiV1TagsIdPut(ctx, id).ApiV1TagsIdPutRequest(apiV1TagsIdPutRequest).Execute()

Rename or move a tag.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	id := int32(56) // int32 | 
	apiV1TagsIdPutRequest := *openapiclient.NewApiV1TagsIdPutRequest("Name_example") // ApiV1TagsIdPutRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.TagsAPI.ApiV1TagsIdPut(context.Background(), id).ApiV1TagsIdPutRequest(apiV1TagsIdPutRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TagsAPI.ApiV1TagsIdPut``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32

Other Parameters

Other parameters are passed through a pointer to a apiApiV1TagsIdPutRequest struct via the builder pattern

Name Type Description Notes

apiV1TagsIdPutRequest | ApiV1TagsIdPutRequest | |

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1TagsMassDeletePost

ApiV1TagsMassDeletePost(ctx).ApiV1TagsMassDeletePostRequest(apiV1TagsMassDeletePostRequest).Execute()

Delete several tags.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	apiV1TagsMassDeletePostRequest := *openapiclient.NewApiV1TagsMassDeletePostRequest([]int32{int32(123)}) // ApiV1TagsMassDeletePostRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.TagsAPI.ApiV1TagsMassDeletePost(context.Background()).ApiV1TagsMassDeletePostRequest(apiV1TagsMassDeletePostRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TagsAPI.ApiV1TagsMassDeletePost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiApiV1TagsMassDeletePostRequest struct via the builder pattern

Name Type Description Notes
apiV1TagsMassDeletePostRequest ApiV1TagsMassDeletePostRequest

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV1TagsPost

ApiV1TagsPost(ctx).ApiV1TagsPostRequest(apiV1TagsPostRequest).Execute()

Create a tag.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/goadserver/goadserver-go"
)

func main() {
	apiV1TagsPostRequest := *openapiclient.NewApiV1TagsPostRequest("Name_example") // ApiV1TagsPostRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.TagsAPI.ApiV1TagsPost(context.Background()).ApiV1TagsPostRequest(apiV1TagsPostRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TagsAPI.ApiV1TagsPost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiApiV1TagsPostRequest struct via the builder pattern

Name Type Description Notes
apiV1TagsPostRequest ApiV1TagsPostRequest

Return type

(empty response body)

Authorization

apiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]