corporations¶
- class pyZUnivers.corporations.Corporation(payload: Corporation)¶
Represents a corporation.
- id¶
The ID of the corporation.
- Type:
str
- name¶
The name of the corporation.
- Type:
str
- description¶
The description of the corporation.
- Type:
str
- balance¶
The balance of the corporation.
- Type:
int
- logo_url¶
The URL of the corporation’s logo.
- Type:
str
- logo_file_name¶
The file name of the corporation’s logo.
- Type:
str
- created_date¶
The created date of the corporation.
- Type:
datetime
- modified_date¶
The modified date of the corporation.
- Type:
datetime
- bonuses¶
The bonuses of the corporation.
- Type:
- donations¶
The donations made to the corporation.
- Type:
List[CorporationDonation]
- members¶
The members of the corporation.
- Type:
List[CorporationMember]
- url¶
The URL of the corporation.
- Type:
str
- static get_all_summary() List[CorporationSummary]¶
Retrieve all corporations.
- Returns:
Representing all corporations.
- Return type:
List[Corporation]
- static get_by_id(corporation_id: str) Corporation¶
Retrieve a corporation by its ID.
- Parameters:
corporation_id (str) – The ID of the corporation.
- Returns:
Representing the corporation.
- Return type:
- static get_by_name(corporation_name: str) Corporation¶
Retrieve a corporation by its name.
- Parameters:
corporation_name (str) – The name of the corporation.
- Returns:
Representing the corporation.
- Return type:
- static get_summary_by_id(corporation_id: str) CorporationSummary¶
Retrieve a corporation summary by its ID.
- Parameters:
corporation_id (str) – The ID of the corporation.
- Returns:
Representing the corporation.
- Return type:
CorporationSummary
- static get_summary_by_name(corporation_name: str) CorporationSummary¶
Retrieve a corporation summary by its name.
- Parameters:
corporation_name (str) – The name of the corporation.
- Returns:
Representing the corporation.
- Return type:
CorporationSummary
- class pyZUnivers.corporations.CorporationBonusAtrb(payload: CorporationBonus)¶
Represents a corporation bonus attributes.
- level¶
The level of the bonus.
- Type:
int
- class pyZUnivers.corporations.CorporationBonuses(payload: List[CorporationBonus])¶
Represents the corporation bonuses.
- member_count¶
The member count bonus.
- Type:
- loot¶
The loot bonus.
- Type:
- recycle_lore_dust¶
The recycle lore dust bonus.
- Type:
- recycle_lore_fragment¶
The recycle lore fragment bonus.
- Type:
- class pyZUnivers.corporations.CorporationDonation(payload: CorporationLedger)¶
Represents a corporation donation.
- amount¶
The amount of the donation.
- Type:
int
- date¶
The date of the donation.
- Type:
datetime
- user_name¶
The name of the user who made the donation.
- Type:
str
- user_id¶
The ID of the user who made the donation.
- Type:
int
- user_role¶
The role of the user who made the donation.
- Type:
str
- class pyZUnivers.corporations.CorporationMember(payload: CorporationUser)¶
Represents a corporation member.
- id¶
The ID of the user.
- Type:
int
- name¶
The name of the user.
- Type:
str
- role¶
The role of the user.
- Type:
str
- joined_date¶
The joined date of the user.
- Type:
datetime
- today_donations¶
The amount of donations the user made today.
- Type:
int
- total_donations¶
The total amount of donations the user made.
- Type:
int
- class pyZUnivers.corporations.UserCorporation(payload: UserCorporation)¶
Represents the user’s corporation.
- id¶
The ID of the corporation.
- Type:
str
- name¶
The name of the corporation.
- Type:
str
- description¶
The description of the corporation.
- Type:
str
- balance¶
The balance of the corporation.
- Type:
int
- logo_url¶
The URL of the corporation’s logo.
- Type:
str
- logo_file_name¶
The file name of the corporation’s logo.
- Type:
str
- created_date¶
The created date of the corporation.
- Type:
datetime
- modified_date¶
The modified date of the corporation.
- Type:
datetime
- joined_date¶
The joined date of the user in the corporation.
- Type:
datetime
- role¶
The role of the user in the corporation.
- Type:
str
- url¶
The URL of the corporation.
- Type:
str