Module ocs_rest_res

pla_ref() = #pla_ref{id = string() | undefined | '_', href = string() | undefined | '_', name = string() | undefined | '_', class_type = string() | undefined | '_', base_type = string() | undefined | '_', schema = string() | undefined | '_', ref_type = string() | undefined | '_'}

product_price_type()

product_status()

quantity()

content_types_accepted/0

content_types_accepted() -> ContentTypes

ContentTypes = list()

content_types_provided/0

content_types_provided() -> ContentTypes

ContentTypes = list()

add_offer/1

add_offer(RequestBody) -> Result

RequestBody = string()
Result = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Respond to POST /productCatalogManagement/v2/productOffering. Add a new Product Offering.

add_product/1

add_product(RequestBody) -> Result

RequestBody = string()
Result = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Respond to POST /productInventoryManagement/v2/product. Add a new instance of a Product Offering subscription.

get_offer/1

get_offer(ID) -> Result

ID = string()
Result = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Respond to GET /productCatalogManagement/v2/productOffering/{id}. Retrieve a Product Offering.

get_product/1

get_product(ID) -> Result

ID = string()
Result = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Respond to GET /productInventoryManagement/v2/product/{id}. Retrieve a Product Inventory.

get_offers/2

get_offers(Query, RequestHeaders) -> Result

Query = [{Key, Value}]
Key = string()
Value = string()
RequestHeaders = [tuple()]
Result = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Respond to GET /productCatalogManagement/v2/productOffering/. Retrieve all Product Offerings.

get_products/2

get_products(Query, RequestHeaders) -> Result

Query = [{Key, Value}]
Key = string()
Value = string()
RequestHeaders = [tuple()]
Result = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Respond to GET /productInventoryManagement/v2/product/. Retrieve all Product Inventories.

get_catalog/2

get_catalog(Id, Query) -> Result

Id = string()
Query = [{Key, Value}]
Key = string()
Value = string()
Result = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

get_catalogs/1

get_catalogs(Query) -> Result

Query = [{Key, Value}]
Key = string()
Value = string()
Result = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

get_category/2

get_category(Id, Query) -> Result

Id = string()
Query = [{Key, Value}]
Key = string()
Value = string()
Result = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Respond to GET /productCatalogManagement/v2/category/{id}. Retrieve a category.

get_categories/1

get_categories(Query) -> Result

Query = [{Key, Value}]
Key = string()
Value = string()
Result = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Respond to GET /productCatalogManagement/v2/category/. Retrieve all catalogs .

get_product_spec/2

get_product_spec(Id, Query) -> Result

Id = string()
Query = [{Key, Value}]
Key = string()
Value = string()
Result = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Respond to GET /productCatalogManagement/v2/productSpecification/{id}. Retrieve a product specification.

get_product_specs/1

get_product_specs(Query) -> Result

Query = [{Key, Value}]
Key = string()
Value = string()
Result = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Respond to GET /productCatalogManagement/v2/productSpecification/. Retrieve all product specifications.

patch_offer/3

patch_offer(OfferId, Etag, RequestBody) -> Result

OfferId = string()
Etag = undefined | string()
RequestBody = string()
Result = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Respond to PATCH /productCatalogManagement/v2/productOffering/{id}. Update a Product Offering using JSON patch method RFC6902.

get_pla_spec/2

get_pla_spec(Id, Query) -> Result

Id = string()
Query = [{Key, Value}]
Key = string()
Value = string()
Result = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Respond to GET /catalogManegment/v2/plaSpecification/{id}. Retrieve a pricing logic algorithm specification.

patch_product/3

patch_product(ProdId, Etag, RequestBody) -> Result

ProdId = string()
Etag = undefined | string()
RequestBody = string()
Result = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Respond to PATCH /productInventoryManagement/v2/product/{id}. Update a Product Offering using JSON patch method RFC6902.

delete_offer/1

delete_offer(Id) -> Result

Id = string()
Result = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Respond to DELETE /productCatalogManagement/v2/productOffering/{id} request to remove a Product Offering.

delete_product/1

delete_product(Id) -> Result

Id = string()
Result = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Respond to DELETE /productInventoryManagement/v2/product/{id} request to remove a Product Invenotry.

sync_offer/1

sync_offer(RequestBody) -> Result

RequestBody = string()
Result = {ok, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Respond to POST /productCatalogManagement/v2/syncOffer. Sync a Product Offering.

product_status/1

product_status(Status) -> Status

Status = atom() | string()

product_spec/1 *

product_spec(ID) -> Result

ID = string()
Result = {struct, [tuple()]} | {error, 404}

pla_spec/1 *

pla_spec(ID) -> Result

ID = string()
Result = {struct, [tuple()]} | {error, 404}

offer_status/1 *

offer_status(Status) -> Status

Status = atom() | string()

price_type/1 *

price_type(Type) -> Type

Type = string() | usage | recurring | one_time | tariff

price_period/1 *

price_period(Period) -> Period

Period = string() | hourly | daily | weekly | monthly | yearly

offer/1

offer(Product) -> Product

Product = #offer{name = string() | undefined | '_' | '$1' | '$3', description = string() | undefined | '_', start_date = pos_integer() | undefined | '_', end_date = pos_integer() | undefined | '_', status = offer_status() | '_' | undefined | '_', specification = string() | undefined | '_', bundle = [#bundled_po{name = string() | undefined, status = offer_status() | undefined, lower_limit = non_neg_integer() | undefined, upper_limit = non_neg_integer() | undefined, default = non_neg_integer() | undefined}] | '_', price = [#price{name = string() | undefined, description = string() | undefined, start_date = pos_integer() | undefined, end_date = pos_integer() | undefined, type = product_price_type() | undefined, period = recur_period() | undefined, units = cents | octets | seconds | messages | undefined, size = integer() | undefined, amount = integer() | undefined, currency = string() | undefined, char_value_use = [#char_value_use{name = string() | undefined, description = string() | undefined, type = string() | undefined, min = non_neg_integer() | undefined, max = pos_integer() | undefined, specification = '_' | string() | undefined, start_date = pos_integer() | undefined, end_date = pos_integer() | undefined, values = [#char_value{default = boolean() | undefined, units = string() | undefined, start_date = pos_integer() | undefined, end_date = pos_integer() | undefined, value = quantity() | range() | rate() | term() | undefined, from = term() | undefined, to = term() | undefined, type = string() | undefined, interval = open | closed | closed_bottom | closed_top | undefined, regex = {CompiledRegEx::re:mp(), OriginalRegEx::string()} | undefined}]}], alteration = #alteration{name = string() | undefined, description = string() | undefined, start_date = pos_integer() | undefined, end_date = pos_integer() | undefined, type = product_price_type() | undefined, period = recur_period() | undefined, units = cents | octets | seconds | messages | undefined, size = integer() | undefined, amount = integer() | undefined, currency = string() | undefined} | undefined}] | '_', char_value_use = [#char_value_use{name = string() | undefined, description = string() | undefined, type = string() | undefined, min = non_neg_integer() | undefined, max = pos_integer() | undefined, specification = '_' | string() | undefined, start_date = pos_integer() | undefined, end_date = pos_integer() | undefined, values = [#char_value{default = boolean() | undefined, units = string() | undefined, start_date = pos_integer() | undefined, end_date = pos_integer() | undefined, value = quantity() | range() | rate() | term() | undefined, from = term() | undefined, to = term() | undefined, type = string() | undefined, interval = open | closed | closed_bottom | closed_top | undefined, regex = {CompiledRegEx::re:mp(), OriginalRegEx::string()} | undefined}]}] | '_', last_modified = tuple() | undefined | '_'} | {struct, [tuple()]}

bundled_po/1 *

bundled_po(Bundled) -> Bundled

Bundled = #bundled_po{name = string() | undefined, status = offer_status() | undefined, lower_limit = non_neg_integer() | undefined, upper_limit = non_neg_integer() | undefined, default = non_neg_integer() | undefined} | {struct, list()}

price/1 *

price(Price) -> Price

Price = #price{name = string() | undefined, description = string() | undefined, start_date = pos_integer() | undefined, end_date = pos_integer() | undefined, type = product_price_type() | undefined, period = recur_period() | undefined, units = cents | octets | seconds | messages | undefined, size = integer() | undefined, amount = integer() | undefined, currency = string() | undefined, char_value_use = [#char_value_use{name = string() | undefined, description = string() | undefined, type = string() | undefined, min = non_neg_integer() | undefined, max = pos_integer() | undefined, specification = '_' | string() | undefined, start_date = pos_integer() | undefined, end_date = pos_integer() | undefined, values = [#char_value{default = boolean() | undefined, units = string() | undefined, start_date = pos_integer() | undefined, end_date = pos_integer() | undefined, value = quantity() | range() | rate() | term() | undefined, from = term() | undefined, to = term() | undefined, type = string() | undefined, interval = open | closed | closed_bottom | closed_top | undefined, regex = {CompiledRegEx::re:mp(), OriginalRegEx::string()} | undefined}]}], alteration = #alteration{name = string() | undefined, description = string() | undefined, start_date = pos_integer() | undefined, end_date = pos_integer() | undefined, type = product_price_type() | undefined, period = recur_period() | undefined, units = cents | octets | seconds | messages | undefined, size = integer() | undefined, amount = integer() | undefined, currency = string() | undefined} | undefined} | {struct, list()}

alteration/1 *

alteration(Alteration) -> Alteration

Alteration = #alteration{name = string() | undefined, description = string() | undefined, start_date = pos_integer() | undefined, end_date = pos_integer() | undefined, type = product_price_type() | undefined, period = recur_period() | undefined, units = cents | octets | seconds | messages | undefined, size = integer() | undefined, amount = integer() | undefined, currency = string() | undefined} | {struct, [tuple()]}

char_value_uses/1 *

char_value_uses(CharValueUses) -> CharValueUses

CharValueUses = [#char_value_use{name = string() | undefined, description = string() | undefined, type = string() | undefined, min = non_neg_integer() | undefined, max = pos_integer() | undefined, specification = '_' | string() | undefined, start_date = pos_integer() | undefined, end_date = pos_integer() | undefined, values = [#char_value{default = boolean() | undefined, units = string() | undefined, start_date = pos_integer() | undefined, end_date = pos_integer() | undefined, value = quantity() | range() | rate() | term() | undefined, from = term() | undefined, to = term() | undefined, type = string() | undefined, interval = open | closed | closed_bottom | closed_top | undefined, regex = {CompiledRegEx::re:mp(), OriginalRegEx::string()} | undefined}]}] | {array, [tuple()]}

char_value_use/1 *

char_value_use(CharValueUse) -> CharValueUse

CharValueUse = #char_value_use{name = string() | undefined, description = string() | undefined, type = string() | undefined, min = non_neg_integer() | undefined, max = pos_integer() | undefined, specification = '_' | string() | undefined, start_date = pos_integer() | undefined, end_date = pos_integer() | undefined, values = [#char_value{default = boolean() | undefined, units = string() | undefined, start_date = pos_integer() | undefined, end_date = pos_integer() | undefined, value = quantity() | range() | rate() | term() | undefined, from = term() | undefined, to = term() | undefined, type = string() | undefined, interval = open | closed | closed_bottom | closed_top | undefined, regex = {CompiledRegEx::re:mp(), OriginalRegEx::string()} | undefined}]} | {struct, [tuple()]}

char_values/1 *

char_values(CharValues) -> CharValues

CharValues = [#char_value{default = boolean() | undefined, units = string() | undefined, start_date = pos_integer() | undefined, end_date = pos_integer() | undefined, value = quantity() | range() | rate() | term() | undefined, from = term() | undefined, to = term() | undefined, type = string() | undefined, interval = open | closed | closed_bottom | closed_top | undefined, regex = {CompiledRegEx::re:mp(), OriginalRegEx::string()} | undefined}] | {array, [tuple()]}

char_value/1 *

char_value(CharValue) -> CharValue

CharValue = #char_value{default = boolean() | undefined, units = string() | undefined, start_date = pos_integer() | undefined, end_date = pos_integer() | undefined, value = quantity() | range() | rate() | term() | undefined, from = term() | undefined, to = term() | undefined, type = string() | undefined, interval = open | closed | closed_bottom | closed_top | undefined, regex = {CompiledRegEx::re:mp(), OriginalRegEx::string()} | undefined} | {struct, [tuple()]}

product/1

product(Instance) -> Instance

Instance = #product{id = string() | undefined | '_' | '$1', name = string() | undefined | '_' | '$2', start_date = pos_integer() | undefined | '_' | '$4', end_date = pos_integer() | undefined | '_' | '$5', status = product_status() | undefined | '_', product = string() | undefined | '_' | '$3', characteristics = [{Name::string(), Value::term()}] | '_', payment = [{Price::string(), DueDate::pos_integer()}] | '_', balance = [BucketRef::term()] | '_', service = [ServiceRef::binary()] | '_', last_modified = tuple() | undefined | '_'} | {struct, [tuple()]}

content_types_accepted/0	Provides list of resource representations accepted.
content_types_provided/0	Provides list of resource representations available.
add_offer/1	Respond to `POST /productCatalogManagement/v2/productOffering`.
add_product/1	Respond to `POST /productInventoryManagement/v2/product`.
get_offer/1	Respond to `GET /productCatalogManagement/v2/productOffering/{id}`.
get_product/1	Respond to `GET /productInventoryManagement/v2/product/{id}`.
get_offers/2	Respond to `GET /productCatalogManagement/v2/productOffering/`.
get_products/2	Respond to `GET /productInventoryManagement/v2/product/`.
get_catalog/2	Respond to `GET /catalogManagement/v2/catalog/{id}`.
get_catalogs/1	Respond to `GET /productCatalogManagement/v2/catalog/`.
get_category/2	Respond to `GET /productCatalogManagement/v2/category/{id}`.
get_categories/1	Respond to `GET /productCatalogManagement/v2/category/`.
get_product_spec/2	Respond to `GET /productCatalogManagement/v2/productSpecification/{id}`.
get_product_specs/1	Respond to `GET /productCatalogManagement/v2/productSpecification/`.
patch_offer/3	Respond to `PATCH /productCatalogManagement/v2/productOffering/{id}`.
get_pla_spec/2	Respond to `GET /catalogManegment/v2/plaSpecification/{id}`.
patch_product/3	Respond to `PATCH /productInventoryManagement/v2/product/{id}`.
delete_offer/1	Respond to `DELETE /productCatalogManagement/v2/productOffering/{id}` request to remove a `Product Offering`.
delete_product/1	Respond to `DELETE /productInventoryManagement/v2/product/{id}` request to remove a `Product Invenotry`.
sync_offer/1	Respond to `POST /productCatalogManagement/v2/syncOffer`.
product_status/1	CODEC for life cycle status of Product Offering.
product_spec/1*	Get Product Specification by ID.
pla_spec/1*	Get PLA specification by ID.
offer_status/1*	CODEC for life cycle status of Product instance.
price_type/1*	CODEC for Price Type.
price_period/1*	CODEC for Recurring Charge Period.
offer/1	CODEC for Product Offering.
bundled_po/1*
price/1*	CODEC for Product Offering Price.
alteration/1*	CODEC for Product Offering Price Alteration.
char_value_uses/1*	CODEC for ProductSpecCharValueUses.
char_value_use/1*	CODEC for ProductSpecCharValueUse.
char_values/1*	CODEC for ProductSpecCharacteristicValues.
char_value/1*	CODEC for ProductSpecCharacteristicValue.
product/1	CODEC for Product Inventory.
instance_chars/1*	CODEC for Product Inventory characteristics.
pla_ref/1*	CODEC for Product Offering Pricing Logic Algorithm.

Module ocs_rest_res_product