README

Our API suite for the Resolution Center and the Safe Checkout features. Simple, yet elegant web interfaces for your convenience. One request away from your first automated resolution or safe-checkout.

For more information, please visit https://tripartie.com.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

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

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

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure API key authorization: jwtPersonalKey
$config = Tripartie\Tpdk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Tripartie\Tpdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Tripartie\Tpdk\Api\BrandingApi(
    // 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(),
    $config
);
$id = 'id_example'; // string | Organization identifier
$organizationUpdate = new \Tripartie\Tpdk\Model\OrganizationUpdate(); // \Tripartie\Tpdk\Model\OrganizationUpdate | The updated Organization resource

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

API Endpoints

All URIs are relative to https://staging-api.tripartie.com

Models

• AccessError
• Address
• ApiClientPostCreationRead
• ApiClientRead
• ApiClientWrite
• AuthError
• DisputeAddressIndependentWrite
• DisputeCollectionRead
• DisputeDisputeRead
• DisputeIndependentWrite
• DisputeMediaRead
• DisputeMetadataIndependentWrite
• DisputeMetadataRead
• DisputeOfferCollectionRead
• DisputeOfferIndependentWrite
• DisputeOfferRead
• DisputeOrganizationRead
• DisputeParcelIndependentWrite
• DisputeParcelRead
• DisputePersonaCollectionRead
• DisputePersonaIndependentWrite
• DisputePersonaRead
• DisputePostCreationRead
• DisputeRead
• DisputeTransactionCollectionRead
• DisputeTransactionIndependentWrite
• DisputeTransactionRead
• DisputeUpdate
• DisputeViewRead
• DisputeWorkflowEventRead
• EvaluationRead
• EvaluationWrite
• Evidence
• EvidenceMediaRead
• EvidenceRead
• EvidenceWrite
• GenericError
• InvalidQueryError
• Media
• MediaDisputeRead
• MediaRead
• MediaUserRead
• MessageError
• Metadata
• MetadataDisputeRead
• NotFoundError
• NotificationRead
• NotificationUpdate
• OfferDisputeRead
• OrganizationAddressUpdate
• OrganizationCollectionRead
• OrganizationDisputeRead
• OrganizationMediaCollectionRead
• OrganizationMediaRead
• OrganizationRead
• OrganizationUpdate
• OrganizationUserRead
• Parcel
• ParcelDisputeRead
• ParcelWrite
• Persona
• PersonaAddressRead
• PersonaAddressUpdate
• PersonaAddressWrite
• PersonaAuthReturn
• PersonaCollectionRead
• PersonaDisputeRead
• PersonaExternalAuth
• PersonaMetadataRead
• PersonaMetadataUpdate
• PersonaMetadataWrite
• PersonaPostAuthRead
• PersonaRead
• PersonaRegister
• PersonaTokenWrite
• PersonaUpdate
• PersonaWrite
• RateLimitError
• TransactionDisputeRead
• UnprocessableEntity
• UnprocessableEntityViolationsInner
• User
• UserAddressWrite
• UserAuthenticatedRead
• UserCollectionRead
• UserEmailValidationWrite
• UserInvite
• UserJwtCreated
• UserJwtWrite
• UserMediaAuthenticatedRead
• UserMediaCollectionRead
• UserMediaRead
• UserOrganizationAuthenticatedRead
• UserOrganizationCollectionRead
• UserOrganizationRead
• UserOrganizationWrite
• UserPostRegisterRead
• UserTotpSetupRead
• UserTotpToggleWrite
• UserUpdate
• UserUserEmailUpdate
• UserUserPasswordUpdate
• UserUserRead
• UserUserSubscribed
• UserWrite
• View
• ViewDisputeRead
• Webhook
• WebhookHistoryCollectionRead
• WebhookHistoryRead
• WebhookObject
• WebhookSubscriptionRead
• WebhookSubscriptionWrite
• WorkflowEventDisputeRead

Authorization

Authentication schemes defined for the API:

oauth

• Type: OAuth
• Flow: application
• Authorization URL: ``
• Scopes:
  • OFFER_READ: Read-only operations on safe-checkout offers
  • OFFER_WRITE: Write permissions on safe-checkout offers
  • DISPUTE_READ: Read-only operations on disputes
  • DISPUTE_WRITE: Write permissions on disputes
  • DISPUTE_ARBITRATION: Update permission on disputes for manual arbitration only
  • ORGANIZATION_READ: Read organization details and stats
  • RULING_READ: Read custom rules applied to the dispute resolution program
  • RULING_WRITE: Write custom rules applied to the dispute resolution program
  • PERSONA_READ: Read operations on the shared user-base knowledge
  • PERSONA_WRITE: Write permissions on the shared user-base knowledge
  • PERSONA_AUTH: Capability to issue short-term lived authenticated URL
  • INTERNAL_WRITE: Special internal scope

jwtPersonalKey

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

personaAuthKey

• Type: API key
• API key parameter name: X-Persona-Authorization
• Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

noc@tripartie.com

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 2.0.204
  • Generator version: 7.6.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen