SubscriptionAPI.md

\SubscriptionAPI

All URIs are relative to /candlepin

Method	HTTP request	Description
ActivateSubscription	Post /subscriptions
DeleteSubscription	Delete /subscriptions/{id}
GetSubscriptions	Get /subscriptions

ActivateSubscription

ActivateSubscription(ctx).ConsumerUuid(consumerUuid).Email(email).EmailLocale(emailLocale).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/content-services/caliri/release/v4"
)

func main() {
	consumerUuid := "consumerUuid_example" // string | The UUID of the consumer of the subscription
	email := "email_example" // string | The email to send a notification to for the activation
	emailLocale := "emailLocale_example" // string | The locale of the email to send a notification to for the activation

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.SubscriptionAPI.ActivateSubscription(context.Background()).ConsumerUuid(consumerUuid).Email(email).EmailLocale(emailLocale).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SubscriptionAPI.ActivateSubscription``: %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 apiActivateSubscriptionRequest struct via the builder pattern

Name	Type	Description	Notes
consumerUuid	string	The UUID of the consumer of the subscription
email	string	The email to send a notification to for the activation
emailLocale	string	The locale of the email to send a notification to for the activation

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

DeleteSubscription

DeleteSubscription(ctx, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/content-services/caliri/release/v4"
)

func main() {
	id := "id_example" // string | The ID of the subscription to remove

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.SubscriptionAPI.DeleteSubscription(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SubscriptionAPI.DeleteSubscription``: %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	string	The ID of the subscription to remove

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

GetSubscriptions

[]SubscriptionDTO GetSubscriptions(ctx).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/content-services/caliri/release/v4"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]SubscriptionDTO

Authorization

No authorization required

HTTP request headers

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

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