diff --git a/.fern/metadata.json b/.fern/metadata.json index dc4b198..9ba1211 100644 --- a/.fern/metadata.json +++ b/.fern/metadata.json @@ -5,9 +5,9 @@ "generatorConfig": { "moduleName": "CloudPDF" }, - "originGitCommit": "08782e4eef6cd6ccce4b6a6883408d9915a2d7c4", + "originGitCommit": "b0888bd6ca83627cb07ea05c440e35c183cebbd0", "originGitCommitIsDirty": false, "invokedBy": "ci", - "requestedVersion": "3.0.0.alpha.11", + "requestedVersion": "3.0.0.alpha.12", "ciProvider": "github" } \ No newline at end of file diff --git a/cloudpdf-generation.json b/cloudpdf-generation.json index cb6aed2..14a424d 100644 --- a/cloudpdf-generation.json +++ b/cloudpdf-generation.json @@ -1,12 +1,12 @@ { "language": "ruby", - "canonicalVersion": "3.0.0-next.11", - "sdkVersion": "3.0.0.alpha.11", + "canonicalVersion": "3.0.0-next.12", + "sdkVersion": "3.0.0.alpha.12", "source": { "repository": "embedpdf/embed-pdf-viewer", "openapi": "cloudpdf/contract/openapi.json", - "openapiSha256": "7bc0eea37724b3e359b0437edc3102b137e3d3f499293c89bb2b3293c6e3b614", - "gitCommit": "08782e4eef6cd6ccce4b6a6883408d9915a2d7c4", + "openapiSha256": "501ec54f2f28089dc8a3cf3a8d2ff3ade44c6c35d47977a3dfa47465fb83a049", + "gitCommit": "b0888bd6ca83627cb07ea05c440e35c183cebbd0", "gitCommitIsDirty": false }, "fern": { diff --git a/lib/CloudPDF/doc/annotations/client.rb b/lib/CloudPDF/doc/annotations/client.rb index 5365b46..ab39cac 100644 --- a/lib/CloudPDF/doc/annotations/client.rb +++ b/lib/CloudPDF/doc/annotations/client.rb @@ -262,6 +262,112 @@ def update(request_options: {}, **params) raise error_class.new(response.body, code: code) end end + + # @param request_options [Hash] + # @param params [CloudPDF::Types::DocAnnotationsExportAppearanceRequest] + # @option request_options [String] :base_url + # @option request_options [Hash{String => Object}] :additional_headers + # @option request_options [Hash{String => Object}] :additional_query_parameters + # @option request_options [Hash{String => Object}] :additional_body_parameters + # @option request_options [Integer] :timeout_in_seconds + # @option params [String] :doc_id + # @option params [String] :layer_name + # @option params [Integer] :pon + # @option params [String, nil] :document_password + # + # @example + # client.doc.annotations.export_appearance( + # doc_id: "docId", + # layer_name: "layerName", + # pon: 1, + # request: { + # string: { + # key: "value" + # } + # } + # ) + # + # @return [untyped] + def export_appearance(request_options: {}, **params) + params = CloudPDF::Internal::Types::Utils.normalize_keys(params) + path_param_names = %i[doc_id layer_name pon] + body_params = params.except(*path_param_names) + + headers = {} + headers["X-Document-Password"] = params[:document_password] if params[:document_password] + + request = CloudPDF::Internal::JSON::Request.new( + base_url: request_options[:base_url], + method: "POST", + path: "v1/docs/#{URI.encode_uri_component(params[:doc_id].to_s)}/layers/#{URI.encode_uri_component(params[:layer_name].to_s)}/annotations/pages/#{URI.encode_uri_component(params[:pon].to_s)}/items/appearance", + headers: headers, + body: body_params, + request_options: request_options + ) + begin + response = @client.send(request) + rescue Net::HTTPRequestTimeout + raise CloudPDF::Errors::TimeoutError + end + code = response.code.to_i + return if code.between?(200, 299) + + error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code) + raise error_class.new(response.body, code: code) + end + + # @param request_options [Hash] + # @param params [CloudPDF::Types::DocAnnotationsFlattenRequest] + # @option request_options [String] :base_url + # @option request_options [Hash{String => Object}] :additional_headers + # @option request_options [Hash{String => Object}] :additional_query_parameters + # @option request_options [Hash{String => Object}] :additional_body_parameters + # @option request_options [Integer] :timeout_in_seconds + # @option params [String] :doc_id + # @option params [String] :layer_name + # @option params [Integer] :pon + # @option params [String, nil] :document_password + # + # @example + # client.doc.annotations.flatten( + # doc_id: "docId", + # layer_name: "layerName", + # pon: 1, + # request: { + # key: "value" + # } + # ) + # + # @return [CloudPDF::Types::DocAnnotationsFlatten200Response] + def flatten(request_options: {}, **params) + params = CloudPDF::Internal::Types::Utils.normalize_keys(params) + path_param_names = %i[doc_id layer_name pon] + body_params = params.except(*path_param_names) + + headers = {} + headers["X-Document-Password"] = params[:document_password] if params[:document_password] + + request = CloudPDF::Internal::JSON::Request.new( + base_url: request_options[:base_url], + method: "POST", + path: "v1/docs/#{URI.encode_uri_component(params[:doc_id].to_s)}/layers/#{URI.encode_uri_component(params[:layer_name].to_s)}/annotations/pages/#{URI.encode_uri_component(params[:pon].to_s)}/items/flatten", + headers: headers, + body: body_params, + request_options: request_options + ) + begin + response = @client.send(request) + rescue Net::HTTPRequestTimeout + raise CloudPDF::Errors::TimeoutError + end + code = response.code.to_i + if code.between?(200, 299) + CloudPDF::Types::DocAnnotationsFlatten200Response.load(response.body) + else + error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code) + raise error_class.new(response.body, code: code) + end + end end end end diff --git a/lib/CloudPDF/doc/annotations/types/export_appearance_annotations_request.rb b/lib/CloudPDF/doc/annotations/types/export_appearance_annotations_request.rb new file mode 100644 index 0000000..a2dabb0 --- /dev/null +++ b/lib/CloudPDF/doc/annotations/types/export_appearance_annotations_request.rb @@ -0,0 +1,21 @@ +# frozen_string_literal: true + +module CloudPDF + module Doc + module Annotations + module Types + class ExportAppearanceAnnotationsRequest < Internal::Types::Model + field :doc_id, -> { String }, optional: false, nullable: false, api_name: "docId" + + field :layer_name, -> { String }, optional: false, nullable: false, api_name: "layerName" + + field :pon, -> { Integer }, optional: false, nullable: false + + field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password" + + field :body, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false + end + end + end + end +end diff --git a/lib/CloudPDF/doc/annotations/types/flatten_annotations_request.rb b/lib/CloudPDF/doc/annotations/types/flatten_annotations_request.rb new file mode 100644 index 0000000..1ab5914 --- /dev/null +++ b/lib/CloudPDF/doc/annotations/types/flatten_annotations_request.rb @@ -0,0 +1,21 @@ +# frozen_string_literal: true + +module CloudPDF + module Doc + module Annotations + module Types + class FlattenAnnotationsRequest < Internal::Types::Model + field :doc_id, -> { String }, optional: false, nullable: false, api_name: "docId" + + field :layer_name, -> { String }, optional: false, nullable: false, api_name: "layerName" + + field :pon, -> { Integer }, optional: false, nullable: false + + field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password" + + field :body, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false + end + end + end + end +end diff --git a/lib/CloudPDF/doc/pages/client.rb b/lib/CloudPDF/doc/pages/client.rb index 733f7b0..90ad131 100644 --- a/lib/CloudPDF/doc/pages/client.rb +++ b/lib/CloudPDF/doc/pages/client.rb @@ -321,6 +321,108 @@ def move(request_options: {}, **params) end end + # @param request_options [Hash] + # @param params [CloudPDF::Types::DocPagesSetNameRequest] + # @option request_options [String] :base_url + # @option request_options [Hash{String => Object}] :additional_headers + # @option request_options [Hash{String => Object}] :additional_query_parameters + # @option request_options [Hash{String => Object}] :additional_body_parameters + # @option request_options [Integer] :timeout_in_seconds + # @option params [String] :doc_id + # @option params [String] :layer_name + # @option params [String, nil] :document_password + # + # @example + # client.doc.pages.set_name( + # doc_id: "docId", + # layer_name: "layerName", + # request: { + # key: "value" + # } + # ) + # + # @return [CloudPDF::Types::DocPagesSetName200Response] + def set_name(request_options: {}, **params) + params = CloudPDF::Internal::Types::Utils.normalize_keys(params) + path_param_names = %i[doc_id layer_name] + body_params = params.except(*path_param_names) + + headers = {} + headers["X-Document-Password"] = params[:document_password] if params[:document_password] + + request = CloudPDF::Internal::JSON::Request.new( + base_url: request_options[:base_url], + method: "POST", + path: "v1/docs/#{URI.encode_uri_component(params[:doc_id].to_s)}/layers/#{URI.encode_uri_component(params[:layer_name].to_s)}/pages/names", + headers: headers, + body: body_params, + request_options: request_options + ) + begin + response = @client.send(request) + rescue Net::HTTPRequestTimeout + raise CloudPDF::Errors::TimeoutError + end + code = response.code.to_i + if code.between?(200, 299) + CloudPDF::Types::DocPagesSetName200Response.load(response.body) + else + error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code) + raise error_class.new(response.body, code: code) + end + end + + # @param request_options [Hash] + # @param params [CloudPDF::Types::DocPagesRemoveNameRequest] + # @option request_options [String] :base_url + # @option request_options [Hash{String => Object}] :additional_headers + # @option request_options [Hash{String => Object}] :additional_query_parameters + # @option request_options [Hash{String => Object}] :additional_body_parameters + # @option request_options [Integer] :timeout_in_seconds + # @option params [String] :doc_id + # @option params [String] :layer_name + # @option params [String, nil] :document_password + # + # @example + # client.doc.pages.remove_name( + # doc_id: "docId", + # layer_name: "layerName", + # request: { + # key: "value" + # } + # ) + # + # @return [CloudPDF::Types::DocPagesRemoveName200Response] + def remove_name(request_options: {}, **params) + params = CloudPDF::Internal::Types::Utils.normalize_keys(params) + path_param_names = %i[doc_id layer_name] + body_params = params.except(*path_param_names) + + headers = {} + headers["X-Document-Password"] = params[:document_password] if params[:document_password] + + request = CloudPDF::Internal::JSON::Request.new( + base_url: request_options[:base_url], + method: "POST", + path: "v1/docs/#{URI.encode_uri_component(params[:doc_id].to_s)}/layers/#{URI.encode_uri_component(params[:layer_name].to_s)}/pages/names/delete", + headers: headers, + body: body_params, + request_options: request_options + ) + begin + response = @client.send(request) + rescue Net::HTTPRequestTimeout + raise CloudPDF::Errors::TimeoutError + end + code = response.code.to_i + if code.between?(200, 299) + CloudPDF::Types::DocPagesRemoveName200Response.load(response.body) + else + error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code) + raise error_class.new(response.body, code: code) + end + end + # @param request_options [Hash] # @param params [CloudPDF::Types::DocPagesRotateRequest] # @option request_options [String] :base_url diff --git a/lib/CloudPDF/doc/pages/types/remove_name_pages_request.rb b/lib/CloudPDF/doc/pages/types/remove_name_pages_request.rb new file mode 100644 index 0000000..9590b08 --- /dev/null +++ b/lib/CloudPDF/doc/pages/types/remove_name_pages_request.rb @@ -0,0 +1,19 @@ +# frozen_string_literal: true + +module CloudPDF + module Doc + module Pages + module Types + class RemoveNamePagesRequest < Internal::Types::Model + field :doc_id, -> { String }, optional: false, nullable: false, api_name: "docId" + + field :layer_name, -> { String }, optional: false, nullable: false, api_name: "layerName" + + field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password" + + field :body, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false + end + end + end + end +end diff --git a/lib/CloudPDF/doc/pages/types/set_name_pages_request.rb b/lib/CloudPDF/doc/pages/types/set_name_pages_request.rb new file mode 100644 index 0000000..caf9e22 --- /dev/null +++ b/lib/CloudPDF/doc/pages/types/set_name_pages_request.rb @@ -0,0 +1,19 @@ +# frozen_string_literal: true + +module CloudPDF + module Doc + module Pages + module Types + class SetNamePagesRequest < Internal::Types::Model + field :doc_id, -> { String }, optional: false, nullable: false, api_name: "docId" + + field :layer_name, -> { String }, optional: false, nullable: false, api_name: "layerName" + + field :document_password, -> { String }, optional: true, nullable: false, api_name: "X-Document-Password" + + field :body, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false + end + end + end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_export_appearance400response.rb b/lib/CloudPDF/types/doc_annotations_export_appearance400response.rb new file mode 100644 index 0000000..242bba3 --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_export_appearance400response.rb @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocAnnotationsExportAppearance400Response < Internal::Types::Model + field :name, -> { CloudPDF::Types::DocAnnotationsExportAppearance400ResponseName }, optional: false, nullable: false + + field :code, -> { CloudPDF::Types::DocAnnotationsExportAppearance400ResponseCode }, optional: false, nullable: false + + field :message, -> { String }, optional: false, nullable: false + + field :details, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false + end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_export_appearance400response_code.rb b/lib/CloudPDF/types/doc_annotations_export_appearance400response_code.rb new file mode 100644 index 0000000..709a5a7 --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_export_appearance400response_code.rb @@ -0,0 +1,29 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + module DocAnnotationsExportAppearance400ResponseCode + extend CloudPDF::Internal::Types::Enum + + UNKNOWN = "Unknown" + INVALID_ARG = "InvalidArg" + DOC_NOT_OPEN = "DocNotOpen" + DOC_OPEN_FAILED = "DocOpenFailed" + DOC_PASSWORD_REQUIRED = "DocPasswordRequired" + DOC_PASSWORD_INCORRECT = "DocPasswordIncorrect" + SHARE_PASSWORD_REQUIRED = "SharePasswordRequired" + ABORTED = "Aborted" + NETWORK = "Network" + UNAUTHENTICATED = "Unauthenticated" + FORBIDDEN = "Forbidden" + NOT_FOUND = "NotFound" + WIRE_FORMAT = "WireFormat" + RUNTIME_UNAVAILABLE = "RuntimeUnavailable" + INVALID_REFERENCE = "InvalidReference" + WEAK_ANNOTATION_SESSION_CONFLICT = "WeakAnnotationSessionConflict" + LAYER_VERSION_CONFLICT = "LayerVersionConflict" + NOT_IMPLEMENTED = "NotImplemented" + MALFORMED_PDF = "MalformedPdf" + end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_export_appearance400response_name.rb b/lib/CloudPDF/types/doc_annotations_export_appearance400response_name.rb new file mode 100644 index 0000000..96f549d --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_export_appearance400response_name.rb @@ -0,0 +1,11 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + module DocAnnotationsExportAppearance400ResponseName + extend CloudPDF::Internal::Types::Enum + + ENGINE_ERROR = "EngineError" + end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_export_appearance404response.rb b/lib/CloudPDF/types/doc_annotations_export_appearance404response.rb new file mode 100644 index 0000000..2b234a5 --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_export_appearance404response.rb @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocAnnotationsExportAppearance404Response < Internal::Types::Model + field :name, -> { CloudPDF::Types::DocAnnotationsExportAppearance404ResponseName }, optional: false, nullable: false + + field :code, -> { CloudPDF::Types::DocAnnotationsExportAppearance404ResponseCode }, optional: false, nullable: false + + field :message, -> { String }, optional: false, nullable: false + + field :details, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false + end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_export_appearance404response_code.rb b/lib/CloudPDF/types/doc_annotations_export_appearance404response_code.rb new file mode 100644 index 0000000..0a382ab --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_export_appearance404response_code.rb @@ -0,0 +1,29 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + module DocAnnotationsExportAppearance404ResponseCode + extend CloudPDF::Internal::Types::Enum + + UNKNOWN = "Unknown" + INVALID_ARG = "InvalidArg" + DOC_NOT_OPEN = "DocNotOpen" + DOC_OPEN_FAILED = "DocOpenFailed" + DOC_PASSWORD_REQUIRED = "DocPasswordRequired" + DOC_PASSWORD_INCORRECT = "DocPasswordIncorrect" + SHARE_PASSWORD_REQUIRED = "SharePasswordRequired" + ABORTED = "Aborted" + NETWORK = "Network" + UNAUTHENTICATED = "Unauthenticated" + FORBIDDEN = "Forbidden" + NOT_FOUND = "NotFound" + WIRE_FORMAT = "WireFormat" + RUNTIME_UNAVAILABLE = "RuntimeUnavailable" + INVALID_REFERENCE = "InvalidReference" + WEAK_ANNOTATION_SESSION_CONFLICT = "WeakAnnotationSessionConflict" + LAYER_VERSION_CONFLICT = "LayerVersionConflict" + NOT_IMPLEMENTED = "NotImplemented" + MALFORMED_PDF = "MalformedPdf" + end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_export_appearance404response_name.rb b/lib/CloudPDF/types/doc_annotations_export_appearance404response_name.rb new file mode 100644 index 0000000..124b9b3 --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_export_appearance404response_name.rb @@ -0,0 +1,11 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + module DocAnnotationsExportAppearance404ResponseName + extend CloudPDF::Internal::Types::Enum + + ENGINE_ERROR = "EngineError" + end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_export_appearance_request.rb b/lib/CloudPDF/types/doc_annotations_export_appearance_request.rb new file mode 100644 index 0000000..9f7d9a6 --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_export_appearance_request.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + module DocAnnotationsExportAppearanceRequest + # DocAnnotationsExportAppearanceRequest is an alias for Hash + + # @option str [String] + # + # @return [untyped] + def self.load(str) + ::JSON.parse(str) + end + + # @option value [untyped] + # + # @return [String] + def self.dump(value) + ::JSON.generate(value) + end + end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_flatten200response.rb b/lib/CloudPDF/types/doc_annotations_flatten200response.rb new file mode 100644 index 0000000..85c3e71 --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_flatten200response.rb @@ -0,0 +1,9 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocAnnotationsFlatten200Response < Internal::Types::Model + field :meta, -> { CloudPDF::Types::DocAnnotationsFlatten200ResponseMeta }, optional: false, nullable: false + end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_flatten200response_meta.rb b/lib/CloudPDF/types/doc_annotations_flatten200response_meta.rb new file mode 100644 index 0000000..8214703 --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_flatten200response_meta.rb @@ -0,0 +1,11 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocAnnotationsFlatten200ResponseMeta < Internal::Types::Model + field :affected_pages, -> { Internal::Types::Array[CloudPDF::Types::DocAnnotationsFlatten200ResponseMetaAffectedPagesItem] }, optional: false, nullable: false, api_name: "affectedPages" + + field :cache_delta, -> { CloudPDF::Types::DocAnnotationsFlatten200ResponseMetaCacheDelta }, optional: false, nullable: true, api_name: "cacheDelta" + end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item.rb b/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item.rb new file mode 100644 index 0000000..53df1f6 --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item.rb @@ -0,0 +1,13 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocAnnotationsFlatten200ResponseMetaAffectedPagesItem < Internal::Types::Model + field :page_object_number, -> { Integer }, optional: false, nullable: false, api_name: "pageObjectNumber" + + field :revision, -> { CloudPDF::Types::DocAnnotationsFlatten200ResponseMetaAffectedPagesItemRevision }, optional: false, nullable: false + + field :weak_annotation_state, -> { CloudPDF::Types::DocAnnotationsFlatten200ResponseMetaAffectedPagesItemWeakAnnotationState }, optional: false, nullable: false, api_name: "weakAnnotationState" + end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_revision.rb b/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_revision.rb new file mode 100644 index 0000000..f887e6e --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_revision.rb @@ -0,0 +1,13 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocAnnotationsFlatten200ResponseMetaAffectedPagesItemRevision < Internal::Types::Model + field :doc_session_id, -> { String }, optional: false, nullable: false, api_name: "docSessionId" + + field :page_object_number, -> { Integer }, optional: false, nullable: false, api_name: "pageObjectNumber" + + field :generation, -> { Integer }, optional: false, nullable: false + end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state.rb b/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state.rb new file mode 100644 index 0000000..4111510 --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state.rb @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocAnnotationsFlatten200ResponseMetaAffectedPagesItemWeakAnnotationState < Internal::Types::Model + extend CloudPDF::Internal::Types::Union + + discriminant :kind + + member -> { CloudPDF::Types::DocAnnotationsFlatten200ResponseMetaAffectedPagesItemWeakAnnotationStateUnknown }, key: "UNKNOWN" + + member -> { CloudPDF::Types::DocAnnotationsFlatten200ResponseMetaAffectedPagesItemWeakAnnotationStateKnown }, key: "KNOWN" + end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state_known.rb b/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state_known.rb new file mode 100644 index 0000000..cd15b80 --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state_known.rb @@ -0,0 +1,9 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocAnnotationsFlatten200ResponseMetaAffectedPagesItemWeakAnnotationStateKnown < Internal::Types::Model + field :has_any_weak_annotations, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "hasAnyWeakAnnotations" + end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state_unknown.rb b/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state_unknown.rb new file mode 100644 index 0000000..a76cf68 --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state_unknown.rb @@ -0,0 +1,7 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocAnnotationsFlatten200ResponseMetaAffectedPagesItemWeakAnnotationStateUnknown < Internal::Types::Model; end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta.rb b/lib/CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta.rb new file mode 100644 index 0000000..733f5d9 --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta.rb @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocAnnotationsFlatten200ResponseMetaCacheDelta < Internal::Types::Model + field :previous_doc_version, -> { Integer }, optional: false, nullable: false, api_name: "previousDocVersion" + + field :doc_version, -> { Integer }, optional: false, nullable: false, api_name: "docVersion" + + field :annotations_version, -> { Integer }, optional: true, nullable: false, api_name: "annotationsVersion" + + field :pages, -> { Internal::Types::Array[CloudPDF::Types::DocAnnotationsFlatten200ResponseMetaCacheDeltaPagesItem] }, optional: false, nullable: false + end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta_pages_item.rb b/lib/CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta_pages_item.rb new file mode 100644 index 0000000..a4ee135 --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta_pages_item.rb @@ -0,0 +1,11 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocAnnotationsFlatten200ResponseMetaCacheDeltaPagesItem < Internal::Types::Model + field :page_object_number, -> { Integer }, optional: false, nullable: false, api_name: "pageObjectNumber" + + field :cache, -> { CloudPDF::Types::DocAnnotationsFlatten200ResponseMetaCacheDeltaPagesItemCache }, optional: false, nullable: false + end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta_pages_item_cache.rb b/lib/CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta_pages_item_cache.rb new file mode 100644 index 0000000..00855e6 --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta_pages_item_cache.rb @@ -0,0 +1,11 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocAnnotationsFlatten200ResponseMetaCacheDeltaPagesItemCache < Internal::Types::Model + field :content_version, -> { Integer }, optional: false, nullable: false, api_name: "contentVersion" + + field :annotation_version, -> { Integer }, optional: false, nullable: false, api_name: "annotationVersion" + end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_flatten400response.rb b/lib/CloudPDF/types/doc_annotations_flatten400response.rb new file mode 100644 index 0000000..54b290b --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_flatten400response.rb @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocAnnotationsFlatten400Response < Internal::Types::Model + field :name, -> { CloudPDF::Types::DocAnnotationsFlatten400ResponseName }, optional: false, nullable: false + + field :code, -> { CloudPDF::Types::DocAnnotationsFlatten400ResponseCode }, optional: false, nullable: false + + field :message, -> { String }, optional: false, nullable: false + + field :details, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false + end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_flatten400response_code.rb b/lib/CloudPDF/types/doc_annotations_flatten400response_code.rb new file mode 100644 index 0000000..12d2244 --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_flatten400response_code.rb @@ -0,0 +1,29 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + module DocAnnotationsFlatten400ResponseCode + extend CloudPDF::Internal::Types::Enum + + UNKNOWN = "Unknown" + INVALID_ARG = "InvalidArg" + DOC_NOT_OPEN = "DocNotOpen" + DOC_OPEN_FAILED = "DocOpenFailed" + DOC_PASSWORD_REQUIRED = "DocPasswordRequired" + DOC_PASSWORD_INCORRECT = "DocPasswordIncorrect" + SHARE_PASSWORD_REQUIRED = "SharePasswordRequired" + ABORTED = "Aborted" + NETWORK = "Network" + UNAUTHENTICATED = "Unauthenticated" + FORBIDDEN = "Forbidden" + NOT_FOUND = "NotFound" + WIRE_FORMAT = "WireFormat" + RUNTIME_UNAVAILABLE = "RuntimeUnavailable" + INVALID_REFERENCE = "InvalidReference" + WEAK_ANNOTATION_SESSION_CONFLICT = "WeakAnnotationSessionConflict" + LAYER_VERSION_CONFLICT = "LayerVersionConflict" + NOT_IMPLEMENTED = "NotImplemented" + MALFORMED_PDF = "MalformedPdf" + end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_flatten400response_name.rb b/lib/CloudPDF/types/doc_annotations_flatten400response_name.rb new file mode 100644 index 0000000..9b6372e --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_flatten400response_name.rb @@ -0,0 +1,11 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + module DocAnnotationsFlatten400ResponseName + extend CloudPDF::Internal::Types::Enum + + ENGINE_ERROR = "EngineError" + end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_flatten404response.rb b/lib/CloudPDF/types/doc_annotations_flatten404response.rb new file mode 100644 index 0000000..9af9f7c --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_flatten404response.rb @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocAnnotationsFlatten404Response < Internal::Types::Model + field :name, -> { CloudPDF::Types::DocAnnotationsFlatten404ResponseName }, optional: false, nullable: false + + field :code, -> { CloudPDF::Types::DocAnnotationsFlatten404ResponseCode }, optional: false, nullable: false + + field :message, -> { String }, optional: false, nullable: false + + field :details, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false + end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_flatten404response_code.rb b/lib/CloudPDF/types/doc_annotations_flatten404response_code.rb new file mode 100644 index 0000000..8715473 --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_flatten404response_code.rb @@ -0,0 +1,29 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + module DocAnnotationsFlatten404ResponseCode + extend CloudPDF::Internal::Types::Enum + + UNKNOWN = "Unknown" + INVALID_ARG = "InvalidArg" + DOC_NOT_OPEN = "DocNotOpen" + DOC_OPEN_FAILED = "DocOpenFailed" + DOC_PASSWORD_REQUIRED = "DocPasswordRequired" + DOC_PASSWORD_INCORRECT = "DocPasswordIncorrect" + SHARE_PASSWORD_REQUIRED = "SharePasswordRequired" + ABORTED = "Aborted" + NETWORK = "Network" + UNAUTHENTICATED = "Unauthenticated" + FORBIDDEN = "Forbidden" + NOT_FOUND = "NotFound" + WIRE_FORMAT = "WireFormat" + RUNTIME_UNAVAILABLE = "RuntimeUnavailable" + INVALID_REFERENCE = "InvalidReference" + WEAK_ANNOTATION_SESSION_CONFLICT = "WeakAnnotationSessionConflict" + LAYER_VERSION_CONFLICT = "LayerVersionConflict" + NOT_IMPLEMENTED = "NotImplemented" + MALFORMED_PDF = "MalformedPdf" + end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_flatten404response_name.rb b/lib/CloudPDF/types/doc_annotations_flatten404response_name.rb new file mode 100644 index 0000000..cc6afc8 --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_flatten404response_name.rb @@ -0,0 +1,11 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + module DocAnnotationsFlatten404ResponseName + extend CloudPDF::Internal::Types::Enum + + ENGINE_ERROR = "EngineError" + end + end +end diff --git a/lib/CloudPDF/types/doc_annotations_flatten_request.rb b/lib/CloudPDF/types/doc_annotations_flatten_request.rb new file mode 100644 index 0000000..bf270c3 --- /dev/null +++ b/lib/CloudPDF/types/doc_annotations_flatten_request.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + module DocAnnotationsFlattenRequest + # DocAnnotationsFlattenRequest is an alias for Hash + + # @option str [String] + # + # @return [untyped] + def self.load(str) + ::JSON.parse(str) + end + + # @option value [untyped] + # + # @return [String] + def self.dump(value) + ::JSON.generate(value) + end + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_remove_name200response.rb b/lib/CloudPDF/types/doc_pages_remove_name200response.rb new file mode 100644 index 0000000..2144704 --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_remove_name200response.rb @@ -0,0 +1,9 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesRemoveName200Response < Internal::Types::Model + field :meta, -> { CloudPDF::Types::DocPagesRemoveName200ResponseMeta }, optional: false, nullable: false + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_remove_name200response_meta.rb b/lib/CloudPDF/types/doc_pages_remove_name200response_meta.rb new file mode 100644 index 0000000..79d2e94 --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_remove_name200response_meta.rb @@ -0,0 +1,11 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesRemoveName200ResponseMeta < Internal::Types::Model + field :affected_pages, -> { Internal::Types::Array[CloudPDF::Types::DocPagesRemoveName200ResponseMetaAffectedPagesItem] }, optional: false, nullable: false, api_name: "affectedPages" + + field :cache_delta, -> { CloudPDF::Types::DocPagesRemoveName200ResponseMetaCacheDelta }, optional: false, nullable: true, api_name: "cacheDelta" + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item.rb b/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item.rb new file mode 100644 index 0000000..78e5a4d --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item.rb @@ -0,0 +1,13 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesRemoveName200ResponseMetaAffectedPagesItem < Internal::Types::Model + field :page_object_number, -> { Integer }, optional: false, nullable: false, api_name: "pageObjectNumber" + + field :revision, -> { CloudPDF::Types::DocPagesRemoveName200ResponseMetaAffectedPagesItemRevision }, optional: false, nullable: false + + field :weak_annotation_state, -> { CloudPDF::Types::DocPagesRemoveName200ResponseMetaAffectedPagesItemWeakAnnotationState }, optional: false, nullable: false, api_name: "weakAnnotationState" + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_revision.rb b/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_revision.rb new file mode 100644 index 0000000..9ee2a57 --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_revision.rb @@ -0,0 +1,13 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesRemoveName200ResponseMetaAffectedPagesItemRevision < Internal::Types::Model + field :doc_session_id, -> { String }, optional: false, nullable: false, api_name: "docSessionId" + + field :page_object_number, -> { Integer }, optional: false, nullable: false, api_name: "pageObjectNumber" + + field :generation, -> { Integer }, optional: false, nullable: false + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state.rb b/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state.rb new file mode 100644 index 0000000..40abf89 --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state.rb @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesRemoveName200ResponseMetaAffectedPagesItemWeakAnnotationState < Internal::Types::Model + extend CloudPDF::Internal::Types::Union + + discriminant :kind + + member -> { CloudPDF::Types::DocPagesRemoveName200ResponseMetaAffectedPagesItemWeakAnnotationStateUnknown }, key: "UNKNOWN" + + member -> { CloudPDF::Types::DocPagesRemoveName200ResponseMetaAffectedPagesItemWeakAnnotationStateKnown }, key: "KNOWN" + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state_known.rb b/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state_known.rb new file mode 100644 index 0000000..b5699eb --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state_known.rb @@ -0,0 +1,9 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesRemoveName200ResponseMetaAffectedPagesItemWeakAnnotationStateKnown < Internal::Types::Model + field :has_any_weak_annotations, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "hasAnyWeakAnnotations" + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state_unknown.rb b/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state_unknown.rb new file mode 100644 index 0000000..e51d278 --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state_unknown.rb @@ -0,0 +1,7 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesRemoveName200ResponseMetaAffectedPagesItemWeakAnnotationStateUnknown < Internal::Types::Model; end + end +end diff --git a/lib/CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta.rb b/lib/CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta.rb new file mode 100644 index 0000000..c7bd821 --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta.rb @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesRemoveName200ResponseMetaCacheDelta < Internal::Types::Model + field :previous_doc_version, -> { Integer }, optional: false, nullable: false, api_name: "previousDocVersion" + + field :doc_version, -> { Integer }, optional: false, nullable: false, api_name: "docVersion" + + field :annotations_version, -> { Integer }, optional: true, nullable: false, api_name: "annotationsVersion" + + field :pages, -> { Internal::Types::Array[CloudPDF::Types::DocPagesRemoveName200ResponseMetaCacheDeltaPagesItem] }, optional: false, nullable: false + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta_pages_item.rb b/lib/CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta_pages_item.rb new file mode 100644 index 0000000..740ba2c --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta_pages_item.rb @@ -0,0 +1,11 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesRemoveName200ResponseMetaCacheDeltaPagesItem < Internal::Types::Model + field :page_object_number, -> { Integer }, optional: false, nullable: false, api_name: "pageObjectNumber" + + field :cache, -> { CloudPDF::Types::DocPagesRemoveName200ResponseMetaCacheDeltaPagesItemCache }, optional: false, nullable: false + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta_pages_item_cache.rb b/lib/CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta_pages_item_cache.rb new file mode 100644 index 0000000..bf69dad --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta_pages_item_cache.rb @@ -0,0 +1,11 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesRemoveName200ResponseMetaCacheDeltaPagesItemCache < Internal::Types::Model + field :content_version, -> { Integer }, optional: false, nullable: false, api_name: "contentVersion" + + field :annotation_version, -> { Integer }, optional: false, nullable: false, api_name: "annotationVersion" + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_remove_name400response.rb b/lib/CloudPDF/types/doc_pages_remove_name400response.rb new file mode 100644 index 0000000..f0c9f77 --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_remove_name400response.rb @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesRemoveName400Response < Internal::Types::Model + field :name, -> { CloudPDF::Types::DocPagesRemoveName400ResponseName }, optional: false, nullable: false + + field :code, -> { CloudPDF::Types::DocPagesRemoveName400ResponseCode }, optional: false, nullable: false + + field :message, -> { String }, optional: false, nullable: false + + field :details, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_remove_name400response_code.rb b/lib/CloudPDF/types/doc_pages_remove_name400response_code.rb new file mode 100644 index 0000000..526c609 --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_remove_name400response_code.rb @@ -0,0 +1,29 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + module DocPagesRemoveName400ResponseCode + extend CloudPDF::Internal::Types::Enum + + UNKNOWN = "Unknown" + INVALID_ARG = "InvalidArg" + DOC_NOT_OPEN = "DocNotOpen" + DOC_OPEN_FAILED = "DocOpenFailed" + DOC_PASSWORD_REQUIRED = "DocPasswordRequired" + DOC_PASSWORD_INCORRECT = "DocPasswordIncorrect" + SHARE_PASSWORD_REQUIRED = "SharePasswordRequired" + ABORTED = "Aborted" + NETWORK = "Network" + UNAUTHENTICATED = "Unauthenticated" + FORBIDDEN = "Forbidden" + NOT_FOUND = "NotFound" + WIRE_FORMAT = "WireFormat" + RUNTIME_UNAVAILABLE = "RuntimeUnavailable" + INVALID_REFERENCE = "InvalidReference" + WEAK_ANNOTATION_SESSION_CONFLICT = "WeakAnnotationSessionConflict" + LAYER_VERSION_CONFLICT = "LayerVersionConflict" + NOT_IMPLEMENTED = "NotImplemented" + MALFORMED_PDF = "MalformedPdf" + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_remove_name400response_name.rb b/lib/CloudPDF/types/doc_pages_remove_name400response_name.rb new file mode 100644 index 0000000..e9491a9 --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_remove_name400response_name.rb @@ -0,0 +1,11 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + module DocPagesRemoveName400ResponseName + extend CloudPDF::Internal::Types::Enum + + ENGINE_ERROR = "EngineError" + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_remove_name404response.rb b/lib/CloudPDF/types/doc_pages_remove_name404response.rb new file mode 100644 index 0000000..0cc3c79 --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_remove_name404response.rb @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesRemoveName404Response < Internal::Types::Model + field :name, -> { CloudPDF::Types::DocPagesRemoveName404ResponseName }, optional: false, nullable: false + + field :code, -> { CloudPDF::Types::DocPagesRemoveName404ResponseCode }, optional: false, nullable: false + + field :message, -> { String }, optional: false, nullable: false + + field :details, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_remove_name404response_code.rb b/lib/CloudPDF/types/doc_pages_remove_name404response_code.rb new file mode 100644 index 0000000..cdd967f --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_remove_name404response_code.rb @@ -0,0 +1,29 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + module DocPagesRemoveName404ResponseCode + extend CloudPDF::Internal::Types::Enum + + UNKNOWN = "Unknown" + INVALID_ARG = "InvalidArg" + DOC_NOT_OPEN = "DocNotOpen" + DOC_OPEN_FAILED = "DocOpenFailed" + DOC_PASSWORD_REQUIRED = "DocPasswordRequired" + DOC_PASSWORD_INCORRECT = "DocPasswordIncorrect" + SHARE_PASSWORD_REQUIRED = "SharePasswordRequired" + ABORTED = "Aborted" + NETWORK = "Network" + UNAUTHENTICATED = "Unauthenticated" + FORBIDDEN = "Forbidden" + NOT_FOUND = "NotFound" + WIRE_FORMAT = "WireFormat" + RUNTIME_UNAVAILABLE = "RuntimeUnavailable" + INVALID_REFERENCE = "InvalidReference" + WEAK_ANNOTATION_SESSION_CONFLICT = "WeakAnnotationSessionConflict" + LAYER_VERSION_CONFLICT = "LayerVersionConflict" + NOT_IMPLEMENTED = "NotImplemented" + MALFORMED_PDF = "MalformedPdf" + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_remove_name404response_name.rb b/lib/CloudPDF/types/doc_pages_remove_name404response_name.rb new file mode 100644 index 0000000..bb3f65f --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_remove_name404response_name.rb @@ -0,0 +1,11 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + module DocPagesRemoveName404ResponseName + extend CloudPDF::Internal::Types::Enum + + ENGINE_ERROR = "EngineError" + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_remove_name_request.rb b/lib/CloudPDF/types/doc_pages_remove_name_request.rb new file mode 100644 index 0000000..0a04a4f --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_remove_name_request.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + module DocPagesRemoveNameRequest + # DocPagesRemoveNameRequest is an alias for Hash + + # @option str [String] + # + # @return [untyped] + def self.load(str) + ::JSON.parse(str) + end + + # @option value [untyped] + # + # @return [String] + def self.dump(value) + ::JSON.generate(value) + end + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_set_name200response.rb b/lib/CloudPDF/types/doc_pages_set_name200response.rb new file mode 100644 index 0000000..c64f089 --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_set_name200response.rb @@ -0,0 +1,9 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesSetName200Response < Internal::Types::Model + field :meta, -> { CloudPDF::Types::DocPagesSetName200ResponseMeta }, optional: false, nullable: false + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_set_name200response_meta.rb b/lib/CloudPDF/types/doc_pages_set_name200response_meta.rb new file mode 100644 index 0000000..5d0ba91 --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_set_name200response_meta.rb @@ -0,0 +1,11 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesSetName200ResponseMeta < Internal::Types::Model + field :affected_pages, -> { Internal::Types::Array[CloudPDF::Types::DocPagesSetName200ResponseMetaAffectedPagesItem] }, optional: false, nullable: false, api_name: "affectedPages" + + field :cache_delta, -> { CloudPDF::Types::DocPagesSetName200ResponseMetaCacheDelta }, optional: false, nullable: true, api_name: "cacheDelta" + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item.rb b/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item.rb new file mode 100644 index 0000000..269d4ec --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item.rb @@ -0,0 +1,13 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesSetName200ResponseMetaAffectedPagesItem < Internal::Types::Model + field :page_object_number, -> { Integer }, optional: false, nullable: false, api_name: "pageObjectNumber" + + field :revision, -> { CloudPDF::Types::DocPagesSetName200ResponseMetaAffectedPagesItemRevision }, optional: false, nullable: false + + field :weak_annotation_state, -> { CloudPDF::Types::DocPagesSetName200ResponseMetaAffectedPagesItemWeakAnnotationState }, optional: false, nullable: false, api_name: "weakAnnotationState" + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_revision.rb b/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_revision.rb new file mode 100644 index 0000000..9f9a478 --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_revision.rb @@ -0,0 +1,13 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesSetName200ResponseMetaAffectedPagesItemRevision < Internal::Types::Model + field :doc_session_id, -> { String }, optional: false, nullable: false, api_name: "docSessionId" + + field :page_object_number, -> { Integer }, optional: false, nullable: false, api_name: "pageObjectNumber" + + field :generation, -> { Integer }, optional: false, nullable: false + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state.rb b/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state.rb new file mode 100644 index 0000000..2887126 --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state.rb @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesSetName200ResponseMetaAffectedPagesItemWeakAnnotationState < Internal::Types::Model + extend CloudPDF::Internal::Types::Union + + discriminant :kind + + member -> { CloudPDF::Types::DocPagesSetName200ResponseMetaAffectedPagesItemWeakAnnotationStateUnknown }, key: "UNKNOWN" + + member -> { CloudPDF::Types::DocPagesSetName200ResponseMetaAffectedPagesItemWeakAnnotationStateKnown }, key: "KNOWN" + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state_known.rb b/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state_known.rb new file mode 100644 index 0000000..739174c --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state_known.rb @@ -0,0 +1,9 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesSetName200ResponseMetaAffectedPagesItemWeakAnnotationStateKnown < Internal::Types::Model + field :has_any_weak_annotations, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "hasAnyWeakAnnotations" + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state_unknown.rb b/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state_unknown.rb new file mode 100644 index 0000000..2d3b41e --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state_unknown.rb @@ -0,0 +1,7 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesSetName200ResponseMetaAffectedPagesItemWeakAnnotationStateUnknown < Internal::Types::Model; end + end +end diff --git a/lib/CloudPDF/types/doc_pages_set_name200response_meta_cache_delta.rb b/lib/CloudPDF/types/doc_pages_set_name200response_meta_cache_delta.rb new file mode 100644 index 0000000..e88934e --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_set_name200response_meta_cache_delta.rb @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesSetName200ResponseMetaCacheDelta < Internal::Types::Model + field :previous_doc_version, -> { Integer }, optional: false, nullable: false, api_name: "previousDocVersion" + + field :doc_version, -> { Integer }, optional: false, nullable: false, api_name: "docVersion" + + field :annotations_version, -> { Integer }, optional: true, nullable: false, api_name: "annotationsVersion" + + field :pages, -> { Internal::Types::Array[CloudPDF::Types::DocPagesSetName200ResponseMetaCacheDeltaPagesItem] }, optional: false, nullable: false + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_set_name200response_meta_cache_delta_pages_item.rb b/lib/CloudPDF/types/doc_pages_set_name200response_meta_cache_delta_pages_item.rb new file mode 100644 index 0000000..81efb1e --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_set_name200response_meta_cache_delta_pages_item.rb @@ -0,0 +1,11 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesSetName200ResponseMetaCacheDeltaPagesItem < Internal::Types::Model + field :page_object_number, -> { Integer }, optional: false, nullable: false, api_name: "pageObjectNumber" + + field :cache, -> { CloudPDF::Types::DocPagesSetName200ResponseMetaCacheDeltaPagesItemCache }, optional: false, nullable: false + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_set_name200response_meta_cache_delta_pages_item_cache.rb b/lib/CloudPDF/types/doc_pages_set_name200response_meta_cache_delta_pages_item_cache.rb new file mode 100644 index 0000000..6252b56 --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_set_name200response_meta_cache_delta_pages_item_cache.rb @@ -0,0 +1,11 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesSetName200ResponseMetaCacheDeltaPagesItemCache < Internal::Types::Model + field :content_version, -> { Integer }, optional: false, nullable: false, api_name: "contentVersion" + + field :annotation_version, -> { Integer }, optional: false, nullable: false, api_name: "annotationVersion" + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_set_name400response.rb b/lib/CloudPDF/types/doc_pages_set_name400response.rb new file mode 100644 index 0000000..cbbb2ef --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_set_name400response.rb @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesSetName400Response < Internal::Types::Model + field :name, -> { CloudPDF::Types::DocPagesSetName400ResponseName }, optional: false, nullable: false + + field :code, -> { CloudPDF::Types::DocPagesSetName400ResponseCode }, optional: false, nullable: false + + field :message, -> { String }, optional: false, nullable: false + + field :details, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_set_name400response_code.rb b/lib/CloudPDF/types/doc_pages_set_name400response_code.rb new file mode 100644 index 0000000..ed62e05 --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_set_name400response_code.rb @@ -0,0 +1,29 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + module DocPagesSetName400ResponseCode + extend CloudPDF::Internal::Types::Enum + + UNKNOWN = "Unknown" + INVALID_ARG = "InvalidArg" + DOC_NOT_OPEN = "DocNotOpen" + DOC_OPEN_FAILED = "DocOpenFailed" + DOC_PASSWORD_REQUIRED = "DocPasswordRequired" + DOC_PASSWORD_INCORRECT = "DocPasswordIncorrect" + SHARE_PASSWORD_REQUIRED = "SharePasswordRequired" + ABORTED = "Aborted" + NETWORK = "Network" + UNAUTHENTICATED = "Unauthenticated" + FORBIDDEN = "Forbidden" + NOT_FOUND = "NotFound" + WIRE_FORMAT = "WireFormat" + RUNTIME_UNAVAILABLE = "RuntimeUnavailable" + INVALID_REFERENCE = "InvalidReference" + WEAK_ANNOTATION_SESSION_CONFLICT = "WeakAnnotationSessionConflict" + LAYER_VERSION_CONFLICT = "LayerVersionConflict" + NOT_IMPLEMENTED = "NotImplemented" + MALFORMED_PDF = "MalformedPdf" + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_set_name400response_name.rb b/lib/CloudPDF/types/doc_pages_set_name400response_name.rb new file mode 100644 index 0000000..96a6b9c --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_set_name400response_name.rb @@ -0,0 +1,11 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + module DocPagesSetName400ResponseName + extend CloudPDF::Internal::Types::Enum + + ENGINE_ERROR = "EngineError" + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_set_name404response.rb b/lib/CloudPDF/types/doc_pages_set_name404response.rb new file mode 100644 index 0000000..6aec582 --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_set_name404response.rb @@ -0,0 +1,15 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + class DocPagesSetName404Response < Internal::Types::Model + field :name, -> { CloudPDF::Types::DocPagesSetName404ResponseName }, optional: false, nullable: false + + field :code, -> { CloudPDF::Types::DocPagesSetName404ResponseCode }, optional: false, nullable: false + + field :message, -> { String }, optional: false, nullable: false + + field :details, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_set_name404response_code.rb b/lib/CloudPDF/types/doc_pages_set_name404response_code.rb new file mode 100644 index 0000000..929bf05 --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_set_name404response_code.rb @@ -0,0 +1,29 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + module DocPagesSetName404ResponseCode + extend CloudPDF::Internal::Types::Enum + + UNKNOWN = "Unknown" + INVALID_ARG = "InvalidArg" + DOC_NOT_OPEN = "DocNotOpen" + DOC_OPEN_FAILED = "DocOpenFailed" + DOC_PASSWORD_REQUIRED = "DocPasswordRequired" + DOC_PASSWORD_INCORRECT = "DocPasswordIncorrect" + SHARE_PASSWORD_REQUIRED = "SharePasswordRequired" + ABORTED = "Aborted" + NETWORK = "Network" + UNAUTHENTICATED = "Unauthenticated" + FORBIDDEN = "Forbidden" + NOT_FOUND = "NotFound" + WIRE_FORMAT = "WireFormat" + RUNTIME_UNAVAILABLE = "RuntimeUnavailable" + INVALID_REFERENCE = "InvalidReference" + WEAK_ANNOTATION_SESSION_CONFLICT = "WeakAnnotationSessionConflict" + LAYER_VERSION_CONFLICT = "LayerVersionConflict" + NOT_IMPLEMENTED = "NotImplemented" + MALFORMED_PDF = "MalformedPdf" + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_set_name404response_name.rb b/lib/CloudPDF/types/doc_pages_set_name404response_name.rb new file mode 100644 index 0000000..0f5c07c --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_set_name404response_name.rb @@ -0,0 +1,11 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + module DocPagesSetName404ResponseName + extend CloudPDF::Internal::Types::Enum + + ENGINE_ERROR = "EngineError" + end + end +end diff --git a/lib/CloudPDF/types/doc_pages_set_name_request.rb b/lib/CloudPDF/types/doc_pages_set_name_request.rb new file mode 100644 index 0000000..e101143 --- /dev/null +++ b/lib/CloudPDF/types/doc_pages_set_name_request.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: true + +module CloudPDF + module Types + module DocPagesSetNameRequest + # DocPagesSetNameRequest is an alias for Hash + + # @option str [String] + # + # @return [untyped] + def self.load(str) + ::JSON.parse(str) + end + + # @option value [untyped] + # + # @return [String] + def self.dump(value) + ::JSON.generate(value) + end + end + end +end diff --git a/lib/CloudPDF/version.rb b/lib/CloudPDF/version.rb index d14dc8a..a1f7477 100644 --- a/lib/CloudPDF/version.rb +++ b/lib/CloudPDF/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module CloudPDF - VERSION = "3.0.0.alpha.11" + VERSION = "3.0.0.alpha.12" end diff --git a/lib/cloudpdf.rb b/lib/cloudpdf.rb index 20da6c1..26993df 100644 --- a/lib/cloudpdf.rb +++ b/lib/cloudpdf.rb @@ -1177,6 +1177,30 @@ require_relative "CloudPDF/types/doc_annotations_delete404response_name" require_relative "CloudPDF/types/doc_annotations_delete404response_code" require_relative "CloudPDF/types/doc_annotations_delete404response" +require_relative "CloudPDF/types/doc_annotations_flatten_request" +require_relative "CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_revision" +require_relative "CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state_unknown" +require_relative "CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state_known" +require_relative "CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item_weak_annotation_state" +require_relative "CloudPDF/types/doc_annotations_flatten200response_meta_affected_pages_item" +require_relative "CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta_pages_item_cache" +require_relative "CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta_pages_item" +require_relative "CloudPDF/types/doc_annotations_flatten200response_meta_cache_delta" +require_relative "CloudPDF/types/doc_annotations_flatten200response_meta" +require_relative "CloudPDF/types/doc_annotations_flatten200response" +require_relative "CloudPDF/types/doc_annotations_flatten400response_name" +require_relative "CloudPDF/types/doc_annotations_flatten400response_code" +require_relative "CloudPDF/types/doc_annotations_flatten400response" +require_relative "CloudPDF/types/doc_annotations_flatten404response_name" +require_relative "CloudPDF/types/doc_annotations_flatten404response_code" +require_relative "CloudPDF/types/doc_annotations_flatten404response" +require_relative "CloudPDF/types/doc_annotations_export_appearance_request" +require_relative "CloudPDF/types/doc_annotations_export_appearance400response_name" +require_relative "CloudPDF/types/doc_annotations_export_appearance400response_code" +require_relative "CloudPDF/types/doc_annotations_export_appearance400response" +require_relative "CloudPDF/types/doc_annotations_export_appearance404response_name" +require_relative "CloudPDF/types/doc_annotations_export_appearance404response_code" +require_relative "CloudPDF/types/doc_annotations_export_appearance404response" require_relative "CloudPDF/types/doc_forms_get200response_form_kind" require_relative "CloudPDF/types/doc_forms_get200response_fields_item_text_ref_object_number" require_relative "CloudPDF/types/doc_forms_get200response_fields_item_text_ref_fqn" @@ -1425,6 +1449,40 @@ require_relative "CloudPDF/types/doc_pages_delete404response_name" require_relative "CloudPDF/types/doc_pages_delete404response_code" require_relative "CloudPDF/types/doc_pages_delete404response" +require_relative "CloudPDF/types/doc_pages_set_name_request" +require_relative "CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_revision" +require_relative "CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state_unknown" +require_relative "CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state_known" +require_relative "CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item_weak_annotation_state" +require_relative "CloudPDF/types/doc_pages_set_name200response_meta_affected_pages_item" +require_relative "CloudPDF/types/doc_pages_set_name200response_meta_cache_delta_pages_item_cache" +require_relative "CloudPDF/types/doc_pages_set_name200response_meta_cache_delta_pages_item" +require_relative "CloudPDF/types/doc_pages_set_name200response_meta_cache_delta" +require_relative "CloudPDF/types/doc_pages_set_name200response_meta" +require_relative "CloudPDF/types/doc_pages_set_name200response" +require_relative "CloudPDF/types/doc_pages_set_name400response_name" +require_relative "CloudPDF/types/doc_pages_set_name400response_code" +require_relative "CloudPDF/types/doc_pages_set_name400response" +require_relative "CloudPDF/types/doc_pages_set_name404response_name" +require_relative "CloudPDF/types/doc_pages_set_name404response_code" +require_relative "CloudPDF/types/doc_pages_set_name404response" +require_relative "CloudPDF/types/doc_pages_remove_name_request" +require_relative "CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_revision" +require_relative "CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state_unknown" +require_relative "CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state_known" +require_relative "CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item_weak_annotation_state" +require_relative "CloudPDF/types/doc_pages_remove_name200response_meta_affected_pages_item" +require_relative "CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta_pages_item_cache" +require_relative "CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta_pages_item" +require_relative "CloudPDF/types/doc_pages_remove_name200response_meta_cache_delta" +require_relative "CloudPDF/types/doc_pages_remove_name200response_meta" +require_relative "CloudPDF/types/doc_pages_remove_name200response" +require_relative "CloudPDF/types/doc_pages_remove_name400response_name" +require_relative "CloudPDF/types/doc_pages_remove_name400response_code" +require_relative "CloudPDF/types/doc_pages_remove_name400response" +require_relative "CloudPDF/types/doc_pages_remove_name404response_name" +require_relative "CloudPDF/types/doc_pages_remove_name404response_code" +require_relative "CloudPDF/types/doc_pages_remove_name404response" require_relative "CloudPDF/types/doc_pages_flatten_request" require_relative "CloudPDF/types/doc_pages_flatten200response_meta_affected_pages_item_revision" require_relative "CloudPDF/types/doc_pages_flatten200response_meta_affected_pages_item_weak_annotation_state_unknown" @@ -1544,6 +1602,8 @@ require_relative "CloudPDF/doc/annotations/types/create_annotations_request" require_relative "CloudPDF/doc/annotations/types/delete_annotations_request" require_relative "CloudPDF/doc/annotations/types/update_annotations_request" +require_relative "CloudPDF/doc/annotations/types/export_appearance_annotations_request" +require_relative "CloudPDF/doc/annotations/types/flatten_annotations_request" require_relative "CloudPDF/doc/forms/client" require_relative "CloudPDF/doc/forms/types/get_forms_request" require_relative "CloudPDF/doc/forms/types/export_data_forms_request" @@ -1559,6 +1619,8 @@ require_relative "CloudPDF/doc/pages/types/insert_pages_request" require_relative "CloudPDF/doc/pages/types/insert_blank_pages_request" require_relative "CloudPDF/doc/pages/types/move_pages_request" +require_relative "CloudPDF/doc/pages/types/set_name_pages_request" +require_relative "CloudPDF/doc/pages/types/remove_name_pages_request" require_relative "CloudPDF/doc/pages/types/rotate_pages_request" require_relative "CloudPDF/doc/redactions/client" require_relative "CloudPDF/doc/redactions/types/apply_redactions_request" diff --git a/reference.md b/reference.md index 7389332..8a8b1f3 100644 --- a/reference.md +++ b/reference.md @@ -2581,6 +2581,182 @@ client.doc.annotations.update( + + + + +
client.doc.annotations.export_appearance(doc_id:, layer_name:, pon:, request) -> String +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.doc.annotations.export_appearance( + doc_id: "docId", + layer_name: "layerName", + pon: 1, + request: { + string: { + key: "value" + } + } +) +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**doc_id:** `String` + +
+
+ +
+
+ +**layer_name:** `String` + +
+
+ +
+
+ +**pon:** `Integer` + +
+
+ +
+
+ +**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead. + +
+
+ +
+
+ +**request:** `Internal::Types::Hash[String, Object]` + +
+
+ +
+
+ +**request_options:** `CloudPDF::Doc::Annotations::RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.doc.annotations.flatten(doc_id:, layer_name:, pon:, request) -> CloudPDF::Types::DocAnnotationsFlatten200Response +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.doc.annotations.flatten( + doc_id: "docId", + layer_name: "layerName", + pon: 1, + request: { + key: "value" + } +) +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**doc_id:** `String` + +
+
+ +
+
+ +**layer_name:** `String` + +
+
+ +
+
+ +**pon:** `Integer` + +
+
+ +
+
+ +**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead. + +
+
+ +
+
+ +**request:** `Internal::Types::Hash[String, Object]` + +
+
+ +
+
+ +**request_options:** `CloudPDF::Doc::Annotations::RequestOptions` + +
+
+
+
+ +
@@ -3535,6 +3711,162 @@ client.doc.pages.move( + + + + +
client.doc.pages.set_name(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesSetName200Response +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.doc.pages.set_name( + doc_id: "docId", + layer_name: "layerName", + request: { + key: "value" + } +) +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**doc_id:** `String` + +
+
+ +
+
+ +**layer_name:** `String` + +
+
+ +
+
+ +**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead. + +
+
+ +
+
+ +**request:** `Internal::Types::Hash[String, Object]` + +
+
+ +
+
+ +**request_options:** `CloudPDF::Doc::Pages::RequestOptions` + +
+
+
+
+ + +
+
+
+ +
client.doc.pages.remove_name(doc_id:, layer_name:, request) -> CloudPDF::Types::DocPagesRemoveName200Response +
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```ruby +client.doc.pages.remove_name( + doc_id: "docId", + layer_name: "layerName", + request: { + key: "value" + } +) +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**doc_id:** `String` + +
+
+ +
+
+ +**layer_name:** `String` + +
+
+ +
+
+ +**document_password:** `String` — Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead. + +
+
+ +
+
+ +**request:** `Internal::Types::Hash[String, Object]` + +
+
+ +
+
+ +**request_options:** `CloudPDF::Doc::Pages::RequestOptions` + +
+
+
+
+ +