DeletedConsumerAPI.md

\DeletedConsumerAPI

All URIs are relative to /candlepin

Method	HTTP request	Description
ListByDate	Get /deleted_consumers

ListByDate

[]DeletedConsumerDTO ListByDate(ctx).Date(date).Page(page).PerPage(perPage).Order(order).SortBy(sortBy).Execute()

Example

package main

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

func main() {
	date := "date_example" // string | Filter deleted consumers to those on or after this date (optional)
	page := int32(2) // int32 | Page index to return (optional)
	perPage := int32(10) // int32 | Number of items to return per page (optional)
	order := "asc" // string | Direction of ordering (optional)
	sortBy := "name" // string | Property to use for ordering (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DeletedConsumerAPI.ListByDate(context.Background()).Date(date).Page(page).PerPage(perPage).Order(order).SortBy(sortBy).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DeletedConsumerAPI.ListByDate``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListByDate`: []DeletedConsumerDTO
	fmt.Fprintf(os.Stdout, "Response from `DeletedConsumerAPI.ListByDate`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
date	string	Filter deleted consumers to those on or after this date
page	int32	Page index to return
perPage	int32	Number of items to return per page
order	string	Direction of ordering
sortBy	string	Property to use for ordering

Return type

[]DeletedConsumerDTO

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]