openapi_client.DefaultApi

All URIs are relative to http://localhost:8080/musicshop-1.0

Method	HTTP request	Description
add_albums_to_cart	POST /api/albums/addAlbumsToCart
add_songs_from_album_to_cart	POST /api/albums/addSongsFromAlbumToCart
add_songs_to_cart	POST /api/albums/addSongsToCart
buy_product	POST /api/shoppingCart/buyProducts
buy_products_web	POST /api/shoppingCart/buyProductsWeb
clear_shopping_cart	GET /api/shoppingCart/clear
display_shopping_cart	GET /api/shoppingCart/display
find_album_by_album_id	GET /api/album/{albumId}
find_albums_by_song_title	GET /api/albums/digital/{songTitle}
find_albums_by_song_title_physical	GET /api/albums/physical/{songTitle}
login	POST /api/login
login_web	POST /api/loginWeb
remove_line_item_from_cart	POST /api/shoppingCart/removeLineItemFromCart
welcome	GET /api

add_albums_to_cart

str add_albums_to_cart()

Example

import time
import openapi_client
from openapi_client.api import default_api
from openapi_client.model.album_dto import AlbumDTO
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8080/musicshop-1.0
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://localhost:8080/musicshop-1.0"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = default_api.DefaultApi(api_client)
    cart_uuid = "CartUUID_example" # str |  (optional)
    album_dto = AlbumDTO(
        long_id=1,
        title="title_example",
        image_url="image_url_example",
        price=3.14,
        stock=1,
        medium_type="CD",
        release_date="release_date_example",
        album_id=AlbumId(
            album_id="album_id_example",
        ),
        label="label_example",
        songs=[
            SongDTO(
                long_id=1,
                title="title_example",
                price=3.14,
                stock=1,
                medium_type="CD",
                release_date="release_date_example",
                genre="genre_example",
                artists=[
                    ArtistDTO(
                        name="name_example",
                    ),
                ],
                in_album=[
                    AlbumDTO(),
                ],
            ),
        ],
        quantity_to_add_to_cart=1,
    ) # AlbumDTO |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.add_albums_to_cart(cart_uuid=cart_uuid, album_dto=album_dto)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling DefaultApi->add_albums_to_cart: %s\n" % e)

Parameters

Name	Type	Description	Notes
cart_uuid	str		[optional]
album_dto	AlbumDTO		[optional]

Return type

str

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Add to cart successful	-
400	Request parameter not ok	-
403	No permission	-

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

add_songs_from_album_to_cart

str add_songs_from_album_to_cart()

Example

import time
import openapi_client
from openapi_client.api import default_api
from openapi_client.model.album_dto import AlbumDTO
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8080/musicshop-1.0
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://localhost:8080/musicshop-1.0"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = default_api.DefaultApi(api_client)
    cart_uuid = "CartUUID_example" # str |  (optional)
    album_dto = AlbumDTO(
        long_id=1,
        title="title_example",
        image_url="image_url_example",
        price=3.14,
        stock=1,
        medium_type="CD",
        release_date="release_date_example",
        album_id=AlbumId(
            album_id="album_id_example",
        ),
        label="label_example",
        songs=[
            SongDTO(
                long_id=1,
                title="title_example",
                price=3.14,
                stock=1,
                medium_type="CD",
                release_date="release_date_example",
                genre="genre_example",
                artists=[
                    ArtistDTO(
                        name="name_example",
                    ),
                ],
                in_album=[
                    AlbumDTO(),
                ],
            ),
        ],
        quantity_to_add_to_cart=1,
    ) # AlbumDTO |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.add_songs_from_album_to_cart(cart_uuid=cart_uuid, album_dto=album_dto)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling DefaultApi->add_songs_from_album_to_cart: %s\n" % e)

Parameters

Name	Type	Description	Notes
cart_uuid	str		[optional]
album_dto	AlbumDTO		[optional]

Return type

str

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Add to cart successful	-
400	Request parameter not ok	-
403	No permission	-

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

add_songs_to_cart

str add_songs_to_cart()

Example

import time
import openapi_client
from openapi_client.api import default_api
from openapi_client.model.song_dto import SongDTO
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8080/musicshop-1.0
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://localhost:8080/musicshop-1.0"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = default_api.DefaultApi(api_client)
    cart_uuid = "CartUUID_example" # str |  (optional)
    song_dto = [
        SongDTO(
            long_id=1,
            title="title_example",
            price=3.14,
            stock=1,
            medium_type="CD",
            release_date="release_date_example",
            genre="genre_example",
            artists=[
                ArtistDTO(
                    name="name_example",
                ),
            ],
            in_album=[
                AlbumDTO(
                    long_id=1,
                    title="title_example",
                    image_url="image_url_example",
                    price=3.14,
                    stock=1,
                    medium_type="CD",
                    release_date="release_date_example",
                    album_id=AlbumId(
                        album_id="album_id_example",
                    ),
                    label="label_example",
                    songs=[
                        SongDTO(),
                    ],
                    quantity_to_add_to_cart=1,
                ),
            ],
        ),
    ] # [SongDTO] |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.add_songs_to_cart(cart_uuid=cart_uuid, song_dto=song_dto)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling DefaultApi->add_songs_to_cart: %s\n" % e)

Parameters

Name	Type	Description	Notes
cart_uuid	str		[optional]
song_dto	[SongDTO]		[optional]

Return type

str

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Add to cart successful	-
400	Request parameter not ok	-
403	No permission	-

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

buy_product

str buy_product()

Example

import time
import openapi_client
from openapi_client.api import default_api
from openapi_client.model.invoice_line_item_dto import InvoiceLineItemDTO
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8080/musicshop-1.0
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://localhost:8080/musicshop-1.0"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = default_api.DefaultApi(api_client)
    authorization = "Authorization_example" # str |  (optional)
    invoice_line_item_dto = [
        InvoiceLineItemDTO(
            medium_type="CD",
            name="name_example",
            quantity=1,
            price=3.14,
            returned_quantity=1,
        ),
    ] # [InvoiceLineItemDTO] |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.buy_product(authorization=authorization, invoice_line_item_dto=invoice_line_item_dto)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling DefaultApi->buy_product: %s\n" % e)

Parameters

Name	Type	Description	Notes
authorization	str		[optional]
invoice_line_item_dto	[InvoiceLineItemDTO]		[optional]

Return type

str

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Buy product successful	-
400	Request parameter not ok	-
401	Invalid JWT token provided	-
403	No permission	-
404	Album not found	-
409	Not enough stock available	-

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

buy_products_web

str buy_products_web()

Example

import time
import openapi_client
from openapi_client.api import default_api
from openapi_client.model.cart_line_item_dto import CartLineItemDTO
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8080/musicshop-1.0
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://localhost:8080/musicshop-1.0"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = default_api.DefaultApi(api_client)
    authorization = "Authorization_example" # str |  (optional)
    cart_uuid = "CartUUID_example" # str |  (optional)
    cart_line_item_dto = [
        CartLineItemDTO(
            product_id=1,
            medium_type="CD",
            name="name_example",
            quantity=1,
            price=3.14,
            stock=1,
            image_url="image_url_example",
            product_type="SONG",
            artists=[
                "artists_example",
            ],
        ),
    ] # [CartLineItemDTO] |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.buy_products_web(authorization=authorization, cart_uuid=cart_uuid, cart_line_item_dto=cart_line_item_dto)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling DefaultApi->buy_products_web: %s\n" % e)

Parameters

Name	Type	Notes
authorization	str	[optional]
cart_uuid	str	[optional]
cart_line_item_dto	[CartLineItemDTO]	[optional]

Return type

str

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Buy product successful	-
400	Request parameter not ok	-
401	Invalid JWT token provided	-
403	No permission	-
404	Album not found	-
409	Not enough stock available	-
500	Internal server error	-

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

clear_shopping_cart

str clear_shopping_cart()

Example

import time
import openapi_client
from openapi_client.api import default_api
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8080/musicshop-1.0
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://localhost:8080/musicshop-1.0"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = default_api.DefaultApi(api_client)
    cart_uuid = "CartUUID_example" # str |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.clear_shopping_cart(cart_uuid=cart_uuid)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling DefaultApi->clear_shopping_cart: %s\n" % e)

Parameters

Name	Type	Description	Notes
cart_uuid	str		[optional]

Return type

str

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain

HTTP response details

Status code	Description	Response headers
200	CLear cart successful	-
400	Request parameter not ok	-
403	No permission	-

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

display_shopping_cart

ShoppingCartDTO display_shopping_cart()

Example

import time
import openapi_client
from openapi_client.api import default_api
from openapi_client.model.shopping_cart_dto import ShoppingCartDTO
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8080/musicshop-1.0
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://localhost:8080/musicshop-1.0"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = default_api.DefaultApi(api_client)
    cart_uuid = "CartUUID_example" # str |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.display_shopping_cart(cart_uuid=cart_uuid)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling DefaultApi->display_shopping_cart: %s\n" % e)

Parameters

Name	Type	Description	Notes
cart_uuid	str		[optional]

Return type

ShoppingCartDTO

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain

HTTP response details

Status code	Description	Response headers
200	Ok	-
400	Request parameter not ok	-
403	No permission	-

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

find_album_by_album_id

AlbumDTO find_album_by_album_id(album_id)

Example

import time
import openapi_client
from openapi_client.api import default_api
from openapi_client.model.album_dto import AlbumDTO
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8080/musicshop-1.0
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://localhost:8080/musicshop-1.0"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = default_api.DefaultApi(api_client)
    album_id = "albumId_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.find_album_by_album_id(album_id)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling DefaultApi->find_album_by_album_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
album_id	str

Return type

AlbumDTO

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain

HTTP response details

Status code	Description	Response headers
200	Album found	-
400	Request parameter not ok	-
404	No album found	-

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

find_albums_by_song_title

[AlbumDTO] find_albums_by_song_title(song_title)

Example

import time
import openapi_client
from openapi_client.api import default_api
from openapi_client.model.album_dto import AlbumDTO
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8080/musicshop-1.0
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://localhost:8080/musicshop-1.0"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = default_api.DefaultApi(api_client)
    song_title = "songTitle_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.find_albums_by_song_title(song_title)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling DefaultApi->find_albums_by_song_title: %s\n" % e)

Parameters

Name	Type	Description	Notes
song_title	str

Return type

[AlbumDTO]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain

HTTP response details

Status code	Description	Response headers
200	Album(s) found	-
400	Request parameter not ok	-
404	No album found	-

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

find_albums_by_song_title_physical

[AlbumDTO] find_albums_by_song_title_physical(song_title)

Example

import time
import openapi_client
from openapi_client.api import default_api
from openapi_client.model.album_dto import AlbumDTO
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8080/musicshop-1.0
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://localhost:8080/musicshop-1.0"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = default_api.DefaultApi(api_client)
    song_title = "songTitle_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.find_albums_by_song_title_physical(song_title)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling DefaultApi->find_albums_by_song_title_physical: %s\n" % e)

Parameters

Name	Type	Description	Notes
song_title	str

Return type

[AlbumDTO]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/plain

HTTP response details

Status code	Description	Response headers
200	Album(s) found	-
400	Request parameter not ok	-
404	No album found	-

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

login

str login()

Example

import time
import openapi_client
from openapi_client.api import default_api
from openapi_client.model.user_data_dto import UserDataDTO
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8080/musicshop-1.0
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://localhost:8080/musicshop-1.0"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = default_api.DefaultApi(api_client)
    user_data_dto = UserDataDTO(
        email_address="email_address_example",
        password="password_example",
    ) # UserDataDTO |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.login(user_data_dto=user_data_dto)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling DefaultApi->login: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_data_dto	UserDataDTO		[optional]

Return type

str

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Login successful	-
400	Request parameter not ok	-
401	Username or password wrong	-
403	No permission	-

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

login_web

str login_web()

Example

import time
import openapi_client
from openapi_client.api import default_api
from openapi_client.model.user_data_dto import UserDataDTO
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8080/musicshop-1.0
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://localhost:8080/musicshop-1.0"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = default_api.DefaultApi(api_client)
    user_data_dto = UserDataDTO(
        email_address="email_address_example",
        password="password_example",
    ) # UserDataDTO |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.login_web(user_data_dto=user_data_dto)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling DefaultApi->login_web: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_data_dto	UserDataDTO		[optional]

Return type

str

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Login successful	-
400	Request parameter not ok	-
401	Username or password wrong	-
403	No permission	-

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

remove_line_item_from_cart

str remove_line_item_from_cart()

Example

import time
import openapi_client
from openapi_client.api import default_api
from openapi_client.model.cart_line_item_dto import CartLineItemDTO
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8080/musicshop-1.0
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://localhost:8080/musicshop-1.0"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = default_api.DefaultApi(api_client)
    cart_uuid = "CartUUID_example" # str |  (optional)
    cart_line_item_dto = CartLineItemDTO(
        product_id=1,
        medium_type="CD",
        name="name_example",
        quantity=1,
        price=3.14,
        stock=1,
        image_url="image_url_example",
        product_type="SONG",
        artists=[
            "artists_example",
        ],
    ) # CartLineItemDTO |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.remove_line_item_from_cart(cart_uuid=cart_uuid, cart_line_item_dto=cart_line_item_dto)
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling DefaultApi->remove_line_item_from_cart: %s\n" % e)

Parameters

Name	Type	Description	Notes
cart_uuid	str		[optional]
cart_line_item_dto	CartLineItemDTO		[optional]

Return type

str

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Remove item successful	-
400	Request parameter not ok	-
403	No permission	-

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

welcome

str welcome()

Example

import time
import openapi_client
from openapi_client.api import default_api
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8080/musicshop-1.0
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://localhost:8080/musicshop-1.0"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = default_api.DefaultApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        api_response = api_instance.welcome()
        pprint(api_response)
    except openapi_client.ApiException as e:
        print("Exception when calling DefaultApi->welcome: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

str

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/html

HTTP response details

Status code	Description	Response headers
0	default response	-

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

FilesExpand file tree

DefaultApi.md

Latest commit

History

DefaultApi.md

File metadata and controls

openapi_client.DefaultApi

add_albums_to_cart

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

add_songs_from_album_to_cart

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

add_songs_to_cart

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

buy_product

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

buy_products_web

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

clear_shopping_cart

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

display_shopping_cart

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

find_album_by_album_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

find_albums_by_song_title

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

find_albums_by_song_title_physical

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

login

Example

Parameters