Account

class ab.api.endpoints.account.AccountEndpoint(client)[source]

Current-user account operations (ACPortal API).

Parameters:

client (HttpClient)

get_profile()[source]

GET /account/profile — the authenticated user’s account profile.

Returns the profile of whoever the client’s token belongs to (user name, email, company, contact id, roles).

Response model: AccountProfile

Docs: https://ab-sdk.readthedocs.io/en/latest/api/account/get_profile.html Response model: AccountProfile

Return type:

AccountProfile

delete_account_paymentsource_source_id(source_id)

DELETE /account/paymentsource/{sourceId}

Schema route on the acportal API surface. This SDK method is a placeholder and raises NotImplementedError until request/response models and dispatch behavior are implemented.

Parameters:

self (BaseEndpoint)

Return type:

Any

get_account_verifyresettoken()

GET /account/verifyresettoken

Schema route on the acportal API surface. This SDK method is a placeholder and raises NotImplementedError until request/response models and dispatch behavior are implemented.

Parameters:

self (BaseEndpoint)

Return type:

Any

post_account_confirm(*, data=None)

POST /account/confirm

Schema route on the acportal API surface. This SDK method is a placeholder and raises NotImplementedError until request/response models and dispatch behavior are implemented.

Parameters:

  • self (BaseEndpoint)

  • data (Any)

Return type:

Any

post_account_forgot(*, data=None)

POST /account/forgot

Schema route on the acportal API surface. This SDK method is a placeholder and raises NotImplementedError until request/response models and dispatch behavior are implemented.

Parameters:

  • self (BaseEndpoint)

  • data (Any)

Return type:

Any

post_account_register(*, data=None)

POST /account/register

Schema route on the acportal API surface. This SDK method is a placeholder and raises NotImplementedError until request/response models and dispatch behavior are implemented.

Parameters:

  • self (BaseEndpoint)

  • data (Any)

Return type:

Any

post_account_resetpassword(*, data=None)

POST /account/resetpassword

Schema route on the acportal API surface. This SDK method is a placeholder and raises NotImplementedError until request/response models and dispatch behavior are implemented.

Parameters:

  • self (BaseEndpoint)

  • data (Any)

Return type:

Any

post_account_send_confirmation(*, data=None)

POST /account/sendConfirmation

Schema route on the acportal API surface. This SDK method is a placeholder and raises NotImplementedError until request/response models and dispatch behavior are implemented.

Parameters:

  • self (BaseEndpoint)

  • data (Any)

Return type:

Any

post_account_setpassword(*, data=None)

POST /account/setpassword

Schema route on the acportal API surface. This SDK method is a placeholder and raises NotImplementedError until request/response models and dispatch behavior are implemented.

Parameters:

  • self (BaseEndpoint)

  • data (Any)

Return type:

Any

put_account_paymentsource_source_id(source_id, *, data=None)

PUT /account/paymentsource/{sourceId}

Schema route on the acportal API surface. This SDK method is a placeholder and raises NotImplementedError until request/response models and dispatch behavior are implemented.

Parameters:

  • self (BaseEndpoint)

  • data (Any)

Return type:

Any

Per-endpoint reference

Each route-backed method has its own page rendering the HTTP route, the Python and CLI call signatures, and the request/response model field tables. This is the page help(api.account.<method>) links to via its Docs: footer. These pages are generated by scripts/generate_endpoint_docs.py and kept current by a CI freshness gate.

Methods

get_profile

GET /account/profile — The authenticated user’s account profile (user name, email, company, contact id, roles).

profile = api.account.get_profile()
print(profile.company_id)