Skip to content

Latest commit

 

History

History
210 lines (139 loc) · 13.3 KB

README.md

File metadata and controls

210 lines (139 loc) · 13.3 KB

TerminalApplications

(terminal_applications)

Overview

Available Operations

  • create - Create a new terminal application.

To access this endpoint using an access token you'll need to specify the /terminal-applications.write scope.

  • list - List all the terminal applications for a Moov Account.

To access this endpoint using an access token you'll need to specify the /terminal-applications.read scope.

  • get - Fetch a specific terminal application.

To access this endpoint using an access token you'll need to specify the /terminal-applications.read scope.

  • delete - Delete a specific terminal application.

To access this endpoint using an access token you'll need to specify the /terminal-applications.write scope.

create

Create a new terminal application.

To access this endpoint using an access token you'll need to specify the /terminal-applications.write scope.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


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

    res = moov.terminal_applications.create(platform=components.TerminalApplicationPlatform.IOS, app_bundle_id="com.example.app", package_name="com.example.app", sha256_digest="1234567890", version_code="1.0.0")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description Example
platform components.TerminalApplicationPlatform ✔️ Platform of the terminal application. ios
app_bundle_id Optional[str] ➖ The app bundle identifier of the terminal application. Required if platform is ios.
package_name Optional[str] ➖ The app package name of the terminal application. Required if platform is android.
sha256_digest Optional[str] ➖ The app version of the terminal application. Required if paltform is android.
version_code Optional[str] ➖ The app version of the terminal application. Required if platform is android.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.CreateTerminalApplicationResponse

Errors

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

list

List all the terminal applications for a Moov Account.

To access this endpoint using an access token you'll need to specify the /terminal-applications.read scope.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


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

    res = moov.terminal_applications.list()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
request operations.ListTerminalApplicationsRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.ListTerminalApplicationsResponse

Errors

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

get

Fetch a specific terminal application.

To access this endpoint using an access token you'll need to specify the /terminal-applications.read scope.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


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

    res = moov.terminal_applications.get(terminal_application_id="12345678-1234-1234-1234-123456789012")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description Example
terminal_application_id str ✔️ N/A 12345678-1234-1234-1234-123456789012
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.GetTerminalApplicationResponse

Errors

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

delete

Delete a specific terminal application.

To access this endpoint using an access token you'll need to specify the /terminal-applications.write scope.

Example Usage

from moovio_sdk import Moov
from moovio_sdk.models import components


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

    res = moov.terminal_applications.delete(terminal_application_id="12345678-1234-1234-1234-123456789012")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description Example
terminal_application_id str ✔️ N/A 12345678-1234-1234-1234-123456789012
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.DeleteTerminalApplicationResponse

Errors

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