README

This API does not represent the final product. Some of the APIs listed below are highly experimental and will likely change before the final release. They may come with crashes and bugs and may potentially cause data loss.

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

API version: v1
Build package: io.swagger.codegen.languages.PhpClientCodegen

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/revenuewire/jackfruit-rest-sdk-php.git"
    }
  ],
  "require": {
    "revenuewire/jackfruit-rest-sdk-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/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');

// Configure API key authorization: JWT
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Authorization-JWT', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Authorization-JWT', 'Bearer');
// Configure API key authorization: API-KEY
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');

$api_instance = new Swagger\Client\Api\AffiliateLinkerLinksApi();
$catalogFid = "catalogFid_example"; // string | Offer's catalog FID

try {
    $result = $api_instance->affiliateLinksGet($catalogFid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AffiliateLinkerLinksApi->affiliateLinksGet: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://localhost/rest/v1

Class	Method	HTTP request	Description
AffiliateLinkerLinksApi	affiliateLinksGet	GET /affiliatelinks
AffiliateMerchantTermsApi	affiliateMerchantTermsAdd	POST /affiliatemerchantterms
AffiliatesApi	getAffiliateById	GET /affiliates/{id}
AffiliatesApi	saveAffiliateById	PUT /affiliates/{id}
AliasesApi	aliasesGet	GET /aliases
BannersApi	bannerDismiss	PUT /banners/{id}/dismiss
BannersApi	bannerDismissTypeDelete	DELETE /banners/dismissedTypes
BannersApi	bannerDismissTypePut	PUT /banners/dismissedTypes
BannersApi	bannersGet	GET /banners
BillingsApi	billingInfoAllUpdate	PUT /billings/update-card
BillingsApi	billingInfoUpdate	PUT /billings/{billingInfoId}
BillingsApi	billingInfoUpdatePaypal	PUT /billings/update-paypal
BillingsApi	setUpPaypalUrl	POST /billings/{billingInfoId}/setup-paypal-url
CPAAcceptTermsApi	cpaTermsAccept	PUT /cpaapplytorun/{payoutPolicyId}/accept
CPAApplyToRunApi	cpaApplyToRunAdd	POST /cpaapplytorun
CatalogApi	catalogOfferGet	GET /catalog/{id}
CatalogApi	catalogOffersGet	GET /catalog
CatalogApi	newOffersGet	GET /catalog/new-offers
CatalogApi	newOffersPut	PUT /catalog/new-offers
CatalogApi	topOffersGet	GET /catalog/top-offers
CatalogApi	topOffersPut	PUT /catalog/top-offers
CouponsApi	couponsGet	GET /coupons
CustomersApi	getCustomer	GET /customers/{customerId}
CustomersApi	getCustomersForMerchant	GET /customers
CustomersApi	getOffers	GET /customers/{customerUserId}/offers
CustomersApi	getTransactions	GET /customers/{customerUserId}/transactions
CustomersApi	updateShippingAddress	PUT /customers/{customerId}/address/{transactionId}
DashboardApi	dashboardCustomizationPost	POST /dashboard/customization
DestinationsApi	destinationsAdd	POST /destinations
DestinationsApi	destinationsDelete	DELETE /destinations/{id}
DestinationsApi	destinationsGet	GET /destinations
DestinationsApi	destinationsUpdate	PUT /destinations/{id}
DomainsApi	domainsDelete	DELETE /domains/{id}
DomainsApi	domainsEmailIdDelete	DELETE /domains/email/{id}
DomainsApi	domainsEmailPost	POST /domains/email
DomainsApi	domainsGet	GET /domains
DomainsApi	domainsGet_0	GET /domains/{id}
DomainsApi	domainsIdUploadCertPost	POST /domains/{id}/upload-cert
DomainsApi	domainsPost	POST /domains
DomainsApi	domainsUpdate	PUT /domains/{id}
GEOApi	geoGetCountryList	GET /geo-info/countries
GEOApi	geoGetSupportedLanguages	GET /geo-info/supported-languages
MerchantGatewayConfigsApi	activate	POST /merchantgatewayconfigs/{clientId}/versions/{versionId}/activate/	Activate the gateway policy for a merchant
MerchantsApi	createAffiliateBlock	POST /merchants/{merchantId}/block-affiliate/	Create merchant affiliate block
MerchantsApi	deleteAffiliateBlock	DELETE /merchants/{merchantId}/block-affiliate/{blockId}/	Delete Merchant Affiliate Block
MerchantsApi	getMerchant	GET /merchants/{merchantId}	Get merchant info
OffersApi	getOffer	GET /offers/{offerId}/	Get Offer
OrdersApi	getOrderDetail	GET /orders/{orderId}
OrdersApi	getOrderList	GET /orders/customer-email/{email}
OrdersApi	orderLookUp	POST /orders/purchase-lookup
PathsApi	createNode	POST /paths/{pathId}/nodes/	Create path node
PathsApi	createPath	POST /paths	Create path
PathsApi	deleteNode	DELETE /paths/{pathId}/nodes/{nodeId}	Delete a node
PathsApi	deletePath	DELETE /paths/{pathId}/	Delete path
PathsApi	getAllPaths	GET /paths	Get Paths
PathsApi	getNode	GET /paths/{pathId}/nodes/{nodeId}	Get a node
PathsApi	getNodesInPath	GET /paths/{pathId}/nodes/	Get nodes in a path
PathsApi	getPathInfo	GET /paths/{pathId}/	Get Path
PathsApi	updateNode	PUT /paths/{pathId}/nodes/{nodeId}	Update a node
PathsApi	updatePath	PUT /paths/{pathId}/	Update path
ProductsApi	getProduct	GET /products/{productId}	Get Product
RebillMigrationssApi	rebill	POST /rebillmigrations/{recurringTransactionItemId}/rebill/	Use card info from vault to enable a paused rebill task
RefundMigrationssApi	refund	POST /refundmigrations/{transactionId}/refund/	Use card info from vault to give customer credit by pavision
SubscriptionsApi	getLegacySubscriptionInfo	GET /subscriptions/legacy/{id}
SubscriptionsApi	getSubscriptionInfo	GET /subscriptions/{id}
SubscriptionsApi	legacySubscriptionCancel	PUT /subscriptions/legacy/{transactionItemId}/cancel
SubscriptionsApi	subscriptionCancel	PUT /subscriptions/{recurringTransactionItemId}/cancel
TemplatesApi	templatesGet	GET /templates
TemplatesManagementApi	templateSync	POST /templates/sync	Sync templates from cart 2.0
TemplatesManagementApi	templatesDeploy	POST /templates/deploy	Deploy templates to a new version
TemplatesManagementApi	templatesRelease	POST /templates/release	Release templates
TokenApi	tokenGenerate	POST /token
TrackingsApi	postbackTest	POST /trackings/{id}/test
TrackingsApi	trackingsAdd	POST /trackings
TrackingsApi	trackingsDelete	DELETE /trackings/{id}
TrackingsApi	trackingsGet	GET /trackings
TrackingsApi	trackingsUpdate	PUT /trackings/{id}
TransactionsApi	getTransaction	GET /transactions/{transactionId}	Get Transaction
UsersApi	customerLogin	POST /users/login
UsersApi	customerOrderLogin	POST /users/order-login
UsersApi	customerSignup	POST /users/sign-up
UsersApi	userForgotPassword	POST /users/forget-password
UsersApi	userGet	GET /users/{id}
UsersApi	userResetPassword	POST /users/reset-password
UsersApi	userSaveAppConfig	PUT /users/{id}/save-app-config
UsersApi	userUpdate	PUT /users/{id}
UsersApi	userUpdateEmail	POST /users/{id}/update-email
UsersApi	userUpdateEmailConfirm	PUT /users/{id}/update-email/{token}
UsersApi	userUpdatePassword	PUT /users/{id}/update-password
UsersApi	userVerify	PUT /users/verify

revenuewire / jackfruit-rest-sdk-php

Maintainers

Details

README

Requirements

Installation & Usage

Composer

Manual Installation

Tests

Getting Started

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

API-KEY

JWT

Author