Skip to main content
POST
/
v1
/
files
/
{id}
/
uploaded
PHP (SDK)
declare(strict_types=1);

require 'vendor/autoload.php';

use Spaire;
use Spaire\Models\Components;

$sdk = Spaire\Spaire::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$fileUploadCompleted = new Components\FileUploadCompleted(
    id: '<id>',
    path: '/boot',
    parts: [
        new Components\S3FileUploadCompletedPart(
            number: 979613,
            checksumEtag: '<value>',
            checksumSha256Base64: '<value>',
        ),
        new Components\S3FileUploadCompletedPart(
            number: 979613,
            checksumEtag: '<value>',
            checksumSha256Base64: '<value>',
        ),
        new Components\S3FileUploadCompletedPart(
            number: 979613,
            checksumEtag: '<value>',
            checksumSha256Base64: '<value>',
        ),
    ],
);

$response = $sdk->files->uploaded(
    id: '<value>',
    fileUploadCompleted: $fileUploadCompleted

);

if ($response->responseFilesUploaded !== null) {
    // handle response
}
{
  "id": "<string>",
  "organization_id": "<string>",
  "name": "<string>",
  "path": "<string>",
  "mime_type": "<string>",
  "size": 123,
  "storage_version": "<string>",
  "checksum_etag": "<string>",
  "checksum_sha256_base64": "<string>",
  "checksum_sha256_hex": "<string>",
  "last_modified_at": "2023-11-07T05:31:56Z",
  "version": "<string>",
  "service": "<string>",
  "is_uploaded": true,
  "created_at": "2023-11-07T05:31:56Z",
  "size_readable": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.spairehq.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

You can generate an Organization Access Token from your organization's settings.

Path Parameters

​
id
string<uuid4>
required

The file ID.

Body

application/json
​
id
string
required
​
path
string
required
​
parts
S3FileUploadCompletedPart · object[]
required

Response

File upload completed.

File to be associated with the downloadables benefit.

​
id
string<uuid4>
required

The ID of the object.

​
organization_id
string<uuid4>
required
​
name
string
required
​
path
string
required
​
mime_type
string
required
​
size
integer
required
​
storage_version
string | null
required
​
checksum_etag
string | null
required
​
checksum_sha256_base64
string | null
required
​
checksum_sha256_hex
string | null
required
​
last_modified_at
string<date-time> | null
required
​
version
string | null
required
​
service
string
required
Allowed value: "downloadable"
​
is_uploaded
boolean
required
​
created_at
string<date-time>
required
​
size_readable
string
required