ask_smapi_model.v1 package

Subpackages

Submodules

Note

Canonical imports have been added in the __init__.py of the package. This helps in importing the class directly from the package, than through the module.

For eg: if package a has module b with class C, you can do from a import C instead of from a.b import C.

ask_smapi_model.v1.bad_request_error module

class ask_smapi_model.v1.bad_request_error.BadRequestError(message=None, violations=None)

Bases: object

Parameters:
attribute_map = {'message': 'message', 'violations': 'violations'}
deserialized_types = {'message': 'str', 'violations': 'list[ask_smapi_model.v1.error.Error]'}
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.error module

class ask_smapi_model.v1.error.Error(code=None, message=None)

Bases: object

Parameters:
  • code ((optional) str) – Error code that maps to an error message. Developers with different locales should be able to lookup the error description based on this code.
  • message ((optional) str) – Readable description of error. If standardized, this is generated from the error code and validation details.
attribute_map = {'code': 'code', 'message': 'message'}
deserialized_types = {'code': 'str', 'message': 'str'}
supports_multiple_types = False
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.stage_type module

class ask_smapi_model.v1.stage_type.StageType

Bases: enum.Enum

Allowed enum values: [development, live]

development = 'development'
live = 'live'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.stage_v2_type module

class ask_smapi_model.v1.stage_v2_type.StageV2Type

Bases: enum.Enum

Allowed enum values: [live, certified, development]

certified = 'certified'
development = 'development'
live = 'live'
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model