Skip to content

Latest commit

 

History

History

php-client

README.md

OpenAPIClient-php

The FirstQuadrant API is used to interact with FirstQuadrant programmatically. We also have SDKs available (coming soon).

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/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:

<?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: api_key
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\IncomingWebhooksApi(
    // 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
);
$mark_conversation_as_won_body = new \OpenAPI\Client\Model\MarkConversationAsWonBody(); // \OpenAPI\Client\Model\MarkConversationAsWonBody | Find conversations using the given email address and create unique goal events based on the idempotency key.

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

API Endpoints

All URIs are relative to https://api.firstquadrant.ai

Class Method HTTP request Description
IncomingWebhooksApi incomingWebhooksMarkConversationsAsWonPost POST /incoming-webhooks/mark-conversations-as-won Mark conversations as won
TeamsApi teamsMeGet GET /teams/me Get team

Models

Authorization

api_key

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

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

inquiry@firstquadrant.ai

About this package

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

  • API version: 0.0.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen