Skip to content

README.md

Latest commit

 

History

History
348 lines (236 loc) · 26.3 KB

README.md

File metadata and controls

348 lines (236 loc) · 26.3 KB

Images

Overview

Available Operations

  • list - List metadata for all images in the specified account.
  • upload - Upload a new PNG, JPEG, or WebP image with optional metadata. Duplicate images, and requests larger than 16MB will be rejected.
  • get_metadata - Retrieve metadata for a specific image by its ID.
  • update - Replace an existing image and, optionally, its metadata.

This endpoint replaces the existing image with the new PNG, JPEG, or WebP. Omit the metadata form section to keep existing metadata. Duplicate images, and requests larger than 16MB will be rejected.

  • delete - Disable an image by its ID.

    Disabled images are still be accessible via their public URL, and cannot be assigned to products or line-items.

  • update_metadata - Replace the metadata for an existing image.

  • get_public - Get an image by its public ID.

list

List metadata for all images in the specified account.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.images.list(account_id="3a4ed2d9-03e1-4b0e-b45f-2a9ca72f8adb", skip=60, count=20)

    # Handle response
    print(res)

Parameters

Parameter Type Required Description Example
account_id str ✔️ N/A
skip Optional[int] ➖ N/A 60
count Optional[int] ➖ N/A 20
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.ListImageMetadataResponse

Errors

Error Type Status Code Content Type
errors.APIError 4XX, 5XX */*

upload

Upload a new PNG, JPEG, or WebP image with optional metadata. Duplicate images, and requests larger than 16MB will be rejected.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.images.upload(account_id="c0971a52-1f1c-4511-876a-f45c4cfd6154", image={
        "file_name": "example.file",
        "content": open("example.file", "rb"),
    })

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
account_id str ✔️ N/A
image components.Image ✔️ A PNG, JPEG, or WebP image file to upload.
metadata Optional[components.ImageMetadataRequest] ➖ Optional, json-encoded metadata to associate with the uploaded image.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.UploadImageResponse

Errors

Error Type Status Code Content Type
errors.GenericError 400, 409 application/json
errors.ImageRequestValidationError 422 application/json
errors.APIError 4XX, 5XX */*

get_metadata

Retrieve metadata for a specific image by its ID.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.images.get_metadata(account_id="6cf66a43-31ce-4d27-8dd4-130fa57f0a6f", image_id="7cec5bd3-6340-4de4-a923-bf6ec0f7e921")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
account_id str ✔️ N/A
image_id str ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.GetImageMetadataResponse

Errors

Error Type Status Code Content Type
errors.APIError 4XX, 5XX */*

update

Replace an existing image and, optionally, its metadata.

This endpoint replaces the existing image with the new PNG, JPEG, or WebP. Omit the metadata form section to keep existing metadata. Duplicate images, and requests larger than 16MB will be rejected.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.images.update(account_id="310f4f19-45cf-4429-9aae-8e93827ecb0d", image_id="8ef109f8-5a61-4355-b2e4-b8ac2f6f6f47", image={
        "file_name": "example.file",
        "content": open("example.file", "rb"),
    })

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
account_id str ✔️ N/A
image_id str ✔️ N/A
image components.Image ✔️ A PNG, JPEG, or WebP image file to upload.
metadata Optional[components.ImageMetadataRequest] ➖ Optional, json-encoded metadata to associate with the uploaded image.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.UpdateImageResponse

Errors

Error Type Status Code Content Type
errors.GenericError 400, 409 application/json
errors.ImageRequestValidationError 422 application/json
errors.APIError 4XX, 5XX */*

delete

Disable an image by its ID.

Disabled images are still be accessible via their public URL, and cannot be assigned to products or line-items.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.images.delete(account_id="866c32ce-2536-4b21-8e12-f8c474fb2a9b", image_id="ca048253-31d2-4bfb-9077-1f07a2a09f26")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
account_id str ✔️ N/A
image_id str ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.DeleteImageResponse

Errors

Error Type Status Code Content Type
errors.GenericError 400, 409 application/json
errors.APIError 4XX, 5XX */*

update_metadata

Replace the metadata for an existing image.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.images.update_metadata(account_id="58c3c937-e648-49c5-88be-6225cca35af1", image_id="d957e703-ecd4-48ac-9c14-c0ecf1b496f0")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
account_id str ✔️ N/A
image_id str ✔️ N/A
alt_text Optional[str] ➖ Alternative text for the image.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.UpdateImageMetadataResponse

Errors

Error Type Status Code Content Type
errors.GenericError 400, 409 application/json
errors.ImageMetadataValidationError 422 application/json
errors.APIError 4XX, 5XX */*

get_public

Get an image by its public ID.

Example Usage

from moovio_sdk import Moov


with Moov() as moov:

    res = moov.images.get_public(public_id="<id>", size="400x400")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
public_id str ✔️ N/A
if_none_match Optional[str] ➖ N/A
size Optional[str] ➖ Optional parameter to request a resized version of the image (WxH).

If either dimension is 0, the image will be scaled proportionally based on
the non-zero dimension. Dimensions are capped at 2048 pixels. A default size
of 400x400 will be used if this parameter is omitted.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.GetPublicImageResponse

Errors

Error Type Status Code Content Type
errors.APIError 4XX, 5XX */*