Fixed a support of filtering by metadata for document list (#21)

Author: akutsanov

docs/DocumentsApi.md

@@ -747,8 +747,8 @@ const body:pd_api.DocumentsApiListDocumentsRequest = {
   formId: "BhVzRcxH9Z2LgfPPGXFUBa",
   // string | Returns results where 'membership_id' is present in document as owner (should be member uuid) (optional)
   membershipId: "BhVzRcxH9Z2LgfPPGXFUBa",
-  // 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)
-  metadata: "metadata_example",
+  // Array<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)
+  metadata: ["metadata_opportunity_id=2181432","metadata_custom_key=custom_value"],
   // string | Return results where the `date_modified` field (iso-8601) is greater than or equal to this value. (optional)
   modifiedFrom: "2021-10-27T15:22:23.132757Z",
   // string | Return results where the `date_modified` field (iso-8601) is less than this value. (optional)
@@ -790,7 +790,7 @@ Name | Type | Description  | Notes
  **folderUuid** | [**string**] | The UUID of the folder where the documents are stored. | (optional) defaults to undefined
  **formId** | [**string**] | Specify the form used for documents creation. This parameter can&#39;t be used with template_id. | (optional) defaults to undefined
  **membershipId** | [**string**] | Returns results where &#39;membership_id&#39; is present in document as owner (should be member uuid) | (optional) defaults to undefined
- **metadata** | [**string**] | Specify metadata to filter by in the format of &#x60;metadata_{metadata-key}&#x3D;{metadata-value}&#x60; such as &#x60;metadata_opportunity_id&#x3D;2181432&#x60;. The &#x60;metadata_&#x60; prefix is always required. | (optional) defaults to undefined
+ **metadata** | **Array&lt;string&gt;** | Specify metadata to filter by in the format of &#x60;metadata_{metadata-key}&#x3D;{metadata-value}&#x60; such as &#x60;metadata_opportunity_id&#x3D;2181432&#x60;. The &#x60;metadata_&#x60; prefix is always required. | (optional) defaults to undefined
  **modifiedFrom** | [**string**] | Return results where the &#x60;date_modified&#x60; field (iso-8601) is greater than or equal to this value. | (optional) defaults to undefined
  **modifiedTo** | [**string**] | Return results where the &#x60;date_modified&#x60; field (iso-8601) is less than this value. | (optional) defaults to undefined
  **orderBy** | **DocumentOrderingFieldsEnum** | Specify the order of documents to return. Use &#x60;value&#x60; (for example, &#x60;date_created&#x60;) for ASC and &#x60;-value&#x60; (for example, &#x60;-date_created&#x60;) for DESC. | (optional) defaults to undefined

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pandadoc-node-client",
-  "version": "5.0.0",
+  "version": "5.0.1",
   "description": "The Official PandaDoc Node client SDK",
   "author": "PandaDoc",
   "keywords": [

src/apis/DocumentsApi.ts

@@ -547,7 +547,7 @@ export class DocumentsApiRequestFactory extends BaseAPIRequestFactory {
      * @param tag Search tag. Filter by document tag.
      * @param templateId Specify the template used for documents creation. Parameter can't be used with form_id.
      */
-    public async listDocuments(completedFrom?: string, completedTo?: string, contactId?: string, count?: number, createdFrom?: string, createdTo?: string, deleted?: boolean, id?: string, folderUuid?: string, formId?: string, membershipId?: string, metadata?: string, modifiedFrom?: string, modifiedTo?: string, orderBy?: DocumentOrderingFieldsEnum, page?: number, q?: string, status?: DocumentStatusRequestEnum, statusNe?: DocumentStatusRequestEnum, tag?: string, templateId?: string, _options?: Configuration): Promise<RequestContext> {
+    public async listDocuments(completedFrom?: string, completedTo?: string, contactId?: string, count?: number, createdFrom?: string, createdTo?: string, deleted?: boolean, id?: string, folderUuid?: string, formId?: string, membershipId?: string, metadata?: Array<string>, modifiedFrom?: string, modifiedTo?: string, orderBy?: DocumentOrderingFieldsEnum, page?: number, q?: string, status?: DocumentStatusRequestEnum, statusNe?: DocumentStatusRequestEnum, tag?: string, templateId?: string, _options?: Configuration): Promise<RequestContext> {
         let _config = _options || this.configuration;
 
 
@@ -635,7 +635,7 @@ export class DocumentsApiRequestFactory extends BaseAPIRequestFactory {
 
         // Query Params
         if (metadata !== undefined) {
-            requestContext.setQueryParam("metadata", ObjectSerializer.serialize(metadata, "string", ""));
+            requestContext.setQueryParam("metadata", ObjectSerializer.serialize(metadata, "Array<string>", ""));
         }
 
         // Query Params

src/http/http.ts

@@ -50,7 +50,7 @@ export type RequestBody = undefined | string | FormData | URLSearchParams;
  */
 export class RequestContext {
     private headers: { [key: string]: string } = {
-        "User-Agent": "pandadoc_node_client/5.0.0",
+        "User-Agent": "pandadoc_node_client/5.0.1",
     };
     private body: RequestBody = undefined;
     private url: URLParse;
@@ -66,12 +66,48 @@ export class RequestContext {
         this.url = new URLParse(url, true);
     }
 
+    public queryStringify(query: any, prefix: string = '') {
+        function encodeInput(input: any) {
+            try {
+                return encodeURIComponent(input);
+            } catch (e) {
+                return null;
+            }
+        }
+
+        const pairs: any[] = [];
+
+        if ('string' !== typeof prefix) prefix = '?';
+
+        Object.keys(query).forEach((key) => {
+            let value = query[key];
+
+            //
+            // Edge cases where we actually want to encode the value to an empty
+            // string instead of the stringified value.
+            //
+            if (!value && (value === null || value === undefined || isNaN(value))) {
+                value = '';
+            }
+
+            if (Array.isArray(value)) {
+                value.forEach(subValue => {
+                    pairs.push(encodeInput(key) + '=' + encodeInput(subValue));
+                });
+                return;
+            }
+            pairs.push(encodeInput(key) + '=' + encodeInput(value));
+        });
+
+        return pairs.length ? prefix + pairs.join('&') : '';
+    }
+
     /*
      * Returns the url set in the constructor including the query string
      *
      */
     public getUrl(): string {
-        return this.url.toString();
+        return this.url.toString(this.queryStringify);
     }
 
     /**

src/types/ObjectParamAPI.ts

@@ -703,10 +703,10 @@ export interface DocumentsApiListDocumentsRequest {
     membershipId?: 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.
-     * @type string
+     * @type Array<string>
      * @memberof DocumentsApilistDocuments
      */
-    metadata?: string
+    metadata?: Array<string>
     /**
      * Return results where the &#x60;date_modified&#x60; field (iso-8601) is greater than or equal to this value.
      * @type string

src/types/ObservableAPI.ts

@@ -767,7 +767,7 @@ export class ObservableDocumentsApi {
      * @param tag Search tag. Filter by document tag.
      * @param templateId Specify the template used for documents creation. Parameter can't be used with form_id.
      */
-    public listDocuments(completedFrom?: string, completedTo?: string, contactId?: string, count?: number, createdFrom?: string, createdTo?: string, deleted?: boolean, id?: string, folderUuid?: string, formId?: string, membershipId?: string, metadata?: string, modifiedFrom?: string, modifiedTo?: string, orderBy?: DocumentOrderingFieldsEnum, page?: number, q?: string, status?: DocumentStatusRequestEnum, statusNe?: DocumentStatusRequestEnum, tag?: string, templateId?: string, _options?: Configuration): Observable<DocumentListResponse> {
+    public listDocuments(completedFrom?: string, completedTo?: string, contactId?: string, count?: number, createdFrom?: string, createdTo?: string, deleted?: boolean, id?: string, folderUuid?: string, formId?: string, membershipId?: string, metadata?: Array<string>, modifiedFrom?: string, modifiedTo?: string, orderBy?: DocumentOrderingFieldsEnum, page?: number, q?: string, status?: DocumentStatusRequestEnum, statusNe?: DocumentStatusRequestEnum, tag?: string, templateId?: string, _options?: Configuration): Observable<DocumentListResponse> {
         const requestContextPromise = this.requestFactory.listDocuments(completedFrom, completedTo, contactId, count, createdFrom, createdTo, deleted, id, folderUuid, formId, membershipId, metadata, modifiedFrom, modifiedTo, orderBy, page, q, status, statusNe, tag, templateId, _options);
 
         // build promise chain

src/types/PromiseAPI.ts

@@ -445,7 +445,7 @@ export class PromiseDocumentsApi {
      * @param tag Search tag. Filter by document tag.
      * @param templateId Specify the template used for documents creation. Parameter can't be used with form_id.
      */
-    public listDocuments(completedFrom?: string, completedTo?: string, contactId?: string, count?: number, createdFrom?: string, createdTo?: string, deleted?: boolean, id?: string, folderUuid?: string, formId?: string, membershipId?: string, metadata?: string, modifiedFrom?: string, modifiedTo?: string, orderBy?: DocumentOrderingFieldsEnum, page?: number, q?: string, status?: DocumentStatusRequestEnum, statusNe?: DocumentStatusRequestEnum, tag?: string, templateId?: string, _options?: Configuration): Promise<DocumentListResponse> {
+    public listDocuments(completedFrom?: string, completedTo?: string, contactId?: string, count?: number, createdFrom?: string, createdTo?: string, deleted?: boolean, id?: string, folderUuid?: string, formId?: string, membershipId?: string, metadata?: Array<string>, modifiedFrom?: string, modifiedTo?: string, orderBy?: DocumentOrderingFieldsEnum, page?: number, q?: string, status?: DocumentStatusRequestEnum, statusNe?: DocumentStatusRequestEnum, tag?: string, templateId?: string, _options?: Configuration): Promise<DocumentListResponse> {
         const result = this.api.listDocuments(completedFrom, completedTo, contactId, count, createdFrom, createdTo, deleted, id, folderUuid, formId, membershipId, metadata, modifiedFrom, modifiedTo, orderBy, page, q, status, statusNe, tag, templateId, _options);
         return result.toPromise();
     }