eBay::API::XML::Call::GetAccount::GetAccountResponseType - eBay::API::XML::Call::GetAccount::GetAccountResponseType documentation

eBay-API documentation Contained in the eBay-API distribution.

Index

Code Index:

NAME

Top

eBay::API::XML::Call::GetAccount::GetAccountResponseType

DESCRIPTION

Top

Returns information about an eBay seller's own account.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::GetAccount::GetAccountResponseType inherits from the eBay::API::XML::ResponseDataType class

Subroutines:

Top

setAccountEntries()

Contains individual account entries, according to the report's scope and date range. Each account entry represents one credit, debit, or administrative account action.

# Argument: 'ns:AccountEntriesType'

getAccountEntries()

  Returned: Conditionally
#    Returns: 'ns:AccountEntriesType'

setAccountID()

Specifies the seller's unique account number.

# Argument: 'xs:string'

getAccountID()

  Returned: Always
#    Returns: 'xs:string'

setAccountSummary()

Contains summary data for the seller's account, such as the overall balance, bank account and credit card information, and amount and date of any past due balances. Can also contain data for one or more additional accounts, if the user has changed country of residence.

# Argument: 'ns:AccountSummaryType'

getAccountSummary()

  Returned: Conditionally
#    Returns: 'ns:AccountSummaryType'

setCurrency()

Indicates the currency used for monetary amounts in the report.

# Argument: 'ns:CurrencyCodeType'

getCurrency()

  Returned: Always
#    Returns: 'ns:CurrencyCodeType'

setEntriesPerPage()

Specifies the number of items that are being returned per virtual page of date. Value is the same as that specified in Pagination.EntriesPerPage.

# Argument: 'xs:int'

getEntriesPerPage()

  Returned: Always
#    Returns: 'xs:int'

setHasMoreEntries()

Indicates whether there are more items yet to be retrieved. Additional calls must be made to retrieve those items.

# Argument: 'xs:boolean'

isHasMoreEntries()

  Returned: Conditionally
#    Returns: 'xs:boolean'

setPageNumber()

Indicates which page of data was just returned. Value is the same as the value specified in Pagination.PageNumber. If PageNumber in the request is higher than the total number of pages, the call fails with an error.)

# Argument: 'xs:int'

getPageNumber()

  Returned: Always
#    Returns: 'xs:int'

setPaginationResult()

Contains the total number of pages (TotalNumberOfPages) and the total number of account entries (TotalNumberOfEntries) that can be returned on repeated calls with the same format and report criteria.

# Argument: 'ns:PaginationResultType'

getPaginationResult()

  Returned: Always
#    Returns: 'ns:PaginationResultType'
eBay-API documentation Contained in the eBay-API distribution. 
#!/usr/bin/perl

package eBay::API::XML::Call::GetAccount::GetAccountResponseType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. GetAccountResponseType.pm
# Generated by: ......... genEBayApiDataTypes.pl
# Last Generated: ....... 08/24/2008 16:44
# API Release Number: ... 579
#
##########################################################################  


use eBay::API::XML::ResponseDataType;
our @ISA = ("eBay::API::XML::ResponseDataType");

use eBay::API::XML::DataType::AccountEntriesType;
use eBay::API::XML::DataType::AccountSummaryType;
use eBay::API::XML::DataType::PaginationResultType;
use eBay::API::XML::DataType::Enum::CurrencyCodeType;


my @gaProperties = ( [ 'AccountEntries', 'ns:AccountEntriesType', ''
	     ,'eBay::API::XML::DataType::AccountEntriesType', '1' ]
	, [ 'AccountID', 'xs:string', '', '', '' ]
	, [ 'AccountSummary', 'ns:AccountSummaryType', ''
	     ,'eBay::API::XML::DataType::AccountSummaryType', '1' ]
	, [ 'Currency', 'ns:CurrencyCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::CurrencyCodeType', '' ]
	, [ 'EntriesPerPage', 'xs:int', '', '', '' ]
	, [ 'HasMoreEntries', 'xs:boolean', '', '', '' ]
	, [ 'PageNumber', 'xs:int', '', '', '' ]
	, [ 'PaginationResult', 'ns:PaginationResultType', ''
	     ,'eBay::API::XML::DataType::PaginationResultType', '1' ]
                    );
push @gaProperties, @{eBay::API::XML::ResponseDataType::getPropertiesList()};

my @gaAttributes = ( 
                    );
push @gaAttributes, @{eBay::API::XML::ResponseDataType::getAttributesList()};


sub new {
  my $classname = shift;
  my %args = @_;
  my $self = $classname->SUPER::new(%args);
  return $self;
}

sub isScalar {
   return 0; 
}




sub setAccountEntries {
  my $self = shift;
  $self->{'AccountEntries'} = shift
}


sub getAccountEntries {
  my $self = shift;
  return $self->_getDataTypeInstance( 'AccountEntries'
		,'eBay::API::XML::DataType::AccountEntriesType');
}



sub setAccountID {
  my $self = shift;
  $self->{'AccountID'} = shift
}


sub getAccountID {
  my $self = shift;
  return $self->{'AccountID'};
}



sub setAccountSummary {
  my $self = shift;
  $self->{'AccountSummary'} = shift
}


sub getAccountSummary {
  my $self = shift;
  return $self->_getDataTypeInstance( 'AccountSummary'
		,'eBay::API::XML::DataType::AccountSummaryType');
}



sub setCurrency {
  my $self = shift;
  $self->{'Currency'} = shift
}


sub getCurrency {
  my $self = shift;
  return $self->{'Currency'};
}



sub setEntriesPerPage {
  my $self = shift;
  $self->{'EntriesPerPage'} = shift
}


sub getEntriesPerPage {
  my $self = shift;
  return $self->{'EntriesPerPage'};
}



sub setHasMoreEntries {
  my $self = shift;
  $self->{'HasMoreEntries'} = shift
}


sub isHasMoreEntries {
  my $self = shift;
  return $self->{'HasMoreEntries'};
}



sub setPageNumber {
  my $self = shift;
  $self->{'PageNumber'} = shift
}


sub getPageNumber {
  my $self = shift;
  return $self->{'PageNumber'};
}



sub setPaginationResult {
  my $self = shift;
  $self->{'PaginationResult'} = shift
}


sub getPaginationResult {
  my $self = shift;
  return $self->_getDataTypeInstance( 'PaginationResult'
		,'eBay::API::XML::DataType::PaginationResultType');
}





##  Attribute and Property lists
sub getPropertiesList {
   my $self = shift;
   return \@gaProperties;
}

sub getAttributesList {
   my $self = shift;
   return \@gaAttributes;
}



1;