PHP Class Api\ServiceType\ApiSaint

Inheritance: extends WsdlToPhp\PackageBase\AbstractSoapClientBase
Show file Open project: wsdltophp/packagegenerator

Public Methods

Method Description
Saint_CheckJobStatus ( string $job_id ) : saintresults | boolean Method to call the operation originally named Saint.CheckJobStatus Meta informations extracted from the WSDL - documentation: Return the current status of a Saint API Job.
Saint_CreateFTP ( string $description, string $email, string $export, string $overwrite, string $relation_id, string $rsid_list ) : Api\StructType\ApiSaint_ftp_info | boolean Method to call the operation originally named Saint.CreateFTP Meta informations extracted from the WSDL - documentation: Creates an ftp account for the given parameters and returns the ftp account info
Saint_ExportCreateJob ( string $campaign_filter_begin_range, string $campaign_filter_end_range, string $campaign_filter_option, string $date_filter_row_end_date, string $date_filter_row_start_date, string $email_address, string $encoding, string $relation_id, string $report_suite_array, string $row_match_filter_empty_column_name, string $row_match_filter_match_column_name, string $row_match_filter_match_column_value, string $select_all_rows, string $select_number_of_rows ) : string | boolean Method to call the operation originally named Saint.ExportCreateJob Meta informations extracted from the WSDL - documentation: Creates Saint Export Job.
Saint_ExportGetFileSegment ( string $file_id, string $segment_id ) : pagedetails | boolean Method to call the operation originally named Saint.ExportGetFileSegment Meta informations extracted from the WSDL - documentation: Returns the page details of a given file_id
Saint_GetCompatabiltyMetrics ( string $report_suite_array ) : compatabilitys | boolean Method to call the operation originally named Saint.GetCompatabiltyMetrics Meta informations extracted from the WSDL - documentation: Returns Array of compatability information for a report suite(s),
Saint_GetFilters ( string $relation_id, string $report_suite_array ) : export_filters | boolean Method to call the operation originally named Saint.GetFilters Meta informations extracted from the WSDL - documentation: Get SAINT export filters.
Saint_GetTemplate ( string $encoding, string $numeric_div_nums, string $relation_id, string $report_suite, string $text_div_nums ) : string | boolean Method to call the operation originally named Saint.GetTemplate Meta informations extracted from the WSDL - documentation: Returns the template to be used in the SAINT browser or FTP download
Saint_ImportCommitJob ( string $job_id ) : string | boolean Method to call the operation originally named Saint.ImportCommitJob Meta informations extracted from the WSDL - documentation: Commits a specified Saint Import job for processing.
Saint_ImportCreateJob ( string $check_divisions, string $description, string $email_address, string $export_results, string $header, string $overwrite_conflicts, string $relation_id, string $report_suite_array ) : integer | boolean Method to call the operation originally named Saint.ImportCreateJob Meta informations extracted from the WSDL - documentation: Creates a Saint Import Job
Saint_ImportPopulateJob ( string $job_id, string $page, string $rows ) : string | boolean Method to call the operation originally named Saint.ImportPopulateJob Meta informations extracted from the WSDL - documentation: Attaches Import data to a given Saint Import job.
Saint_ListFTP ( ) : saint_ftp_list | boolean Method to call the operation originally named Saint.ListFTP Meta informations extracted from the WSDL - documentation: Returns a list of the ftp accounts configured for this company
__toString ( ) : string Method returning the class name
getResult ( ) : compatabilitys | export_filters | integer | pagedetails | saintresults | saint_ftp_list | string | Api\StructType\ApiSaint_ftp_info Returns the result

Method Details

Saint_CheckJobStatus() public method

Method to call the operation originally named Saint.CheckJobStatus Meta informations extracted from the WSDL - documentation: Return the current status of a Saint API Job.
public Saint_CheckJobStatus ( string $job_id ) : saintresults | boolean
$job_id string
return saintresults | boolean

Saint_CreateFTP() public method

Method to call the operation originally named Saint.CreateFTP Meta informations extracted from the WSDL - documentation: Creates an ftp account for the given parameters and returns the ftp account info
public Saint_CreateFTP ( string $description, string $email, string $export, string $overwrite, string $relation_id, string $rsid_list ) : Api\StructType\ApiSaint_ftp_info | boolean
$description string
$email string
$export string
$overwrite string
$relation_id string
$rsid_list string
return Api\StructType\ApiSaint_ftp_info | boolean

Saint_ExportCreateJob() public method

Method to call the operation originally named Saint.ExportCreateJob Meta informations extracted from the WSDL - documentation: Creates Saint Export Job.
public Saint_ExportCreateJob ( string $campaign_filter_begin_range, string $campaign_filter_end_range, string $campaign_filter_option, string $date_filter_row_end_date, string $date_filter_row_start_date, string $email_address, string $encoding, string $relation_id, string $report_suite_array, string $row_match_filter_empty_column_name, string $row_match_filter_match_column_name, string $row_match_filter_match_column_value, string $select_all_rows, string $select_number_of_rows ) : string | boolean
$campaign_filter_begin_range string
$campaign_filter_end_range string
$campaign_filter_option string
$date_filter_row_end_date string
$date_filter_row_start_date string
$email_address string
$encoding string
$relation_id string
$report_suite_array string
$row_match_filter_empty_column_name string
$row_match_filter_match_column_name string
$row_match_filter_match_column_value string
$select_all_rows string
$select_number_of_rows string
return string | boolean

Saint_ExportGetFileSegment() public method

Method to call the operation originally named Saint.ExportGetFileSegment Meta informations extracted from the WSDL - documentation: Returns the page details of a given file_id
public Saint_ExportGetFileSegment ( string $file_id, string $segment_id ) : pagedetails | boolean
$file_id string
$segment_id string
return pagedetails | boolean

Saint_GetCompatabiltyMetrics() public method

Method to call the operation originally named Saint.GetCompatabiltyMetrics Meta informations extracted from the WSDL - documentation: Returns Array of compatability information for a report suite(s),
public Saint_GetCompatabiltyMetrics ( string $report_suite_array ) : compatabilitys | boolean
$report_suite_array string
return compatabilitys | boolean

Saint_GetFilters() public method

Method to call the operation originally named Saint.GetFilters Meta informations extracted from the WSDL - documentation: Get SAINT export filters.
public Saint_GetFilters ( string $relation_id, string $report_suite_array ) : export_filters | boolean
$relation_id string
$report_suite_array string
return export_filters | boolean

Saint_GetTemplate() public method

Method to call the operation originally named Saint.GetTemplate Meta informations extracted from the WSDL - documentation: Returns the template to be used in the SAINT browser or FTP download
public Saint_GetTemplate ( string $encoding, string $numeric_div_nums, string $relation_id, string $report_suite, string $text_div_nums ) : string | boolean
$encoding string
$numeric_div_nums string
$relation_id string
$report_suite string
$text_div_nums string
return string | boolean

Saint_ImportCommitJob() public method

Method to call the operation originally named Saint.ImportCommitJob Meta informations extracted from the WSDL - documentation: Commits a specified Saint Import job for processing.
public Saint_ImportCommitJob ( string $job_id ) : string | boolean
$job_id string
return string | boolean

Saint_ImportCreateJob() public method

Method to call the operation originally named Saint.ImportCreateJob Meta informations extracted from the WSDL - documentation: Creates a Saint Import Job
public Saint_ImportCreateJob ( string $check_divisions, string $description, string $email_address, string $export_results, string $header, string $overwrite_conflicts, string $relation_id, string $report_suite_array ) : integer | boolean
$check_divisions string
$description string
$email_address string
$export_results string
$header string
$overwrite_conflicts string
$relation_id string
$report_suite_array string
return integer | boolean

Saint_ImportPopulateJob() public method

Method to call the operation originally named Saint.ImportPopulateJob Meta informations extracted from the WSDL - documentation: Attaches Import data to a given Saint Import job.
public Saint_ImportPopulateJob ( string $job_id, string $page, string $rows ) : string | boolean
$job_id string
$page string
$rows string
return string | boolean

Saint_ListFTP() public method

Method to call the operation originally named Saint.ListFTP Meta informations extracted from the WSDL - documentation: Returns a list of the ftp accounts configured for this company
public Saint_ListFTP ( ) : saint_ftp_list | boolean
return saint_ftp_list | boolean

__toString() public method

Method returning the class name
public __toString ( ) : string
return string __CLASS__

getResult() public method

Returns the result
See also: AbstractSoapClientBase::getResult()
public getResult ( ) : compatabilitys | export_filters | integer | pagedetails | saintresults | saint_ftp_list | string | Api\StructType\ApiSaint_ftp_info
return compatabilitys | export_filters | integer | pagedetails | saintresults | saint_ftp_list | string | Api\StructType\ApiSaint_ftp_info