rossity / php-quickbase
A Quick Base RESTful API implementation of their OpenAPI spec.
v0.2.1
2021-01-08 14:45 UTC
Requires
- php: >=7.2
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^6.2 || ^7.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.12
- phpunit/phpunit: ^8.0 || ^9.0
This package is auto-updated.
Last update: 2024-11-08 23:09:41 UTC
README
A Quick Base RESTful API implementation of their OpenAPI spec.
Installation & Usage
Requirements
PHP 7.2 and later.
Composer
To install the bindings via Composer, add the following to composer.json
:
{ "repositories": [ { "type": "vcs", "url": "https://github.com/rossity/php-quickbase.git" } ], "require": { "rossity/php-quickbase": "*@dev" } }
Then run composer install
Manual Installation
Download the files and include autoload.php
:
<?php require_once('/path/to/Rossity/PhpQuickbase/vendor/autoload.php');
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); $apiInstance = new Rossity\PhpQuickbase\Api\AppsApi( // 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() ); $appId = 'appId_example'; // string | The unique identifier of an app $qBRealmHostname = 'qBRealmHostname_example'; // string | Your Quick Base domain, for example demo.quickbase.com $authorization = 'authorization_example'; // string | The Quick Base authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth). $userAgent = 'userAgent_example'; // string | Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting. $generated = new \Rossity\PhpQuickbase\Model\InlineObject3(); // \Rossity\PhpQuickbase\Model\InlineObject3 try { $result = $apiInstance->copyApp($appId, $qBRealmHostname, $authorization, $userAgent, $generated); print_r($result); } catch (Exception $e) { echo 'Exception when calling AppsApi->copyApp: ', $e->getMessage(), PHP_EOL; }
API Endpoints
All URIs are relative to https://api.quickbase.com/v1
Models
- AppsAppIdCopyProperties
- AppsAppIdEventsOwner
- AppsVariables
- FieldsFieldIdProperties
- FieldsPermissions
- FieldsProperties
- FieldsUsageField
- FieldsUsageUsage
- FieldsUsageUsageActions
- FieldsUsageUsageAppHomePages
- FieldsUsageUsageDefaultReports
- FieldsUsageUsageExactForms
- FieldsUsageUsageFields
- FieldsUsageUsageForms
- FieldsUsageUsageNotifications
- FieldsUsageUsagePersonalReports
- FieldsUsageUsageRelationships
- FieldsUsageUsageReminders
- FieldsUsageUsageReports
- FieldsUsageUsageRoles
- FieldsUsageUsageWebhooks
- InlineObject
- InlineObject1
- InlineObject10
- InlineObject11
- InlineObject12
- InlineObject13
- InlineObject14
- InlineObject2
- InlineObject3
- InlineObject4
- InlineObject5
- InlineObject6
- InlineObject7
- InlineObject8
- InlineObject9
- InlineResponse200
- InlineResponse2001
- InlineResponse2002
- InlineResponse2003
- InlineResponse2004
- RecordsQueryGroupBy
- RecordsQueryOptions
- ReportsQuery
- ReportsQueryFormulaFields
- TablesTableIdRelationshipForeignKeyField
- TablesTableIdRelationshipSummaryFields
Authorization
All endpoints do not require authorization.
Tests
To run the tests, use:
composer install vendor/bin/phpunit
About this package
- API version:
1.0.0
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen