SwaggerClient-php

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 0.0.1
• Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\PayrollApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

try {
    $result = $apiInstance->getV1PayrollCompanies();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayrollApi->getV1PayrollCompanies: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new Swagger\Client\Api\PayrollApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$company_name = "company_name_example"; // string | Company Name

try {
    $apiInstance->getV1PayrollCompaniesCafeteriaPlan($company_name);
} catch (Exception $e) {
    echo 'Exception when calling PayrollApi->getV1PayrollCompaniesCafeteriaPlan: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new Swagger\Client\Api\PayrollApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$company_id = 56; // int |

try {
    $result = $apiInstance->getV1PayrollCompaniesCompanyId($company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayrollApi->getV1PayrollCompaniesCompanyId: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new Swagger\Client\Api\PayrollApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$company_name = "company_name_example"; // string | Company Name
$company_address = "company_address_example"; // string | Company Address
$signatory_name = "signatory_name_example"; // string | Signatory Name
$signatory_phone = "signatory_phone_example"; // string | Signatory Phone
$signatory_email = "signatory_email_example"; // string | Signatory Email

try {
    $apiInstance->getV1PayrollCompaniesTos($company_name, $company_address, $signatory_name, $signatory_phone, $signatory_email);
} catch (Exception $e) {
    echo 'Exception when calling PayrollApi->getV1PayrollCompaniesTos: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new Swagger\Client\Api\PayrollApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$status = "status_example"; // string | Filters by status
$employer_id = 56; // int | Filters by company

try {
    $result = $apiInstance->getV1PayrollPayPeriods($status, $employer_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayrollApi->getV1PayrollPayPeriods: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new Swagger\Client\Api\PayrollApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 56; // int |

try {
    $result = $apiInstance->getV1PayrollPayPeriodsId($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PayrollApi->getV1PayrollPayPeriodsId: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new Swagger\Client\Api\PayrollApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$company_id = 56; // int |
$employee_id = 56; // int |

try {
    $apiInstance->postV1PayrollCompaniesCompanyIdEmployeesEmployeeIdSessions($company_id, $employee_id);
} catch (Exception $e) {
    echo 'Exception when calling PayrollApi->postV1PayrollCompaniesCompanyIdEmployeesEmployeeIdSessions: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new Swagger\Client\Api\PayrollApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$company_id = 56; // int |

try {
    $apiInstance->postV1PayrollCompaniesCompanyIdSessions($company_id);
} catch (Exception $e) {
    echo 'Exception when calling PayrollApi->postV1PayrollCompaniesCompanyIdSessions: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new Swagger\Client\Api\PayrollApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Swagger\Client\Model\null(); //  |

try {
    $apiInstance->postV1PayrollCompaniesOauthSignup($body);
} catch (Exception $e) {
    echo 'Exception when calling PayrollApi->postV1PayrollCompaniesOauthSignup: ', $e->getMessage(), PHP_EOL;
}

$apiInstance = new Swagger\Client\Api\PayrollApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \Swagger\Client\Model\null(); //  |

try {
    $apiInstance->postV1PayrollEvents($body);
} catch (Exception $e) {
    echo 'Exception when calling PayrollApi->postV1PayrollEvents: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to //staging.thisisalice.com/api

Class	Method	HTTP request	Description
PayrollApi	getV1PayrollCompanies	GET /v1/payroll/companies	Companies list
PayrollApi	getV1PayrollCompaniesCafeteriaPlan	GET /v1/payroll/companies/cafeteria_plan	Return Cafeteria plan HTML for Square
PayrollApi	getV1PayrollCompaniesCompanyId	GET /v1/payroll/companies/{company_id}	Company details
PayrollApi	getV1PayrollCompaniesTos	GET /v1/payroll/companies/tos	Return HTML TOS for Square
PayrollApi	getV1PayrollPayPeriods	GET /v1/payroll/pay_periods	Pay periods list
PayrollApi	getV1PayrollPayPeriodsId	GET /v1/payroll/pay_periods/{id}	Pay period details
PayrollApi	postV1PayrollCompaniesCompanyIdEmployeesEmployeeIdSessions	POST /v1/payroll/companies/{company_id}/employees/{employee_id}/sessions	Create single-use login token
PayrollApi	postV1PayrollCompaniesCompanyIdSessions	POST /v1/payroll/companies/{company_id}/sessions	Create single-use login token
PayrollApi	postV1PayrollCompaniesOauthSignup	POST /v1/payroll/companies/oauth/signup	Signs up a new Square company
PayrollApi	postV1PayrollEvents	POST /v1/payroll/events	webhook for payroll companies to push events to us

Documentation For Models

• AccountEntity
• AccountManagementStatsEntity
• AddressEntity
• AliceStatsEntity
• BankingAccountEntity
• BankingInstitutionConnectionEntity
• BankingTransactionEntity
• BeneficiaryEntity
• BillingSourceEntity
• ChurnStatsEntity
• CitySpendingAnalysisEntity
• ClaimDocumentEntity
• CustodianEntity
• DependentCareOpenEnrollmentEntity
• DependentCareProgramEnrollmentCollectionEntity
• DependentCareProgramEnrollmentEntity
• DependentCareSummaryEntity
• DependentEntity
• DocumentEntity
• DocumentUrlEntity
• EmployeeBenefitsEntity
• EmployeeCohortTimeSeriesAnalysisEntity
• EmployeeCollectionActionResultEntity
• EmployeeCollectionSummaryEntity
• EmployeeEnrollmentTimeSeriesAnalysisEntity
• EmployeeEnrollmentTimeSeriesSegmentEntity
• EmployeeEntity
• EmployeeOrganizationBenefitEntity
• EmployeeOrganizationEntity
• EmployeePaginatedEntity
• EmployeePaginatedSummaryEntity
• EmployeePayPeriodRecordEntity
• EmployeeProfileEntity
• EmployeeReimbursementClaimEntity
• EmployeeSpendStateAnalysisEntity
• EmployeeSpendStateSegmentEntity
• EmployeeSpendStateTimeSeriesAnalysisEntity
• EmployeeSpendStateTimeSeriesSegmentEntity
• EmployeeSpendingAnalysisEntity
• EmployeesProviderEntity
• EmployerAccountEntity
• EmployerAnnualSavingsEntity
• EmployerCollectionEntity
• EmployerMinimalEntity
• EmployerPaginatedEntity
• EmployerPaginatedSummaryEntity
• EmployerPayrollEntity
• EmployerSummaryEntity
• EmployerTotalSavingsEntity
• EngagementStatNodeEntity
• EngagementStatsEntity
• EnrollmentStatsEntity
• EstimatedEmployeeTaxSavingsEntity
• FundsTransferEntity
• GroupedPayPeriodCollectionEntity
• GroupedPayPeriodEntity
• HSAProgramEnrollmentCollectionEntity
• HSAProgramEnrollmentEntity
• HealthPlanEntity
• HealthcareFSAProgramEnrollmentCollectionEntity
• HealthcareFSAProgramEnrollmentEntity
• HealthcareOpenEnrollmentEntity
• ImageUploaderEntity
• InstitutionCollectionEntity
• InstitutionEntity
• InvoiceCollectionEntity
• InvoiceEntity
• InvoiceItemEntity
• MachineLearningPerformanceEntity
• MostRecentComplianceReportCollectionEntity
• OpenEnrollmentEntity
• OrganizationAccountsEntity
• OrganizationAdminProfileEntity
• OrganizationBenefitEntity
• OrganizationBenefitsEntity
• OrganizationSummaryEntity
• PaginatedPayGroupPayPeriodCollectionEntity
• PayGroupPayPeriodEntity
• PayPeriodCollectionEntity
• PayPeriodCollectionPayrollEntity
• PayPeriodEntity
• PayPeriodMinimalEntity
• PayPeriodPayrollEntity
• PaymentScheduleEntity
• PayrollConfigEntity
• PayrollPlatformEntity
• PeriodsPayGroupEntity
• PlanYearEntity
• PretaxCategoryPredictionPerformanceEntity
• PretaxProgramEnrollmentCollectionEntity
• PretaxProgramEnrollmentEntity
• PreviousYearSummaryEntity
• ProviderEntity
• QualifyingLifeEventEntity
• ReportEntity
• RevenueStatsEntity
• SpendingAnalysisEntity
• SuggestedElectionEntity
• TestResultsEntity
• UserAdminProfileEntity
• UserEntity
• UserOnboardingEntity
• UserSignupEntity

Documentation For Authorization

api_key

• Type: API key
• API key parameter name: Api-Key
• Location: HTTP header

Author