Skip to content

Commit 93e4086

Browse files
authored
Fixed a support of filtering by metadata for document list (#7)
1 parent 567b327 commit 93e4086

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ or add the following to `composer.json`:
1919
```json
2020
{
2121
"require": {
22-
"pandadoc/php-client": "5.0.0"
22+
"pandadoc/php-client": "5.0.1"
2323
}
2424
}
2525
```

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "pandadoc/php-client",
3-
"version": "5.0.0",
3+
"version": "5.0.1",
44
"description": "The Official PandaDoc PHP client SDK",
55
"keywords": [
66
"openapi",

docs/Api/DocumentsApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -637,7 +637,7 @@ $id = BhVzRcxH9Z2LgfPPGXFUBa; // string
637637
$folderUuid = BhVzRcxH9Z2LgfPPGXFUBa; // string | The UUID of the folder where the documents are stored.
638638
$formId = BhVzRcxH9Z2LgfPPGXFUBa; // string | Specify the form used for documents creation. This parameter can't be used with template_id.
639639
$membershipId = BhVzRcxH9Z2LgfPPGXFUBa; // string | Returns results where 'membership_id' is present in document as owner (should be member uuid)
640-
$metadata = 'metadata_example'; // string | Specify metadata to filter by in the format of `metadata_{metadata-key}={metadata-value}` such as `metadata_opportunity_id=2181432`. The `metadata_` prefix is always required.
640+
$metadata = ["metadata_opportunity_id=2181432","metadata_custom_key=custom_value"]; // string[] | Specify metadata to filter by in the format of `metadata_{metadata-key}={metadata-value}` such as `metadata_opportunity_id=2181432`. The `metadata_` prefix is always required.
641641
$modifiedFrom = 2021-10-27T15:22:23.132757Z; // string | Return results where the `date_modified` field (iso-8601) is greater than or equal to this value.
642642
$modifiedTo = 2021-10-27T15:22:23.132757Z; // string | Return results where the `date_modified` field (iso-8601) is less than this value.
643643
$orderBy = name; // \PandaDoc\Client\Model\DocumentOrderingFieldsEnum | Specify the order of documents to return. Use `value` (for example, `date_created`) for ASC and `-value` (for example, `-date_created`) for DESC.
@@ -671,7 +671,7 @@ Name | Type | Description | Notes
671671
**folderUuid** | **string**| The UUID of the folder where the documents are stored. | [optional]
672672
**formId** | **string**| Specify the form used for documents creation. This parameter can't be used with template_id. | [optional]
673673
**membershipId** | **string**| Returns results where 'membership_id' is present in document as owner (should be member uuid) | [optional]
674-
**metadata** | **string**| Specify metadata to filter by in the format of `metadata_{metadata-key}={metadata-value}` such as `metadata_opportunity_id=2181432`. The `metadata_` prefix is always required. | [optional]
674+
**metadata** | [**string[]**](../Model/string.md)| Specify metadata to filter by in the format of `metadata_{metadata-key}={metadata-value}` such as `metadata_opportunity_id=2181432`. The `metadata_` prefix is always required. | [optional]
675675
**modifiedFrom** | **string**| Return results where the `date_modified` field (iso-8601) is greater than or equal to this value. | [optional]
676676
**modifiedTo** | **string**| Return results where the `date_modified` field (iso-8601) is less than this value. | [optional]
677677
**orderBy** | [**\PandaDoc\Client\Model\DocumentOrderingFieldsEnum**](../Model/.md)| Specify the order of documents to return. Use `value` (for example, `date_created`) for ASC and `-value` (for example, `-date_created`) for DESC. | [optional]

src/Api/DocumentsApi.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3330,7 +3330,7 @@ public function downloadProtectedDocumentRequest($id)
33303330
* @param string $folderUuid The UUID of the folder where the documents are stored. (optional)
33313331
* @param string $formId Specify the form used for documents creation. This parameter can't be used with template_id. (optional)
33323332
* @param string $membershipId Returns results where 'membership_id' is present in document as owner (should be member uuid) (optional)
3333-
* @param string $metadata Specify metadata to filter by in the format of `metadata_{metadata-key}={metadata-value}` such as `metadata_opportunity_id=2181432`. The `metadata_` prefix is always required. (optional)
3333+
* @param string[] $metadata Specify metadata to filter by in the format of `metadata_{metadata-key}={metadata-value}` such as `metadata_opportunity_id=2181432`. The `metadata_` prefix is always required. (optional)
33343334
* @param string $modifiedFrom Return results where the `date_modified` field (iso-8601) is greater than or equal to this value. (optional)
33353335
* @param string $modifiedTo Return results where the `date_modified` field (iso-8601) is less than this value. (optional)
33363336
* @param \PandaDoc\Client\Model\DocumentOrderingFieldsEnum $orderBy Specify the order of documents to return. Use `value` (for example, `date_created`) for ASC and `-value` (for example, `-date_created`) for DESC. (optional)
@@ -3367,7 +3367,7 @@ public function listDocuments($completedFrom = null, $completedTo = null, $conta
33673367
* @param string $folderUuid The UUID of the folder where the documents are stored. (optional)
33683368
* @param string $formId Specify the form used for documents creation. This parameter can't be used with template_id. (optional)
33693369
* @param string $membershipId Returns results where 'membership_id' is present in document as owner (should be member uuid) (optional)
3370-
* @param string $metadata Specify metadata to filter by in the format of `metadata_{metadata-key}={metadata-value}` such as `metadata_opportunity_id=2181432`. The `metadata_` prefix is always required. (optional)
3370+
* @param string[] $metadata Specify metadata to filter by in the format of `metadata_{metadata-key}={metadata-value}` such as `metadata_opportunity_id=2181432`. The `metadata_` prefix is always required. (optional)
33713371
* @param string $modifiedFrom Return results where the `date_modified` field (iso-8601) is greater than or equal to this value. (optional)
33723372
* @param string $modifiedTo Return results where the `date_modified` field (iso-8601) is less than this value. (optional)
33733373
* @param \PandaDoc\Client\Model\DocumentOrderingFieldsEnum $orderBy Specify the order of documents to return. Use `value` (for example, `date_created`) for ASC and `-value` (for example, `-date_created`) for DESC. (optional)
@@ -3560,7 +3560,7 @@ public function listDocumentsWithHttpInfo($completedFrom = null, $completedTo =
35603560
* @param string $folderUuid The UUID of the folder where the documents are stored. (optional)
35613561
* @param string $formId Specify the form used for documents creation. This parameter can't be used with template_id. (optional)
35623562
* @param string $membershipId Returns results where 'membership_id' is present in document as owner (should be member uuid) (optional)
3563-
* @param string $metadata Specify metadata to filter by in the format of `metadata_{metadata-key}={metadata-value}` such as `metadata_opportunity_id=2181432`. The `metadata_` prefix is always required. (optional)
3563+
* @param string[] $metadata Specify metadata to filter by in the format of `metadata_{metadata-key}={metadata-value}` such as `metadata_opportunity_id=2181432`. The `metadata_` prefix is always required. (optional)
35643564
* @param string $modifiedFrom Return results where the `date_modified` field (iso-8601) is greater than or equal to this value. (optional)
35653565
* @param string $modifiedTo Return results where the `date_modified` field (iso-8601) is less than this value. (optional)
35663566
* @param \PandaDoc\Client\Model\DocumentOrderingFieldsEnum $orderBy Specify the order of documents to return. Use `value` (for example, `date_created`) for ASC and `-value` (for example, `-date_created`) for DESC. (optional)
@@ -3600,7 +3600,7 @@ function ($response) {
36003600
* @param string $folderUuid The UUID of the folder where the documents are stored. (optional)
36013601
* @param string $formId Specify the form used for documents creation. This parameter can't be used with template_id. (optional)
36023602
* @param string $membershipId Returns results where 'membership_id' is present in document as owner (should be member uuid) (optional)
3603-
* @param string $metadata Specify metadata to filter by in the format of `metadata_{metadata-key}={metadata-value}` such as `metadata_opportunity_id=2181432`. The `metadata_` prefix is always required. (optional)
3603+
* @param string[] $metadata Specify metadata to filter by in the format of `metadata_{metadata-key}={metadata-value}` such as `metadata_opportunity_id=2181432`. The `metadata_` prefix is always required. (optional)
36043604
* @param string $modifiedFrom Return results where the `date_modified` field (iso-8601) is greater than or equal to this value. (optional)
36053605
* @param string $modifiedTo Return results where the `date_modified` field (iso-8601) is less than this value. (optional)
36063606
* @param \PandaDoc\Client\Model\DocumentOrderingFieldsEnum $orderBy Specify the order of documents to return. Use `value` (for example, `date_created`) for ASC and `-value` (for example, `-date_created`) for DESC. (optional)
@@ -3666,7 +3666,7 @@ function ($exception) {
36663666
* @param string $folderUuid The UUID of the folder where the documents are stored. (optional)
36673667
* @param string $formId Specify the form used for documents creation. This parameter can't be used with template_id. (optional)
36683668
* @param string $membershipId Returns results where 'membership_id' is present in document as owner (should be member uuid) (optional)
3669-
* @param string $metadata Specify metadata to filter by in the format of `metadata_{metadata-key}={metadata-value}` such as `metadata_opportunity_id=2181432`. The `metadata_` prefix is always required. (optional)
3669+
* @param string[] $metadata Specify metadata to filter by in the format of `metadata_{metadata-key}={metadata-value}` such as `metadata_opportunity_id=2181432`. The `metadata_` prefix is always required. (optional)
36703670
* @param string $modifiedFrom Return results where the `date_modified` field (iso-8601) is greater than or equal to this value. (optional)
36713671
* @param string $modifiedTo Return results where the `date_modified` field (iso-8601) is less than this value. (optional)
36723672
* @param \PandaDoc\Client\Model\DocumentOrderingFieldsEnum $orderBy Specify the order of documents to return. Use `value` (for example, `date_created`) for ASC and `-value` (for example, `-date_created`) for DESC. (optional)

src/Configuration.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ class Configuration
8888
*
8989
* @var string
9090
*/
91-
protected $userAgent = 'pandadoc_php_client/5.0.0';
91+
protected $userAgent = 'pandadoc_php_client/5.0.1';
9292

9393
/**
9494
* Debug switch (default set to false)
@@ -396,8 +396,8 @@ public static function toDebugReport()
396396
$report = 'PHP SDK (PandaDoc\Client) Debug Report:' . PHP_EOL;
397397
$report .= ' OS: ' . php_uname() . PHP_EOL;
398398
$report .= ' PHP Version: ' . PHP_VERSION . PHP_EOL;
399-
$report .= ' The version of the OpenAPI document: 5.0.0' . PHP_EOL;
400-
$report .= ' SDK Package Version: 5.0.0' . PHP_EOL;
399+
$report .= ' The version of the OpenAPI document: 5.0.1' . PHP_EOL;
400+
$report .= ' SDK Package Version: 5.0.1' . PHP_EOL;
401401
$report .= ' Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL;
402402

403403
return $report;

0 commit comments

Comments
 (0)