module XIVAPI::Client::FreeCompany

Direct including types

XIVAPI::Client

Defined in:

Instance Method Summary

#free_company(id : String, members : Bool = false) : Dataclasses::FreeCompanyResponse
Retrieve the details of the FreeCompany with the given Lodestone ID.
#free_company_search(name : String, server : String = "", page : UInt32 = 1) : Dataclasses::Page(Dataclasses::FreeCompanyProfile)
Search the Lodestone API for Free Companies with a given name.

Instance Method Detail

def free_company(id : String, members : Bool = false) : Dataclasses::FreeCompanyResponse #

Retrieve the details of the FreeCompany with the given Lodestone ID. If the Members Array is also needed, then it can be requested using the members flag by setting it to true.

[View source]

def free_company_search(name : String, server : String = "", page : UInt32 = 1) : Dataclasses::Page(Dataclasses::FreeCompanyProfile) #

Search the Lodestone API for Free Companies with a given name. Optionally, search specific servers.