Skip to content

ImageGridApi.md

Latest commit

 

History

History
361 lines (242 loc) · 9.88 KB

ImageGridApi.md

File metadata and controls

361 lines (242 loc) · 9.88 KB

wallet.ImageGridApi

All URIs are relative to https://api.wall.et

Method HTTP request Description
archive_image_grid DELETE /v2/imageGrid/{id} Archive image
create_image_grid POST /v2/imageGrid Create image
fetch_all_image_grid GET /v2/imageGrid/all Fetch all images
restore_image_grid PATCH /v2/imageGrid/{id} Restore image
update_image_grid PUT /v2/imageGrid/{id} Update image

archive_image_grid

ImageGrid archive_image_grid(id)

Archive image

Example

import wallet
from wallet.models.image_grid import ImageGrid
from wallet.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wall.et
# See configuration.py for a list of all supported configuration parameters.
configuration = wallet.Configuration(
    host = "https://api.wall.et"
)


# Enter a context with an instance of the API client
with wallet.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wallet.ImageGridApi(api_client)
    id = None # object | 

    try:
        # Archive image
        api_response = api_instance.archive_image_grid(id)
        print("The response of ImageGridApi->archive_image_grid:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImageGridApi->archive_image_grid: %s\n" % e)

Parameters

Name Type Description Notes
id object

Return type

ImageGrid

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Ok -
401 Authentication Failed -
422 Validation Failed -
500 Internal Server Error -

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

create_image_grid

ImageGrid create_image_grid(wt_image_grid_create_params)

Create image

Example

import wallet
from wallet.models.image_grid import ImageGrid
from wallet.models.wt_image_grid_create_params import WTImageGridCreateParams
from wallet.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wall.et
# See configuration.py for a list of all supported configuration parameters.
configuration = wallet.Configuration(
    host = "https://api.wall.et"
)


# Enter a context with an instance of the API client
with wallet.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wallet.ImageGridApi(api_client)
    wt_image_grid_create_params = wallet.WTImageGridCreateParams() # WTImageGridCreateParams | 

    try:
        # Create image
        api_response = api_instance.create_image_grid(wt_image_grid_create_params)
        print("The response of ImageGridApi->create_image_grid:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImageGridApi->create_image_grid: %s\n" % e)

Parameters

Name Type Description Notes
wt_image_grid_create_params WTImageGridCreateParams

Return type

ImageGrid

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Ok -
401 Authentication Failed -
422 Validation Failed -
500 Internal Server Error -

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

fetch_all_image_grid

object fetch_all_image_grid(is_archive_included=is_archive_included)

Fetch all images

Example

import wallet
from wallet.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wall.et
# See configuration.py for a list of all supported configuration parameters.
configuration = wallet.Configuration(
    host = "https://api.wall.et"
)


# Enter a context with an instance of the API client
with wallet.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wallet.ImageGridApi(api_client)
    is_archive_included = True # bool |  (optional)

    try:
        # Fetch all images
        api_response = api_instance.fetch_all_image_grid(is_archive_included=is_archive_included)
        print("The response of ImageGridApi->fetch_all_image_grid:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImageGridApi->fetch_all_image_grid: %s\n" % e)

Parameters

Name Type Description Notes
is_archive_included bool [optional]

Return type

object

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Ok -
401 Authentication Failed -
422 Validation Failed -
500 Internal Server Error -

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

restore_image_grid

ImageGrid restore_image_grid(id)

Restore image

Example

import wallet
from wallet.models.image_grid import ImageGrid
from wallet.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wall.et
# See configuration.py for a list of all supported configuration parameters.
configuration = wallet.Configuration(
    host = "https://api.wall.et"
)


# Enter a context with an instance of the API client
with wallet.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wallet.ImageGridApi(api_client)
    id = None # object | 

    try:
        # Restore image
        api_response = api_instance.restore_image_grid(id)
        print("The response of ImageGridApi->restore_image_grid:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImageGridApi->restore_image_grid: %s\n" % e)

Parameters

Name Type Description Notes
id object

Return type

ImageGrid

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Ok -
401 Authentication Failed -
422 Validation Failed -
500 Internal Server Error -

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

update_image_grid

ImageGrid update_image_grid(id, wt_image_grid_update_params)

Update image

Example

import wallet
from wallet.models.image_grid import ImageGrid
from wallet.models.wt_image_grid_update_params import WTImageGridUpdateParams
from wallet.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wall.et
# See configuration.py for a list of all supported configuration parameters.
configuration = wallet.Configuration(
    host = "https://api.wall.et"
)


# Enter a context with an instance of the API client
with wallet.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wallet.ImageGridApi(api_client)
    id = None # object | 
    wt_image_grid_update_params = wallet.WTImageGridUpdateParams() # WTImageGridUpdateParams | 

    try:
        # Update image
        api_response = api_instance.update_image_grid(id, wt_image_grid_update_params)
        print("The response of ImageGridApi->update_image_grid:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImageGridApi->update_image_grid: %s\n" % e)

Parameters

Name Type Description Notes
id object
wt_image_grid_update_params WTImageGridUpdateParams

Return type

ImageGrid

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Ok -
401 Authentication Failed -
422 Validation Failed -
500 Internal Server Error -

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