saas4saas/s4s-full-php

v2.1.9 2016-12-20 17:54 UTC

README

No descripton 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:
  • Package version: v2.1.5
  • Build date: 2016-12-20T17:05:52.488Z
  • Build package: class io.swagger.codegen.languages.PhpClientCodegen For more information, please visit

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/saas4saas/s4s-full-php.git"
    }
  ],
  "require": {
    "saas4saas/s4s-full-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to//autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit lib/Tests

Getting Started

Please follow the installation procedure and then run the following:

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

// Configure API key authorization: tenantid
s4s\Configuration::getDefaultConfiguration()->setApiKey('tenantid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// s4s\Configuration::getDefaultConfiguration()->setApiKeyPrefix('tenantid', 'Bearer');
// Configure API key authorization: token
s4s\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// s4s\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');

$api_instance = new s4s\Api\SsNotificationApi();
$name = "name_example"; // string | 
$email = "email_example"; // string | 
$phone = "phone_example"; // string | 
$message = "message_example"; // string | 

try {
    $result = $api_instance->notificationContactus($name, $email, $phone, $message);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SsNotificationApi->notificationContactus: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://

Class Method HTTP request Description
SsNotificationApi notificationContactus GET /s4s-user/notification/contactus
SsNotificationApi notificationOperatorConf GET /s4s-user/notification/operator/conf/{notification-key}
SsNotificationApi notificationOperatorSendEmail POST /s4s-user/notification/operator/sendEmail
SsNotificationApi notificationUserSendEmail POST /s4s-user/notification/user/sendEmail
SsPaymentApi paymentCustomerInfoCurrency GET /s4s-pricing/payment/customer/{customer-id}/info/currency
SsPaymentApi paymentCustomerInfoGet GET /s4s-pricing/payment/customer/{customer-id}/info
SsPaymentApi paymentCustomerInfoHasPaymentInfo GET /s4s-pricing/payment/customer/{customer-id}/info/hasPaymentInfo
SsPaymentApi paymentCustomerInfoStripeCustomer POST /s4s-pricing/payment/customer/{customer-id}/info/stripeCustomer
SsPaymentApi paymentCustomerPaymentAdd POST /s4s-pricing/payment/customer/{customer-id}/payment
SsPaymentApi paymentCustomerPaymentCancelPatch PATCH /s4s-pricing/payment/customer/{customer-id}/payment/{payment-id}/cancel
SsPaymentApi paymentCustomerPaymentGetAll GET /s4s-pricing/payment/customer/{customer-id}/payment
SsPaymentApi paymentCustomerPaymentPayPatch PATCH /s4s-pricing/payment/customer/{customer-id}/payment/{payment-id}/pay
SsPaymentApi paymentCustomerPaymentValues GET /s4s-pricing/payment/customer/{customer-id}/payment/values
SsPaymentApi paymentPaymentGetAll GET /s4s-pricing/payment/payment
SsPricingApi customerBillClose GET /s4s-pricing/customer/{customer-id}/bill/{customer-bill-id}/close
SsPricingApi customerBillGet GET /s4s-pricing/customer/{customer-id}/bill/{customer-bill-id}
SsPricingApi customerBillInitGet GET /s4s-pricing/customer/{customer-id}/bill/init
SsPricingApi customerBillInitPost GET /s4s-pricing/customer/{customer-id}/bill/initPost
SsPricingApi customerBillOrGet GET /s4s-pricing/customer/{customer-id}/bill/or
SsPricingApi customerBillPaymentAdd POST /s4s-pricing/customer/{customer-id}/bill/payment
SsPricingApi customerBillValues GET /s4s-pricing/customer/{customer-id}/bill/values
SsPricingApi customerHistoryPlanValues GET /s4s-pricing/customer/{customer-id}/history/plan/values
SsPricingApi customerPlanAdd POST /s4s-pricing/customer/{customer-id}/plan
SsPricingApi customerPlanAddCheck POST /s4s-pricing/customer/{customer-id}/plan/addCheck
SsPricingApi customerPlanClose GET /s4s-pricing/customer/{customer-id}/plan/{customer-plan-id}/close
SsPricingApi customerPlanFamily GET /s4s-pricing/customer/{customer-id}/plan/family
SsPricingApi customerPlanGet GET /s4s-pricing/customer/{customer-id}/plan/{customer-plan-id}
SsPricingApi customerPlanGetAll GET /s4s-pricing/customer/{customer-id}/plan
SsPricingApi customerPlanPay GET /s4s-pricing/customer/{customer-id}/plan/pay
SsPricingApi customerPlanPlan GET /s4s-pricing/customer/{customer-id}/plan/plan
SsPricingApi customerPlanValues GET /s4s-pricing/customer/{customer-id}/plan/values
SsResourceApi resourceCustomerResourceGet GET /s4s-pricing/resource/customer/{customer-id}/resource/{resourceid}
SsResourceApi resourceCustomerResourceLimitGet GET /s4s-pricing/resource/customer/{customer-id}/resource/{resourceid}/limit
SsResourceApi resourceCustomerResourcePatch PATCH /s4s-pricing/resource/customer/{customer-id}/resource/{resourceid}
SsResourceApi resourceCustomerResourceProductGet GET /s4s-pricing/resource/customer/{customer-id}/resource/{resourceid}/product/{customer-product-id}
SsResourceApi resourceCustomerResourceUnspendDel DELETE /s4s-pricing/resource/customer/{customer-id}/resource/{resourceid}/unspend
SsResourceApi resourceCustomerResourceUnspendGet GET /s4s-pricing/resource/customer/{customer-id}/resource/{resourceid}/unspend
SsResourceApi resourceCustomerResourceUnspendPatch PATCH /s4s-pricing/resource/customer/{customer-id}/resource/{resourceid}/unspend
SsResourceApi resourceCustomerUpdateLimits GET /s4s-pricing/resource/customer/{customer-id}/updateLimits
SsUserApi accountAdd POST /s4s-user/account
SsUserApi accountAutoLogin GET /s4s-user/account/autoLogin
SsUserApi accountChangePasswordPatch PATCH /s4s-user/account/changePassword
SsUserApi accountGetAll GET /s4s-user/account
SsUserApi accountIdGet GET /s4s-user/account/{account-id}
SsUserApi accountIdKeysAdd POST /s4s-user/account/{account-id}/keys
SsUserApi accountIdKeysDel DELETE /s4s-user/account/{account-id}/keys/{user-id}
SsUserApi accountIdKeysGetAll GET /s4s-user/account/{account-id}/keys
SsUserApi accountIdPrivateDataPut PUT /s4s-user/account/{account-id}/privateData
SsUserApi accountIdPut PUT /s4s-user/account/{account-id}
SsUserApi accountIdStatusPut PUT /s4s-user/account/{account-id}/status
SsUserApi accountIdUserAdd POST /s4s-user/account/{account-id}/user
SsUserApi accountIdUserChangePwdToken GET /s4s-user/account/{account-id}/user/{user-id}/changePwdToken
SsUserApi accountIdUserGet GET /s4s-user/account/{account-id}/user/{user-id}
SsUserApi accountIdUserLogin GET /s4s-user/account/{account-id}/user/{user-id}/login
SsUserApi accountIdUserPut PUT /s4s-user/account/{account-id}/user/{user-id}
SsUserApi accountIdUserResendEmailConfirmation GET /s4s-user/account/{account-id}/user/{user-id}/resendEmailConfirmation
SsUserApi accountLogin POST /s4s-user/account/login
SsUserApi accountLoginOrAdd POST /s4s-user/account/loginOr
SsUserApi accountRecover POST /s4s-user/account/recover
SsUserApi accountUserChangePwdToken GET /s4s-user/account/user/{user-id}/changePwdToken
SsUserApi accountUserGet GET /s4s-user/account/user/{user-id}
SsUserApi accountUserLogin GET /s4s-user/account/user/{user-id}/login
SsUserApi accountUserPut PUT /s4s-user/account/user/{user-id}
SsUserApi accountUserResendEmailConfirmation GET /s4s-user/account/user/{user-id}/resendEmailConfirmation
SsUserApi accountUsernameChangePwdToken GET /s4s-user/account/username/changePwdToken
SsUserApi accountUsernameGet GET /s4s-user/account/username
SsUserApi accountUsernameLogin GET /s4s-user/account/username/login
SsUserApi accountUsernamePut PUT /s4s-user/account/username
SsUserApi accountUsernameResendEmailConfirmation GET /s4s-user/account/username/resendEmailConfirmation
SsUserApi authenticate GET /s4s-user/authenticate
SsUserApi config GET /s4s-user/config
SsUserApi googleLogin POST /s4s-user/googleLogin
SsUserApi renewSession GET /s4s-user/renewSession

Documentation For Models

Documentation For Authorization

tenantid

  • Type: API key
  • API key parameter name: tenantid
  • Location: URL query string

token

  • Type: API key
  • API key parameter name: token
  • Location: URL query string

Author