everyaction.services.Codes

class everyaction.services.Codes(ea: EAClient)

Represents the Codes service.

Methods

create(**kwargs)	See POST /codes.
create_each(**kwargs)	See POST /codes/batch.
delete(code_id, /)	See DELETE /codes/{codeId}.
delete_each(*, data)	See DELETE /codes.
get(code_id, /)	See GET /codes/{codeId}.
list(*[, limit])	See GET /codes.
supported_entities()	See GET /codes/supportedEntities.
types()	See GET /codeTypes.
update(code_id, /, **kwargs)	See PUT /codes/{codeId}.
update_each(**kwargs)	See PUT /codes.

create(**kwargs: EAValue) → Code

See POST /codes.

Parameters

kwargs – The applicable query arguments and JSON data for the request. A Code is appropriate to unpack here.

Returns

The created Code object.

Keyword Arguments

• codeId (code_id, id)

• codeType (code_type, type)

• dateCreated (date_created, created)

• dateModified (date_modified, modified)

• description (desc)

• name

• parentCodeId (parent_code_id, parent_code)

• supportedEntities (supported_entities, entities, entity (singular))

create_each(**kwargs: EAValue) → List[CodeResult]

See POST /codes/batch.

Parameters

kwargs – The applicable query arguments and JSON data for the request.

Returns

List of the resulting CodeResult objects for each code to be created.

Keyword Arguments

• codes (code (singular))

delete(code_id: int, /) → None

See DELETE /codes/{codeId}.

Parameters

code_id – The codeId path parameter.

delete_each(*, data: List[int]) → List[CodeResult]

See DELETE /codes.

Parameters

data – The ids of the codes to delete.

Returns

List of the resulting CodeResult objects for each code to be deleted.

get(code_id: int, /) → Code

See GET /codes/{codeId}.

Parameters

code_id – The codeId path parameter.

Returns

The resulting Code object.

list(*, limit: Optional[int] = None, **kwargs: EAValue) → List[Code]

See GET /codes.

Parameters

• limit – Maximum number of records to get for this request.

• kwargs – The applicable query arguments and JSON data for the request.

Returns

List of the resulting Code objects.

Keyword Arguments

• codeType (type)

• expand

• name

• orderby (order_by)

• parentCodeId (parent_code_id, parent_code)

• supportedEntities (supported_entities, entities, entity (singular))

supported_entities() → List[str]

See GET /codes/supportedEntities.

Returns

List of the names of the supported entities.

types() → List[str]

See GET /codeTypes.

Returns

List of the names of the code types.

update(code_id: int, /, **kwargs: EAValue) → None

See PUT /codes/{codeId}.

Parameters

• code_id – The codeId path parameter.

• kwargs – The applicable query arguments and JSON data for the request. A Code is appropriate to unpack here.

Keyword Arguments

• codeId (code_id, id)

• codeType (code_type, type)

• dateCreated (date_created, created)

• dateModified (date_modified, modified)

• description (desc)

• name

• parentCodeId (parent_code_id, parent_code)

• supportedEntities (supported_entities, entities, entity (singular))

update_each(**kwargs: EAValue) → List[CodeResult]

See PUT /codes.

Parameters

kwargs – The applicable query arguments and JSON data for the request.

Returns

List of the resulting CodeResult objects for each code to be updated.

Keyword Arguments

• codes (code (singular))