Module ocs_rest_res_balance

Description
Data Types
Function Index
Function Details

This library module implements resource handling functions for a REST server in the ocs application.

Description

This library module implements resource handling functions for a REST server in the ocs application.

Data Types

bucket_attributes()

bucket_attributes() = #{bucket_type := normal | session, from_bucket => [bucket_source()], reservations => reservations()}

bucket_source()

bucket_source() = #{id := string(), amount := pos_integer(), unit_size := pos_integer(), unit_price := pos_integer(), expire := pos_integer() | undefined}

bucket_status()

bucket_status() = active | expired | suspended

quantity()

quantity() = #quantity{amount = integer(), units = atom() | string()}

reservation()

reservation() = #{ts := pos_integer(), debit := non_neg_integer(), reserve := non_neg_integer(), service_id => non_neg_integer(), charging_key => non_neg_integer()}

reservations()

reservations() = #{SesssionID::list() => reservation()}

Function Index

content_types_accepted/0	Provides list of resource representations accepted.
content_types_provided/0	Provides list of resource representations available.
get_balance_log/2	Body producing function for `GET /ocs/v1/log/balance` requests.
delete_bucket/1	Respond to `DELETE /balanceManagement/v1/bucket/{id}` request to remove a `Balance Bucket`.
get_bucket/1	Body producing function for `GET /balanceManagement/v1/bucket/{id}` requests.
head_bucket/0	Body producing function for `HEAD /balanceManagement/v1/bucket` requests.
get_buckets/2	Body producing function for `GET /balanceManagement/v1/bucket/` requests.
get_balance_service/1	Body producing function for `GET /balanceManagement/v1/service/{id}/accumulatedBalance` requests.
get_balance/1	Body producing function for `GET /balanceManagement/v1/product/{id}/accumulatedBalance` request requests.
get_balance/2	Body producing function for `GET /balanceManagement/v1/product/{id}/accumulatedBalance` with query request.
top_up_service/2	Respond to `POST /balanceManagement/v1/service/{id}/balanceTopup`.
top_up/2	Respond to `POST /balanceManagement/v1/product/{id}/balanceTopup`.
balance_adjustment/1	Respond to `POST /balanceManagement/v1/balanceAdjustment`.
units/1*	Return the type of units of the bucket.
type/1*	Return the type of abmf logs.
bucket_status/1*	CODEC for life cycle status of Bucket instance.
bucket/1	CODEC for buckets.
adjustment/1	CODEC for adjustments.
acc_balance/1	CODEC for acc_balance.
quantity/1	CODEC for quantity type.

Function Details

content_types_accepted/0

content_types_accepted() -> ContentTypes

ContentTypes = list()

Provides list of resource representations accepted.

content_types_provided/0

content_types_provided() -> ContentTypes

ContentTypes = list()

Provides list of resource representations available.

get_balance_log/2

get_balance_log(Query, Headers) -> Result

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

Body producing function for GET /ocs/v1/log/balance requests.

delete_bucket/1

delete_bucket(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 /balanceManagement/v1/bucket/{id} request to remove a Balance Bucket.

get_bucket/1

get_bucket(BucketId) -> Result

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

Body producing function for GET /balanceManagement/v1/bucket/{id} requests.

head_bucket/0

head_bucket() -> Result

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

Body producing function for HEAD /balanceManagement/v1/bucket requests.

get_buckets/2

get_buckets(Query, Headers) -> Result

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

Body producing function for GET /balanceManagement/v1/bucket/ requests.

get_balance_service/1

get_balance_service(Identity) -> Result

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

Body producing function for GET /balanceManagement/v1/service/{id}/accumulatedBalance requests.

get_balance/1

get_balance(ProdRef) -> Result

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

Body producing function for GET /balanceManagement/v1/product/{id}/accumulatedBalance request requests.

get_balance/2

get_balance(ProdRef, Query) -> Result

ProdRef = 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()

Body producing function for GET /balanceManagement/v1/product/{id}/accumulatedBalance with query request

top_up_service/2

top_up_service(Identity, RequestBody) -> Result

Identity = 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 POST /balanceManagement/v1/service/{id}/balanceTopup.

top_up/2

top_up(Identity, RequestBody) -> Result

Identity = 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 POST /balanceManagement/v1/product/{id}/balanceTopup.

balance_adjustment/1

balance_adjustment(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 /balanceManagement/v1/balanceAdjustment.

units/1 *

units(Units) -> Units

Units = string() | octets | cents | seconds | messages

Return the type of units of the bucket.

type/1 *

type(Type) -> Type

Type = topup | adjustment | delete | deduct | reserve | unreserve | transfer | string()

Return the type of abmf logs.

bucket_status/1 *

bucket_status(Status) -> Status

Status = atom() | string()

CODEC for life cycle status of Bucket instance.

bucket/1

bucket(Bucket) -> Bucket

Bucket = #bucket{id = string() | undefined | '_' | '$1', name = string() | undefined | '_', start_date = pos_integer() | undefined | '_', end_date = pos_integer() | undefined | '_', status = bucket_status() | undefined | '_', remain_amount = integer() | '_', attributes = bucket_attributes() | '_', units = octets | cents | seconds | messages | undefined | '_', price = string() | '_', product = [ProdRef::term()] | '_', last_modified = tuple() | undefined | '_'} | {struct, list()}

CODEC for buckets

adjustment/1

adjustment(Adjustment) -> Adjustment

Adjustment = #adjustment{id = string() | undefined | '_' | '$1', type = string() | undefined | '_', description = string() | undefined | '_', reason = string() | undefined | '_', amount = integer() | undefined | '_', units = octets | cents | seconds | messages | undefined | '_', start_date = pos_integer() | undefined | '_', end_date = pos_integer() | undefined | '_', product = (ProdRef::term() | '_'), service = (ServiceRef::term() | '_'), bucket = (BucketRef::term() | '_')} | {struct, list()}

CODEC for adjustments

acc_balance/1

acc_balance(AccBalance) -> AccBalance

AccBalance = #acc_balance{id = string() | undefined, name = string() | undefined, total_balance = [quantity()] | undefined, bucket = [string()], product = [string()]} | {struct, list()}

CODEC for acc_balance

quantity/1

quantity(Quantity) -> Quantity

Quantity = {struct, list()} | #quantity{amount = integer(), units = atom() | string()}

CODEC for quantity type

Generated by EDoc