diff --git a/generate-client/swagger.json b/generate-client/swagger.json index ff563fc3..bb8fdf7b 100644 --- a/generate-client/swagger.json +++ b/generate-client/swagger.json @@ -3,7 +3,7 @@ "openapi": "3.0.0", "info": { "title": "Laserfiche Repository API", - "description": "Welcome to the Laserfiche API Swagger Playground. You can try out any of our API calls against your live Laserfiche Cloud account. Visit the developer center for more details: https://developer.laserfiche.com

Visit the changelog for the list of changes: /v1/changelog

Build# :

", + "description": "Welcome to the Laserfiche API Swagger Playground. You can try out any of our API calls against your live Laserfiche Cloud account. Visit the developer center for more details: https://developer.laserfiche.com

Visit the changelog for the list of changes: /repository/v1/changelog

Build# : c2b48a709248742c8c1c8aa8718ead3d7e893a85_.20230614.5

", "version": "1" }, "servers": [ @@ -17,7 +17,7 @@ "tags": [ "Entries" ], - "summary": "Creates a new document in the specified folder with file (no more than 100 MB). Optionally sets metadata and electronic document component. Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. With this route, partial success is possible. The response returns multiple operation (entryCreate operation, setEdoc operation, setLinks operation, etc..) objects, which contain information about any errors that may have occurred during the creation. As long as the entryCreate operation succeeds, the entry will be created, even if all other operations fail.", + "summary": "Creates a new document in a folder.", "description": "- Creates a new document in the specified folder with file (no more than 100 MB).\n- Optionally sets metadata and electronic document component.\n- Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. With this route, partial success is possible. The response returns multiple operation (entryCreate operation, setEdoc operation, setLinks operation, etc..) objects, which contain information about any errors that may have occurred during the creation. As long as the entryCreate operation succeeds, the entry will be created, even if all other operations fail.", "operationId": "ImportDocument", "parameters": [ @@ -152,6 +152,16 @@ } } }, + "413": { + "description": "Request is too large.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, "429": { "description": "Rate limit is reached.", "content": { @@ -180,7 +190,7 @@ "tags": [ "Attributes" ], - "summary": "Returns the attribute key value pairs associated with the authenticated user. Alternatively, return only the attribute key value pairs that are associated with the \"Everyone\" group. Attribute keys can be used with subsequent calls to get specific attribute values. Default page size: 100. Allowed OData query options: Select, Count, OrderBy, Skip, Top, SkipToken, Prefer. Optional query parameters: everyone (bool, default false). When true, this route does not return the attributes that are tied to the currently authenticated user, but rather the attributes assigned to the \"Everyone\" group. Note when this is true, the response does not include both the \"Everyone\" groups attribute and the currently authenticated user, but only the \"Everyone\" groups.", + "summary": "Returns the attribute key value pairs associated with the authenticated user.", "description": "- Returns the attribute key value pairs associated with the authenticated user. Alternatively, return only the attribute key value pairs that are associated with the \"Everyone\" group.\n- Attribute keys can be used with subsequent calls to get specific attribute values.\n- Default page size: 100. Allowed OData query options: Select, Count, OrderBy, Skip, Top, SkipToken, Prefer. Optional query parameters: everyone (bool, default false). When true, this route does not return the attributes that are tied to the currently authenticated user, but rather the attributes assigned to the \"Everyone\" group. Note when this is true, the response does not include both the \"Everyone\" groups attribute and the currently authenticated user, but only the \"Everyone\" groups.", "operationId": "GetTrusteeAttributeKeyValuePairs", "parameters": [ @@ -333,7 +343,7 @@ "tags": [ "Attributes" ], - "summary": "Returns the attribute associated with the key. Alternatively, return the attribute associated with the key within \"Everyone\" group. Optional query parameters: everyone (bool, default false). When true, the server only searches for the attribute value with the given key upon the authenticated users attributes. If false, only the authenticated users attributes will be queried.", + "summary": "Returns an attribute object associated with the authenticated user.", "description": "- Returns the attribute associated with the key. Alternatively, return the attribute associated with the key within \"Everyone\" group.\n- Optional query parameters: everyone (bool, default false). When true, the server only searches for the attribute value with the given key upon the authenticated users attributes. If false, only the authenticated users attributes will be queried.", "operationId": "GetTrusteeAttributeValueByKey", "parameters": [ @@ -436,7 +446,7 @@ "tags": [ "FieldDefinitions" ], - "summary": "Returns a single field definition associated with the specified ID. Useful when a route provides a minimal amount of details and more information about the specific field definition is needed. Allowed OData query options: Select", + "summary": "Returns a single field definition object.", "description": "- Returns a single field definition associated with the specified ID. \n- Useful when a route provides a minimal amount of details and more information about the specific field definition is needed.\n- Allowed OData query options: Select", "operationId": "GetFieldDefinitionById", "parameters": [ @@ -552,7 +562,7 @@ "tags": [ "FieldDefinitions" ], - "summary": "Returns a paged listing of field definitions available in the specified repository. Useful when trying to find a list of all field definitions available, rather than only those assigned to a specific entry/template. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.", + "summary": "Returns the paged listing of the field definitions available in a repository.", "description": "- Returns a paged listing of field definitions available in the specified repository.\n- Useful when trying to find a list of all field definitions available, rather than only those assigned to a specific entry/template.\n- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.", "operationId": "GetFieldDefinitions", "parameters": [ @@ -707,7 +717,7 @@ "tags": [ "LinkDefinitions" ], - "summary": "Returns the link definitions in the repository. Provide a repository ID and get a paged listing of link definitions available in the repository. Useful when trying to display all link definitions available, not only links assigned to a specific entry. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.", + "summary": "Returns the link definitions associated with a repository.", "description": "- Returns the link definitions in the repository.\n- Provide a repository ID and get a paged listing of link definitions available in the repository. Useful when trying to display all link definitions available, not only links assigned to a specific entry.\n- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.", "operationId": "GetLinkDefinitions", "parameters": [ @@ -851,7 +861,7 @@ "tags": [ "LinkDefinitions" ], - "summary": "Returns a single link definition associated with the specified ID. Provide a link type ID and get the associated link definition. Useful when a route provides a minimal amount of details and more information about the specific link definition is needed. Allowed OData query options: Select", + "summary": "Returns a single link definition object.", "description": "- Returns a single link definition associated with the specified ID.\n- Provide a link type ID and get the associated link definition. Useful when a route provides a minimal amount of details and more information about the specific link definition is needed.\n- Allowed OData query options: Select", "operationId": "GetLinkDefinitionById", "parameters": [ @@ -956,7 +966,7 @@ "tags": [ "Entries" ], - "summary": "Returns a single entry object. Provide an entry ID, and get the entry associated with that ID. Useful when detailed information about the entry is required, such as metadata, path information, etc. Allowed OData query options: Select. If the entry is a subtype (Folder, Document, or Shortcut), the entry will automatically be converted to include those model-specific properties.", + "summary": "Returns a single entry object.", "description": "- Returns a single entry object.\n- Provide an entry ID, and get the entry associated with that ID. Useful when detailed information about the entry is required, such as metadata, path information, etc.\n- Allowed OData query options: Select. If the entry is a subtype (Folder, Document, or Shortcut), the entry will automatically be converted to include those model-specific properties.", "operationId": "GetEntry", "parameters": [ @@ -1059,7 +1069,7 @@ "tags": [ "Entries" ], - "summary": "Begins a task to delete an entry, and returns an operationToken. Provide an entry ID, and queue a delete task to remove it from the repository (includes nested objects if the entry is a Folder type). The entry will not be deleted immediately. Optionally include an audit reason ID and comment in the JSON body. This route returns an operationToken, and will run as an asynchronous operation. Check the progress via the Tasks/{operationToken} route.", + "summary": "Deletes an entry asynchronously.", "description": "- Begins a task to delete an entry, and returns an operationToken.\n- Provide an entry ID, and queue a delete task to remove it from the repository (includes nested objects if the entry is a Folder type). The entry will not be deleted immediately.\n- Optionally include an audit reason ID and comment in the JSON body. This route returns an operationToken, and will run as an asynchronous operation. Check the progress via the Tasks/{operationToken} route.", "operationId": "DeleteEntryInfo", "parameters": [ @@ -1148,6 +1158,16 @@ } } }, + "413": { + "description": "Request is too large.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, "429": { "description": "Operation limit or request limit reached.", "content": { @@ -1164,7 +1184,7 @@ "tags": [ "Entries" ], - "summary": "Moves and/or renames an entry. Move and/or rename an entry by passing in the new parent folder ID or name in the JSON body. Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed.", + "summary": "Moves and/or renames an entry.", "description": "- Moves and/or renames an entry.\n- Move and/or rename an entry by passing in the new parent folder ID or name in the JSON body.\n- Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed.", "operationId": "MoveOrRenameEntry", "parameters": [ @@ -1307,6 +1327,16 @@ } } }, + "413": { + "description": "Request is too large.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, "423": { "description": "Entry is locked.", "content": { @@ -1335,7 +1365,7 @@ "tags": [ "Entries" ], - "summary": "Returns a single entry object using the entry path. Optional query parameter: fallbackToClosestAncestor. Use the fallbackToClosestAncestor query parameter to return the closest existing ancestor if the initial entry path is not found.", + "summary": "Returns a single entry object using the entry path.", "description": "- Returns a single entry object using the entry path.\n- Optional query parameter: fallbackToClosestAncestor. Use the fallbackToClosestAncestor query parameter to return the closest existing ancestor if the initial entry path is not found.", "operationId": "GetEntryByPath", "parameters": [ @@ -1440,8 +1470,8 @@ "tags": [ "Entries" ], - "summary": "Returns the children entries of a folder in the repository. Provide an entry ID (must be a folder), and get a paged listing of entries in that folder. Used as a way of navigating through the repository. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. OData $OrderBy syntax should follow: \"PropertyName direction,PropertyName2 direction\". Sort order can be either value \"asc\" or \"desc\". Optional query parameters: groupByOrderType (bool). This query parameter decides if results are returned in groups based on their entry type. Entries returned in the listing are not automatically converted to their subtype (Folder, Shortcut, Document), so clients who want model-specific information should request it via the GET entry by ID route. Optionally returns field values for the entries in the folder. Each field name needs to be specified in the request. Maximum limit of 10 field names. If field values are requested, only the first value is returned if it is a multi value field. Null or Empty field values should not be used to determine if a field is assigned to the entry.", - "description": "- Returns the children entries of a folder in the repository.\n- Provide an entry ID (must be a folder), and get a paged listing of entries in that folder. Used as a way of navigating through the repository.\n- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. OData $OrderBy syntax should follow: \"PropertyName direction,PropertyName2 direction\". Sort order can be either value \"asc\" or \"desc\". Optional query parameters: groupByOrderType (bool). This query parameter decides if results are returned in groups based on their entry type. Entries returned in the listing are not automatically converted to their subtype (Folder, Shortcut, Document), so clients who want model-specific information should request it via the GET entry by ID route.\n- Optionally returns field values for the entries in the folder. Each field name needs to be specified in the request. Maximum limit of 10 field names.\n- If field values are requested, only the first value is returned if it is a multi value field.\n- Null or Empty field values should not be used to determine if a field is assigned to the entry.", + "summary": "Returns the children entries of a folder.", + "description": "- Returns the children entries of a folder in the repository.\n- Provide an entry ID (must be a folder), and get a paged listing of entries in that folder. Used as a way of navigating through the repository.\n- Default page size: 150. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. OData $OrderBy syntax should follow: \"PropertyName direction,PropertyName2 direction\". Sort order can be either value \"asc\" or \"desc\". Optional query parameters: groupByOrderType (bool). This query parameter decides if results are returned in groups based on their entry type. Entries returned in the listing are not automatically converted to their subtype (Folder, Shortcut, Document), so clients who want model-specific information should request it via the GET entry by ID route.\n- Optionally returns field values for the entries in the folder. Each field name needs to be specified in the request. Maximum limit of 10 field names.\n- If field values are requested, only the first value is returned if it is a multi value field.\n- Null or Empty field values should not be used to determine if a field is assigned to the entry.", "operationId": "GetEntryListing", "parameters": [ { @@ -1637,7 +1667,7 @@ "tags": [ "Entries" ], - "summary": "Create/copy a new child entry in the designated folder. Provide the parent folder ID, and based on the request body, copy or create a folder/shortcut as a child entry of the designated folder. Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed.", + "summary": "Creates/copies a new child entry in a folder.", "description": "- Create/copy a new child entry in the designated folder.\n- Provide the parent folder ID, and based on the request body, copy or create a folder/shortcut as a child entry of the designated folder.\n- Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed.", "operationId": "CreateOrCopyEntry", "parameters": [ @@ -1783,6 +1813,16 @@ } } }, + "413": { + "description": "Request is too large.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, "429": { "description": "Rate limit is reached.", "content": { @@ -1801,7 +1841,7 @@ "tags": [ "Entries" ], - "summary": "Returns the fields assigned to an entry. Provide an entry ID, and get a paged listing of all fields assigned to that entry. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.", + "summary": "Returns the fields assigned to an entry.", "description": "- Returns the fields assigned to an entry.\n- Provide an entry ID, and get a paged listing of all fields assigned to that entry.\n- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.", "operationId": "GetFieldValues", "parameters": [ @@ -1975,7 +2015,7 @@ "tags": [ "Entries" ], - "summary": "Update the field values assigned to an entry. Provide the new field values to assign to the entry, and remove/reset all previously assigned field values. This is an overwrite action. The request body must include all desired field values, including any existing field values that should remain assigned to the entry. Field values that are not included in the request will be deleted from the entry. If the field value that is not included is part of a template, it will still be assigned (as required by the template), but its value will be reset.", + "summary": "Updates the field values assigned to an entry.", "description": "- Update the field values assigned to an entry.\n- Provide the new field values to assign to the entry, and remove/reset all previously assigned field values. \n- This is an overwrite action. The request body must include all desired field values, including any existing field values that should remain assigned to the entry. Field values that are not included in the request will be deleted from the entry. If the field value that is not included is part of a template, it will still be assigned (as required by the template), but its value will be reset.", "operationId": "AssignFieldValues", "parameters": [ @@ -2078,6 +2118,16 @@ } } }, + "413": { + "description": "Request is too large.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, "423": { "description": "Entry is locked.", "content": { @@ -2106,7 +2156,7 @@ "tags": [ "Entries" ], - "summary": "Returns the tags assigned to an entry. Provide an entry ID, and get a paged listing of tags assigned to that entry. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.", + "summary": "Returns the tags assigned to an entry.", "description": "- Returns the tags assigned to an entry.\n- Provide an entry ID, and get a paged listing of tags assigned to that entry.\n- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.", "operationId": "GetTagsAssignedToEntry", "parameters": [ @@ -2259,7 +2309,7 @@ "tags": [ "Entries" ], - "summary": "Assign tags to an entry. Provide an entry ID and a list of tags to assign to that entry. This is an overwrite action. The request must include all tags to assign to the entry, including existing tags that should remain assigned to the entry.", + "summary": "Assigns tags to an entry.", "description": "- Assign tags to an entry.\n- Provide an entry ID and a list of tags to assign to that entry.\n- This is an overwrite action. The request must include all tags to assign to the entry, including existing tags that should remain assigned to the entry.", "operationId": "AssignTags", "parameters": [ @@ -2348,6 +2398,16 @@ } } }, + "413": { + "description": "Request is too large.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, "423": { "description": "Entry is locked.", "content": { @@ -2376,7 +2436,7 @@ "tags": [ "Entries" ], - "summary": "Assign links to an entry. Provide an entry ID and a list of links to assign to that entry. This is an overwrite action. The request must include all links to assign to the entry, including existing links that should remain assigned to the entry.", + "summary": "Assigns links to an entry.", "description": "- Assign links to an entry.\n- Provide an entry ID and a list of links to assign to that entry.\n- This is an overwrite action. The request must include all links to assign to the entry, including existing links that should remain assigned to the entry.", "operationId": "AssignEntryLinks", "parameters": [ @@ -2467,6 +2527,16 @@ } } }, + "413": { + "description": "Request is too large.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, "423": { "description": "Entry is locked.", "content": { @@ -2493,7 +2563,7 @@ "tags": [ "Entries" ], - "summary": "Returns the links assigned to an entry. Provide an entry ID, and get a paged listing of links assigned to that entry. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.", + "summary": "Returns the links assigned to an entry.", "description": "- Returns the links assigned to an entry.\n- Provide an entry ID, and get a paged listing of links assigned to that entry.\n- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.", "operationId": "GetLinkValuesFromEntry", "parameters": [ @@ -2648,8 +2718,8 @@ "tags": [ "Entries" ], - "summary": "Copy a new child entry in the designated folder async, and potentially return an operationToken. Provide the parent folder ID, and copy an entry as a child of the designated folder. Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. The status of the operation can be checked via the Tasks/{operationToken} route.", - "description": "- Copy a new child entry in the designated folder async, and potentially return an operationToken.\n- Provide the parent folder ID, and copy an entry as a child of the designated folder.\n- Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. \n- The status of the operation can be checked via the Tasks/{operationToken} route.", + "summary": "Copies an entry into a folder asynchronously.", + "description": "- Copy a new child entry in the designated folder async, and potentially return an operationToken.\n- Provide the parent folder ID, and copy an entry as a child of the designated folder.\n- Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. \n- The status of the operation can be checked via the Tasks/{operationToken} route.\n- Token substitution in the name of the copied entry is not supported.", "operationId": "CopyEntryAsync", "parameters": [ { @@ -2767,6 +2837,16 @@ } } }, + "413": { + "description": "Request is too large.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, "429": { "description": "Operation limit or request limit reached.", "content": { @@ -2785,7 +2865,7 @@ "tags": [ "Entries" ], - "summary": "Delete the edoc associated with the provided entry ID.", + "summary": "Deletes the edoc associated with an entry.", "description": "- Delete the edoc associated with the provided entry ID.", "operationId": "DeleteDocument", "parameters": [ @@ -2888,8 +2968,8 @@ "tags": [ "Entries" ], - "summary": "Returns information about the edoc content of an entry, without downloading the edoc in its entirety. Provide an entry ID, and get back the Content-Type and Content-Length in the response headers. This route does not provide a way to download the actual edoc. Instead, it just gives metadata information about the edoc associated with the entry.", - "description": "- Returns information about the edoc content of an entry, without downloading the edoc in its entirety.\n- Provide an entry ID, and get back the Content-Type and Content-Length in the response headers.\n- This route does not provide a way to download the actual edoc. Instead, it just gives metadata information about the edoc associated with the entry.", + "summary": "Returns information about the edoc content of an entry.", + "description": "- Returns information about the edoc content of an entry, without downloading the edoc in its entirety.\n- Provide an entry ID, and get back the Content-Type and Content-Length in the response headers.\n- This route does not provide a way to download the actual edoc. Instead, it just gives metadata information about the edoc associated with the entry.\n- If an error occurs, the error message can be found in the X-APIServer-Error HTTP response header.", "operationId": "GetDocumentContentType", "parameters": [ { @@ -2942,7 +3022,7 @@ "tags": [ "Entries" ], - "summary": "Returns an entry's edoc resource in a stream format. Provide an entry ID, and get the edoc resource as part of the response content. Optional header: Range. Use the Range header (single range with byte unit) to retrieve partial content of the edoc, rather than the entire edoc.", + "summary": "Returns an entry's edoc resource in a stream format.", "description": "- Returns an entry's edoc resource in a stream format.\n- Provide an entry ID, and get the edoc resource as part of the response content.\n- Optional header: Range. Use the Range header (single range with byte unit) to retrieve partial content of the edoc, rather than the entire edoc.", "operationId": "ExportDocument", "parameters": [ @@ -3070,7 +3150,7 @@ "tags": [ "Entries" ], - "summary": "Delete the pages associated with the provided entry ID. If no pageRange is specified, all pages will be deleted. Optional parameter: pageRange (default empty). The value should be a comma-seperated string which contains non-overlapping single values, or page ranges. Ex: \"1,2,3\", \"1-3,5\", \"2-7,10-12.\"", + "summary": "Deletes the pages associated with an entry.", "description": "- Delete the pages associated with the provided entry ID. If no pageRange is specified, all pages will be deleted.\n- Optional parameter: pageRange (default empty). The value should be a comma-seperated string which contains non-overlapping single values, or page ranges. Ex: \"1,2,3\", \"1-3,5\", \"2-7,10-12.\"", "operationId": "DeletePages", "parameters": [ @@ -3185,7 +3265,7 @@ "tags": [ "Entries" ], - "summary": "Returns an entry's edoc resource in a stream format while including an audit reason. Provide an entry ID and audit reason/comment in the request body, and get the edoc resource as part of the response content. Optional header: Range. Use the Range header (single range with byte unit) to retrieve partial content of the edoc, rather than the entire edoc. This route is identical to the GET edoc route, but allows clients to include an audit reason when downloading the edoc.", + "summary": "Returns an entry's edoc resource in a stream format, including an audit reason.", "description": "- Returns an entry's edoc resource in a stream format while including an audit reason.\n- Provide an entry ID and audit reason/comment in the request body, and get the edoc resource as part of the response content.\n- Optional header: Range. Use the Range header (single range with byte unit) to retrieve partial content of the edoc, rather than the entire edoc. This route is identical to the GET edoc route, but allows clients to include an audit reason when downloading the edoc.", "operationId": "ExportDocumentWithAuditReason", "parameters": [ @@ -3296,6 +3376,16 @@ } } }, + "413": { + "description": "Request is too large.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, "423": { "description": "Entry is locked.", "content": { @@ -3324,7 +3414,7 @@ "tags": [ "Entries" ], - "summary": "Returns dynamic field logic values with the current values of the fields in the template. Provide an entry ID and field values in the JSON body to get dynamic field logic values. Independent and non-dynamic fields in the request body will be ignored, and only related dynamic field logic values for the assigned template will be returned.", + "summary": "Returns the dynamic field logic values assigned to an entry.", "description": "- Returns dynamic field logic values with the current values of the fields in the template.\n- Provide an entry ID and field values in the JSON body to get dynamic field logic values.\n Independent and non-dynamic fields in the request body will be ignored, and only related dynamic field logic values for the assigned template will be returned.", "operationId": "GetDynamicFieldValues", "parameters": [ @@ -3418,6 +3508,16 @@ } } }, + "413": { + "description": "Request is too large.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, "429": { "description": "Rate limit is reached.", "content": { @@ -3436,7 +3536,7 @@ "tags": [ "Entries" ], - "summary": "Remove the currently assigned template from the specified entry. Provide an entry ID to clear template value on. If the entry does not have a template assigned, no change will be made.", + "summary": "Removes the currently assigned template from an entry.", "description": "- Remove the currently assigned template from the specified entry.\n- Provide an entry ID to clear template value on.\n- If the entry does not have a template assigned, no change will be made.", "operationId": "DeleteAssignedTemplate", "parameters": [ @@ -3539,7 +3639,7 @@ "tags": [ "Entries" ], - "summary": "Assign a template to an entry. Provide an entry ID, template name, and a list of template fields to assign to that entry. Only template values will be modified. Any existing independent fields on the entry will not be modified, nor will they be added if included in the request. The only modification to fields will only occur on templated fields. If the previously assigned template includes common template fields as the newly assigned template, the common field values will not be modified.", + "summary": "Assigns a template to an entry.", "description": "- Assign a template to an entry.\n- Provide an entry ID, template name, and a list of template fields to assign to that entry.\n- Only template values will be modified. Any existing independent fields on the entry will not be modified, nor will they be added if included in the request. The only modification to fields will only occur on templated fields. If the previously assigned template includes common template fields as the newly assigned template, the common field values will not be modified.", "operationId": "WriteTemplateValueToEntry", "parameters": [ @@ -3681,6 +3781,16 @@ } } }, + "413": { + "description": "Request is too large.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, "423": { "description": "Entry is locked.", "content": { @@ -3709,7 +3819,7 @@ "tags": [ "Repositories" ], - "summary": "Returns the repository resource list that current user has access to.", + "summary": "Returns the list of repositories accessible to the user.", "description": "- Returns the repository resource list that current user has access to.", "operationId": "GetRepositoryList", "responses": { @@ -3774,7 +3884,7 @@ "tags": [ "AuditReasons" ], - "summary": "Returns the audit reasons associated with the authenticated user. Inherited audit reasons are included. Only includes audit reasons associated with available API functionalities, like delete entry and export document. If the authenticated user does not have the appropriate Laserfiche feature right, the audit reasons associated with that feature right will not be included.", + "summary": "Returns the audit reasons associated with the authenticated user.", "description": "- Returns the audit reasons associated with the authenticated user. Inherited audit reasons are included.\n- Only includes audit reasons associated with available API functionalities, like delete entry and export document.\n- If the authenticated user does not have the appropriate Laserfiche feature right, the audit reasons associated with that feature right will not be included.", "operationId": "GetAuditReasons", "parameters": [ @@ -3858,7 +3968,7 @@ "tags": [ "Searches" ], - "summary": "Runs a search operation on the repository. Optional body parameters: FuzzyType: (default none), which can be used to determine what is considered a match by number of letters or percentage. FuzzyFactor: integer value that determines the degree to which a search will be considered a match (integer value for NumberOfLetters, or int value representing a percentage). The status for search operations must be checked via the Search specific status checking route. ", + "summary": "Runs a search in the specified repository.", "description": "- Runs a search operation on the repository.\n- Optional body parameters: FuzzyType: (default none), which can be used to determine what is considered a match by number of letters or percentage. FuzzyFactor: integer value that determines the degree to which a search will be considered a match (integer value for NumberOfLetters, or int value representing a percentage). The status for search operations must be checked via the Search specific status checking route. ", "operationId": "CreateSearchOperation", "parameters": [ @@ -3956,6 +4066,16 @@ } } }, + "413": { + "description": "Request is too large.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, "429": { "description": "Operation limit or request limit reached.", "content": { @@ -3974,7 +4094,7 @@ "tags": [ "Searches" ], - "summary": "Returns search status. Provide a token (returned in the create search asynchronous route), and get the search status, progress, and any errors that may have occurred. When the search is completed, the Location header can be inspected as a link to the search results. OperationStatus can be one of the following : NotStarted, InProgress, Completed, Failed, or Canceled.", + "summary": "Returns the status of a search operation.", "description": "- Returns search status.\n- Provide a token (returned in the create search asynchronous route), and get the search status, progress, and any errors that may have occurred. When the search is completed, the Location header can be inspected as a link to the search results.\n- OperationStatus can be one of the following : NotStarted, InProgress, Completed, Failed, or Canceled.", "operationId": "GetSearchStatus", "parameters": [ @@ -4086,7 +4206,7 @@ "tags": [ "Searches" ], - "summary": "Cancels a currently running search. Closes a completed search.", + "summary": "Cancels or closes a search operation.", "description": "- Cancels a currently running search.\n- Closes a completed search.", "operationId": "CancelOrCloseSearch", "parameters": [ @@ -4180,7 +4300,7 @@ "tags": [ "Searches" ], - "summary": "Returns a search result listing if the search is completed. Optional query parameter: groupByOrderType (default false). This query parameter decides whether or not results are returned in groups based on their entry type. Optional query parameter: refresh (default false). If the search listing should be refreshed to show updated values. Default page size: 150. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. OData $OrderBy syntax should follow: \"PropertyName direction,PropertyName2 direction\". sort order can be either \"asc\" or \"desc\". Search results expire after 5 minutes, but can be refreshed by retrieving the results again. Optionally returns field values for the entries in the search result listing. Each field name needs to be specified in the request. Maximum limit of 10 field names. If field values are requested, only the first value is returned if it is a multi value field. Null or Empty field values should not be used to determine if a field is assigned to the entry.", + "summary": "Returns the results listing associated with a search operation.", "description": "- Returns a search result listing if the search is completed.\n- Optional query parameter: groupByOrderType (default false). This query parameter decides whether or not results are returned in groups based on their entry type.\n- Optional query parameter: refresh (default false). If the search listing should be refreshed to show updated values.\n- Default page size: 150. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. OData $OrderBy syntax should follow: \"PropertyName direction,PropertyName2 direction\". sort order can be either \"asc\" or \"desc\". Search results expire after 5 minutes, but can be refreshed by retrieving the results again.\n- Optionally returns field values for the entries in the search result listing. Each field name needs to be specified in the request. Maximum limit of 10 field names.\n- If field values are requested, only the first value is returned if it is a multi value field.\n- Null or Empty field values should not be used to determine if a field is assigned to the entry.", "operationId": "GetSearchResults", "parameters": [ @@ -4387,7 +4507,7 @@ "tags": [ "Searches" ], - "summary": "Returns the context hits associated with a search result entry. Given a searchToken, and rowNumber associated with a search entry in the listing, return the context hits for that entry. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.", + "summary": "Returns the context hits associated with a search result entry.", "description": "- Returns the context hits associated with a search result entry.\n- Given a searchToken, and rowNumber associated with a search entry in the listing, return the context hits for that entry.\n- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.", "operationId": "GetSearchContextHits", "parameters": [ @@ -4552,7 +4672,7 @@ "tags": [ "SimpleSearches" ], - "summary": "Runs a \"simple\" search operation on the repository. Returns a truncated search result listing. Search result listing may be truncated, depending on number of results. Additionally, searches may time out if they take too long. Use the other search route to run full searches. Optionally returns field values for the entries in the search result listing. Each field name needs to be specified in the request. Maximum limit of 10 field names. If field values are requested, only the first value is returned if it is a multi value field. Null or Empty field values should not be used to determine if a field is assigned to the entry.", + "summary": "Runs a \"simple\" search operation.", "description": "- Runs a \"simple\" search operation on the repository.\n- Returns a truncated search result listing.\n- Search result listing may be truncated, depending on number of results. Additionally, searches may time out if they take too long. Use the other search route to run full searches.\n- Optionally returns field values for the entries in the search result listing. Each field name needs to be specified in the request. Maximum limit of 10 field names.\n- If field values are requested, only the first value is returned if it is a multi value field.\n- Null or Empty field values should not be used to determine if a field is assigned to the entry.", "operationId": "CreateSimpleSearchOperation", "parameters": [ @@ -4711,6 +4831,16 @@ } } }, + "413": { + "description": "Request is too large.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, "429": { "description": "Operation limit or request limit reached.", "content": { @@ -4729,7 +4859,7 @@ "tags": [ "TagDefinitions" ], - "summary": "Returns all tag definitions in the repository. Provide a repository ID and get a paged listing of tag definitions available in the repository. Useful when trying to display all tag definitions available, not only tags assigned to a specific entry. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.", + "summary": "Returns the tag definitions associated with a repository.", "description": "- Returns all tag definitions in the repository.\n- Provide a repository ID and get a paged listing of tag definitions available in the repository. Useful when trying to display all tag definitions available, not only tags assigned to a specific entry.\n- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.", "operationId": "GetTagDefinitions", "parameters": [ @@ -4884,7 +5014,7 @@ "tags": [ "TagDefinitions" ], - "summary": "Returns a single tag definition. Provide a tag definition ID, and get the single tag definition associated with that ID. Useful when another route provides a minimal amount of details, and more information about the specific tag is needed. Allowed OData query options: Select", + "summary": "Returns a single tag definition object.", "description": "- Returns a single tag definition.\n- Provide a tag definition ID, and get the single tag definition associated with that ID. Useful when another route provides a minimal amount of details, and more information about the specific tag is needed.\n- Allowed OData query options: Select", "operationId": "GetTagDefinitionById", "parameters": [ @@ -5000,7 +5130,7 @@ "tags": [ "Tasks" ], - "summary": "Returns the status of an operation. Provide an operationToken (returned in other asynchronous routes) to get the operation status, progress, and any errors that may have occurred. When the operation is completed, the Location header can be inspected as a link to the modified resources (if relevant). OperationStatus can be one of the following values: NotStarted, InProgress, Completed, or Failed.", + "summary": "Returns the status of an operation.", "description": "- Returns the status of an operation.\n- Provide an operationToken (returned in other asynchronous routes) to get the operation status, progress, and any errors that may have occurred. When the operation is completed, the Location header can be inspected as a link to the modified resources (if relevant).\n- OperationStatus can be one of the following values: NotStarted, InProgress, Completed, or Failed.", "operationId": "GetOperationStatusAndProgress", "parameters": [ @@ -5112,7 +5242,7 @@ "tags": [ "Tasks" ], - "summary": "Cancels an operation. Provide an operationToken to cancel the operation, if possible. Should be used if an operation was created in error, or is no longer necessary. Rollbacks must be done manually. For example, if a copy operation is started and is halfway complete when canceled, the client application is responsible for cleaning up the files that were successfully copied before the operation was canceled.", + "summary": "Cancels an operation.", "description": "- Cancels an operation.\n- Provide an operationToken to cancel the operation, if possible. Should be used if an operation was created in error, or is no longer necessary.\n- Rollbacks must be done manually. For example, if a copy operation is started and is halfway complete when canceled, the client application is responsible for cleaning up the files that were successfully copied before the operation was canceled.", "operationId": "CancelOperation", "parameters": [ @@ -5199,7 +5329,7 @@ "tags": [ "TemplateDefinitions" ], - "summary": "Returns all template definitions (including field definitions) in the repository. If a template name query parameter is given, then a single template definition is returned. Provide a repository ID, and get a paged listing of template definitions available in the repository. Useful when trying to find a list of all template definitions available, rather than a specific one. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.", + "summary": "Returns the template definitions associated with a repository.", "description": "- Returns all template definitions (including field definitions) in the repository. If a template name query parameter is given, then a single template definition is returned.\n- Provide a repository ID, and get a paged listing of template definitions available in the repository. Useful when trying to find a list of all template definitions available, rather than a specific one.\n- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.", "operationId": "GetTemplateDefinitions", "parameters": [ @@ -5364,7 +5494,7 @@ "tags": [ "TemplateDefinitions" ], - "summary": "Returns a single template definition (including field definitions, if relevant). Provide a template definition ID, and get the single template definition associated with that ID. Useful when a route provides a minimal amount of details, and more information about the specific template is needed. Allowed OData query options: Select", + "summary": "Returns a single template definition object.", "description": "- Returns a single template definition (including field definitions, if relevant).\n- Provide a template definition ID, and get the single template definition associated with that ID. Useful when a route provides a minimal amount of details, and more information about the specific template is needed.\n- Allowed OData query options: Select", "operationId": "GetTemplateDefinitionById", "parameters": [ @@ -5480,7 +5610,7 @@ "tags": [ "TemplateDefinitions" ], - "summary": "Returns the field definitions assigned to a template definition. Provide a template definition ID, and get a paged listing of the field definitions assigned to that template. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.", + "summary": "Returns the field definitions assigned to a template definition (by template definition ID).", "description": "- Returns the field definitions assigned to a template definition.\n- Provide a template definition ID, and get a paged listing of the field definitions assigned to that template. \n- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.", "operationId": "GetTemplateFieldDefinitions", "parameters": [ @@ -5646,7 +5776,7 @@ "tags": [ "TemplateDefinitions" ], - "summary": "Returns the field definitions assigned to a template definition. Provide a template definition name, and get a paged listing of the field definitions assigned to that template. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.", + "summary": "Returns the field definitions assigned to a template definition (by template definition name).", "description": "- Returns the field definitions assigned to a template definition.\n- Provide a template definition name, and get a paged listing of the field definitions assigned to that template. \n- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.", "operationId": "GetTemplateFieldDefinitionsByTemplateName", "parameters": [ @@ -5812,7 +5942,7 @@ "tags": [ "ServerSession" ], - "summary": "Deprecated. Invalidates the server session. Acts as a \"logout\" operation, and invalidates the session associated with the provided access token. This method should be used when the client wants to clean up the current session. Only available in Laserfiche Cloud.", + "summary": "Deprecated. Do not call this api.", "description": "- Deprecated.\n- Invalidates the server session.\n- Acts as a \"logout\" operation, and invalidates the session associated with the provided access token. This method should be used when the client wants to clean up the current session.\n- Only available in Laserfiche Cloud.", "operationId": "InvalidateServerSession", "parameters": [ @@ -5897,7 +6027,7 @@ "tags": [ "ServerSession" ], - "summary": "Deprecated. Refreshes the session associated with the access token. This is only necessary if you want to keep the same session alive, otherwise a new session will be automatically created when the session expires. When a client application wants to keep a session alive that has been idle for an hour, this route can be used to refresh the expiration timer associated with the access token. Only available in Laserfiche Cloud.", + "summary": "Deprecated. Do not call this api.", "description": "- Deprecated.\n- Refreshes the session associated with the access token. This is only necessary if you want to keep the same session alive, otherwise a new session will be automatically created when the session expires.\n- When a client application wants to keep a session alive that has been idle for an hour, this route can be used to refresh the expiration timer associated with the access token.\n- Only available in Laserfiche Cloud.", "operationId": "RefreshServerSession", "parameters": [ @@ -5982,7 +6112,7 @@ "tags": [ "ServerSession" ], - "summary": "Deprecated. This function is a no-op, always returns 200. Only available in Laserfiche Cloud.", + "summary": "Deprecated. Do not call this api.", "description": "- Deprecated. This function is a no-op, always returns 200.\n- Only available in Laserfiche Cloud.", "operationId": "CreateServerSession", "parameters": [ @@ -6754,28 +6884,6 @@ } ] }, - "SimpleImportMetadata": { - "type": "object", - "additionalProperties": false, - "properties": { - "fields": { - "type": "object", - "description": "The fields that will be assigned to the entry.", - "nullable": true, - "additionalProperties": { - "$ref": "#/components/schemas/FieldToUpdate" - } - }, - "tags": { - "type": "array", - "description": "The tags that will be assigned to the entry.", - "nullable": true, - "items": { - "type": "string" - } - } - } - }, "ODataValueContextOfListOfAttribute": { "allOf": [ { @@ -8485,6 +8593,28 @@ "format": "date-time" } } + }, + "SimpleImportMetadata": { + "type": "object", + "additionalProperties": false, + "properties": { + "fields": { + "type": "object", + "description": "The fields that will be assigned to the entry.", + "nullable": true, + "additionalProperties": { + "$ref": "#/components/schemas/FieldToUpdate" + } + }, + "tags": { + "type": "array", + "description": "The tags that will be assigned to the entry.", + "nullable": true, + "items": { + "type": "string" + } + } + } } }, "securitySchemes": { @@ -8495,24 +8625,15 @@ }, "OAuth2 Authorization Code Flow": { "type": "oauth2", - "description": "

Note: Please enter below the clientId/clientSecret of a registered web application, or the clientId of a SPA. For SPA, the clientSecret field must be left empty. The app, either a web application or SPA, must have the following uri defined as its redirect uri.

https://api.laserfiche.com/repository/swagger/oauth2-redirect.html

", + "description": "

Note: Please enter below the clientId/clientSecret of a registered web application, or the clientId of a SPA. For SPA, the clientSecret field must be left empty. The app, either a web application or SPA, must have the following uri defined as its redirect uri.

https://api.laserfiche.com/repository/swagger/oauth2-redirect.html

For more information, see this page

", "flows": { "authorizationCode": { "authorizationUrl": "https://signin.laserfiche.com/oauth/Authorize", "tokenUrl": "https://signin.laserfiche.com/oauth/Token", - "scopes": {} - } - } - }, - "OAuth2 Client Credentials Flow": { - "type": "http", - "description": "", - "scheme": "Bearer", - "bearerFormat": "JWT", - "flows": { - "clientCredentials": { - "tokenUrl": "https://signin.laserfiche.com/oauth/Token", - "scopes": {} + "scopes": { + "repository.Read": "Allows the app to read the content of Laserfiche repositories on behalf of the signed-in user.", + "repository.Write": "Allows the app to modify the content of Laserfiche repositories on behalf of the signed-in user." + } } } } @@ -8524,9 +8645,6 @@ }, { "OAuth2 Authorization Code Flow": [] - }, - { - "OAuth2 Client Credentials Flow": [] } ] } \ No newline at end of file diff --git a/src/Clients/RepositoryClients.cs b/src/Clients/RepositoryClients.cs index 553fd628..cf6efeea 100644 --- a/src/Clients/RepositoryClients.cs +++ b/src/Clients/RepositoryClients.cs @@ -1,6 +1,6 @@ //---------------------- // -// Generated using the NSwag toolchain v13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0)) (http://NSwag.org) +// Generated using the NSwag toolchain v13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0)) (http://NSwag.org) // //---------------------- @@ -22,6 +22,7 @@ #pragma warning disable 108 // Disable "CS0108 '{derivedDto}.ToJson()' hides inherited member '{dtoBase}.ToJson()'. Use the new keyword if hiding was intended." #pragma warning disable 114 // Disable "CS0114 '{derivedDto}.RaisePropertyChanged(String)' hides inherited member 'dtoBase.RaisePropertyChanged(String)'. To make the current member override that implementation, add the override keyword. Otherwise add the new keyword." #pragma warning disable 472 // Disable "CS0472 The result of the expression is always 'false' since a value of type 'Int32' is never equal to 'null' of type 'Int32?' +#pragma warning disable 612 // Disable "CS0612 '...' is obsolete" #pragma warning disable 1573 // Disable "CS1573 Parameter '...' has no matching param tag in the XML comment for ... #pragma warning disable 1591 // Disable "CS1591 Missing XML comment for publicly visible type or member ..." #pragma warning disable 8073 // Disable "CS8073 The result of the expression is always 'false' since a value of type 'T' is never equal to 'null' of type 'T?'" @@ -32,148 +33,199 @@ namespace Laserfiche.Repository.Api.Client { using System = global::System; - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial interface IEntriesClient { - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Creates a new document in the specified folder with file (no more than 100 MB). Optionally sets metadata and electronic document component. Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. With this route, partial success is possible. The response returns multiple operation (entryCreate operation, setEdoc operation, setLinks operation, etc..) objects, which contain information about any errors that may have occurred during the creation. As long as the entryCreate operation succeeds, the entry will be created, even if all other operations fail. + /// Creates a new document in a folder. /// + /// + /// - Creates a new document in the specified folder with file (no more than 100 MB).
+ /// - Optionally sets metadata and electronic document component.
+ /// - Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. With this route, partial success is possible. The response returns multiple operation (entryCreate operation, setEdoc operation, setLinks operation, etc..) objects, which contain information about any errors that may have occurred during the creation. As long as the entryCreate operation succeeds, the entry will be created, even if all other operations fail. + ///
/// The requested repository ID. /// The entry ID of the folder that the document will be created in. /// The created document's file name. - /// An optional query parameter used to indicate if the new document should be automatically - ///
renamed if an entry already exists with the given name in the folder. The default value is false. - /// An optional query parameter used to indicate the locale that should be used. - ///
The value should be a standard language tag. This may be used when setting field values with tokens. + /// An optional query parameter used to indicate if the new document should be automatically
+ /// renamed if an entry already exists with the given name in the folder. The default value is false. + /// An optional query parameter used to indicate the locale that should be used.
+ /// The value should be a standard language tag. This may be used when setting field values with tokens. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Document creation is success. /// A server side error occurred. Task ImportDocumentAsync(string repoId, int parentEntryId, string fileName, bool? autoRename = null, string culture = null, FileParameter electronicDocument = null, PostEntryWithEdocMetadataRequest request = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns a single entry object. Provide an entry ID, and get the entry associated with that ID. Useful when detailed information about the entry is required, such as metadata, path information, etc. Allowed OData query options: Select. If the entry is a subtype (Folder, Document, or Shortcut), the entry will automatically be converted to include those model-specific properties. + /// Returns a single entry object. /// + /// + /// - Returns a single entry object.
+ /// - Provide an entry ID, and get the entry associated with that ID. Useful when detailed information about the entry is required, such as metadata, path information, etc.
+ /// - Allowed OData query options: Select. If the entry is a subtype (Folder, Document, or Shortcut), the entry will automatically be converted to include those model-specific properties. + ///
/// The requested repository ID. /// The requested entry ID. /// Limits the properties returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get entry successfully. /// A server side error occurred. Task GetEntryAsync(string repoId, int entryId, string select = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Begins a task to delete an entry, and returns an operationToken. Provide an entry ID, and queue a delete task to remove it from the repository (includes nested objects if the entry is a Folder type). The entry will not be deleted immediately. Optionally include an audit reason ID and comment in the JSON body. This route returns an operationToken, and will run as an asynchronous operation. Check the progress via the Tasks/{operationToken} route. + /// Deletes an entry asynchronously. /// + /// + /// - Begins a task to delete an entry, and returns an operationToken.
+ /// - Provide an entry ID, and queue a delete task to remove it from the repository (includes nested objects if the entry is a Folder type). The entry will not be deleted immediately.
+ /// - Optionally include an audit reason ID and comment in the JSON body. This route returns an operationToken, and will run as an asynchronous operation. Check the progress via the Tasks/{operationToken} route. + ///
/// The requested repository ID. /// The requested entry ID. /// The submitted audit reason. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Delete entry operation start successfully. /// A server side error occurred. Task DeleteEntryInfoAsync(string repoId, int entryId, DeleteEntryWithAuditReason request = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Moves and/or renames an entry. Move and/or rename an entry by passing in the new parent folder ID or name in the JSON body. Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. + /// Moves and/or renames an entry. /// + /// + /// - Moves and/or renames an entry.
+ /// - Move and/or rename an entry by passing in the new parent folder ID or name in the JSON body.
+ /// - Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. + ///
/// The requested repository ID. /// The requested entry ID. - /// The request containing the folder ID that the entry will be moved to and the new name - ///
the entry will be renamed to. - /// An optional query parameter used to indicate if the entry should be automatically - ///
renamed if another entry already exists with the same name in the folder. The default value is false. - /// An optional query parameter used to indicate the locale that should be used. - ///
The value should be a standard language tag. + /// The request containing the folder ID that the entry will be moved to and the new name
+ /// the entry will be renamed to. + /// An optional query parameter used to indicate if the entry should be automatically
+ /// renamed if another entry already exists with the same name in the folder. The default value is false. + /// An optional query parameter used to indicate the locale that should be used.
+ /// The value should be a standard language tag. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Moves and/or renames an entry successfully. /// A server side error occurred. Task MoveOrRenameEntryAsync(string repoId, int entryId, PatchEntryRequest request = null, bool? autoRename = null, string culture = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns a single entry object using the entry path. Optional query parameter: fallbackToClosestAncestor. Use the fallbackToClosestAncestor query parameter to return the closest existing ancestor if the initial entry path is not found. + /// Returns a single entry object using the entry path. /// + /// + /// - Returns a single entry object using the entry path.
+ /// - Optional query parameter: fallbackToClosestAncestor. Use the fallbackToClosestAncestor query parameter to return the closest existing ancestor if the initial entry path is not found. + ///
/// The requested repository ID. /// The requested entry path. /// An optional query parameter used to indicate whether or not the closest ancestor in the path should be returned if the initial entry path is not found. The default value is false. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get entry successfully. /// A server side error occurred. Task GetEntryByPathAsync(string repoId, string fullPath, bool? fallbackToClosestAncestor = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the children entries of a folder in the repository. Provide an entry ID (must be a folder), and get a paged listing of entries in that folder. Used as a way of navigating through the repository. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. OData $OrderBy syntax should follow: "PropertyName direction,PropertyName2 direction". Sort order can be either value "asc" or "desc". Optional query parameters: groupByOrderType (bool). This query parameter decides if results are returned in groups based on their entry type. Entries returned in the listing are not automatically converted to their subtype (Folder, Shortcut, Document), so clients who want model-specific information should request it via the GET entry by ID route. Optionally returns field values for the entries in the folder. Each field name needs to be specified in the request. Maximum limit of 10 field names. If field values are requested, only the first value is returned if it is a multi value field. Null or Empty field values should not be used to determine if a field is assigned to the entry. + /// Returns the children entries of a folder. /// + /// + /// - Returns the children entries of a folder in the repository.
+ /// - Provide an entry ID (must be a folder), and get a paged listing of entries in that folder. Used as a way of navigating through the repository.
+ /// - Default page size: 150. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. OData $OrderBy syntax should follow: "PropertyName direction,PropertyName2 direction". Sort order can be either value "asc" or "desc". Optional query parameters: groupByOrderType (bool). This query parameter decides if results are returned in groups based on their entry type. Entries returned in the listing are not automatically converted to their subtype (Folder, Shortcut, Document), so clients who want model-specific information should request it via the GET entry by ID route.
+ /// - Optionally returns field values for the entries in the folder. Each field name needs to be specified in the request. Maximum limit of 10 field names.
+ /// - If field values are requested, only the first value is returned if it is a multi value field.
+ /// - Null or Empty field values should not be used to determine if a field is assigned to the entry. + ///
/// The requested repository ID. /// The folder ID. /// An optional query parameter used to indicate if the result should be grouped by entry type or not. /// Optional array of field names. Field values corresponding to the given field names will be returned for each entry. /// Boolean for if field values should be formatted. Only applicable if Fields are specified. /// An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise - ///
culture will not be used for formatting. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise
+ /// culture will not be used for formatting. /// Limits the properties returned in the result. /// Specifies the order in which items are returned. The maximum number of expressions is 5. /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get the children entries of a Folder successfully. /// A server side error occurred. Task GetEntryListingAsync(string repoId, int entryId, bool? groupByEntryType = null, IEnumerable fields = null, bool? formatFields = null, string prefer = null, string culture = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Create/copy a new child entry in the designated folder. Provide the parent folder ID, and based on the request body, copy or create a folder/shortcut as a child entry of the designated folder. Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. + /// Creates/copies a new child entry in a folder. /// + /// + /// - Create/copy a new child entry in the designated folder.
+ /// - Provide the parent folder ID, and based on the request body, copy or create a folder/shortcut as a child entry of the designated folder.
+ /// - Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. + ///
/// The requested repository ID. /// The folder ID that the entry will be created in. /// The entry to create. - /// An optional query parameter used to indicate if the new entry should be automatically - ///
renamed if an entry already exists with the given name in the folder. The default value is false. - /// An optional query parameter used to indicate the locale that should be used. - ///
The value should be a standard language tag. + /// An optional query parameter used to indicate if the new entry should be automatically
+ /// renamed if an entry already exists with the given name in the folder. The default value is false. + /// An optional query parameter used to indicate the locale that should be used.
+ /// The value should be a standard language tag. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Created a new child entry successfully. /// A server side error occurred. Task CreateOrCopyEntryAsync(string repoId, int entryId, PostEntryChildrenRequest request = null, bool? autoRename = null, string culture = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the fields assigned to an entry. Provide an entry ID, and get a paged listing of all fields assigned to that entry. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + /// Returns the fields assigned to an entry. /// + /// + /// - Returns the fields assigned to an entry.
+ /// - Provide an entry ID, and get a paged listing of all fields assigned to that entry.
+ /// - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + ///
/// The requested repository ID. /// The requested entry ID. /// An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. - /// An optional query parameter used to indicate if the field values should be formatted. - ///
The default value is false. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise - ///
culture will not be used for formatting. + /// An optional query parameter used to indicate if the field values should be formatted.
+ /// The default value is false. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise
+ /// culture will not be used for formatting. /// Limits the properties returned in the result. /// Specifies the order in which items are returned. The maximum number of expressions is 5. /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get field values successfully. /// A server side error occurred. Task GetFieldValuesAsync(string repoId, int entryId, string prefer = null, bool? formatValue = null, string culture = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Update the field values assigned to an entry. Provide the new field values to assign to the entry, and remove/reset all previously assigned field values. This is an overwrite action. The request body must include all desired field values, including any existing field values that should remain assigned to the entry. Field values that are not included in the request will be deleted from the entry. If the field value that is not included is part of a template, it will still be assigned (as required by the template), but its value will be reset. + /// Updates the field values assigned to an entry. /// + /// + /// - Update the field values assigned to an entry.
+ /// - Provide the new field values to assign to the entry, and remove/reset all previously assigned field values.
+ /// - This is an overwrite action. The request body must include all desired field values, including any existing field values that should remain assigned to the entry. Field values that are not included in the request will be deleted from the entry. If the field value that is not included is part of a template, it will still be assigned (as required by the template), but its value will be reset. + ///
/// The requested repository ID. /// The entry ID of the entry that will have its fields updated. - /// An optional query parameter used to indicate the locale that should be used. - ///
The value should be a standard language tag. This may be used when setting field values with tokens. + /// An optional query parameter used to indicate the locale that should be used.
+ /// The value should be a standard language tag. This may be used when setting field values with tokens. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Update field values successfully. /// A server side error occurred. Task AssignFieldValuesAsync(string repoId, int entryId, IDictionary fieldsToUpdate = null, string culture = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the tags assigned to an entry. Provide an entry ID, and get a paged listing of tags assigned to that entry. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + /// Returns the tags assigned to an entry. /// + /// + /// - Returns the tags assigned to an entry.
+ /// - Provide an entry ID, and get a paged listing of tags assigned to that entry.
+ /// - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + ///
/// The requested repository ID. /// The requested entry ID. /// An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. @@ -182,35 +234,50 @@ public partial interface IEntriesClient /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get entry tags successfully. /// A server side error occurred. Task GetTagsAssignedToEntryAsync(string repoId, int entryId, string prefer = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Assign tags to an entry. Provide an entry ID and a list of tags to assign to that entry. This is an overwrite action. The request must include all tags to assign to the entry, including existing tags that should remain assigned to the entry. + /// Assigns tags to an entry. /// + /// + /// - Assign tags to an entry.
+ /// - Provide an entry ID and a list of tags to assign to that entry.
+ /// - This is an overwrite action. The request must include all tags to assign to the entry, including existing tags that should remain assigned to the entry. + ///
/// The requested repository ID. /// The requested entry ID. /// The tags to add. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Assign tags to an entry successfully. /// A server side error occurred. Task AssignTagsAsync(string repoId, int entryId, PutTagRequest tagsToAdd = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Assign links to an entry. Provide an entry ID and a list of links to assign to that entry. This is an overwrite action. The request must include all links to assign to the entry, including existing links that should remain assigned to the entry. + /// Assigns links to an entry. /// + /// + /// - Assign links to an entry.
+ /// - Provide an entry ID and a list of links to assign to that entry.
+ /// - This is an overwrite action. The request must include all links to assign to the entry, including existing links that should remain assigned to the entry. + ///
/// The request repository ID. /// The requested entry ID. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Assign links to an entry successfully. /// A server side error occurred. Task AssignEntryLinksAsync(string repoId, int entryId, IEnumerable linksToAdd = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the links assigned to an entry. Provide an entry ID, and get a paged listing of links assigned to that entry. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + /// Returns the links assigned to an entry. /// + /// + /// - Returns the links assigned to an entry.
+ /// - Provide an entry ID, and get a paged listing of links assigned to that entry.
+ /// - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + ///
/// The requested repository ID. /// The requested entry ID. /// An optional odata header. Can be used to set the maximum page size using odata.maxpagesize. @@ -219,116 +286,162 @@ public partial interface IEntriesClient /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get links successfully. /// A server side error occurred. Task GetLinkValuesFromEntryAsync(string repoId, int entryId, string prefer = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Copy a new child entry in the designated folder async, and potentially return an operationToken. Provide the parent folder ID, and copy an entry as a child of the designated folder. Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. The status of the operation can be checked via the Tasks/{operationToken} route. + /// Copies an entry into a folder asynchronously. /// + /// + /// - Copy a new child entry in the designated folder async, and potentially return an operationToken.
+ /// - Provide the parent folder ID, and copy an entry as a child of the designated folder.
+ /// - Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed.
+ /// - The status of the operation can be checked via the Tasks/{operationToken} route.
+ /// - Token substitution in the name of the copied entry is not supported. + ///
/// The requested repository ID. /// The folder ID that the entry will be created in. /// Copy entry request. - /// An optional query parameter used to indicate if the new entry should be automatically - ///
renamed if an entry already exists with the given name in the folder. The default value is false. - /// An optional query parameter used to indicate the locale that should be used. - ///
The value should be a standard language tag. + /// An optional query parameter used to indicate if the new entry should be automatically
+ /// renamed if an entry already exists with the given name in the folder. The default value is false. + /// An optional query parameter used to indicate the locale that should be used.
+ /// The value should be a standard language tag. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Copy entry operation is started successfully. /// A server side error occurred. Task CopyEntryAsync(string repoId, int entryId, CopyAsyncRequest request = null, bool? autoRename = null, string culture = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Delete the edoc associated with the provided entry ID. + /// Deletes the edoc associated with an entry. /// + /// + /// - Delete the edoc associated with the provided entry ID. + /// /// The requested repository ID. /// The requested document ID. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Deleted edoc successfully. /// A server side error occurred. Task DeleteDocumentAsync(string repoId, int entryId, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns information about the edoc content of an entry, without downloading the edoc in its entirety. Provide an entry ID, and get back the Content-Type and Content-Length in the response headers. This route does not provide a way to download the actual edoc. Instead, it just gives metadata information about the edoc associated with the entry. + /// Returns information about the edoc content of an entry. /// + /// + /// - Returns information about the edoc content of an entry, without downloading the edoc in its entirety.
+ /// - Provide an entry ID, and get back the Content-Type and Content-Length in the response headers.
+ /// - This route does not provide a way to download the actual edoc. Instead, it just gives metadata information about the edoc associated with the entry.
+ /// - If an error occurs, the error message can be found in the X-APIServer-Error HTTP response header. + ///
/// The requested repository ID. /// The requested document ID. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get edoc info successfully. /// A server side error occurred. Task GetDocumentContentTypeAsync(string repoId, int entryId, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns an entry's edoc resource in a stream format. Provide an entry ID, and get the edoc resource as part of the response content. Optional header: Range. Use the Range header (single range with byte unit) to retrieve partial content of the edoc, rather than the entire edoc. + /// Returns an entry's edoc resource in a stream format. /// + /// + /// - Returns an entry's edoc resource in a stream format.
+ /// - Provide an entry ID, and get the edoc resource as part of the response content.
+ /// - Optional header: Range. Use the Range header (single range with byte unit) to retrieve partial content of the edoc, rather than the entire edoc. + ///
/// The requested repository ID. /// The requested document ID. - /// An optional header used to retrieve partial content of the edoc. Only supports single - ///
range with byte unit. + /// An optional header used to retrieve partial content of the edoc. Only supports single
+ /// range with byte unit. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get edoc successfully. /// A server side error occurred. Task ExportDocumentAsync(string repoId, int entryId, string range = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Delete the pages associated with the provided entry ID. If no pageRange is specified, all pages will be deleted. Optional parameter: pageRange (default empty). The value should be a comma-seperated string which contains non-overlapping single values, or page ranges. Ex: "1,2,3", "1-3,5", "2-7,10-12." + /// Deletes the pages associated with an entry. /// + /// + /// - Delete the pages associated with the provided entry ID. If no pageRange is specified, all pages will be deleted.
+ /// - Optional parameter: pageRange (default empty). The value should be a comma-seperated string which contains non-overlapping single values, or page ranges. Ex: "1,2,3", "1-3,5", "2-7,10-12." + ///
/// The requested repository ID. /// The requested document ID. /// The pages to be deleted. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Deleted pages successfully. /// A server side error occurred. Task DeletePagesAsync(string repoId, int entryId, string pageRange = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns an entry's edoc resource in a stream format while including an audit reason. Provide an entry ID and audit reason/comment in the request body, and get the edoc resource as part of the response content. Optional header: Range. Use the Range header (single range with byte unit) to retrieve partial content of the edoc, rather than the entire edoc. This route is identical to the GET edoc route, but allows clients to include an audit reason when downloading the edoc. + /// Returns an entry's edoc resource in a stream format, including an audit reason. /// + /// + /// - Returns an entry's edoc resource in a stream format while including an audit reason.
+ /// - Provide an entry ID and audit reason/comment in the request body, and get the edoc resource as part of the response content.
+ /// - Optional header: Range. Use the Range header (single range with byte unit) to retrieve partial content of the edoc, rather than the entire edoc. This route is identical to the GET edoc route, but allows clients to include an audit reason when downloading the edoc. + ///
/// The requested repository ID. /// The requested document ID. - /// An optional header used to retrieve partial content of the edoc. Only supports single - ///
range with byte unit. + /// An optional header used to retrieve partial content of the edoc. Only supports single
+ /// range with byte unit. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get edoc successfully. /// A server side error occurred. Task ExportDocumentWithAuditReasonAsync(string repoId, int entryId, GetEdocWithAuditReasonRequest request = null, string range = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns dynamic field logic values with the current values of the fields in the template. Provide an entry ID and field values in the JSON body to get dynamic field logic values. Independent and non-dynamic fields in the request body will be ignored, and only related dynamic field logic values for the assigned template will be returned. + /// Returns the dynamic field logic values assigned to an entry. /// + /// + /// - Returns dynamic field logic values with the current values of the fields in the template.
+ /// - Provide an entry ID and field values in the JSON body to get dynamic field logic values.
+ /// Independent and non-dynamic fields in the request body will be ignored, and only related dynamic field logic values for the assigned template will be returned. + ///
/// The requested repository ID. /// The requested entry ID. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get dynamic field logic values successfully. /// A server side error occurred. Task>> GetDynamicFieldValuesAsync(string repoId, int entryId, GetDynamicFieldLogicValueRequest request = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Remove the currently assigned template from the specified entry. Provide an entry ID to clear template value on. If the entry does not have a template assigned, no change will be made. + /// Removes the currently assigned template from an entry. /// + /// + /// - Remove the currently assigned template from the specified entry.
+ /// - Provide an entry ID to clear template value on.
+ /// - If the entry does not have a template assigned, no change will be made. + ///
/// The requested repository ID. /// The ID of the entry that will have its template removed. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Remove the currently assigned template successfully. /// A server side error occurred. Task DeleteAssignedTemplateAsync(string repoId, int entryId, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Assign a template to an entry. Provide an entry ID, template name, and a list of template fields to assign to that entry. Only template values will be modified. Any existing independent fields on the entry will not be modified, nor will they be added if included in the request. The only modification to fields will only occur on templated fields. If the previously assigned template includes common template fields as the newly assigned template, the common field values will not be modified. + /// Assigns a template to an entry. /// + /// + /// - Assign a template to an entry.
+ /// - Provide an entry ID, template name, and a list of template fields to assign to that entry.
+ /// - Only template values will be modified. Any existing independent fields on the entry will not be modified, nor will they be added if included in the request. The only modification to fields will only occur on templated fields. If the previously assigned template includes common template fields as the newly assigned template, the common field values will not be modified. + ///
/// The requested repository ID. /// The ID of entry that will have its template updated. /// The template and template fields that will be assigned to the entry. - /// An optional query parameter used to indicate the locale that should be used. - ///
The value should be a standard language tag. This may be used when setting field values with tokens. + /// An optional query parameter used to indicate the locale that should be used.
+ /// The value should be a standard language tag. This may be used when setting field values with tokens. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Assign a template successfully. /// A server side error occurred. Task WriteTemplateValueToEntryAsync(string repoId, int entryId, PutTemplateRequest request = null, string culture = null, CancellationToken cancellationToken = default(CancellationToken)); } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class EntriesClient : BaseClient, IEntriesClient { private HttpClient _httpClient; @@ -353,17 +466,22 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() partial void PrepareRequest(HttpClient client, HttpRequestMessage request, StringBuilder urlBuilder); partial void ProcessResponse(HttpClient client, HttpResponseMessage response); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Creates a new document in the specified folder with file (no more than 100 MB). Optionally sets metadata and electronic document component. Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. With this route, partial success is possible. The response returns multiple operation (entryCreate operation, setEdoc operation, setLinks operation, etc..) objects, which contain information about any errors that may have occurred during the creation. As long as the entryCreate operation succeeds, the entry will be created, even if all other operations fail. + /// Creates a new document in a folder. /// + /// + /// - Creates a new document in the specified folder with file (no more than 100 MB).
+ /// - Optionally sets metadata and electronic document component.
+ /// - Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. With this route, partial success is possible. The response returns multiple operation (entryCreate operation, setEdoc operation, setLinks operation, etc..) objects, which contain information about any errors that may have occurred during the creation. As long as the entryCreate operation succeeds, the entry will be created, even if all other operations fail. + ///
/// The requested repository ID. /// The entry ID of the folder that the document will be created in. /// The created document's file name. - /// An optional query parameter used to indicate if the new document should be automatically - ///
renamed if an entry already exists with the given name in the folder. The default value is false. - /// An optional query parameter used to indicate the locale that should be used. - ///
The value should be a standard language tag. This may be used when setting field values with tokens. + /// An optional query parameter used to indicate if the new document should be automatically
+ /// renamed if an entry already exists with the given name in the folder. The default value is false. + /// An optional query parameter used to indicate the locale that should be used.
+ /// The value should be a standard language tag. This may be used when setting field values with tokens. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Document creation is success. /// A server side error occurred. public virtual async Task ImportDocumentAsync(string repoId, int parentEntryId, string fileName, bool? autoRename = null, string culture = null, FileParameter electronicDocument = null, PostEntryWithEdocMetadataRequest request = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -417,7 +535,8 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() throw new ArgumentNullException("request"); else { - content_.Add(new StringContent(Newtonsoft.Json.JsonConvert.SerializeObject(request, _settings.Value)), "request"); + var json_ = Newtonsoft.Json.JsonConvert.SerializeObject(request, _settings.Value); + content_.Add(new StringContent(json_), "request"); } request_.Content = content_; request_.Method = new HttpMethod("POST"); @@ -516,6 +635,16 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); } else + if (status_ == 413) + { + var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); + if (objectResponse_.Object == null) + { + throw ApiExceptionExtensions.Create(status_, headers_, null); + } + throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); + } + else if (status_ == 429) { var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); @@ -548,13 +677,18 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns a single entry object. Provide an entry ID, and get the entry associated with that ID. Useful when detailed information about the entry is required, such as metadata, path information, etc. Allowed OData query options: Select. If the entry is a subtype (Folder, Document, or Shortcut), the entry will automatically be converted to include those model-specific properties. + /// Returns a single entry object. /// + /// + /// - Returns a single entry object.
+ /// - Provide an entry ID, and get the entry associated with that ID. Useful when detailed information about the entry is required, such as metadata, path information, etc.
+ /// - Allowed OData query options: Select. If the entry is a subtype (Folder, Document, or Shortcut), the entry will automatically be converted to include those model-specific properties. + ///
/// The requested repository ID. /// The requested entry ID. /// Limits the properties returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get entry successfully. /// A server side error occurred. public virtual async Task GetEntryAsync(string repoId, int entryId, string select = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -689,13 +823,18 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Begins a task to delete an entry, and returns an operationToken. Provide an entry ID, and queue a delete task to remove it from the repository (includes nested objects if the entry is a Folder type). The entry will not be deleted immediately. Optionally include an audit reason ID and comment in the JSON body. This route returns an operationToken, and will run as an asynchronous operation. Check the progress via the Tasks/{operationToken} route. + /// Deletes an entry asynchronously. /// + /// + /// - Begins a task to delete an entry, and returns an operationToken.
+ /// - Provide an entry ID, and queue a delete task to remove it from the repository (includes nested objects if the entry is a Folder type). The entry will not be deleted immediately.
+ /// - Optionally include an audit reason ID and comment in the JSON body. This route returns an operationToken, and will run as an asynchronous operation. Check the progress via the Tasks/{operationToken} route. + ///
/// The requested repository ID. /// The requested entry ID. /// The submitted audit reason. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Delete entry operation start successfully. /// A server side error occurred. public virtual async Task DeleteEntryInfoAsync(string repoId, int entryId, DeleteEntryWithAuditReason request = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -717,7 +856,8 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() { using (var request_ = new HttpRequestMessage()) { - var content_ = new StringContent(Newtonsoft.Json.JsonConvert.SerializeObject(request, _settings.Value)); + var json_ = Newtonsoft.Json.JsonConvert.SerializeObject(request, _settings.Value); + var content_ = new StringContent(json_); content_.Headers.ContentType = MediaTypeHeaderValue.Parse("application/json"); request_.Content = content_; request_.Method = new HttpMethod("DELETE"); @@ -806,6 +946,16 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); } else + if (status_ == 413) + { + var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); + if (objectResponse_.Object == null) + { + throw ApiExceptionExtensions.Create(status_, headers_, null); + } + throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); + } + else if (status_ == 429) { var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); @@ -828,18 +978,23 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Moves and/or renames an entry. Move and/or rename an entry by passing in the new parent folder ID or name in the JSON body. Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. + /// Moves and/or renames an entry. /// + /// + /// - Moves and/or renames an entry.
+ /// - Move and/or rename an entry by passing in the new parent folder ID or name in the JSON body.
+ /// - Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. + ///
/// The requested repository ID. /// The requested entry ID. - /// The request containing the folder ID that the entry will be moved to and the new name - ///
the entry will be renamed to. - /// An optional query parameter used to indicate if the entry should be automatically - ///
renamed if another entry already exists with the same name in the folder. The default value is false. - /// An optional query parameter used to indicate the locale that should be used. - ///
The value should be a standard language tag. + /// The request containing the folder ID that the entry will be moved to and the new name
+ /// the entry will be renamed to. + /// An optional query parameter used to indicate if the entry should be automatically
+ /// renamed if another entry already exists with the same name in the folder. The default value is false. + /// An optional query parameter used to indicate the locale that should be used.
+ /// The value should be a standard language tag. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Moves and/or renames an entry successfully. /// A server side error occurred. public virtual async Task MoveOrRenameEntryAsync(string repoId, int entryId, PatchEntryRequest request = null, bool? autoRename = null, string culture = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -870,7 +1025,8 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() { using (var request_ = new HttpRequestMessage()) { - var content_ = new StringContent(Newtonsoft.Json.JsonConvert.SerializeObject(request, _settings.Value)); + var json_ = Newtonsoft.Json.JsonConvert.SerializeObject(request, _settings.Value); + var content_ = new StringContent(json_); content_.Headers.ContentType = MediaTypeHeaderValue.Parse("application/json"); request_.Content = content_; request_.Method = new HttpMethod("PATCH"); @@ -969,6 +1125,16 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); } else + if (status_ == 413) + { + var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); + if (objectResponse_.Object == null) + { + throw ApiExceptionExtensions.Create(status_, headers_, null); + } + throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); + } + else if (status_ == 423) { var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); @@ -1001,13 +1167,17 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns a single entry object using the entry path. Optional query parameter: fallbackToClosestAncestor. Use the fallbackToClosestAncestor query parameter to return the closest existing ancestor if the initial entry path is not found. + /// Returns a single entry object using the entry path. /// + /// + /// - Returns a single entry object using the entry path.
+ /// - Optional query parameter: fallbackToClosestAncestor. Use the fallbackToClosestAncestor query parameter to return the closest existing ancestor if the initial entry path is not found. + ///
/// The requested repository ID. /// The requested entry path. /// An optional query parameter used to indicate whether or not the closest ancestor in the path should be returned if the initial entry path is not found. The default value is false. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get entry successfully. /// A server side error occurred. public virtual async Task GetEntryByPathAsync(string repoId, string fullPath, bool? fallbackToClosestAncestor = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -1139,24 +1309,32 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the children entries of a folder in the repository. Provide an entry ID (must be a folder), and get a paged listing of entries in that folder. Used as a way of navigating through the repository. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. OData $OrderBy syntax should follow: "PropertyName direction,PropertyName2 direction". Sort order can be either value "asc" or "desc". Optional query parameters: groupByOrderType (bool). This query parameter decides if results are returned in groups based on their entry type. Entries returned in the listing are not automatically converted to their subtype (Folder, Shortcut, Document), so clients who want model-specific information should request it via the GET entry by ID route. Optionally returns field values for the entries in the folder. Each field name needs to be specified in the request. Maximum limit of 10 field names. If field values are requested, only the first value is returned if it is a multi value field. Null or Empty field values should not be used to determine if a field is assigned to the entry. + /// Returns the children entries of a folder. /// + /// + /// - Returns the children entries of a folder in the repository.
+ /// - Provide an entry ID (must be a folder), and get a paged listing of entries in that folder. Used as a way of navigating through the repository.
+ /// - Default page size: 150. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. OData $OrderBy syntax should follow: "PropertyName direction,PropertyName2 direction". Sort order can be either value "asc" or "desc". Optional query parameters: groupByOrderType (bool). This query parameter decides if results are returned in groups based on their entry type. Entries returned in the listing are not automatically converted to their subtype (Folder, Shortcut, Document), so clients who want model-specific information should request it via the GET entry by ID route.
+ /// - Optionally returns field values for the entries in the folder. Each field name needs to be specified in the request. Maximum limit of 10 field names.
+ /// - If field values are requested, only the first value is returned if it is a multi value field.
+ /// - Null or Empty field values should not be used to determine if a field is assigned to the entry. + ///
/// The requested repository ID. /// The folder ID. /// An optional query parameter used to indicate if the result should be grouped by entry type or not. /// Optional array of field names. Field values corresponding to the given field names will be returned for each entry. /// Boolean for if field values should be formatted. Only applicable if Fields are specified. /// An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise - ///
culture will not be used for formatting. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise
+ /// culture will not be used for formatting. /// Limits the properties returned in the result. /// Specifies the order in which items are returned. The maximum number of expressions is 5. /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get the children entries of a Folder successfully. /// A server side error occurred. public virtual async Task GetEntryListingAsync(string repoId, int entryId, bool? groupByEntryType = null, IEnumerable fields = null, bool? formatFields = null, string prefer = null, string culture = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -1326,17 +1504,22 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Create/copy a new child entry in the designated folder. Provide the parent folder ID, and based on the request body, copy or create a folder/shortcut as a child entry of the designated folder. Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. + /// Creates/copies a new child entry in a folder. /// + /// + /// - Create/copy a new child entry in the designated folder.
+ /// - Provide the parent folder ID, and based on the request body, copy or create a folder/shortcut as a child entry of the designated folder.
+ /// - Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. + ///
/// The requested repository ID. /// The folder ID that the entry will be created in. /// The entry to create. - /// An optional query parameter used to indicate if the new entry should be automatically - ///
renamed if an entry already exists with the given name in the folder. The default value is false. - /// An optional query parameter used to indicate the locale that should be used. - ///
The value should be a standard language tag. + /// An optional query parameter used to indicate if the new entry should be automatically
+ /// renamed if an entry already exists with the given name in the folder. The default value is false. + /// An optional query parameter used to indicate the locale that should be used.
+ /// The value should be a standard language tag. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Created a new child entry successfully. /// A server side error occurred. public virtual async Task CreateOrCopyEntryAsync(string repoId, int entryId, PostEntryChildrenRequest request = null, bool? autoRename = null, string culture = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -1367,7 +1550,8 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() { using (var request_ = new HttpRequestMessage()) { - var content_ = new StringContent(Newtonsoft.Json.JsonConvert.SerializeObject(request, _settings.Value)); + var json_ = Newtonsoft.Json.JsonConvert.SerializeObject(request, _settings.Value); + var content_ = new StringContent(json_); content_.Headers.ContentType = MediaTypeHeaderValue.Parse("application/json"); request_.Content = content_; request_.Method = new HttpMethod("POST"); @@ -1466,6 +1650,16 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); } else + if (status_ == 413) + { + var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); + if (objectResponse_.Object == null) + { + throw ApiExceptionExtensions.Create(status_, headers_, null); + } + throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); + } + else if (status_ == 429) { var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); @@ -1488,23 +1682,28 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the fields assigned to an entry. Provide an entry ID, and get a paged listing of all fields assigned to that entry. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + /// Returns the fields assigned to an entry. /// + /// + /// - Returns the fields assigned to an entry.
+ /// - Provide an entry ID, and get a paged listing of all fields assigned to that entry.
+ /// - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + ///
/// The requested repository ID. /// The requested entry ID. /// An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. - /// An optional query parameter used to indicate if the field values should be formatted. - ///
The default value is false. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise - ///
culture will not be used for formatting. + /// An optional query parameter used to indicate if the field values should be formatted.
+ /// The default value is false. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise
+ /// culture will not be used for formatting. /// Limits the properties returned in the result. /// Specifies the order in which items are returned. The maximum number of expressions is 5. /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get field values successfully. /// A server side error occurred. public virtual async Task GetFieldValuesAsync(string repoId, int entryId, string prefer = null, bool? formatValue = null, string culture = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -1666,14 +1865,19 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Update the field values assigned to an entry. Provide the new field values to assign to the entry, and remove/reset all previously assigned field values. This is an overwrite action. The request body must include all desired field values, including any existing field values that should remain assigned to the entry. Field values that are not included in the request will be deleted from the entry. If the field value that is not included is part of a template, it will still be assigned (as required by the template), but its value will be reset. + /// Updates the field values assigned to an entry. /// + /// + /// - Update the field values assigned to an entry.
+ /// - Provide the new field values to assign to the entry, and remove/reset all previously assigned field values.
+ /// - This is an overwrite action. The request body must include all desired field values, including any existing field values that should remain assigned to the entry. Field values that are not included in the request will be deleted from the entry. If the field value that is not included is part of a template, it will still be assigned (as required by the template), but its value will be reset. + ///
/// The requested repository ID. /// The entry ID of the entry that will have its fields updated. - /// An optional query parameter used to indicate the locale that should be used. - ///
The value should be a standard language tag. This may be used when setting field values with tokens. + /// An optional query parameter used to indicate the locale that should be used.
+ /// The value should be a standard language tag. This may be used when setting field values with tokens. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Update field values successfully. /// A server side error occurred. public virtual async Task AssignFieldValuesAsync(string repoId, int entryId, IDictionary fieldsToUpdate = null, string culture = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -1700,7 +1904,8 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() { using (var request_ = new HttpRequestMessage()) { - var content_ = new StringContent(Newtonsoft.Json.JsonConvert.SerializeObject(fieldsToUpdate, _settings.Value)); + var json_ = Newtonsoft.Json.JsonConvert.SerializeObject(fieldsToUpdate, _settings.Value); + var content_ = new StringContent(json_); content_.Headers.ContentType = MediaTypeHeaderValue.Parse("application/json"); request_.Content = content_; request_.Method = new HttpMethod("PUT"); @@ -1789,6 +1994,16 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); } else + if (status_ == 413) + { + var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); + if (objectResponse_.Object == null) + { + throw ApiExceptionExtensions.Create(status_, headers_, null); + } + throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); + } + else if (status_ == 423) { var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); @@ -1821,10 +2036,14 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the tags assigned to an entry. Provide an entry ID, and get a paged listing of tags assigned to that entry. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + /// Returns the tags assigned to an entry. /// + /// + /// - Returns the tags assigned to an entry.
+ /// - Provide an entry ID, and get a paged listing of tags assigned to that entry.
+ /// - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + ///
/// The requested repository ID. /// The requested entry ID. /// An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. @@ -1833,6 +2052,7 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get entry tags successfully. /// A server side error occurred. public virtual async Task GetTagsAssignedToEntryAsync(string repoId, int entryId, string prefer = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -1986,13 +2206,18 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Assign tags to an entry. Provide an entry ID and a list of tags to assign to that entry. This is an overwrite action. The request must include all tags to assign to the entry, including existing tags that should remain assigned to the entry. + /// Assigns tags to an entry. /// + /// + /// - Assign tags to an entry.
+ /// - Provide an entry ID and a list of tags to assign to that entry.
+ /// - This is an overwrite action. The request must include all tags to assign to the entry, including existing tags that should remain assigned to the entry. + ///
/// The requested repository ID. /// The requested entry ID. /// The tags to add. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Assign tags to an entry successfully. /// A server side error occurred. public virtual async Task AssignTagsAsync(string repoId, int entryId, PutTagRequest tagsToAdd = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -2014,7 +2239,8 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() { using (var request_ = new HttpRequestMessage()) { - var content_ = new StringContent(Newtonsoft.Json.JsonConvert.SerializeObject(tagsToAdd, _settings.Value)); + var json_ = Newtonsoft.Json.JsonConvert.SerializeObject(tagsToAdd, _settings.Value); + var content_ = new StringContent(json_); content_.Headers.ContentType = MediaTypeHeaderValue.Parse("application/json"); request_.Content = content_; request_.Method = new HttpMethod("PUT"); @@ -2103,6 +2329,16 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); } else + if (status_ == 413) + { + var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); + if (objectResponse_.Object == null) + { + throw ApiExceptionExtensions.Create(status_, headers_, null); + } + throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); + } + else if (status_ == 423) { var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); @@ -2135,12 +2371,17 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Assign links to an entry. Provide an entry ID and a list of links to assign to that entry. This is an overwrite action. The request must include all links to assign to the entry, including existing links that should remain assigned to the entry. + /// Assigns links to an entry. /// + /// + /// - Assign links to an entry.
+ /// - Provide an entry ID and a list of links to assign to that entry.
+ /// - This is an overwrite action. The request must include all links to assign to the entry, including existing links that should remain assigned to the entry. + ///
/// The request repository ID. /// The requested entry ID. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Assign links to an entry successfully. /// A server side error occurred. public virtual async Task AssignEntryLinksAsync(string repoId, int entryId, IEnumerable linksToAdd = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -2162,7 +2403,8 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() { using (var request_ = new HttpRequestMessage()) { - var content_ = new StringContent(Newtonsoft.Json.JsonConvert.SerializeObject(linksToAdd, _settings.Value)); + var json_ = Newtonsoft.Json.JsonConvert.SerializeObject(linksToAdd, _settings.Value); + var content_ = new StringContent(json_); content_.Headers.ContentType = MediaTypeHeaderValue.Parse("application/json"); request_.Content = content_; request_.Method = new HttpMethod("PUT"); @@ -2251,6 +2493,16 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); } else + if (status_ == 413) + { + var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); + if (objectResponse_.Object == null) + { + throw ApiExceptionExtensions.Create(status_, headers_, null); + } + throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); + } + else if (status_ == 423) { var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); @@ -2283,10 +2535,14 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the links assigned to an entry. Provide an entry ID, and get a paged listing of links assigned to that entry. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + /// Returns the links assigned to an entry. /// + /// + /// - Returns the links assigned to an entry.
+ /// - Provide an entry ID, and get a paged listing of links assigned to that entry.
+ /// - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + ///
/// The requested repository ID. /// The requested entry ID. /// An optional odata header. Can be used to set the maximum page size using odata.maxpagesize. @@ -2295,6 +2551,7 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get links successfully. /// A server side error occurred. public virtual async Task GetLinkValuesFromEntryAsync(string repoId, int entryId, string prefer = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -2448,17 +2705,24 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Copy a new child entry in the designated folder async, and potentially return an operationToken. Provide the parent folder ID, and copy an entry as a child of the designated folder. Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. The status of the operation can be checked via the Tasks/{operationToken} route. + /// Copies an entry into a folder asynchronously. /// + /// + /// - Copy a new child entry in the designated folder async, and potentially return an operationToken.
+ /// - Provide the parent folder ID, and copy an entry as a child of the designated folder.
+ /// - Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed.
+ /// - The status of the operation can be checked via the Tasks/{operationToken} route.
+ /// - Token substitution in the name of the copied entry is not supported. + ///
/// The requested repository ID. /// The folder ID that the entry will be created in. /// Copy entry request. - /// An optional query parameter used to indicate if the new entry should be automatically - ///
renamed if an entry already exists with the given name in the folder. The default value is false. - /// An optional query parameter used to indicate the locale that should be used. - ///
The value should be a standard language tag. + /// An optional query parameter used to indicate if the new entry should be automatically
+ /// renamed if an entry already exists with the given name in the folder. The default value is false. + /// An optional query parameter used to indicate the locale that should be used.
+ /// The value should be a standard language tag. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Copy entry operation is started successfully. /// A server side error occurred. public virtual async Task CopyEntryAsync(string repoId, int entryId, CopyAsyncRequest request = null, bool? autoRename = null, string culture = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -2489,7 +2753,8 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() { using (var request_ = new HttpRequestMessage()) { - var content_ = new StringContent(Newtonsoft.Json.JsonConvert.SerializeObject(request, _settings.Value)); + var json_ = Newtonsoft.Json.JsonConvert.SerializeObject(request, _settings.Value); + var content_ = new StringContent(json_); content_.Headers.ContentType = MediaTypeHeaderValue.Parse("application/json"); request_.Content = content_; request_.Method = new HttpMethod("POST"); @@ -2578,6 +2843,16 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); } else + if (status_ == 413) + { + var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); + if (objectResponse_.Object == null) + { + throw ApiExceptionExtensions.Create(status_, headers_, null); + } + throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); + } + else if (status_ == 429) { var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); @@ -2600,12 +2875,15 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Delete the edoc associated with the provided entry ID. + /// Deletes the edoc associated with an entry. /// + /// + /// - Delete the edoc associated with the provided entry ID. + /// /// The requested repository ID. /// The requested document ID. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Deleted edoc successfully. /// A server side error occurred. public virtual async Task DeleteDocumentAsync(string repoId, int entryId, CancellationToken cancellationToken = default(CancellationToken)) @@ -2745,12 +3023,18 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns information about the edoc content of an entry, without downloading the edoc in its entirety. Provide an entry ID, and get back the Content-Type and Content-Length in the response headers. This route does not provide a way to download the actual edoc. Instead, it just gives metadata information about the edoc associated with the entry. + /// Returns information about the edoc content of an entry. /// + /// + /// - Returns information about the edoc content of an entry, without downloading the edoc in its entirety.
+ /// - Provide an entry ID, and get back the Content-Type and Content-Length in the response headers.
+ /// - This route does not provide a way to download the actual edoc. Instead, it just gives metadata information about the edoc associated with the entry.
+ /// - If an error occurs, the error message can be found in the X-APIServer-Error HTTP response header. + ///
/// The requested repository ID. /// The requested document ID. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get edoc info successfully. /// A server side error occurred. public virtual async Task GetDocumentContentTypeAsync(string repoId, int entryId, CancellationToken cancellationToken = default(CancellationToken)) @@ -2860,14 +3144,19 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns an entry's edoc resource in a stream format. Provide an entry ID, and get the edoc resource as part of the response content. Optional header: Range. Use the Range header (single range with byte unit) to retrieve partial content of the edoc, rather than the entire edoc. + /// Returns an entry's edoc resource in a stream format. /// + /// + /// - Returns an entry's edoc resource in a stream format.
+ /// - Provide an entry ID, and get the edoc resource as part of the response content.
+ /// - Optional header: Range. Use the Range header (single range with byte unit) to retrieve partial content of the edoc, rather than the entire edoc. + ///
/// The requested repository ID. /// The requested document ID. - /// An optional header used to retrieve partial content of the edoc. Only supports single - ///
range with byte unit. + /// An optional header used to retrieve partial content of the edoc. Only supports single
+ /// range with byte unit. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get edoc successfully. /// A server side error occurred. public virtual async Task ExportDocumentAsync(string repoId, int entryId, string range = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -3016,13 +3305,17 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Delete the pages associated with the provided entry ID. If no pageRange is specified, all pages will be deleted. Optional parameter: pageRange (default empty). The value should be a comma-seperated string which contains non-overlapping single values, or page ranges. Ex: "1,2,3", "1-3,5", "2-7,10-12." + /// Deletes the pages associated with an entry. /// + /// + /// - Delete the pages associated with the provided entry ID. If no pageRange is specified, all pages will be deleted.
+ /// - Optional parameter: pageRange (default empty). The value should be a comma-seperated string which contains non-overlapping single values, or page ranges. Ex: "1,2,3", "1-3,5", "2-7,10-12." + ///
/// The requested repository ID. /// The requested document ID. /// The pages to be deleted. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Deleted pages successfully. /// A server side error occurred. public virtual async Task DeletePagesAsync(string repoId, int entryId, string pageRange = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -3167,14 +3460,19 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns an entry's edoc resource in a stream format while including an audit reason. Provide an entry ID and audit reason/comment in the request body, and get the edoc resource as part of the response content. Optional header: Range. Use the Range header (single range with byte unit) to retrieve partial content of the edoc, rather than the entire edoc. This route is identical to the GET edoc route, but allows clients to include an audit reason when downloading the edoc. + /// Returns an entry's edoc resource in a stream format, including an audit reason. /// + /// + /// - Returns an entry's edoc resource in a stream format while including an audit reason.
+ /// - Provide an entry ID and audit reason/comment in the request body, and get the edoc resource as part of the response content.
+ /// - Optional header: Range. Use the Range header (single range with byte unit) to retrieve partial content of the edoc, rather than the entire edoc. This route is identical to the GET edoc route, but allows clients to include an audit reason when downloading the edoc. + ///
/// The requested repository ID. /// The requested document ID. - /// An optional header used to retrieve partial content of the edoc. Only supports single - ///
range with byte unit. + /// An optional header used to retrieve partial content of the edoc. Only supports single
+ /// range with byte unit. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get edoc successfully. /// A server side error occurred. public virtual async Task ExportDocumentWithAuditReasonAsync(string repoId, int entryId, GetEdocWithAuditReasonRequest request = null, string range = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -3199,7 +3497,8 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() if (range != null) request_.Headers.TryAddWithoutValidation("Range", ConvertToString(range, CultureInfo.InvariantCulture)); - var content_ = new StringContent(Newtonsoft.Json.JsonConvert.SerializeObject(request, _settings.Value)); + var json_ = Newtonsoft.Json.JsonConvert.SerializeObject(request, _settings.Value); + var content_ = new StringContent(json_); content_.Headers.ContentType = MediaTypeHeaderValue.Parse("application/json"); request_.Content = content_; request_.Method = new HttpMethod("POST"); @@ -3294,6 +3593,16 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); } else + if (status_ == 413) + { + var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); + if (objectResponse_.Object == null) + { + throw ApiExceptionExtensions.Create(status_, headers_, null); + } + throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); + } + else if (status_ == 423) { var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); @@ -3326,12 +3635,17 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns dynamic field logic values with the current values of the fields in the template. Provide an entry ID and field values in the JSON body to get dynamic field logic values. Independent and non-dynamic fields in the request body will be ignored, and only related dynamic field logic values for the assigned template will be returned. + /// Returns the dynamic field logic values assigned to an entry. /// + /// + /// - Returns dynamic field logic values with the current values of the fields in the template.
+ /// - Provide an entry ID and field values in the JSON body to get dynamic field logic values.
+ /// Independent and non-dynamic fields in the request body will be ignored, and only related dynamic field logic values for the assigned template will be returned. + ///
/// The requested repository ID. /// The requested entry ID. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get dynamic field logic values successfully. /// A server side error occurred. public virtual async Task>> GetDynamicFieldValuesAsync(string repoId, int entryId, GetDynamicFieldLogicValueRequest request = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -3353,7 +3667,8 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() { using (var request_ = new HttpRequestMessage()) { - var content_ = new StringContent(Newtonsoft.Json.JsonConvert.SerializeObject(request, _settings.Value)); + var json_ = Newtonsoft.Json.JsonConvert.SerializeObject(request, _settings.Value); + var content_ = new StringContent(json_); content_.Headers.ContentType = MediaTypeHeaderValue.Parse("application/json"); request_.Content = content_; request_.Method = new HttpMethod("POST"); @@ -3442,6 +3757,16 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); } else + if (status_ == 413) + { + var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); + if (objectResponse_.Object == null) + { + throw ApiExceptionExtensions.Create(status_, headers_, null); + } + throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); + } + else if (status_ == 429) { var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); @@ -3464,12 +3789,17 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Remove the currently assigned template from the specified entry. Provide an entry ID to clear template value on. If the entry does not have a template assigned, no change will be made. + /// Removes the currently assigned template from an entry. /// + /// + /// - Remove the currently assigned template from the specified entry.
+ /// - Provide an entry ID to clear template value on.
+ /// - If the entry does not have a template assigned, no change will be made. + ///
/// The requested repository ID. /// The ID of the entry that will have its template removed. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Remove the currently assigned template successfully. /// A server side error occurred. public virtual async Task DeleteAssignedTemplateAsync(string repoId, int entryId, CancellationToken cancellationToken = default(CancellationToken)) @@ -3609,15 +3939,20 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Assign a template to an entry. Provide an entry ID, template name, and a list of template fields to assign to that entry. Only template values will be modified. Any existing independent fields on the entry will not be modified, nor will they be added if included in the request. The only modification to fields will only occur on templated fields. If the previously assigned template includes common template fields as the newly assigned template, the common field values will not be modified. + /// Assigns a template to an entry. /// + /// + /// - Assign a template to an entry.
+ /// - Provide an entry ID, template name, and a list of template fields to assign to that entry.
+ /// - Only template values will be modified. Any existing independent fields on the entry will not be modified, nor will they be added if included in the request. The only modification to fields will only occur on templated fields. If the previously assigned template includes common template fields as the newly assigned template, the common field values will not be modified. + ///
/// The requested repository ID. /// The ID of entry that will have its template updated. /// The template and template fields that will be assigned to the entry. - /// An optional query parameter used to indicate the locale that should be used. - ///
The value should be a standard language tag. This may be used when setting field values with tokens. + /// An optional query parameter used to indicate the locale that should be used.
+ /// The value should be a standard language tag. This may be used when setting field values with tokens. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Assign a template successfully. /// A server side error occurred. public virtual async Task WriteTemplateValueToEntryAsync(string repoId, int entryId, PutTemplateRequest request = null, string culture = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -3644,7 +3979,8 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() { using (var request_ = new HttpRequestMessage()) { - var content_ = new StringContent(Newtonsoft.Json.JsonConvert.SerializeObject(request, _settings.Value)); + var json_ = Newtonsoft.Json.JsonConvert.SerializeObject(request, _settings.Value); + var content_ = new StringContent(json_); content_.Headers.ContentType = MediaTypeHeaderValue.Parse("application/json"); request_.Content = content_; request_.Method = new HttpMethod("PUT"); @@ -3733,6 +4069,16 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); } else + if (status_ == 413) + { + var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); + if (objectResponse_.Object == null) + { + throw ApiExceptionExtensions.Create(status_, headers_, null); + } + throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); + } + else if (status_ == 423) { var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); @@ -3868,14 +4214,18 @@ private string ConvertToString(object value, CultureInfo cultureInfo) } } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial interface IAttributesClient { - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the attribute key value pairs associated with the authenticated user. Alternatively, return only the attribute key value pairs that are associated with the "Everyone" group. Attribute keys can be used with subsequent calls to get specific attribute values. Default page size: 100. Allowed OData query options: Select, Count, OrderBy, Skip, Top, SkipToken, Prefer. Optional query parameters: everyone (bool, default false). When true, this route does not return the attributes that are tied to the currently authenticated user, but rather the attributes assigned to the "Everyone" group. Note when this is true, the response does not include both the "Everyone" groups attribute and the currently authenticated user, but only the "Everyone" groups. + /// Returns the attribute key value pairs associated with the authenticated user. /// + /// + /// - Returns the attribute key value pairs associated with the authenticated user. Alternatively, return only the attribute key value pairs that are associated with the "Everyone" group.
+ /// - Attribute keys can be used with subsequent calls to get specific attribute values.
+ /// - Default page size: 100. Allowed OData query options: Select, Count, OrderBy, Skip, Top, SkipToken, Prefer. Optional query parameters: everyone (bool, default false). When true, this route does not return the attributes that are tied to the currently authenticated user, but rather the attributes assigned to the "Everyone" group. Note when this is true, the response does not include both the "Everyone" groups attribute and the currently authenticated user, but only the "Everyone" groups. + ///
/// The requested repository ID. /// Boolean value that indicates whether to return attributes key value pairs associated with everyone or the currently authenticated user. /// An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. @@ -3884,24 +4234,29 @@ public partial interface IAttributesClient /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get trustee attribute key value pairs successfully. /// A server side error occurred. Task GetTrusteeAttributeKeyValuePairsAsync(string repoId, bool? everyone = null, string prefer = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the attribute associated with the key. Alternatively, return the attribute associated with the key within "Everyone" group. Optional query parameters: everyone (bool, default false). When true, the server only searches for the attribute value with the given key upon the authenticated users attributes. If false, only the authenticated users attributes will be queried. + /// Returns an attribute object associated with the authenticated user. /// + /// + /// - Returns the attribute associated with the key. Alternatively, return the attribute associated with the key within "Everyone" group.
+ /// - Optional query parameters: everyone (bool, default false). When true, the server only searches for the attribute value with the given key upon the authenticated users attributes. If false, only the authenticated users attributes will be queried. + ///
/// The requested repository ID. /// The requested attribute key. /// Boolean value that indicates whether to return attributes associated with everyone or the currently authenticated user. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get trustee attribute value successfully. /// A server side error occurred. Task GetTrusteeAttributeValueByKeyAsync(string repoId, string attributeKey, bool? everyone = null, CancellationToken cancellationToken = default(CancellationToken)); } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class AttributesClient : BaseClient, IAttributesClient { private HttpClient _httpClient; @@ -3926,10 +4281,14 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() partial void PrepareRequest(HttpClient client, HttpRequestMessage request, StringBuilder urlBuilder); partial void ProcessResponse(HttpClient client, HttpResponseMessage response); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the attribute key value pairs associated with the authenticated user. Alternatively, return only the attribute key value pairs that are associated with the "Everyone" group. Attribute keys can be used with subsequent calls to get specific attribute values. Default page size: 100. Allowed OData query options: Select, Count, OrderBy, Skip, Top, SkipToken, Prefer. Optional query parameters: everyone (bool, default false). When true, this route does not return the attributes that are tied to the currently authenticated user, but rather the attributes assigned to the "Everyone" group. Note when this is true, the response does not include both the "Everyone" groups attribute and the currently authenticated user, but only the "Everyone" groups. + /// Returns the attribute key value pairs associated with the authenticated user. /// + /// + /// - Returns the attribute key value pairs associated with the authenticated user. Alternatively, return only the attribute key value pairs that are associated with the "Everyone" group.
+ /// - Attribute keys can be used with subsequent calls to get specific attribute values.
+ /// - Default page size: 100. Allowed OData query options: Select, Count, OrderBy, Skip, Top, SkipToken, Prefer. Optional query parameters: everyone (bool, default false). When true, this route does not return the attributes that are tied to the currently authenticated user, but rather the attributes assigned to the "Everyone" group. Note when this is true, the response does not include both the "Everyone" groups attribute and the currently authenticated user, but only the "Everyone" groups. + ///
/// The requested repository ID. /// Boolean value that indicates whether to return attributes key value pairs associated with everyone or the currently authenticated user. /// An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. @@ -3938,6 +4297,7 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get trustee attribute key value pairs successfully. /// A server side error occurred. public virtual async Task GetTrusteeAttributeKeyValuePairsAsync(string repoId, bool? everyone = null, string prefer = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -4091,13 +4451,17 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the attribute associated with the key. Alternatively, return the attribute associated with the key within "Everyone" group. Optional query parameters: everyone (bool, default false). When true, the server only searches for the attribute value with the given key upon the authenticated users attributes. If false, only the authenticated users attributes will be queried. + /// Returns an attribute object associated with the authenticated user. /// + /// + /// - Returns the attribute associated with the key. Alternatively, return the attribute associated with the key within "Everyone" group.
+ /// - Optional query parameters: everyone (bool, default false). When true, the server only searches for the attribute value with the given key upon the authenticated users attributes. If false, only the authenticated users attributes will be queried. + ///
/// The requested repository ID. /// The requested attribute key. /// Boolean value that indicates whether to return attributes associated with everyone or the currently authenticated user. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get trustee attribute value successfully. /// A server side error occurred. public virtual async Task GetTrusteeAttributeValueByKeyAsync(string repoId, string attributeKey, bool? everyone = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -4335,43 +4699,53 @@ private string ConvertToString(object value, CultureInfo cultureInfo) } } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial interface IFieldDefinitionsClient { - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns a single field definition associated with the specified ID. Useful when a route provides a minimal amount of details and more information about the specific field definition is needed. Allowed OData query options: Select + /// Returns a single field definition object. /// + /// + /// - Returns a single field definition associated with the specified ID.
+ /// - Useful when a route provides a minimal amount of details and more information about the specific field definition is needed.
+ /// - Allowed OData query options: Select + ///
/// The requested repository ID. /// The requested field definition ID. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. /// Limits the properties returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get field definition successfully. /// A server side error occurred. Task GetFieldDefinitionByIdAsync(string repoId, int fieldDefinitionId, string culture = null, string select = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns a paged listing of field definitions available in the specified repository. Useful when trying to find a list of all field definitions available, rather than only those assigned to a specific entry/template. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + /// Returns the paged listing of the field definitions available in a repository. /// + /// + /// - Returns a paged listing of field definitions available in the specified repository.
+ /// - Useful when trying to find a list of all field definitions available, rather than only those assigned to a specific entry/template.
+ /// - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + ///
/// The requested repository ID. /// An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. /// Limits the properties returned in the result. /// Specifies the order in which items are returned. The maximum number of expressions is 5. /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get field definitions successfully. /// A server side error occurred. Task GetFieldDefinitionsAsync(string repoId, string prefer = null, string culture = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)); } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class FieldDefinitionsClient : BaseClient, IFieldDefinitionsClient { private HttpClient _httpClient; @@ -4396,15 +4770,20 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() partial void PrepareRequest(HttpClient client, HttpRequestMessage request, StringBuilder urlBuilder); partial void ProcessResponse(HttpClient client, HttpResponseMessage response); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns a single field definition associated with the specified ID. Useful when a route provides a minimal amount of details and more information about the specific field definition is needed. Allowed OData query options: Select + /// Returns a single field definition object. /// + /// + /// - Returns a single field definition associated with the specified ID.
+ /// - Useful when a route provides a minimal amount of details and more information about the specific field definition is needed.
+ /// - Allowed OData query options: Select + ///
/// The requested repository ID. /// The requested field definition ID. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. /// Limits the properties returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get field definition successfully. /// A server side error occurred. public virtual async Task GetFieldDefinitionByIdAsync(string repoId, int fieldDefinitionId, string culture = null, string select = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -4543,19 +4922,24 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns a paged listing of field definitions available in the specified repository. Useful when trying to find a list of all field definitions available, rather than only those assigned to a specific entry/template. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + /// Returns the paged listing of the field definitions available in a repository. /// + /// + /// - Returns a paged listing of field definitions available in the specified repository.
+ /// - Useful when trying to find a list of all field definitions available, rather than only those assigned to a specific entry/template.
+ /// - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + ///
/// The requested repository ID. /// An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. /// Limits the properties returned in the result. /// Specifies the order in which items are returned. The maximum number of expressions is 5. /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get field definitions successfully. /// A server side error occurred. public virtual async Task GetFieldDefinitionsAsync(string repoId, string prefer = null, string culture = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -4812,14 +5196,18 @@ private string ConvertToString(object value, CultureInfo cultureInfo) } } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial interface ILinkDefinitionsClient { - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the link definitions in the repository. Provide a repository ID and get a paged listing of link definitions available in the repository. Useful when trying to display all link definitions available, not only links assigned to a specific entry. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + /// Returns the link definitions associated with a repository. /// + /// + /// - Returns the link definitions in the repository.
+ /// - Provide a repository ID and get a paged listing of link definitions available in the repository. Useful when trying to display all link definitions available, not only links assigned to a specific entry.
+ /// - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + ///
/// The requested repository ID. /// An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. /// Limits the properties returned in the result. @@ -4827,24 +5215,30 @@ public partial interface ILinkDefinitionsClient /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get link definitions successfully. /// A server side error occurred. Task GetLinkDefinitionsAsync(string repoId, string prefer = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns a single link definition associated with the specified ID. Provide a link type ID and get the associated link definition. Useful when a route provides a minimal amount of details and more information about the specific link definition is needed. Allowed OData query options: Select + /// Returns a single link definition object. /// + /// + /// - Returns a single link definition associated with the specified ID.
+ /// - Provide a link type ID and get the associated link definition. Useful when a route provides a minimal amount of details and more information about the specific link definition is needed.
+ /// - Allowed OData query options: Select + ///
/// The requested repository ID. /// The requested link type ID. /// Limits the properties returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get link definition successfully. /// A server side error occurred. Task GetLinkDefinitionByIdAsync(string repoId, int linkTypeId, string select = null, CancellationToken cancellationToken = default(CancellationToken)); } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class LinkDefinitionsClient : BaseClient, ILinkDefinitionsClient { private HttpClient _httpClient; @@ -4869,10 +5263,14 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() partial void PrepareRequest(HttpClient client, HttpRequestMessage request, StringBuilder urlBuilder); partial void ProcessResponse(HttpClient client, HttpResponseMessage response); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the link definitions in the repository. Provide a repository ID and get a paged listing of link definitions available in the repository. Useful when trying to display all link definitions available, not only links assigned to a specific entry. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + /// Returns the link definitions associated with a repository. /// + /// + /// - Returns the link definitions in the repository.
+ /// - Provide a repository ID and get a paged listing of link definitions available in the repository. Useful when trying to display all link definitions available, not only links assigned to a specific entry.
+ /// - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + ///
/// The requested repository ID. /// An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. /// Limits the properties returned in the result. @@ -4880,6 +5278,7 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get link definitions successfully. /// A server side error occurred. public virtual async Task GetLinkDefinitionsAsync(string repoId, string prefer = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -5029,13 +5428,18 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns a single link definition associated with the specified ID. Provide a link type ID and get the associated link definition. Useful when a route provides a minimal amount of details and more information about the specific link definition is needed. Allowed OData query options: Select + /// Returns a single link definition object. /// + /// + /// - Returns a single link definition associated with the specified ID.
+ /// - Provide a link type ID and get the associated link definition. Useful when a route provides a minimal amount of details and more information about the specific link definition is needed.
+ /// - Allowed OData query options: Select + ///
/// The requested repository ID. /// The requested link type ID. /// Limits the properties returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get link definition successfully. /// A server side error occurred. public virtual async Task GetLinkDefinitionByIdAsync(string repoId, int linkTypeId, string select = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -5273,21 +5677,24 @@ private string ConvertToString(object value, CultureInfo cultureInfo) } } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial interface IRepositoriesClient { - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the repository resource list that current user has access to. + /// Returns the list of repositories accessible to the user. /// + /// + /// - Returns the repository resource list that current user has access to. + /// + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get the respository resource list successfully. /// A server side error occurred. Task> GetRepositoryListAsync(CancellationToken cancellationToken = default(CancellationToken)); } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class RepositoriesClient : BaseClient, IRepositoriesClient { private HttpClient _httpClient; @@ -5312,10 +5719,13 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() partial void PrepareRequest(HttpClient client, HttpRequestMessage request, StringBuilder urlBuilder); partial void ProcessResponse(HttpClient client, HttpResponseMessage response); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the repository resource list that current user has access to. + /// Returns the list of repositories accessible to the user. /// + /// + /// - Returns the repository resource list that current user has access to. + /// + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get the respository resource list successfully. /// A server side error occurred. public virtual async Task> GetRepositoryListAsync(CancellationToken cancellationToken = default(CancellationToken)) @@ -5530,22 +5940,27 @@ private string ConvertToString(object value, CultureInfo cultureInfo) } } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial interface IAuditReasonsClient { - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the audit reasons associated with the authenticated user. Inherited audit reasons are included. Only includes audit reasons associated with available API functionalities, like delete entry and export document. If the authenticated user does not have the appropriate Laserfiche feature right, the audit reasons associated with that feature right will not be included. + /// Returns the audit reasons associated with the authenticated user. /// + /// + /// - Returns the audit reasons associated with the authenticated user. Inherited audit reasons are included.
+ /// - Only includes audit reasons associated with available API functionalities, like delete entry and export document.
+ /// - If the authenticated user does not have the appropriate Laserfiche feature right, the audit reasons associated with that feature right will not be included. + ///
/// The requested repository ID. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get audit reasons successfully. /// A server side error occurred. Task GetAuditReasonsAsync(string repoId, CancellationToken cancellationToken = default(CancellationToken)); } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class AuditReasonsClient : BaseClient, IAuditReasonsClient { private HttpClient _httpClient; @@ -5570,11 +5985,16 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() partial void PrepareRequest(HttpClient client, HttpRequestMessage request, StringBuilder urlBuilder); partial void ProcessResponse(HttpClient client, HttpResponseMessage response); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the audit reasons associated with the authenticated user. Inherited audit reasons are included. Only includes audit reasons associated with available API functionalities, like delete entry and export document. If the authenticated user does not have the appropriate Laserfiche feature right, the audit reasons associated with that feature right will not be included. + /// Returns the audit reasons associated with the authenticated user. /// + /// + /// - Returns the audit reasons associated with the authenticated user. Inherited audit reasons are included.
+ /// - Only includes audit reasons associated with available API functionalities, like delete entry and export document.
+ /// - If the authenticated user does not have the appropriate Laserfiche feature right, the audit reasons associated with that feature right will not be included. + ///
/// The requested repository ID. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get audit reasons successfully. /// A server side error occurred. public virtual async Task GetAuditReasonsAsync(string repoId, CancellationToken cancellationToken = default(CancellationToken)) @@ -5803,44 +6223,65 @@ private string ConvertToString(object value, CultureInfo cultureInfo) } } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial interface ISearchesClient { - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Runs a search operation on the repository. Optional body parameters: FuzzyType: (default none), which can be used to determine what is considered a match by number of letters or percentage. FuzzyFactor: integer value that determines the degree to which a search will be considered a match (integer value for NumberOfLetters, or int value representing a percentage). The status for search operations must be checked via the Search specific status checking route. + /// Runs a search in the specified repository. /// + /// + /// - Runs a search operation on the repository.
+ /// - Optional body parameters: FuzzyType: (default none), which can be used to determine what is considered a match by number of letters or percentage. FuzzyFactor: integer value that determines the degree to which a search will be considered a match (integer value for NumberOfLetters, or int value representing a percentage). The status for search operations must be checked via the Search specific status checking route. + ///
/// The requested repository ID. /// The Laserfiche search command to run, optionally include fuzzy search settings. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Search operation start successfully. /// A server side error occurred. Task CreateSearchOperationAsync(string repoId, AdvancedSearchRequest request = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns search status. Provide a token (returned in the create search asynchronous route), and get the search status, progress, and any errors that may have occurred. When the search is completed, the Location header can be inspected as a link to the search results. OperationStatus can be one of the following : NotStarted, InProgress, Completed, Failed, or Canceled. + /// Returns the status of a search operation. /// + /// + /// - Returns search status.
+ /// - Provide a token (returned in the create search asynchronous route), and get the search status, progress, and any errors that may have occurred. When the search is completed, the Location header can be inspected as a link to the search results.
+ /// - OperationStatus can be one of the following : NotStarted, InProgress, Completed, Failed, or Canceled. + ///
/// The requested repository ID. /// The requested searchToken. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Search has failed. Check the errors property to find out why. /// A server side error occurred. Task GetSearchStatusAsync(string repoId, string searchToken, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Cancels a currently running search. Closes a completed search. + /// Cancels or closes a search operation. /// + /// + /// - Cancels a currently running search.
+ /// - Closes a completed search. + ///
/// The requested repository ID. /// The requested searchToken. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Cancel or closed search successfully. /// A server side error occurred. Task CancelOrCloseSearchAsync(string repoId, string searchToken, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns a search result listing if the search is completed. Optional query parameter: groupByOrderType (default false). This query parameter decides whether or not results are returned in groups based on their entry type. Optional query parameter: refresh (default false). If the search listing should be refreshed to show updated values. Default page size: 150. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. OData $OrderBy syntax should follow: "PropertyName direction,PropertyName2 direction". sort order can be either "asc" or "desc". Search results expire after 5 minutes, but can be refreshed by retrieving the results again. Optionally returns field values for the entries in the search result listing. Each field name needs to be specified in the request. Maximum limit of 10 field names. If field values are requested, only the first value is returned if it is a multi value field. Null or Empty field values should not be used to determine if a field is assigned to the entry. + /// Returns the results listing associated with a search operation. /// + /// + /// - Returns a search result listing if the search is completed.
+ /// - Optional query parameter: groupByOrderType (default false). This query parameter decides whether or not results are returned in groups based on their entry type.
+ /// - Optional query parameter: refresh (default false). If the search listing should be refreshed to show updated values.
+ /// - Default page size: 150. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. OData $OrderBy syntax should follow: "PropertyName direction,PropertyName2 direction". sort order can be either "asc" or "desc". Search results expire after 5 minutes, but can be refreshed by retrieving the results again.
+ /// - Optionally returns field values for the entries in the search result listing. Each field name needs to be specified in the request. Maximum limit of 10 field names.
+ /// - If field values are requested, only the first value is returned if it is a multi value field.
+ /// - Null or Empty field values should not be used to determine if a field is assigned to the entry. + ///
/// The requested repository ID. /// The requested searchToken. /// An optional query parameter used to indicate if the result should be grouped by entry type or not. @@ -5848,22 +6289,27 @@ public partial interface ISearchesClient /// Optional array of field names. Field values corresponding to the given field names will be returned for each search result. /// Boolean for if field values should be formatted. Only applicable if Fields are specified. /// An optional odata header. Can be used to set the maximum page size using odata.maxpagesize. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise - ///
culture will not be used for formatting. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise
+ /// culture will not be used for formatting. /// Limits the properties returned in the result. /// Specifies the order in which items are returned. The maximum number of expressions is 5. /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get search result successfully. /// A server side error occurred. Task GetSearchResultsAsync(string repoId, string searchToken, bool? groupByEntryType = null, bool? refresh = null, IEnumerable fields = null, bool? formatFields = null, string prefer = null, string culture = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the context hits associated with a search result entry. Given a searchToken, and rowNumber associated with a search entry in the listing, return the context hits for that entry. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + /// Returns the context hits associated with a search result entry. /// + /// + /// - Returns the context hits associated with a search result entry.
+ /// - Given a searchToken, and rowNumber associated with a search entry in the listing, return the context hits for that entry.
+ /// - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + ///
/// The requested repository ID. /// The requested searchToken. /// The search result listing row number to get context hits for. @@ -5873,13 +6319,14 @@ public partial interface ISearchesClient /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get search context hits successfully. /// A server side error occurred. Task GetSearchContextHitsAsync(string repoId, string searchToken, int rowNumber, string prefer = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)); } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class SearchesClient : BaseClient, ISearchesClient { private HttpClient _httpClient; @@ -5904,12 +6351,16 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() partial void PrepareRequest(HttpClient client, HttpRequestMessage request, StringBuilder urlBuilder); partial void ProcessResponse(HttpClient client, HttpResponseMessage response); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Runs a search operation on the repository. Optional body parameters: FuzzyType: (default none), which can be used to determine what is considered a match by number of letters or percentage. FuzzyFactor: integer value that determines the degree to which a search will be considered a match (integer value for NumberOfLetters, or int value representing a percentage). The status for search operations must be checked via the Search specific status checking route. + /// Runs a search in the specified repository. /// + /// + /// - Runs a search operation on the repository.
+ /// - Optional body parameters: FuzzyType: (default none), which can be used to determine what is considered a match by number of letters or percentage. FuzzyFactor: integer value that determines the degree to which a search will be considered a match (integer value for NumberOfLetters, or int value representing a percentage). The status for search operations must be checked via the Search specific status checking route. + ///
/// The requested repository ID. /// The Laserfiche search command to run, optionally include fuzzy search settings. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Search operation start successfully. /// A server side error occurred. public virtual async Task CreateSearchOperationAsync(string repoId, AdvancedSearchRequest request = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -5927,7 +6378,8 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() { using (var request_ = new HttpRequestMessage()) { - var content_ = new StringContent(Newtonsoft.Json.JsonConvert.SerializeObject(request, _settings.Value)); + var json_ = Newtonsoft.Json.JsonConvert.SerializeObject(request, _settings.Value); + var content_ = new StringContent(json_); content_.Headers.ContentType = MediaTypeHeaderValue.Parse("application/json"); request_.Content = content_; request_.Method = new HttpMethod("POST"); @@ -6016,6 +6468,16 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); } else + if (status_ == 413) + { + var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); + if (objectResponse_.Object == null) + { + throw ApiExceptionExtensions.Create(status_, headers_, null); + } + throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); + } + else if (status_ == 429) { var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); @@ -6038,12 +6500,17 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns search status. Provide a token (returned in the create search asynchronous route), and get the search status, progress, and any errors that may have occurred. When the search is completed, the Location header can be inspected as a link to the search results. OperationStatus can be one of the following : NotStarted, InProgress, Completed, Failed, or Canceled. + /// Returns the status of a search operation. /// + /// + /// - Returns search status.
+ /// - Provide a token (returned in the create search asynchronous route), and get the search status, progress, and any errors that may have occurred. When the search is completed, the Location header can be inspected as a link to the search results.
+ /// - OperationStatus can be one of the following : NotStarted, InProgress, Completed, Failed, or Canceled. + ///
/// The requested repository ID. /// The requested searchToken. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Search has failed. Check the errors property to find out why. /// A server side error occurred. public virtual async Task GetSearchStatusAsync(string repoId, string searchToken, CancellationToken cancellationToken = default(CancellationToken)) @@ -6193,12 +6660,16 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Cancels a currently running search. Closes a completed search. + /// Cancels or closes a search operation. /// + /// + /// - Cancels a currently running search.
+ /// - Closes a completed search. + ///
/// The requested repository ID. /// The requested searchToken. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Cancel or closed search successfully. /// A server side error occurred. public virtual async Task CancelOrCloseSearchAsync(string repoId, string searchToken, CancellationToken cancellationToken = default(CancellationToken)) @@ -6328,10 +6799,18 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns a search result listing if the search is completed. Optional query parameter: groupByOrderType (default false). This query parameter decides whether or not results are returned in groups based on their entry type. Optional query parameter: refresh (default false). If the search listing should be refreshed to show updated values. Default page size: 150. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. OData $OrderBy syntax should follow: "PropertyName direction,PropertyName2 direction". sort order can be either "asc" or "desc". Search results expire after 5 minutes, but can be refreshed by retrieving the results again. Optionally returns field values for the entries in the search result listing. Each field name needs to be specified in the request. Maximum limit of 10 field names. If field values are requested, only the first value is returned if it is a multi value field. Null or Empty field values should not be used to determine if a field is assigned to the entry. + /// Returns the results listing associated with a search operation. /// + /// + /// - Returns a search result listing if the search is completed.
+ /// - Optional query parameter: groupByOrderType (default false). This query parameter decides whether or not results are returned in groups based on their entry type.
+ /// - Optional query parameter: refresh (default false). If the search listing should be refreshed to show updated values.
+ /// - Default page size: 150. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. OData $OrderBy syntax should follow: "PropertyName direction,PropertyName2 direction". sort order can be either "asc" or "desc". Search results expire after 5 minutes, but can be refreshed by retrieving the results again.
+ /// - Optionally returns field values for the entries in the search result listing. Each field name needs to be specified in the request. Maximum limit of 10 field names.
+ /// - If field values are requested, only the first value is returned if it is a multi value field.
+ /// - Null or Empty field values should not be used to determine if a field is assigned to the entry. + ///
/// The requested repository ID. /// The requested searchToken. /// An optional query parameter used to indicate if the result should be grouped by entry type or not. @@ -6339,14 +6818,15 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() /// Optional array of field names. Field values corresponding to the given field names will be returned for each search result. /// Boolean for if field values should be formatted. Only applicable if Fields are specified. /// An optional odata header. Can be used to set the maximum page size using odata.maxpagesize. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise - ///
culture will not be used for formatting. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise
+ /// culture will not be used for formatting. /// Limits the properties returned in the result. /// Specifies the order in which items are returned. The maximum number of expressions is 5. /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get search result successfully. /// A server side error occurred. public virtual async Task GetSearchResultsAsync(string repoId, string searchToken, bool? groupByEntryType = null, bool? refresh = null, IEnumerable fields = null, bool? formatFields = null, string prefer = null, string culture = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -6520,10 +7000,14 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the context hits associated with a search result entry. Given a searchToken, and rowNumber associated with a search entry in the listing, return the context hits for that entry. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + /// Returns the context hits associated with a search result entry. /// + /// + /// - Returns the context hits associated with a search result entry.
+ /// - Given a searchToken, and rowNumber associated with a search entry in the listing, return the context hits for that entry.
+ /// - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + ///
/// The requested repository ID. /// The requested searchToken. /// The search result listing row number to get context hits for. @@ -6533,6 +7017,7 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get search context hits successfully. /// A server side error occurred. public virtual async Task GetSearchContextHitsAsync(string repoId, string searchToken, int rowNumber, string prefer = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -6793,14 +7278,21 @@ private string ConvertToString(object value, CultureInfo cultureInfo) } } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial interface ISimpleSearchesClient { - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Runs a "simple" search operation on the repository. Returns a truncated search result listing. Search result listing may be truncated, depending on number of results. Additionally, searches may time out if they take too long. Use the other search route to run full searches. Optionally returns field values for the entries in the search result listing. Each field name needs to be specified in the request. Maximum limit of 10 field names. If field values are requested, only the first value is returned if it is a multi value field. Null or Empty field values should not be used to determine if a field is assigned to the entry. + /// Runs a "simple" search operation. /// + /// + /// - Runs a "simple" search operation on the repository.
+ /// - Returns a truncated search result listing.
+ /// - Search result listing may be truncated, depending on number of results. Additionally, searches may time out if they take too long. Use the other search route to run full searches.
+ /// - Optionally returns field values for the entries in the search result listing. Each field name needs to be specified in the request. Maximum limit of 10 field names.
+ /// - If field values are requested, only the first value is returned if it is a multi value field.
+ /// - Null or Empty field values should not be used to determine if a field is assigned to the entry. + ///
/// The requested repository ID. /// Limits the properties returned in the result. /// Specifies the order in which items are returned. The maximum number of expressions is 5. @@ -6808,16 +7300,17 @@ public partial interface ISimpleSearchesClient /// Optional array of field names. Field values corresponding to the given field names will be returned for each search result. /// Boolean for if field values should be formatted. Only applicable if Fields are specified. /// The Laserfiche search command to run. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise - ///
culture will not be used for formatting. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise
+ /// culture will not be used for formatting. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Simple search run successfully. /// A server side error occurred. Task CreateSimpleSearchOperationAsync(string repoId, string select = null, string orderby = null, bool? count = null, IEnumerable fields = null, bool? formatFields = null, SimpleSearchRequest request = null, string culture = null, CancellationToken cancellationToken = default(CancellationToken)); } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class SimpleSearchesClient : BaseClient, ISimpleSearchesClient { private HttpClient _httpClient; @@ -6842,10 +7335,17 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() partial void PrepareRequest(HttpClient client, HttpRequestMessage request, StringBuilder urlBuilder); partial void ProcessResponse(HttpClient client, HttpResponseMessage response); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Runs a "simple" search operation on the repository. Returns a truncated search result listing. Search result listing may be truncated, depending on number of results. Additionally, searches may time out if they take too long. Use the other search route to run full searches. Optionally returns field values for the entries in the search result listing. Each field name needs to be specified in the request. Maximum limit of 10 field names. If field values are requested, only the first value is returned if it is a multi value field. Null or Empty field values should not be used to determine if a field is assigned to the entry. + /// Runs a "simple" search operation. /// + /// + /// - Runs a "simple" search operation on the repository.
+ /// - Returns a truncated search result listing.
+ /// - Search result listing may be truncated, depending on number of results. Additionally, searches may time out if they take too long. Use the other search route to run full searches.
+ /// - Optionally returns field values for the entries in the search result listing. Each field name needs to be specified in the request. Maximum limit of 10 field names.
+ /// - If field values are requested, only the first value is returned if it is a multi value field.
+ /// - Null or Empty field values should not be used to determine if a field is assigned to the entry. + ///
/// The requested repository ID. /// Limits the properties returned in the result. /// Specifies the order in which items are returned. The maximum number of expressions is 5. @@ -6853,9 +7353,10 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() /// Optional array of field names. Field values corresponding to the given field names will be returned for each search result. /// Boolean for if field values should be formatted. Only applicable if Fields are specified. /// The Laserfiche search command to run. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise - ///
culture will not be used for formatting. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise
+ /// culture will not be used for formatting. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Simple search run successfully. /// A server side error occurred. public virtual async Task CreateSimpleSearchOperationAsync(string repoId, string select = null, string orderby = null, bool? count = null, IEnumerable fields = null, bool? formatFields = null, SimpleSearchRequest request = null, string culture = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -6898,7 +7399,8 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() { using (var request_ = new HttpRequestMessage()) { - var content_ = new StringContent(Newtonsoft.Json.JsonConvert.SerializeObject(request, _settings.Value)); + var json_ = Newtonsoft.Json.JsonConvert.SerializeObject(request, _settings.Value); + var content_ = new StringContent(json_); content_.Headers.ContentType = MediaTypeHeaderValue.Parse("application/json"); request_.Content = content_; request_.Method = new HttpMethod("POST"); @@ -7003,6 +7505,16 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); } else + if (status_ == 413) + { + var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); + if (objectResponse_.Object == null) + { + throw ApiExceptionExtensions.Create(status_, headers_, null); + } + throw ApiExceptionExtensions.Create(status_, headers_, objectResponse_.Object, null); + } + else if (status_ == 429) { var objectResponse_ = await ReadObjectResponseAsync(response_, headers_, cancellationToken).ConfigureAwait(false); @@ -7128,43 +7640,53 @@ private string ConvertToString(object value, CultureInfo cultureInfo) } } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial interface ITagDefinitionsClient { - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns all tag definitions in the repository. Provide a repository ID and get a paged listing of tag definitions available in the repository. Useful when trying to display all tag definitions available, not only tags assigned to a specific entry. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + /// Returns the tag definitions associated with a repository. /// + /// + /// - Returns all tag definitions in the repository.
+ /// - Provide a repository ID and get a paged listing of tag definitions available in the repository. Useful when trying to display all tag definitions available, not only tags assigned to a specific entry.
+ /// - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + ///
/// The requested repository ID. /// An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. /// Limits the properties returned in the result. /// Specifies the order in which items are returned. The maximum number of expressions is 5. /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get tag definitions successfully. /// A server side error occurred. Task GetTagDefinitionsAsync(string repoId, string prefer = null, string culture = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns a single tag definition. Provide a tag definition ID, and get the single tag definition associated with that ID. Useful when another route provides a minimal amount of details, and more information about the specific tag is needed. Allowed OData query options: Select + /// Returns a single tag definition object. /// + /// + /// - Returns a single tag definition.
+ /// - Provide a tag definition ID, and get the single tag definition associated with that ID. Useful when another route provides a minimal amount of details, and more information about the specific tag is needed.
+ /// - Allowed OData query options: Select + ///
/// The requested repository ID. /// The requested tag definition ID. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. /// Limits the properties returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get tag definition successfully. /// A server side error occurred. Task GetTagDefinitionByIdAsync(string repoId, int tagId, string culture = null, string select = null, CancellationToken cancellationToken = default(CancellationToken)); } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class TagDefinitionsClient : BaseClient, ITagDefinitionsClient { private HttpClient _httpClient; @@ -7189,19 +7711,24 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() partial void PrepareRequest(HttpClient client, HttpRequestMessage request, StringBuilder urlBuilder); partial void ProcessResponse(HttpClient client, HttpResponseMessage response); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns all tag definitions in the repository. Provide a repository ID and get a paged listing of tag definitions available in the repository. Useful when trying to display all tag definitions available, not only tags assigned to a specific entry. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + /// Returns the tag definitions associated with a repository. /// + /// + /// - Returns all tag definitions in the repository.
+ /// - Provide a repository ID and get a paged listing of tag definitions available in the repository. Useful when trying to display all tag definitions available, not only tags assigned to a specific entry.
+ /// - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + ///
/// The requested repository ID. /// An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. /// Limits the properties returned in the result. /// Specifies the order in which items are returned. The maximum number of expressions is 5. /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get tag definitions successfully. /// A server side error occurred. public virtual async Task GetTagDefinitionsAsync(string repoId, string prefer = null, string culture = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -7355,15 +7882,20 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns a single tag definition. Provide a tag definition ID, and get the single tag definition associated with that ID. Useful when another route provides a minimal amount of details, and more information about the specific tag is needed. Allowed OData query options: Select + /// Returns a single tag definition object. /// + /// + /// - Returns a single tag definition.
+ /// - Provide a tag definition ID, and get the single tag definition associated with that ID. Useful when another route provides a minimal amount of details, and more information about the specific tag is needed.
+ /// - Allowed OData query options: Select + ///
/// The requested repository ID. /// The requested tag definition ID. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. /// Limits the properties returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get tag definition successfully. /// A server side error occurred. public virtual async Task GetTagDefinitionByIdAsync(string repoId, int tagId, string culture = null, string select = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -7605,33 +8137,43 @@ private string ConvertToString(object value, CultureInfo cultureInfo) } } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial interface ITasksClient { - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the status of an operation. Provide an operationToken (returned in other asynchronous routes) to get the operation status, progress, and any errors that may have occurred. When the operation is completed, the Location header can be inspected as a link to the modified resources (if relevant). OperationStatus can be one of the following values: NotStarted, InProgress, Completed, or Failed. + /// Returns the status of an operation. /// + /// + /// - Returns the status of an operation.
+ /// - Provide an operationToken (returned in other asynchronous routes) to get the operation status, progress, and any errors that may have occurred. When the operation is completed, the Location header can be inspected as a link to the modified resources (if relevant).
+ /// - OperationStatus can be one of the following values: NotStarted, InProgress, Completed, or Failed. + ///
/// The requested repository ID /// The operation token + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get completed or failed operation status with no result successfully. /// A server side error occurred. Task GetOperationStatusAndProgressAsync(string repoId, string operationToken, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Cancels an operation. Provide an operationToken to cancel the operation, if possible. Should be used if an operation was created in error, or is no longer necessary. Rollbacks must be done manually. For example, if a copy operation is started and is halfway complete when canceled, the client application is responsible for cleaning up the files that were successfully copied before the operation was canceled. + /// Cancels an operation. /// + /// + /// - Cancels an operation.
+ /// - Provide an operationToken to cancel the operation, if possible. Should be used if an operation was created in error, or is no longer necessary.
+ /// - Rollbacks must be done manually. For example, if a copy operation is started and is halfway complete when canceled, the client application is responsible for cleaning up the files that were successfully copied before the operation was canceled. + ///
/// The requested repository ID /// The operation token + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Cancel operation successfully. /// A server side error occurred. Task CancelOperationAsync(string repoId, string operationToken, CancellationToken cancellationToken = default(CancellationToken)); } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class TasksClient : BaseClient, ITasksClient { private HttpClient _httpClient; @@ -7656,12 +8198,17 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() partial void PrepareRequest(HttpClient client, HttpRequestMessage request, StringBuilder urlBuilder); partial void ProcessResponse(HttpClient client, HttpResponseMessage response); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the status of an operation. Provide an operationToken (returned in other asynchronous routes) to get the operation status, progress, and any errors that may have occurred. When the operation is completed, the Location header can be inspected as a link to the modified resources (if relevant). OperationStatus can be one of the following values: NotStarted, InProgress, Completed, or Failed. + /// Returns the status of an operation. /// + /// + /// - Returns the status of an operation.
+ /// - Provide an operationToken (returned in other asynchronous routes) to get the operation status, progress, and any errors that may have occurred. When the operation is completed, the Location header can be inspected as a link to the modified resources (if relevant).
+ /// - OperationStatus can be one of the following values: NotStarted, InProgress, Completed, or Failed. + ///
/// The requested repository ID /// The operation token + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get completed or failed operation status with no result successfully. /// A server side error occurred. public virtual async Task GetOperationStatusAndProgressAsync(string repoId, string operationToken, CancellationToken cancellationToken = default(CancellationToken)) @@ -7811,12 +8358,17 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Cancels an operation. Provide an operationToken to cancel the operation, if possible. Should be used if an operation was created in error, or is no longer necessary. Rollbacks must be done manually. For example, if a copy operation is started and is halfway complete when canceled, the client application is responsible for cleaning up the files that were successfully copied before the operation was canceled. + /// Cancels an operation. /// + /// + /// - Cancels an operation.
+ /// - Provide an operationToken to cancel the operation, if possible. Should be used if an operation was created in error, or is no longer necessary.
+ /// - Rollbacks must be done manually. For example, if a copy operation is started and is halfway complete when canceled, the client application is responsible for cleaning up the files that were successfully copied before the operation was canceled. + ///
/// The requested repository ID /// The operation token + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Cancel operation successfully. /// A server side error occurred. public virtual async Task CancelOperationAsync(string repoId, string operationToken, CancellationToken cancellationToken = default(CancellationToken)) @@ -8044,80 +8596,100 @@ private string ConvertToString(object value, CultureInfo cultureInfo) } } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial interface ITemplateDefinitionsClient { - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns all template definitions (including field definitions) in the repository. If a template name query parameter is given, then a single template definition is returned. Provide a repository ID, and get a paged listing of template definitions available in the repository. Useful when trying to find a list of all template definitions available, rather than a specific one. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + /// Returns the template definitions associated with a repository. /// + /// + /// - Returns all template definitions (including field definitions) in the repository. If a template name query parameter is given, then a single template definition is returned.
+ /// - Provide a repository ID, and get a paged listing of template definitions available in the repository. Useful when trying to find a list of all template definitions available, rather than a specific one.
+ /// - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + ///
/// The requested repository ID. /// An optional query parameter. Can be used to get a single template definition using the template name. /// An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. /// Limits the properties returned in the result. /// Specifies the order in which items are returned. The maximum number of expressions is 5. /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get template definitions successfully. /// A server side error occurred. Task GetTemplateDefinitionsAsync(string repoId, string templateName = null, string prefer = null, string culture = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns a single template definition (including field definitions, if relevant). Provide a template definition ID, and get the single template definition associated with that ID. Useful when a route provides a minimal amount of details, and more information about the specific template is needed. Allowed OData query options: Select + /// Returns a single template definition object. /// + /// + /// - Returns a single template definition (including field definitions, if relevant).
+ /// - Provide a template definition ID, and get the single template definition associated with that ID. Useful when a route provides a minimal amount of details, and more information about the specific template is needed.
+ /// - Allowed OData query options: Select + ///
/// The requested repository ID. /// The requested template definition ID. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. /// Limits the properties returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get template definition successfully. /// A server side error occurred. Task GetTemplateDefinitionByIdAsync(string repoId, int templateId, string culture = null, string select = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the field definitions assigned to a template definition. Provide a template definition ID, and get a paged listing of the field definitions assigned to that template. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + /// Returns the field definitions assigned to a template definition (by template definition ID). /// + /// + /// - Returns the field definitions assigned to a template definition.
+ /// - Provide a template definition ID, and get a paged listing of the field definitions assigned to that template.
+ /// - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + ///
/// The requested repository ID. /// The requested template definition ID. /// An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. /// Limits the properties returned in the result. /// Specifies the order in which items are returned. The maximum number of expressions is 5. /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get template field definitions successfully. /// A server side error occurred. Task GetTemplateFieldDefinitionsAsync(string repoId, int templateId, string prefer = null, string culture = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the field definitions assigned to a template definition. Provide a template definition name, and get a paged listing of the field definitions assigned to that template. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + /// Returns the field definitions assigned to a template definition (by template definition name). /// + /// + /// - Returns the field definitions assigned to a template definition.
+ /// - Provide a template definition name, and get a paged listing of the field definitions assigned to that template.
+ /// - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + ///
/// The requested repository ID. /// A required query parameter for the requested template name. /// An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. /// Limits the properties returned in the result. /// Specifies the order in which items are returned. The maximum number of expressions is 5. /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get template field definitions successfully. /// A server side error occurred. Task GetTemplateFieldDefinitionsByTemplateNameAsync(string repoId, string templateName, string prefer = null, string culture = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)); } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class TemplateDefinitionsClient : BaseClient, ITemplateDefinitionsClient { private HttpClient _httpClient; @@ -8142,20 +8714,25 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() partial void PrepareRequest(HttpClient client, HttpRequestMessage request, StringBuilder urlBuilder); partial void ProcessResponse(HttpClient client, HttpResponseMessage response); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns all template definitions (including field definitions) in the repository. If a template name query parameter is given, then a single template definition is returned. Provide a repository ID, and get a paged listing of template definitions available in the repository. Useful when trying to find a list of all template definitions available, rather than a specific one. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + /// Returns the template definitions associated with a repository. /// + /// + /// - Returns all template definitions (including field definitions) in the repository. If a template name query parameter is given, then a single template definition is returned.
+ /// - Provide a repository ID, and get a paged listing of template definitions available in the repository. Useful when trying to find a list of all template definitions available, rather than a specific one.
+ /// - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + ///
/// The requested repository ID. /// An optional query parameter. Can be used to get a single template definition using the template name. /// An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. /// Limits the properties returned in the result. /// Specifies the order in which items are returned. The maximum number of expressions is 5. /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get template definitions successfully. /// A server side error occurred. public virtual async Task GetTemplateDefinitionsAsync(string repoId, string templateName = null, string prefer = null, string culture = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -8313,15 +8890,20 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns a single template definition (including field definitions, if relevant). Provide a template definition ID, and get the single template definition associated with that ID. Useful when a route provides a minimal amount of details, and more information about the specific template is needed. Allowed OData query options: Select + /// Returns a single template definition object. /// + /// + /// - Returns a single template definition (including field definitions, if relevant).
+ /// - Provide a template definition ID, and get the single template definition associated with that ID. Useful when a route provides a minimal amount of details, and more information about the specific template is needed.
+ /// - Allowed OData query options: Select + ///
/// The requested repository ID. /// The requested template definition ID. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. /// Limits the properties returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get template definition successfully. /// A server side error occurred. public virtual async Task GetTemplateDefinitionByIdAsync(string repoId, int templateId, string culture = null, string select = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -8460,20 +9042,25 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the field definitions assigned to a template definition. Provide a template definition ID, and get a paged listing of the field definitions assigned to that template. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + /// Returns the field definitions assigned to a template definition (by template definition ID). /// + /// + /// - Returns the field definitions assigned to a template definition.
+ /// - Provide a template definition ID, and get a paged listing of the field definitions assigned to that template.
+ /// - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + ///
/// The requested repository ID. /// The requested template definition ID. /// An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. /// Limits the properties returned in the result. /// Specifies the order in which items are returned. The maximum number of expressions is 5. /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get template field definitions successfully. /// A server side error occurred. public virtual async Task GetTemplateFieldDefinitionsAsync(string repoId, int templateId, string prefer = null, string culture = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -8631,20 +9218,25 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Returns the field definitions assigned to a template definition. Provide a template definition name, and get a paged listing of the field definitions assigned to that template. Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + /// Returns the field definitions assigned to a template definition (by template definition name). /// + /// + /// - Returns the field definitions assigned to a template definition.
+ /// - Provide a template definition name, and get a paged listing of the field definitions assigned to that template.
+ /// - Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. + ///
/// The requested repository ID. /// A required query parameter for the requested template name. /// An optional OData header. Can be used to set the maximum page size using odata.maxpagesize. - /// An optional query parameter used to indicate the locale that should be used for formatting. - ///
The value should be a standard language tag. + /// An optional query parameter used to indicate the locale that should be used for formatting.
+ /// The value should be a standard language tag. /// Limits the properties returned in the result. /// Specifies the order in which items are returned. The maximum number of expressions is 5. /// Limits the number of items returned from a collection. /// Excludes the specified number of items of the queried collection from the result. /// Indicates whether the total count of items within a collection are returned in the result. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Get template field definitions successfully. /// A server side error occurred. public virtual async Task GetTemplateFieldDefinitionsByTemplateNameAsync(string repoId, string templateName, string prefer = null, string culture = null, string select = null, string orderby = null, int? top = null, int? skip = null, bool? count = null, CancellationToken cancellationToken = default(CancellationToken)) @@ -8902,35 +9494,51 @@ private string ConvertToString(object value, CultureInfo cultureInfo) } } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial interface IServerSessionClient { - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Deprecated. Invalidates the server session. Acts as a "logout" operation, and invalidates the session associated with the provided access token. This method should be used when the client wants to clean up the current session. Only available in Laserfiche Cloud. + /// Deprecated. Do not call this api. /// + /// + /// - Deprecated.
+ /// - Invalidates the server session.
+ /// - Acts as a "logout" operation, and invalidates the session associated with the provided access token. This method should be used when the client wants to clean up the current session.
+ /// - Only available in Laserfiche Cloud. + ///
/// The requested repository ID. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Invalidate the server session successfully. /// A server side error occurred. [Obsolete] Task InvalidateServerSessionAsync(string repoId, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Deprecated. Refreshes the session associated with the access token. This is only necessary if you want to keep the same session alive, otherwise a new session will be automatically created when the session expires. When a client application wants to keep a session alive that has been idle for an hour, this route can be used to refresh the expiration timer associated with the access token. Only available in Laserfiche Cloud. + /// Deprecated. Do not call this api. /// + /// + /// - Deprecated.
+ /// - Refreshes the session associated with the access token. This is only necessary if you want to keep the same session alive, otherwise a new session will be automatically created when the session expires.
+ /// - When a client application wants to keep a session alive that has been idle for an hour, this route can be used to refresh the expiration timer associated with the access token.
+ /// - Only available in Laserfiche Cloud. + ///
/// The requested repository ID. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Refresh the session successfully. /// A server side error occurred. [Obsolete] Task RefreshServerSessionAsync(string repoId, CancellationToken cancellationToken = default(CancellationToken)); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Deprecated. This function is a no-op, always returns 200. Only available in Laserfiche Cloud. + /// Deprecated. Do not call this api. /// + /// + /// - Deprecated. This function is a no-op, always returns 200.
+ /// - Only available in Laserfiche Cloud. + ///
/// The requested repository ID. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Create the session successfully. /// A server side error occurred. [Obsolete] @@ -8938,7 +9546,7 @@ public partial interface IServerSessionClient } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ServerSessionClient : BaseClient, IServerSessionClient { private HttpClient _httpClient; @@ -8963,11 +9571,17 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() partial void PrepareRequest(HttpClient client, HttpRequestMessage request, StringBuilder urlBuilder); partial void ProcessResponse(HttpClient client, HttpResponseMessage response); - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Deprecated. Invalidates the server session. Acts as a "logout" operation, and invalidates the session associated with the provided access token. This method should be used when the client wants to clean up the current session. Only available in Laserfiche Cloud. + /// Deprecated. Do not call this api. /// + /// + /// - Deprecated.
+ /// - Invalidates the server session.
+ /// - Acts as a "logout" operation, and invalidates the session associated with the provided access token. This method should be used when the client wants to clean up the current session.
+ /// - Only available in Laserfiche Cloud. + ///
/// The requested repository ID. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Invalidate the server session successfully. /// A server side error occurred. [Obsolete] @@ -9095,11 +9709,17 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Deprecated. Refreshes the session associated with the access token. This is only necessary if you want to keep the same session alive, otherwise a new session will be automatically created when the session expires. When a client application wants to keep a session alive that has been idle for an hour, this route can be used to refresh the expiration timer associated with the access token. Only available in Laserfiche Cloud. + /// Deprecated. Do not call this api. /// + /// + /// - Deprecated.
+ /// - Refreshes the session associated with the access token. This is only necessary if you want to keep the same session alive, otherwise a new session will be automatically created when the session expires.
+ /// - When a client application wants to keep a session alive that has been idle for an hour, this route can be used to refresh the expiration timer associated with the access token.
+ /// - Only available in Laserfiche Cloud. + ///
/// The requested repository ID. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Refresh the session successfully. /// A server side error occurred. [Obsolete] @@ -9227,11 +9847,15 @@ private Newtonsoft.Json.JsonSerializerSettings CreateSerializerSettings() } } - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// - /// Deprecated. This function is a no-op, always returns 200. Only available in Laserfiche Cloud. + /// Deprecated. Do not call this api. /// + /// + /// - Deprecated. This function is a no-op, always returns 200.
+ /// - Only available in Laserfiche Cloud. + ///
/// The requested repository ID. + /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// Create the session successfully. /// A server side error occurred. [Obsolete] @@ -9432,7 +10056,7 @@ private string ConvertToString(object value, CultureInfo cultureInfo) } } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class CreateEntryResult { [Newtonsoft.Json.JsonProperty("operations", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] @@ -9449,7 +10073,7 @@ public partial class CreateEntryResult /// /// The results of each operation needed in order to create the electronic document with optional template and fields. /// - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class CreateEntryOperations { [Newtonsoft.Json.JsonProperty("entryCreate", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] @@ -9475,7 +10099,7 @@ public partial class CreateEntryOperations /// /// The result of trying to create the entry. /// - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class EntryCreate { /// @@ -9492,7 +10116,7 @@ public partial class EntryCreate } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class APIServerException { /// @@ -9531,12 +10155,12 @@ public partial class APIServerException [Newtonsoft.Json.JsonProperty("errorSource", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] public string ErrorSource { get; set; } - private IDictionary _additionalProperties = new Dictionary(); + private IDictionary _additionalProperties; [Newtonsoft.Json.JsonExtensionData] public IDictionary AdditionalProperties { - get { return _additionalProperties; } + get { return _additionalProperties ?? (_additionalProperties = new Dictionary()); } set { _additionalProperties = value; } } @@ -9545,7 +10169,7 @@ public IDictionary AdditionalProperties /// /// The result of trying to create the electronic document. /// - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class SetEdoc { /// @@ -9559,7 +10183,7 @@ public partial class SetEdoc /// /// The result of trying to assign a template to the entry. /// - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class SetTemplate { /// @@ -9579,7 +10203,7 @@ public partial class SetTemplate /// /// The result of trying to assign fields to the entry. /// - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class SetFields { /// @@ -9599,7 +10223,7 @@ public partial class SetFields /// /// The result of trying to assign fields to the entry. /// - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class SetTags { /// @@ -9619,7 +10243,7 @@ public partial class SetTags /// /// The result of trying to assign a entry link to the entry. /// - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class SetLinks { /// @@ -9636,7 +10260,7 @@ public partial class SetLinks } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public abstract partial class IHeaderDictionary { [Newtonsoft.Json.JsonProperty("Item", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] @@ -9917,7 +10541,7 @@ public abstract partial class IHeaderDictionary /// /// The request body containing fields that will be assigned to the entry. /// - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class FieldToUpdate { /// @@ -9928,7 +10552,7 @@ public partial class FieldToUpdate } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ValueToUpdate { /// @@ -9945,7 +10569,7 @@ public partial class ValueToUpdate } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class LinkToUpdate { /// @@ -9968,7 +10592,7 @@ public partial class LinkToUpdate } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class PostEntryWithEdocMetadataRequest { /// @@ -9991,7 +10615,7 @@ public partial class PostEntryWithEdocMetadataRequest /// /// The request body containing fields that will be assigned to the entry. /// - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class PutFieldValsRequest : SimpleImportMetadata { /// @@ -10002,27 +10626,10 @@ public partial class PutFieldValsRequest : SimpleImportMetadata } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] - public partial class SimpleImportMetadata - { - /// - /// The fields that will be assigned to the entry. - /// - [Newtonsoft.Json.JsonProperty("fields", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] - public IDictionary Fields { get; set; } - - /// - /// The tags that will be assigned to the entry. - /// - [Newtonsoft.Json.JsonProperty("tags", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] - public ICollection Tags { get; set; } - - } - /// /// A wrapper around the ODataValue with extra odata.nextLink and odata.count. /// - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ODataValueContextOfListOfAttribute : ODataValueOfListOfAttribute { /// @@ -10039,7 +10646,7 @@ public partial class ODataValueContextOfListOfAttribute : ODataValueOfListOfAttr } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ODataValueOfListOfAttribute { [Newtonsoft.Json.JsonProperty("value", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] @@ -10047,7 +10654,7 @@ public partial class ODataValueOfListOfAttribute } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class Attribute { [Newtonsoft.Json.JsonProperty("key", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] @@ -10058,7 +10665,7 @@ public partial class Attribute } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class WFieldInfo { /// @@ -10099,8 +10706,8 @@ public partial class WFieldInfo public int Length { get; set; } /// - /// The default value of the field for new entries that are assigned - ///
to a template the represented field is a member of. + /// The default value of the field for new entries that are assigned
+ /// to a template the represented field is a member of. ///
[Newtonsoft.Json.JsonProperty("defaultValue", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] public string DefaultValue { get; set; } @@ -10112,8 +10719,8 @@ public partial class WFieldInfo public bool IsMultiValue { get; set; } /// - /// A boolean indicating if the represented field must have a value set - ///
on entries assigned to a template that the field is a member of. + /// A boolean indicating if the represented field must have a value set
+ /// on entries assigned to a template that the field is a member of. ///
[Newtonsoft.Json.JsonProperty("isRequired", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] public bool IsRequired { get; set; } @@ -10125,8 +10732,8 @@ public partial class WFieldInfo public string Constraint { get; set; } /// - /// The error string that will be returned when the field constraint - ///
is violated when setting a value for this field. + /// The error string that will be returned when the field constraint
+ /// is violated when setting a value for this field. ///
[Newtonsoft.Json.JsonProperty("constraintError", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] public string ConstraintError { get; set; } @@ -10145,16 +10752,16 @@ public partial class WFieldInfo public WFieldFormat Format { get; set; } /// - /// The name of the currency that will be using when formatting - ///
the represented field when the Format property is set to the - ///
Currency member of the WFieldFormat enumeration. + /// The name of the currency that will be using when formatting
+ /// the represented field when the Format property is set to the
+ /// Currency member of the WFieldFormat enumeration. ///
[Newtonsoft.Json.JsonProperty("currency", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] public string Currency { get; set; } /// - /// The custom format pattern for fields that are configured to - ///
use a custom format. + /// The custom format pattern for fields that are configured to
+ /// use a custom format. ///
[Newtonsoft.Json.JsonProperty("formatPattern", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] public string FormatPattern { get; set; } @@ -10164,7 +10771,7 @@ public partial class WFieldInfo /// /// Enumeration of Laserfiche template field types. /// - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public enum WFieldType { @@ -10200,7 +10807,7 @@ public enum WFieldType /// /// Enumeration of Laserfiche template field formats. /// - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public enum WFieldFormat { @@ -10245,7 +10852,7 @@ public enum WFieldFormat /// /// A wrapper around the ODataValue with extra odata.nextLink and odata.count. /// - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ODataValueContextOfIListOfWFieldInfo : ODataValueOfIListOfWFieldInfo { /// @@ -10262,7 +10869,7 @@ public partial class ODataValueContextOfIListOfWFieldInfo : ODataValueOfIListOfW } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ODataValueOfIListOfWFieldInfo { [Newtonsoft.Json.JsonProperty("value", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] @@ -10273,7 +10880,7 @@ public partial class ODataValueOfIListOfWFieldInfo /// /// A wrapper around the ODataValue with extra odata.nextLink and odata.count. /// - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ODataValueContextOfIListOfEntryLinkTypeInfo : ODataValueOfIListOfEntryLinkTypeInfo { /// @@ -10290,7 +10897,7 @@ public partial class ODataValueContextOfIListOfEntryLinkTypeInfo : ODataValueOfI } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ODataValueOfIListOfEntryLinkTypeInfo { [Newtonsoft.Json.JsonProperty("value", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] @@ -10298,7 +10905,7 @@ public partial class ODataValueOfIListOfEntryLinkTypeInfo } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class EntryLinkTypeInfo { /// @@ -10327,7 +10934,7 @@ public partial class EntryLinkTypeInfo } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public abstract partial class Entry { /// @@ -10435,7 +11042,7 @@ public abstract partial class Entry } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public enum EntryType { @@ -10453,7 +11060,7 @@ public enum EntryType } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class EntryFieldValue { /// @@ -10501,18 +11108,18 @@ public partial class EntryFieldValue } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class RecordSeries : Entry { } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class Document : Entry { /// - /// The size of the electronic document attached to the represented document, - ///
if there is one, in bytes. + /// The size of the electronic document attached to the represented document,
+ /// if there is one, in bytes. ///
[Newtonsoft.Json.JsonProperty("elecDocumentSize", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] public long ElecDocumentSize { get; set; } @@ -10567,13 +11174,13 @@ public partial class Document : Entry } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class Edoc { } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class Shortcut : Entry { /// @@ -10597,19 +11204,19 @@ public partial class Shortcut : Entry } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class Folder : Entry { /// - /// A boolean indicating if the folder that this instance represents is known - ///
to be a record folder. + /// A boolean indicating if the folder that this instance represents is known
+ /// to be a record folder. ///
[Newtonsoft.Json.JsonProperty("isRecordFolder", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] public bool IsRecordFolder { get; set; } /// - /// A boolean indicating if the folder that this instance represents is known - ///
to directly or indirectly under a record series in the repository. + /// A boolean indicating if the folder that this instance represents is known
+ /// to directly or indirectly under a record series in the repository. ///
[Newtonsoft.Json.JsonProperty("isUnderRecordSeries", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] public bool IsUnderRecordSeries { get; set; } @@ -10622,7 +11229,7 @@ public partial class Folder : Entry } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class FindEntryResult { /// @@ -10639,7 +11246,7 @@ public partial class FindEntryResult } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class AcceptedOperation { /// @@ -10650,7 +11257,7 @@ public partial class AcceptedOperation } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class DeleteEntryWithAuditReason { /// @@ -10667,7 +11274,7 @@ public partial class DeleteEntryWithAuditReason } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class PatchEntryRequest { /// @@ -10687,7 +11294,7 @@ public partial class PatchEntryRequest /// /// A wrapper around the ODataValue with extra odata.nextLink and odata.count. /// - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ODataValueContextOfIListOfEntry : ODataValueOfIListOfEntry { /// @@ -10704,7 +11311,7 @@ public partial class ODataValueContextOfIListOfEntry : ODataValueOfIListOfEntry } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ODataValueOfIListOfEntry { [Newtonsoft.Json.JsonProperty("value", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] @@ -10715,7 +11322,7 @@ public partial class ODataValueOfIListOfEntry /// /// A wrapper around the ODataValue with extra odata.nextLink and odata.count. /// - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ODataValueContextOfIListOfFieldValue : ODataValueOfIListOfFieldValue { /// @@ -10732,7 +11339,7 @@ public partial class ODataValueContextOfIListOfFieldValue : ODataValueOfIListOfF } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ODataValueOfIListOfFieldValue { [Newtonsoft.Json.JsonProperty("value", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] @@ -10740,7 +11347,7 @@ public partial class ODataValueOfIListOfFieldValue } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class FieldValue : EntryFieldValue { /// @@ -10754,7 +11361,7 @@ public partial class FieldValue : EntryFieldValue /// /// A wrapper around the ODataValue with extra odata.nextLink and odata.count. /// - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ODataValueContextOfIListOfWTagInfo : ODataValueOfIListOfWTagInfo { /// @@ -10771,7 +11378,7 @@ public partial class ODataValueContextOfIListOfWTagInfo : ODataValueOfIListOfWTa } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ODataValueOfIListOfWTagInfo { [Newtonsoft.Json.JsonProperty("value", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] @@ -10779,7 +11386,7 @@ public partial class ODataValueOfIListOfWTagInfo } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class WTagInfo { /// @@ -10807,8 +11414,8 @@ public partial class WTagInfo public string Description { get; set; } /// - /// A boolean indicating whether or not the tag definition is classified - ///
as a security tag (true) or an informational tag (false). + /// A boolean indicating whether or not the tag definition is classified
+ /// as a security tag (true) or an informational tag (false). ///
[Newtonsoft.Json.JsonProperty("isSecure", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] public bool IsSecure { get; set; } @@ -10821,7 +11428,7 @@ public partial class WTagInfo } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class Watermark { /// @@ -10856,15 +11463,15 @@ public partial class Watermark public bool IsWatermarkMandatory { get; set; } /// - /// The intensity of the watermark associated with the tag definition. Valid value - ///
ranges from 0 to 100, with -1 as the default values. + /// The intensity of the watermark associated with the tag definition. Valid value
+ /// ranges from 0 to 100, with -1 as the default values. ///
[Newtonsoft.Json.JsonProperty("watermarkIntensity", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] public int WatermarkIntensity { get; set; } } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public enum WatermarkPosition { @@ -10897,7 +11504,7 @@ public enum WatermarkPosition } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class PutTagRequest { /// @@ -10908,7 +11515,7 @@ public partial class PutTagRequest } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ODataValueOfIListOfWEntryLinkInfo { [Newtonsoft.Json.JsonProperty("value", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] @@ -10916,7 +11523,7 @@ public partial class ODataValueOfIListOfWEntryLinkInfo } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class WEntryLinkInfo { /// @@ -10999,7 +11606,7 @@ public partial class WEntryLinkInfo } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class PutLinksRequest { /// @@ -11025,7 +11632,7 @@ public partial class PutLinksRequest /// /// A wrapper around the ODataValue with extra odata.nextLink and odata.count. /// - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ODataValueContextOfIListOfWEntryLinkInfo : ODataValueOfIListOfWEntryLinkInfo { /// @@ -11042,7 +11649,7 @@ public partial class ODataValueContextOfIListOfWEntryLinkInfo : ODataValueOfILis } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class PostEntryChildrenRequest { /// @@ -11078,7 +11685,7 @@ public partial class PostEntryChildrenRequest } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public enum PostEntryChildrenEntryType { @@ -11090,7 +11697,7 @@ public enum PostEntryChildrenEntryType } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class CopyAsyncRequest { /// @@ -11113,7 +11720,7 @@ public partial class CopyAsyncRequest } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ODataValueOfBoolean { [Newtonsoft.Json.JsonProperty("value", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] @@ -11121,7 +11728,7 @@ public partial class ODataValueOfBoolean } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class GetEdocWithAuditReasonRequest { /// @@ -11138,7 +11745,7 @@ public partial class GetEdocWithAuditReasonRequest } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class GetDynamicFieldLogicValueRequest { /// @@ -11155,7 +11762,7 @@ public partial class GetDynamicFieldLogicValueRequest } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class PutTemplateRequest { /// @@ -11172,7 +11779,7 @@ public partial class PutTemplateRequest } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class RepositoryInfo { /// @@ -11195,7 +11802,7 @@ public partial class RepositoryInfo } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class AuditReasons { /// @@ -11212,7 +11819,7 @@ public partial class AuditReasons } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class WAuditReason { /// @@ -11229,7 +11836,7 @@ public partial class WAuditReason } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class AdvancedSearchRequest { /// @@ -11253,7 +11860,7 @@ public partial class AdvancedSearchRequest } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public enum FuzzyType { @@ -11268,7 +11875,7 @@ public enum FuzzyType } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class OperationProgress { /// @@ -11328,7 +11935,7 @@ public partial class OperationProgress } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public enum OperationStatus { @@ -11349,7 +11956,7 @@ public enum OperationStatus } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class OperationErrorItem { /// @@ -11369,7 +11976,7 @@ public partial class OperationErrorItem /// /// A wrapper around the ODataValue with extra odata.nextLink and odata.count. /// - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ODataValueContextOfIListOfContextHit : ODataValueOfIListOfContextHit { /// @@ -11386,7 +11993,7 @@ public partial class ODataValueContextOfIListOfContextHit : ODataValueOfIListOfC } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ODataValueOfIListOfContextHit { [Newtonsoft.Json.JsonProperty("value", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] @@ -11394,7 +12001,7 @@ public partial class ODataValueOfIListOfContextHit } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ContextHit { [Newtonsoft.Json.JsonProperty("hitType", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] @@ -11490,7 +12097,7 @@ public partial class ContextHit /// /// The type of context hit. /// - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public enum HitType { @@ -11544,7 +12151,7 @@ public enum HitType } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class SimpleSearchRequest { /// @@ -11558,7 +12165,7 @@ public partial class SimpleSearchRequest /// /// A wrapper around the ODataValue with extra odata.nextLink and odata.count. /// - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ODataValueContextOfIListOfWTemplateInfo : ODataValueOfIListOfWTemplateInfo { /// @@ -11575,7 +12182,7 @@ public partial class ODataValueContextOfIListOfWTemplateInfo : ODataValueOfIList } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ODataValueOfIListOfWTemplateInfo { [Newtonsoft.Json.JsonProperty("value", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] @@ -11583,7 +12190,7 @@ public partial class ODataValueOfIListOfWTemplateInfo } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class WTemplateInfo { /// @@ -11624,7 +12231,7 @@ public partial class WTemplateInfo } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class LFColor { [Newtonsoft.Json.JsonProperty("a", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] @@ -11644,7 +12251,7 @@ public partial class LFColor /// /// A wrapper around the ODataValue with extra odata.nextLink and odata.count. /// - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ODataValueContextOfIListOfTemplateFieldInfo : ODataValueOfIListOfTemplateFieldInfo { /// @@ -11661,7 +12268,7 @@ public partial class ODataValueContextOfIListOfTemplateFieldInfo : ODataValueOfI } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ODataValueOfIListOfTemplateFieldInfo { [Newtonsoft.Json.JsonProperty("value", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] @@ -11669,7 +12276,7 @@ public partial class ODataValueOfIListOfTemplateFieldInfo } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class TemplateFieldInfo : WFieldInfo { /// @@ -11692,19 +12299,19 @@ public partial class TemplateFieldInfo : WFieldInfo } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class Rule { /// - /// The IDs of the parent fields in the template according to the - ///
form logic rule. + /// The IDs of the parent fields in the template according to the
+ /// form logic rule. ///
[Newtonsoft.Json.JsonProperty("ancestors", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] public ICollection Ancestors { get; set; } } - [GeneratedCode("NJsonSchema", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class ODataValueOfDateTime { [Newtonsoft.Json.JsonProperty("value", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] @@ -11712,7 +12319,24 @@ public partial class ODataValueOfDateTime } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NJsonSchema", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class SimpleImportMetadata + { + /// + /// The fields that will be assigned to the entry. + /// + [Newtonsoft.Json.JsonProperty("fields", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public IDictionary Fields { get; set; } + + /// + /// The tags that will be assigned to the entry. + /// + [Newtonsoft.Json.JsonProperty("tags", Required = Newtonsoft.Json.Required.Default, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public ICollection Tags { get; set; } + + } + + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class FileParameter { public FileParameter(Stream data) @@ -11739,7 +12363,7 @@ public FileParameter(Stream data, string fileName, string contentType) public string ContentType { get; private set; } } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class FileResponse : IDisposable { private IDisposable _client; @@ -11775,7 +12399,7 @@ public void Dispose() } } - [GeneratedCode("NSwag", "13.15.10.0 (NJsonSchema v10.6.10.0 (Newtonsoft.Json v11.0.0.0))")] + [GeneratedCode("NSwag", "13.19.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")] public partial class HttpResponseHead { public int StatusCode { get; private set; } @@ -11789,7 +12413,7 @@ public HttpResponseHead(int statusCode, IReadOnlyDictionary : HttpResponseHead { public TResult Result { get; private set; } @@ -11805,10 +12429,13 @@ public HttpResponseHead(int statusCode, IReadOnlyDictionary