C# Class IO.Swagger.Api.PetApi

Represents a collection of functions to interact with the API endpoints

Inheritance: IPetApi

Mostra file Open project: QualityUnit/swagger-codegen Class Usage Examples

Public Methods

Method	Description
AddPet ( Pet body ) : void	Add a new pet to the store
AddPetAsync ( Pet body ) : System.Threading.Tasks.Task	Add a new pet to the store
AddPetAsyncWithHttpInfo ( Pet body ) : System.Threading.Tasks.Task>	Add a new pet to the store
AddPetWithHttpInfo ( Pet body ) : ApiResponse	Add a new pet to the store
DeletePet ( long petId, string apiKey = null ) : void	Deletes a pet
DeletePetAsync ( long petId, string apiKey = null ) : System.Threading.Tasks.Task	Deletes a pet
DeletePetAsyncWithHttpInfo ( long petId, string apiKey = null ) : System.Threading.Tasks.Task>	Deletes a pet
DeletePetWithHttpInfo ( long petId, string apiKey = null ) : ApiResponse	Deletes a pet
FindPetsByStatus ( List status ) : List	Finds Pets by status Multiple status values can be provided with comma separated strings
FindPetsByStatusAsync ( List status ) : System.Threading.Tasks.Task>	Finds Pets by status Multiple status values can be provided with comma separated strings
FindPetsByStatusAsyncWithHttpInfo ( List status ) : System.Threading.Tasks.Task>>	Finds Pets by status Multiple status values can be provided with comma separated strings
FindPetsByStatusWithHttpInfo ( List status ) : ApiResponse>	Finds Pets by status Multiple status values can be provided with comma separated strings
FindPetsByTags ( List tags ) : List	Finds Pets by tags Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
FindPetsByTagsAsync ( List tags ) : System.Threading.Tasks.Task>	Finds Pets by tags Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
FindPetsByTagsAsyncWithHttpInfo ( List tags ) : System.Threading.Tasks.Task>>	Finds Pets by tags Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
FindPetsByTagsWithHttpInfo ( List tags ) : ApiResponse>	Finds Pets by tags Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
GetBasePath ( ) : String	Gets the base path of the API client.
GetPetById ( long petId ) : Pet	Find pet by ID Returns a single pet
GetPetByIdAsync ( long petId ) : System.Threading.Tasks.Task	Find pet by ID Returns a single pet
GetPetByIdAsyncWithHttpInfo ( long petId ) : System.Threading.Tasks.Task>	Find pet by ID Returns a single pet
GetPetByIdWithHttpInfo ( long petId ) : ApiResponse	Find pet by ID Returns a single pet
PetApi ( Configuration configuration = null ) : System	Initializes a new instance of the PetApi class using Configuration object
PetApi ( String basePath ) : System	Initializes a new instance of the PetApi class.
UpdatePet ( Pet body ) : void	Update an existing pet
UpdatePetAsync ( Pet body ) : System.Threading.Tasks.Task	Update an existing pet
UpdatePetAsyncWithHttpInfo ( Pet body ) : System.Threading.Tasks.Task>	Update an existing pet
UpdatePetWithForm ( long petId, string name = null, string status = null ) : void	Updates a pet in the store with form data
UpdatePetWithFormAsync ( long petId, string name = null, string status = null ) : System.Threading.Tasks.Task	Updates a pet in the store with form data
UpdatePetWithFormAsyncWithHttpInfo ( long petId, string name = null, string status = null ) : System.Threading.Tasks.Task>	Updates a pet in the store with form data
UpdatePetWithFormWithHttpInfo ( long petId, string name = null, string status = null ) : ApiResponse	Updates a pet in the store with form data
UpdatePetWithHttpInfo ( Pet body ) : ApiResponse	Update an existing pet
UploadFile ( long petId, string additionalMetadata = null, System file = null ) : ApiResponse	uploads an image
UploadFileAsync ( long petId, string additionalMetadata = null, System file = null ) : System.Threading.Tasks.Task	uploads an image
UploadFileAsyncWithHttpInfo ( long petId, string additionalMetadata = null, System file = null ) : System.Threading.Tasks.Task>	uploads an image
UploadFileWithHttpInfo ( long petId, string additionalMetadata = null, System file = null ) : ApiResponse	uploads an image

Private Methods

Method	Description
AddDefaultHeader ( string key, string value ) : void
DefaultHeader ( ) : String>.Dictionary
SetBasePath ( String basePath ) : void

Method Details

AddPet() public method

Add a new pet to the store

Thrown when fails to make API call

public AddPet ( Pet body ) : void
body	IO.Swagger.Model.Pet	Pet object that needs to be added to the store
return	void

AddPetAsync() public method

Add a new pet to the store

Thrown when fails to make API call

public AddPetAsync ( Pet body ) : System.Threading.Tasks.Task
body	IO.Swagger.Model.Pet	Pet object that needs to be added to the store
return	System.Threading.Tasks.Task

AddPetAsyncWithHttpInfo() public method

Add a new pet to the store

Thrown when fails to make API call

public AddPetAsyncWithHttpInfo ( Pet body ) : System.Threading.Tasks.Task>
body	IO.Swagger.Model.Pet	Pet object that needs to be added to the store
return	System.Threading.Tasks.Task>

AddPetWithHttpInfo() public method

Add a new pet to the store

Thrown when fails to make API call

public AddPetWithHttpInfo ( Pet body ) : ApiResponse
body	Pet	Pet object that needs to be added to the store
return	ApiResponse

DeletePet() public method

Deletes a pet

Thrown when fails to make API call

public DeletePet ( long petId, string apiKey = null ) : void
petId	long	Pet id to delete
apiKey	string	(optional)
return	void

DeletePetAsync() public method

Deletes a pet

Thrown when fails to make API call

public DeletePetAsync ( long petId, string apiKey = null ) : System.Threading.Tasks.Task
petId	long	Pet id to delete
apiKey	string	(optional)
return	System.Threading.Tasks.Task

DeletePetAsyncWithHttpInfo() public method

Deletes a pet

Thrown when fails to make API call

public DeletePetAsyncWithHttpInfo ( long petId, string apiKey = null ) : System.Threading.Tasks.Task>
petId	long	Pet id to delete
apiKey	string	(optional)
return	System.Threading.Tasks.Task>

DeletePetWithHttpInfo() public method

Deletes a pet

Thrown when fails to make API call

public DeletePetWithHttpInfo ( long petId, string apiKey = null ) : ApiResponse
petId	long	Pet id to delete
apiKey	string	(optional)
return	ApiResponse

FindPetsByStatus() public method

Finds Pets by status Multiple status values can be provided with comma separated strings

Thrown when fails to make API call

public FindPetsByStatus ( List status ) : List
status	List	Status values that need to be considered for filter
return	List

FindPetsByStatusAsync() public method

Finds Pets by status Multiple status values can be provided with comma separated strings

Thrown when fails to make API call

public FindPetsByStatusAsync ( List status ) : System.Threading.Tasks.Task>
status	List	Status values that need to be considered for filter
return	System.Threading.Tasks.Task>

FindPetsByStatusAsyncWithHttpInfo() public method

Finds Pets by status Multiple status values can be provided with comma separated strings

Thrown when fails to make API call

public FindPetsByStatusAsyncWithHttpInfo ( List status ) : System.Threading.Tasks.Task>>
status	List	Status values that need to be considered for filter
return	System.Threading.Tasks.Task>>

FindPetsByStatusWithHttpInfo() public method

Finds Pets by status Multiple status values can be provided with comma separated strings

Thrown when fails to make API call

public FindPetsByStatusWithHttpInfo ( List status ) : ApiResponse>
status	List	Status values that need to be considered for filter
return	ApiResponse>

FindPetsByTags() public method

Finds Pets by tags Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

Thrown when fails to make API call

public FindPetsByTags ( List tags ) : List
tags	List	Tags to filter by
return	List

FindPetsByTagsAsync() public method

Finds Pets by tags Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

Thrown when fails to make API call

public FindPetsByTagsAsync ( List tags ) : System.Threading.Tasks.Task>
tags	List	Tags to filter by
return	System.Threading.Tasks.Task>

FindPetsByTagsAsyncWithHttpInfo() public method

Finds Pets by tags Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

Thrown when fails to make API call

public FindPetsByTagsAsyncWithHttpInfo ( List tags ) : System.Threading.Tasks.Task>>
tags	List	Tags to filter by
return	System.Threading.Tasks.Task>>

FindPetsByTagsWithHttpInfo() public method

Finds Pets by tags Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

Thrown when fails to make API call

public FindPetsByTagsWithHttpInfo ( List tags ) : ApiResponse>
tags	List	Tags to filter by
return	ApiResponse>

GetBasePath() public method

Gets the base path of the API client.

public GetBasePath ( ) : String
return	String

GetPetById() public method

Find pet by ID Returns a single pet

Thrown when fails to make API call

public GetPetById ( long petId ) : Pet
petId	long	ID of pet to return
return	Pet

GetPetByIdAsync() public method

Find pet by ID Returns a single pet

Thrown when fails to make API call

public GetPetByIdAsync ( long petId ) : System.Threading.Tasks.Task
petId	long	ID of pet to return
return	System.Threading.Tasks.Task

GetPetByIdAsyncWithHttpInfo() public method

Find pet by ID Returns a single pet

Thrown when fails to make API call

public GetPetByIdAsyncWithHttpInfo ( long petId ) : System.Threading.Tasks.Task>
petId	long	ID of pet to return
return	System.Threading.Tasks.Task>

GetPetByIdWithHttpInfo() public method

Find pet by ID Returns a single pet

Thrown when fails to make API call

public GetPetByIdWithHttpInfo ( long petId ) : ApiResponse
petId	long	ID of pet to return
return	ApiResponse

PetApi() public method

Initializes a new instance of the PetApi class using Configuration object

public PetApi ( Configuration configuration = null ) : System
configuration	Configuration	An instance of Configuration
return	System

PetApi() public method

Initializes a new instance of the PetApi class.

public PetApi ( String basePath ) : System
basePath	String
return	System

UpdatePet() public method

Update an existing pet

Thrown when fails to make API call

public UpdatePet ( Pet body ) : void
body	Pet	Pet object that needs to be added to the store
return	void

UpdatePetAsync() public method

Update an existing pet

Thrown when fails to make API call

public UpdatePetAsync ( Pet body ) : System.Threading.Tasks.Task
body	Pet	Pet object that needs to be added to the store
return	System.Threading.Tasks.Task

UpdatePetAsyncWithHttpInfo() public method

Update an existing pet

Thrown when fails to make API call

public UpdatePetAsyncWithHttpInfo ( Pet body ) : System.Threading.Tasks.Task>
body	Pet	Pet object that needs to be added to the store
return	System.Threading.Tasks.Task>

UpdatePetWithForm() public method

Updates a pet in the store with form data

Thrown when fails to make API call

public UpdatePetWithForm ( long petId, string name = null, string status = null ) : void
petId	long	ID of pet that needs to be updated
name	string	Updated name of the pet (optional)
status	string	Updated status of the pet (optional)
return	void

UpdatePetWithFormAsync() public method

Updates a pet in the store with form data

Thrown when fails to make API call

public UpdatePetWithFormAsync ( long petId, string name = null, string status = null ) : System.Threading.Tasks.Task
petId	long	ID of pet that needs to be updated
name	string	Updated name of the pet (optional)
status	string	Updated status of the pet (optional)
return	System.Threading.Tasks.Task

UpdatePetWithFormAsyncWithHttpInfo() public method

Updates a pet in the store with form data

Thrown when fails to make API call

public UpdatePetWithFormAsyncWithHttpInfo ( long petId, string name = null, string status = null ) : System.Threading.Tasks.Task>
petId	long	ID of pet that needs to be updated
name	string	Updated name of the pet (optional)
status	string	Updated status of the pet (optional)
return	System.Threading.Tasks.Task>

UpdatePetWithFormWithHttpInfo() public method

Updates a pet in the store with form data

Thrown when fails to make API call

public UpdatePetWithFormWithHttpInfo ( long petId, string name = null, string status = null ) : ApiResponse
petId	long	ID of pet that needs to be updated
name	string	Updated name of the pet (optional)
status	string	Updated status of the pet (optional)
return	ApiResponse

UpdatePetWithHttpInfo() public method

Update an existing pet

Thrown when fails to make API call

public UpdatePetWithHttpInfo ( Pet body ) : ApiResponse
body	Pet	Pet object that needs to be added to the store
return	ApiResponse

UploadFile() public method

uploads an image

Thrown when fails to make API call

public UploadFile ( long petId, string additionalMetadata = null, System file = null ) : ApiResponse
petId	long	ID of pet to update
additionalMetadata	string	Additional data to pass to server (optional)
file	System	file to upload (optional)
return	ApiResponse

UploadFileAsync() public method

uploads an image

Thrown when fails to make API call

public UploadFileAsync ( long petId, string additionalMetadata = null, System file = null ) : System.Threading.Tasks.Task
petId	long	ID of pet to update
additionalMetadata	string	Additional data to pass to server (optional)
file	System	file to upload (optional)
return	System.Threading.Tasks.Task

UploadFileAsyncWithHttpInfo() public method

uploads an image

Thrown when fails to make API call

public UploadFileAsyncWithHttpInfo ( long petId, string additionalMetadata = null, System file = null ) : System.Threading.Tasks.Task>
petId	long	ID of pet to update
additionalMetadata	string	Additional data to pass to server (optional)
file	System	file to upload (optional)
return	System.Threading.Tasks.Task>

UploadFileWithHttpInfo() public method

uploads an image

Thrown when fails to make API call

public UploadFileWithHttpInfo ( long petId, string additionalMetadata = null, System file = null ) : ApiResponse
petId	long	ID of pet to update
additionalMetadata	string	Additional data to pass to server (optional)
file	System	file to upload (optional)
return	ApiResponse