apideck-libraries/sdk-php

Developer-friendly & type-safe Php SDK specifically catered to leverage apideck-libraries/sdk-php API.

Summary

Apideck: The Apideck OpenAPI Spec: SDK Optimized

For more information about the API: Apideck Developer Docs

SDK Installation

The SDK relies on Composer to manage its dependencies.

To install the SDK and add it as a dependency to an existing composer.json file:

composer require "apideck-libraries/sdk-php"

SDK Example Usage

Example

declare(strict_types=1);

require 'vendor/autoload.php';

use Apideck\Unify;
use Apideck\Unify\Models\Components;
use Apideck\Unify\Models\Operations;

$sdk = Unify\Apideck::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->setConsumerId('test-consumer')
    ->setAppId('dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX')
    ->build();

$request = new Operations\AccountingTaxRatesAllRequest(
    serviceId: 'salesforce',
    filter: new Components\TaxRatesFilter(
        assets: true,
        equity: true,
        expenses: true,
        liabilities: true,
        revenue: true,
    ),
    passThrough: [
        'search' => 'San Francisco',
    ],
    fields: 'id,updated_at',
);

$responses = $sdk->accounting->taxRates->list(
    request: $request
);


foreach ($responses as $response) {
    if ($response->httpMeta->response->getStatusCode() === 200) {
        // handle response
    }
}

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
`apiKey`	http	HTTP Bearer

To authenticate with the API the apiKey parameter must be set when initializing the SDK. For example:

declare(strict_types=1);

require 'vendor/autoload.php';

use Apideck\Unify;
use Apideck\Unify\Models\Components;
use Apideck\Unify\Models\Operations;

$sdk = Unify\Apideck::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->setConsumerId('test-consumer')
    ->setAppId('dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX')
    ->build();

$request = new Operations\AccountingTaxRatesAllRequest(
    serviceId: 'salesforce',
    filter: new Components\TaxRatesFilter(
        assets: true,
        equity: true,
        expenses: true,
        liabilities: true,
        revenue: true,
    ),
    passThrough: [
        'search' => 'San Francisco',
    ],
    fields: 'id,updated_at',
);

$responses = $sdk->accounting->taxRates->list(
    request: $request
);


foreach ($responses as $response) {
    if ($response->httpMeta->response->getStatusCode() === 200) {
        // handle response
    }
}

Available Resources and Operations

Available methods

accounting

accounting->agedCreditors

get - Get Aged Creditors

accounting->agedDebtors

get - Get Aged Debtors

accounting->attachments

list - List Attachments
upload - Upload attachment
get - Get Attachment
delete - Delete Attachment
download - Download Attachment

accounting->balanceSheet

get - Get BalanceSheet

accounting->billPayments

list - List Bill Payments
create - Create Bill Payment
get - Get Bill Payment
update - Update Bill Payment
delete - Delete Bill Payment

accounting->bills

list - List Bills
create - Create Bill
get - Get Bill
update - Update Bill
delete - Delete Bill

accounting->companyInfo

get - Get company info

accounting->creditNotes

list - List Credit Notes
create - Create Credit Note
get - Get Credit Note
update - Update Credit Note
delete - Delete Credit Note

accounting->customers

list - List Customers
create - Create Customer
get - Get Customer
update - Update Customer
delete - Delete Customer

accounting->departments

list - List Departments
create - Create Department
get - Get Department
update - Update Department
delete - Delete Department

accounting->expenses

list - List Expenses
create - Create Expense
get - Get Expense
update - Update Expense
delete - Delete Expense

accounting->invoiceItems

list - List Invoice Items
create - Create Invoice Item
get - Get Invoice Item
update - Update Invoice Item
delete - Delete Invoice Item

accounting->invoices

list - List Invoices
create - Create Invoice
get - Get Invoice
update - Update Invoice
delete - Delete Invoice

accounting->journalEntries

list - List Journal Entries
create - Create Journal Entry
get - Get Journal Entry
update - Update Journal Entry
delete - Delete Journal Entry

accounting->ledgerAccounts

list - List Ledger Accounts
create - Create Ledger Account
get - Get Ledger Account
update - Update Ledger Account
delete - Delete Ledger Account

accounting->locations

list - List Locations
create - Create Location
get - Get Location
update - Update Location
delete - Delete Location

accounting->payments

list - List Payments
create - Create Payment
get - Get Payment
update - Update Payment
delete - Delete Payment

accounting->profitAndLoss

get - Get Profit and Loss

accounting->purchaseOrders

list - List Purchase Orders
create - Create Purchase Order
get - Get Purchase Order
update - Update Purchase Order
delete - Delete Purchase Order

accounting->subsidiaries

list - List Subsidiaries
create - Create Subsidiary
get - Get Subsidiary
update - Update Subsidiary
delete - Delete Subsidiary

accounting->suppliers

list - List Suppliers
create - Create Supplier
get - Get Supplier
update - Update Supplier
delete - Delete Supplier

accounting->taxRates

list - List Tax Rates
create - Create Tax Rate
get - Get Tax Rate
update - Update Tax Rate
delete - Delete Tax Rate

accounting->trackingCategories

list - List Tracking Categories
create - Create Tracking Category
get - Get Tracking Category
update - Update Tracking Category
delete - Delete Tracking Category

ats

ats->applicants

list - List Applicants
create - Create Applicant
get - Get Applicant
update - Update Applicant
delete - Delete Applicant

ats->applications

list - List Applications
create - Create Application
get - Get Application
update - Update Application
delete - Delete Application

ats->jobs

list - List Jobs
get - Get Job

connector

connector->apiResourceCoverage

get - Get API Resource Coverage

connector->apiResources

get - Get API Resource

connector->apis

list - List APIs
get - Get API

connector->connectorDocs

get - Get Connector Doc content

connector->connectorResources

get - Get Connector Resource

connector->connectors

list - List Connectors
get - Get Connector

crm

crm->activities

list - List activities
create - Create activity
get - Get activity
update - Update activity
delete - Delete activity

crm->companies

list - List companies
create - Create company
get - Get company
update - Update company
delete - Delete company

crm->contacts

list - List contacts
create - Create contact
get - Get contact
update - Update contact
delete - Delete contact

crm->leads

list - List leads
create - Create lead
get - Get lead
update - Update lead
delete - Delete lead

crm->notes

list - List notes
create - Create note
get - Get note
update - Update note
delete - Delete note

crm->opportunities

list - List opportunities
create - Create opportunity
get - Get opportunity
update - Update opportunity
delete - Delete opportunity

crm->pipelines

list - List pipelines
create - Create pipeline
get - Get pipeline
update - Updat 10000 e pipeline
delete - Delete pipeline

crm->users

list - List users
create - Create user
get - Get user
update - Update user
delete - Delete user

ecommerce

ecommerce->customers

list - List Customers
get - Get Customer

ecommerce->orders

list - List Orders
get - Get Order

ecommerce->products

list - List Products
get - Get Product

ecommerce->stores

get - Get Store

fileStorage

fileStorage->driveGroups

list - List DriveGroups
create - Create DriveGroup
get - Get DriveGroup
update - Update DriveGroup
delete - Delete DriveGroup

fileStorage->drives

list - List Drives
create - Create Drive
get - Get Drive
update - Update Drive
delete - Delete Drive

fileStorage->files

list - List Files
search - Search Files
get - Get File
update - Rename or move File
delete - Delete File
download - Download File
export - Export File

fileStorage->folders

create - Create Folder
get - Get Folder
update - Rename or move Folder
delete - Delete Folder
copy - Copy Folder

fileStorage->sharedLinks

list - List SharedLinks
create - Create Shared Link
get - Get Shared Link
update - Update Shared Link
delete - Delete Shared Link

fileStorage->uploadSessions

create - Start Upload Session
get - Get Upload Session
upload - Upload part of File to Upload Session
delete - Abort Upload Session
finish - Finish Upload Session

hris

hris->companies

list - List Companies
create - Create Company
get - Get Company
update - Update Company
delete - Delete Company

hris->departments

list - List Departments
create - Create Department
get - Get Department
update - Update Department
delete - Delete Department

hris->employeePayrolls

list - List Employee Payrolls
get - Get Employee Payroll

hris->employees

list - List Employees
create - Create Employee
get - Get Employee
update - Update Employee
delete - Delete Employee

hris->employeeSchedules

list - List Employee Schedules

hris->payrolls

list - List Payroll
get - Get Payroll

hris->timeOffRequests

list - List Time Off Requests
create - Create Time Off Request
get - Get Time Off Request
update - Update Time Off Request
delete - Delete Time Off Request

issueTracking

issueTracking->collections

list - List Collections
get - Get Collection

issueTracking->collectionTags

list - List Tags

issueTracking->collectionTicketComments

list - List Comments
create - Create Comment
get - Get Comment
update - Update Comment
delete - Delete Comment

issueTracking->collectionTickets

list - List Tickets
create - Create Ticket
get - Get Ticket
update - Update Ticket
delete - Delete Ticket

issueTracking->collectionUsers

list - List Users
get - Get user

sms

sms->messages

list - List Messages
create - Create Message
get - Get Message
update - Update Message
delete - Delete Message

vault

vault->connectionCustomMappings

list - List connection custom mappings

vault->connections

list - Get all connections
get - Get connection
update - Update connection
delete - Deletes a connection
imports - Import connection
token - Authorize Access Token

vault->connectionSettings

list - Get resource settings
update - Update settings

vault->consumerRequestCounts

list - Consumer request counts

vault->consumers

create - Create consumer
list - Get all consumers
get - Get consumer
update - Update consumer
delete - Delete consumer

vault->createCallback

state - Create Callback State

vault->customFields

list - Get resource custom fields

vault->customMappings

list - List custom mappings

vault->logs

list - Get all consumer request logs

vault->sessions

create - Create Session

vault->validateConnection

state - Validate Connection State

webhook

webhook->eventLogs

list - List event logs

webhook->webhooks

list - List webhook subscriptions
create - Create webhook subscription
get - Get webhook subscription
update - Update webhook subscription
delete - Delete webhook subscription

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned object will be a Generator instead of an individual response.

Working with generators is as simple as iterating over the responses in a foreach loop, and you can see an example below:

declare(strict_types=1);

require 'vendor/autoload.php';

use Apideck\Unify;
use Apideck\Unify\Models\Components;
use Apideck\Unify\Models\Operations;

$sdk = Unify\Apideck::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->setConsumerId('test-consumer')
    ->setAppId('dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX')
    ->build();

$request = new Operations\AccountingTaxRatesAllRequest(
    serviceId: 'salesforce',
    filter: new Components\TaxRatesFilter(
        assets: true,
        equity: true,
        expenses: true,
        liabilities: true,
        revenue: true,
    ),
    passThrough: [
        'search' => 'San Francisco',
    ],
    fields: 'id,updated_at',
);

$responses = $sdk->accounting->taxRates->list(
    request: $request
);


foreach ($responses as $response) {
    if ($response->httpMeta->response->getStatusCode() === 200) {
        // handle response
    }
}

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the A377 API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide an Options object built with a RetryConfig object to the call:

declare(strict_types=1);

require 'vendor/autoload.php';

use Apideck\Unify;
use Apideck\Unify\Models\Components;
use Apideck\Unify\Models\Operations;
use Apideck\Unify\Utils\Retry;

$sdk = Unify\Apideck::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->setConsumerId('test-consumer')
    ->setAppId('dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX')
    ->build();

$request = new Operations\AccountingTaxRatesAllRequest(
    serviceId: 'salesforce',
    filter: new Components\TaxRatesFilter(
        assets: true,
        equity: true,
        expenses: true,
        liabilities: true,
        revenue: true,
    ),
    passThrough: [
        'search' => 'San Francisco',
    ],
    fields: 'id,updated_at',
);

$responses = $sdk->accounting->taxRates->list(
    request: $request,
    options: Utils\Options->builder()->setRetryConfig(
        new Retry\RetryConfigBackoff(
            initialInterval: 1,
            maxInterval:     50,
            exponent:        1.1,
            maxElapsedTime:  100,
            retryConnectionErrors: false,
        ))->build()
);


foreach ($responses as $response) {
    if ($response->httpMeta->response->getStatusCode() === 200) {
        // handle response
    }
}

If you'd like to override the default retry strategy for all operations that support retries, you can pass a RetryConfig object to the SDKBuilder->setRetryConfig function when initializing the SDK:

declare(strict_types=1);

require 'vendor/autoload.php';

use Apideck\Unify;
use Apideck\Unify\Models\Components;
use Apideck\Unify\Models\Operations;
use Apideck\Unify\Utils\Retry;

$sdk = Unify\Apideck::builder()
    ->setRetryConfig(
        new Retry\RetryConfigBackoff(
            initialInterval: 1,
            maxInterval:     50,
            exponent:        1.1,
            maxElapsedTime:  100,
            retryConnectionErrors: false,
        )
  )
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->setConsumerId('test-consumer')
    ->setAppId('dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX')
    ->build();

$request = new Operations\AccountingTaxRatesAllRequest(
    serviceId: 'salesforce',
    filter: new Components\TaxRatesFilter(
        assets: true,
        equity: true,
        expenses: true,
        liabilities: true,
        revenue: true,
    ),
    passThrough: [
        'search' => 'San Francisco',
    ],
    fields: 'id,updated_at',
);

$responses = $sdk->accounting->taxRates->list(
    request: $request
);


foreach ($responses as $response) {
    if ($response->httpMeta->response->getStatusCode() === 200) {
        // handle response
    }
}

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an exception.

By default an API error will raise a Errors\APIException exception, which has the following properties:

Property	Type	Description
`$message`	string	The error message
`$request`	?\Psr\Http\Message\RequestInterface	The HTTP request
`$response`	?\Psr\Http\Message\ResponseInterface	The HTTP response

When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the list method throws the following exceptions:

Error Type	Status Code	Content Type
Errors\BadRequestResponse	400	application/json
Errors\UnauthorizedResponse	401	application/json
Errors\PaymentRequiredResponse	402	application/json
Errors\NotFoundResponse	404	application/json
Errors\UnprocessableResponse	422	application/json
Errors\APIException	4XX, 5XX	/

Example

declare(strict_types=1);

require 'vendor/autoload.php';

use Apideck\Unify;
use Apideck\Unify\Models\Components;
use Apideck\Unify\Models\Errors;
use Apideck\Unify\Models\Operations;

$sdk = Unify\Apideck::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->setConsumerId('test-consumer')
    ->setAppId('dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX')
    ->build();

try {
    $request = new Operations\AccountingTaxRatesAllRequest(
        serviceId: 'salesforce',
        filter: new Components\TaxRatesFilter(
            assets: true,
            equity: true,
            expenses: true,
            liabilities: true,
            revenue: true,
        ),
        passThrough: [
            'search' => 'San Francisco',
        ],
        fields: 'id,updated_at',
    );

    $responses = $sdk->accounting->taxRates->list(
        request: $request
    );

    foreach ($responses as $response) {
        if ($response->httpMeta->response->getStatusCode() === 200) {
            // handle response
        }
    }
} catch (Errors\BadRequestResponseThrowable $e) {
    // handle $e->$container data
    throw $e;
} catch (Errors\UnauthorizedResponseThrowable $e) {
    // handle $e->$container data
    throw $e;
} catch (Errors\PaymentRequiredResponseThrowable $e) {
    // handle $e->$container data
    throw $e;
} catch (Errors\NotFoundResponseThrowable $e) {
    // handle $e->$container data
    throw $e;
} catch (Errors\UnprocessableResponseThrowable $e) {
    // handle $e->$container data
    throw $e;
} catch (Errors\APIException $e) {
    // handle default exception
    throw $e;
}

Server Selection

Override Server URL Per-Client

The default server can be overridden globally using the setServerUrl(string $serverUrl) builder method when initializing the SDK client instance. For example:

declare(strict_types=1);

require 'vendor/autoload.php';

use Apideck\Unify;
use Apideck\Unify\Models\Components;
use Apideck\Unify\Models\Operations;

$sdk = Unify\Apideck::builder()
    ->setServerURL('https://unify.apideck.com')
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->setConsumerId('test-consumer')
    ->setAppId('dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX')
    ->build();

$request = new Operations\AccountingTaxRatesAllRequest(
    serviceId: 'salesforce',
    filter: new Components\TaxRatesFilter(
        assets: true,
        equity: true,
        expenses: true,
        liabilities: true,
        revenue: true,
    ),
    passThrough: [
        'search' => 'San Francisco',
    ],
    fields: 'id,updated_at',
);

$responses = $sdk->accounting->taxRates->list(
    request: $request
);


foreach ($responses as $response) {
    if ($response->httpMeta->response->getStatusCode() === 200) {
        // handle response
    }
}

Override Server URL Per-Operation

The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:

declare(strict_types=1);

require 'vendor/autoload.php';

use Apideck\Unify;
use Apideck\Unify\Models\Components;
use Apideck\Unify\Models\Operations;

$sdk = Unify\Apideck::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->setConsumerId('test-consumer')
    ->setAppId('dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX')
    ->build();

$request = new Operations\AccountingAttachmentsUploadRequest(
    referenceType: Components\AttachmentReferenceType::Invoice,
    referenceId: '12345',
    serviceId: 'salesforce',
    requestBody: '0x8cc9e675ad',
);

$response = $sdk->accounting->attachments->upload(
    request: $request,
    'https://upload.apideck.com'
);

if ($response->createAttachmentResponse !== null) {
    // handle response
}

Development

Maturity

There may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

Name		Name	Last commit message	Last commit date
Latest commit History 66 Commits
.github/workflows		.github/workflows
.speakeasy		.speakeasy
docs		docs
src		src
.gitattributes		.gitattributes
.gitignore		.gitignore
CONTRIBUTING.md		CONTRIBUTING.md
MIGRATION.md		MIGRATION.md
README.md		README.md
RELEASES.md		RELEASES.md
USAGE.md		USAGE.md
composer.json		composer.json
phpstan.neon		phpstan.neon
phpunit.xml		phpunit.xml
pint.json		pint.json
rector.php		rector.php

apideck-libraries/sdk-php

Folders and files

Latest commit

History

Repository files navigation

apideck-libraries/sdk-php

Summary

Table of Contents

SDK Installation

SDK Example Usage

Example

Authentication

Per-Client Security Schemes

Available Resources and Operations

Pagination

Retries

Error Handling

Example

Server Selection

Override Server URL Per-Client

Override Server URL Per-Operation

Development

Maturity

Contributions

About

Resources

Stars

Watchers

Forks

Languages