portal/openapi/docs/CardAPI.md

\CardAPI

All URIs are relative to http://localhost

Method	HTTP request	Description
AddCardApiV1CardsPost	Post /api/v1/cards/	Add Card
DelCardApiV1CardsDelete	Delete /api/v1/cards/	Del Card
GetCardsApiV1CardsGroupIdGet	Get /api/v1/cards/{group_id}	Get Cards
UpdateCardApiV1CardsCardIdPatch	Patch /api/v1/cards/{card_id}	Update Card

AddCardApiV1CardsPost

Card AddCardApiV1CardsPost(ctx).CardCreate(cardCreate).Execute()

Add Card

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	cardCreate := *openapiclient.NewCardCreate("Name_example", int32(123)) // CardCreate | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.CardAPI.AddCardApiV1CardsPost(context.Background()).CardCreate(cardCreate).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CardAPI.AddCardApiV1CardsPost``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AddCardApiV1CardsPost`: Card
	fmt.Fprintf(os.Stdout, "Response from `CardAPI.AddCardApiV1CardsPost`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
cardCreate	CardCreate

Return type

Card

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

DelCardApiV1CardsDelete

interface{} DelCardApiV1CardsDelete(ctx).Execute()

Del Card

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.CardAPI.DelCardApiV1CardsDelete(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CardAPI.DelCardApiV1CardsDelete``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DelCardApiV1CardsDelete`: interface{}
	fmt.Fprintf(os.Stdout, "Response from `CardAPI.DelCardApiV1CardsDelete`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

interface{}

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

GetCardsApiV1CardsGroupIdGet

[]Card GetCardsApiV1CardsGroupIdGet(ctx, groupId).Execute()

Get Cards

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

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

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.CardAPI.GetCardsApiV1CardsGroupIdGet(context.Background(), groupId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CardAPI.GetCardsApiV1CardsGroupIdGet``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetCardsApiV1CardsGroupIdGet`: []Card
	fmt.Fprintf(os.Stdout, "Response from `CardAPI.GetCardsApiV1CardsGroupIdGet`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

Return type

[]Card

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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

UpdateCardApiV1CardsCardIdPatch

Card UpdateCardApiV1CardsCardIdPatch(ctx, cardId).CardUpdate(cardUpdate).Execute()

Update Card

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	cardId := int32(56) // int32 | 
	cardUpdate := *openapiclient.NewCardUpdate() // CardUpdate | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.CardAPI.UpdateCardApiV1CardsCardIdPatch(context.Background(), cardId).CardUpdate(cardUpdate).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CardAPI.UpdateCardApiV1CardsCardIdPatch``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateCardApiV1CardsCardIdPatch`: Card
	fmt.Fprintf(os.Stdout, "Response from `CardAPI.UpdateCardApiV1CardsCardIdPatch`: %v\n", resp)
}

Path Parameters

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

Other Parameters

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

Name	Type	Description	Notes

cardUpdate | CardUpdate | |

Return type

Card

Authorization

OAuth2PasswordBearer

HTTP request headers

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

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