docspace-api-sdk 4.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/AUTHORS.md +3 -0
- data/CHANGELOG.md +50 -0
- data/LICENSE +201 -0
- data/README.md +5310 -0
- data/lib/docspace-api-sdk/api/AI/agents-api.rb +605 -0
- data/lib/docspace-api-sdk/api/AI/ai-api.rb +517 -0
- data/lib/docspace-api-sdk/api/AI/assignments-api.rb +573 -0
- data/lib/docspace-api-sdk/api/AI/attachments-api.rb +585 -0
- data/lib/docspace-api-sdk/api/AI/context-api.rb +233 -0
- data/lib/docspace-api-sdk/api/AI/editor-tools-api.rb +156 -0
- data/lib/docspace-api-sdk/api/AI/export-api.rb +97 -0
- data/lib/docspace-api-sdk/api/AI/open-ai-passthrough-api.rb +179 -0
- data/lib/docspace-api-sdk/api/AI/preferences-api.rb +555 -0
- data/lib/docspace-api-sdk/api/AI/profiles-api.rb +568 -0
- data/lib/docspace-api-sdk/api/AI/prompts-api.rb +899 -0
- data/lib/docspace-api-sdk/api/AI/settings-api.rb +473 -0
- data/lib/docspace-api-sdk/api/AI/threads-api.rb +1005 -0
- data/lib/docspace-api-sdk/api/AI/tools-api.rb +923 -0
- data/lib/docspace-api-sdk/api/AI/vectorization-api.rb +97 -0
- data/lib/docspace-api-sdk/api/AI/web-search-api.rb +571 -0
- data/lib/docspace-api-sdk/api/ApiKeys/api-keys-api.rb +411 -0
- data/lib/docspace-api-sdk/api/Apps/apps-api.rb +368 -0
- data/lib/docspace-api-sdk/api/Authentication/authentication-api.rb +481 -0
- data/lib/docspace-api-sdk/api/Backup/backup-api.rb +916 -0
- data/lib/docspace-api-sdk/api/Capabilities/capabilities-api.rb +86 -0
- data/lib/docspace-api-sdk/api/Docs/docs-api.rb +159 -0
- data/lib/docspace-api-sdk/api/Files/files-api.rb +3705 -0
- data/lib/docspace-api-sdk/api/Files/folders-api.rb +2611 -0
- data/lib/docspace-api-sdk/api/Files/metadata-api.rb +1465 -0
- data/lib/docspace-api-sdk/api/Files/operations-api.rb +1722 -0
- data/lib/docspace-api-sdk/api/Files/quota-api.rb +159 -0
- data/lib/docspace-api-sdk/api/Files/settings-api.rb +1973 -0
- data/lib/docspace-api-sdk/api/Files/sharing-api.rb +1126 -0
- data/lib/docspace-api-sdk/api/Files/third-party-integration-api.rb +522 -0
- data/lib/docspace-api-sdk/api/Group/group-api.rb +830 -0
- data/lib/docspace-api-sdk/api/Group/search-api.rb +282 -0
- data/lib/docspace-api-sdk/api/Migration/migration-api.rb +519 -0
- data/lib/docspace-api-sdk/api/OAuth20/authorization-api.rb +262 -0
- data/lib/docspace-api-sdk/api/OAuth20/client-management-api.rb +582 -0
- data/lib/docspace-api-sdk/api/OAuth20/client-querying-api.rb +467 -0
- data/lib/docspace-api-sdk/api/OAuth20/discovery-api.rb +84 -0
- data/lib/docspace-api-sdk/api/OAuth20/scope-management-api.rb +86 -0
- data/lib/docspace-api-sdk/api/People/email-api.rb +169 -0
- data/lib/docspace-api-sdk/api/People/guests-api.rb +159 -0
- data/lib/docspace-api-sdk/api/People/password-api.rb +169 -0
- data/lib/docspace-api-sdk/api/People/photos-api.rb +389 -0
- data/lib/docspace-api-sdk/api/People/profiles-api.rb +986 -0
- data/lib/docspace-api-sdk/api/People/quota-api.rb +159 -0
- data/lib/docspace-api-sdk/api/People/search-api.rb +1150 -0
- data/lib/docspace-api-sdk/api/People/theme-api.rb +152 -0
- data/lib/docspace-api-sdk/api/People/third-party-accounts-api.rb +292 -0
- data/lib/docspace-api-sdk/api/People/user-data-api.rb +663 -0
- data/lib/docspace-api-sdk/api/People/user-status-api.rb +273 -0
- data/lib/docspace-api-sdk/api/People/user-type-api.rb +300 -0
- data/lib/docspace-api-sdk/api/Portal/guests-api.rb +92 -0
- data/lib/docspace-api-sdk/api/Portal/payment-api.rb +2571 -0
- data/lib/docspace-api-sdk/api/Portal/quota-api.rb +328 -0
- data/lib/docspace-api-sdk/api/Portal/settings-api.rb +502 -0
- data/lib/docspace-api-sdk/api/Portal/users-api.rb +611 -0
- data/lib/docspace-api-sdk/api/Rooms/groups-api.rb +442 -0
- data/lib/docspace-api-sdk/api/Rooms/privacy-room-api.rb +348 -0
- data/lib/docspace-api-sdk/api/Rooms/rooms-api.rb +3121 -0
- data/lib/docspace-api-sdk/api/Security/access-to-dev-tools-api.rb +93 -0
- data/lib/docspace-api-sdk/api/Security/active-connections-api.rb +334 -0
- data/lib/docspace-api-sdk/api/Security/audit-trail-data-api.rb +618 -0
- data/lib/docspace-api-sdk/api/Security/banners-visibility-api.rb +93 -0
- data/lib/docspace-api-sdk/api/Security/csp-api.rb +152 -0
- data/lib/docspace-api-sdk/api/Security/firebase-api.rb +159 -0
- data/lib/docspace-api-sdk/api/Security/login-history-api.rb +357 -0
- data/lib/docspace-api-sdk/api/Security/o-auth2-api.rb +86 -0
- data/lib/docspace-api-sdk/api/Security/smtp-settings-api.rb +329 -0
- data/lib/docspace-api-sdk/api/Settings/access-to-dev-tools-api.rb +86 -0
- data/lib/docspace-api-sdk/api/Settings/authorization-api.rb +218 -0
- data/lib/docspace-api-sdk/api/Settings/banners-visibility-api.rb +86 -0
- data/lib/docspace-api-sdk/api/Settings/common-settings-api.rb +1398 -0
- data/lib/docspace-api-sdk/api/Settings/cookies-api.rb +152 -0
- data/lib/docspace-api-sdk/api/Settings/docs-cloud-api.rb +771 -0
- data/lib/docspace-api-sdk/api/Settings/encryption-api.rb +211 -0
- data/lib/docspace-api-sdk/api/Settings/greeting-settings-api.rb +270 -0
- data/lib/docspace-api-sdk/api/Settings/ip-restrictions-api.rb +277 -0
- data/lib/docspace-api-sdk/api/Settings/license-api.rb +275 -0
- data/lib/docspace-api-sdk/api/Settings/login-settings-api.rb +211 -0
- data/lib/docspace-api-sdk/api/Settings/messages-api.rb +225 -0
- data/lib/docspace-api-sdk/api/Settings/notifications-api.rb +342 -0
- data/lib/docspace-api-sdk/api/Settings/owner-api.rb +159 -0
- data/lib/docspace-api-sdk/api/Settings/quota-api.rb +284 -0
- data/lib/docspace-api-sdk/api/Settings/rebranding-api.rb +1112 -0
- data/lib/docspace-api-sdk/api/Settings/security-api.rb +674 -0
- data/lib/docspace-api-sdk/api/Settings/sso-api.rb +329 -0
- data/lib/docspace-api-sdk/api/Settings/statistics-api.rb +92 -0
- data/lib/docspace-api-sdk/api/Settings/storage-api.rb +575 -0
- data/lib/docspace-api-sdk/api/Settings/telegram-api.rb +204 -0
- data/lib/docspace-api-sdk/api/Settings/tfa-settings-api.rb +586 -0
- data/lib/docspace-api-sdk/api/Settings/webhooks-api.rb +636 -0
- data/lib/docspace-api-sdk/api/Settings/webplugins-api.rb +422 -0
- data/lib/docspace-api-sdk/api/ThirdParty/third-party-api.rb +92 -0
- data/lib/docspace-api-sdk/api-client.rb +407 -0
- data/lib/docspace-api-sdk/api-error.rb +63 -0
- data/lib/docspace-api-sdk/api-model-base.rb +91 -0
- data/lib/docspace-api-sdk/configuration.rb +367 -0
- data/lib/docspace-api-sdk/models/access-request-key-dto.rb +173 -0
- data/lib/docspace-api-sdk/models/account-entry-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/account-entry-dto.rb +108 -0
- data/lib/docspace-api-sdk/models/account-info-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/account-info-dto.rb +195 -0
- data/lib/docspace-api-sdk/models/account-login-type.rb +44 -0
- data/lib/docspace-api-sdk/models/account-search-area.rb +44 -0
- data/lib/docspace-api-sdk/models/ace-short-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/ace-short-dto.rb +174 -0
- data/lib/docspace-api-sdk/models/action-link-action-request.rb +212 -0
- data/lib/docspace-api-sdk/models/action-link-request.rb +152 -0
- data/lib/docspace-api-sdk/models/action-type.rb +61 -0
- data/lib/docspace-api-sdk/models/active-connections-dto.rb +182 -0
- data/lib/docspace-api-sdk/models/active-connections-item-dto.rb +309 -0
- data/lib/docspace-api-sdk/models/active-connections-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/active-service-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/active-service-dto.rb +207 -0
- data/lib/docspace-api-sdk/models/additional-resources-dto.rb +212 -0
- data/lib/docspace-api-sdk/models/additional-resources-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/additional-white-label-settings-dto.rb +331 -0
- data/lib/docspace-api-sdk/models/additional-white-label-settings-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/additional-white-label-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/admin-message-base-settings-request-dto.rb +190 -0
- data/lib/docspace-api-sdk/models/admin-message-settings-request-dto.rb +270 -0
- data/lib/docspace-api-sdk/models/ai-action-args-prompt.rb +218 -0
- data/lib/docspace-api-sdk/models/ai-action-args.rb +204 -0
- data/lib/docspace-api-sdk/models/ai-action-type.rb +51 -0
- data/lib/docspace-api-sdk/models/ai-agent-new-items-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/ai-agents-create-request.rb +329 -0
- data/lib/docspace-api-sdk/models/ai-agents-delete-request.rb +151 -0
- data/lib/docspace-api-sdk/models/ai-agents-get200-response-all-of-response.rb +151 -0
- data/lib/docspace-api-sdk/models/ai-agents-get200-response.rb +199 -0
- data/lib/docspace-api-sdk/models/ai-agents-reset-quota-request.rb +170 -0
- data/lib/docspace-api-sdk/models/ai-agents-update-quota-request-room-ids-inner.rb +107 -0
- data/lib/docspace-api-sdk/models/ai-agents-update-quota-request.rb +197 -0
- data/lib/docspace-api-sdk/models/ai-agents-update-request.rb +283 -0
- data/lib/docspace-api-sdk/models/ai-api-date-time.rb +162 -0
- data/lib/docspace-api-sdk/models/ai-approve-tool-call-request.rb +301 -0
- data/lib/docspace-api-sdk/models/ai-assignment-mutation-result.rb +179 -0
- data/lib/docspace-api-sdk/models/ai-assignments-assign-request.rb +217 -0
- data/lib/docspace-api-sdk/models/ai-assignments-cascade-profile-delete-request.rb +168 -0
- data/lib/docspace-api-sdk/models/ai-attachment-form-keys-inner.rb +193 -0
- data/lib/docspace-api-sdk/models/ai-attachment.rb +388 -0
- data/lib/docspace-api-sdk/models/ai-attachments-link-to-message-request.rb +224 -0
- data/lib/docspace-api-sdk/models/ai-attachments-save-file-request-input.rb +233 -0
- data/lib/docspace-api-sdk/models/ai-attachments-save-file-request.rb +177 -0
- data/lib/docspace-api-sdk/models/ai-attachments-save-files-many-request.rb +178 -0
- data/lib/docspace-api-sdk/models/ai-builtin-provider-type.rb +58 -0
- data/lib/docspace-api-sdk/models/ai-bulk-assignment-result-errors-inner.rb +215 -0
- data/lib/docspace-api-sdk/models/ai-bulk-assignment-result.rb +181 -0
- data/lib/docspace-api-sdk/models/ai-chat-event.rb +273 -0
- data/lib/docspace-api-sdk/models/ai-chat-price-dto.rb +195 -0
- data/lib/docspace-api-sdk/models/ai-chat-settings-dto.rb +153 -0
- data/lib/docspace-api-sdk/models/ai-chat-tool-permission-mode.rb +44 -0
- data/lib/docspace-api-sdk/models/ai-chat-tool-prefs-scope.rb +43 -0
- data/lib/docspace-api-sdk/models/ai-config-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/ai-create-profile-input.rb +374 -0
- data/lib/docspace-api-sdk/models/ai-create-prompt-input.rb +207 -0
- data/lib/docspace-api-sdk/models/ai-distributed-task-status.rb +46 -0
- data/lib/docspace-api-sdk/models/ai-editor-tools-call-request.rb +190 -0
- data/lib/docspace-api-sdk/models/ai-editor-tools-call200-response.rb +168 -0
- data/lib/docspace-api-sdk/models/ai-editor-tools-list200-response-tools-inner.rb +251 -0
- data/lib/docspace-api-sdk/models/ai-editor-tools-list200-response.rb +170 -0
- data/lib/docspace-api-sdk/models/ai-embedding-price-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/ai-embedding-provider-type.rb +45 -0
- data/lib/docspace-api-sdk/models/ai-employee-dto.rb +249 -0
- data/lib/docspace-api-sdk/models/ai-entry-pricing-dto-ai-chat-price-dto.rb +234 -0
- data/lib/docspace-api-sdk/models/ai-entry-pricing-dto-ai-embedding-price-dto.rb +234 -0
- data/lib/docspace-api-sdk/models/ai-entry-pricing-dto-ai-image-price-dto.rb +234 -0
- data/lib/docspace-api-sdk/models/ai-entry-pricing-dto-decimal.rb +234 -0
- data/lib/docspace-api-sdk/models/ai-error-code.rb +45 -0
- data/lib/docspace-api-sdk/models/ai-error-data.rb +230 -0
- data/lib/docspace-api-sdk/models/ai-error-response.rb +169 -0
- data/lib/docspace-api-sdk/models/ai-export-text-to-docx-request-folder-id.rb +107 -0
- data/lib/docspace-api-sdk/models/ai-export-text-to-docx-request.rb +221 -0
- data/lib/docspace-api-sdk/models/ai-export-text-to-docx202-response.rb +168 -0
- data/lib/docspace-api-sdk/models/ai-file-entry-base-dto.rb +391 -0
- data/lib/docspace-api-sdk/models/ai-file-entry-dto-all-of-available-share-rights.rb +197 -0
- data/lib/docspace-api-sdk/models/ai-file-entry-dto-all-of-security.rb +565 -0
- data/lib/docspace-api-sdk/models/ai-file-entry-dto-all-of-share-settings.rb +187 -0
- data/lib/docspace-api-sdk/models/ai-file-entry-dto.rb +562 -0
- data/lib/docspace-api-sdk/models/ai-file-entry-type.rb +43 -0
- data/lib/docspace-api-sdk/models/ai-file-operation-dto.rb +331 -0
- data/lib/docspace-api-sdk/models/ai-file-operation-type.rb +50 -0
- data/lib/docspace-api-sdk/models/ai-file-operation-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/ai-file-share.rb +53 -0
- data/lib/docspace-api-sdk/models/ai-folder-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/ai-folder-content-dto.rb +247 -0
- data/lib/docspace-api-sdk/models/ai-folder-content-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/ai-folder-dto.rb +838 -0
- data/lib/docspace-api-sdk/models/ai-folder-mutation-result.rb +189 -0
- data/lib/docspace-api-sdk/models/ai-folder-type.rb +72 -0
- data/lib/docspace-api-sdk/models/ai-folder-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/ai-image-price-dto.rb +172 -0
- data/lib/docspace-api-sdk/models/ai-import-error.rb +247 -0
- data/lib/docspace-api-sdk/models/ai-import-mode.rb +43 -0
- data/lib/docspace-api-sdk/models/ai-import-result-imported.rb +194 -0
- data/lib/docspace-api-sdk/models/ai-import-result.rb +190 -0
- data/lib/docspace-api-sdk/models/ai-logo-cover-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/ai-logo-dto.rb +215 -0
- data/lib/docspace-api-sdk/models/ai-mcp-item.rb +263 -0
- data/lib/docspace-api-sdk/models/ai-metadata-match-dto.rb +186 -0
- data/lib/docspace-api-sdk/models/ai-model.rb +263 -0
- data/lib/docspace-api-sdk/models/ai-new-items-agent-new-items-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/ai-new-items-dto-agent-new-items-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/ai-open-ai-chat-completion-chunk.rb +303 -0
- data/lib/docspace-api-sdk/models/ai-open-ai-choice-delta.rb +209 -0
- data/lib/docspace-api-sdk/models/ai-open-ai-chunk-choice.rb +231 -0
- data/lib/docspace-api-sdk/models/ai-open-ai-finish-reason.rb +45 -0
- data/lib/docspace-api-sdk/models/ai-open-ai-stream-chunk.rb +107 -0
- data/lib/docspace-api-sdk/models/ai-open-ai-stream-error-error.rb +218 -0
- data/lib/docspace-api-sdk/models/ai-open-ai-stream-error.rb +168 -0
- data/lib/docspace-api-sdk/models/ai-open-ai-tool-call-delta-function.rb +160 -0
- data/lib/docspace-api-sdk/models/ai-open-ai-tool-call-delta.rb +232 -0
- data/lib/docspace-api-sdk/models/ai-open-or-create-result.rb +225 -0
- data/lib/docspace-api-sdk/models/ai-openai-chat-completions403-response-error.rb +217 -0
- data/lib/docspace-api-sdk/models/ai-openai-chat-completions403-response.rb +167 -0
- data/lib/docspace-api-sdk/models/ai-openai-images-generations403-response-error.rb +217 -0
- data/lib/docspace-api-sdk/models/ai-openai-images-generations403-response.rb +167 -0
- data/lib/docspace-api-sdk/models/ai-preferences-set-deep-mode-request.rb +177 -0
- data/lib/docspace-api-sdk/models/ai-preferences-set-reasoning-level-request.rb +199 -0
- data/lib/docspace-api-sdk/models/ai-preferences-set-tool-permission-mode-request.rb +199 -0
- data/lib/docspace-api-sdk/models/ai-price-currency-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/ai-prices-dto.rb +229 -0
- data/lib/docspace-api-sdk/models/ai-prices-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/ai-profile-mutation-result.rb +189 -0
- data/lib/docspace-api-sdk/models/ai-profile.rb +411 -0
- data/lib/docspace-api-sdk/models/ai-profiles-create400-response.rb +106 -0
- data/lib/docspace-api-sdk/models/ai-profiles-get-by-id200-response.rb +388 -0
- data/lib/docspace-api-sdk/models/ai-profiles-list-provider-models-request.rb +205 -0
- data/lib/docspace-api-sdk/models/ai-profiles-list-provider-models400-response-any-of.rb +195 -0
- data/lib/docspace-api-sdk/models/ai-profiles-list-provider-models400-response.rb +106 -0
- data/lib/docspace-api-sdk/models/ai-profiles-test-connection200-response-any-of.rb +150 -0
- data/lib/docspace-api-sdk/models/ai-profiles-test-connection200-response.rb +106 -0
- data/lib/docspace-api-sdk/models/ai-prompt-bundle.rb +251 -0
- data/lib/docspace-api-sdk/models/ai-prompt-folder.rb +250 -0
- data/lib/docspace-api-sdk/models/ai-prompt-mutation-result.rb +189 -0
- data/lib/docspace-api-sdk/models/ai-prompt.rb +287 -0
- data/lib/docspace-api-sdk/models/ai-prompts-import-bundle-request-options.rb +173 -0
- data/lib/docspace-api-sdk/models/ai-prompts-import-bundle-request.rb +177 -0
- data/lib/docspace-api-sdk/models/ai-prompts-move-request.rb +181 -0
- data/lib/docspace-api-sdk/models/ai-prompts-rename-folder-request.rb +195 -0
- data/lib/docspace-api-sdk/models/ai-prompts-update-request-updates.rb +170 -0
- data/lib/docspace-api-sdk/models/ai-prompts-update-request.rb +194 -0
- data/lib/docspace-api-sdk/models/ai-provider-type.rb +107 -0
- data/lib/docspace-api-sdk/models/ai-provider.rb +233 -0
- data/lib/docspace-api-sdk/models/ai-reasoning-depth.rb +45 -0
- data/lib/docspace-api-sdk/models/ai-reasoning-level.rb +46 -0
- data/lib/docspace-api-sdk/models/ai-reasoning-support.rb +257 -0
- data/lib/docspace-api-sdk/models/ai-regenerate-stream-request.rb +198 -0
- data/lib/docspace-api-sdk/models/ai-resolved-assignment.rb +196 -0
- data/lib/docspace-api-sdk/models/ai-room-data-lifetime-dto.rb +230 -0
- data/lib/docspace-api-sdk/models/ai-room-data-lifetime-period.rb +44 -0
- data/lib/docspace-api-sdk/models/ai-room-type.rb +47 -0
- data/lib/docspace-api-sdk/models/ai-send-custom-request.rb +231 -0
- data/lib/docspace-api-sdk/models/ai-send-request.rb +237 -0
- data/lib/docspace-api-sdk/models/ai-send-stream-body.rb +209 -0
- data/lib/docspace-api-sdk/models/ai-settings-dto.rb +238 -0
- data/lib/docspace-api-sdk/models/ai-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/ai-success-response.rb +169 -0
- data/lib/docspace-api-sdk/models/ai-thread-message-like-content-any-of-inner.rb +176 -0
- data/lib/docspace-api-sdk/models/ai-thread-message-like-content.rb +107 -0
- data/lib/docspace-api-sdk/models/ai-thread-message-like-status.rb +168 -0
- data/lib/docspace-api-sdk/models/ai-thread-message-like.rb +270 -0
- data/lib/docspace-api-sdk/models/ai-thread.rb +219 -0
- data/lib/docspace-api-sdk/models/ai-threads-append-user-message-request.rb +203 -0
- data/lib/docspace-api-sdk/models/ai-threads-append-user-message200-response.rb +168 -0
- data/lib/docspace-api-sdk/models/ai-threads-create-request.rb +188 -0
- data/lib/docspace-api-sdk/models/ai-threads-open-or-create-request-entity-meta.rb +160 -0
- data/lib/docspace-api-sdk/models/ai-threads-open-or-create-request.rb +249 -0
- data/lib/docspace-api-sdk/models/ai-threads-regenerate-title-request.rb +203 -0
- data/lib/docspace-api-sdk/models/ai-threads-regenerate-title200-response.rb +168 -0
- data/lib/docspace-api-sdk/models/ai-threads-rename-request.rb +194 -0
- data/lib/docspace-api-sdk/models/ai-threads-touch-request.rb +176 -0
- data/lib/docspace-api-sdk/models/ai-threads-update-message-request.rb +194 -0
- data/lib/docspace-api-sdk/models/ai-tool-annotations.rb +187 -0
- data/lib/docspace-api-sdk/models/ai-tool-call-data.rb +280 -0
- data/lib/docspace-api-sdk/models/ai-tool-permission-mode.rb +44 -0
- data/lib/docspace-api-sdk/models/ai-tools-add-custom-server-request.rb +204 -0
- data/lib/docspace-api-sdk/models/ai-tools-bulk-result-errors-inner.rb +193 -0
- data/lib/docspace-api-sdk/models/ai-tools-bulk-result.rb +181 -0
- data/lib/docspace-api-sdk/models/ai-tools-list-system-tools200-response.rb +228 -0
- data/lib/docspace-api-sdk/models/ai-tools-mutation-result.rb +179 -0
- data/lib/docspace-api-sdk/models/ai-tools-remove-custom-server-request.rb +176 -0
- data/lib/docspace-api-sdk/models/ai-tools-replace-all-custom-servers-request.rb +179 -0
- data/lib/docspace-api-sdk/models/ai-tools-set-allow-always-request.rb +229 -0
- data/lib/docspace-api-sdk/models/ai-tools-set-disabled-request.rb +237 -0
- data/lib/docspace-api-sdk/models/ai-tools-update-custom-server-request.rb +203 -0
- data/lib/docspace-api-sdk/models/ai-user-settings-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/ai-user-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/ai-vectorization-settings-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/ai-vectorization-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/ai-vectorization-start-task-request.rb +170 -0
- data/lib/docspace-api-sdk/models/ai-vectorization-start-task200-response.rb +222 -0
- data/lib/docspace-api-sdk/models/ai-watermark-additions.rb +46 -0
- data/lib/docspace-api-sdk/models/ai-watermark-dto.rb +321 -0
- data/lib/docspace-api-sdk/models/ai-web-search-config.rb +211 -0
- data/lib/docspace-api-sdk/models/ai-web-search-configure-request.rb +176 -0
- data/lib/docspace-api-sdk/models/ai-web-search-configure400-response.rb +106 -0
- data/lib/docspace-api-sdk/models/ai-web-search-mutation-result.rb +189 -0
- data/lib/docspace-api-sdk/models/ai-web-search-set-active-config-request.rb +176 -0
- data/lib/docspace-api-sdk/models/amazon-s3-region-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/amazon-s3-region-dto.rb +208 -0
- data/lib/docspace-api-sdk/models/anonymous-config-dto.rb +169 -0
- data/lib/docspace-api-sdk/models/api-date-time.rb +162 -0
- data/lib/docspace-api-sdk/models/api-key-response-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/api-key-response-dto.rb +288 -0
- data/lib/docspace-api-sdk/models/api-key-response-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/app-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/app-dto.rb +173 -0
- data/lib/docspace-api-sdk/models/app-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/apply-filter-option.rb +44 -0
- data/lib/docspace-api-sdk/models/archive-room-request.rb +152 -0
- data/lib/docspace-api-sdk/models/array-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/assign-metadata-templates.rb +199 -0
- data/lib/docspace-api-sdk/models/audit-event-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/audit-event-dto.rb +359 -0
- data/lib/docspace-api-sdk/models/audit-report-format.rb +43 -0
- data/lib/docspace-api-sdk/models/audit-trail-action-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/audit-trail-module-dto.rb +166 -0
- data/lib/docspace-api-sdk/models/audit-trail-product-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/audit-trail-product-dto.rb +166 -0
- data/lib/docspace-api-sdk/models/audit-trail-types-dto.rb +207 -0
- data/lib/docspace-api-sdk/models/audit-trail-types-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/auth-key-dto.rb +249 -0
- data/lib/docspace-api-sdk/models/auth-key-request.rb +249 -0
- data/lib/docspace-api-sdk/models/auth-request-dto.rb +293 -0
- data/lib/docspace-api-sdk/models/auth-service-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/auth-service-dto.rb +219 -0
- data/lib/docspace-api-sdk/models/auth-with-code-request-dto.rb +302 -0
- data/lib/docspace-api-sdk/models/authentication-token-dto.rb +216 -0
- data/lib/docspace-api-sdk/models/authentication-token-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/auto-clean-up-data-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/auto-clean-up-data-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/auto-cleanup-request-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/backup-cron-request.rb +195 -0
- data/lib/docspace-api-sdk/models/backup-history-record-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/backup-history-record-dto.rb +285 -0
- data/lib/docspace-api-sdk/models/backup-period.rb +44 -0
- data/lib/docspace-api-sdk/models/backup-progress-dto.rb +258 -0
- data/lib/docspace-api-sdk/models/backup-progress-enum.rb +44 -0
- data/lib/docspace-api-sdk/models/backup-progress-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/backup-service-state-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/backup-service-state-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/backup-storage-type.rb +47 -0
- data/lib/docspace-api-sdk/models/backups-count-result-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/backups-count-result-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/balance-dto.rb +207 -0
- data/lib/docspace-api-sdk/models/balance-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/base-batch-request-dto-all-of-file-ids.rb +106 -0
- data/lib/docspace-api-sdk/models/base-batch-request-dto-all-of-folder-ids.rb +106 -0
- data/lib/docspace-api-sdk/models/base-batch-request-dto.rb +185 -0
- data/lib/docspace-api-sdk/models/batch-request-dto-all-of-dest-folder-id.rb +108 -0
- data/lib/docspace-api-sdk/models/batch-request-dto-all-of-file-ids.rb +106 -0
- data/lib/docspace-api-sdk/models/batch-request-dto-all-of-folder-ids.rb +106 -0
- data/lib/docspace-api-sdk/models/batch-request-dto.rb +256 -0
- data/lib/docspace-api-sdk/models/batch-tags-request-dto.rb +171 -0
- data/lib/docspace-api-sdk/models/boolean-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/capabilities-dto.rb +275 -0
- data/lib/docspace-api-sdk/models/capabilities-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/change-client-activation-request.rb +169 -0
- data/lib/docspace-api-sdk/models/change-email-request.rb +188 -0
- data/lib/docspace-api-sdk/models/change-history-request.rb +179 -0
- data/lib/docspace-api-sdk/models/change-owner-request-dto.rb +195 -0
- data/lib/docspace-api-sdk/models/change-password-request.rb +164 -0
- data/lib/docspace-api-sdk/models/change-wallet-service-state-request-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/chat-settings-dto.rb +153 -0
- data/lib/docspace-api-sdk/models/chat-settings.rb +184 -0
- data/lib/docspace-api-sdk/models/check-confirm-request-dto.rb +250 -0
- data/lib/docspace-api-sdk/models/check-conversion-request-dto.rb +214 -0
- data/lib/docspace-api-sdk/models/check-dest-folder-dto.rb +187 -0
- data/lib/docspace-api-sdk/models/check-dest-folder-result.rb +44 -0
- data/lib/docspace-api-sdk/models/check-dest-folder-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/check-doc-service-url-request-dto.rb +210 -0
- data/lib/docspace-api-sdk/models/check-fill-form-draft-request.rb +200 -0
- data/lib/docspace-api-sdk/models/check-move-or-copy-batch-items-dest-folder-id-parameter.rb +108 -0
- data/lib/docspace-api-sdk/models/check-move-or-copy-batch-items-folder-ids-parameter-inner.rb +106 -0
- data/lib/docspace-api-sdk/models/check-upload-request.rb +155 -0
- data/lib/docspace-api-sdk/models/chunked-upload-session-dto.rb +207 -0
- data/lib/docspace-api-sdk/models/chunked-upload-session-result-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/chunked-upload-session-result-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/chunked-upload-session-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/client-info-response.rb +306 -0
- data/lib/docspace-api-sdk/models/client-response.rb +402 -0
- data/lib/docspace-api-sdk/models/client-secret-response.rb +152 -0
- data/lib/docspace-api-sdk/models/co-editing-config-dto.rb +194 -0
- data/lib/docspace-api-sdk/models/co-editing-config-mode.rb +43 -0
- data/lib/docspace-api-sdk/models/color-theme-colors-dto.rb +164 -0
- data/lib/docspace-api-sdk/models/color-theme-colors-request-dto.rb +164 -0
- data/lib/docspace-api-sdk/models/company-white-label-settings-dto.rb +288 -0
- data/lib/docspace-api-sdk/models/company-white-label-settings-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/company-white-label-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/configuration-dto.rb +394 -0
- data/lib/docspace-api-sdk/models/configuration-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/confirm-data.rb +175 -0
- data/lib/docspace-api-sdk/models/confirm-dto.rb +234 -0
- data/lib/docspace-api-sdk/models/confirm-type.rb +61 -0
- data/lib/docspace-api-sdk/models/confirm-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/connection-test-result-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/connection-test-result-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/contact.rb +164 -0
- data/lib/docspace-api-sdk/models/conversation-result-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/conversation-result-dto.rb +274 -0
- data/lib/docspace-api-sdk/models/convert-document-layout-request.rb +175 -0
- data/lib/docspace-api-sdk/models/convert-document-renderer-request.rb +153 -0
- data/lib/docspace-api-sdk/models/convert-file-request-dto.rb +287 -0
- data/lib/docspace-api-sdk/models/convert-pdf-request.rb +152 -0
- data/lib/docspace-api-sdk/models/convert-spreadsheet-layout-request.rb +239 -0
- data/lib/docspace-api-sdk/models/convert-spreadsheet-margins-request.rb +186 -0
- data/lib/docspace-api-sdk/models/convert-spreadsheet-page-size-request.rb +164 -0
- data/lib/docspace-api-sdk/models/convert-thumbnail-request.rb +186 -0
- data/lib/docspace-api-sdk/models/cookie-settings-dto.rb +196 -0
- data/lib/docspace-api-sdk/models/cookie-settings-request-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/cookie-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/copy-as-request-dest-folder-id.rb +108 -0
- data/lib/docspace-api-sdk/models/copy-as-request.rb +212 -0
- data/lib/docspace-api-sdk/models/cover-request-dto.rb +181 -0
- data/lib/docspace-api-sdk/models/covers-result-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/covers-result-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/create-api-key-request-dto.rb +235 -0
- data/lib/docspace-api-sdk/models/create-backup-schedule-request-dto.rb +218 -0
- data/lib/docspace-api-sdk/models/create-client-request.rb +612 -0
- data/lib/docspace-api-sdk/models/create-file-request-template-id.rb +108 -0
- data/lib/docspace-api-sdk/models/create-file-request.rb +208 -0
- data/lib/docspace-api-sdk/models/create-folder-request.rb +179 -0
- data/lib/docspace-api-sdk/models/create-metadata-template-request-dto.rb +178 -0
- data/lib/docspace-api-sdk/models/create-room-from-template-dto.rb +373 -0
- data/lib/docspace-api-sdk/models/create-room-request-dto.rb +422 -0
- data/lib/docspace-api-sdk/models/create-tag-request-dto.rb +179 -0
- data/lib/docspace-api-sdk/models/create-text-or-html-file-request.rb +200 -0
- data/lib/docspace-api-sdk/models/create-third-party-room-request.rb +289 -0
- data/lib/docspace-api-sdk/models/create-webhooks-config-request-dto.rb +345 -0
- data/lib/docspace-api-sdk/models/cron-params-dto.rb +194 -0
- data/lib/docspace-api-sdk/models/csp-dto.rb +170 -0
- data/lib/docspace-api-sdk/models/csp-request-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/csp-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/currencies-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/currencies-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/current-license-info.rb +196 -0
- data/lib/docspace-api-sdk/models/custom-color-theme-dto.rb +183 -0
- data/lib/docspace-api-sdk/models/custom-color-theme-request-dto.rb +183 -0
- data/lib/docspace-api-sdk/models/custom-color-themes-settings-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/custom-color-themes-settings-request-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/custom-color-themes-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/custom-field-request.rb +166 -0
- data/lib/docspace-api-sdk/models/custom-field-value-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/custom-field-value-dto.rb +164 -0
- data/lib/docspace-api-sdk/models/custom-filter-request.rb +152 -0
- data/lib/docspace-api-sdk/models/customer-config-dto.rb +208 -0
- data/lib/docspace-api-sdk/models/customer-info-dto.rb +227 -0
- data/lib/docspace-api-sdk/models/customer-info-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/customer-monthly-usage-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/customer-monthly-usage-dto.rb +193 -0
- data/lib/docspace-api-sdk/models/customer-monthly-usage-report-request-dto.rb +164 -0
- data/lib/docspace-api-sdk/models/customer-operations-report-request-dto.rb +273 -0
- data/lib/docspace-api-sdk/models/customer-service-usage-dto.rb +236 -0
- data/lib/docspace-api-sdk/models/customer-service-usage-report-dto.rb +205 -0
- data/lib/docspace-api-sdk/models/customer-service-usage-report-request-dto.rb +253 -0
- data/lib/docspace-api-sdk/models/customer-service-usage-report-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/customization-config-dto.rb +263 -0
- data/lib/docspace-api-sdk/models/dark-theme-settings-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/dark-theme-settings-request-dto.rb +191 -0
- data/lib/docspace-api-sdk/models/dark-theme-settings-type.rb +44 -0
- data/lib/docspace-api-sdk/models/dark-theme-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/date-to-auto-clean-up.rb +47 -0
- data/lib/docspace-api-sdk/models/deep-link-configuration-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/deep-link-dto.rb +181 -0
- data/lib/docspace-api-sdk/models/deep-link-handling-mode.rb +44 -0
- data/lib/docspace-api-sdk/models/deep-link-settings-request-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/default-product-request-dto.rb +191 -0
- data/lib/docspace-api-sdk/models/default-template-item-dto.rb +210 -0
- data/lib/docspace-api-sdk/models/default-template-settings-dto.rb +157 -0
- data/lib/docspace-api-sdk/models/default-template-settings-request-dto-selected-file.rb +108 -0
- data/lib/docspace-api-sdk/models/default-template-settings-request-dto.rb +181 -0
- data/lib/docspace-api-sdk/models/default-template-settings-reset-request-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/default-template-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/delete-batch-request-dto-all-of-file-ids.rb +106 -0
- data/lib/docspace-api-sdk/models/delete-batch-request-dto-all-of-folder-ids.rb +106 -0
- data/lib/docspace-api-sdk/models/delete-batch-request-dto.rb +205 -0
- data/lib/docspace-api-sdk/models/delete-file-request.rb +162 -0
- data/lib/docspace-api-sdk/models/delete-folder-request.rb +162 -0
- data/lib/docspace-api-sdk/models/delete-room-request.rb +152 -0
- data/lib/docspace-api-sdk/models/delete-version-batch-request-dto.rb +211 -0
- data/lib/docspace-api-sdk/models/discount-category-dto.rb +183 -0
- data/lib/docspace-api-sdk/models/display-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/distributed-task-status.rb +46 -0
- data/lib/docspace-api-sdk/models/dns-settings-request-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/doc-service-url-dto.rb +287 -0
- data/lib/docspace-api-sdk/models/doc-service-url-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/docs-cloud-config-dto.rb +217 -0
- data/lib/docspace-api-sdk/models/docs-cloud-config-request-dto.rb +217 -0
- data/lib/docspace-api-sdk/models/docs-cloud-config-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/docs-cloud-dev-pack-request-dto.rb +180 -0
- data/lib/docspace-api-sdk/models/docs-cloud-ip-filter-config-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/docs-cloud-ip-filter-config-request.rb +155 -0
- data/lib/docspace-api-sdk/models/docs-cloud-ip-filter-rule-dto.rb +187 -0
- data/lib/docspace-api-sdk/models/docs-cloud-ip-filter-rule-request.rb +187 -0
- data/lib/docspace-api-sdk/models/docs-cloud-license-info-dto.rb +172 -0
- data/lib/docspace-api-sdk/models/docs-cloud-payment-dto.rb +224 -0
- data/lib/docspace-api-sdk/models/docs-cloud-quota-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/docs-cloud-quota-user-dto.rb +164 -0
- data/lib/docspace-api-sdk/models/docs-cloud-quota-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/docs-cloud-security-config-dto.rb +212 -0
- data/lib/docspace-api-sdk/models/docs-cloud-security-config-request.rb +212 -0
- data/lib/docspace-api-sdk/models/docs-cloud-server-config-dto.rb +190 -0
- data/lib/docspace-api-sdk/models/docs-cloud-server-config-request.rb +190 -0
- data/lib/docspace-api-sdk/models/docs-cloud-server-info-dto.rb +174 -0
- data/lib/docspace-api-sdk/models/docs-cloud-stats-dto.rb +172 -0
- data/lib/docspace-api-sdk/models/docs-cloud-tenant-dto.rb +257 -0
- data/lib/docspace-api-sdk/models/docs-cloud-tenant-info-dto.rb +182 -0
- data/lib/docspace-api-sdk/models/docs-cloud-tenant-info-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/docs-cloud-tenant-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/docs-cloud-usage-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/docs-cloud-usage-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/docs-cloud-user-stats-dto.rb +192 -0
- data/lib/docspace-api-sdk/models/docs-cloud-users-limit-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/docs-cloud-wopi-config-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/docs-cloud-wopi-config-request.rb +152 -0
- data/lib/docspace-api-sdk/models/document-builder-task-dto.rb +309 -0
- data/lib/docspace-api-sdk/models/document-builder-task-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/document-config-dto.rb +268 -0
- data/lib/docspace-api-sdk/models/document-options-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/domain-name-rules-dto.rb +173 -0
- data/lib/docspace-api-sdk/models/double-nullable-wrapper.rb +195 -0
- data/lib/docspace-api-sdk/models/double-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/download-request-dto-all-of-file-ids.rb +106 -0
- data/lib/docspace-api-sdk/models/download-request-dto-all-of-folder-ids.rb +106 -0
- data/lib/docspace-api-sdk/models/download-request-dto.rb +198 -0
- data/lib/docspace-api-sdk/models/download-request-item-dto-key.rb +108 -0
- data/lib/docspace-api-sdk/models/download-request-item-dto.rb +192 -0
- data/lib/docspace-api-sdk/models/draft-location.rb +184 -0
- data/lib/docspace-api-sdk/models/duplicate-request-dto-all-of-file-ids.rb +106 -0
- data/lib/docspace-api-sdk/models/duplicate-request-dto-all-of-folder-ids.rb +106 -0
- data/lib/docspace-api-sdk/models/duplicate-request-dto.rb +185 -0
- data/lib/docspace-api-sdk/models/edit-history-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/edit-history-author-dto.rb +166 -0
- data/lib/docspace-api-sdk/models/edit-history-changes-dto.rb +173 -0
- data/lib/docspace-api-sdk/models/edit-history-data-dto.rb +240 -0
- data/lib/docspace-api-sdk/models/edit-history-data-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/edit-history-dto.rb +238 -0
- data/lib/docspace-api-sdk/models/edit-history-url-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/editor-configuration-dto.rb +289 -0
- data/lib/docspace-api-sdk/models/editor-tool-call-parameters-dto.rb +109 -0
- data/lib/docspace-api-sdk/models/editor-tool-call-state-dto.rb +182 -0
- data/lib/docspace-api-sdk/models/editor-type.rb +44 -0
- data/lib/docspace-api-sdk/models/email-activation-settings-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/email-activation-settings-request-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/email-activation-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/email-invitation-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/email-member-request-dto.rb +230 -0
- data/lib/docspace-api-sdk/models/embedded-config-dto.rb +197 -0
- data/lib/docspace-api-sdk/models/employee-activation-status.rb +45 -0
- data/lib/docspace-api-sdk/models/employee-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/employee-dto.rb +249 -0
- data/lib/docspace-api-sdk/models/employee-full-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/employee-full-dto.rb +637 -0
- data/lib/docspace-api-sdk/models/employee-full-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/employee-status.rb +46 -0
- data/lib/docspace-api-sdk/models/employee-type.rb +46 -0
- data/lib/docspace-api-sdk/models/employee-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/enabled-module-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/enabled-module-dto.rb +164 -0
- data/lib/docspace-api-sdk/models/encryption-key-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/encryption-key-dto.rb +205 -0
- data/lib/docspace-api-sdk/models/encryption-key-request-dto.rb +174 -0
- data/lib/docspace-api-sdk/models/encryption-settings-dto.rb +195 -0
- data/lib/docspace-api-sdk/models/encryption-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/encryption-status.rb +45 -0
- data/lib/docspace-api-sdk/models/entity-quota-dto.rb +173 -0
- data/lib/docspace-api-sdk/models/entity-quota-settings-dto.rb +189 -0
- data/lib/docspace-api-sdk/models/entity-quota-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/entry-field-dto.rb +228 -0
- data/lib/docspace-api-sdk/models/entry-metadata-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/entry-metadata-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/entry-template-dto.rb +228 -0
- data/lib/docspace-api-sdk/models/entry-type.rb +49 -0
- data/lib/docspace-api-sdk/models/error-api-response-error.rb +182 -0
- data/lib/docspace-api-sdk/models/error-api-response.rb +171 -0
- data/lib/docspace-api-sdk/models/exchange-token200-response.rb +181 -0
- data/lib/docspace-api-sdk/models/external-database-connection-request-dto.rb +260 -0
- data/lib/docspace-api-sdk/models/external-database-type.rb +43 -0
- data/lib/docspace-api-sdk/models/external-db-sync-form-result-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/external-db-sync-task-dto.rb +284 -0
- data/lib/docspace-api-sdk/models/external-db-sync-task-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/external-resource-dto.rb +165 -0
- data/lib/docspace-api-sdk/models/external-resources-dto.rb +242 -0
- data/lib/docspace-api-sdk/models/external-share-dto.rb +384 -0
- data/lib/docspace-api-sdk/models/external-share-request-param.rb +153 -0
- data/lib/docspace-api-sdk/models/external-share-status.rb +47 -0
- data/lib/docspace-api-sdk/models/external-share-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/external-sharing-settings-dto.rb +192 -0
- data/lib/docspace-api-sdk/models/external-sharing-settings-request-dto.rb +192 -0
- data/lib/docspace-api-sdk/models/external-sharing-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/feature-used-dto.rb +165 -0
- data/lib/docspace-api-sdk/models/feedback-config-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/field-error.rb +172 -0
- data/lib/docspace-api-sdk/models/file-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/file-conflict-resolve-type.rb +44 -0
- data/lib/docspace-api-sdk/models/file-dto-all-of-view-accessibility.rb +232 -0
- data/lib/docspace-api-sdk/models/file-dto.rb +927 -0
- data/lib/docspace-api-sdk/models/file-encryption-info-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/file-encryption-info-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/file-entry-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/file-entry-base-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/file-entry-base-dto.rb +391 -0
- data/lib/docspace-api-sdk/models/file-entry-base-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/file-entry-dto.rb +562 -0
- data/lib/docspace-api-sdk/models/file-entry-type.rb +43 -0
- data/lib/docspace-api-sdk/models/file-keys-dto.rb +203 -0
- data/lib/docspace-api-sdk/models/file-link-dto.rb +179 -0
- data/lib/docspace-api-sdk/models/file-link-request.rb +294 -0
- data/lib/docspace-api-sdk/models/file-link-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/file-operation-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/file-operation-dto.rb +331 -0
- data/lib/docspace-api-sdk/models/file-operation-request-base-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/file-operation-type.rb +50 -0
- data/lib/docspace-api-sdk/models/file-operation-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/file-reference-data-dto.rb +185 -0
- data/lib/docspace-api-sdk/models/file-reference-dto.rb +229 -0
- data/lib/docspace-api-sdk/models/file-reference-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/file-share-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/file-share-dto.rb +430 -0
- data/lib/docspace-api-sdk/models/file-share-link.rb +303 -0
- data/lib/docspace-api-sdk/models/file-share-params.rb +220 -0
- data/lib/docspace-api-sdk/models/file-share-response-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/file-share-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/file-share.rb +53 -0
- data/lib/docspace-api-sdk/models/file-status.rb +51 -0
- data/lib/docspace-api-sdk/models/file-type.rb +51 -0
- data/lib/docspace-api-sdk/models/file-upload-result-dto.rb +173 -0
- data/lib/docspace-api-sdk/models/file-upload-result-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/file-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/files-settings-dto-internal-formats.rb +232 -0
- data/lib/docspace-api-sdk/models/files-settings-dto.rb +892 -0
- data/lib/docspace-api-sdk/models/files-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/files-statistics-folder.rb +163 -0
- data/lib/docspace-api-sdk/models/files-statistics-result-dto.rb +202 -0
- data/lib/docspace-api-sdk/models/files-statistics-result-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/filling-form-result-dto.rb +236 -0
- data/lib/docspace-api-sdk/models/filling-form-result-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/filter-type.rb +62 -0
- data/lib/docspace-api-sdk/models/finish-dto.rb +169 -0
- data/lib/docspace-api-sdk/models/firebase-device-dto.rb +205 -0
- data/lib/docspace-api-sdk/models/firebase-device-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/firebase-dto.rb +246 -0
- data/lib/docspace-api-sdk/models/firebase-request-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/folder-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/folder-content-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/folder-content-dto.rb +247 -0
- data/lib/docspace-api-sdk/models/folder-content-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/folder-dto.rb +838 -0
- data/lib/docspace-api-sdk/models/folder-link-request.rb +294 -0
- data/lib/docspace-api-sdk/models/folder-metadata-search.rb +328 -0
- data/lib/docspace-api-sdk/models/folder-type.rb +72 -0
- data/lib/docspace-api-sdk/models/folder-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/form-filling-manage-action.rb +45 -0
- data/lib/docspace-api-sdk/models/form-filling-status.rb +47 -0
- data/lib/docspace-api-sdk/models/form-gallery-dto.rb +233 -0
- data/lib/docspace-api-sdk/models/form-metadata-dto.rb +188 -0
- data/lib/docspace-api-sdk/models/form-results-dto.rb +165 -0
- data/lib/docspace-api-sdk/models/form-role-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/form-role-dto.rb +284 -0
- data/lib/docspace-api-sdk/models/form-role-request.rb +224 -0
- data/lib/docspace-api-sdk/models/form-submissions-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/form-submissions-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/forms-item-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/forms-item-data-dto.rb +186 -0
- data/lib/docspace-api-sdk/models/forms-item-dto.rb +164 -0
- data/lib/docspace-api-sdk/models/generate-docx-tool-call-parameters-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/generate-form-tool-call-parameters-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/generate-presentation-tool-call-parameters-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/get-portal-prices200-response-links-inner.rb +161 -0
- data/lib/docspace-api-sdk/models/get-portal-prices200-response.rb +196 -0
- data/lib/docspace-api-sdk/models/get-reference-data-dto.rb +200 -0
- data/lib/docspace-api-sdk/models/goback-config-dto.rb +153 -0
- data/lib/docspace-api-sdk/models/greeting-settings-request-dto.rb +179 -0
- data/lib/docspace-api-sdk/models/group-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/group-dto.rb +302 -0
- data/lib/docspace-api-sdk/models/group-member-security-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/group-member-security-dto.rb +309 -0
- data/lib/docspace-api-sdk/models/group-request-dto.rb +202 -0
- data/lib/docspace-api-sdk/models/group-summary-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/group-summary-dto.rb +204 -0
- data/lib/docspace-api-sdk/models/group-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/hide-confirm-convert-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/history-action-dto.rb +185 -0
- data/lib/docspace-api-sdk/models/history-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/history-data-dto.rb +153 -0
- data/lib/docspace-api-sdk/models/history-dto.rb +273 -0
- data/lib/docspace-api-sdk/models/i-compress-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/icon-request.rb +153 -0
- data/lib/docspace-api-sdk/models/image-size-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/importable-api-entity.rb +152 -0
- data/lib/docspace-api-sdk/models/info-config-dto.rb +231 -0
- data/lib/docspace-api-sdk/models/int32-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/int64-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/invitation-link-create-request-dto.rb +237 -0
- data/lib/docspace-api-sdk/models/invitation-link-delete-request-dto.rb +169 -0
- data/lib/docspace-api-sdk/models/invitation-link-dto.rb +253 -0
- data/lib/docspace-api-sdk/models/invitation-link-update-request-dto.rb +215 -0
- data/lib/docspace-api-sdk/models/invitation-link-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/invite-users-request-dto.rb +182 -0
- data/lib/docspace-api-sdk/models/ip-restriction-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/ip-restriction-dto.rb +185 -0
- data/lib/docspace-api-sdk/models/ip-restriction-entry-dto.rb +165 -0
- data/lib/docspace-api-sdk/models/ip-restrictions-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/ip-restrictions-settings-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/ip-restrictions-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/ip-restrictions-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/is-default-white-label-logos-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/is-default-white-label-logos-dto.rb +182 -0
- data/lib/docspace-api-sdk/models/is-default-white-label-logos-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/item-key-value-pair-boolean-string-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/item-key-value-pair-boolean-string.rb +163 -0
- data/lib/docspace-api-sdk/models/item-key-value-pair-object-object.rb +162 -0
- data/lib/docspace-api-sdk/models/item-key-value-pair-string-boolean.rb +163 -0
- data/lib/docspace-api-sdk/models/item-key-value-pair-string-logo-request-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/item-key-value-pair-string-string.rb +164 -0
- data/lib/docspace-api-sdk/models/json-value-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/licensor-details-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/licensor-details-dto.rb +347 -0
- data/lib/docspace-api-sdk/models/licensor-details-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/link-account-request-dto.rb +153 -0
- data/lib/docspace-api-sdk/models/link-type.rb +43 -0
- data/lib/docspace-api-sdk/models/location-type.rb +49 -0
- data/lib/docspace-api-sdk/models/lock-file-request.rb +152 -0
- data/lib/docspace-api-sdk/models/login-event-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/login-event-dto.rb +303 -0
- data/lib/docspace-api-sdk/models/login-provider.rb +56 -0
- data/lib/docspace-api-sdk/models/login-settings-dto.rb +250 -0
- data/lib/docspace-api-sdk/models/login-settings-request-dto.rb +256 -0
- data/lib/docspace-api-sdk/models/login-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/logo-config-dto.rb +207 -0
- data/lib/docspace-api-sdk/models/logo-cover-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/logo-dto.rb +215 -0
- data/lib/docspace-api-sdk/models/logo-request-dto.rb +164 -0
- data/lib/docspace-api-sdk/models/logo-request.rb +330 -0
- data/lib/docspace-api-sdk/models/mail-domain-settings-request-dto.rb +233 -0
- data/lib/docspace-api-sdk/models/manage-form-filling-dto.rb +201 -0
- data/lib/docspace-api-sdk/models/member-request-dto.rb +424 -0
- data/lib/docspace-api-sdk/models/members-request.rb +155 -0
- data/lib/docspace-api-sdk/models/mention-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/mention-dto.rb +206 -0
- data/lib/docspace-api-sdk/models/mention-message-request.rb +200 -0
- data/lib/docspace-api-sdk/models/message-action.rb +403 -0
- data/lib/docspace-api-sdk/models/metadata-conflict-resolve-type.rb +43 -0
- data/lib/docspace-api-sdk/models/metadata-field-dto.rb +228 -0
- data/lib/docspace-api-sdk/models/metadata-field-option-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/metadata-field-option-request.rb +164 -0
- data/lib/docspace-api-sdk/models/metadata-field-request.rb +209 -0
- data/lib/docspace-api-sdk/models/metadata-field-type.rb +46 -0
- data/lib/docspace-api-sdk/models/metadata-field-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/metadata-filter-condition-request.rb +220 -0
- data/lib/docspace-api-sdk/models/metadata-match-dto.rb +186 -0
- data/lib/docspace-api-sdk/models/metadata-operation-dto.rb +197 -0
- data/lib/docspace-api-sdk/models/metadata-operation-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/metadata-template-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/metadata-template-dto.rb +226 -0
- data/lib/docspace-api-sdk/models/metadata-template-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/metadata-value-dto.rb +187 -0
- data/lib/docspace-api-sdk/models/metadata-value-request.rb +215 -0
- data/lib/docspace-api-sdk/models/migrating-api-files.rb +172 -0
- data/lib/docspace-api-sdk/models/migrating-api-group.rb +194 -0
- data/lib/docspace-api-sdk/models/migrating-api-user.rb +256 -0
- data/lib/docspace-api-sdk/models/migration-api-info.rb +335 -0
- data/lib/docspace-api-sdk/models/migration-status-dto.rb +183 -0
- data/lib/docspace-api-sdk/models/migration-status-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/mobile-phone-activation-status.rb +43 -0
- data/lib/docspace-api-sdk/models/mobile-request-dto.rb +153 -0
- data/lib/docspace-api-sdk/models/model-module.rb +239 -0
- data/lib/docspace-api-sdk/models/module-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/multi-size-logo-cover-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/new-items-dto-file-entry-base-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/new-items-dto-room-new-items-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/new-items-file-entry-base-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/new-items-room-new-items-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/notification-channel-dto.rb +182 -0
- data/lib/docspace-api-sdk/models/notification-channel-status-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/notification-channel-status-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/notification-settings-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/notification-settings-request-dto.rb +201 -0
- data/lib/docspace-api-sdk/models/notification-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/notification-type.rb +45 -0
- data/lib/docspace-api-sdk/models/object-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/operation-dto.rb +345 -0
- data/lib/docspace-api-sdk/models/operation-order-type.rb +43 -0
- data/lib/docspace-api-sdk/models/operation-status.rb +45 -0
- data/lib/docspace-api-sdk/models/operation-token-usage-dto.rb +212 -0
- data/lib/docspace-api-sdk/models/operation-type.rb +61 -0
- data/lib/docspace-api-sdk/models/order-by-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/order-request-dto.rb +180 -0
- data/lib/docspace-api-sdk/models/orders-item-request-dto.rb +263 -0
- data/lib/docspace-api-sdk/models/orders-request-dto.rb +157 -0
- data/lib/docspace-api-sdk/models/owner-change-instructions-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/owner-change-instructions-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/owner-id-settings-request-dto.rb +169 -0
- data/lib/docspace-api-sdk/models/pageable-client-info-response.rb +184 -0
- data/lib/docspace-api-sdk/models/pageable-client-response.rb +184 -0
- data/lib/docspace-api-sdk/models/pageable-modification-response.rb +172 -0
- data/lib/docspace-api-sdk/models/pageable-response.rb +182 -0
- data/lib/docspace-api-sdk/models/password-hash-settings-dto.rb +173 -0
- data/lib/docspace-api-sdk/models/password-settings-dto.rb +302 -0
- data/lib/docspace-api-sdk/models/password-settings-request-dto.rb +199 -0
- data/lib/docspace-api-sdk/models/password-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/payment-calculation-dto.rb +183 -0
- data/lib/docspace-api-sdk/models/payment-calculation-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/payment-method-status.rb +44 -0
- data/lib/docspace-api-sdk/models/payment-settings-dto.rb +260 -0
- data/lib/docspace-api-sdk/models/payment-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/payment-url-request-dto.rb +279 -0
- data/lib/docspace-api-sdk/models/payments.rb +43 -0
- data/lib/docspace-api-sdk/models/permissions-config-dto.rb +242 -0
- data/lib/docspace-api-sdk/models/plugins-config-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/plugins-dto.rb +172 -0
- data/lib/docspace-api-sdk/models/portal-user-dto.rb +496 -0
- data/lib/docspace-api-sdk/models/portal-user-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/price-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/price-status.rb +44 -0
- data/lib/docspace-api-sdk/models/price-time-unit.rb +48 -0
- data/lib/docspace-api-sdk/models/problem-detail.rb +216 -0
- data/lib/docspace-api-sdk/models/product-administrator-dto.rb +223 -0
- data/lib/docspace-api-sdk/models/product-administrator-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/product-quantity-type.rb +45 -0
- data/lib/docspace-api-sdk/models/product-type.rb +45 -0
- data/lib/docspace-api-sdk/models/provider-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/provider-dto.rb +216 -0
- data/lib/docspace-api-sdk/models/provider-filter.rb +51 -0
- data/lib/docspace-api-sdk/models/quantity-request-dto.rb +189 -0
- data/lib/docspace-api-sdk/models/quota-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/quota-dto.rb +354 -0
- data/lib/docspace-api-sdk/models/quota-filter.rb +44 -0
- data/lib/docspace-api-sdk/models/quota-scope.rb +44 -0
- data/lib/docspace-api-sdk/models/quota-settings-request-dto-default-quota.rb +108 -0
- data/lib/docspace-api-sdk/models/quota-settings-request-dto.rb +178 -0
- data/lib/docspace-api-sdk/models/quota-state.rb +43 -0
- data/lib/docspace-api-sdk/models/quota-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/recaptcha-type.rb +45 -0
- data/lib/docspace-api-sdk/models/recent-config-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/reg-status.rb +44 -0
- data/lib/docspace-api-sdk/models/report-dto.rb +205 -0
- data/lib/docspace-api-sdk/models/report-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/request-location.rb +44 -0
- data/lib/docspace-api-sdk/models/restricted-ai-models-dto.rb +157 -0
- data/lib/docspace-api-sdk/models/restricted-ai-models-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/review-config-dto.rb +153 -0
- data/lib/docspace-api-sdk/models/room-data-lifetime-dto.rb +230 -0
- data/lib/docspace-api-sdk/models/room-data-lifetime-period.rb +44 -0
- data/lib/docspace-api-sdk/models/room-from-template-status-dto.rb +236 -0
- data/lib/docspace-api-sdk/models/room-from-template-status-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/room-group-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/room-group-dto.rb +238 -0
- data/lib/docspace-api-sdk/models/room-group-request-dto.rb +293 -0
- data/lib/docspace-api-sdk/models/room-group-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/room-invitation-request.rb +197 -0
- data/lib/docspace-api-sdk/models/room-invitation.rb +220 -0
- data/lib/docspace-api-sdk/models/room-link-request.rb +339 -0
- data/lib/docspace-api-sdk/models/room-new-items-dto.rb +165 -0
- data/lib/docspace-api-sdk/models/room-privacy-filter.rb +44 -0
- data/lib/docspace-api-sdk/models/room-security-dto.rb +198 -0
- data/lib/docspace-api-sdk/models/room-security-error.rb +43 -0
- data/lib/docspace-api-sdk/models/room-security-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/room-template-dto.rb +364 -0
- data/lib/docspace-api-sdk/models/room-template-status-dto.rb +234 -0
- data/lib/docspace-api-sdk/models/room-template-status-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/room-type.rb +47 -0
- data/lib/docspace-api-sdk/models/rooms-metadata-search-request-dto.rb +330 -0
- data/lib/docspace-api-sdk/models/rooms-notification-settings-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/rooms-notification-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/rooms-notifications-settings-request-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/run-builder-script-output-request.rb +175 -0
- data/lib/docspace-api-sdk/models/run-builder-script-request-dto-argument.rb +108 -0
- data/lib/docspace-api-sdk/models/run-builder-script-request-dto.rb +211 -0
- data/lib/docspace-api-sdk/models/sales-request-dto.rb +277 -0
- data/lib/docspace-api-sdk/models/save-additional-resources-request.rb +212 -0
- data/lib/docspace-api-sdk/models/save-as-pdf-request.rb +182 -0
- data/lib/docspace-api-sdk/models/save-auth-keys-request-dto.rb +219 -0
- data/lib/docspace-api-sdk/models/save-company-info-request.rb +347 -0
- data/lib/docspace-api-sdk/models/save-form-role-mapping-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/schedule-dto.rb +312 -0
- data/lib/docspace-api-sdk/models/schedule-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/scope-response.rb +172 -0
- data/lib/docspace-api-sdk/models/search-area.rb +51 -0
- data/lib/docspace-api-sdk/models/security-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/security-dto.rb +199 -0
- data/lib/docspace-api-sdk/models/security-info-request-dto.rb +226 -0
- data/lib/docspace-api-sdk/models/security-info-simple-request-dto.rb +200 -0
- data/lib/docspace-api-sdk/models/security-request-dto.rb +206 -0
- data/lib/docspace-api-sdk/models/service-price-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/service-price-dto.rb +296 -0
- data/lib/docspace-api-sdk/models/session-request.rb +206 -0
- data/lib/docspace-api-sdk/models/set-app-enabled-request.rb +169 -0
- data/lib/docspace-api-sdk/models/set-app-settings-request.rb +152 -0
- data/lib/docspace-api-sdk/models/set-audit-lifetime-settings-request.rb +172 -0
- data/lib/docspace-api-sdk/models/set-custom-fields.rb +171 -0
- data/lib/docspace-api-sdk/models/set-manager-request.rb +169 -0
- data/lib/docspace-api-sdk/models/set-metadata-values.rb +171 -0
- data/lib/docspace-api-sdk/models/set-public-dto.rb +197 -0
- data/lib/docspace-api-sdk/models/set-restricted-ai-models-request-dto.rb +171 -0
- data/lib/docspace-api-sdk/models/set-wallet-top-up-settings-request.rb +269 -0
- data/lib/docspace-api-sdk/models/settings-dto.rb +684 -0
- data/lib/docspace-api-sdk/models/settings-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/share-filter-type.rb +49 -0
- data/lib/docspace-api-sdk/models/signup-account-request-dto.rb +211 -0
- data/lib/docspace-api-sdk/models/smtp-operation-status-dto.rb +195 -0
- data/lib/docspace-api-sdk/models/smtp-operation-status-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/smtp-settings-dto.rb +368 -0
- data/lib/docspace-api-sdk/models/smtp-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/socket-settings-dto.rb +153 -0
- data/lib/docspace-api-sdk/models/socket-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/sort-order.rb +43 -0
- data/lib/docspace-api-sdk/models/sorted-by-type.rb +54 -0
- data/lib/docspace-api-sdk/models/sso-binding-type-dto.rb +164 -0
- data/lib/docspace-api-sdk/models/sso-certificate-dto.rb +216 -0
- data/lib/docspace-api-sdk/models/sso-encrypt-algorithm-type-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/sso-field-mapping-dto.rb +208 -0
- data/lib/docspace-api-sdk/models/sso-idp-certificate-action-type-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/sso-idp-certificate-advanced-dto.rb +204 -0
- data/lib/docspace-api-sdk/models/sso-idp-settings-dto.rb +208 -0
- data/lib/docspace-api-sdk/models/sso-name-id-format-type-dto.rb +252 -0
- data/lib/docspace-api-sdk/models/sso-settings-constants-dto.rb +202 -0
- data/lib/docspace-api-sdk/models/sso-settings-constants-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/sso-settings-dto.rb +270 -0
- data/lib/docspace-api-sdk/models/sso-settings-request-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/sso-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/sso-signing-algorithm-type-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/sso-sp-certificate-action-type-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/sso-sp-certificate-advanced-dto.rb +215 -0
- data/lib/docspace-api-sdk/models/start-backup-request-dto.rb +197 -0
- data/lib/docspace-api-sdk/models/start-backup-restore-request-dto.rb +220 -0
- data/lib/docspace-api-sdk/models/start-edit-request.rb +152 -0
- data/lib/docspace-api-sdk/models/start-filling-form.rb +153 -0
- data/lib/docspace-api-sdk/models/start-filling-mode.rb +45 -0
- data/lib/docspace-api-sdk/models/start-reassign-request-dto.rb +206 -0
- data/lib/docspace-api-sdk/models/start-update-user-type-dto.rb +195 -0
- data/lib/docspace-api-sdk/models/storage-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/storage-dto.rb +235 -0
- data/lib/docspace-api-sdk/models/storage-encryption-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/storage-filter.rb +44 -0
- data/lib/docspace-api-sdk/models/storage-request-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/storage-settings-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/storage-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/string-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/string-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/studio-default-page-settings-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/studio-default-page-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/sub-account-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/subject-type.rb +46 -0
- data/lib/docspace-api-sdk/models/submit-form-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/subscription-balance-dto.rb +234 -0
- data/lib/docspace-api-sdk/models/subscription-balance-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tariff-dto.rb +271 -0
- data/lib/docspace-api-sdk/models/tariff-quota-dto.rb +246 -0
- data/lib/docspace-api-sdk/models/tariff-state.rb +45 -0
- data/lib/docspace-api-sdk/models/tariff-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/task-progress-response-dto.rb +269 -0
- data/lib/docspace-api-sdk/models/task-progress-response-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/telegram-status-dto.rb +202 -0
- data/lib/docspace-api-sdk/models/telegram-status-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/templates-config-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/templates-request-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/tenant-ai-access-settings-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/tenant-ai-access-settings-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/tenant-ai-access-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tenant-audit-settings-dto.rb +172 -0
- data/lib/docspace-api-sdk/models/tenant-audit-settings-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/tenant-audit-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tenant-banner-settings-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/tenant-banner-settings-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/tenant-banner-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tenant-deep-link-settings-dto.rb +184 -0
- data/lib/docspace-api-sdk/models/tenant-deep-link-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tenant-dev-tools-access-settings-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/tenant-dev-tools-access-settings-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/tenant-dev-tools-access-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tenant-dto.rb +418 -0
- data/lib/docspace-api-sdk/models/tenant-industry.rb +58 -0
- data/lib/docspace-api-sdk/models/tenant-quota-dto.rb +610 -0
- data/lib/docspace-api-sdk/models/tenant-quota-feature-dto.rb +217 -0
- data/lib/docspace-api-sdk/models/tenant-quota-settings-dto.rb +183 -0
- data/lib/docspace-api-sdk/models/tenant-quota-settings-request-dto.rb +179 -0
- data/lib/docspace-api-sdk/models/tenant-quota-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tenant-quota-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tenant-status.rb +49 -0
- data/lib/docspace-api-sdk/models/tenant-trusted-domains-type.rb +44 -0
- data/lib/docspace-api-sdk/models/tenant-user-invitation-settings-dto.rb +196 -0
- data/lib/docspace-api-sdk/models/tenant-user-invitation-settings-request-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/tenant-user-invitation-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tenant-wallet-service-settings-dto.rb +187 -0
- data/lib/docspace-api-sdk/models/tenant-wallet-service-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tenant-wallet-service.rb +48 -0
- data/lib/docspace-api-sdk/models/tenant-wallet-settings-dto.rb +213 -0
- data/lib/docspace-api-sdk/models/tenant-wallet-settings-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/tenant-wallet-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tenant-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/terminate-request-dto.rb +169 -0
- data/lib/docspace-api-sdk/models/tfa-app-code-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/tfa-app-code-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/tfa-confirm-data-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/tfa-confirm-data-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tfa-request-dto.rb +223 -0
- data/lib/docspace-api-sdk/models/tfa-settings-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/tfa-settings-dto.rb +261 -0
- data/lib/docspace-api-sdk/models/tfa-setup-code-dto.rb +175 -0
- data/lib/docspace-api-sdk/models/tfa-setup-code-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/tfa-type.rb +44 -0
- data/lib/docspace-api-sdk/models/tfa-validate-request-dto.rb +165 -0
- data/lib/docspace-api-sdk/models/third-party-account-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/third-party-account-dto.rb +195 -0
- data/lib/docspace-api-sdk/models/third-party-backup-request-dto.rb +208 -0
- data/lib/docspace-api-sdk/models/third-party-check-conversion-request-dto.rb +215 -0
- data/lib/docspace-api-sdk/models/third-party-chunked-upload-session-dto.rb +207 -0
- data/lib/docspace-api-sdk/models/third-party-chunked-upload-session-result-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/third-party-chunked-upload-session-result-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/third-party-chunked-upload-session-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/third-party-configuration-dto.rb +394 -0
- data/lib/docspace-api-sdk/models/third-party-configuration-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/third-party-draft-location.rb +186 -0
- data/lib/docspace-api-sdk/models/third-party-file-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/third-party-file-dto.rb +928 -0
- data/lib/docspace-api-sdk/models/third-party-file-entry-dto.rb +566 -0
- data/lib/docspace-api-sdk/models/third-party-file-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/third-party-folder-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/third-party-folder-content-dto.rb +247 -0
- data/lib/docspace-api-sdk/models/third-party-folder-content-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/third-party-folder-dto.rb +839 -0
- data/lib/docspace-api-sdk/models/third-party-folder-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/third-party-request-dto.rb +223 -0
- data/lib/docspace-api-sdk/models/third-party-save-as-pdf-request.rb +168 -0
- data/lib/docspace-api-sdk/models/third-party-upload-session-response-dto.rb +216 -0
- data/lib/docspace-api-sdk/models/third-party-upload-session-response-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/thumbnail.rb +46 -0
- data/lib/docspace-api-sdk/models/thumbnails-data-dto.rb +208 -0
- data/lib/docspace-api-sdk/models/thumbnails-data-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/thumbnails-request.rb +193 -0
- data/lib/docspace-api-sdk/models/time-bound-dto.rb +163 -0
- data/lib/docspace-api-sdk/models/timezone-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/timezone-dto.rb +168 -0
- data/lib/docspace-api-sdk/models/token-diagnostics-dto.rb +166 -0
- data/lib/docspace-api-sdk/models/token-diagnostics-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/top-up-deposit-request-dto.rb +215 -0
- data/lib/docspace-api-sdk/models/transaction-info-dto.rb +173 -0
- data/lib/docspace-api-sdk/models/turn-on-admin-message-settings-request-dto.rb +152 -0
- data/lib/docspace-api-sdk/models/upcoming-payment-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/upcoming-payment-dto.rb +236 -0
- data/lib/docspace-api-sdk/models/update-api-key-request.rb +212 -0
- data/lib/docspace-api-sdk/models/update-client-request.rb +424 -0
- data/lib/docspace-api-sdk/models/update-comment-request.rb +222 -0
- data/lib/docspace-api-sdk/models/update-file-request.rb +187 -0
- data/lib/docspace-api-sdk/models/update-folder-metadata-template-request.rb +184 -0
- data/lib/docspace-api-sdk/models/update-group-request.rb +213 -0
- data/lib/docspace-api-sdk/models/update-member-culture-request.rb +187 -0
- data/lib/docspace-api-sdk/models/update-member-request-dto.rb +350 -0
- data/lib/docspace-api-sdk/models/update-members-quota-request-dto-quota.rb +108 -0
- data/lib/docspace-api-sdk/models/update-members-quota-request-dto.rb +164 -0
- data/lib/docspace-api-sdk/models/update-members-request-dto.rb +165 -0
- data/lib/docspace-api-sdk/models/update-metadata-field-request.rb +209 -0
- data/lib/docspace-api-sdk/models/update-metadata-template.rb +164 -0
- data/lib/docspace-api-sdk/models/update-photo-member-request.rb +153 -0
- data/lib/docspace-api-sdk/models/update-room-group-request.rb +203 -0
- data/lib/docspace-api-sdk/models/update-room-request.rb +348 -0
- data/lib/docspace-api-sdk/models/update-rooms-quota-request-dto.rb +165 -0
- data/lib/docspace-api-sdk/models/update-rooms-room-ids-request-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/update-tag-request-dto.rb +216 -0
- data/lib/docspace-api-sdk/models/update-webhooks-config-request-dto.rb +385 -0
- data/lib/docspace-api-sdk/models/upload-result-dto.rb +173 -0
- data/lib/docspace-api-sdk/models/upload-result-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/upload-session-response-dto.rb +214 -0
- data/lib/docspace-api-sdk/models/upload-session-response-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/usage-space-stat-item-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/usage-space-stat-item-dto.rb +196 -0
- data/lib/docspace-api-sdk/models/user-config-dto.rb +199 -0
- data/lib/docspace-api-sdk/models/user-exists-response-dto.rb +201 -0
- data/lib/docspace-api-sdk/models/user-exists-response-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/user-invitation-request-dto.rb +210 -0
- data/lib/docspace-api-sdk/models/user-invitation.rb +165 -0
- data/lib/docspace-api-sdk/models/validation-error-response.rb +174 -0
- data/lib/docspace-api-sdk/models/validation-result.rb +48 -0
- data/lib/docspace-api-sdk/models/vectorization-status.rb +44 -0
- data/lib/docspace-api-sdk/models/wallet-quantity-request-dto.rb +221 -0
- data/lib/docspace-api-sdk/models/wallet-service-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/wallet-service-dto.rb +397 -0
- data/lib/docspace-api-sdk/models/wallet-service-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/watermark-additions.rb +46 -0
- data/lib/docspace-api-sdk/models/watermark-dto.rb +321 -0
- data/lib/docspace-api-sdk/models/watermark-on-draw-dto.rb +219 -0
- data/lib/docspace-api-sdk/models/watermark-paragraph-dto.rb +165 -0
- data/lib/docspace-api-sdk/models/watermark-request-dto.rb +271 -0
- data/lib/docspace-api-sdk/models/watermark-text-run-dto.rb +177 -0
- data/lib/docspace-api-sdk/models/web-item-security-request-dto.rb +178 -0
- data/lib/docspace-api-sdk/models/web-items-security-request-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/web-plugin-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/web-plugin-dto.rb +452 -0
- data/lib/docspace-api-sdk/models/web-plugin-request.rb +189 -0
- data/lib/docspace-api-sdk/models/web-plugin-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/webhook-group-status.rb +47 -0
- data/lib/docspace-api-sdk/models/webhook-retry-request-dto.rb +155 -0
- data/lib/docspace-api-sdk/models/webhook-trigger-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/webhook-trigger-dto.rb +173 -0
- data/lib/docspace-api-sdk/models/webhook-trigger.rb +73 -0
- data/lib/docspace-api-sdk/models/webhooks-config-dto.rb +329 -0
- data/lib/docspace-api-sdk/models/webhooks-config-with-status-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/webhooks-config-with-status-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/webhooks-config-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/webhooks-log-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/webhooks-log-dto.rb +309 -0
- data/lib/docspace-api-sdk/models/webhooks-log-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/white-label-item-array-wrapper.rb +196 -0
- data/lib/docspace-api-sdk/models/white-label-item-dto.rb +205 -0
- data/lib/docspace-api-sdk/models/white-label-item-path-dto.rb +164 -0
- data/lib/docspace-api-sdk/models/white-label-item-size-dto.rb +252 -0
- data/lib/docspace-api-sdk/models/white-label-logo-type.rb +57 -0
- data/lib/docspace-api-sdk/models/white-label-request-dto.rb +190 -0
- data/lib/docspace-api-sdk/models/wizard-request-dto.rb +211 -0
- data/lib/docspace-api-sdk/models/wizard-settings-dto.rb +162 -0
- data/lib/docspace-api-sdk/models/wizard-settings-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/models/xlsx-report-response-dto.rb +172 -0
- data/lib/docspace-api-sdk/models/xlsx-report-response-wrapper.rb +194 -0
- data/lib/docspace-api-sdk/version.rb +20 -0
- data/lib/docspace-api-sdk.rb +1153 -0
- metadata +1208 -0
|
@@ -0,0 +1,2571 @@
|
|
|
1
|
+
# (c) Copyright Ascensio System SIA 2026
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
require 'cgi'
|
|
17
|
+
|
|
18
|
+
module DocspaceApiSdk
|
|
19
|
+
module Portal
|
|
20
|
+
class PaymentApi
|
|
21
|
+
attr_accessor :api_client
|
|
22
|
+
|
|
23
|
+
def initialize(api_client = ApiClient.default)
|
|
24
|
+
@api_client = api_client
|
|
25
|
+
end
|
|
26
|
+
# Calculate the wallet payment amount
|
|
27
|
+
# Prices a wallet-service purchase without making it: it returns what buying the requested number of units would cost right now, so a client can show the amount before asking for a confirmation. Only `productQuantityType` `Add` (1) is accepted, the quantity must be greater than zero, and the portal needs a billing customer whose wallet has a sub-account in the accounting currency. The caller has to be a DocSpace administrator. Nothing is bought, charged or written down - the call is read-only and may be repeated - and the purchase itself is `PUT api/2.0/portal/payment/updatewallet`. The answer carries the amount with its currency, the quantity it was computed for and the identifier of the calculation. It is the price of this moment and is not held: it can differ by the time the purchase is made.
|
|
28
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/calculate-wallet-payment/
|
|
29
|
+
# @param [Hash] opts the optional parameters
|
|
30
|
+
# @option opts [WalletQuantityRequestDto] :wallet_quantity_request_dto
|
|
31
|
+
# @return [PaymentCalculationWrapper]
|
|
32
|
+
def calculate_wallet_payment(opts = {})
|
|
33
|
+
data, _status_code, _headers = calculate_wallet_payment_with_http_info(opts)
|
|
34
|
+
data
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# Calculate the wallet payment amount
|
|
38
|
+
# Prices a wallet-service purchase without making it: it returns what buying the requested number of units would cost right now, so a client can show the amount before asking for a confirmation. Only `productQuantityType` `Add` (1) is accepted, the quantity must be greater than zero, and the portal needs a billing customer whose wallet has a sub-account in the accounting currency. The caller has to be a DocSpace administrator. Nothing is bought, charged or written down - the call is read-only and may be repeated - and the purchase itself is `PUT api/2.0/portal/payment/updatewallet`. The answer carries the amount with its currency, the quantity it was computed for and the identifier of the calculation. It is the price of this moment and is not held: it can differ by the time the purchase is made.
|
|
39
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/calculate-wallet-payment/
|
|
40
|
+
# @param [Hash] opts the optional parameters
|
|
41
|
+
# @option opts [WalletQuantityRequestDto] :wallet_quantity_request_dto
|
|
42
|
+
# @return [Array<(PaymentCalculationWrapper, Integer, Hash)>] PaymentCalculationWrapper data, response status code and response headers
|
|
43
|
+
def calculate_wallet_payment_with_http_info(opts = {})
|
|
44
|
+
if @api_client.config.debugging
|
|
45
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.calculate_wallet_payment ...'
|
|
46
|
+
end
|
|
47
|
+
# resource path
|
|
48
|
+
local_var_path = '/api/2.0/portal/payment/calculatewallet'
|
|
49
|
+
|
|
50
|
+
# query parameters
|
|
51
|
+
query_params = opts[:query_params] || {}
|
|
52
|
+
|
|
53
|
+
# header parameters
|
|
54
|
+
header_params = opts[:header_params] || {}
|
|
55
|
+
# HTTP header 'Accept' (if needed)
|
|
56
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
57
|
+
# HTTP header 'Content-Type'
|
|
58
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
59
|
+
if !content_type.nil?
|
|
60
|
+
header_params['Content-Type'] = content_type
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
# form parameters
|
|
64
|
+
form_params = opts[:form_params] || {}
|
|
65
|
+
|
|
66
|
+
# http body (model)
|
|
67
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'wallet_quantity_request_dto'])
|
|
68
|
+
|
|
69
|
+
# return_type
|
|
70
|
+
return_type = opts[:debug_return_type] || 'PaymentCalculationWrapper'
|
|
71
|
+
|
|
72
|
+
# auth_names
|
|
73
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
74
|
+
|
|
75
|
+
new_options = opts.merge(
|
|
76
|
+
:operation => :"Portal::PaymentApi.calculate_wallet_payment",
|
|
77
|
+
:header_params => header_params,
|
|
78
|
+
:query_params => query_params,
|
|
79
|
+
:form_params => form_params,
|
|
80
|
+
:body => post_body,
|
|
81
|
+
:auth_names => auth_names,
|
|
82
|
+
:return_type => return_type
|
|
83
|
+
)
|
|
84
|
+
|
|
85
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
86
|
+
if @api_client.config.debugging
|
|
87
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#calculate_wallet_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
88
|
+
end
|
|
89
|
+
return data, status_code, headers
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
# Switch a wallet service
|
|
93
|
+
# Switches one wallet service on or off for the portal: `service` names it and `enabled` says which way. The portal needs a billing customer, and the caller needs both the permission to edit the portal settings and DocSpace administrator rights. Order matters between the two AI services - AI tools has to be on before AI search may be switched on, and switching AI tools off switches AI search off with it - so a request that breaks that order is refused with 403. The call is mutating and idempotent: switching on a service that is already on changes nothing. It is written to the portal audit trail, and switching AI tools notifies the portal clients so the AI features appear or disappear for them without a reload. The whole updated set of switched-on services comes back. Switching a service on does not buy it - its units are still bought with `PUT api/2.0/portal/payment/updatewallet`.
|
|
94
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/change-tenant-wallet-service-state/
|
|
95
|
+
# @param [Hash] opts the optional parameters
|
|
96
|
+
# @option opts [ChangeWalletServiceStateRequestDto] :change_wallet_service_state_request_dto
|
|
97
|
+
# @return [TenantWalletServiceSettingsWrapper]
|
|
98
|
+
def change_tenant_wallet_service_state(opts = {})
|
|
99
|
+
data, _status_code, _headers = change_tenant_wallet_service_state_with_http_info(opts)
|
|
100
|
+
data
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
# Switch a wallet service
|
|
104
|
+
# Switches one wallet service on or off for the portal: `service` names it and `enabled` says which way. The portal needs a billing customer, and the caller needs both the permission to edit the portal settings and DocSpace administrator rights. Order matters between the two AI services - AI tools has to be on before AI search may be switched on, and switching AI tools off switches AI search off with it - so a request that breaks that order is refused with 403. The call is mutating and idempotent: switching on a service that is already on changes nothing. It is written to the portal audit trail, and switching AI tools notifies the portal clients so the AI features appear or disappear for them without a reload. The whole updated set of switched-on services comes back. Switching a service on does not buy it - its units are still bought with `PUT api/2.0/portal/payment/updatewallet`.
|
|
105
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/change-tenant-wallet-service-state/
|
|
106
|
+
# @param [Hash] opts the optional parameters
|
|
107
|
+
# @option opts [ChangeWalletServiceStateRequestDto] :change_wallet_service_state_request_dto
|
|
108
|
+
# @return [Array<(TenantWalletServiceSettingsWrapper, Integer, Hash)>] TenantWalletServiceSettingsWrapper data, response status code and response headers
|
|
109
|
+
def change_tenant_wallet_service_state_with_http_info(opts = {})
|
|
110
|
+
if @api_client.config.debugging
|
|
111
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.change_tenant_wallet_service_state ...'
|
|
112
|
+
end
|
|
113
|
+
# resource path
|
|
114
|
+
local_var_path = '/api/2.0/portal/payment/servicestate'
|
|
115
|
+
|
|
116
|
+
# query parameters
|
|
117
|
+
query_params = opts[:query_params] || {}
|
|
118
|
+
|
|
119
|
+
# header parameters
|
|
120
|
+
header_params = opts[:header_params] || {}
|
|
121
|
+
# HTTP header 'Accept' (if needed)
|
|
122
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
123
|
+
# HTTP header 'Content-Type'
|
|
124
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
125
|
+
if !content_type.nil?
|
|
126
|
+
header_params['Content-Type'] = content_type
|
|
127
|
+
end
|
|
128
|
+
|
|
129
|
+
# form parameters
|
|
130
|
+
form_params = opts[:form_params] || {}
|
|
131
|
+
|
|
132
|
+
# http body (model)
|
|
133
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'change_wallet_service_state_request_dto'])
|
|
134
|
+
|
|
135
|
+
# return_type
|
|
136
|
+
return_type = opts[:debug_return_type] || 'TenantWalletServiceSettingsWrapper'
|
|
137
|
+
|
|
138
|
+
# auth_names
|
|
139
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
140
|
+
|
|
141
|
+
new_options = opts.merge(
|
|
142
|
+
:operation => :"Portal::PaymentApi.change_tenant_wallet_service_state",
|
|
143
|
+
:header_params => header_params,
|
|
144
|
+
:query_params => query_params,
|
|
145
|
+
:form_params => form_params,
|
|
146
|
+
:body => post_body,
|
|
147
|
+
:auth_names => auth_names,
|
|
148
|
+
:return_type => return_type
|
|
149
|
+
)
|
|
150
|
+
|
|
151
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
152
|
+
if @api_client.config.debugging
|
|
153
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#change_tenant_wallet_service_state\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
154
|
+
end
|
|
155
|
+
return data, status_code, headers
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
# Start the monthly usage report
|
|
159
|
+
# Queues the wallet spending added up per calendar month as an `xlsx` file and returns the task that will build it; the file is not ready when the response arrives. The portal needs a billing customer and the caller has to be a DocSpace administrator. The body takes only the period - `startDate` and `endDate`, both inclusive - and an empty body covers everything from the portal creation date to now; the months are cut in the portal time zone, exactly as in `GET api/2.0/portal/payment/customer/usage/monthly`. Poll `GET api/2.0/portal/payment/customer/usage/monthly/report` until `isCompleted` is true, then take the file from `resultFileUrl` or open `resultFileId`: the finished file is saved into the caller's own My documents section, where it counts against the portal storage like any other file. One monthly usage report per user is tracked at a time - a call made while the previous one is still running answers with that task - and `DELETE api/2.0/portal/payment/customer/usage/monthly/report` stops it. There is no service filter here: for a report per service use `POST api/2.0/portal/payment/customer/usage/report`.
|
|
160
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/create-customer-monthly-usage-report/
|
|
161
|
+
# @param [Hash] opts the optional parameters
|
|
162
|
+
# @option opts [CustomerMonthlyUsageReportRequestDto] :customer_monthly_usage_report_request_dto
|
|
163
|
+
# @return [DocumentBuilderTaskWrapper]
|
|
164
|
+
def create_customer_monthly_usage_report(opts = {})
|
|
165
|
+
data, _status_code, _headers = create_customer_monthly_usage_report_with_http_info(opts)
|
|
166
|
+
data
|
|
167
|
+
end
|
|
168
|
+
|
|
169
|
+
# Start the monthly usage report
|
|
170
|
+
# Queues the wallet spending added up per calendar month as an `xlsx` file and returns the task that will build it; the file is not ready when the response arrives. The portal needs a billing customer and the caller has to be a DocSpace administrator. The body takes only the period - `startDate` and `endDate`, both inclusive - and an empty body covers everything from the portal creation date to now; the months are cut in the portal time zone, exactly as in `GET api/2.0/portal/payment/customer/usage/monthly`. Poll `GET api/2.0/portal/payment/customer/usage/monthly/report` until `isCompleted` is true, then take the file from `resultFileUrl` or open `resultFileId`: the finished file is saved into the caller's own My documents section, where it counts against the portal storage like any other file. One monthly usage report per user is tracked at a time - a call made while the previous one is still running answers with that task - and `DELETE api/2.0/portal/payment/customer/usage/monthly/report` stops it. There is no service filter here: for a report per service use `POST api/2.0/portal/payment/customer/usage/report`.
|
|
171
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/create-customer-monthly-usage-report/
|
|
172
|
+
# @param [Hash] opts the optional parameters
|
|
173
|
+
# @option opts [CustomerMonthlyUsageReportRequestDto] :customer_monthly_usage_report_request_dto
|
|
174
|
+
# @return [Array<(DocumentBuilderTaskWrapper, Integer, Hash)>] DocumentBuilderTaskWrapper data, response status code and response headers
|
|
175
|
+
def create_customer_monthly_usage_report_with_http_info(opts = {})
|
|
176
|
+
if @api_client.config.debugging
|
|
177
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.create_customer_monthly_usage_report ...'
|
|
178
|
+
end
|
|
179
|
+
# resource path
|
|
180
|
+
local_var_path = '/api/2.0/portal/payment/customer/usage/monthly/report'
|
|
181
|
+
|
|
182
|
+
# query parameters
|
|
183
|
+
query_params = opts[:query_params] || {}
|
|
184
|
+
|
|
185
|
+
# header parameters
|
|
186
|
+
header_params = opts[:header_params] || {}
|
|
187
|
+
# HTTP header 'Accept' (if needed)
|
|
188
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
189
|
+
# HTTP header 'Content-Type'
|
|
190
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
191
|
+
if !content_type.nil?
|
|
192
|
+
header_params['Content-Type'] = content_type
|
|
193
|
+
end
|
|
194
|
+
|
|
195
|
+
# form parameters
|
|
196
|
+
form_params = opts[:form_params] || {}
|
|
197
|
+
|
|
198
|
+
# http body (model)
|
|
199
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'customer_monthly_usage_report_request_dto'])
|
|
200
|
+
|
|
201
|
+
# return_type
|
|
202
|
+
return_type = opts[:debug_return_type] || 'DocumentBuilderTaskWrapper'
|
|
203
|
+
|
|
204
|
+
# auth_names
|
|
205
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
206
|
+
|
|
207
|
+
new_options = opts.merge(
|
|
208
|
+
:operation => :"Portal::PaymentApi.create_customer_monthly_usage_report",
|
|
209
|
+
:header_params => header_params,
|
|
210
|
+
:query_params => query_params,
|
|
211
|
+
:form_params => form_params,
|
|
212
|
+
:body => post_body,
|
|
213
|
+
:auth_names => auth_names,
|
|
214
|
+
:return_type => return_type
|
|
215
|
+
)
|
|
216
|
+
|
|
217
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
218
|
+
if @api_client.config.debugging
|
|
219
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#create_customer_monthly_usage_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
220
|
+
end
|
|
221
|
+
return data, status_code, headers
|
|
222
|
+
end
|
|
223
|
+
|
|
224
|
+
# Start the operations report
|
|
225
|
+
# Queues the history of the wallet movements as an `xlsx` file and returns the task that will build it; the file is not ready when the response arrives. The portal needs a billing customer and the caller has to be a DocSpace administrator. The body takes the same filters as `GET api/2.0/portal/payment/customer/operations` - the service names, the date range, the participant, the operation type and status, the credit and debit directions and the ordering - and an empty body reports everything from the portal creation date to now; a service name this installation does not sell fails with 404. Poll `GET api/2.0/portal/payment/customer/operationsreport` until `isCompleted` is true, then take the file from `resultFileUrl` or open `resultFileId`: the finished file is saved into the caller's own My documents section, where it counts against the portal storage like any other file. One operations report per user is tracked at a time - a call made while the previous one is still running answers with that task - and `DELETE api/2.0/portal/payment/customer/operationsreport` stops it. A build that fails ends the task with `error` filled in rather than failing this call.
|
|
226
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/create-customer-operations-report/
|
|
227
|
+
# @param [Hash] opts the optional parameters
|
|
228
|
+
# @option opts [CustomerOperationsReportRequestDto] :customer_operations_report_request_dto
|
|
229
|
+
# @return [DocumentBuilderTaskWrapper]
|
|
230
|
+
def create_customer_operations_report(opts = {})
|
|
231
|
+
data, _status_code, _headers = create_customer_operations_report_with_http_info(opts)
|
|
232
|
+
data
|
|
233
|
+
end
|
|
234
|
+
|
|
235
|
+
# Start the operations report
|
|
236
|
+
# Queues the history of the wallet movements as an `xlsx` file and returns the task that will build it; the file is not ready when the response arrives. The portal needs a billing customer and the caller has to be a DocSpace administrator. The body takes the same filters as `GET api/2.0/portal/payment/customer/operations` - the service names, the date range, the participant, the operation type and status, the credit and debit directions and the ordering - and an empty body reports everything from the portal creation date to now; a service name this installation does not sell fails with 404. Poll `GET api/2.0/portal/payment/customer/operationsreport` until `isCompleted` is true, then take the file from `resultFileUrl` or open `resultFileId`: the finished file is saved into the caller's own My documents section, where it counts against the portal storage like any other file. One operations report per user is tracked at a time - a call made while the previous one is still running answers with that task - and `DELETE api/2.0/portal/payment/customer/operationsreport` stops it. A build that fails ends the task with `error` filled in rather than failing this call.
|
|
237
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/create-customer-operations-report/
|
|
238
|
+
# @param [Hash] opts the optional parameters
|
|
239
|
+
# @option opts [CustomerOperationsReportRequestDto] :customer_operations_report_request_dto
|
|
240
|
+
# @return [Array<(DocumentBuilderTaskWrapper, Integer, Hash)>] DocumentBuilderTaskWrapper data, response status code and response headers
|
|
241
|
+
def create_customer_operations_report_with_http_info(opts = {})
|
|
242
|
+
if @api_client.config.debugging
|
|
243
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.create_customer_operations_report ...'
|
|
244
|
+
end
|
|
245
|
+
# resource path
|
|
246
|
+
local_var_path = '/api/2.0/portal/payment/customer/operationsreport'
|
|
247
|
+
|
|
248
|
+
# query parameters
|
|
249
|
+
query_params = opts[:query_params] || {}
|
|
250
|
+
|
|
251
|
+
# header parameters
|
|
252
|
+
header_params = opts[:header_params] || {}
|
|
253
|
+
# HTTP header 'Accept' (if needed)
|
|
254
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
255
|
+
# HTTP header 'Content-Type'
|
|
256
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
257
|
+
if !content_type.nil?
|
|
258
|
+
header_params['Content-Type'] = content_type
|
|
259
|
+
end
|
|
260
|
+
|
|
261
|
+
# form parameters
|
|
262
|
+
form_params = opts[:form_params] || {}
|
|
263
|
+
|
|
264
|
+
# http body (model)
|
|
265
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'customer_operations_report_request_dto'])
|
|
266
|
+
|
|
267
|
+
# return_type
|
|
268
|
+
return_type = opts[:debug_return_type] || 'DocumentBuilderTaskWrapper'
|
|
269
|
+
|
|
270
|
+
# auth_names
|
|
271
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
272
|
+
|
|
273
|
+
new_options = opts.merge(
|
|
274
|
+
:operation => :"Portal::PaymentApi.create_customer_operations_report",
|
|
275
|
+
:header_params => header_params,
|
|
276
|
+
:query_params => query_params,
|
|
277
|
+
:form_params => form_params,
|
|
278
|
+
:body => post_body,
|
|
279
|
+
:auth_names => auth_names,
|
|
280
|
+
:return_type => return_type
|
|
281
|
+
)
|
|
282
|
+
|
|
283
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
284
|
+
if @api_client.config.debugging
|
|
285
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#create_customer_operations_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
286
|
+
end
|
|
287
|
+
return data, status_code, headers
|
|
288
|
+
end
|
|
289
|
+
|
|
290
|
+
# Start the service usage report
|
|
291
|
+
# Queues the usage of the wallet services as an `xlsx` file and returns the task that will build it; the file is not ready when the response arrives. The portal needs a billing customer and the caller has to be a DocSpace administrator. The body takes the same filters as `GET api/2.0/portal/payment/customer/usage` - the service names, the date range, the participant, the operation status, the usage metadata and the ordering - and an empty body reports every service from the portal creation date to now; a service name this installation does not sell fails with 404. Poll `GET api/2.0/portal/payment/customer/usage/report` until `isCompleted` is true, then take the file from `resultFileUrl` or open `resultFileId`: the finished file is saved into the caller's own My documents section, where it counts against the portal storage like any other file. One service usage report per user is tracked at a time - a call made while the previous one is still running answers with that task - and `DELETE api/2.0/portal/payment/customer/usage/report` stops it. It is a different report from the operations one and does not interfere with it: per-movement history is `POST api/2.0/portal/payment/customer/operationsreport`.
|
|
292
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/create-customer-service-usage-report/
|
|
293
|
+
# @param [Hash] opts the optional parameters
|
|
294
|
+
# @option opts [CustomerServiceUsageReportRequestDto] :customer_service_usage_report_request_dto
|
|
295
|
+
# @return [DocumentBuilderTaskWrapper]
|
|
296
|
+
def create_customer_service_usage_report(opts = {})
|
|
297
|
+
data, _status_code, _headers = create_customer_service_usage_report_with_http_info(opts)
|
|
298
|
+
data
|
|
299
|
+
end
|
|
300
|
+
|
|
301
|
+
# Start the service usage report
|
|
302
|
+
# Queues the usage of the wallet services as an `xlsx` file and returns the task that will build it; the file is not ready when the response arrives. The portal needs a billing customer and the caller has to be a DocSpace administrator. The body takes the same filters as `GET api/2.0/portal/payment/customer/usage` - the service names, the date range, the participant, the operation status, the usage metadata and the ordering - and an empty body reports every service from the portal creation date to now; a service name this installation does not sell fails with 404. Poll `GET api/2.0/portal/payment/customer/usage/report` until `isCompleted` is true, then take the file from `resultFileUrl` or open `resultFileId`: the finished file is saved into the caller's own My documents section, where it counts against the portal storage like any other file. One service usage report per user is tracked at a time - a call made while the previous one is still running answers with that task - and `DELETE api/2.0/portal/payment/customer/usage/report` stops it. It is a different report from the operations one and does not interfere with it: per-movement history is `POST api/2.0/portal/payment/customer/operationsreport`.
|
|
303
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/create-customer-service-usage-report/
|
|
304
|
+
# @param [Hash] opts the optional parameters
|
|
305
|
+
# @option opts [CustomerServiceUsageReportRequestDto] :customer_service_usage_report_request_dto
|
|
306
|
+
# @return [Array<(DocumentBuilderTaskWrapper, Integer, Hash)>] DocumentBuilderTaskWrapper data, response status code and response headers
|
|
307
|
+
def create_customer_service_usage_report_with_http_info(opts = {})
|
|
308
|
+
if @api_client.config.debugging
|
|
309
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.create_customer_service_usage_report ...'
|
|
310
|
+
end
|
|
311
|
+
# resource path
|
|
312
|
+
local_var_path = '/api/2.0/portal/payment/customer/usage/report'
|
|
313
|
+
|
|
314
|
+
# query parameters
|
|
315
|
+
query_params = opts[:query_params] || {}
|
|
316
|
+
|
|
317
|
+
# header parameters
|
|
318
|
+
header_params = opts[:header_params] || {}
|
|
319
|
+
# HTTP header 'Accept' (if needed)
|
|
320
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
321
|
+
# HTTP header 'Content-Type'
|
|
322
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
323
|
+
if !content_type.nil?
|
|
324
|
+
header_params['Content-Type'] = content_type
|
|
325
|
+
end
|
|
326
|
+
|
|
327
|
+
# form parameters
|
|
328
|
+
form_params = opts[:form_params] || {}
|
|
329
|
+
|
|
330
|
+
# http body (model)
|
|
331
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'customer_service_usage_report_request_dto'])
|
|
332
|
+
|
|
333
|
+
# return_type
|
|
334
|
+
return_type = opts[:debug_return_type] || 'DocumentBuilderTaskWrapper'
|
|
335
|
+
|
|
336
|
+
# auth_names
|
|
337
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
338
|
+
|
|
339
|
+
new_options = opts.merge(
|
|
340
|
+
:operation => :"Portal::PaymentApi.create_customer_service_usage_report",
|
|
341
|
+
:header_params => header_params,
|
|
342
|
+
:query_params => query_params,
|
|
343
|
+
:form_params => form_params,
|
|
344
|
+
:body => post_body,
|
|
345
|
+
:auth_names => auth_names,
|
|
346
|
+
:return_type => return_type
|
|
347
|
+
)
|
|
348
|
+
|
|
349
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
350
|
+
if @api_client.config.debugging
|
|
351
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#create_customer_service_usage_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
352
|
+
end
|
|
353
|
+
return data, status_code, headers
|
|
354
|
+
end
|
|
355
|
+
|
|
356
|
+
# Get the service prices from the accounting service
|
|
357
|
+
# Returns the portal's automatic wallet top-up settings: whether it is switched on, the balance that triggers it, the balance it tops the wallet up to and the currency it charges in. Only a DocSpace administrator may read it, no billing customer is needed, and the call is read-only. A portal that has never configured it gets the defaults rather than an empty result, so `enabled` is the field that says whether anything happens at all. Two of the values are kept by the portal itself and cannot be set through this API: `lowBalanceThreshold` is the balance below which the portal warns its administrators by mail, and `lowBalanceNotified` says whether that warning has already gone out for the current dip. Change the rest with `POST api/2.0/portal/payment/topupsettings`.
|
|
358
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-accounting-service-prices/
|
|
359
|
+
# @param service_name [String] The service whose price list is read, named the way the billing catalogue names it, such as `ai-tools` or `backup`. Take the value from the `serviceName` field of `GET api/2.0/portal/payment/walletservices`; a name the accounting service does not price yields an empty list rather than an error.
|
|
360
|
+
# @param [Hash] opts the optional parameters
|
|
361
|
+
# @option opts [Boolean] :active Whether the answer is narrowed to the prices in force at the moment of the call. Leaving it false also returns the retired and the not yet started ones, which is what pricing a movement recorded in the past needs.
|
|
362
|
+
# @return [ServicePriceArrayWrapper]
|
|
363
|
+
def get_accounting_service_prices(service_name, opts = {})
|
|
364
|
+
data, _status_code, _headers = get_accounting_service_prices_with_http_info(service_name, opts)
|
|
365
|
+
data
|
|
366
|
+
end
|
|
367
|
+
|
|
368
|
+
# Get the service prices from the accounting service
|
|
369
|
+
# Returns the portal's automatic wallet top-up settings: whether it is switched on, the balance that triggers it, the balance it tops the wallet up to and the currency it charges in. Only a DocSpace administrator may read it, no billing customer is needed, and the call is read-only. A portal that has never configured it gets the defaults rather than an empty result, so `enabled` is the field that says whether anything happens at all. Two of the values are kept by the portal itself and cannot be set through this API: `lowBalanceThreshold` is the balance below which the portal warns its administrators by mail, and `lowBalanceNotified` says whether that warning has already gone out for the current dip. Change the rest with `POST api/2.0/portal/payment/topupsettings`.
|
|
370
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-accounting-service-prices/
|
|
371
|
+
# @param service_name [String] The service whose price list is read, named the way the billing catalogue names it, such as `ai-tools` or `backup`. Take the value from the `serviceName` field of `GET api/2.0/portal/payment/walletservices`; a name the accounting service does not price yields an empty list rather than an error.
|
|
372
|
+
# @param [Hash] opts the optional parameters
|
|
373
|
+
# @option opts [Boolean] :active Whether the answer is narrowed to the prices in force at the moment of the call. Leaving it false also returns the retired and the not yet started ones, which is what pricing a movement recorded in the past needs.
|
|
374
|
+
# @return [Array<(ServicePriceArrayWrapper, Integer, Hash)>] ServicePriceArrayWrapper data, response status code and response headers
|
|
375
|
+
def get_accounting_service_prices_with_http_info(service_name, opts = {})
|
|
376
|
+
if @api_client.config.debugging
|
|
377
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_accounting_service_prices ...'
|
|
378
|
+
end
|
|
379
|
+
# verify the required parameter 'service_name' is set
|
|
380
|
+
if @api_client.config.client_side_validation && service_name.nil?
|
|
381
|
+
fail ArgumentError, "Missing the required parameter 'service_name' when calling Portal::PaymentApi.get_accounting_service_prices"
|
|
382
|
+
end
|
|
383
|
+
if @api_client.config.client_side_validation && service_name.to_s.length > 255
|
|
384
|
+
fail ArgumentError, 'invalid value for "service_name" when calling Portal::PaymentApi.get_accounting_service_prices, the character length must be smaller than or equal to 255.'
|
|
385
|
+
end
|
|
386
|
+
|
|
387
|
+
if @api_client.config.client_side_validation && service_name.to_s.length < 0
|
|
388
|
+
fail ArgumentError, 'invalid value for "service_name" when calling Portal::PaymentApi.get_accounting_service_prices, the character length must be greater than or equal to 0.'
|
|
389
|
+
end
|
|
390
|
+
|
|
391
|
+
# resource path
|
|
392
|
+
local_var_path = '/api/2.0/portal/payment/accounting/prices/{serviceName}'.sub('{' + 'serviceName' + '}', CGI.escape(service_name.to_s))
|
|
393
|
+
|
|
394
|
+
# query parameters
|
|
395
|
+
query_params = opts[:query_params] || {}
|
|
396
|
+
query_params[:'active'] = opts[:'active'] if !opts[:'active'].nil?
|
|
397
|
+
|
|
398
|
+
# header parameters
|
|
399
|
+
header_params = opts[:header_params] || {}
|
|
400
|
+
# HTTP header 'Accept' (if needed)
|
|
401
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
402
|
+
|
|
403
|
+
# form parameters
|
|
404
|
+
form_params = opts[:form_params] || {}
|
|
405
|
+
|
|
406
|
+
# http body (model)
|
|
407
|
+
post_body = opts[:debug_body]
|
|
408
|
+
|
|
409
|
+
# return_type
|
|
410
|
+
return_type = opts[:debug_return_type] || 'ServicePriceArrayWrapper'
|
|
411
|
+
|
|
412
|
+
# auth_names
|
|
413
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
414
|
+
|
|
415
|
+
new_options = opts.merge(
|
|
416
|
+
:operation => :"Portal::PaymentApi.get_accounting_service_prices",
|
|
417
|
+
:header_params => header_params,
|
|
418
|
+
:query_params => query_params,
|
|
419
|
+
:form_params => form_params,
|
|
420
|
+
:body => post_body,
|
|
421
|
+
:auth_names => auth_names,
|
|
422
|
+
:return_type => return_type
|
|
423
|
+
)
|
|
424
|
+
|
|
425
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
426
|
+
if @api_client.config.debugging
|
|
427
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_accounting_service_prices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
428
|
+
end
|
|
429
|
+
return data, status_code, headers
|
|
430
|
+
end
|
|
431
|
+
|
|
432
|
+
# Get the active wallet services
|
|
433
|
+
# Lists the wallet services the portal is running right now: the add-ons its plan pays for that are in the active state, plus the ones an administrator switched on by hand in the wallet service settings; the Docs Connect trial is listed as well, although it is not paid from the wallet. Only a DocSpace administrator may call it, no billing customer is needed for it, and the call is read-only. Every item names the service, its title and the unit it is measured in, and says whether it is a subscription; a subscribed service also carries the limit it grants and how much of it is used where that number is known - the editor seats and the editors currently active for Docs Connect, the purchased units and the units already consumed for disk storage. A service listed with no limit is one whose usage is not counted this way, not one without a limit. The catalogue of what could be switched on is `GET api/2.0/portal/payment/walletservices`, and switching one is `POST api/2.0/portal/payment/servicestate`.
|
|
434
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-active-services/
|
|
435
|
+
# @param [Hash] opts the optional parameters
|
|
436
|
+
# @return [ActiveServiceArrayWrapper]
|
|
437
|
+
def get_active_services(opts = {})
|
|
438
|
+
data, _status_code, _headers = get_active_services_with_http_info(opts)
|
|
439
|
+
data
|
|
440
|
+
end
|
|
441
|
+
|
|
442
|
+
# Get the active wallet services
|
|
443
|
+
# Lists the wallet services the portal is running right now: the add-ons its plan pays for that are in the active state, plus the ones an administrator switched on by hand in the wallet service settings; the Docs Connect trial is listed as well, although it is not paid from the wallet. Only a DocSpace administrator may call it, no billing customer is needed for it, and the call is read-only. Every item names the service, its title and the unit it is measured in, and says whether it is a subscription; a subscribed service also carries the limit it grants and how much of it is used where that number is known - the editor seats and the editors currently active for Docs Connect, the purchased units and the units already consumed for disk storage. A service listed with no limit is one whose usage is not counted this way, not one without a limit. The catalogue of what could be switched on is `GET api/2.0/portal/payment/walletservices`, and switching one is `POST api/2.0/portal/payment/servicestate`.
|
|
444
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-active-services/
|
|
445
|
+
# @param [Hash] opts the optional parameters
|
|
446
|
+
# @return [Array<(ActiveServiceArrayWrapper, Integer, Hash)>] ActiveServiceArrayWrapper data, response status code and response headers
|
|
447
|
+
def get_active_services_with_http_info(opts = {})
|
|
448
|
+
if @api_client.config.debugging
|
|
449
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_active_services ...'
|
|
450
|
+
end
|
|
451
|
+
# resource path
|
|
452
|
+
local_var_path = '/api/2.0/portal/payment/activeservices'
|
|
453
|
+
|
|
454
|
+
# query parameters
|
|
455
|
+
query_params = opts[:query_params] || {}
|
|
456
|
+
|
|
457
|
+
# header parameters
|
|
458
|
+
header_params = opts[:header_params] || {}
|
|
459
|
+
# HTTP header 'Accept' (if needed)
|
|
460
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
461
|
+
|
|
462
|
+
# form parameters
|
|
463
|
+
form_params = opts[:form_params] || {}
|
|
464
|
+
|
|
465
|
+
# http body (model)
|
|
466
|
+
post_body = opts[:debug_body]
|
|
467
|
+
|
|
468
|
+
# return_type
|
|
469
|
+
return_type = opts[:debug_return_type] || 'ActiveServiceArrayWrapper'
|
|
470
|
+
|
|
471
|
+
# auth_names
|
|
472
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
473
|
+
|
|
474
|
+
new_options = opts.merge(
|
|
475
|
+
:operation => :"Portal::PaymentApi.get_active_services",
|
|
476
|
+
:header_params => header_params,
|
|
477
|
+
:query_params => query_params,
|
|
478
|
+
:form_params => form_params,
|
|
479
|
+
:body => post_body,
|
|
480
|
+
:auth_names => auth_names,
|
|
481
|
+
:return_type => return_type
|
|
482
|
+
)
|
|
483
|
+
|
|
484
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
485
|
+
if @api_client.config.debugging
|
|
486
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_active_services\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
487
|
+
end
|
|
488
|
+
return data, status_code, headers
|
|
489
|
+
end
|
|
490
|
+
|
|
491
|
+
# Get AI model prices
|
|
492
|
+
# Returns the price list of the AI features the portal pays for out of its wallet: the chat models with the price of their prompt and completion tokens, the embedding models, the image models with their per-image price, and the web search providers with the price of one search. The installation needs both a billing service and the AI gateway configured, otherwise the answer is 403, and only a DocSpace administrator may read it; the call is read-only. Token prices are normalised per million tokens, and every price is in the single `currency` the answer names. Each entry carries the model identifier to use when talking to the AI operations, its display alias, its provider with the provider icon, and a link to the model's own page. It is a list of what the models cost and not of what the portal spent - that is `GET api/2.0/portal/payment/customer/usage` - and it says nothing about which of them are allowed here, which is `GET api/2.0/portal/payment/ai-model/restrictions`.
|
|
493
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-ai-prices/
|
|
494
|
+
# @param [Hash] opts the optional parameters
|
|
495
|
+
# @return [AiPricesWrapper]
|
|
496
|
+
def get_ai_prices(opts = {})
|
|
497
|
+
data, _status_code, _headers = get_ai_prices_with_http_info(opts)
|
|
498
|
+
data
|
|
499
|
+
end
|
|
500
|
+
|
|
501
|
+
# Get AI model prices
|
|
502
|
+
# Returns the price list of the AI features the portal pays for out of its wallet: the chat models with the price of their prompt and completion tokens, the embedding models, the image models with their per-image price, and the web search providers with the price of one search. The installation needs both a billing service and the AI gateway configured, otherwise the answer is 403, and only a DocSpace administrator may read it; the call is read-only. Token prices are normalised per million tokens, and every price is in the single `currency` the answer names. Each entry carries the model identifier to use when talking to the AI operations, its display alias, its provider with the provider icon, and a link to the model's own page. It is a list of what the models cost and not of what the portal spent - that is `GET api/2.0/portal/payment/customer/usage` - and it says nothing about which of them are allowed here, which is `GET api/2.0/portal/payment/ai-model/restrictions`.
|
|
503
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-ai-prices/
|
|
504
|
+
# @param [Hash] opts the optional parameters
|
|
505
|
+
# @return [Array<(AiPricesWrapper, Integer, Hash)>] AiPricesWrapper data, response status code and response headers
|
|
506
|
+
def get_ai_prices_with_http_info(opts = {})
|
|
507
|
+
if @api_client.config.debugging
|
|
508
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_ai_prices ...'
|
|
509
|
+
end
|
|
510
|
+
# resource path
|
|
511
|
+
local_var_path = '/api/2.0/portal/payment/ai-prices'
|
|
512
|
+
|
|
513
|
+
# query parameters
|
|
514
|
+
query_params = opts[:query_params] || {}
|
|
515
|
+
|
|
516
|
+
# header parameters
|
|
517
|
+
header_params = opts[:header_params] || {}
|
|
518
|
+
# HTTP header 'Accept' (if needed)
|
|
519
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
520
|
+
|
|
521
|
+
# form parameters
|
|
522
|
+
form_params = opts[:form_params] || {}
|
|
523
|
+
|
|
524
|
+
# http body (model)
|
|
525
|
+
post_body = opts[:debug_body]
|
|
526
|
+
|
|
527
|
+
# return_type
|
|
528
|
+
return_type = opts[:debug_return_type] || 'AiPricesWrapper'
|
|
529
|
+
|
|
530
|
+
# auth_names
|
|
531
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
532
|
+
|
|
533
|
+
new_options = opts.merge(
|
|
534
|
+
:operation => :"Portal::PaymentApi.get_ai_prices",
|
|
535
|
+
:header_params => header_params,
|
|
536
|
+
:query_params => query_params,
|
|
537
|
+
:form_params => form_params,
|
|
538
|
+
:body => post_body,
|
|
539
|
+
:auth_names => auth_names,
|
|
540
|
+
:return_type => return_type
|
|
541
|
+
)
|
|
542
|
+
|
|
543
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
544
|
+
if @api_client.config.debugging
|
|
545
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_ai_prices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
546
|
+
end
|
|
547
|
+
return data, status_code, headers
|
|
548
|
+
end
|
|
549
|
+
|
|
550
|
+
# Get the checkout setup page URL
|
|
551
|
+
# Hands back the hosted page on which a payment method is attached to the portal's billing account, for the case where money has to be taken later - a wallet top-up or an automatic one - rather than a plan bought now. A portal that already has a payment method on file answers with an empty result; a DocSpace administrator may ask for the page, but once the portal has a billing customer with an e-mail, only its payer may. The call itself changes nothing and may be repeated: the payment method is stored by the payment provider when the returned page is completed, after which `GET api/2.0/portal/payment/customerinfo` reports it as set. The URL is absolute, carries the caller's e-mail, the language of the request and the currency of the region, and redirects to `successUrl` or `backUrl` when the user finishes or cancels. It buys nothing - a plan is bought with `PUT api/2.0/portal/payment/url`.
|
|
552
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-checkout-setup-url/
|
|
553
|
+
# @param back_url [String] The absolute address the setup page sends the user back to when attaching a payment method is abandoned. It has to be a well-formed URL and must be reachable by that user rather than by the portal.
|
|
554
|
+
# @param success_url [String] The absolute address the setup page sends the user to once the payment provider has stored the payment method. Reaching it means a method is now on file, which `GET api/2.0/portal/payment/customerinfo` confirms; nothing has been charged.
|
|
555
|
+
# @param [Hash] opts the optional parameters
|
|
556
|
+
# @return [StringWrapper]
|
|
557
|
+
def get_checkout_setup_url(back_url, success_url, opts = {})
|
|
558
|
+
data, _status_code, _headers = get_checkout_setup_url_with_http_info(back_url, success_url, opts)
|
|
559
|
+
data
|
|
560
|
+
end
|
|
561
|
+
|
|
562
|
+
# Get the checkout setup page URL
|
|
563
|
+
# Hands back the hosted page on which a payment method is attached to the portal's billing account, for the case where money has to be taken later - a wallet top-up or an automatic one - rather than a plan bought now. A portal that already has a payment method on file answers with an empty result; a DocSpace administrator may ask for the page, but once the portal has a billing customer with an e-mail, only its payer may. The call itself changes nothing and may be repeated: the payment method is stored by the payment provider when the returned page is completed, after which `GET api/2.0/portal/payment/customerinfo` reports it as set. The URL is absolute, carries the caller's e-mail, the language of the request and the currency of the region, and redirects to `successUrl` or `backUrl` when the user finishes or cancels. It buys nothing - a plan is bought with `PUT api/2.0/portal/payment/url`.
|
|
564
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-checkout-setup-url/
|
|
565
|
+
# @param back_url [String] The absolute address the setup page sends the user back to when attaching a payment method is abandoned. It has to be a well-formed URL and must be reachable by that user rather than by the portal.
|
|
566
|
+
# @param success_url [String] The absolute address the setup page sends the user to once the payment provider has stored the payment method. Reaching it means a method is now on file, which `GET api/2.0/portal/payment/customerinfo` confirms; nothing has been charged.
|
|
567
|
+
# @param [Hash] opts the optional parameters
|
|
568
|
+
# @return [Array<(StringWrapper, Integer, Hash)>] StringWrapper data, response status code and response headers
|
|
569
|
+
def get_checkout_setup_url_with_http_info(back_url, success_url, opts = {})
|
|
570
|
+
if @api_client.config.debugging
|
|
571
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_checkout_setup_url ...'
|
|
572
|
+
end
|
|
573
|
+
# verify the required parameter 'back_url' is set
|
|
574
|
+
if @api_client.config.client_side_validation && back_url.nil?
|
|
575
|
+
fail ArgumentError, "Missing the required parameter 'back_url' when calling Portal::PaymentApi.get_checkout_setup_url"
|
|
576
|
+
end
|
|
577
|
+
if @api_client.config.client_side_validation && back_url.to_s.length > 255
|
|
578
|
+
fail ArgumentError, 'invalid value for "back_url" when calling Portal::PaymentApi.get_checkout_setup_url, the character length must be smaller than or equal to 255.'
|
|
579
|
+
end
|
|
580
|
+
|
|
581
|
+
if @api_client.config.client_side_validation && back_url.to_s.length < 0
|
|
582
|
+
fail ArgumentError, 'invalid value for "back_url" when calling Portal::PaymentApi.get_checkout_setup_url, the character length must be greater than or equal to 0.'
|
|
583
|
+
end
|
|
584
|
+
|
|
585
|
+
# verify the required parameter 'success_url' is set
|
|
586
|
+
if @api_client.config.client_side_validation && success_url.nil?
|
|
587
|
+
fail ArgumentError, "Missing the required parameter 'success_url' when calling Portal::PaymentApi.get_checkout_setup_url"
|
|
588
|
+
end
|
|
589
|
+
if @api_client.config.client_side_validation && success_url.to_s.length > 255
|
|
590
|
+
fail ArgumentError, 'invalid value for "success_url" when calling Portal::PaymentApi.get_checkout_setup_url, the character length must be smaller than or equal to 255.'
|
|
591
|
+
end
|
|
592
|
+
|
|
593
|
+
if @api_client.config.client_side_validation && success_url.to_s.length < 0
|
|
594
|
+
fail ArgumentError, 'invalid value for "success_url" when calling Portal::PaymentApi.get_checkout_setup_url, the character length must be greater than or equal to 0.'
|
|
595
|
+
end
|
|
596
|
+
|
|
597
|
+
# resource path
|
|
598
|
+
local_var_path = '/api/2.0/portal/payment/checkoutsetupurl'
|
|
599
|
+
|
|
600
|
+
# query parameters
|
|
601
|
+
query_params = opts[:query_params] || {}
|
|
602
|
+
query_params[:'backUrl'] = back_url
|
|
603
|
+
query_params[:'successUrl'] = success_url
|
|
604
|
+
|
|
605
|
+
# header parameters
|
|
606
|
+
header_params = opts[:header_params] || {}
|
|
607
|
+
# HTTP header 'Accept' (if needed)
|
|
608
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
609
|
+
|
|
610
|
+
# form parameters
|
|
611
|
+
form_params = opts[:form_params] || {}
|
|
612
|
+
|
|
613
|
+
# http body (model)
|
|
614
|
+
post_body = opts[:debug_body]
|
|
615
|
+
|
|
616
|
+
# return_type
|
|
617
|
+
return_type = opts[:debug_return_type] || 'StringWrapper'
|
|
618
|
+
|
|
619
|
+
# auth_names
|
|
620
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
621
|
+
|
|
622
|
+
new_options = opts.merge(
|
|
623
|
+
:operation => :"Portal::PaymentApi.get_checkout_setup_url",
|
|
624
|
+
:header_params => header_params,
|
|
625
|
+
:query_params => query_params,
|
|
626
|
+
:form_params => form_params,
|
|
627
|
+
:body => post_body,
|
|
628
|
+
:auth_names => auth_names,
|
|
629
|
+
:return_type => return_type
|
|
630
|
+
)
|
|
631
|
+
|
|
632
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
633
|
+
if @api_client.config.debugging
|
|
634
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_checkout_setup_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
635
|
+
end
|
|
636
|
+
return data, status_code, headers
|
|
637
|
+
end
|
|
638
|
+
|
|
639
|
+
# Get the customer balance
|
|
640
|
+
# Returns the money the portal has in its wallet as the accounting service holds it: the account with its own currency, one sub-account per currency with the amount on it, and the most recent credit movement. Only a DocSpace administrator may read it, an installation without a billing service answers 403, and a portal that has never been a customer gets an empty result. The call is read-only. This balance is what the wallet services are charged against, so it falls as they are used and rises with `POST api/2.0/portal/payment/deposit`; the movements behind a change are listed by `GET api/2.0/portal/payment/customer/operations`. Pass `refresh=true` to re-read it from the accounting service rather than the cache - right after a top-up the cached figure is still the old one.
|
|
641
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-customer-balance/
|
|
642
|
+
# @param [Hash] opts the optional parameters
|
|
643
|
+
# @option opts [Boolean] :refresh Whether the answer is fetched from the billing service instead of the portal cache. The cached copy is what a start-up needs and costs nothing; asking for a fresh one makes a remote call, so use it right after a purchase or a top-up and not on every read.
|
|
644
|
+
# @return [BalanceWrapper]
|
|
645
|
+
def get_customer_balance(opts = {})
|
|
646
|
+
data, _status_code, _headers = get_customer_balance_with_http_info(opts)
|
|
647
|
+
data
|
|
648
|
+
end
|
|
649
|
+
|
|
650
|
+
# Get the customer balance
|
|
651
|
+
# Returns the money the portal has in its wallet as the accounting service holds it: the account with its own currency, one sub-account per currency with the amount on it, and the most recent credit movement. Only a DocSpace administrator may read it, an installation without a billing service answers 403, and a portal that has never been a customer gets an empty result. The call is read-only. This balance is what the wallet services are charged against, so it falls as they are used and rises with `POST api/2.0/portal/payment/deposit`; the movements behind a change are listed by `GET api/2.0/portal/payment/customer/operations`. Pass `refresh=true` to re-read it from the accounting service rather than the cache - right after a top-up the cached figure is still the old one.
|
|
652
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-customer-balance/
|
|
653
|
+
# @param [Hash] opts the optional parameters
|
|
654
|
+
# @option opts [Boolean] :refresh Whether the answer is fetched from the billing service instead of the portal cache. The cached copy is what a start-up needs and costs nothing; asking for a fresh one makes a remote call, so use it right after a purchase or a top-up and not on every read.
|
|
655
|
+
# @return [Array<(BalanceWrapper, Integer, Hash)>] BalanceWrapper data, response status code and response headers
|
|
656
|
+
def get_customer_balance_with_http_info(opts = {})
|
|
657
|
+
if @api_client.config.debugging
|
|
658
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_customer_balance ...'
|
|
659
|
+
end
|
|
660
|
+
# resource path
|
|
661
|
+
local_var_path = '/api/2.0/portal/payment/customer/balance'
|
|
662
|
+
|
|
663
|
+
# query parameters
|
|
664
|
+
query_params = opts[:query_params] || {}
|
|
665
|
+
query_params[:'refresh'] = opts[:'refresh'] if !opts[:'refresh'].nil?
|
|
666
|
+
|
|
667
|
+
# header parameters
|
|
668
|
+
header_params = opts[:header_params] || {}
|
|
669
|
+
# HTTP header 'Accept' (if needed)
|
|
670
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
671
|
+
|
|
672
|
+
# form parameters
|
|
673
|
+
form_params = opts[:form_params] || {}
|
|
674
|
+
|
|
675
|
+
# http body (model)
|
|
676
|
+
post_body = opts[:debug_body]
|
|
677
|
+
|
|
678
|
+
# return_type
|
|
679
|
+
return_type = opts[:debug_return_type] || 'BalanceWrapper'
|
|
680
|
+
|
|
681
|
+
# auth_names
|
|
682
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
683
|
+
|
|
684
|
+
new_options = opts.merge(
|
|
685
|
+
:operation => :"Portal::PaymentApi.get_customer_balance",
|
|
686
|
+
:header_params => header_params,
|
|
687
|
+
:query_params => query_params,
|
|
688
|
+
:form_params => form_params,
|
|
689
|
+
:body => post_body,
|
|
690
|
+
:auth_names => auth_names,
|
|
691
|
+
:return_type => return_type
|
|
692
|
+
)
|
|
693
|
+
|
|
694
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
695
|
+
if @api_client.config.debugging
|
|
696
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_customer_balance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
697
|
+
end
|
|
698
|
+
return data, status_code, headers
|
|
699
|
+
end
|
|
700
|
+
|
|
701
|
+
# Get the customer information
|
|
702
|
+
# Returns the billing customer behind the portal: the e-mail its billing account is registered to, whether a payment method is stored for it, and the portal user who is the payer of that account. Only a DocSpace administrator may read it, and the call is read-only. The answer is empty in two ordinary cases - the installation has no billing service configured at all, and the portal has never been a customer - so an empty body is not an error. `payer` is filled in only when the billing e-mail belongs to a portal user; when it does not, the e-mail is still shown but the field stays empty, and that is what makes every payer-only operation of this group unreachable for everybody. `refresh=true` re-reads the customer from the billing provider instead of the cache, which is worth doing right after a payment method has been attached.
|
|
703
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-customer-info/
|
|
704
|
+
# @param [Hash] opts the optional parameters
|
|
705
|
+
# @option opts [Boolean] :refresh Whether the answer is fetched from the billing service instead of the portal cache. The cached copy is what a start-up needs and costs nothing; asking for a fresh one makes a remote call, so use it right after a purchase or a top-up and not on every read.
|
|
706
|
+
# @return [CustomerInfoWrapper]
|
|
707
|
+
def get_customer_info(opts = {})
|
|
708
|
+
data, _status_code, _headers = get_customer_info_with_http_info(opts)
|
|
709
|
+
data
|
|
710
|
+
end
|
|
711
|
+
|
|
712
|
+
# Get the customer information
|
|
713
|
+
# Returns the billing customer behind the portal: the e-mail its billing account is registered to, whether a payment method is stored for it, and the portal user who is the payer of that account. Only a DocSpace administrator may read it, and the call is read-only. The answer is empty in two ordinary cases - the installation has no billing service configured at all, and the portal has never been a customer - so an empty body is not an error. `payer` is filled in only when the billing e-mail belongs to a portal user; when it does not, the e-mail is still shown but the field stays empty, and that is what makes every payer-only operation of this group unreachable for everybody. `refresh=true` re-reads the customer from the billing provider instead of the cache, which is worth doing right after a payment method has been attached.
|
|
714
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-customer-info/
|
|
715
|
+
# @param [Hash] opts the optional parameters
|
|
716
|
+
# @option opts [Boolean] :refresh Whether the answer is fetched from the billing service instead of the portal cache. The cached copy is what a start-up needs and costs nothing; asking for a fresh one makes a remote call, so use it right after a purchase or a top-up and not on every read.
|
|
717
|
+
# @return [Array<(CustomerInfoWrapper, Integer, Hash)>] CustomerInfoWrapper data, response status code and response headers
|
|
718
|
+
def get_customer_info_with_http_info(opts = {})
|
|
719
|
+
if @api_client.config.debugging
|
|
720
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_customer_info ...'
|
|
721
|
+
end
|
|
722
|
+
# resource path
|
|
723
|
+
local_var_path = '/api/2.0/portal/payment/customerinfo'
|
|
724
|
+
|
|
725
|
+
# query parameters
|
|
726
|
+
query_params = opts[:query_params] || {}
|
|
727
|
+
query_params[:'refresh'] = opts[:'refresh'] if !opts[:'refresh'].nil?
|
|
728
|
+
|
|
729
|
+
# header parameters
|
|
730
|
+
header_params = opts[:header_params] || {}
|
|
731
|
+
# HTTP header 'Accept' (if needed)
|
|
732
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
733
|
+
|
|
734
|
+
# form parameters
|
|
735
|
+
form_params = opts[:form_params] || {}
|
|
736
|
+
|
|
737
|
+
# http body (model)
|
|
738
|
+
post_body = opts[:debug_body]
|
|
739
|
+
|
|
740
|
+
# return_type
|
|
741
|
+
return_type = opts[:debug_return_type] || 'CustomerInfoWrapper'
|
|
742
|
+
|
|
743
|
+
# auth_names
|
|
744
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
745
|
+
|
|
746
|
+
new_options = opts.merge(
|
|
747
|
+
:operation => :"Portal::PaymentApi.get_customer_info",
|
|
748
|
+
:header_params => header_params,
|
|
749
|
+
:query_params => query_params,
|
|
750
|
+
:form_params => form_params,
|
|
751
|
+
:body => post_body,
|
|
752
|
+
:auth_names => auth_names,
|
|
753
|
+
:return_type => return_type
|
|
754
|
+
)
|
|
755
|
+
|
|
756
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
757
|
+
if @api_client.config.debugging
|
|
758
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_customer_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
759
|
+
end
|
|
760
|
+
return data, status_code, headers
|
|
761
|
+
end
|
|
762
|
+
|
|
763
|
+
# Get the customer monthly usage
|
|
764
|
+
# Returns what the portal spent from its wallet added up per calendar month, so a client can draw a spending chart without paging through every movement. Only a DocSpace administrator may read it, a portal with no billing customer answers with an empty result, and the call is read-only. `startDate` and `endDate` bound the period, both inclusive, and default to the portal creation date and the present moment; the months are cut in the portal time zone, so a movement at the edge of a month falls where the portal sees it and not where UTC does. Each item names its year and month, the total charged in it with the currency, and how many operations that total came from. The movements behind a month are in `GET api/2.0/portal/payment/customer/operations`, and the same figures as a file come from `POST api/2.0/portal/payment/customer/usage/monthly/report`.
|
|
765
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-customer-monthly-usage/
|
|
766
|
+
# @param [Hash] opts the optional parameters
|
|
767
|
+
# @option opts [Time] :start_date The beginning of the reported period, inclusive. The months are cut in the portal time zone rather than in UTC, so spending at the turn of a month falls where the portal sees it; defaults to the portal creation date.
|
|
768
|
+
# @option opts [Time] :end_date The end of the reported period, inclusive. Cut in the portal time zone in the same way as `startDate`, and defaults to the moment the call is made.
|
|
769
|
+
# @return [CustomerMonthlyUsageArrayWrapper]
|
|
770
|
+
def get_customer_monthly_usage(opts = {})
|
|
771
|
+
data, _status_code, _headers = get_customer_monthly_usage_with_http_info(opts)
|
|
772
|
+
data
|
|
773
|
+
end
|
|
774
|
+
|
|
775
|
+
# Get the customer monthly usage
|
|
776
|
+
# Returns what the portal spent from its wallet added up per calendar month, so a client can draw a spending chart without paging through every movement. Only a DocSpace administrator may read it, a portal with no billing customer answers with an empty result, and the call is read-only. `startDate` and `endDate` bound the period, both inclusive, and default to the portal creation date and the present moment; the months are cut in the portal time zone, so a movement at the edge of a month falls where the portal sees it and not where UTC does. Each item names its year and month, the total charged in it with the currency, and how many operations that total came from. The movements behind a month are in `GET api/2.0/portal/payment/customer/operations`, and the same figures as a file come from `POST api/2.0/portal/payment/customer/usage/monthly/report`.
|
|
777
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-customer-monthly-usage/
|
|
778
|
+
# @param [Hash] opts the optional parameters
|
|
779
|
+
# @option opts [Time] :start_date The beginning of the reported period, inclusive. The months are cut in the portal time zone rather than in UTC, so spending at the turn of a month falls where the portal sees it; defaults to the portal creation date.
|
|
780
|
+
# @option opts [Time] :end_date The end of the reported period, inclusive. Cut in the portal time zone in the same way as `startDate`, and defaults to the moment the call is made.
|
|
781
|
+
# @return [Array<(CustomerMonthlyUsageArrayWrapper, Integer, Hash)>] CustomerMonthlyUsageArrayWrapper data, response status code and response headers
|
|
782
|
+
def get_customer_monthly_usage_with_http_info(opts = {})
|
|
783
|
+
if @api_client.config.debugging
|
|
784
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_customer_monthly_usage ...'
|
|
785
|
+
end
|
|
786
|
+
# resource path
|
|
787
|
+
local_var_path = '/api/2.0/portal/payment/customer/usage/monthly'
|
|
788
|
+
|
|
789
|
+
# query parameters
|
|
790
|
+
query_params = opts[:query_params] || {}
|
|
791
|
+
query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
|
792
|
+
query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
|
793
|
+
|
|
794
|
+
# header parameters
|
|
795
|
+
header_params = opts[:header_params] || {}
|
|
796
|
+
# HTTP header 'Accept' (if needed)
|
|
797
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
798
|
+
|
|
799
|
+
# form parameters
|
|
800
|
+
form_params = opts[:form_params] || {}
|
|
801
|
+
|
|
802
|
+
# http body (model)
|
|
803
|
+
post_body = opts[:debug_body]
|
|
804
|
+
|
|
805
|
+
# return_type
|
|
806
|
+
return_type = opts[:debug_return_type] || 'CustomerMonthlyUsageArrayWrapper'
|
|
807
|
+
|
|
808
|
+
# auth_names
|
|
809
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
810
|
+
|
|
811
|
+
new_options = opts.merge(
|
|
812
|
+
:operation => :"Portal::PaymentApi.get_customer_monthly_usage",
|
|
813
|
+
:header_params => header_params,
|
|
814
|
+
:query_params => query_params,
|
|
815
|
+
:form_params => form_params,
|
|
816
|
+
:body => post_body,
|
|
817
|
+
:auth_names => auth_names,
|
|
818
|
+
:return_type => return_type
|
|
819
|
+
)
|
|
820
|
+
|
|
821
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
822
|
+
if @api_client.config.debugging
|
|
823
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_customer_monthly_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
824
|
+
end
|
|
825
|
+
return data, status_code, headers
|
|
826
|
+
end
|
|
827
|
+
|
|
828
|
+
# Get the monthly usage report status
|
|
829
|
+
# Returns the state of the `xlsx` monthly usage report this user started with `POST api/2.0/portal/payment/customer/usage/monthly/report`: `percentage` while it is being built, `isCompleted` when it is done, `resultFileId`, `resultFileName` and `resultFileUrl` pointing at the file in the caller's My documents, and `error` when the build failed. The portal needs a billing customer and the caller has to be a DocSpace administrator; the call is read-only and is the one to poll. The task is kept per user and per report kind, so it reports neither another administrator's report nor the operations and service usage ones, which have their own status operations. An empty result means this user has no monthly usage report at all - none was started, or the finished one was already picked up or terminated. A completed task is dropped as soon as the next report is started, so read the file link out of the same answer that first reports `isCompleted`.
|
|
830
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-customer-monthly-usage-report/
|
|
831
|
+
# @param [Hash] opts the optional parameters
|
|
832
|
+
# @return [DocumentBuilderTaskWrapper]
|
|
833
|
+
def get_customer_monthly_usage_report(opts = {})
|
|
834
|
+
data, _status_code, _headers = get_customer_monthly_usage_report_with_http_info(opts)
|
|
835
|
+
data
|
|
836
|
+
end
|
|
837
|
+
|
|
838
|
+
# Get the monthly usage report status
|
|
839
|
+
# Returns the state of the `xlsx` monthly usage report this user started with `POST api/2.0/portal/payment/customer/usage/monthly/report`: `percentage` while it is being built, `isCompleted` when it is done, `resultFileId`, `resultFileName` and `resultFileUrl` pointing at the file in the caller's My documents, and `error` when the build failed. The portal needs a billing customer and the caller has to be a DocSpace administrator; the call is read-only and is the one to poll. The task is kept per user and per report kind, so it reports neither another administrator's report nor the operations and service usage ones, which have their own status operations. An empty result means this user has no monthly usage report at all - none was started, or the finished one was already picked up or terminated. A completed task is dropped as soon as the next report is started, so read the file link out of the same answer that first reports `isCompleted`.
|
|
840
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-customer-monthly-usage-report/
|
|
841
|
+
# @param [Hash] opts the optional parameters
|
|
842
|
+
# @return [Array<(DocumentBuilderTaskWrapper, Integer, Hash)>] DocumentBuilderTaskWrapper data, response status code and response headers
|
|
843
|
+
def get_customer_monthly_usage_report_with_http_info(opts = {})
|
|
844
|
+
if @api_client.config.debugging
|
|
845
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_customer_monthly_usage_report ...'
|
|
846
|
+
end
|
|
847
|
+
# resource path
|
|
848
|
+
local_var_path = '/api/2.0/portal/payment/customer/usage/monthly/report'
|
|
849
|
+
|
|
850
|
+
# query parameters
|
|
851
|
+
query_params = opts[:query_params] || {}
|
|
852
|
+
|
|
853
|
+
# header parameters
|
|
854
|
+
header_params = opts[:header_params] || {}
|
|
855
|
+
# HTTP header 'Accept' (if needed)
|
|
856
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
857
|
+
|
|
858
|
+
# form parameters
|
|
859
|
+
form_params = opts[:form_params] || {}
|
|
860
|
+
|
|
861
|
+
# http body (model)
|
|
862
|
+
post_body = opts[:debug_body]
|
|
863
|
+
|
|
864
|
+
# return_type
|
|
865
|
+
return_type = opts[:debug_return_type] || 'DocumentBuilderTaskWrapper'
|
|
866
|
+
|
|
867
|
+
# auth_names
|
|
868
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
869
|
+
|
|
870
|
+
new_options = opts.merge(
|
|
871
|
+
:operation => :"Portal::PaymentApi.get_customer_monthly_usage_report",
|
|
872
|
+
:header_params => header_params,
|
|
873
|
+
:query_params => query_params,
|
|
874
|
+
:form_params => form_params,
|
|
875
|
+
:body => post_body,
|
|
876
|
+
:auth_names => auth_names,
|
|
877
|
+
:return_type => return_type
|
|
878
|
+
)
|
|
879
|
+
|
|
880
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
881
|
+
if @api_client.config.debugging
|
|
882
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_customer_monthly_usage_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
883
|
+
end
|
|
884
|
+
return data, status_code, headers
|
|
885
|
+
end
|
|
886
|
+
|
|
887
|
+
# Get the wallet operations
|
|
888
|
+
# Lists the money movements on the portal's wallet - top-ups, the charges of the wallet services, refunds and corrections - one page at a time, which is what a billing history is built from. Only a DocSpace administrator may read it, a portal with no billing customer answers with an empty result, and the call is read-only. Every filter is optional: `startDate` and `endDate` are read in the portal time zone and default to the portal creation date and the present moment, `serviceName` narrows to particular wallet services and fails with 404 on a name this installation does not sell, `participantName`, `type` and `status` narrow to who caused a movement and how it ended, and `credit` and `debit` include or exclude the two directions. `offset` and `limit` page through the result and default to 0 and 25, `orderBy` and `orderType` sort it, and the answer repeats them next to `totalQuantity`, `totalPage` and `currentPage` so a client can page without counting. The same data as a downloadable file is `POST api/2.0/portal/payment/customer/operationsreport`, and the figures added up per service are `GET api/2.0/portal/payment/customer/usage`.
|
|
889
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-customer-operations/
|
|
890
|
+
# @param [Hash] opts the optional parameters
|
|
891
|
+
# @option opts [Integer] :offset The number of movements to skip before the first one returned, for walking through a long history page by page. Counted after the filters and the ordering are applied, and starts at 0 when omitted.
|
|
892
|
+
# @option opts [Integer] :limit The maximum number of movements returned in one page. Defaults to 25 when omitted; the answer echoes the window back next to `totalQuantity`, `totalPage` and `currentPage`, so the next `offset` can be computed without counting the items.
|
|
893
|
+
# @option opts [Array<String>] :service_name The wallet services whose movements are kept, named the way the billing catalogue names them - `backup`, `ai-tools`, `ai-search`, `disk-storage`, `docscloud`. Take the values from the `serviceName` field of `GET api/2.0/portal/payment/walletservices`; the match ignores case, a name this installation does not sell fails the call with 404, and an omitted list keeps every service. A bare string is accepted in place of an array for backward compatibility.
|
|
894
|
+
# @option opts [Time] :start_date The beginning of the reported period, inclusive. Read in the portal time zone rather than in UTC, so a movement at the edge of the period falls where the portal sees it; defaults to the portal creation date.
|
|
895
|
+
# @option opts [Time] :end_date The end of the reported period, inclusive. Read in the portal time zone rather than in UTC, and defaults to the moment the call is made.
|
|
896
|
+
# @option opts [String] :participant_name The participant whose movements are kept - the account the accounting service records as the cause of a movement. A movement caused by a portal user carries that user ID here, and one caused by the portal itself carries the customer name; surrounding whitespace is trimmed, and an omitted value keeps every participant.
|
|
897
|
+
# @option opts [Boolean] :credit Whether movements that add money to the wallet - top-ups, refunds and corrections in the portal's favour - are kept. Both directions are reported when neither this nor `debit` is given.
|
|
898
|
+
# @option opts [Boolean] :debit Whether movements that take money out of the wallet - the charges of the wallet services - are kept. Both directions are reported when neither this nor `credit` is given.
|
|
899
|
+
# @option opts [OperationType] :type The kind of movement to keep, which says what caused the money to move rather than how it ended. Every kind is reported when it is omitted.
|
|
900
|
+
# @option opts [OperationStatus] :status The outcome to keep. A movement that is still being settled is reported as pending and may change later, while the other outcomes are final; every outcome is reported when this is omitted.
|
|
901
|
+
# @option opts [String] :order_by The name of the field the movements are sorted by, spelled as the accounting service names it, such as `StartDate` or `ServiceName`. Surrounding whitespace is trimmed, and the accounting service applies its own ordering when this is omitted.
|
|
902
|
+
# @option opts [OperationOrderType] :order_type The direction the field named in `orderBy` is sorted in. Newest or largest first is what the accounting service does by default, so leaving this out sorts the same way as asking for descending explicitly.
|
|
903
|
+
# @return [ReportWrapper]
|
|
904
|
+
def get_customer_operations(opts = {})
|
|
905
|
+
data, _status_code, _headers = get_customer_operations_with_http_info(opts)
|
|
906
|
+
data
|
|
907
|
+
end
|
|
908
|
+
|
|
909
|
+
# Get the wallet operations
|
|
910
|
+
# Lists the money movements on the portal's wallet - top-ups, the charges of the wallet services, refunds and corrections - one page at a time, which is what a billing history is built from. Only a DocSpace administrator may read it, a portal with no billing customer answers with an empty result, and the call is read-only. Every filter is optional: `startDate` and `endDate` are read in the portal time zone and default to the portal creation date and the present moment, `serviceName` narrows to particular wallet services and fails with 404 on a name this installation does not sell, `participantName`, `type` and `status` narrow to who caused a movement and how it ended, and `credit` and `debit` include or exclude the two directions. `offset` and `limit` page through the result and default to 0 and 25, `orderBy` and `orderType` sort it, and the answer repeats them next to `totalQuantity`, `totalPage` and `currentPage` so a client can page without counting. The same data as a downloadable file is `POST api/2.0/portal/payment/customer/operationsreport`, and the figures added up per service are `GET api/2.0/portal/payment/customer/usage`.
|
|
911
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-customer-operations/
|
|
912
|
+
# @param [Hash] opts the optional parameters
|
|
913
|
+
# @option opts [Integer] :offset The number of movements to skip before the first one returned, for walking through a long history page by page. Counted after the filters and the ordering are applied, and starts at 0 when omitted.
|
|
914
|
+
# @option opts [Integer] :limit The maximum number of movements returned in one page. Defaults to 25 when omitted; the answer echoes the window back next to `totalQuantity`, `totalPage` and `currentPage`, so the next `offset` can be computed without counting the items.
|
|
915
|
+
# @option opts [Array<String>] :service_name The wallet services whose movements are kept, named the way the billing catalogue names them - `backup`, `ai-tools`, `ai-search`, `disk-storage`, `docscloud`. Take the values from the `serviceName` field of `GET api/2.0/portal/payment/walletservices`; the match ignores case, a name this installation does not sell fails the call with 404, and an omitted list keeps every service. A bare string is accepted in place of an array for backward compatibility.
|
|
916
|
+
# @option opts [Time] :start_date The beginning of the reported period, inclusive. Read in the portal time zone rather than in UTC, so a movement at the edge of the period falls where the portal sees it; defaults to the portal creation date.
|
|
917
|
+
# @option opts [Time] :end_date The end of the reported period, inclusive. Read in the portal time zone rather than in UTC, and defaults to the moment the call is made.
|
|
918
|
+
# @option opts [String] :participant_name The participant whose movements are kept - the account the accounting service records as the cause of a movement. A movement caused by a portal user carries that user ID here, and one caused by the portal itself carries the customer name; surrounding whitespace is trimmed, and an omitted value keeps every participant.
|
|
919
|
+
# @option opts [Boolean] :credit Whether movements that add money to the wallet - top-ups, refunds and corrections in the portal's favour - are kept. Both directions are reported when neither this nor `debit` is given.
|
|
920
|
+
# @option opts [Boolean] :debit Whether movements that take money out of the wallet - the charges of the wallet services - are kept. Both directions are reported when neither this nor `credit` is given.
|
|
921
|
+
# @option opts [OperationType] :type The kind of movement to keep, which says what caused the money to move rather than how it ended. Every kind is reported when it is omitted.
|
|
922
|
+
# @option opts [OperationStatus] :status The outcome to keep. A movement that is still being settled is reported as pending and may change later, while the other outcomes are final; every outcome is reported when this is omitted.
|
|
923
|
+
# @option opts [String] :order_by The name of the field the movements are sorted by, spelled as the accounting service names it, such as `StartDate` or `ServiceName`. Surrounding whitespace is trimmed, and the accounting service applies its own ordering when this is omitted.
|
|
924
|
+
# @option opts [OperationOrderType] :order_type The direction the field named in `orderBy` is sorted in. Newest or largest first is what the accounting service does by default, so leaving this out sorts the same way as asking for descending explicitly.
|
|
925
|
+
# @return [Array<(ReportWrapper, Integer, Hash)>] ReportWrapper data, response status code and response headers
|
|
926
|
+
def get_customer_operations_with_http_info(opts = {})
|
|
927
|
+
if @api_client.config.debugging
|
|
928
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_customer_operations ...'
|
|
929
|
+
end
|
|
930
|
+
# resource path
|
|
931
|
+
local_var_path = '/api/2.0/portal/payment/customer/operations'
|
|
932
|
+
|
|
933
|
+
# query parameters
|
|
934
|
+
query_params = opts[:query_params] || {}
|
|
935
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
936
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
937
|
+
query_params[:'serviceName'] = @api_client.build_collection_param(opts[:'service_name'], :multi) if !opts[:'service_name'].nil?
|
|
938
|
+
query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
|
939
|
+
query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
|
940
|
+
query_params[:'participantName'] = opts[:'participant_name'] if !opts[:'participant_name'].nil?
|
|
941
|
+
query_params[:'credit'] = opts[:'credit'] if !opts[:'credit'].nil?
|
|
942
|
+
query_params[:'debit'] = opts[:'debit'] if !opts[:'debit'].nil?
|
|
943
|
+
query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
|
|
944
|
+
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
|
945
|
+
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
|
946
|
+
query_params[:'orderType'] = opts[:'order_type'] if !opts[:'order_type'].nil?
|
|
947
|
+
|
|
948
|
+
# header parameters
|
|
949
|
+
header_params = opts[:header_params] || {}
|
|
950
|
+
# HTTP header 'Accept' (if needed)
|
|
951
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
952
|
+
|
|
953
|
+
# form parameters
|
|
954
|
+
form_params = opts[:form_params] || {}
|
|
955
|
+
|
|
956
|
+
# http body (model)
|
|
957
|
+
post_body = opts[:debug_body]
|
|
958
|
+
|
|
959
|
+
# return_type
|
|
960
|
+
return_type = opts[:debug_return_type] || 'ReportWrapper'
|
|
961
|
+
|
|
962
|
+
# auth_names
|
|
963
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
964
|
+
|
|
965
|
+
new_options = opts.merge(
|
|
966
|
+
:operation => :"Portal::PaymentApi.get_customer_operations",
|
|
967
|
+
:header_params => header_params,
|
|
968
|
+
:query_params => query_params,
|
|
969
|
+
:form_params => form_params,
|
|
970
|
+
:body => post_body,
|
|
971
|
+
:auth_names => auth_names,
|
|
972
|
+
:return_type => return_type
|
|
973
|
+
)
|
|
974
|
+
|
|
975
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
976
|
+
if @api_client.config.debugging
|
|
977
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_customer_operations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
978
|
+
end
|
|
979
|
+
return data, status_code, headers
|
|
980
|
+
end
|
|
981
|
+
|
|
982
|
+
# Get the operations report status
|
|
983
|
+
# Returns the state of the `xlsx` wallet operations report this user started with `POST api/2.0/portal/payment/customer/operationsreport`: `percentage` while it is being built, `isCompleted` when it is done, `resultFileId`, `resultFileName` and `resultFileUrl` pointing at the file in the caller's My documents, and `error` when the build failed. The portal needs a billing customer and the caller has to be a DocSpace administrator; the call is read-only and is the one to poll. The task is kept per user and per report kind, so it never reports another administrator's report, nor the service usage and monthly usage ones, which have their own status operations. An empty result means this user has no operations report at all - none was started, or the finished one was already picked up or terminated. A completed task is dropped as soon as the next report is started, so read the file link out of the same answer that first reports `isCompleted`.
|
|
984
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-customer-operations-report/
|
|
985
|
+
# @param [Hash] opts the optional parameters
|
|
986
|
+
# @return [DocumentBuilderTaskWrapper]
|
|
987
|
+
def get_customer_operations_report(opts = {})
|
|
988
|
+
data, _status_code, _headers = get_customer_operations_report_with_http_info(opts)
|
|
989
|
+
data
|
|
990
|
+
end
|
|
991
|
+
|
|
992
|
+
# Get the operations report status
|
|
993
|
+
# Returns the state of the `xlsx` wallet operations report this user started with `POST api/2.0/portal/payment/customer/operationsreport`: `percentage` while it is being built, `isCompleted` when it is done, `resultFileId`, `resultFileName` and `resultFileUrl` pointing at the file in the caller's My documents, and `error` when the build failed. The portal needs a billing customer and the caller has to be a DocSpace administrator; the call is read-only and is the one to poll. The task is kept per user and per report kind, so it never reports another administrator's report, nor the service usage and monthly usage ones, which have their own status operations. An empty result means this user has no operations report at all - none was started, or the finished one was already picked up or terminated. A completed task is dropped as soon as the next report is started, so read the file link out of the same answer that first reports `isCompleted`.
|
|
994
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-customer-operations-report/
|
|
995
|
+
# @param [Hash] opts the optional parameters
|
|
996
|
+
# @return [Array<(DocumentBuilderTaskWrapper, Integer, Hash)>] DocumentBuilderTaskWrapper data, response status code and response headers
|
|
997
|
+
def get_customer_operations_report_with_http_info(opts = {})
|
|
998
|
+
if @api_client.config.debugging
|
|
999
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_customer_operations_report ...'
|
|
1000
|
+
end
|
|
1001
|
+
# resource path
|
|
1002
|
+
local_var_path = '/api/2.0/portal/payment/customer/operationsreport'
|
|
1003
|
+
|
|
1004
|
+
# query parameters
|
|
1005
|
+
query_params = opts[:query_params] || {}
|
|
1006
|
+
|
|
1007
|
+
# header parameters
|
|
1008
|
+
header_params = opts[:header_params] || {}
|
|
1009
|
+
# HTTP header 'Accept' (if needed)
|
|
1010
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1011
|
+
|
|
1012
|
+
# form parameters
|
|
1013
|
+
form_params = opts[:form_params] || {}
|
|
1014
|
+
|
|
1015
|
+
# http body (model)
|
|
1016
|
+
post_body = opts[:debug_body]
|
|
1017
|
+
|
|
1018
|
+
# return_type
|
|
1019
|
+
return_type = opts[:debug_return_type] || 'DocumentBuilderTaskWrapper'
|
|
1020
|
+
|
|
1021
|
+
# auth_names
|
|
1022
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1023
|
+
|
|
1024
|
+
new_options = opts.merge(
|
|
1025
|
+
:operation => :"Portal::PaymentApi.get_customer_operations_report",
|
|
1026
|
+
:header_params => header_params,
|
|
1027
|
+
:query_params => query_params,
|
|
1028
|
+
:form_params => form_params,
|
|
1029
|
+
:body => post_body,
|
|
1030
|
+
:auth_names => auth_names,
|
|
1031
|
+
:return_type => return_type
|
|
1032
|
+
)
|
|
1033
|
+
|
|
1034
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1035
|
+
if @api_client.config.debugging
|
|
1036
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_customer_operations_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1037
|
+
end
|
|
1038
|
+
return data, status_code, headers
|
|
1039
|
+
end
|
|
1040
|
+
|
|
1041
|
+
# Get the customer service usage
|
|
1042
|
+
# Returns how much of each wallet service the portal consumed and what that cost, added up per service instead of listed per movement. Only a DocSpace administrator may read it, a portal with no billing customer answers with an empty result, and the call is read-only. The filters are optional: `serviceName` narrows to particular services and fails with 404 on a name this installation does not sell, `participantName` and `status` narrow to who consumed and how the operation ended, `startDate` and `endDate` bound the period in the portal time zone, `metadata` matches the key and value pairs a service records with its usage, and `offset`, `limit`, `orderBy` and `orderType` page and sort the result. Amounts come with the unit the service is sold in, except AI tools, whose consumption is reported in tokens rather than in AI credits. The individual charges behind these totals are `GET api/2.0/portal/payment/customer/operations`, and the same figures as a downloadable file are `POST api/2.0/portal/payment/customer/usage/report`.
|
|
1043
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-customer-service-usage/
|
|
1044
|
+
# @param [Hash] opts the optional parameters
|
|
1045
|
+
# @option opts [Array<String>] :service_name The wallet services whose consumption is added up, named the way the billing catalogue names them - `backup`, `ai-tools`, `ai-search`, `disk-storage`, `docscloud`. Take the values from the `serviceName` field of `GET api/2.0/portal/payment/walletservices`; the match ignores case, a name this installation does not sell fails the call with 404, and an omitted list covers every service.
|
|
1046
|
+
# @option opts [String] :participant_name The participant whose consumption is added up - the account the accounting service records as the consumer. Consumption caused by a portal user carries that user ID here; surrounding whitespace is trimmed, and an omitted value covers every participant.
|
|
1047
|
+
# @option opts [OperationStatus] :status The outcome to keep. Consumption that is still being settled is reported as pending and may change later, while the other outcomes are final; every outcome is counted when this is omitted.
|
|
1048
|
+
# @option opts [Time] :start_date The beginning of the reported period, inclusive. Read in the portal time zone rather than in UTC, and defaults to the portal creation date.
|
|
1049
|
+
# @option opts [Time] :end_date The end of the reported period, inclusive. Read in the portal time zone rather than in UTC, and defaults to the moment the call is made.
|
|
1050
|
+
# @option opts [Hash<String, String>] :metadata The usage annotations a wallet service records alongside its consumption, as the key and value pairs that must all match for a record to be counted. The keys are chosen by the service that writes them, so read them off the `metadata` of the records already returned rather than guessing; an omitted map counts every record.
|
|
1051
|
+
# @option opts [Integer] :offset The number of per-service totals to skip before the first one returned. Counted after the filters and the ordering are applied, and starts at 0 when omitted.
|
|
1052
|
+
# @option opts [Integer] :limit The maximum number of per-service totals returned in one page. Defaults to 25 when omitted; the answer echoes the window back with its paging information, so the next `offset` can be computed without counting the items.
|
|
1053
|
+
# @option opts [String] :order_by The name of the field the per-service totals are sorted by, spelled as the accounting service names it, such as `ServiceName` or `StartDate`. Surrounding whitespace is trimmed, and the accounting service applies its own ordering when this is omitted.
|
|
1054
|
+
# @option opts [OperationOrderType] :order_type The direction the field named in `orderBy` is sorted in. Newest or largest first is what the accounting service does by default, so leaving this out sorts the same way as asking for descending explicitly.
|
|
1055
|
+
# @return [CustomerServiceUsageReportWrapper]
|
|
1056
|
+
def get_customer_service_usage(opts = {})
|
|
1057
|
+
data, _status_code, _headers = get_customer_service_usage_with_http_info(opts)
|
|
1058
|
+
data
|
|
1059
|
+
end
|
|
1060
|
+
|
|
1061
|
+
# Get the customer service usage
|
|
1062
|
+
# Returns how much of each wallet service the portal consumed and what that cost, added up per service instead of listed per movement. Only a DocSpace administrator may read it, a portal with no billing customer answers with an empty result, and the call is read-only. The filters are optional: `serviceName` narrows to particular services and fails with 404 on a name this installation does not sell, `participantName` and `status` narrow to who consumed and how the operation ended, `startDate` and `endDate` bound the period in the portal time zone, `metadata` matches the key and value pairs a service records with its usage, and `offset`, `limit`, `orderBy` and `orderType` page and sort the result. Amounts come with the unit the service is sold in, except AI tools, whose consumption is reported in tokens rather than in AI credits. The individual charges behind these totals are `GET api/2.0/portal/payment/customer/operations`, and the same figures as a downloadable file are `POST api/2.0/portal/payment/customer/usage/report`.
|
|
1063
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-customer-service-usage/
|
|
1064
|
+
# @param [Hash] opts the optional parameters
|
|
1065
|
+
# @option opts [Array<String>] :service_name The wallet services whose consumption is added up, named the way the billing catalogue names them - `backup`, `ai-tools`, `ai-search`, `disk-storage`, `docscloud`. Take the values from the `serviceName` field of `GET api/2.0/portal/payment/walletservices`; the match ignores case, a name this installation does not sell fails the call with 404, and an omitted list covers every service.
|
|
1066
|
+
# @option opts [String] :participant_name The participant whose consumption is added up - the account the accounting service records as the consumer. Consumption caused by a portal user carries that user ID here; surrounding whitespace is trimmed, and an omitted value covers every participant.
|
|
1067
|
+
# @option opts [OperationStatus] :status The outcome to keep. Consumption that is still being settled is reported as pending and may change later, while the other outcomes are final; every outcome is counted when this is omitted.
|
|
1068
|
+
# @option opts [Time] :start_date The beginning of the reported period, inclusive. Read in the portal time zone rather than in UTC, and defaults to the portal creation date.
|
|
1069
|
+
# @option opts [Time] :end_date The end of the reported period, inclusive. Read in the portal time zone rather than in UTC, and defaults to the moment the call is made.
|
|
1070
|
+
# @option opts [Hash<String, String>] :metadata The usage annotations a wallet service records alongside its consumption, as the key and value pairs that must all match for a record to be counted. The keys are chosen by the service that writes them, so read them off the `metadata` of the records already returned rather than guessing; an omitted map counts every record.
|
|
1071
|
+
# @option opts [Integer] :offset The number of per-service totals to skip before the first one returned. Counted after the filters and the ordering are applied, and starts at 0 when omitted.
|
|
1072
|
+
# @option opts [Integer] :limit The maximum number of per-service totals returned in one page. Defaults to 25 when omitted; the answer echoes the window back with its paging information, so the next `offset` can be computed without counting the items.
|
|
1073
|
+
# @option opts [String] :order_by The name of the field the per-service totals are sorted by, spelled as the accounting service names it, such as `ServiceName` or `StartDate`. Surrounding whitespace is trimmed, and the accounting service applies its own ordering when this is omitted.
|
|
1074
|
+
# @option opts [OperationOrderType] :order_type The direction the field named in `orderBy` is sorted in. Newest or largest first is what the accounting service does by default, so leaving this out sorts the same way as asking for descending explicitly.
|
|
1075
|
+
# @return [Array<(CustomerServiceUsageReportWrapper, Integer, Hash)>] CustomerServiceUsageReportWrapper data, response status code and response headers
|
|
1076
|
+
def get_customer_service_usage_with_http_info(opts = {})
|
|
1077
|
+
if @api_client.config.debugging
|
|
1078
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_customer_service_usage ...'
|
|
1079
|
+
end
|
|
1080
|
+
# resource path
|
|
1081
|
+
local_var_path = '/api/2.0/portal/payment/customer/usage'
|
|
1082
|
+
|
|
1083
|
+
# query parameters
|
|
1084
|
+
query_params = opts[:query_params] || {}
|
|
1085
|
+
query_params[:'serviceName'] = @api_client.build_collection_param(opts[:'service_name'], :multi) if !opts[:'service_name'].nil?
|
|
1086
|
+
query_params[:'participantName'] = opts[:'participant_name'] if !opts[:'participant_name'].nil?
|
|
1087
|
+
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
|
1088
|
+
query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
|
1089
|
+
query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
|
1090
|
+
query_params[:'metadata'] = opts[:'metadata'] if !opts[:'metadata'].nil?
|
|
1091
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
1092
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
1093
|
+
query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
|
1094
|
+
query_params[:'orderType'] = opts[:'order_type'] if !opts[:'order_type'].nil?
|
|
1095
|
+
|
|
1096
|
+
# header parameters
|
|
1097
|
+
header_params = opts[:header_params] || {}
|
|
1098
|
+
# HTTP header 'Accept' (if needed)
|
|
1099
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1100
|
+
|
|
1101
|
+
# form parameters
|
|
1102
|
+
form_params = opts[:form_params] || {}
|
|
1103
|
+
|
|
1104
|
+
# http body (model)
|
|
1105
|
+
post_body = opts[:debug_body]
|
|
1106
|
+
|
|
1107
|
+
# return_type
|
|
1108
|
+
return_type = opts[:debug_return_type] || 'CustomerServiceUsageReportWrapper'
|
|
1109
|
+
|
|
1110
|
+
# auth_names
|
|
1111
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1112
|
+
|
|
1113
|
+
new_options = opts.merge(
|
|
1114
|
+
:operation => :"Portal::PaymentApi.get_customer_service_usage",
|
|
1115
|
+
:header_params => header_params,
|
|
1116
|
+
:query_params => query_params,
|
|
1117
|
+
:form_params => form_params,
|
|
1118
|
+
:body => post_body,
|
|
1119
|
+
:auth_names => auth_names,
|
|
1120
|
+
:return_type => return_type
|
|
1121
|
+
)
|
|
1122
|
+
|
|
1123
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1124
|
+
if @api_client.config.debugging
|
|
1125
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_customer_service_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1126
|
+
end
|
|
1127
|
+
return data, status_code, headers
|
|
1128
|
+
end
|
|
1129
|
+
|
|
1130
|
+
# Get the service usage report status
|
|
1131
|
+
# Returns the state of the `xlsx` service usage report this user started with `POST api/2.0/portal/payment/customer/usage/report`: `percentage` while it is being built, `isCompleted` when it is done, `resultFileId`, `resultFileName` and `resultFileUrl` pointing at the file in the caller's My documents, and `error` when the build failed. The portal needs a billing customer and the caller has to be a DocSpace administrator; the call is read-only and is the one to poll. The task is kept per user and per report kind, so it reports neither another administrator's report nor the operations and monthly usage ones, which have their own status operations. An empty result means this user has no service usage report at all - none was started, or the finished one was already picked up or terminated. A completed task is dropped as soon as the next report is started, so read the file link out of the same answer that first reports `isCompleted`.
|
|
1132
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-customer-service-usage-report/
|
|
1133
|
+
# @param [Hash] opts the optional parameters
|
|
1134
|
+
# @return [DocumentBuilderTaskWrapper]
|
|
1135
|
+
def get_customer_service_usage_report(opts = {})
|
|
1136
|
+
data, _status_code, _headers = get_customer_service_usage_report_with_http_info(opts)
|
|
1137
|
+
data
|
|
1138
|
+
end
|
|
1139
|
+
|
|
1140
|
+
# Get the service usage report status
|
|
1141
|
+
# Returns the state of the `xlsx` service usage report this user started with `POST api/2.0/portal/payment/customer/usage/report`: `percentage` while it is being built, `isCompleted` when it is done, `resultFileId`, `resultFileName` and `resultFileUrl` pointing at the file in the caller's My documents, and `error` when the build failed. The portal needs a billing customer and the caller has to be a DocSpace administrator; the call is read-only and is the one to poll. The task is kept per user and per report kind, so it reports neither another administrator's report nor the operations and monthly usage ones, which have their own status operations. An empty result means this user has no service usage report at all - none was started, or the finished one was already picked up or terminated. A completed task is dropped as soon as the next report is started, so read the file link out of the same answer that first reports `isCompleted`.
|
|
1142
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-customer-service-usage-report/
|
|
1143
|
+
# @param [Hash] opts the optional parameters
|
|
1144
|
+
# @return [Array<(DocumentBuilderTaskWrapper, Integer, Hash)>] DocumentBuilderTaskWrapper data, response status code and response headers
|
|
1145
|
+
def get_customer_service_usage_report_with_http_info(opts = {})
|
|
1146
|
+
if @api_client.config.debugging
|
|
1147
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_customer_service_usage_report ...'
|
|
1148
|
+
end
|
|
1149
|
+
# resource path
|
|
1150
|
+
local_var_path = '/api/2.0/portal/payment/customer/usage/report'
|
|
1151
|
+
|
|
1152
|
+
# query parameters
|
|
1153
|
+
query_params = opts[:query_params] || {}
|
|
1154
|
+
|
|
1155
|
+
# header parameters
|
|
1156
|
+
header_params = opts[:header_params] || {}
|
|
1157
|
+
# HTTP header 'Accept' (if needed)
|
|
1158
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1159
|
+
|
|
1160
|
+
# form parameters
|
|
1161
|
+
form_params = opts[:form_params] || {}
|
|
1162
|
+
|
|
1163
|
+
# http body (model)
|
|
1164
|
+
post_body = opts[:debug_body]
|
|
1165
|
+
|
|
1166
|
+
# return_type
|
|
1167
|
+
return_type = opts[:debug_return_type] || 'DocumentBuilderTaskWrapper'
|
|
1168
|
+
|
|
1169
|
+
# auth_names
|
|
1170
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1171
|
+
|
|
1172
|
+
new_options = opts.merge(
|
|
1173
|
+
:operation => :"Portal::PaymentApi.get_customer_service_usage_report",
|
|
1174
|
+
:header_params => header_params,
|
|
1175
|
+
:query_params => query_params,
|
|
1176
|
+
:form_params => form_params,
|
|
1177
|
+
:body => post_body,
|
|
1178
|
+
:auth_names => auth_names,
|
|
1179
|
+
:return_type => return_type
|
|
1180
|
+
)
|
|
1181
|
+
|
|
1182
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1183
|
+
if @api_client.config.debugging
|
|
1184
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_customer_service_usage_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1185
|
+
end
|
|
1186
|
+
return data, status_code, headers
|
|
1187
|
+
end
|
|
1188
|
+
|
|
1189
|
+
# Get the billing account page
|
|
1190
|
+
# Hands back the address of the portal page on which the billing account is managed - the payment method on file, the invoices and the receipts - so a client can link to it instead of assembling the address itself. The portal must already have a billing customer: one that has never had it gets an empty result, and an installation without a billing service answers 403. Only the payer or the portal owner may read it, and the call changes nothing. The value is relative to the portal root (`payment.ashx`), and the optional `backUrl` is appended to it as a query parameter so the page can send the user back where they came from. It is not a checkout page: a plan is bought with `PUT api/2.0/portal/payment/url` and a payment method is attached with `GET api/2.0/portal/payment/checkoutsetupurl`.
|
|
1191
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-payment-account/
|
|
1192
|
+
# @param [Hash] opts the optional parameters
|
|
1193
|
+
# @option opts [String] :back_url The absolute address the billing account page should offer as its way back. It is appended to the returned portal-relative address as a query parameter rather than followed here, and omitting it yields the bare address of the page.
|
|
1194
|
+
# @return [StringWrapper]
|
|
1195
|
+
def get_payment_account(opts = {})
|
|
1196
|
+
data, _status_code, _headers = get_payment_account_with_http_info(opts)
|
|
1197
|
+
data
|
|
1198
|
+
end
|
|
1199
|
+
|
|
1200
|
+
# Get the billing account page
|
|
1201
|
+
# Hands back the address of the portal page on which the billing account is managed - the payment method on file, the invoices and the receipts - so a client can link to it instead of assembling the address itself. The portal must already have a billing customer: one that has never had it gets an empty result, and an installation without a billing service answers 403. Only the payer or the portal owner may read it, and the call changes nothing. The value is relative to the portal root (`payment.ashx`), and the optional `backUrl` is appended to it as a query parameter so the page can send the user back where they came from. It is not a checkout page: a plan is bought with `PUT api/2.0/portal/payment/url` and a payment method is attached with `GET api/2.0/portal/payment/checkoutsetupurl`.
|
|
1202
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-payment-account/
|
|
1203
|
+
# @param [Hash] opts the optional parameters
|
|
1204
|
+
# @option opts [String] :back_url The absolute address the billing account page should offer as its way back. It is appended to the returned portal-relative address as a query parameter rather than followed here, and omitting it yields the bare address of the page.
|
|
1205
|
+
# @return [Array<(StringWrapper, Integer, Hash)>] StringWrapper data, response status code and response headers
|
|
1206
|
+
def get_payment_account_with_http_info(opts = {})
|
|
1207
|
+
if @api_client.config.debugging
|
|
1208
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_payment_account ...'
|
|
1209
|
+
end
|
|
1210
|
+
if @api_client.config.client_side_validation && !opts[:'back_url'].nil? && opts[:'back_url'].to_s.length > 255
|
|
1211
|
+
fail ArgumentError, 'invalid value for "opts[:"back_url"]" when calling Portal::PaymentApi.get_payment_account, the character length must be smaller than or equal to 255.'
|
|
1212
|
+
end
|
|
1213
|
+
|
|
1214
|
+
if @api_client.config.client_side_validation && !opts[:'back_url'].nil? && opts[:'back_url'].to_s.length < 0
|
|
1215
|
+
fail ArgumentError, 'invalid value for "opts[:"back_url"]" when calling Portal::PaymentApi.get_payment_account, the character length must be greater than or equal to 0.'
|
|
1216
|
+
end
|
|
1217
|
+
|
|
1218
|
+
# resource path
|
|
1219
|
+
local_var_path = '/api/2.0/portal/payment/account'
|
|
1220
|
+
|
|
1221
|
+
# query parameters
|
|
1222
|
+
query_params = opts[:query_params] || {}
|
|
1223
|
+
query_params[:'backUrl'] = opts[:'back_url'] if !opts[:'back_url'].nil?
|
|
1224
|
+
|
|
1225
|
+
# header parameters
|
|
1226
|
+
header_params = opts[:header_params] || {}
|
|
1227
|
+
# HTTP header 'Accept' (if needed)
|
|
1228
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1229
|
+
|
|
1230
|
+
# form parameters
|
|
1231
|
+
form_params = opts[:form_params] || {}
|
|
1232
|
+
|
|
1233
|
+
# http body (model)
|
|
1234
|
+
post_body = opts[:debug_body]
|
|
1235
|
+
|
|
1236
|
+
# return_type
|
|
1237
|
+
return_type = opts[:debug_return_type] || 'StringWrapper'
|
|
1238
|
+
|
|
1239
|
+
# auth_names
|
|
1240
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1241
|
+
|
|
1242
|
+
new_options = opts.merge(
|
|
1243
|
+
:operation => :"Portal::PaymentApi.get_payment_account",
|
|
1244
|
+
:header_params => header_params,
|
|
1245
|
+
:query_params => query_params,
|
|
1246
|
+
:form_params => form_params,
|
|
1247
|
+
:body => post_body,
|
|
1248
|
+
:auth_names => auth_names,
|
|
1249
|
+
:return_type => return_type
|
|
1250
|
+
)
|
|
1251
|
+
|
|
1252
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1253
|
+
if @api_client.config.debugging
|
|
1254
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_payment_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1255
|
+
end
|
|
1256
|
+
return data, status_code, headers
|
|
1257
|
+
end
|
|
1258
|
+
|
|
1259
|
+
# Get the billing currencies
|
|
1260
|
+
# Tells a client which currency the portal is billed in: the default currency of the portal region always comes first, followed by the currency resolved for the current request when that one differs, so the answer holds one or two items. Nothing has to be called first, the caller needs the permission to edit the portal settings, and the call is read-only. Each item carries the country code of the region, the currency symbol and the native name of the currency; the first item is the currency the amounts from `GET api/2.0/portal/payment/prices` are expressed in. These are the currencies of the subscription prices, and they are not the accounting currencies the wallet is topped up in - those come with the balance in `GET api/2.0/portal/payment/customer/balance`.
|
|
1261
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-payment-currencies/
|
|
1262
|
+
# @param [Hash] opts the optional parameters
|
|
1263
|
+
# @return [CurrenciesArrayWrapper]
|
|
1264
|
+
def get_payment_currencies(opts = {})
|
|
1265
|
+
data, _status_code, _headers = get_payment_currencies_with_http_info(opts)
|
|
1266
|
+
data
|
|
1267
|
+
end
|
|
1268
|
+
|
|
1269
|
+
# Get the billing currencies
|
|
1270
|
+
# Tells a client which currency the portal is billed in: the default currency of the portal region always comes first, followed by the currency resolved for the current request when that one differs, so the answer holds one or two items. Nothing has to be called first, the caller needs the permission to edit the portal settings, and the call is read-only. Each item carries the country code of the region, the currency symbol and the native name of the currency; the first item is the currency the amounts from `GET api/2.0/portal/payment/prices` are expressed in. These are the currencies of the subscription prices, and they are not the accounting currencies the wallet is topped up in - those come with the balance in `GET api/2.0/portal/payment/customer/balance`.
|
|
1271
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-payment-currencies/
|
|
1272
|
+
# @param [Hash] opts the optional parameters
|
|
1273
|
+
# @return [Array<(CurrenciesArrayWrapper, Integer, Hash)>] CurrenciesArrayWrapper data, response status code and response headers
|
|
1274
|
+
def get_payment_currencies_with_http_info(opts = {})
|
|
1275
|
+
if @api_client.config.debugging
|
|
1276
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_payment_currencies ...'
|
|
1277
|
+
end
|
|
1278
|
+
# resource path
|
|
1279
|
+
local_var_path = '/api/2.0/portal/payment/currencies'
|
|
1280
|
+
|
|
1281
|
+
# query parameters
|
|
1282
|
+
query_params = opts[:query_params] || {}
|
|
1283
|
+
|
|
1284
|
+
# header parameters
|
|
1285
|
+
header_params = opts[:header_params] || {}
|
|
1286
|
+
# HTTP header 'Accept' (if needed)
|
|
1287
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1288
|
+
|
|
1289
|
+
# form parameters
|
|
1290
|
+
form_params = opts[:form_params] || {}
|
|
1291
|
+
|
|
1292
|
+
# http body (model)
|
|
1293
|
+
post_body = opts[:debug_body]
|
|
1294
|
+
|
|
1295
|
+
# return_type
|
|
1296
|
+
return_type = opts[:debug_return_type] || 'CurrenciesArrayWrapper'
|
|
1297
|
+
|
|
1298
|
+
# auth_names
|
|
1299
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1300
|
+
|
|
1301
|
+
new_options = opts.merge(
|
|
1302
|
+
:operation => :"Portal::PaymentApi.get_payment_currencies",
|
|
1303
|
+
:header_params => header_params,
|
|
1304
|
+
:query_params => query_params,
|
|
1305
|
+
:form_params => form_params,
|
|
1306
|
+
:body => post_body,
|
|
1307
|
+
:auth_names => auth_names,
|
|
1308
|
+
:return_type => return_type
|
|
1309
|
+
)
|
|
1310
|
+
|
|
1311
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1312
|
+
if @api_client.config.debugging
|
|
1313
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_payment_currencies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1314
|
+
end
|
|
1315
|
+
return data, status_code, headers
|
|
1316
|
+
end
|
|
1317
|
+
|
|
1318
|
+
# Get the purchasable quotas
|
|
1319
|
+
# Lists the quotas the portal can be put on - the paid plans and the wallet services - each with its price, its features and the limits it grants, which is what a pricing page is built from. Nothing has to be called first, the caller needs the permission to edit the portal settings, and the call is read-only. Only quotas marked visible are listed, newest first, and the two optional filters narrow that: `wallet` selects the wallet services (`true`) or the subscription plans (`false`), `additional` selects the add-ons to a plan (`true`) or the plans themselves (`false`), and an omitted filter keeps both kinds. A portal on a non-profit quota is a special case - asking for `additional=false` returns that single quota and nothing else, because no other plan may be bought for it. The quota the portal is actually on is not marked here; read it from `GET api/2.0/portal/payment/quota`.
|
|
1320
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-payment-quotas/
|
|
1321
|
+
# @param [Hash] opts the optional parameters
|
|
1322
|
+
# @option opts [Boolean] :wallet Which side of the catalogue is listed: `true` keeps the services paid out of the portal wallet, `false` keeps the subscription plans, and omitting it keeps both.
|
|
1323
|
+
# @option opts [Boolean] :additional Which layer of the catalogue is listed: `true` keeps the add-ons that extend a plan, `false` keeps the plans themselves, and omitting it keeps both.
|
|
1324
|
+
# @return [QuotaArrayWrapper]
|
|
1325
|
+
def get_payment_quotas(opts = {})
|
|
1326
|
+
data, _status_code, _headers = get_payment_quotas_with_http_info(opts)
|
|
1327
|
+
data
|
|
1328
|
+
end
|
|
1329
|
+
|
|
1330
|
+
# Get the purchasable quotas
|
|
1331
|
+
# Lists the quotas the portal can be put on - the paid plans and the wallet services - each with its price, its features and the limits it grants, which is what a pricing page is built from. Nothing has to be called first, the caller needs the permission to edit the portal settings, and the call is read-only. Only quotas marked visible are listed, newest first, and the two optional filters narrow that: `wallet` selects the wallet services (`true`) or the subscription plans (`false`), `additional` selects the add-ons to a plan (`true`) or the plans themselves (`false`), and an omitted filter keeps both kinds. A portal on a non-profit quota is a special case - asking for `additional=false` returns that single quota and nothing else, because no other plan may be bought for it. The quota the portal is actually on is not marked here; read it from `GET api/2.0/portal/payment/quota`.
|
|
1332
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-payment-quotas/
|
|
1333
|
+
# @param [Hash] opts the optional parameters
|
|
1334
|
+
# @option opts [Boolean] :wallet Which side of the catalogue is listed: `true` keeps the services paid out of the portal wallet, `false` keeps the subscription plans, and omitting it keeps both.
|
|
1335
|
+
# @option opts [Boolean] :additional Which layer of the catalogue is listed: `true` keeps the add-ons that extend a plan, `false` keeps the plans themselves, and omitting it keeps both.
|
|
1336
|
+
# @return [Array<(QuotaArrayWrapper, Integer, Hash)>] QuotaArrayWrapper data, response status code and response headers
|
|
1337
|
+
def get_payment_quotas_with_http_info(opts = {})
|
|
1338
|
+
if @api_client.config.debugging
|
|
1339
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_payment_quotas ...'
|
|
1340
|
+
end
|
|
1341
|
+
# resource path
|
|
1342
|
+
local_var_path = '/api/2.0/portal/payment/quotas'
|
|
1343
|
+
|
|
1344
|
+
# query parameters
|
|
1345
|
+
query_params = opts[:query_params] || {}
|
|
1346
|
+
query_params[:'wallet'] = opts[:'wallet'] if !opts[:'wallet'].nil?
|
|
1347
|
+
query_params[:'additional'] = opts[:'additional'] if !opts[:'additional'].nil?
|
|
1348
|
+
|
|
1349
|
+
# header parameters
|
|
1350
|
+
header_params = opts[:header_params] || {}
|
|
1351
|
+
# HTTP header 'Accept' (if needed)
|
|
1352
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1353
|
+
|
|
1354
|
+
# form parameters
|
|
1355
|
+
form_params = opts[:form_params] || {}
|
|
1356
|
+
|
|
1357
|
+
# http body (model)
|
|
1358
|
+
post_body = opts[:debug_body]
|
|
1359
|
+
|
|
1360
|
+
# return_type
|
|
1361
|
+
return_type = opts[:debug_return_type] || 'QuotaArrayWrapper'
|
|
1362
|
+
|
|
1363
|
+
# auth_names
|
|
1364
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1365
|
+
|
|
1366
|
+
new_options = opts.merge(
|
|
1367
|
+
:operation => :"Portal::PaymentApi.get_payment_quotas",
|
|
1368
|
+
:header_params => header_params,
|
|
1369
|
+
:query_params => query_params,
|
|
1370
|
+
:form_params => form_params,
|
|
1371
|
+
:body => post_body,
|
|
1372
|
+
:auth_names => auth_names,
|
|
1373
|
+
:return_type => return_type
|
|
1374
|
+
)
|
|
1375
|
+
|
|
1376
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1377
|
+
if @api_client.config.debugging
|
|
1378
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_payment_quotas\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1379
|
+
end
|
|
1380
|
+
return data, status_code, headers
|
|
1381
|
+
end
|
|
1382
|
+
|
|
1383
|
+
# Get the payment page URL
|
|
1384
|
+
# Starts the purchase of a monthly paid plan for this portal by handing back the hosted checkout page the buyer has to open; nothing is bought until that page is completed. The portal must have no paid plan yet - a portal whose plan is already paid gets an empty result and changes its subscription through `PUT api/2.0/portal/payment/update` instead - and the product name in `quantity` must be one of the monthly, non-wallet plans listed by `GET api/2.0/portal/payment/quotas`. Only a DocSpace administrator may call it. The call itself changes nothing on the portal and may be repeated: the money is taken by the payment provider on the checkout page, and the plan becomes active once the provider confirms it. The returned URL is absolute and single-purpose - it carries the caller's e-mail, the language of the request and the currency of the request region, and it redirects to `successUrl` or `backUrl` when the buyer finishes or cancels. Exactly one product per call is accepted and its quantity has to be greater than zero; yearly and wallet products are refused, and wallet services are bought with `PUT api/2.0/portal/payment/updatewallet` instead.
|
|
1385
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-payment-url/
|
|
1386
|
+
# @param [Hash] opts the optional parameters
|
|
1387
|
+
# @option opts [PaymentUrlRequestDto] :payment_url_request_dto
|
|
1388
|
+
# @return [StringWrapper]
|
|
1389
|
+
def get_payment_url(opts = {})
|
|
1390
|
+
data, _status_code, _headers = get_payment_url_with_http_info(opts)
|
|
1391
|
+
data
|
|
1392
|
+
end
|
|
1393
|
+
|
|
1394
|
+
# Get the payment page URL
|
|
1395
|
+
# Starts the purchase of a monthly paid plan for this portal by handing back the hosted checkout page the buyer has to open; nothing is bought until that page is completed. The portal must have no paid plan yet - a portal whose plan is already paid gets an empty result and changes its subscription through `PUT api/2.0/portal/payment/update` instead - and the product name in `quantity` must be one of the monthly, non-wallet plans listed by `GET api/2.0/portal/payment/quotas`. Only a DocSpace administrator may call it. The call itself changes nothing on the portal and may be repeated: the money is taken by the payment provider on the checkout page, and the plan becomes active once the provider confirms it. The returned URL is absolute and single-purpose - it carries the caller's e-mail, the language of the request and the currency of the request region, and it redirects to `successUrl` or `backUrl` when the buyer finishes or cancels. Exactly one product per call is accepted and its quantity has to be greater than zero; yearly and wallet products are refused, and wallet services are bought with `PUT api/2.0/portal/payment/updatewallet` instead.
|
|
1396
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-payment-url/
|
|
1397
|
+
# @param [Hash] opts the optional parameters
|
|
1398
|
+
# @option opts [PaymentUrlRequestDto] :payment_url_request_dto
|
|
1399
|
+
# @return [Array<(StringWrapper, Integer, Hash)>] StringWrapper data, response status code and response headers
|
|
1400
|
+
def get_payment_url_with_http_info(opts = {})
|
|
1401
|
+
if @api_client.config.debugging
|
|
1402
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_payment_url ...'
|
|
1403
|
+
end
|
|
1404
|
+
# resource path
|
|
1405
|
+
local_var_path = '/api/2.0/portal/payment/url'
|
|
1406
|
+
|
|
1407
|
+
# query parameters
|
|
1408
|
+
query_params = opts[:query_params] || {}
|
|
1409
|
+
|
|
1410
|
+
# header parameters
|
|
1411
|
+
header_params = opts[:header_params] || {}
|
|
1412
|
+
# HTTP header 'Accept' (if needed)
|
|
1413
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1414
|
+
# HTTP header 'Content-Type'
|
|
1415
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1416
|
+
if !content_type.nil?
|
|
1417
|
+
header_params['Content-Type'] = content_type
|
|
1418
|
+
end
|
|
1419
|
+
|
|
1420
|
+
# form parameters
|
|
1421
|
+
form_params = opts[:form_params] || {}
|
|
1422
|
+
|
|
1423
|
+
# http body (model)
|
|
1424
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'payment_url_request_dto'])
|
|
1425
|
+
|
|
1426
|
+
# return_type
|
|
1427
|
+
return_type = opts[:debug_return_type] || 'StringWrapper'
|
|
1428
|
+
|
|
1429
|
+
# auth_names
|
|
1430
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1431
|
+
|
|
1432
|
+
new_options = opts.merge(
|
|
1433
|
+
:operation => :"Portal::PaymentApi.get_payment_url",
|
|
1434
|
+
:header_params => header_params,
|
|
1435
|
+
:query_params => query_params,
|
|
1436
|
+
:form_params => form_params,
|
|
1437
|
+
:body => post_body,
|
|
1438
|
+
:auth_names => auth_names,
|
|
1439
|
+
:return_type => return_type
|
|
1440
|
+
)
|
|
1441
|
+
|
|
1442
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1443
|
+
if @api_client.config.debugging
|
|
1444
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_payment_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1445
|
+
end
|
|
1446
|
+
return data, status_code, headers
|
|
1447
|
+
end
|
|
1448
|
+
|
|
1449
|
+
# Get the product prices
|
|
1450
|
+
# Lists what one unit of every purchasable product costs, keyed by the product name that `quantity` takes in the purchase operations, so a client can price a plan or a wallet service without reading the whole quota list. Nothing has to be called first, and the caller needs the permission to edit the portal settings, which portal administrators and the owner have. The call is read-only. Prices are given in the one currency resolved for this request from the portal region, which `GET api/2.0/portal/payment/currencies` reports; a product with no price in that currency comes back as `0` rather than being left out, so a zero means unpriced and not free. The list covers the products on offer, not the portal's own plan - the plan in force, with its limits and its usage, is `GET api/2.0/portal/payment/quota`.
|
|
1451
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-portal-prices/
|
|
1452
|
+
# @param [Hash] opts the optional parameters
|
|
1453
|
+
# @return [GetPortalPrices200Response]
|
|
1454
|
+
def get_portal_prices(opts = {})
|
|
1455
|
+
data, _status_code, _headers = get_portal_prices_with_http_info(opts)
|
|
1456
|
+
data
|
|
1457
|
+
end
|
|
1458
|
+
|
|
1459
|
+
# Get the product prices
|
|
1460
|
+
# Lists what one unit of every purchasable product costs, keyed by the product name that `quantity` takes in the purchase operations, so a client can price a plan or a wallet service without reading the whole quota list. Nothing has to be called first, and the caller needs the permission to edit the portal settings, which portal administrators and the owner have. The call is read-only. Prices are given in the one currency resolved for this request from the portal region, which `GET api/2.0/portal/payment/currencies` reports; a product with no price in that currency comes back as `0` rather than being left out, so a zero means unpriced and not free. The list covers the products on offer, not the portal's own plan - the plan in force, with its limits and its usage, is `GET api/2.0/portal/payment/quota`.
|
|
1461
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-portal-prices/
|
|
1462
|
+
# @param [Hash] opts the optional parameters
|
|
1463
|
+
# @return [Array<(GetPortalPrices200Response, Integer, Hash)>] GetPortalPrices200Response data, response status code and response headers
|
|
1464
|
+
def get_portal_prices_with_http_info(opts = {})
|
|
1465
|
+
if @api_client.config.debugging
|
|
1466
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_portal_prices ...'
|
|
1467
|
+
end
|
|
1468
|
+
# resource path
|
|
1469
|
+
local_var_path = '/api/2.0/portal/payment/prices'
|
|
1470
|
+
|
|
1471
|
+
# query parameters
|
|
1472
|
+
query_params = opts[:query_params] || {}
|
|
1473
|
+
|
|
1474
|
+
# header parameters
|
|
1475
|
+
header_params = opts[:header_params] || {}
|
|
1476
|
+
# HTTP header 'Accept' (if needed)
|
|
1477
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1478
|
+
|
|
1479
|
+
# form parameters
|
|
1480
|
+
form_params = opts[:form_params] || {}
|
|
1481
|
+
|
|
1482
|
+
# http body (model)
|
|
1483
|
+
post_body = opts[:debug_body]
|
|
1484
|
+
|
|
1485
|
+
# return_type
|
|
1486
|
+
return_type = opts[:debug_return_type] || 'GetPortalPrices200Response'
|
|
1487
|
+
|
|
1488
|
+
# auth_names
|
|
1489
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1490
|
+
|
|
1491
|
+
new_options = opts.merge(
|
|
1492
|
+
:operation => :"Portal::PaymentApi.get_portal_prices",
|
|
1493
|
+
:header_params => header_params,
|
|
1494
|
+
:query_params => query_params,
|
|
1495
|
+
:form_params => form_params,
|
|
1496
|
+
:body => post_body,
|
|
1497
|
+
:auth_names => auth_names,
|
|
1498
|
+
:return_type => return_type
|
|
1499
|
+
)
|
|
1500
|
+
|
|
1501
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1502
|
+
if @api_client.config.debugging
|
|
1503
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_portal_prices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1504
|
+
end
|
|
1505
|
+
return data, status_code, headers
|
|
1506
|
+
end
|
|
1507
|
+
|
|
1508
|
+
# Get the current plan and limits
|
|
1509
|
+
# Returns the quota the portal is on right now - its paid plan or the free one - with everything a client needs to render itself: the price, the features that are switched on, the limits they grant (rooms, storage in bytes, users, administrators, AI) and how much of each is already used. Every signed-in member of the portal reads it, so it is not restricted to administrators; only guests are refused with 403. The call is read-only. The plan is served from the cache by default, which is what a start-up needs; `refresh=true` fetches it from the billing service instead, so use that right after a purchase and not routinely, because it is a remote call. The catalogue of the quotas that could be bought instead is `GET api/2.0/portal/payment/quotas`, and the money side of the same portal - customer, wallet and balance - starts at `GET api/2.0/portal/payment/customerinfo`.
|
|
1510
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-quota-payment-information/
|
|
1511
|
+
# @param [Hash] opts the optional parameters
|
|
1512
|
+
# @option opts [Boolean] :refresh Whether the answer is fetched from the billing service instead of the portal cache. The cached copy is what a start-up needs and costs nothing; asking for a fresh one makes a remote call, so use it right after a purchase or a top-up and not on every read.
|
|
1513
|
+
# @return [QuotaWrapper]
|
|
1514
|
+
def get_quota_payment_information(opts = {})
|
|
1515
|
+
data, _status_code, _headers = get_quota_payment_information_with_http_info(opts)
|
|
1516
|
+
data
|
|
1517
|
+
end
|
|
1518
|
+
|
|
1519
|
+
# Get the current plan and limits
|
|
1520
|
+
# Returns the quota the portal is on right now - its paid plan or the free one - with everything a client needs to render itself: the price, the features that are switched on, the limits they grant (rooms, storage in bytes, users, administrators, AI) and how much of each is already used. Every signed-in member of the portal reads it, so it is not restricted to administrators; only guests are refused with 403. The call is read-only. The plan is served from the cache by default, which is what a start-up needs; `refresh=true` fetches it from the billing service instead, so use that right after a purchase and not routinely, because it is a remote call. The catalogue of the quotas that could be bought instead is `GET api/2.0/portal/payment/quotas`, and the money side of the same portal - customer, wallet and balance - starts at `GET api/2.0/portal/payment/customerinfo`.
|
|
1521
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-quota-payment-information/
|
|
1522
|
+
# @param [Hash] opts the optional parameters
|
|
1523
|
+
# @option opts [Boolean] :refresh Whether the answer is fetched from the billing service instead of the portal cache. The cached copy is what a start-up needs and costs nothing; asking for a fresh one makes a remote call, so use it right after a purchase or a top-up and not on every read.
|
|
1524
|
+
# @return [Array<(QuotaWrapper, Integer, Hash)>] QuotaWrapper data, response status code and response headers
|
|
1525
|
+
def get_quota_payment_information_with_http_info(opts = {})
|
|
1526
|
+
if @api_client.config.debugging
|
|
1527
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_quota_payment_information ...'
|
|
1528
|
+
end
|
|
1529
|
+
# resource path
|
|
1530
|
+
local_var_path = '/api/2.0/portal/payment/quota'
|
|
1531
|
+
|
|
1532
|
+
# query parameters
|
|
1533
|
+
query_params = opts[:query_params] || {}
|
|
1534
|
+
query_params[:'refresh'] = opts[:'refresh'] if !opts[:'refresh'].nil?
|
|
1535
|
+
|
|
1536
|
+
# header parameters
|
|
1537
|
+
header_params = opts[:header_params] || {}
|
|
1538
|
+
# HTTP header 'Accept' (if needed)
|
|
1539
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1540
|
+
|
|
1541
|
+
# form parameters
|
|
1542
|
+
form_params = opts[:form_params] || {}
|
|
1543
|
+
|
|
1544
|
+
# http body (model)
|
|
1545
|
+
post_body = opts[:debug_body]
|
|
1546
|
+
|
|
1547
|
+
# return_type
|
|
1548
|
+
return_type = opts[:debug_return_type] || 'QuotaWrapper'
|
|
1549
|
+
|
|
1550
|
+
# auth_names
|
|
1551
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1552
|
+
|
|
1553
|
+
new_options = opts.merge(
|
|
1554
|
+
:operation => :"Portal::PaymentApi.get_quota_payment_information",
|
|
1555
|
+
:header_params => header_params,
|
|
1556
|
+
:query_params => query_params,
|
|
1557
|
+
:form_params => form_params,
|
|
1558
|
+
:body => post_body,
|
|
1559
|
+
:auth_names => auth_names,
|
|
1560
|
+
:return_type => return_type
|
|
1561
|
+
)
|
|
1562
|
+
|
|
1563
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1564
|
+
if @api_client.config.debugging
|
|
1565
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_quota_payment_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1566
|
+
end
|
|
1567
|
+
return data, status_code, headers
|
|
1568
|
+
end
|
|
1569
|
+
|
|
1570
|
+
# Get restricted AI models
|
|
1571
|
+
# Returns the AI chat models that are barred on this portal - the ones no user of it may pick for a conversation, whatever the price list offers. Only a DocSpace administrator may read it, and the call is read-only. When the installation has no billing service or AI is not enabled for the portal, the answer is an empty set instead of an error, which is indistinguishable from a portal that restricts nothing. An empty `models` therefore means every model in `GET api/2.0/portal/payment/ai-prices` may be used. The set names the barred models and not the allowed ones; replace it with `PUT api/2.0/portal/payment/ai-model/restrictions`.
|
|
1572
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-restricted-ai-models/
|
|
1573
|
+
# @param [Hash] opts the optional parameters
|
|
1574
|
+
# @return [RestrictedAiModelsWrapper]
|
|
1575
|
+
def get_restricted_ai_models(opts = {})
|
|
1576
|
+
data, _status_code, _headers = get_restricted_ai_models_with_http_info(opts)
|
|
1577
|
+
data
|
|
1578
|
+
end
|
|
1579
|
+
|
|
1580
|
+
# Get restricted AI models
|
|
1581
|
+
# Returns the AI chat models that are barred on this portal - the ones no user of it may pick for a conversation, whatever the price list offers. Only a DocSpace administrator may read it, and the call is read-only. When the installation has no billing service or AI is not enabled for the portal, the answer is an empty set instead of an error, which is indistinguishable from a portal that restricts nothing. An empty `models` therefore means every model in `GET api/2.0/portal/payment/ai-prices` may be used. The set names the barred models and not the allowed ones; replace it with `PUT api/2.0/portal/payment/ai-model/restrictions`.
|
|
1582
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-restricted-ai-models/
|
|
1583
|
+
# @param [Hash] opts the optional parameters
|
|
1584
|
+
# @return [Array<(RestrictedAiModelsWrapper, Integer, Hash)>] RestrictedAiModelsWrapper data, response status code and response headers
|
|
1585
|
+
def get_restricted_ai_models_with_http_info(opts = {})
|
|
1586
|
+
if @api_client.config.debugging
|
|
1587
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_restricted_ai_models ...'
|
|
1588
|
+
end
|
|
1589
|
+
# resource path
|
|
1590
|
+
local_var_path = '/api/2.0/portal/payment/ai-model/restrictions'
|
|
1591
|
+
|
|
1592
|
+
# query parameters
|
|
1593
|
+
query_params = opts[:query_params] || {}
|
|
1594
|
+
|
|
1595
|
+
# header parameters
|
|
1596
|
+
header_params = opts[:header_params] || {}
|
|
1597
|
+
# HTTP header 'Accept' (if needed)
|
|
1598
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1599
|
+
|
|
1600
|
+
# form parameters
|
|
1601
|
+
form_params = opts[:form_params] || {}
|
|
1602
|
+
|
|
1603
|
+
# http body (model)
|
|
1604
|
+
post_body = opts[:debug_body]
|
|
1605
|
+
|
|
1606
|
+
# return_type
|
|
1607
|
+
return_type = opts[:debug_return_type] || 'RestrictedAiModelsWrapper'
|
|
1608
|
+
|
|
1609
|
+
# auth_names
|
|
1610
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1611
|
+
|
|
1612
|
+
new_options = opts.merge(
|
|
1613
|
+
:operation => :"Portal::PaymentApi.get_restricted_ai_models",
|
|
1614
|
+
:header_params => header_params,
|
|
1615
|
+
:query_params => query_params,
|
|
1616
|
+
:form_params => form_params,
|
|
1617
|
+
:body => post_body,
|
|
1618
|
+
:auth_names => auth_names,
|
|
1619
|
+
:return_type => return_type
|
|
1620
|
+
)
|
|
1621
|
+
|
|
1622
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1623
|
+
if @api_client.config.debugging
|
|
1624
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_restricted_ai_models\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1625
|
+
end
|
|
1626
|
+
return data, status_code, headers
|
|
1627
|
+
end
|
|
1628
|
+
|
|
1629
|
+
# Get the subscription balance information
|
|
1630
|
+
# Reports in money how much of the portal's paid subscription period is still unused - the credit that `POST api/2.0/portal/payment/subscription/movetowallet` would carry over to the wallet if the subscription were ended now. The portal must have a billing customer and a plan in the paid state; a plan that is not paid answers 402, and a paid plan without a subscription row gives 404. Only the payer - the portal user whose e-mail is the billing customer's e-mail - may read it, and the call is read-only. The answer states the total cost of the current period with its currency, the start and the end of that period in UTC, the moment the unused part is measured up to, the days already elapsed, and the remaining balance both in the subscription currency and converted to the wallet currency. Every figure is computed for the instant of the request, so it changes between calls.
|
|
1631
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-subscription-balance-info/
|
|
1632
|
+
# @param [Hash] opts the optional parameters
|
|
1633
|
+
# @return [SubscriptionBalanceWrapper]
|
|
1634
|
+
def get_subscription_balance_info(opts = {})
|
|
1635
|
+
data, _status_code, _headers = get_subscription_balance_info_with_http_info(opts)
|
|
1636
|
+
data
|
|
1637
|
+
end
|
|
1638
|
+
|
|
1639
|
+
# Get the subscription balance information
|
|
1640
|
+
# Reports in money how much of the portal's paid subscription period is still unused - the credit that `POST api/2.0/portal/payment/subscription/movetowallet` would carry over to the wallet if the subscription were ended now. The portal must have a billing customer and a plan in the paid state; a plan that is not paid answers 402, and a paid plan without a subscription row gives 404. Only the payer - the portal user whose e-mail is the billing customer's e-mail - may read it, and the call is read-only. The answer states the total cost of the current period with its currency, the start and the end of that period in UTC, the moment the unused part is measured up to, the days already elapsed, and the remaining balance both in the subscription currency and converted to the wallet currency. Every figure is computed for the instant of the request, so it changes between calls.
|
|
1641
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-subscription-balance-info/
|
|
1642
|
+
# @param [Hash] opts the optional parameters
|
|
1643
|
+
# @return [Array<(SubscriptionBalanceWrapper, Integer, Hash)>] SubscriptionBalanceWrapper data, response status code and response headers
|
|
1644
|
+
def get_subscription_balance_info_with_http_info(opts = {})
|
|
1645
|
+
if @api_client.config.debugging
|
|
1646
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_subscription_balance_info ...'
|
|
1647
|
+
end
|
|
1648
|
+
# resource path
|
|
1649
|
+
local_var_path = '/api/2.0/portal/payment/subscription/balance'
|
|
1650
|
+
|
|
1651
|
+
# query parameters
|
|
1652
|
+
query_params = opts[:query_params] || {}
|
|
1653
|
+
|
|
1654
|
+
# header parameters
|
|
1655
|
+
header_params = opts[:header_params] || {}
|
|
1656
|
+
# HTTP header 'Accept' (if needed)
|
|
1657
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1658
|
+
|
|
1659
|
+
# form parameters
|
|
1660
|
+
form_params = opts[:form_params] || {}
|
|
1661
|
+
|
|
1662
|
+
# http body (model)
|
|
1663
|
+
post_body = opts[:debug_body]
|
|
1664
|
+
|
|
1665
|
+
# return_type
|
|
1666
|
+
return_type = opts[:debug_return_type] || 'SubscriptionBalanceWrapper'
|
|
1667
|
+
|
|
1668
|
+
# auth_names
|
|
1669
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1670
|
+
|
|
1671
|
+
new_options = opts.merge(
|
|
1672
|
+
:operation => :"Portal::PaymentApi.get_subscription_balance_info",
|
|
1673
|
+
:header_params => header_params,
|
|
1674
|
+
:query_params => query_params,
|
|
1675
|
+
:form_params => form_params,
|
|
1676
|
+
:body => post_body,
|
|
1677
|
+
:auth_names => auth_names,
|
|
1678
|
+
:return_type => return_type
|
|
1679
|
+
)
|
|
1680
|
+
|
|
1681
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1682
|
+
if @api_client.config.debugging
|
|
1683
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_subscription_balance_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1684
|
+
end
|
|
1685
|
+
return data, status_code, headers
|
|
1686
|
+
end
|
|
1687
|
+
|
|
1688
|
+
# Get the wallet service settings
|
|
1689
|
+
# Returns which wallet services an administrator has switched on for this portal by hand, as opposed to the ones its plan pays for. Only a DocSpace administrator may read it, an installation without a billing service answers 403, no billing customer is needed, and the call is read-only. `enabledServices` holds the names of those services and is empty when none was switched on. This is the stored setting and not the state of the portal: a service the plan brings with it is active without appearing here, so the honest answer to what is running is `GET api/2.0/portal/payment/activeservices`. One entry is changed with `POST api/2.0/portal/payment/servicestate`.
|
|
1690
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-tenant-wallet-service-settings/
|
|
1691
|
+
# @param [Hash] opts the optional parameters
|
|
1692
|
+
# @return [TenantWalletServiceSettingsWrapper]
|
|
1693
|
+
def get_tenant_wallet_service_settings(opts = {})
|
|
1694
|
+
data, _status_code, _headers = get_tenant_wallet_service_settings_with_http_info(opts)
|
|
1695
|
+
data
|
|
1696
|
+
end
|
|
1697
|
+
|
|
1698
|
+
# Get the wallet service settings
|
|
1699
|
+
# Returns which wallet services an administrator has switched on for this portal by hand, as opposed to the ones its plan pays for. Only a DocSpace administrator may read it, an installation without a billing service answers 403, no billing customer is needed, and the call is read-only. `enabledServices` holds the names of those services and is empty when none was switched on. This is the stored setting and not the state of the portal: a service the plan brings with it is active without appearing here, so the honest answer to what is running is `GET api/2.0/portal/payment/activeservices`. One entry is changed with `POST api/2.0/portal/payment/servicestate`.
|
|
1700
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-tenant-wallet-service-settings/
|
|
1701
|
+
# @param [Hash] opts the optional parameters
|
|
1702
|
+
# @return [Array<(TenantWalletServiceSettingsWrapper, Integer, Hash)>] TenantWalletServiceSettingsWrapper data, response status code and response headers
|
|
1703
|
+
def get_tenant_wallet_service_settings_with_http_info(opts = {})
|
|
1704
|
+
if @api_client.config.debugging
|
|
1705
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_tenant_wallet_service_settings ...'
|
|
1706
|
+
end
|
|
1707
|
+
# resource path
|
|
1708
|
+
local_var_path = '/api/2.0/portal/payment/servicessettings'
|
|
1709
|
+
|
|
1710
|
+
# query parameters
|
|
1711
|
+
query_params = opts[:query_params] || {}
|
|
1712
|
+
|
|
1713
|
+
# header parameters
|
|
1714
|
+
header_params = opts[:header_params] || {}
|
|
1715
|
+
# HTTP header 'Accept' (if needed)
|
|
1716
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1717
|
+
|
|
1718
|
+
# form parameters
|
|
1719
|
+
form_params = opts[:form_params] || {}
|
|
1720
|
+
|
|
1721
|
+
# http body (model)
|
|
1722
|
+
post_body = opts[:debug_body]
|
|
1723
|
+
|
|
1724
|
+
# return_type
|
|
1725
|
+
return_type = opts[:debug_return_type] || 'TenantWalletServiceSettingsWrapper'
|
|
1726
|
+
|
|
1727
|
+
# auth_names
|
|
1728
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1729
|
+
|
|
1730
|
+
new_options = opts.merge(
|
|
1731
|
+
:operation => :"Portal::PaymentApi.get_tenant_wallet_service_settings",
|
|
1732
|
+
:header_params => header_params,
|
|
1733
|
+
:query_params => query_params,
|
|
1734
|
+
:form_params => form_params,
|
|
1735
|
+
:body => post_body,
|
|
1736
|
+
:auth_names => auth_names,
|
|
1737
|
+
:return_type => return_type
|
|
1738
|
+
)
|
|
1739
|
+
|
|
1740
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1741
|
+
if @api_client.config.debugging
|
|
1742
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_tenant_wallet_service_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1743
|
+
end
|
|
1744
|
+
return data, status_code, headers
|
|
1745
|
+
end
|
|
1746
|
+
|
|
1747
|
+
# Get the auto top-up settings
|
|
1748
|
+
# Returns the portal's automatic wallet top-up settings - whether it is on, the balance that triggers a charge, the balance it is topped up to, and the currency both are expressed in. Any DocSpace administrator may read them, and unlike the operation that changes them this one needs neither a billing customer nor a configured billing service, so it answers on a portal that has never paid for anything. It is read-only and changes nothing. A portal that has never configured top-up gets the defaults rather than an empty result: `enabled` is false, `currency` is null, and `minBalance` and `upToBalance` are 0. Those two zeros are outside the ranges `POST api/2.0/portal/payment/topupsettings` accepts - 5 to 1000 and 6 to 5000 - so the answer cannot be sent straight back to it; supply real values instead. `lastModified` is `0001-01-01T00:00:00` until the settings are stored for the first time. `lowBalanceThreshold` and `lowBalanceNotified` are maintained by the portal itself: they are reported here, but cannot be written.
|
|
1749
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-tenant-wallet-settings/
|
|
1750
|
+
# @param [Hash] opts the optional parameters
|
|
1751
|
+
# @return [TenantWalletSettingsWrapper]
|
|
1752
|
+
def get_tenant_wallet_settings(opts = {})
|
|
1753
|
+
data, _status_code, _headers = get_tenant_wallet_settings_with_http_info(opts)
|
|
1754
|
+
data
|
|
1755
|
+
end
|
|
1756
|
+
|
|
1757
|
+
# Get the auto top-up settings
|
|
1758
|
+
# Returns the portal's automatic wallet top-up settings - whether it is on, the balance that triggers a charge, the balance it is topped up to, and the currency both are expressed in. Any DocSpace administrator may read them, and unlike the operation that changes them this one needs neither a billing customer nor a configured billing service, so it answers on a portal that has never paid for anything. It is read-only and changes nothing. A portal that has never configured top-up gets the defaults rather than an empty result: `enabled` is false, `currency` is null, and `minBalance` and `upToBalance` are 0. Those two zeros are outside the ranges `POST api/2.0/portal/payment/topupsettings` accepts - 5 to 1000 and 6 to 5000 - so the answer cannot be sent straight back to it; supply real values instead. `lastModified` is `0001-01-01T00:00:00` until the settings are stored for the first time. `lowBalanceThreshold` and `lowBalanceNotified` are maintained by the portal itself: they are reported here, but cannot be written.
|
|
1759
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-tenant-wallet-settings/
|
|
1760
|
+
# @param [Hash] opts the optional parameters
|
|
1761
|
+
# @return [Array<(TenantWalletSettingsWrapper, Integer, Hash)>] TenantWalletSettingsWrapper data, response status code and response headers
|
|
1762
|
+
def get_tenant_wallet_settings_with_http_info(opts = {})
|
|
1763
|
+
if @api_client.config.debugging
|
|
1764
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_tenant_wallet_settings ...'
|
|
1765
|
+
end
|
|
1766
|
+
# resource path
|
|
1767
|
+
local_var_path = '/api/2.0/portal/payment/topupsettings'
|
|
1768
|
+
|
|
1769
|
+
# query parameters
|
|
1770
|
+
query_params = opts[:query_params] || {}
|
|
1771
|
+
|
|
1772
|
+
# header parameters
|
|
1773
|
+
header_params = opts[:header_params] || {}
|
|
1774
|
+
# HTTP header 'Accept' (if needed)
|
|
1775
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1776
|
+
|
|
1777
|
+
# form parameters
|
|
1778
|
+
form_params = opts[:form_params] || {}
|
|
1779
|
+
|
|
1780
|
+
# http body (model)
|
|
1781
|
+
post_body = opts[:debug_body]
|
|
1782
|
+
|
|
1783
|
+
# return_type
|
|
1784
|
+
return_type = opts[:debug_return_type] || 'TenantWalletSettingsWrapper'
|
|
1785
|
+
|
|
1786
|
+
# auth_names
|
|
1787
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1788
|
+
|
|
1789
|
+
new_options = opts.merge(
|
|
1790
|
+
:operation => :"Portal::PaymentApi.get_tenant_wallet_settings",
|
|
1791
|
+
:header_params => header_params,
|
|
1792
|
+
:query_params => query_params,
|
|
1793
|
+
:form_params => form_params,
|
|
1794
|
+
:body => post_body,
|
|
1795
|
+
:auth_names => auth_names,
|
|
1796
|
+
:return_type => return_type
|
|
1797
|
+
)
|
|
1798
|
+
|
|
1799
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1800
|
+
if @api_client.config.debugging
|
|
1801
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_tenant_wallet_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1802
|
+
end
|
|
1803
|
+
return data, status_code, headers
|
|
1804
|
+
end
|
|
1805
|
+
|
|
1806
|
+
# Get a wallet service
|
|
1807
|
+
# Returns one wallet service by name, for a client that already knows which service it needs and does not want the whole catalogue. `service` is the name of the service - `Storage`, `Backup`, `AITools`, `Admin`, `DocsCloud`, `DocsCloudDevPack` or `AISearch` - and a name this installation does not sell answers 404. Nothing has to be called first, the caller needs the permission to edit the portal settings, and the call is read-only. The answer has the same shape as one item of `GET api/2.0/portal/payment/walletservices` - the price of a unit, the unit, the limits the service grants and its service name - except that the variants of a service are not grouped into `innerServices` here, because a single service is looked up directly. The price is in the currency resolved for the request.
|
|
1808
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-wallet-service/
|
|
1809
|
+
# @param service [TenantWalletService] The service to look up, given by its catalogue name. A service this installation does not sell answers 404, and the whole catalogue is `GET api/2.0/portal/payment/walletservices`.
|
|
1810
|
+
# @param [Hash] opts the optional parameters
|
|
1811
|
+
# @return [WalletServiceWrapper]
|
|
1812
|
+
def get_wallet_service(service, opts = {})
|
|
1813
|
+
data, _status_code, _headers = get_wallet_service_with_http_info(service, opts)
|
|
1814
|
+
data
|
|
1815
|
+
end
|
|
1816
|
+
|
|
1817
|
+
# Get a wallet service
|
|
1818
|
+
# Returns one wallet service by name, for a client that already knows which service it needs and does not want the whole catalogue. `service` is the name of the service - `Storage`, `Backup`, `AITools`, `Admin`, `DocsCloud`, `DocsCloudDevPack` or `AISearch` - and a name this installation does not sell answers 404. Nothing has to be called first, the caller needs the permission to edit the portal settings, and the call is read-only. The answer has the same shape as one item of `GET api/2.0/portal/payment/walletservices` - the price of a unit, the unit, the limits the service grants and its service name - except that the variants of a service are not grouped into `innerServices` here, because a single service is looked up directly. The price is in the currency resolved for the request.
|
|
1819
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-wallet-service/
|
|
1820
|
+
# @param service [TenantWalletService] The service to look up, given by its catalogue name. A service this installation does not sell answers 404, and the whole catalogue is `GET api/2.0/portal/payment/walletservices`.
|
|
1821
|
+
# @param [Hash] opts the optional parameters
|
|
1822
|
+
# @return [Array<(WalletServiceWrapper, Integer, Hash)>] WalletServiceWrapper data, response status code and response headers
|
|
1823
|
+
def get_wallet_service_with_http_info(service, opts = {})
|
|
1824
|
+
if @api_client.config.debugging
|
|
1825
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_wallet_service ...'
|
|
1826
|
+
end
|
|
1827
|
+
# verify the required parameter 'service' is set
|
|
1828
|
+
if @api_client.config.client_side_validation && service.nil?
|
|
1829
|
+
fail ArgumentError, "Missing the required parameter 'service' when calling Portal::PaymentApi.get_wallet_service"
|
|
1830
|
+
end
|
|
1831
|
+
# resource path
|
|
1832
|
+
local_var_path = '/api/2.0/portal/payment/walletservice'
|
|
1833
|
+
|
|
1834
|
+
# query parameters
|
|
1835
|
+
query_params = opts[:query_params] || {}
|
|
1836
|
+
query_params[:'service'] = service
|
|
1837
|
+
|
|
1838
|
+
# header parameters
|
|
1839
|
+
header_params = opts[:header_params] || {}
|
|
1840
|
+
# HTTP header 'Accept' (if needed)
|
|
1841
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1842
|
+
|
|
1843
|
+
# form parameters
|
|
1844
|
+
form_params = opts[:form_params] || {}
|
|
1845
|
+
|
|
1846
|
+
# http body (model)
|
|
1847
|
+
post_body = opts[:debug_body]
|
|
1848
|
+
|
|
1849
|
+
# return_type
|
|
1850
|
+
return_type = opts[:debug_return_type] || 'WalletServiceWrapper'
|
|
1851
|
+
|
|
1852
|
+
# auth_names
|
|
1853
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1854
|
+
|
|
1855
|
+
new_options = opts.merge(
|
|
1856
|
+
:operation => :"Portal::PaymentApi.get_wallet_service",
|
|
1857
|
+
:header_params => header_params,
|
|
1858
|
+
:query_params => query_params,
|
|
1859
|
+
:form_params => form_params,
|
|
1860
|
+
:body => post_body,
|
|
1861
|
+
:auth_names => auth_names,
|
|
1862
|
+
:return_type => return_type
|
|
1863
|
+
)
|
|
1864
|
+
|
|
1865
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1866
|
+
if @api_client.config.debugging
|
|
1867
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_wallet_service\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1868
|
+
end
|
|
1869
|
+
return data, status_code, headers
|
|
1870
|
+
end
|
|
1871
|
+
|
|
1872
|
+
# Get wallet services
|
|
1873
|
+
# Lists every service the portal may pay for out of its wallet - extra administrators, disk storage, backup, AI tools, AI search and Docs Connect - with the price of a unit, the unit it is sold in and whether the portal has it switched on. Nothing has to be called first, the caller needs the permission to edit the portal settings, and the call is read-only. Services that are variants of one another are folded together: the visible one carries the rest in its `innerServices`, so a client renders one card per group. The AI services are left out entirely when AI is not enabled for the portal. This is the catalogue and not the state of the portal - what is actually running is `GET api/2.0/portal/payment/activeservices`, one service on its own is `GET api/2.0/portal/payment/walletservice`, and switching one on or off is `POST api/2.0/portal/payment/servicestate`.
|
|
1874
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-wallet-services/
|
|
1875
|
+
# @param [Hash] opts the optional parameters
|
|
1876
|
+
# @return [WalletServiceArrayWrapper]
|
|
1877
|
+
def get_wallet_services(opts = {})
|
|
1878
|
+
data, _status_code, _headers = get_wallet_services_with_http_info(opts)
|
|
1879
|
+
data
|
|
1880
|
+
end
|
|
1881
|
+
|
|
1882
|
+
# Get wallet services
|
|
1883
|
+
# Lists every service the portal may pay for out of its wallet - extra administrators, disk storage, backup, AI tools, AI search and Docs Connect - with the price of a unit, the unit it is sold in and whether the portal has it switched on. Nothing has to be called first, the caller needs the permission to edit the portal settings, and the call is read-only. Services that are variants of one another are folded together: the visible one carries the rest in its `innerServices`, so a client renders one card per group. The AI services are left out entirely when AI is not enabled for the portal. This is the catalogue and not the state of the portal - what is actually running is `GET api/2.0/portal/payment/activeservices`, one service on its own is `GET api/2.0/portal/payment/walletservice`, and switching one on or off is `POST api/2.0/portal/payment/servicestate`.
|
|
1884
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/get-wallet-services/
|
|
1885
|
+
# @param [Hash] opts the optional parameters
|
|
1886
|
+
# @return [Array<(WalletServiceArrayWrapper, Integer, Hash)>] WalletServiceArrayWrapper data, response status code and response headers
|
|
1887
|
+
def get_wallet_services_with_http_info(opts = {})
|
|
1888
|
+
if @api_client.config.debugging
|
|
1889
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.get_wallet_services ...'
|
|
1890
|
+
end
|
|
1891
|
+
# resource path
|
|
1892
|
+
local_var_path = '/api/2.0/portal/payment/walletservices'
|
|
1893
|
+
|
|
1894
|
+
# query parameters
|
|
1895
|
+
query_params = opts[:query_params] || {}
|
|
1896
|
+
|
|
1897
|
+
# header parameters
|
|
1898
|
+
header_params = opts[:header_params] || {}
|
|
1899
|
+
# HTTP header 'Accept' (if needed)
|
|
1900
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1901
|
+
|
|
1902
|
+
# form parameters
|
|
1903
|
+
form_params = opts[:form_params] || {}
|
|
1904
|
+
|
|
1905
|
+
# http body (model)
|
|
1906
|
+
post_body = opts[:debug_body]
|
|
1907
|
+
|
|
1908
|
+
# return_type
|
|
1909
|
+
return_type = opts[:debug_return_type] || 'WalletServiceArrayWrapper'
|
|
1910
|
+
|
|
1911
|
+
# auth_names
|
|
1912
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1913
|
+
|
|
1914
|
+
new_options = opts.merge(
|
|
1915
|
+
:operation => :"Portal::PaymentApi.get_wallet_services",
|
|
1916
|
+
:header_params => header_params,
|
|
1917
|
+
:query_params => query_params,
|
|
1918
|
+
:form_params => form_params,
|
|
1919
|
+
:body => post_body,
|
|
1920
|
+
:auth_names => auth_names,
|
|
1921
|
+
:return_type => return_type
|
|
1922
|
+
)
|
|
1923
|
+
|
|
1924
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1925
|
+
if @api_client.config.debugging
|
|
1926
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#get_wallet_services\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1927
|
+
end
|
|
1928
|
+
return data, status_code, headers
|
|
1929
|
+
end
|
|
1930
|
+
|
|
1931
|
+
# Move the subscription to the wallet
|
|
1932
|
+
# Ends the portal's paid subscription and moves it onto the wallet: the unused balance of the running period is credited to the wallet, the wallet is topped up from the payment method on file if that credit does not cover the purchase, and the requested number of administrators is then bought as a wallet service. The portal needs a billing customer with a payment method set and a plan in the paid state, `quantity` has to name the administrators wallet product, and the number asked for may not be below the administrators the portal already has - read the credit that will be carried over from `GET api/2.0/portal/payment/subscription/balance` first. Only the payer may call it. The call is mutating, spends money and cannot be undone: the subscription is ended before the purchase is attempted, so a failure in the second half leaves the portal on the wallet with the money credited but the administrators unbought, and a repeat would then buy them a second time. It is limited to ten requests a minute per user by default. The result is `true` when the administrators were bought.
|
|
1933
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/move-subscription-to-wallet/
|
|
1934
|
+
# @param [Hash] opts the optional parameters
|
|
1935
|
+
# @option opts [QuantityRequestDto] :quantity_request_dto
|
|
1936
|
+
# @return [BooleanWrapper]
|
|
1937
|
+
def move_subscription_to_wallet(opts = {})
|
|
1938
|
+
data, _status_code, _headers = move_subscription_to_wallet_with_http_info(opts)
|
|
1939
|
+
data
|
|
1940
|
+
end
|
|
1941
|
+
|
|
1942
|
+
# Move the subscription to the wallet
|
|
1943
|
+
# Ends the portal's paid subscription and moves it onto the wallet: the unused balance of the running period is credited to the wallet, the wallet is topped up from the payment method on file if that credit does not cover the purchase, and the requested number of administrators is then bought as a wallet service. The portal needs a billing customer with a payment method set and a plan in the paid state, `quantity` has to name the administrators wallet product, and the number asked for may not be below the administrators the portal already has - read the credit that will be carried over from `GET api/2.0/portal/payment/subscription/balance` first. Only the payer may call it. The call is mutating, spends money and cannot be undone: the subscription is ended before the purchase is attempted, so a failure in the second half leaves the portal on the wallet with the money credited but the administrators unbought, and a repeat would then buy them a second time. It is limited to ten requests a minute per user by default. The result is `true` when the administrators were bought.
|
|
1944
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/move-subscription-to-wallet/
|
|
1945
|
+
# @param [Hash] opts the optional parameters
|
|
1946
|
+
# @option opts [QuantityRequestDto] :quantity_request_dto
|
|
1947
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
1948
|
+
def move_subscription_to_wallet_with_http_info(opts = {})
|
|
1949
|
+
if @api_client.config.debugging
|
|
1950
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.move_subscription_to_wallet ...'
|
|
1951
|
+
end
|
|
1952
|
+
# resource path
|
|
1953
|
+
local_var_path = '/api/2.0/portal/payment/subscription/movetowallet'
|
|
1954
|
+
|
|
1955
|
+
# query parameters
|
|
1956
|
+
query_params = opts[:query_params] || {}
|
|
1957
|
+
|
|
1958
|
+
# header parameters
|
|
1959
|
+
header_params = opts[:header_params] || {}
|
|
1960
|
+
# HTTP header 'Accept' (if needed)
|
|
1961
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1962
|
+
# HTTP header 'Content-Type'
|
|
1963
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1964
|
+
if !content_type.nil?
|
|
1965
|
+
header_params['Content-Type'] = content_type
|
|
1966
|
+
end
|
|
1967
|
+
|
|
1968
|
+
# form parameters
|
|
1969
|
+
form_params = opts[:form_params] || {}
|
|
1970
|
+
|
|
1971
|
+
# http body (model)
|
|
1972
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'quantity_request_dto'])
|
|
1973
|
+
|
|
1974
|
+
# return_type
|
|
1975
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
1976
|
+
|
|
1977
|
+
# auth_names
|
|
1978
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
1979
|
+
|
|
1980
|
+
new_options = opts.merge(
|
|
1981
|
+
:operation => :"Portal::PaymentApi.move_subscription_to_wallet",
|
|
1982
|
+
:header_params => header_params,
|
|
1983
|
+
:query_params => query_params,
|
|
1984
|
+
:form_params => form_params,
|
|
1985
|
+
:body => post_body,
|
|
1986
|
+
:auth_names => auth_names,
|
|
1987
|
+
:return_type => return_type
|
|
1988
|
+
)
|
|
1989
|
+
|
|
1990
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
1991
|
+
if @api_client.config.debugging
|
|
1992
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#move_subscription_to_wallet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1993
|
+
end
|
|
1994
|
+
return data, status_code, headers
|
|
1995
|
+
end
|
|
1996
|
+
|
|
1997
|
+
# Contact the sales team
|
|
1998
|
+
# Sends the portal's message to the ONLYOFFICE sales team - the contact-sales form behind a request for a quote, an invoice or a plan that cannot be bought online. `email` has to be a well-formed address and is where the answer will go, while `userName` and `message` say who is asking and what for; all three are required and none may be empty. Only a DocSpace administrator may call it. Nothing on the portal changes: no plan, no quota and no payment is touched, a message is mailed out and the request is written to the portal audit trail. There is no response body - status 200 means the message was handed to the mail service - and the call is not idempotent, so a repeat sends a second message. It is limited to ten requests a minute per user by default and answers 429 above that.
|
|
1999
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/send-payment-request/
|
|
2000
|
+
# @param [Hash] opts the optional parameters
|
|
2001
|
+
# @option opts [SalesRequestDto] :sales_request_dto
|
|
2002
|
+
# @return [nil]
|
|
2003
|
+
def send_payment_request(opts = {})
|
|
2004
|
+
send_payment_request_with_http_info(opts)
|
|
2005
|
+
nil
|
|
2006
|
+
end
|
|
2007
|
+
|
|
2008
|
+
# Contact the sales team
|
|
2009
|
+
# Sends the portal's message to the ONLYOFFICE sales team - the contact-sales form behind a request for a quote, an invoice or a plan that cannot be bought online. `email` has to be a well-formed address and is where the answer will go, while `userName` and `message` say who is asking and what for; all three are required and none may be empty. Only a DocSpace administrator may call it. Nothing on the portal changes: no plan, no quota and no payment is touched, a message is mailed out and the request is written to the portal audit trail. There is no response body - status 200 means the message was handed to the mail service - and the call is not idempotent, so a repeat sends a second message. It is limited to ten requests a minute per user by default and answers 429 above that.
|
|
2010
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/send-payment-request/
|
|
2011
|
+
# @param [Hash] opts the optional parameters
|
|
2012
|
+
# @option opts [SalesRequestDto] :sales_request_dto
|
|
2013
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
2014
|
+
def send_payment_request_with_http_info(opts = {})
|
|
2015
|
+
if @api_client.config.debugging
|
|
2016
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.send_payment_request ...'
|
|
2017
|
+
end
|
|
2018
|
+
# resource path
|
|
2019
|
+
local_var_path = '/api/2.0/portal/payment/request'
|
|
2020
|
+
|
|
2021
|
+
# query parameters
|
|
2022
|
+
query_params = opts[:query_params] || {}
|
|
2023
|
+
|
|
2024
|
+
# header parameters
|
|
2025
|
+
header_params = opts[:header_params] || {}
|
|
2026
|
+
# HTTP header 'Accept' (if needed)
|
|
2027
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
2028
|
+
# HTTP header 'Content-Type'
|
|
2029
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2030
|
+
if !content_type.nil?
|
|
2031
|
+
header_params['Content-Type'] = content_type
|
|
2032
|
+
end
|
|
2033
|
+
|
|
2034
|
+
# form parameters
|
|
2035
|
+
form_params = opts[:form_params] || {}
|
|
2036
|
+
|
|
2037
|
+
# http body (model)
|
|
2038
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'sales_request_dto'])
|
|
2039
|
+
|
|
2040
|
+
# return_type
|
|
2041
|
+
return_type = opts[:debug_return_type]
|
|
2042
|
+
|
|
2043
|
+
# auth_names
|
|
2044
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
2045
|
+
|
|
2046
|
+
new_options = opts.merge(
|
|
2047
|
+
:operation => :"Portal::PaymentApi.send_payment_request",
|
|
2048
|
+
:header_params => header_params,
|
|
2049
|
+
:query_params => query_params,
|
|
2050
|
+
:form_params => form_params,
|
|
2051
|
+
:body => post_body,
|
|
2052
|
+
:auth_names => auth_names,
|
|
2053
|
+
:return_type => return_type
|
|
2054
|
+
)
|
|
2055
|
+
|
|
2056
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
2057
|
+
if @api_client.config.debugging
|
|
2058
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#send_payment_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2059
|
+
end
|
|
2060
|
+
return data, status_code, headers
|
|
2061
|
+
end
|
|
2062
|
+
|
|
2063
|
+
# Set restricted AI models
|
|
2064
|
+
# Replaces the whole set of AI chat models barred on this portal: the body is the complete set that is to hold, so adding one restriction means sending the new model together with the ones already restricted, lifting one means leaving it out, and an empty set lifts them all. Read the current set from `GET api/2.0/portal/payment/ai-model/restrictions` and the model identifiers from `GET api/2.0/portal/payment/ai-prices` before calling. The installation needs a billing service and the AI gateway configured, the portal needs a billing customer and the AI tools wallet service switched on with `POST api/2.0/portal/payment/servicestate`, and the caller needs the permission to edit the portal settings as well as DocSpace administrator rights. The call is mutating and idempotent - sending the same set twice leaves the same state - and it is written to the portal audit trail. It takes effect on the next AI request, so a conversation already open on a model that has just been barred cannot go on with it. The stored set comes back in the answer. While AI tools is off the call is refused with 403 instead of being stored, because the read reports an empty set then and nothing written could be read back.
|
|
2065
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-restricted-ai-models/
|
|
2066
|
+
# @param [Hash] opts the optional parameters
|
|
2067
|
+
# @option opts [SetRestrictedAiModelsRequestDto] :set_restricted_ai_models_request_dto
|
|
2068
|
+
# @return [RestrictedAiModelsWrapper]
|
|
2069
|
+
def set_restricted_ai_models(opts = {})
|
|
2070
|
+
data, _status_code, _headers = set_restricted_ai_models_with_http_info(opts)
|
|
2071
|
+
data
|
|
2072
|
+
end
|
|
2073
|
+
|
|
2074
|
+
# Set restricted AI models
|
|
2075
|
+
# Replaces the whole set of AI chat models barred on this portal: the body is the complete set that is to hold, so adding one restriction means sending the new model together with the ones already restricted, lifting one means leaving it out, and an empty set lifts them all. Read the current set from `GET api/2.0/portal/payment/ai-model/restrictions` and the model identifiers from `GET api/2.0/portal/payment/ai-prices` before calling. The installation needs a billing service and the AI gateway configured, the portal needs a billing customer and the AI tools wallet service switched on with `POST api/2.0/portal/payment/servicestate`, and the caller needs the permission to edit the portal settings as well as DocSpace administrator rights. The call is mutating and idempotent - sending the same set twice leaves the same state - and it is written to the portal audit trail. It takes effect on the next AI request, so a conversation already open on a model that has just been barred cannot go on with it. The stored set comes back in the answer. While AI tools is off the call is refused with 403 instead of being stored, because the read reports an empty set then and nothing written could be read back.
|
|
2076
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-restricted-ai-models/
|
|
2077
|
+
# @param [Hash] opts the optional parameters
|
|
2078
|
+
# @option opts [SetRestrictedAiModelsRequestDto] :set_restricted_ai_models_request_dto
|
|
2079
|
+
# @return [Array<(RestrictedAiModelsWrapper, Integer, Hash)>] RestrictedAiModelsWrapper data, response status code and response headers
|
|
2080
|
+
def set_restricted_ai_models_with_http_info(opts = {})
|
|
2081
|
+
if @api_client.config.debugging
|
|
2082
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.set_restricted_ai_models ...'
|
|
2083
|
+
end
|
|
2084
|
+
# resource path
|
|
2085
|
+
local_var_path = '/api/2.0/portal/payment/ai-model/restrictions'
|
|
2086
|
+
|
|
2087
|
+
# query parameters
|
|
2088
|
+
query_params = opts[:query_params] || {}
|
|
2089
|
+
|
|
2090
|
+
# header parameters
|
|
2091
|
+
header_params = opts[:header_params] || {}
|
|
2092
|
+
# HTTP header 'Accept' (if needed)
|
|
2093
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
2094
|
+
# HTTP header 'Content-Type'
|
|
2095
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2096
|
+
if !content_type.nil?
|
|
2097
|
+
header_params['Content-Type'] = content_type
|
|
2098
|
+
end
|
|
2099
|
+
|
|
2100
|
+
# form parameters
|
|
2101
|
+
form_params = opts[:form_params] || {}
|
|
2102
|
+
|
|
2103
|
+
# http body (model)
|
|
2104
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'set_restricted_ai_models_request_dto'])
|
|
2105
|
+
|
|
2106
|
+
# return_type
|
|
2107
|
+
return_type = opts[:debug_return_type] || 'RestrictedAiModelsWrapper'
|
|
2108
|
+
|
|
2109
|
+
# auth_names
|
|
2110
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
2111
|
+
|
|
2112
|
+
new_options = opts.merge(
|
|
2113
|
+
:operation => :"Portal::PaymentApi.set_restricted_ai_models",
|
|
2114
|
+
:header_params => header_params,
|
|
2115
|
+
:query_params => query_params,
|
|
2116
|
+
:form_params => form_params,
|
|
2117
|
+
:body => post_body,
|
|
2118
|
+
:auth_names => auth_names,
|
|
2119
|
+
:return_type => return_type
|
|
2120
|
+
)
|
|
2121
|
+
|
|
2122
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
2123
|
+
if @api_client.config.debugging
|
|
2124
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#set_restricted_ai_models\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2125
|
+
end
|
|
2126
|
+
return data, status_code, headers
|
|
2127
|
+
end
|
|
2128
|
+
|
|
2129
|
+
# Set the auto top-up settings
|
|
2130
|
+
# Switches the portal's automatic wallet top-up on or off and sets its thresholds: while it is on, the payment method on file is charged whenever the wallet balance falls below `minBalance`, enough to bring it up to `upToBalance`, in `currency`. The portal needs a billing customer whose wallet balance exists - a portal that has never had one answers 404, so top the wallet up once with `POST api/2.0/portal/payment/deposit` first - and only the payer may change the settings. The body replaces the stored settings as a whole and an omitted body resets them to the defaults; `minBalance` is accepted between 5 and 1000 and `upToBalance` between 6 and 5000, and `upToBalance` has to be greater than `minBalance`, so that a top-up lifts the wallet above the balance that triggers it. The low-balance warning state (`lowBalanceThreshold`, `lowBalanceNotified`) and `lastModified` may be sent for compatibility but are ignored: the portal keeps the values it had. The call is mutating and idempotent, it charges nothing by itself, it is written to the portal audit trail, and switching the top-up on also re-arms the low-balance warning. The settings as they were stored come back in the answer.
|
|
2131
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-tenant-wallet-settings/
|
|
2132
|
+
# @param [Hash] opts the optional parameters
|
|
2133
|
+
# @option opts [TenantWalletSettingsRequestDto] :tenant_wallet_settings_request_dto
|
|
2134
|
+
# @return [TenantWalletSettingsWrapper]
|
|
2135
|
+
def set_tenant_wallet_settings(opts = {})
|
|
2136
|
+
data, _status_code, _headers = set_tenant_wallet_settings_with_http_info(opts)
|
|
2137
|
+
data
|
|
2138
|
+
end
|
|
2139
|
+
|
|
2140
|
+
# Set the auto top-up settings
|
|
2141
|
+
# Switches the portal's automatic wallet top-up on or off and sets its thresholds: while it is on, the payment method on file is charged whenever the wallet balance falls below `minBalance`, enough to bring it up to `upToBalance`, in `currency`. The portal needs a billing customer whose wallet balance exists - a portal that has never had one answers 404, so top the wallet up once with `POST api/2.0/portal/payment/deposit` first - and only the payer may change the settings. The body replaces the stored settings as a whole and an omitted body resets them to the defaults; `minBalance` is accepted between 5 and 1000 and `upToBalance` between 6 and 5000, and `upToBalance` has to be greater than `minBalance`, so that a top-up lifts the wallet above the balance that triggers it. The low-balance warning state (`lowBalanceThreshold`, `lowBalanceNotified`) and `lastModified` may be sent for compatibility but are ignored: the portal keeps the values it had. The call is mutating and idempotent, it charges nothing by itself, it is written to the portal audit trail, and switching the top-up on also re-arms the low-balance warning. The settings as they were stored come back in the answer.
|
|
2142
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/set-tenant-wallet-settings/
|
|
2143
|
+
# @param [Hash] opts the optional parameters
|
|
2144
|
+
# @option opts [TenantWalletSettingsRequestDto] :tenant_wallet_settings_request_dto
|
|
2145
|
+
# @return [Array<(TenantWalletSettingsWrapper, Integer, Hash)>] TenantWalletSettingsWrapper data, response status code and response headers
|
|
2146
|
+
def set_tenant_wallet_settings_with_http_info(opts = {})
|
|
2147
|
+
if @api_client.config.debugging
|
|
2148
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.set_tenant_wallet_settings ...'
|
|
2149
|
+
end
|
|
2150
|
+
# resource path
|
|
2151
|
+
local_var_path = '/api/2.0/portal/payment/topupsettings'
|
|
2152
|
+
|
|
2153
|
+
# query parameters
|
|
2154
|
+
query_params = opts[:query_params] || {}
|
|
2155
|
+
|
|
2156
|
+
# header parameters
|
|
2157
|
+
header_params = opts[:header_params] || {}
|
|
2158
|
+
# HTTP header 'Accept' (if needed)
|
|
2159
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
2160
|
+
# HTTP header 'Content-Type'
|
|
2161
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2162
|
+
if !content_type.nil?
|
|
2163
|
+
header_params['Content-Type'] = content_type
|
|
2164
|
+
end
|
|
2165
|
+
|
|
2166
|
+
# form parameters
|
|
2167
|
+
form_params = opts[:form_params] || {}
|
|
2168
|
+
|
|
2169
|
+
# http body (model)
|
|
2170
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'tenant_wallet_settings_request_dto'])
|
|
2171
|
+
|
|
2172
|
+
# return_type
|
|
2173
|
+
return_type = opts[:debug_return_type] || 'TenantWalletSettingsWrapper'
|
|
2174
|
+
|
|
2175
|
+
# auth_names
|
|
2176
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
2177
|
+
|
|
2178
|
+
new_options = opts.merge(
|
|
2179
|
+
:operation => :"Portal::PaymentApi.set_tenant_wallet_settings",
|
|
2180
|
+
:header_params => header_params,
|
|
2181
|
+
:query_params => query_params,
|
|
2182
|
+
:form_params => form_params,
|
|
2183
|
+
:body => post_body,
|
|
2184
|
+
:auth_names => auth_names,
|
|
2185
|
+
:return_type => return_type
|
|
2186
|
+
)
|
|
2187
|
+
|
|
2188
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
2189
|
+
if @api_client.config.debugging
|
|
2190
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#set_tenant_wallet_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2191
|
+
end
|
|
2192
|
+
return data, status_code, headers
|
|
2193
|
+
end
|
|
2194
|
+
|
|
2195
|
+
# Terminate the monthly usage report
|
|
2196
|
+
# Stops the `xlsx` monthly usage report this user has running and drops its task, for a report that was started for the wrong period or is no longer wanted. The portal needs a billing customer and the caller has to be a DocSpace administrator. The stop is asked of the worker that builds the file rather than done here, so `GET api/2.0/portal/payment/customer/usage/monthly/report` can still answer for a moment afterwards. The call is safe to repeat and does nothing at all when this user has no such report running: there is no response body, and status 200 says the stop was requested, not that a report was really stopped. It leaves the operations and service usage reports alone, and a report that had already finished keeps its file in My documents.
|
|
2197
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/terminate-customer-monthly-usage-report/
|
|
2198
|
+
# @param [Hash] opts the optional parameters
|
|
2199
|
+
# @return [nil]
|
|
2200
|
+
def terminate_customer_monthly_usage_report(opts = {})
|
|
2201
|
+
terminate_customer_monthly_usage_report_with_http_info(opts)
|
|
2202
|
+
nil
|
|
2203
|
+
end
|
|
2204
|
+
|
|
2205
|
+
# Terminate the monthly usage report
|
|
2206
|
+
# Stops the `xlsx` monthly usage report this user has running and drops its task, for a report that was started for the wrong period or is no longer wanted. The portal needs a billing customer and the caller has to be a DocSpace administrator. The stop is asked of the worker that builds the file rather than done here, so `GET api/2.0/portal/payment/customer/usage/monthly/report` can still answer for a moment afterwards. The call is safe to repeat and does nothing at all when this user has no such report running: there is no response body, and status 200 says the stop was requested, not that a report was really stopped. It leaves the operations and service usage reports alone, and a report that had already finished keeps its file in My documents.
|
|
2207
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/terminate-customer-monthly-usage-report/
|
|
2208
|
+
# @param [Hash] opts the optional parameters
|
|
2209
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
2210
|
+
def terminate_customer_monthly_usage_report_with_http_info(opts = {})
|
|
2211
|
+
if @api_client.config.debugging
|
|
2212
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.terminate_customer_monthly_usage_report ...'
|
|
2213
|
+
end
|
|
2214
|
+
# resource path
|
|
2215
|
+
local_var_path = '/api/2.0/portal/payment/customer/usage/monthly/report'
|
|
2216
|
+
|
|
2217
|
+
# query parameters
|
|
2218
|
+
query_params = opts[:query_params] || {}
|
|
2219
|
+
|
|
2220
|
+
# header parameters
|
|
2221
|
+
header_params = opts[:header_params] || {}
|
|
2222
|
+
# HTTP header 'Accept' (if needed)
|
|
2223
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
2224
|
+
|
|
2225
|
+
# form parameters
|
|
2226
|
+
form_params = opts[:form_params] || {}
|
|
2227
|
+
|
|
2228
|
+
# http body (model)
|
|
2229
|
+
post_body = opts[:debug_body]
|
|
2230
|
+
|
|
2231
|
+
# return_type
|
|
2232
|
+
return_type = opts[:debug_return_type]
|
|
2233
|
+
|
|
2234
|
+
# auth_names
|
|
2235
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
2236
|
+
|
|
2237
|
+
new_options = opts.merge(
|
|
2238
|
+
:operation => :"Portal::PaymentApi.terminate_customer_monthly_usage_report",
|
|
2239
|
+
:header_params => header_params,
|
|
2240
|
+
:query_params => query_params,
|
|
2241
|
+
:form_params => form_params,
|
|
2242
|
+
:body => post_body,
|
|
2243
|
+
:auth_names => auth_names,
|
|
2244
|
+
:return_type => return_type
|
|
2245
|
+
)
|
|
2246
|
+
|
|
2247
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
2248
|
+
if @api_client.config.debugging
|
|
2249
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#terminate_customer_monthly_usage_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2250
|
+
end
|
|
2251
|
+
return data, status_code, headers
|
|
2252
|
+
end
|
|
2253
|
+
|
|
2254
|
+
# Terminate the operations report
|
|
2255
|
+
# Stops the `xlsx` wallet operations report this user has running and drops its task, for a report that was started with the wrong filters or is no longer wanted. The portal needs a billing customer and the caller has to be a DocSpace administrator. The stop is asked of the worker that builds the file rather than done here, so `GET api/2.0/portal/payment/customer/operationsreport` can still answer for a moment afterwards. The call is safe to repeat and does nothing at all when this user has no report running: there is no response body, and status 200 says the stop was requested, not that a report was really stopped. A report that had already finished keeps its file in My documents - nothing is deleted from there.
|
|
2256
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/terminate-customer-operations-report/
|
|
2257
|
+
# @param [Hash] opts the optional parameters
|
|
2258
|
+
# @return [nil]
|
|
2259
|
+
def terminate_customer_operations_report(opts = {})
|
|
2260
|
+
terminate_customer_operations_report_with_http_info(opts)
|
|
2261
|
+
nil
|
|
2262
|
+
end
|
|
2263
|
+
|
|
2264
|
+
# Terminate the operations report
|
|
2265
|
+
# Stops the `xlsx` wallet operations report this user has running and drops its task, for a report that was started with the wrong filters or is no longer wanted. The portal needs a billing customer and the caller has to be a DocSpace administrator. The stop is asked of the worker that builds the file rather than done here, so `GET api/2.0/portal/payment/customer/operationsreport` can still answer for a moment afterwards. The call is safe to repeat and does nothing at all when this user has no report running: there is no response body, and status 200 says the stop was requested, not that a report was really stopped. A report that had already finished keeps its file in My documents - nothing is deleted from there.
|
|
2266
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/terminate-customer-operations-report/
|
|
2267
|
+
# @param [Hash] opts the optional parameters
|
|
2268
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
2269
|
+
def terminate_customer_operations_report_with_http_info(opts = {})
|
|
2270
|
+
if @api_client.config.debugging
|
|
2271
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.terminate_customer_operations_report ...'
|
|
2272
|
+
end
|
|
2273
|
+
# resource path
|
|
2274
|
+
local_var_path = '/api/2.0/portal/payment/customer/operationsreport'
|
|
2275
|
+
|
|
2276
|
+
# query parameters
|
|
2277
|
+
query_params = opts[:query_params] || {}
|
|
2278
|
+
|
|
2279
|
+
# header parameters
|
|
2280
|
+
header_params = opts[:header_params] || {}
|
|
2281
|
+
# HTTP header 'Accept' (if needed)
|
|
2282
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
2283
|
+
|
|
2284
|
+
# form parameters
|
|
2285
|
+
form_params = opts[:form_params] || {}
|
|
2286
|
+
|
|
2287
|
+
# http body (model)
|
|
2288
|
+
post_body = opts[:debug_body]
|
|
2289
|
+
|
|
2290
|
+
# return_type
|
|
2291
|
+
return_type = opts[:debug_return_type]
|
|
2292
|
+
|
|
2293
|
+
# auth_names
|
|
2294
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
2295
|
+
|
|
2296
|
+
new_options = opts.merge(
|
|
2297
|
+
:operation => :"Portal::PaymentApi.terminate_customer_operations_report",
|
|
2298
|
+
:header_params => header_params,
|
|
2299
|
+
:query_params => query_params,
|
|
2300
|
+
:form_params => form_params,
|
|
2301
|
+
:body => post_body,
|
|
2302
|
+
:auth_names => auth_names,
|
|
2303
|
+
:return_type => return_type
|
|
2304
|
+
)
|
|
2305
|
+
|
|
2306
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
2307
|
+
if @api_client.config.debugging
|
|
2308
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#terminate_customer_operations_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2309
|
+
end
|
|
2310
|
+
return data, status_code, headers
|
|
2311
|
+
end
|
|
2312
|
+
|
|
2313
|
+
# Terminate the service usage report
|
|
2314
|
+
# Stops the `xlsx` service usage report this user has running and drops its task, for a report that was started with the wrong filters or is no longer wanted. The portal needs a billing customer and the caller has to be a DocSpace administrator. The stop is asked of the worker that builds the file rather than done here, so `GET api/2.0/portal/payment/customer/usage/report` can still answer for a moment afterwards. The call is safe to repeat and does nothing at all when this user has no such report running: there is no response body, and status 200 says the stop was requested, not that a report was really stopped. It leaves the operations and monthly usage reports alone, and a report that had already finished keeps its file in My documents.
|
|
2315
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/terminate-customer-service-usage-report/
|
|
2316
|
+
# @param [Hash] opts the optional parameters
|
|
2317
|
+
# @return [nil]
|
|
2318
|
+
def terminate_customer_service_usage_report(opts = {})
|
|
2319
|
+
terminate_customer_service_usage_report_with_http_info(opts)
|
|
2320
|
+
nil
|
|
2321
|
+
end
|
|
2322
|
+
|
|
2323
|
+
# Terminate the service usage report
|
|
2324
|
+
# Stops the `xlsx` service usage report this user has running and drops its task, for a report that was started with the wrong filters or is no longer wanted. The portal needs a billing customer and the caller has to be a DocSpace administrator. The stop is asked of the worker that builds the file rather than done here, so `GET api/2.0/portal/payment/customer/usage/report` can still answer for a moment afterwards. The call is safe to repeat and does nothing at all when this user has no such report running: there is no response body, and status 200 says the stop was requested, not that a report was really stopped. It leaves the operations and monthly usage reports alone, and a report that had already finished keeps its file in My documents.
|
|
2325
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/terminate-customer-service-usage-report/
|
|
2326
|
+
# @param [Hash] opts the optional parameters
|
|
2327
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
2328
|
+
def terminate_customer_service_usage_report_with_http_info(opts = {})
|
|
2329
|
+
if @api_client.config.debugging
|
|
2330
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.terminate_customer_service_usage_report ...'
|
|
2331
|
+
end
|
|
2332
|
+
# resource path
|
|
2333
|
+
local_var_path = '/api/2.0/portal/payment/customer/usage/report'
|
|
2334
|
+
|
|
2335
|
+
# query parameters
|
|
2336
|
+
query_params = opts[:query_params] || {}
|
|
2337
|
+
|
|
2338
|
+
# header parameters
|
|
2339
|
+
header_params = opts[:header_params] || {}
|
|
2340
|
+
# HTTP header 'Accept' (if needed)
|
|
2341
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
2342
|
+
|
|
2343
|
+
# form parameters
|
|
2344
|
+
form_params = opts[:form_params] || {}
|
|
2345
|
+
|
|
2346
|
+
# http body (model)
|
|
2347
|
+
post_body = opts[:debug_body]
|
|
2348
|
+
|
|
2349
|
+
# return_type
|
|
2350
|
+
return_type = opts[:debug_return_type]
|
|
2351
|
+
|
|
2352
|
+
# auth_names
|
|
2353
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
2354
|
+
|
|
2355
|
+
new_options = opts.merge(
|
|
2356
|
+
:operation => :"Portal::PaymentApi.terminate_customer_service_usage_report",
|
|
2357
|
+
:header_params => header_params,
|
|
2358
|
+
:query_params => query_params,
|
|
2359
|
+
:form_params => form_params,
|
|
2360
|
+
:body => post_body,
|
|
2361
|
+
:auth_names => auth_names,
|
|
2362
|
+
:return_type => return_type
|
|
2363
|
+
)
|
|
2364
|
+
|
|
2365
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
2366
|
+
if @api_client.config.debugging
|
|
2367
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#terminate_customer_service_usage_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2368
|
+
end
|
|
2369
|
+
return data, status_code, headers
|
|
2370
|
+
end
|
|
2371
|
+
|
|
2372
|
+
# Top up the wallet
|
|
2373
|
+
# Charges the payment method on file and adds the amount to the portal's wallet, the balance every wallet service is paid from. The portal needs a billing customer with a payment method set - attach one with `GET api/2.0/portal/payment/checkoutsetupurl` - `currency` has to be one of the accounting currencies this installation supports, and `amount` is a whole number of currency units between 1 and 999999. Only the payer may call it. The call takes money and is not idempotent in any way: two identical requests charge twice, so a client must not retry it blindly after a timeout, and it is limited to ten requests a minute per user by default. A successful top-up pushes the new balance to the portal clients over their socket connection and re-arms the low-balance notification. The result is `true` when the payment provider accepted the charge; read the resulting balance back from `GET api/2.0/portal/payment/customer/balance`.
|
|
2374
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/top-up-deposit/
|
|
2375
|
+
# @param [Hash] opts the optional parameters
|
|
2376
|
+
# @option opts [TopUpDepositRequestDto] :top_up_deposit_request_dto
|
|
2377
|
+
# @return [BooleanWrapper]
|
|
2378
|
+
def top_up_deposit(opts = {})
|
|
2379
|
+
data, _status_code, _headers = top_up_deposit_with_http_info(opts)
|
|
2380
|
+
data
|
|
2381
|
+
end
|
|
2382
|
+
|
|
2383
|
+
# Top up the wallet
|
|
2384
|
+
# Charges the payment method on file and adds the amount to the portal's wallet, the balance every wallet service is paid from. The portal needs a billing customer with a payment method set - attach one with `GET api/2.0/portal/payment/checkoutsetupurl` - `currency` has to be one of the accounting currencies this installation supports, and `amount` is a whole number of currency units between 1 and 999999. Only the payer may call it. The call takes money and is not idempotent in any way: two identical requests charge twice, so a client must not retry it blindly after a timeout, and it is limited to ten requests a minute per user by default. A successful top-up pushes the new balance to the portal clients over their socket connection and re-arms the low-balance notification. The result is `true` when the payment provider accepted the charge; read the resulting balance back from `GET api/2.0/portal/payment/customer/balance`.
|
|
2385
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/top-up-deposit/
|
|
2386
|
+
# @param [Hash] opts the optional parameters
|
|
2387
|
+
# @option opts [TopUpDepositRequestDto] :top_up_deposit_request_dto
|
|
2388
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
2389
|
+
def top_up_deposit_with_http_info(opts = {})
|
|
2390
|
+
if @api_client.config.debugging
|
|
2391
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.top_up_deposit ...'
|
|
2392
|
+
end
|
|
2393
|
+
# resource path
|
|
2394
|
+
local_var_path = '/api/2.0/portal/payment/deposit'
|
|
2395
|
+
|
|
2396
|
+
# query parameters
|
|
2397
|
+
query_params = opts[:query_params] || {}
|
|
2398
|
+
|
|
2399
|
+
# header parameters
|
|
2400
|
+
header_params = opts[:header_params] || {}
|
|
2401
|
+
# HTTP header 'Accept' (if needed)
|
|
2402
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
2403
|
+
# HTTP header 'Content-Type'
|
|
2404
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2405
|
+
if !content_type.nil?
|
|
2406
|
+
header_params['Content-Type'] = content_type
|
|
2407
|
+
end
|
|
2408
|
+
|
|
2409
|
+
# form parameters
|
|
2410
|
+
form_params = opts[:form_params] || {}
|
|
2411
|
+
|
|
2412
|
+
# http body (model)
|
|
2413
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'top_up_deposit_request_dto'])
|
|
2414
|
+
|
|
2415
|
+
# return_type
|
|
2416
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
2417
|
+
|
|
2418
|
+
# auth_names
|
|
2419
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
2420
|
+
|
|
2421
|
+
new_options = opts.merge(
|
|
2422
|
+
:operation => :"Portal::PaymentApi.top_up_deposit",
|
|
2423
|
+
:header_params => header_params,
|
|
2424
|
+
:query_params => query_params,
|
|
2425
|
+
:form_params => form_params,
|
|
2426
|
+
:body => post_body,
|
|
2427
|
+
:auth_names => auth_names,
|
|
2428
|
+
:return_type => return_type
|
|
2429
|
+
)
|
|
2430
|
+
|
|
2431
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
2432
|
+
if @api_client.config.debugging
|
|
2433
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#top_up_deposit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2434
|
+
end
|
|
2435
|
+
return data, status_code, headers
|
|
2436
|
+
end
|
|
2437
|
+
|
|
2438
|
+
# Change the subscription quantity
|
|
2439
|
+
# Changes how many units of the plan the portal is paying for - the number of administrators it covers - and lets the payment provider bill the difference against the payment method already on file. The portal must have a billing customer and a plan bought through `PUT api/2.0/portal/payment/url`, and while the portal is on a priced plan the product name in `quantity` has to be that same plan, which `GET api/2.0/portal/payment/quota` reports, because a subscription is changed here and not swapped. Only the payer - the portal user whose e-mail is the billing customer's e-mail - may call it. The call is mutating and charges money, and it is guarded against a double submission: once the new quantity is in effect, repeating the same request fails with 400 because that quantity is already set. The result is `true` when the provider accepted the change and `false` when it declined it without an error. Exactly one product per call is accepted, the operation is limited to ten requests a minute per user by default and answers 429 above that, and wallet services are not bought here - use `PUT api/2.0/portal/payment/updatewallet` for those.
|
|
2440
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/update-payment/
|
|
2441
|
+
# @param [Hash] opts the optional parameters
|
|
2442
|
+
# @option opts [QuantityRequestDto] :quantity_request_dto
|
|
2443
|
+
# @return [BooleanWrapper]
|
|
2444
|
+
def update_payment(opts = {})
|
|
2445
|
+
data, _status_code, _headers = update_payment_with_http_info(opts)
|
|
2446
|
+
data
|
|
2447
|
+
end
|
|
2448
|
+
|
|
2449
|
+
# Change the subscription quantity
|
|
2450
|
+
# Changes how many units of the plan the portal is paying for - the number of administrators it covers - and lets the payment provider bill the difference against the payment method already on file. The portal must have a billing customer and a plan bought through `PUT api/2.0/portal/payment/url`, and while the portal is on a priced plan the product name in `quantity` has to be that same plan, which `GET api/2.0/portal/payment/quota` reports, because a subscription is changed here and not swapped. Only the payer - the portal user whose e-mail is the billing customer's e-mail - may call it. The call is mutating and charges money, and it is guarded against a double submission: once the new quantity is in effect, repeating the same request fails with 400 because that quantity is already set. The result is `true` when the provider accepted the change and `false` when it declined it without an error. Exactly one product per call is accepted, the operation is limited to ten requests a minute per user by default and answers 429 above that, and wallet services are not bought here - use `PUT api/2.0/portal/payment/updatewallet` for those.
|
|
2451
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/update-payment/
|
|
2452
|
+
# @param [Hash] opts the optional parameters
|
|
2453
|
+
# @option opts [QuantityRequestDto] :quantity_request_dto
|
|
2454
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
2455
|
+
def update_payment_with_http_info(opts = {})
|
|
2456
|
+
if @api_client.config.debugging
|
|
2457
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.update_payment ...'
|
|
2458
|
+
end
|
|
2459
|
+
# resource path
|
|
2460
|
+
local_var_path = '/api/2.0/portal/payment/update'
|
|
2461
|
+
|
|
2462
|
+
# query parameters
|
|
2463
|
+
query_params = opts[:query_params] || {}
|
|
2464
|
+
|
|
2465
|
+
# header parameters
|
|
2466
|
+
header_params = opts[:header_params] || {}
|
|
2467
|
+
# HTTP header 'Accept' (if needed)
|
|
2468
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
2469
|
+
# HTTP header 'Content-Type'
|
|
2470
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2471
|
+
if !content_type.nil?
|
|
2472
|
+
header_params['Content-Type'] = content_type
|
|
2473
|
+
end
|
|
2474
|
+
|
|
2475
|
+
# form parameters
|
|
2476
|
+
form_params = opts[:form_params] || {}
|
|
2477
|
+
|
|
2478
|
+
# http body (model)
|
|
2479
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'quantity_request_dto'])
|
|
2480
|
+
|
|
2481
|
+
# return_type
|
|
2482
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
2483
|
+
|
|
2484
|
+
# auth_names
|
|
2485
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
2486
|
+
|
|
2487
|
+
new_options = opts.merge(
|
|
2488
|
+
:operation => :"Portal::PaymentApi.update_payment",
|
|
2489
|
+
:header_params => header_params,
|
|
2490
|
+
:query_params => query_params,
|
|
2491
|
+
:form_params => form_params,
|
|
2492
|
+
:body => post_body,
|
|
2493
|
+
:auth_names => auth_names,
|
|
2494
|
+
:return_type => return_type
|
|
2495
|
+
)
|
|
2496
|
+
|
|
2497
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
2498
|
+
if @api_client.config.debugging
|
|
2499
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#update_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2500
|
+
end
|
|
2501
|
+
return data, status_code, headers
|
|
2502
|
+
end
|
|
2503
|
+
|
|
2504
|
+
# Change a wallet service quantity
|
|
2505
|
+
# Buys more units of a wallet service - extra administrators, disk storage, backup, AI tools, AI search or Docs Connect - or writes down the quantity that service will have after the next renewal, depending on `productQuantityType`. With `Add` (1) the units are bought at once and paid out of the portal wallet, so the wallet needs a sub-account in the accounting currency and enough money on it; with `Set` (0) nothing is charged now and the quantity only takes effect in the next period, where an empty or zero quantity cancels a change scheduled earlier. `Renew` and `Sub` are not accepted here. The portal needs a billing customer and the caller has to be a DocSpace administrator; a service that is an add-on to the plan also needs the plan itself to be paid, otherwise the answer is 402. Minimum quantities apply - disk storage starts at 100 units, the Docs Connect Dev Pack at 10, and the administrators may not be fewer than the portal already has - and in the `Add` form they are checked only while the portal does not hold that service yet. Asking for the Docs Connect plan in the `Set` form while Docs Connect Dev Pack is active schedules the reversion to it at the next period, while the upgrade in the other direction is not done here at all: use `POST api/2.0/settings/docscloud/switchtodevpack`. The result is `true` when the change was accepted; the call is mutating, spends money in its `Add` form and is limited to ten requests a minute per user by default. Price the same purchase without paying for it with `PUT api/2.0/portal/payment/calculatewallet`.
|
|
2506
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/update-wallet-payment/
|
|
2507
|
+
# @param [Hash] opts the optional parameters
|
|
2508
|
+
# @option opts [WalletQuantityRequestDto] :wallet_quantity_request_dto
|
|
2509
|
+
# @return [BooleanWrapper]
|
|
2510
|
+
def update_wallet_payment(opts = {})
|
|
2511
|
+
data, _status_code, _headers = update_wallet_payment_with_http_info(opts)
|
|
2512
|
+
data
|
|
2513
|
+
end
|
|
2514
|
+
|
|
2515
|
+
# Change a wallet service quantity
|
|
2516
|
+
# Buys more units of a wallet service - extra administrators, disk storage, backup, AI tools, AI search or Docs Connect - or writes down the quantity that service will have after the next renewal, depending on `productQuantityType`. With `Add` (1) the units are bought at once and paid out of the portal wallet, so the wallet needs a sub-account in the accounting currency and enough money on it; with `Set` (0) nothing is charged now and the quantity only takes effect in the next period, where an empty or zero quantity cancels a change scheduled earlier. `Renew` and `Sub` are not accepted here. The portal needs a billing customer and the caller has to be a DocSpace administrator; a service that is an add-on to the plan also needs the plan itself to be paid, otherwise the answer is 402. Minimum quantities apply - disk storage starts at 100 units, the Docs Connect Dev Pack at 10, and the administrators may not be fewer than the portal already has - and in the `Add` form they are checked only while the portal does not hold that service yet. Asking for the Docs Connect plan in the `Set` form while Docs Connect Dev Pack is active schedules the reversion to it at the next period, while the upgrade in the other direction is not done here at all: use `POST api/2.0/settings/docscloud/switchtodevpack`. The result is `true` when the change was accepted; the call is mutating, spends money in its `Add` form and is limited to ten requests a minute per user by default. Price the same purchase without paying for it with `PUT api/2.0/portal/payment/calculatewallet`.
|
|
2517
|
+
# See also: https://api.onlyoffice.com/docspace/api-backend/usage-api/update-wallet-payment/
|
|
2518
|
+
# @param [Hash] opts the optional parameters
|
|
2519
|
+
# @option opts [WalletQuantityRequestDto] :wallet_quantity_request_dto
|
|
2520
|
+
# @return [Array<(BooleanWrapper, Integer, Hash)>] BooleanWrapper data, response status code and response headers
|
|
2521
|
+
def update_wallet_payment_with_http_info(opts = {})
|
|
2522
|
+
if @api_client.config.debugging
|
|
2523
|
+
@api_client.config.logger.debug 'Calling API: Portal::PaymentApi.update_wallet_payment ...'
|
|
2524
|
+
end
|
|
2525
|
+
# resource path
|
|
2526
|
+
local_var_path = '/api/2.0/portal/payment/updatewallet'
|
|
2527
|
+
|
|
2528
|
+
# query parameters
|
|
2529
|
+
query_params = opts[:query_params] || {}
|
|
2530
|
+
|
|
2531
|
+
# header parameters
|
|
2532
|
+
header_params = opts[:header_params] || {}
|
|
2533
|
+
# HTTP header 'Accept' (if needed)
|
|
2534
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
2535
|
+
# HTTP header 'Content-Type'
|
|
2536
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2537
|
+
if !content_type.nil?
|
|
2538
|
+
header_params['Content-Type'] = content_type
|
|
2539
|
+
end
|
|
2540
|
+
|
|
2541
|
+
# form parameters
|
|
2542
|
+
form_params = opts[:form_params] || {}
|
|
2543
|
+
|
|
2544
|
+
# http body (model)
|
|
2545
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'wallet_quantity_request_dto'])
|
|
2546
|
+
|
|
2547
|
+
# return_type
|
|
2548
|
+
return_type = opts[:debug_return_type] || 'BooleanWrapper'
|
|
2549
|
+
|
|
2550
|
+
# auth_names
|
|
2551
|
+
auth_names = opts[:debug_auth_names] || ['Basic', 'OAuth2', 'ApiKeyBearer', 'asc_auth_key', 'Bearer', 'OpenId']
|
|
2552
|
+
|
|
2553
|
+
new_options = opts.merge(
|
|
2554
|
+
:operation => :"Portal::PaymentApi.update_wallet_payment",
|
|
2555
|
+
:header_params => header_params,
|
|
2556
|
+
:query_params => query_params,
|
|
2557
|
+
:form_params => form_params,
|
|
2558
|
+
:body => post_body,
|
|
2559
|
+
:auth_names => auth_names,
|
|
2560
|
+
:return_type => return_type
|
|
2561
|
+
)
|
|
2562
|
+
|
|
2563
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
2564
|
+
if @api_client.config.debugging
|
|
2565
|
+
@api_client.config.logger.debug "API called: Portal::PaymentApi#update_wallet_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2566
|
+
end
|
|
2567
|
+
return data, status_code, headers
|
|
2568
|
+
end
|
|
2569
|
+
end
|
|
2570
|
+
end
|
|
2571
|
+
end
|