Skip to content

Latest commit

 

History

History
188 lines (136 loc) · 6.7 KB

OffersApi.md

File metadata and controls

188 lines (136 loc) · 6.7 KB
Raw

Ageras\Api\OffersApi

All URIs are relative to https://api.ageras.com/v2

Method HTTP request Description
offersActionsCreate POST /offers/{offer_id}/actions
offersGet GET /offers/{offer_id}
offersIndex GET /offers

offersActionsCreate

\Ageras\Api\PartnerOfferResource offersActionsCreate($offer_id , $offer_action_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\OffersApi();
$offer_id = "offer_id_example"; // string | 
$offer_action_resource = new \Ageras\Api\OfferActionResource(); // \Ageras\Api\OfferActionResource | 

try {
    $result = $api_instance->offersActionsCreate($offer_id , $offer_action_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OffersApi->offersActionsCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
offer_id string
offer_action_resource \Ageras\Api\OfferActionResource

Return type

\Ageras\Api\PartnerOfferResource

Authorization

jwt, login

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

offersGet

\Ageras\Api\PartnerOfferResource offersGet($offer_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\OffersApi();
$offer_id = "offer_id_example"; // string | 

try {
    $result = $api_instance->offersGet($offer_id );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OffersApi->offersGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
offer_id string

Return type

\Ageras\Api\PartnerOfferResource

Authorization

jwt, login

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

offersIndex

\Ageras\Api\PartnerOfferResult offersIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\OffersApi();
$criteria = [
        'show_expired' => false; // bool | Include expired partners in the result.
        'show_accepted' => false; // bool | Show accepted partner.
        'partner_id' => 56; // int | Partner id of Offers to filter by.
        'sort' => "created_at"; // string | Order by price asc or desc.
        'action' => "action_example"; // string | Action to take.
        'geo_code' => "geo_code_example"; // string | Offer geo code.
        'type' => "partner"; // string | Type of Offer
        'sale_type' => "unknown"; // string | Sale type
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->offersIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OffersApi->offersIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
show_expired bool Include expired partners in the result. [optional] [default to false]
show_accepted bool Show accepted partner. [optional] [default to false]
partner_id int Partner id of Offers to filter by. [optional]
sort string Order by price asc or desc. [optional] [default to created_at]
action string Action to take. [optional]
geo_code string Offer geo code. [optional]
type string Type of Offer [optional] [default to partner]
sale_type string Sale type [optional] [default to unknown]
limit int The number of resources to be returned. [optional]
page int The page position in the result. [optional]
query string The search wildcard. [optional]

Return type

\Ageras\Api\PartnerOfferResult

Authorization

jwt, login

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]