\OwnerProductAPI

All URIs are relative to /candlepin

Method	HTTP request	Description
AddContentToProduct	Post /owners/{owner_key}/products/{product_id}/content/{content_id}
AddContentsToProduct	Post /owners/{owner_key}/products/{product_id}/batch_content
CreateProduct	Post /owners/{owner_key}/products
GetProductById	Get /owners/{owner_key}/products/{product_id}
GetProductCertificateById	Get /owners/{owner_key}/products/{product_id}/certificate
GetProductsByOwner	Get /owners/{owner_key}/products
RefreshPoolsForProduct	Put /owners/{owner_key}/products/{product_id}/subscriptions
RemoveContentFromProduct	Delete /owners/{owner_key}/products/{product_id}/content/{content_id}
RemoveContentsFromProduct	Delete /owners/{owner_key}/products/{product_id}/batch_content
RemoveProduct	Delete /owners/{owner_key}/products/{product_id}
UpdateProduct	Put /owners/{owner_key}/products/{product_id}

AddContentToProduct

ProductDTO AddContentToProduct(ctx, ownerKey, productId, contentId).Enabled(enabled).Execute()

Example

package main

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

func main() {
	ownerKey := "ownerKey_example" // string | Owner key
	productId := "productId_example" // string | Product ID
	contentId := "contentId_example" // string | Content ID
	enabled := true // bool | Content enabled flag

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.OwnerProductAPI.AddContentToProduct(context.Background(), ownerKey, productId, contentId).Enabled(enabled).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OwnerProductAPI.AddContentToProduct``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AddContentToProduct`: ProductDTO
	fmt.Fprintf(os.Stdout, "Response from `OwnerProductAPI.AddContentToProduct`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ownerKey	string	Owner key
productId	string	Product ID
contentId	string	Content ID

Other Parameters

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

Name	Type	Description	Notes

enabled | bool | Content enabled flag |

Return type

ProductDTO

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]

AddContentsToProduct

ProductDTO AddContentsToProduct(ctx, ownerKey, productId).RequestBody(requestBody).Execute()

Example

package main

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

func main() {
	ownerKey := "ownerKey_example" // string | Owner key
	productId := "productId_example" // string | Product ID
	requestBody := map[string]bool{"key": false} // map[string]bool | Content map

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ownerKey	string	Owner key
productId	string	Product ID

Other Parameters

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

Name	Type	Description	Notes

requestBody | map[string]bool | Content map |

Return type

ProductDTO

Authorization

No authorization required

HTTP request headers

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

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

CreateProduct

ProductDTO CreateProduct(ctx, ownerKey).ProductDTO(productDTO).Execute()

Example

package main

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

func main() {
	ownerKey := "ownerKey_example" // string | Owner key
	productDTO := *openapiclient.NewProductDTO() // ProductDTO | A product to be created

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ownerKey	string	Owner key

Other Parameters

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

Name	Type	Description	Notes

productDTO | ProductDTO | A product to be created |

Return type

ProductDTO

Authorization

No authorization required

HTTP request headers

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

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

GetProductById

ProductDTO GetProductById(ctx, ownerKey, productId).Execute()

Example

package main

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

func main() {
	ownerKey := "ownerKey_example" // string | Owner key
	productId := "productId_example" // string | Product ID

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ownerKey	string	Owner key
productId	string	Product ID

Other Parameters

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

Name	Type	Description	Notes

Return type

ProductDTO

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]

GetProductCertificateById

ProductCertificateDTO GetProductCertificateById(ctx, ownerKey, productId).Execute()

Example

package main

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

func main() {
	ownerKey := "ownerKey_example" // string | Owner key
	productId := "productId_example" // string | Product ID

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ownerKey	string	Owner key
productId	string	Product ID

Other Parameters

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

Name	Type	Description	Notes

Return type

ProductCertificateDTO

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]

GetProductsByOwner

[]ProductDTO GetProductsByOwner(ctx, ownerKey).Product(product).Name(name).Active(active).Custom(custom).Execute()

Example

package main

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

func main() {
	ownerKey := "ownerKey_example" // string | Owner key
	product := []string{"Inner_example"} // []string | The ID of a product to fetch. If defined, the list of products returned by this endpoint will only include those matching the given ID. May be specified multiple times to filter on multiple product IDs. If multiple IDs are provided, any products matching any of the provided IDs will be returned.  (optional)
	name := []string{"Inner_example"} // []string | The names of products to fetch. If defined, the list of products returned by this endpoint will only include those matching the given names (case-insensitive). May be specified multiple times to filter on multiple names. If multiple names are provided, any products matching any of the provided names will be returned.  (optional)
	active := "{"include":{"value":"include","description":"indicates the query should include matching active products, along with any inactive\nproducts\n"},"exclude":{"value":"exclude","description":"indicates the query should exclude, or omit, active products, returning only matching\ninactive products\n"},"exclusive":{"value":"exclusive","description":"indicates the query should only include matching active products, excluding any inactive\nproducts\n"}}" // string | A value indicating how 'active' products should be considered when fetching products, where 'active' is defined as a product that is currently in use by a subscription with a start time in the past and that has not yet expired, or in use by a product which itself is considered 'active.' Must be one of 'include', 'exclude', or 'exclusive' indicating that active products should be included along with inactive products, excluded (omitted) from the results, or exclusively selected as the only products to return. Defaults to 'exclusive'.  (optional) (default to "exclusive")
	custom := "{"include":{"value":"include","description":"indicates the query should include matching custom products, along with any matching\nglobally defined products\n"},"exclude":{"value":"exclude","description":"indicates the query should exclude, or omit, custom products, returning only matching\nglobally defined products\n"},"exclusive":{"value":"exclusive","description":"indicates the query should only include matching custom products, excluding any globally\ndefined products\n"}}" // string | A value indicating how custom products are considered when fetching products, where 'custom' is defined as a product that did not originate from a refresh operation nor manifest import. Must be one of 'include', 'exclude', or 'exclusive' indicating that custom products should be passively included, excluded or omitted from the output, or exclusively selected as the only products to return.  (optional) (default to "include")

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.OwnerProductAPI.GetProductsByOwner(context.Background(), ownerKey).Product(product).Name(name).Active(active).Custom(custom).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OwnerProductAPI.GetProductsByOwner``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetProductsByOwner`: []ProductDTO
	fmt.Fprintf(os.Stdout, "Response from `OwnerProductAPI.GetProductsByOwner`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ownerKey	string	Owner key

Other Parameters

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

Name	Type	Description	Notes

product | []string | The ID of a product to fetch. If defined, the list of products returned by this endpoint will only include those matching the given ID. May be specified multiple times to filter on multiple product IDs. If multiple IDs are provided, any products matching any of the provided IDs will be returned. | name | []string | The names of products to fetch. If defined, the list of products returned by this endpoint will only include those matching the given names (case-insensitive). May be specified multiple times to filter on multiple names. If multiple names are provided, any products matching any of the provided names will be returned. | active | string | A value indicating how 'active' products should be considered when fetching products, where 'active' is defined as a product that is currently in use by a subscription with a start time in the past and that has not yet expired, or in use by a product which itself is considered 'active.' Must be one of 'include', 'exclude', or 'exclusive' indicating that active products should be included along with inactive products, excluded (omitted) from the results, or exclusively selected as the only products to return. Defaults to 'exclusive'. | [default to "exclusive"] custom | string | A value indicating how custom products are considered when fetching products, where 'custom' is defined as a product that did not originate from a refresh operation nor manifest import. Must be one of 'include', 'exclude', or 'exclusive' indicating that custom products should be passively included, excluded or omitted from the output, or exclusively selected as the only products to return. | [default to "include"]

Return type

[]ProductDTO

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]

RefreshPoolsForProduct

AsyncJobStatusDTO RefreshPoolsForProduct(ctx, ownerKey, productId).LazyRegen(lazyRegen).Execute()

Example

package main

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

func main() {
	ownerKey := "ownerKey_example" // string | Owner key
	productId := "productId_example" // string | Product ID
	lazyRegen := true // bool | Regenerate certificates immediatelly or allow them to be regenerated on demand (default to true)

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ownerKey	string	Owner key
productId	string	Product ID

Other Parameters

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

Name	Type	Description	Notes

lazyRegen | bool | Regenerate certificates immediatelly or allow them to be regenerated on demand | [default to true]

Return type

AsyncJobStatusDTO

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]

RemoveContentFromProduct

ProductDTO RemoveContentFromProduct(ctx, ownerKey, productId, contentId).Execute()

Example

package main

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

func main() {
	ownerKey := "ownerKey_example" // string | Owner key
	productId := "productId_example" // string | Product ID
	contentId := "contentId_example" // string | Content ID

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ownerKey	string	Owner key
productId	string	Product ID
contentId	string	Content ID

Other Parameters

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

Name	Type	Description	Notes

Return type

ProductDTO

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]

RemoveContentsFromProduct

ProductDTO RemoveContentsFromProduct(ctx, ownerKey, productId).RequestBody(requestBody).Execute()

Example

package main

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

func main() {
	ownerKey := "ownerKey_example" // string | Owner key
	productId := "productId_example" // string | Product ID
	requestBody := []string{"Property_example"} // []string | Content IDs

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ownerKey	string	Owner key
productId	string	Product ID

Other Parameters

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

Name	Type	Description	Notes

requestBody | []string | Content IDs |

Return type

ProductDTO

Authorization

No authorization required

HTTP request headers

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

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

RemoveProduct

RemoveProduct(ctx, ownerKey, productId).Execute()

Example

package main

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

func main() {
	ownerKey := "ownerKey_example" // string | Owner key
	productId := "productId_example" // string | Product ID

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ownerKey	string	Owner key
productId	string	Product ID

Other Parameters

Other parameters are passed through a pointer to a apiRemoveProductRequest 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]

UpdateProduct

ProductDTO UpdateProduct(ctx, ownerKey, productId).ProductDTO(productDTO).Execute()

Example

package main

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

func main() {
	ownerKey := "ownerKey_example" // string | Owner key
	productId := "productId_example" // string | Product ID
	productDTO := *openapiclient.NewProductDTO() // ProductDTO | Product to be updated

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ownerKey	string	Owner key
productId	string	Product ID

Other Parameters

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

Name	Type	Description	Notes

productDTO | ProductDTO | Product to be updated |

Return type

ProductDTO

Authorization

No authorization required

HTTP request headers

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

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

Files

OwnerProductAPI.md

Latest commit

History

OwnerProductAPI.md

File metadata and controls

\OwnerProductAPI

AddContentToProduct

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AddContentsToProduct

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateProduct

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetProductById

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetProductCertificateById

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetProductsByOwner

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

RefreshPoolsForProduct

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

RemoveContentFromProduct

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

RemoveContentsFromProduct

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

RemoveProduct

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateProduct

Example

Path Parameters