From 60b259b33dc7c52e45719180521620ded6ebd142 Mon Sep 17 00:00:00 2001 From: Serraniel Date: Fri, 3 Mar 2023 17:51:58 +0100 Subject: [PATCH] Adds documentation with correct name --- docs/JpnCardsPokemon.Sdk.xml | 376 +++++++++++++++++++++++++++++++++++ docs/JpnCardsPokemonSdk.xml | 8 - 2 files changed, 376 insertions(+), 8 deletions(-) create mode 100644 docs/JpnCardsPokemon.Sdk.xml delete mode 100644 docs/JpnCardsPokemonSdk.xml diff --git a/docs/JpnCardsPokemon.Sdk.xml b/docs/JpnCardsPokemon.Sdk.xml new file mode 100644 index 0000000..92fb44d --- /dev/null +++ b/docs/JpnCardsPokemon.Sdk.xml @@ -0,0 +1,376 @@ + + + + JpnCardsPokemon.Sdk + + + + + Represents a card object from the web api. + + + + + The name of the card. + + + + + The internal identification number that the card is given. Used to query for this single card. + + + + + Reduced information about the set the card belongs to. + + May contain basic information only. It´s recommended to fetch the fully separately. + + + + The energy type of types the card is. + + Almost always will be a single value. + + + + The amount of HP the card has. + + If the card does not have HP, the value will be -1. + + + + If the card evolves from another card, this field will denote the name of the pre-evolution. + + + + + Describes rules the card is bound to. Mainly for cards with a rule box and certain Trainers. + + + + + A list of known prices for this card. + + May contain entries from different sellers, versions and conditions. + + + + List of the energies required to retreat. + + + + + The total number of energies needed to retreat. + + + + + The supertype the card is. + + Only possibilities are 'Pokemon', 'Trainer' or 'Energy'. + + + + The subsets that the card falls into. For example 'Single Strike Pokemon', 'Pokemon VMAX', etc. + + + + + The rarity of the card. + + + + + The card art's artist. + + + + + The url pointing to the card's image. + + + If there is no card image, then this will instead point to + https://assets.tcgcollector.com/build/images/default-card-image.789f6232.png. + + + + + The URL which leads to the original card URL data. + + + + + The sequential number of the card (applicable to Secret Rares). + + + + + The number printed on the card. Will be the same as almost always. Is relevant for + promotional cards, such as SWSH001. + + + + + A stable id for earch card. Output is an eight digit integer which is unique for each card. While the cards' + may change over time, the uuid should always remain stable and constant. + + + + + Contains information about card price. + + + + + Specifies the card version. Almost always will be 'Regular' but may contain other versions like 'Reverse Holo', + etc. + + + + + Specifies the card condition. Often will be a rating in format of 'A+', 'A', etc. but also can be 'NM' or other + similar descriptive strings. + + + + + The actual price for the specified version and condition. + + + + + The currency used for the . + + Almost always will be 'JYP' for Japanese Yen. + + + + Date when the price information was updated last. + + + + + An URL to the listing. + + + + + Name of the seller who is listing the card. + + + + + Represents a set object from the web api. + + + + + The name of the set. + + + + + The internal identification number that the set is given. Used to query for information about this single set or + for all cards in this single set. + + + + + The URL to a page which has more information about the set. + + + + + A URL to the official set's image. + + + + + The language that the cards in the set are printed in. + + + + + The year the set was released. + + + + + The total number of cards in the set. + + + + + The number of cards in the set that is printed on the card. This differs from the set's + in sets with Secret Rare cards. + + + + + The shorthand code for the set. + + + + + A stable id for earch card. Output is an eight digit integer which is unique for each card. While the cards' + may change over time, the uuid should always remain stable and constant. + + + + + A client to interact with the web api. + + + + + Creates a new instance of the ApiClient. + + Can pass a to use for the internal http client. + + + + Creates a new instance of the ApiClient. + + + + + Creates a new instance of the ApiClient. + + Can pass a http client to use. + + + + Fetches all . + + Returns an enumerable containing all . + + + + Fetches a by its id. + + Id of the to fetch. + If existing returns the matching . + + + + Fetches a by its uuid. + + Uuid of the to fetch. + If existing returns the matching . + + + + Fetches from a search query. + + The search query. + Returns an enumerable of matching the . + Thrown if the is empty. + + At least one filter query must be specified. More information about the query format can be found at + https://jpn-cards-site.readthedocs.io/en/latest/api_docs/pokemon/v2/v2_api/#card-queries. + + + + + Fetches from a search query. + + Configured query builder to generate the search query. + Returns an enumerable of matching the . + At least one filter must be specified. + + + + Abstract Implementation of an which builts the filter string based on + attributed properties. + + + + + + + + for . + + + + + Sets a filter for the . + + + + + Sets a filter for the . + + Must match the full name. + + + + Sets a filter for the by . + + + + + Sets a filter for the . + + Must match the full name. + + + + Sets a filter for the . + + + + + Sets a filter for the . + + + + + + Sets a filter for the . + + + + + Sets a filter for the . + + + + + Sets a filter for the by . + + + + + Defines an interface for a filter builder. + + + + + Builds the query filter to use for the api request. + + Returns the built query filter. + + + + Attribute which can be used to mark a property as a filter for the . + + + + + Creates a new query filter attribute with a custom filter name. + + Custom filter name for the web request. + + + + Creates a new query filter attribute. + + + + + Filter name for the web api. + + + + diff --git a/docs/JpnCardsPokemonSdk.xml b/docs/JpnCardsPokemonSdk.xml deleted file mode 100644 index 7abc56b..0000000 --- a/docs/JpnCardsPokemonSdk.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - JpnCardsPokemonSdk - - - -