tic-tac-toe-backend 3.0.3

Tic Tac Toe Backend Python Client SDK

tic-tac-toe-backend

SDK Installation

pip install tic-tac-toe-backend

SDK Example Usage

Example

import tic_tac_toe_backends

s = tic_tac_toe_backends.TicTacToeBackends()


res = s.get_()

if res.body is not None:
    # handle response
    pass

Available Resources and Operations

TicTacToeBackends SDK

• get_ - Root endpoint.
• get_version - Root endpoint.
• put_games - Games endpoint. Creates the next game state from the previous game state.

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a Next method that can be called to pull down the next group of results. If the return value of Next is None, then there are no more pages to be fetched.

Here's an example of one such pagination call:

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.

Error Object	Status Code	Content Type
errors.SDKError	400-600	/

Example

import tic_tac_toe_backends

s = tic_tac_toe_backends.TicTacToeBackends()


res = None
try:
    res = s.get_()

except (errors.SDKError) as e:
    print(e) # handle exception


if res.body is not None:
    # handle response
    pass

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server	Variables
0	http://localhost:5000/	None
1	https://localhost:5000/	None

Example

import tic_tac_toe_backends

s = tic_tac_toe_backends.TicTacToeBackends(
    server_idx=1,
)


res = s.get_()

if res.body is not None:
    # handle response
    pass

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

import tic_tac_toe_backends

s = tic_tac_toe_backends.TicTacToeBackends(
    server_url="http://localhost:5000/",
)


res = s.get_()

if res.body is not None:
    # handle response
    pass

Custom HTTP Client

The Python SDK makes API calls using the (requests)[https://pypi.org/project/requests/] HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom requests.Session object.

For example, you could specify a header for every request that this sdk makes as follows:

import tic_tac_toe_backends
import requests

http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = tic_tac_toe_backends.TicTacToeBackends(client: http_client)

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy