openlayer 0.15.0 → 0.17.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 +4 -4
- data/CHANGELOG.md +35 -0
- data/README.md +1 -1
- data/lib/openlayer/client.rb +8 -0
- data/lib/openlayer/models/background_task_retrieve_params.rb +20 -0
- data/lib/openlayer/models/background_task_retrieve_response.rb +85 -0
- data/lib/openlayer/models/governance/framework_create_params.rb +143 -0
- data/lib/openlayer/models/governance/framework_create_response.rb +412 -0
- data/lib/openlayer/models/governance/framework_export_params.rb +36 -0
- data/lib/openlayer/models/governance/framework_export_response.rb +32 -0
- data/lib/openlayer/models/governance/framework_list_params.rb +148 -0
- data/lib/openlayer/models/governance/framework_list_project_rule_stats_params.rb +74 -0
- data/lib/openlayer/models/governance/framework_list_project_rule_stats_response.rb +279 -0
- data/lib/openlayer/models/governance/framework_list_projects_params.rb +39 -0
- data/lib/openlayer/models/governance/framework_list_projects_response.rb +315 -0
- data/lib/openlayer/models/governance/framework_list_response.rb +423 -0
- data/lib/openlayer/models/governance/framework_list_rules_params.rb +39 -0
- data/lib/openlayer/models/governance/framework_list_rules_response.rb +696 -0
- data/lib/openlayer/models/governance/framework_retrieve_params.rb +22 -0
- data/lib/openlayer/models/governance/framework_retrieve_response.rb +412 -0
- data/lib/openlayer/models/governance/framework_update_params.rb +200 -0
- data/lib/openlayer/models/governance/framework_update_response.rb +412 -0
- data/lib/openlayer/models/governance/frameworks/document_list_params.rb +41 -0
- data/lib/openlayer/models/governance/frameworks/document_list_response.rb +598 -0
- data/lib/openlayer/models/governance/frameworks/document_retrieve_params.rb +30 -0
- data/lib/openlayer/models/governance/frameworks/document_retrieve_response.rb +587 -0
- data/lib/openlayer/models/governance/frameworks/section_list_rules_params.rb +96 -0
- data/lib/openlayer/models/governance/frameworks/section_list_rules_response.rb +700 -0
- data/lib/openlayer/models/governance/frameworks/subsection_list_rules_params.rb +88 -0
- data/lib/openlayer/models/governance/frameworks/subsection_list_rules_response.rb +700 -0
- data/lib/openlayer/models/governance/rule_create_params.rb +173 -0
- data/lib/openlayer/models/governance/rule_create_response.rb +677 -0
- data/lib/openlayer/models/governance/rule_delete_params.rb +22 -0
- data/lib/openlayer/models/governance/rule_list_params.rb +231 -0
- data/lib/openlayer/models/governance/rule_list_response.rb +694 -0
- data/lib/openlayer/models/governance/rule_result_create_evidence_params.rb +69 -0
- data/lib/openlayer/models/governance/rule_result_create_evidence_response.rb +95 -0
- data/lib/openlayer/models/governance/rule_result_list_evidence_params.rb +39 -0
- data/lib/openlayer/models/governance/rule_result_list_evidence_response.rb +106 -0
- data/lib/openlayer/models/governance/rule_result_list_params.rb +149 -0
- data/lib/openlayer/models/governance/rule_result_list_response.rb +276 -0
- data/lib/openlayer/models/governance/rule_result_retrieve_params.rb +22 -0
- data/lib/openlayer/models/governance/rule_result_retrieve_response.rb +264 -0
- data/lib/openlayer/models/governance/rule_result_update_params.rb +156 -0
- data/lib/openlayer/models/governance/rule_result_update_response.rb +263 -0
- data/lib/openlayer/models/governance/rule_retrieve_params.rb +22 -0
- data/lib/openlayer/models/governance/rule_retrieve_response.rb +681 -0
- data/lib/openlayer/models/governance/rule_stat_retrieve_params.rb +39 -0
- data/lib/openlayer/models/governance/rule_stat_retrieve_response.rb +508 -0
- data/lib/openlayer/models/governance/rule_tag_list_params.rb +39 -0
- data/lib/openlayer/models/governance/rule_tag_list_response.rb +91 -0
- data/lib/openlayer/models/governance/rule_update_params.rb +78 -0
- data/lib/openlayer/models/governance/rule_update_response.rb +677 -0
- data/lib/openlayer/models/inference_pipeline_retrieve_response.rb +0 -1
- data/lib/openlayer/models/inference_pipeline_retrieve_sessions_response.rb +3 -0
- data/lib/openlayer/models/inference_pipeline_retrieve_users_response.rb +3 -0
- data/lib/openlayer/models/inference_pipeline_update_response.rb +0 -1
- data/lib/openlayer/models/project_create_response.rb +0 -1
- data/lib/openlayer/models/project_list_response.rb +0 -1
- data/lib/openlayer/models/project_update_response.rb +0 -1
- data/lib/openlayer/models/projects/inference_pipeline_create_params.rb +0 -1
- data/lib/openlayer/models/projects/inference_pipeline_create_response.rb +0 -1
- data/lib/openlayer/models/projects/inference_pipeline_list_response.rb +0 -1
- data/lib/openlayer/models/storage/presigned_url_retrieve_params.rb +28 -0
- data/lib/openlayer/models/storage/presigned_url_retrieve_response.rb +19 -0
- data/lib/openlayer/models/workspaces/api_key_create_params.rb +17 -1
- data/lib/openlayer/models/workspaces/api_key_create_response.rb +73 -3
- data/lib/openlayer/models/workspaces/api_key_delete_params.rb +28 -0
- data/lib/openlayer/models/workspaces/api_key_list_params.rb +22 -0
- data/lib/openlayer/models/workspaces/api_key_list_response.rb +134 -0
- data/lib/openlayer/models/workspaces/api_key_retrieve_params.rb +28 -0
- data/lib/openlayer/models/workspaces/api_key_retrieve_response.rb +131 -0
- data/lib/openlayer/models/workspaces/api_key_rotate_params.rb +56 -0
- data/lib/openlayer/models/workspaces/api_key_rotate_response.rb +131 -0
- data/lib/openlayer/models/workspaces/api_key_update_params.rb +38 -0
- data/lib/openlayer/models/workspaces/api_key_update_response.rb +131 -0
- data/lib/openlayer/models.rb +4 -0
- data/lib/openlayer/resources/background_tasks.rb +34 -0
- data/lib/openlayer/resources/commits.rb +1 -1
- data/lib/openlayer/resources/governance/frameworks/documents.rb +72 -0
- data/lib/openlayer/resources/governance/frameworks/sections.rb +68 -0
- data/lib/openlayer/resources/governance/frameworks/subsections.rb +65 -0
- data/lib/openlayer/resources/governance/frameworks.rb +292 -0
- data/lib/openlayer/resources/governance/rule_results.rb +187 -0
- data/lib/openlayer/resources/governance/rule_stats.rb +43 -0
- data/lib/openlayer/resources/governance/rule_tags.rb +43 -0
- data/lib/openlayer/resources/governance/rules.rb +210 -0
- data/lib/openlayer/resources/governance.rb +34 -0
- data/lib/openlayer/resources/inference_pipelines/rows.rb +4 -5
- data/lib/openlayer/resources/inference_pipelines.rb +5 -14
- data/lib/openlayer/resources/projects/tests.rb +3 -3
- data/lib/openlayer/resources/storage/presigned_url.rb +27 -1
- data/lib/openlayer/resources/tests.rb +1 -4
- data/lib/openlayer/resources/workspaces/api_keys.rb +146 -2
- data/lib/openlayer/resources/workspaces/invites.rb +1 -1
- data/lib/openlayer/resources/workspaces.rb +1 -1
- data/lib/openlayer/version.rb +1 -1
- data/lib/openlayer.rb +70 -0
- data/rbi/openlayer/client.rbi +6 -0
- data/rbi/openlayer/models/background_task_retrieve_params.rbi +38 -0
- data/rbi/openlayer/models/background_task_retrieve_response.rbi +105 -0
- data/rbi/openlayer/models/governance/framework_create_params.rbi +298 -0
- data/rbi/openlayer/models/governance/framework_create_response.rbi +735 -0
- data/rbi/openlayer/models/governance/framework_export_params.rbi +58 -0
- data/rbi/openlayer/models/governance/framework_export_response.rbi +48 -0
- data/rbi/openlayer/models/governance/framework_list_params.rbi +310 -0
- data/rbi/openlayer/models/governance/framework_list_project_rule_stats_params.rbi +178 -0
- data/rbi/openlayer/models/governance/framework_list_project_rule_stats_response.rbi +441 -0
- data/rbi/openlayer/models/governance/framework_list_projects_params.rbi +68 -0
- data/rbi/openlayer/models/governance/framework_list_projects_response.rbi +498 -0
- data/rbi/openlayer/models/governance/framework_list_response.rbi +776 -0
- data/rbi/openlayer/models/governance/framework_list_rules_params.rbi +68 -0
- data/rbi/openlayer/models/governance/framework_list_rules_response.rbi +1334 -0
- data/rbi/openlayer/models/governance/framework_retrieve_params.rbi +40 -0
- data/rbi/openlayer/models/governance/framework_retrieve_response.rbi +735 -0
- data/rbi/openlayer/models/governance/framework_update_params.rbi +425 -0
- data/rbi/openlayer/models/governance/framework_update_response.rbi +735 -0
- data/rbi/openlayer/models/governance/frameworks/document_list_params.rbi +70 -0
- data/rbi/openlayer/models/governance/frameworks/document_list_response.rbi +1050 -0
- data/rbi/openlayer/models/governance/frameworks/document_retrieve_params.rbi +50 -0
- data/rbi/openlayer/models/governance/frameworks/document_retrieve_response.rbi +1006 -0
- data/rbi/openlayer/models/governance/frameworks/section_list_rules_params.rbi +193 -0
- data/rbi/openlayer/models/governance/frameworks/section_list_rules_response.rbi +1338 -0
- data/rbi/openlayer/models/governance/frameworks/subsection_list_rules_params.rbi +182 -0
- data/rbi/openlayer/models/governance/frameworks/subsection_list_rules_response.rbi +1338 -0
- data/rbi/openlayer/models/governance/rule_create_params.rbi +291 -0
- data/rbi/openlayer/models/governance/rule_create_response.rbi +1289 -0
- data/rbi/openlayer/models/governance/rule_delete_params.rbi +40 -0
- data/rbi/openlayer/models/governance/rule_list_params.rbi +486 -0
- data/rbi/openlayer/models/governance/rule_list_response.rbi +1330 -0
- data/rbi/openlayer/models/governance/rule_result_create_evidence_params.rbi +90 -0
- data/rbi/openlayer/models/governance/rule_result_create_evidence_response.rbi +113 -0
- data/rbi/openlayer/models/governance/rule_result_list_evidence_params.rbi +68 -0
- data/rbi/openlayer/models/governance/rule_result_list_evidence_response.rbi +156 -0
- data/rbi/openlayer/models/governance/rule_result_list_params.rbi +322 -0
- data/rbi/openlayer/models/governance/rule_result_list_response.rbi +580 -0
- data/rbi/openlayer/models/governance/rule_result_retrieve_params.rbi +43 -0
- data/rbi/openlayer/models/governance/rule_result_retrieve_response.rbi +537 -0
- data/rbi/openlayer/models/governance/rule_result_update_params.rbi +381 -0
- data/rbi/openlayer/models/governance/rule_result_update_response.rbi +537 -0
- data/rbi/openlayer/models/governance/rule_retrieve_params.rbi +40 -0
- data/rbi/openlayer/models/governance/rule_retrieve_response.rbi +1289 -0
- data/rbi/openlayer/models/governance/rule_stat_retrieve_params.rbi +68 -0
- data/rbi/openlayer/models/governance/rule_stat_retrieve_response.rbi +877 -0
- data/rbi/openlayer/models/governance/rule_tag_list_params.rbi +68 -0
- data/rbi/openlayer/models/governance/rule_tag_list_response.rbi +141 -0
- data/rbi/openlayer/models/governance/rule_update_params.rbi +108 -0
- data/rbi/openlayer/models/governance/rule_update_response.rbi +1289 -0
- data/rbi/openlayer/models/inference_pipeline_retrieve_response.rbi +0 -5
- data/rbi/openlayer/models/inference_pipeline_retrieve_sessions_response.rbi +2 -0
- data/rbi/openlayer/models/inference_pipeline_retrieve_users_response.rbi +2 -0
- data/rbi/openlayer/models/inference_pipeline_update_response.rbi +0 -5
- data/rbi/openlayer/models/project_create_response.rbi +0 -5
- data/rbi/openlayer/models/project_list_response.rbi +0 -5
- data/rbi/openlayer/models/project_update_response.rbi +0 -5
- data/rbi/openlayer/models/projects/inference_pipeline_create_params.rbi +0 -5
- data/rbi/openlayer/models/projects/inference_pipeline_create_response.rbi +0 -5
- data/rbi/openlayer/models/projects/inference_pipeline_list_response.rbi +0 -5
- data/rbi/openlayer/models/storage/presigned_url_retrieve_params.rbi +47 -0
- data/rbi/openlayer/models/storage/presigned_url_retrieve_response.rbi +32 -0
- data/rbi/openlayer/models/workspaces/api_key_create_params.rbi +18 -0
- data/rbi/openlayer/models/workspaces/api_key_create_response.rbi +117 -5
- data/rbi/openlayer/models/workspaces/api_key_delete_params.rbi +48 -0
- data/rbi/openlayer/models/workspaces/api_key_list_params.rbi +40 -0
- data/rbi/openlayer/models/workspaces/api_key_list_response.rbi +202 -0
- data/rbi/openlayer/models/workspaces/api_key_retrieve_params.rbi +48 -0
- data/rbi/openlayer/models/workspaces/api_key_retrieve_response.rbi +194 -0
- data/rbi/openlayer/models/workspaces/api_key_rotate_params.rbi +85 -0
- data/rbi/openlayer/models/workspaces/api_key_rotate_response.rbi +194 -0
- data/rbi/openlayer/models/workspaces/api_key_update_params.rbi +60 -0
- data/rbi/openlayer/models/workspaces/api_key_update_response.rbi +194 -0
- data/rbi/openlayer/models.rbi +4 -0
- data/rbi/openlayer/resources/background_tasks.rbi +26 -0
- data/rbi/openlayer/resources/commits.rbi +1 -1
- data/rbi/openlayer/resources/governance/frameworks/documents.rbi +57 -0
- data/rbi/openlayer/resources/governance/frameworks/sections.rbi +56 -0
- data/rbi/openlayer/resources/governance/frameworks/subsections.rbi +52 -0
- data/rbi/openlayer/resources/governance/frameworks.rbi +261 -0
- data/rbi/openlayer/resources/governance/rule_results.rbi +167 -0
- data/rbi/openlayer/resources/governance/rule_stats.rbi +34 -0
- data/rbi/openlayer/resources/governance/rule_tags.rbi +34 -0
- data/rbi/openlayer/resources/governance/rules.rbi +209 -0
- data/rbi/openlayer/resources/governance.rbi +27 -0
- data/rbi/openlayer/resources/inference_pipelines/rows.rbi +4 -5
- data/rbi/openlayer/resources/inference_pipelines.rbi +5 -14
- data/rbi/openlayer/resources/projects/tests.rbi +3 -3
- data/rbi/openlayer/resources/storage/presigned_url.rbi +16 -1
- data/rbi/openlayer/resources/tests.rbi +1 -4
- data/rbi/openlayer/resources/workspaces/api_keys.rbi +110 -1
- data/rbi/openlayer/resources/workspaces/invites.rbi +1 -1
- data/rbi/openlayer/resources/workspaces.rbi +1 -1
- data/sig/openlayer/client.rbs +4 -0
- data/sig/openlayer/models/background_task_retrieve_params.rbs +23 -0
- data/sig/openlayer/models/background_task_retrieve_response.rbs +55 -0
- data/sig/openlayer/models/governance/framework_create_params.rbs +124 -0
- data/sig/openlayer/models/governance/framework_create_response.rbs +293 -0
- data/sig/openlayer/models/governance/framework_export_params.rbs +30 -0
- data/sig/openlayer/models/governance/framework_export_response.rbs +21 -0
- data/sig/openlayer/models/governance/framework_list_params.rbs +145 -0
- data/sig/openlayer/models/governance/framework_list_project_rule_stats_params.rbs +87 -0
- data/sig/openlayer/models/governance/framework_list_project_rule_stats_response.rbs +232 -0
- data/sig/openlayer/models/governance/framework_list_projects_params.rbs +38 -0
- data/sig/openlayer/models/governance/framework_list_projects_response.rbs +248 -0
- data/sig/openlayer/models/governance/framework_list_response.rbs +314 -0
- data/sig/openlayer/models/governance/framework_list_rules_params.rbs +38 -0
- data/sig/openlayer/models/governance/framework_list_rules_response.rbs +547 -0
- data/sig/openlayer/models/governance/framework_retrieve_params.rbs +25 -0
- data/sig/openlayer/models/governance/framework_retrieve_response.rbs +293 -0
- data/sig/openlayer/models/governance/framework_update_params.rbs +175 -0
- data/sig/openlayer/models/governance/framework_update_response.rbs +293 -0
- data/sig/openlayer/models/governance/frameworks/document_list_params.rbs +40 -0
- data/sig/openlayer/models/governance/frameworks/document_list_response.rbs +435 -0
- data/sig/openlayer/models/governance/frameworks/document_retrieve_params.rbs +32 -0
- data/sig/openlayer/models/governance/frameworks/document_retrieve_response.rbs +418 -0
- data/sig/openlayer/models/governance/frameworks/section_list_rules_params.rbs +102 -0
- data/sig/openlayer/models/governance/frameworks/section_list_rules_response.rbs +549 -0
- data/sig/openlayer/models/governance/frameworks/subsection_list_rules_params.rbs +95 -0
- data/sig/openlayer/models/governance/frameworks/subsection_list_rules_response.rbs +549 -0
- data/sig/openlayer/models/governance/rule_create_params.rbs +120 -0
- data/sig/openlayer/models/governance/rule_create_response.rbs +530 -0
- data/sig/openlayer/models/governance/rule_delete_params.rbs +25 -0
- data/sig/openlayer/models/governance/rule_list_params.rbs +228 -0
- data/sig/openlayer/models/governance/rule_list_response.rbs +547 -0
- data/sig/openlayer/models/governance/rule_result_create_evidence_params.rbs +53 -0
- data/sig/openlayer/models/governance/rule_result_create_evidence_response.rbs +62 -0
- data/sig/openlayer/models/governance/rule_result_list_evidence_params.rbs +38 -0
- data/sig/openlayer/models/governance/rule_result_list_evidence_response.rbs +79 -0
- data/sig/openlayer/models/governance/rule_result_list_params.rbs +156 -0
- data/sig/openlayer/models/governance/rule_result_list_response.rbs +252 -0
- data/sig/openlayer/models/governance/rule_result_retrieve_params.rbs +26 -0
- data/sig/openlayer/models/governance/rule_result_retrieve_response.rbs +235 -0
- data/sig/openlayer/models/governance/rule_result_update_params.rbs +165 -0
- data/sig/openlayer/models/governance/rule_result_update_response.rbs +235 -0
- data/sig/openlayer/models/governance/rule_retrieve_params.rbs +25 -0
- data/sig/openlayer/models/governance/rule_retrieve_response.rbs +530 -0
- data/sig/openlayer/models/governance/rule_stat_retrieve_params.rbs +38 -0
- data/sig/openlayer/models/governance/rule_stat_retrieve_response.rbs +434 -0
- data/sig/openlayer/models/governance/rule_tag_list_params.rbs +38 -0
- data/sig/openlayer/models/governance/rule_tag_list_response.rbs +74 -0
- data/sig/openlayer/models/governance/rule_update_params.rbs +62 -0
- data/sig/openlayer/models/governance/rule_update_response.rbs +530 -0
- data/sig/openlayer/models/inference_pipeline_retrieve_response.rbs +1 -2
- data/sig/openlayer/models/inference_pipeline_update_response.rbs +1 -2
- data/sig/openlayer/models/project_create_response.rbs +1 -2
- data/sig/openlayer/models/project_list_response.rbs +1 -2
- data/sig/openlayer/models/project_update_response.rbs +1 -2
- data/sig/openlayer/models/projects/inference_pipeline_create_params.rbs +1 -2
- data/sig/openlayer/models/projects/inference_pipeline_create_response.rbs +1 -2
- data/sig/openlayer/models/projects/inference_pipeline_list_response.rbs +1 -2
- data/sig/openlayer/models/storage/presigned_url_retrieve_params.rbs +25 -0
- data/sig/openlayer/models/storage/presigned_url_retrieve_response.rbs +15 -0
- data/sig/openlayer/models/workspaces/api_key_create_params.rbs +5 -1
- data/sig/openlayer/models/workspaces/api_key_create_response.rbs +42 -3
- data/sig/openlayer/models/workspaces/api_key_delete_params.rbs +30 -0
- data/sig/openlayer/models/workspaces/api_key_list_params.rbs +25 -0
- data/sig/openlayer/models/workspaces/api_key_list_response.rbs +91 -0
- data/sig/openlayer/models/workspaces/api_key_retrieve_params.rbs +30 -0
- data/sig/openlayer/models/workspaces/api_key_retrieve_response.rbs +86 -0
- data/sig/openlayer/models/workspaces/api_key_rotate_params.rbs +45 -0
- data/sig/openlayer/models/workspaces/api_key_rotate_response.rbs +86 -0
- data/sig/openlayer/models/workspaces/api_key_update_params.rbs +34 -0
- data/sig/openlayer/models/workspaces/api_key_update_response.rbs +86 -0
- data/sig/openlayer/models.rbs +4 -0
- data/sig/openlayer/resources/background_tasks.rbs +12 -0
- data/sig/openlayer/resources/governance/frameworks/documents.rbs +24 -0
- data/sig/openlayer/resources/governance/frameworks/sections.rbs +23 -0
- data/sig/openlayer/resources/governance/frameworks/subsections.rbs +22 -0
- data/sig/openlayer/resources/governance/frameworks.rbs +88 -0
- data/sig/openlayer/resources/governance/rule_results.rbs +57 -0
- data/sig/openlayer/resources/governance/rule_stats.rbs +16 -0
- data/sig/openlayer/resources/governance/rule_tags.rbs +16 -0
- data/sig/openlayer/resources/governance/rules.rbs +68 -0
- data/sig/openlayer/resources/governance.rbs +17 -0
- data/sig/openlayer/resources/storage/presigned_url.rbs +5 -0
- data/sig/openlayer/resources/workspaces/api_keys.rbs +33 -0
- metadata +212 -2
|
@@ -58,6 +58,9 @@ module Openlayer
|
|
|
58
58
|
required :tokens, Float
|
|
59
59
|
|
|
60
60
|
# @!method initialize(id:, cost:, date_of_first_record:, date_of_last_record:, records:, sessions:, tokens:)
|
|
61
|
+
# A user who has interacted with an inference pipeline, with their activity stats:
|
|
62
|
+
# session and record counts, token usage, and cost.
|
|
63
|
+
#
|
|
61
64
|
# @param id [String] The unique user identifier
|
|
62
65
|
#
|
|
63
66
|
# @param cost [Float] Total cost for this user
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Openlayer
|
|
4
|
+
module Models
|
|
5
|
+
module Storage
|
|
6
|
+
# @see Openlayer::Resources::Storage::PresignedURL#retrieve
|
|
7
|
+
class PresignedURLRetrieveParams < Openlayer::Internal::Type::BaseModel
|
|
8
|
+
extend Openlayer::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Openlayer::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute storage_uri
|
|
12
|
+
# The object's storage uri, for example `outputs.storageUri` from a framework
|
|
13
|
+
# export's background task.
|
|
14
|
+
#
|
|
15
|
+
# @return [String]
|
|
16
|
+
required :storage_uri, String
|
|
17
|
+
|
|
18
|
+
# @!method initialize(storage_uri:, request_options: {})
|
|
19
|
+
# Some parameter documentations has been truncated, see
|
|
20
|
+
# {Openlayer::Models::Storage::PresignedURLRetrieveParams} for more details.
|
|
21
|
+
#
|
|
22
|
+
# @param storage_uri [String] The object's storage uri, for example `outputs.storageUri` from a framework expo
|
|
23
|
+
#
|
|
24
|
+
# @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Openlayer
|
|
4
|
+
module Models
|
|
5
|
+
module Storage
|
|
6
|
+
# @see Openlayer::Resources::Storage::PresignedURL#retrieve
|
|
7
|
+
class PresignedURLRetrieveResponse < Openlayer::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute url
|
|
9
|
+
# The presigned url. Short-lived -- download promptly.
|
|
10
|
+
#
|
|
11
|
+
# @return [String]
|
|
12
|
+
required :url, String
|
|
13
|
+
|
|
14
|
+
# @!method initialize(url:)
|
|
15
|
+
# @param url [String] The presigned url. Short-lived -- download promptly.
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|
|
19
|
+
end
|
|
@@ -13,15 +13,31 @@ module Openlayer
|
|
|
13
13
|
# @return [String]
|
|
14
14
|
required :workspace_id, String
|
|
15
15
|
|
|
16
|
+
# @!attribute expires_at
|
|
17
|
+
# When the key stops authenticating. `null` means the key never expires. Set when
|
|
18
|
+
# the key is created or rotated, and must be in the future. When the request is
|
|
19
|
+
# authenticated with an API key that expires, the result can't be later than that
|
|
20
|
+
# key's expiry. On create, omit it to inherit that expiry. On rotate, omit it to
|
|
21
|
+
# keep the current one. It can't be changed with an update; rotate the key
|
|
22
|
+
# instead.
|
|
23
|
+
#
|
|
24
|
+
# @return [Time, nil]
|
|
25
|
+
optional :expires_at, Time, api_name: :expiresAt, nil?: true
|
|
26
|
+
|
|
16
27
|
# @!attribute name
|
|
17
28
|
# The API key name.
|
|
18
29
|
#
|
|
19
30
|
# @return [String, nil]
|
|
20
31
|
optional :name, String, nil?: true
|
|
21
32
|
|
|
22
|
-
# @!method initialize(workspace_id:, name: nil, request_options: {})
|
|
33
|
+
# @!method initialize(workspace_id:, expires_at: nil, name: nil, request_options: {})
|
|
34
|
+
# Some parameter documentations has been truncated, see
|
|
35
|
+
# {Openlayer::Models::Workspaces::APIKeyCreateParams} for more details.
|
|
36
|
+
#
|
|
23
37
|
# @param workspace_id [String]
|
|
24
38
|
#
|
|
39
|
+
# @param expires_at [Time, nil] When the key stops authenticating. `null` means the key never expires. Set when
|
|
40
|
+
#
|
|
25
41
|
# @param name [String, nil] The API key name.
|
|
26
42
|
#
|
|
27
43
|
# @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -5,6 +5,17 @@ module Openlayer
|
|
|
5
5
|
module Workspaces
|
|
6
6
|
# @see Openlayer::Resources::Workspaces::APIKeys#create
|
|
7
7
|
class APIKeyCreateResponse < Openlayer::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute expires_at
|
|
9
|
+
# When the key stops authenticating. `null` means the key never expires. Set when
|
|
10
|
+
# the key is created or rotated, and must be in the future. When the request is
|
|
11
|
+
# authenticated with an API key that expires, the result can't be later than that
|
|
12
|
+
# key's expiry. On create, omit it to inherit that expiry. On rotate, omit it to
|
|
13
|
+
# keep the current one. It can't be changed with an update; rotate the key
|
|
14
|
+
# instead.
|
|
15
|
+
#
|
|
16
|
+
# @return [Time, nil]
|
|
17
|
+
optional :expires_at, Time, api_name: :expiresAt, nil?: true
|
|
18
|
+
|
|
8
19
|
# @!attribute name
|
|
9
20
|
# The API key name.
|
|
10
21
|
#
|
|
@@ -37,13 +48,45 @@ module Openlayer
|
|
|
37
48
|
required :date_updated, Time, api_name: :dateUpdated
|
|
38
49
|
|
|
39
50
|
# @!attribute secure_key
|
|
40
|
-
#
|
|
51
|
+
# An obfuscated hint of the API key value. When a key is created or rotated this
|
|
52
|
+
# also holds the full secret, for backward compatibility; prefer `secret`.
|
|
41
53
|
#
|
|
42
54
|
# @return [String]
|
|
43
55
|
required :secure_key, String, api_name: :secureKey
|
|
56
|
+
|
|
57
|
+
# @!attribute status
|
|
58
|
+
# The key's lifecycle state. `active`: the current secret authenticates.
|
|
59
|
+
# `rotating`: the key was rotated and the previous secret still authenticates
|
|
60
|
+
# until `previousKeyExpiresAt`. `expired`: `expiresAt` has passed, no secret
|
|
61
|
+
# authenticates, and the key can't be rotated.
|
|
62
|
+
#
|
|
63
|
+
# @return [Symbol, Openlayer::Models::Workspaces::APIKeyCreateResponse::Status]
|
|
64
|
+
required :status, enum: -> { Openlayer::Models::Workspaces::APIKeyCreateResponse::Status }
|
|
65
|
+
|
|
66
|
+
# @!attribute last_rotated_at
|
|
67
|
+
# When the key was last rotated.
|
|
68
|
+
#
|
|
69
|
+
# @return [Time, nil]
|
|
70
|
+
optional :last_rotated_at, Time, api_name: :lastRotatedAt, nil?: true
|
|
71
|
+
|
|
72
|
+
# @!attribute previous_key_expires_at
|
|
73
|
+
# While `status` is `rotating`, when the previous secret stops authenticating.
|
|
74
|
+
#
|
|
75
|
+
# @return [Time, nil]
|
|
76
|
+
optional :previous_key_expires_at, Time, api_name: :previousKeyExpiresAt, nil?: true
|
|
77
|
+
|
|
78
|
+
# @!attribute secret
|
|
79
|
+
# The full API key. Only present in the response that creates or rotates the key,
|
|
80
|
+
# and never shown again.
|
|
81
|
+
#
|
|
82
|
+
# @return [String, nil]
|
|
83
|
+
optional :secret, String
|
|
44
84
|
end
|
|
45
85
|
|
|
46
|
-
# @!method initialize(id:, date_created:, date_last_used:, date_updated:, secure_key:, name: nil)
|
|
86
|
+
# @!method initialize(id:, date_created:, date_last_used:, date_updated:, secure_key:, status:, expires_at: nil, last_rotated_at: nil, name: nil, previous_key_expires_at: nil, secret: nil)
|
|
87
|
+
# Some parameter documentations has been truncated, see
|
|
88
|
+
# {Openlayer::Models::Workspaces::APIKeyCreateResponse} for more details.
|
|
89
|
+
#
|
|
47
90
|
# @param id [String] The API key id.
|
|
48
91
|
#
|
|
49
92
|
# @param date_created [Time] The API key creation date.
|
|
@@ -52,9 +95,36 @@ module Openlayer
|
|
|
52
95
|
#
|
|
53
96
|
# @param date_updated [Time] The API key last update date.
|
|
54
97
|
#
|
|
55
|
-
# @param secure_key [String]
|
|
98
|
+
# @param secure_key [String] An obfuscated hint of the API key value. When a key is created or rotated this a
|
|
99
|
+
#
|
|
100
|
+
# @param status [Symbol, Openlayer::Models::Workspaces::APIKeyCreateResponse::Status] The key's lifecycle state. `active`: the current secret authenticates. `rotating
|
|
101
|
+
#
|
|
102
|
+
# @param expires_at [Time, nil] When the key stops authenticating. `null` means the key never expires. Set when
|
|
103
|
+
#
|
|
104
|
+
# @param last_rotated_at [Time, nil] When the key was last rotated.
|
|
56
105
|
#
|
|
57
106
|
# @param name [String, nil] The API key name.
|
|
107
|
+
#
|
|
108
|
+
# @param previous_key_expires_at [Time, nil] While `status` is `rotating`, when the previous secret stops authenticating.
|
|
109
|
+
#
|
|
110
|
+
# @param secret [String] The full API key. Only present in the response that creates or rotates the key,
|
|
111
|
+
|
|
112
|
+
# The key's lifecycle state. `active`: the current secret authenticates.
|
|
113
|
+
# `rotating`: the key was rotated and the previous secret still authenticates
|
|
114
|
+
# until `previousKeyExpiresAt`. `expired`: `expiresAt` has passed, no secret
|
|
115
|
+
# authenticates, and the key can't be rotated.
|
|
116
|
+
#
|
|
117
|
+
# @see Openlayer::Models::Workspaces::APIKeyCreateResponse#status
|
|
118
|
+
module Status
|
|
119
|
+
extend Openlayer::Internal::Type::Enum
|
|
120
|
+
|
|
121
|
+
ACTIVE = :active
|
|
122
|
+
ROTATING = :rotating
|
|
123
|
+
EXPIRED = :expired
|
|
124
|
+
|
|
125
|
+
# @!method self.values
|
|
126
|
+
# @return [Array<Symbol>]
|
|
127
|
+
end
|
|
58
128
|
end
|
|
59
129
|
end
|
|
60
130
|
end
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Openlayer
|
|
4
|
+
module Models
|
|
5
|
+
module Workspaces
|
|
6
|
+
# @see Openlayer::Resources::Workspaces::APIKeys#delete
|
|
7
|
+
class APIKeyDeleteParams < Openlayer::Internal::Type::BaseModel
|
|
8
|
+
extend Openlayer::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Openlayer::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute workspace_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :workspace_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute api_key_id
|
|
17
|
+
#
|
|
18
|
+
# @return [String]
|
|
19
|
+
required :api_key_id, String
|
|
20
|
+
|
|
21
|
+
# @!method initialize(workspace_id:, api_key_id:, request_options: {})
|
|
22
|
+
# @param workspace_id [String]
|
|
23
|
+
# @param api_key_id [String]
|
|
24
|
+
# @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Openlayer
|
|
4
|
+
module Models
|
|
5
|
+
module Workspaces
|
|
6
|
+
# @see Openlayer::Resources::Workspaces::APIKeys#list
|
|
7
|
+
class APIKeyListParams < Openlayer::Internal::Type::BaseModel
|
|
8
|
+
extend Openlayer::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Openlayer::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute workspace_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :workspace_id, String
|
|
15
|
+
|
|
16
|
+
# @!method initialize(workspace_id:, request_options: {})
|
|
17
|
+
# @param workspace_id [String]
|
|
18
|
+
# @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Openlayer
|
|
4
|
+
module Models
|
|
5
|
+
module Workspaces
|
|
6
|
+
class APIKeyListResponseItem < Openlayer::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute expires_at
|
|
8
|
+
# When the key stops authenticating. `null` means the key never expires. Set when
|
|
9
|
+
# the key is created or rotated, and must be in the future. When the request is
|
|
10
|
+
# authenticated with an API key that expires, the result can't be later than that
|
|
11
|
+
# key's expiry. On create, omit it to inherit that expiry. On rotate, omit it to
|
|
12
|
+
# keep the current one. It can't be changed with an update; rotate the key
|
|
13
|
+
# instead.
|
|
14
|
+
#
|
|
15
|
+
# @return [Time, nil]
|
|
16
|
+
optional :expires_at, Time, api_name: :expiresAt, nil?: true
|
|
17
|
+
|
|
18
|
+
# @!attribute name
|
|
19
|
+
# The API key name.
|
|
20
|
+
#
|
|
21
|
+
# @return [String, nil]
|
|
22
|
+
optional :name, String, nil?: true
|
|
23
|
+
|
|
24
|
+
response_only do
|
|
25
|
+
# @!attribute id
|
|
26
|
+
# The API key id.
|
|
27
|
+
#
|
|
28
|
+
# @return [String]
|
|
29
|
+
required :id, String
|
|
30
|
+
|
|
31
|
+
# @!attribute date_created
|
|
32
|
+
# The API key creation date.
|
|
33
|
+
#
|
|
34
|
+
# @return [Time]
|
|
35
|
+
required :date_created, Time, api_name: :dateCreated
|
|
36
|
+
|
|
37
|
+
# @!attribute date_last_used
|
|
38
|
+
# The API key last use date.
|
|
39
|
+
#
|
|
40
|
+
# @return [Time, nil]
|
|
41
|
+
required :date_last_used, Time, api_name: :dateLastUsed, nil?: true
|
|
42
|
+
|
|
43
|
+
# @!attribute date_updated
|
|
44
|
+
# The API key last update date.
|
|
45
|
+
#
|
|
46
|
+
# @return [Time]
|
|
47
|
+
required :date_updated, Time, api_name: :dateUpdated
|
|
48
|
+
|
|
49
|
+
# @!attribute secure_key
|
|
50
|
+
# An obfuscated hint of the API key value. When a key is created or rotated this
|
|
51
|
+
# also holds the full secret, for backward compatibility; prefer `secret`.
|
|
52
|
+
#
|
|
53
|
+
# @return [String]
|
|
54
|
+
required :secure_key, String, api_name: :secureKey
|
|
55
|
+
|
|
56
|
+
# @!attribute status
|
|
57
|
+
# The key's lifecycle state. `active`: the current secret authenticates.
|
|
58
|
+
# `rotating`: the key was rotated and the previous secret still authenticates
|
|
59
|
+
# until `previousKeyExpiresAt`. `expired`: `expiresAt` has passed, no secret
|
|
60
|
+
# authenticates, and the key can't be rotated.
|
|
61
|
+
#
|
|
62
|
+
# @return [Symbol, Openlayer::Models::Workspaces::APIKeyListResponseItem::Status]
|
|
63
|
+
required :status, enum: -> { Openlayer::Models::Workspaces::APIKeyListResponseItem::Status }
|
|
64
|
+
|
|
65
|
+
# @!attribute last_rotated_at
|
|
66
|
+
# When the key was last rotated.
|
|
67
|
+
#
|
|
68
|
+
# @return [Time, nil]
|
|
69
|
+
optional :last_rotated_at, Time, api_name: :lastRotatedAt, nil?: true
|
|
70
|
+
|
|
71
|
+
# @!attribute previous_key_expires_at
|
|
72
|
+
# While `status` is `rotating`, when the previous secret stops authenticating.
|
|
73
|
+
#
|
|
74
|
+
# @return [Time, nil]
|
|
75
|
+
optional :previous_key_expires_at, Time, api_name: :previousKeyExpiresAt, nil?: true
|
|
76
|
+
|
|
77
|
+
# @!attribute secret
|
|
78
|
+
# The full API key. Only present in the response that creates or rotates the key,
|
|
79
|
+
# and never shown again.
|
|
80
|
+
#
|
|
81
|
+
# @return [String, nil]
|
|
82
|
+
optional :secret, String
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
# @!method initialize(id:, date_created:, date_last_used:, date_updated:, secure_key:, status:, expires_at: nil, last_rotated_at: nil, name: nil, previous_key_expires_at: nil, secret: nil)
|
|
86
|
+
# Some parameter documentations has been truncated, see
|
|
87
|
+
# {Openlayer::Models::Workspaces::APIKeyListResponseItem} for more details.
|
|
88
|
+
#
|
|
89
|
+
# @param id [String] The API key id.
|
|
90
|
+
#
|
|
91
|
+
# @param date_created [Time] The API key creation date.
|
|
92
|
+
#
|
|
93
|
+
# @param date_last_used [Time, nil] The API key last use date.
|
|
94
|
+
#
|
|
95
|
+
# @param date_updated [Time] The API key last update date.
|
|
96
|
+
#
|
|
97
|
+
# @param secure_key [String] An obfuscated hint of the API key value. When a key is created or rotated this a
|
|
98
|
+
#
|
|
99
|
+
# @param status [Symbol, Openlayer::Models::Workspaces::APIKeyListResponseItem::Status] The key's lifecycle state. `active`: the current secret authenticates. `rotating
|
|
100
|
+
#
|
|
101
|
+
# @param expires_at [Time, nil] When the key stops authenticating. `null` means the key never expires. Set when
|
|
102
|
+
#
|
|
103
|
+
# @param last_rotated_at [Time, nil] When the key was last rotated.
|
|
104
|
+
#
|
|
105
|
+
# @param name [String, nil] The API key name.
|
|
106
|
+
#
|
|
107
|
+
# @param previous_key_expires_at [Time, nil] While `status` is `rotating`, when the previous secret stops authenticating.
|
|
108
|
+
#
|
|
109
|
+
# @param secret [String] The full API key. Only present in the response that creates or rotates the key,
|
|
110
|
+
|
|
111
|
+
# The key's lifecycle state. `active`: the current secret authenticates.
|
|
112
|
+
# `rotating`: the key was rotated and the previous secret still authenticates
|
|
113
|
+
# until `previousKeyExpiresAt`. `expired`: `expiresAt` has passed, no secret
|
|
114
|
+
# authenticates, and the key can't be rotated.
|
|
115
|
+
#
|
|
116
|
+
# @see Openlayer::Models::Workspaces::APIKeyListResponseItem#status
|
|
117
|
+
module Status
|
|
118
|
+
extend Openlayer::Internal::Type::Enum
|
|
119
|
+
|
|
120
|
+
ACTIVE = :active
|
|
121
|
+
ROTATING = :rotating
|
|
122
|
+
EXPIRED = :expired
|
|
123
|
+
|
|
124
|
+
# @!method self.values
|
|
125
|
+
# @return [Array<Symbol>]
|
|
126
|
+
end
|
|
127
|
+
end
|
|
128
|
+
|
|
129
|
+
# @type [Openlayer::Internal::Type::Converter]
|
|
130
|
+
APIKeyListResponse =
|
|
131
|
+
Openlayer::Internal::Type::ArrayOf[-> { Openlayer::Models::Workspaces::APIKeyListResponseItem }]
|
|
132
|
+
end
|
|
133
|
+
end
|
|
134
|
+
end
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Openlayer
|
|
4
|
+
module Models
|
|
5
|
+
module Workspaces
|
|
6
|
+
# @see Openlayer::Resources::Workspaces::APIKeys#retrieve
|
|
7
|
+
class APIKeyRetrieveParams < Openlayer::Internal::Type::BaseModel
|
|
8
|
+
extend Openlayer::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Openlayer::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute workspace_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :workspace_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute api_key_id
|
|
17
|
+
#
|
|
18
|
+
# @return [String]
|
|
19
|
+
required :api_key_id, String
|
|
20
|
+
|
|
21
|
+
# @!method initialize(workspace_id:, api_key_id:, request_options: {})
|
|
22
|
+
# @param workspace_id [String]
|
|
23
|
+
# @param api_key_id [String]
|
|
24
|
+
# @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Openlayer
|
|
4
|
+
module Models
|
|
5
|
+
module Workspaces
|
|
6
|
+
# @see Openlayer::Resources::Workspaces::APIKeys#retrieve
|
|
7
|
+
class APIKeyRetrieveResponse < Openlayer::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute expires_at
|
|
9
|
+
# When the key stops authenticating. `null` means the key never expires. Set when
|
|
10
|
+
# the key is created or rotated, and must be in the future. When the request is
|
|
11
|
+
# authenticated with an API key that expires, the result can't be later than that
|
|
12
|
+
# key's expiry. On create, omit it to inherit that expiry. On rotate, omit it to
|
|
13
|
+
# keep the current one. It can't be changed with an update; rotate the key
|
|
14
|
+
# instead.
|
|
15
|
+
#
|
|
16
|
+
# @return [Time, nil]
|
|
17
|
+
optional :expires_at, Time, api_name: :expiresAt, nil?: true
|
|
18
|
+
|
|
19
|
+
# @!attribute name
|
|
20
|
+
# The API key name.
|
|
21
|
+
#
|
|
22
|
+
# @return [String, nil]
|
|
23
|
+
optional :name, String, nil?: true
|
|
24
|
+
|
|
25
|
+
response_only do
|
|
26
|
+
# @!attribute id
|
|
27
|
+
# The API key id.
|
|
28
|
+
#
|
|
29
|
+
# @return [String]
|
|
30
|
+
required :id, String
|
|
31
|
+
|
|
32
|
+
# @!attribute date_created
|
|
33
|
+
# The API key creation date.
|
|
34
|
+
#
|
|
35
|
+
# @return [Time]
|
|
36
|
+
required :date_created, Time, api_name: :dateCreated
|
|
37
|
+
|
|
38
|
+
# @!attribute date_last_used
|
|
39
|
+
# The API key last use date.
|
|
40
|
+
#
|
|
41
|
+
# @return [Time, nil]
|
|
42
|
+
required :date_last_used, Time, api_name: :dateLastUsed, nil?: true
|
|
43
|
+
|
|
44
|
+
# @!attribute date_updated
|
|
45
|
+
# The API key last update date.
|
|
46
|
+
#
|
|
47
|
+
# @return [Time]
|
|
48
|
+
required :date_updated, Time, api_name: :dateUpdated
|
|
49
|
+
|
|
50
|
+
# @!attribute secure_key
|
|
51
|
+
# An obfuscated hint of the API key value. When a key is created or rotated this
|
|
52
|
+
# also holds the full secret, for backward compatibility; prefer `secret`.
|
|
53
|
+
#
|
|
54
|
+
# @return [String]
|
|
55
|
+
required :secure_key, String, api_name: :secureKey
|
|
56
|
+
|
|
57
|
+
# @!attribute status
|
|
58
|
+
# The key's lifecycle state. `active`: the current secret authenticates.
|
|
59
|
+
# `rotating`: the key was rotated and the previous secret still authenticates
|
|
60
|
+
# until `previousKeyExpiresAt`. `expired`: `expiresAt` has passed, no secret
|
|
61
|
+
# authenticates, and the key can't be rotated.
|
|
62
|
+
#
|
|
63
|
+
# @return [Symbol, Openlayer::Models::Workspaces::APIKeyRetrieveResponse::Status]
|
|
64
|
+
required :status, enum: -> { Openlayer::Models::Workspaces::APIKeyRetrieveResponse::Status }
|
|
65
|
+
|
|
66
|
+
# @!attribute last_rotated_at
|
|
67
|
+
# When the key was last rotated.
|
|
68
|
+
#
|
|
69
|
+
# @return [Time, nil]
|
|
70
|
+
optional :last_rotated_at, Time, api_name: :lastRotatedAt, nil?: true
|
|
71
|
+
|
|
72
|
+
# @!attribute previous_key_expires_at
|
|
73
|
+
# While `status` is `rotating`, when the previous secret stops authenticating.
|
|
74
|
+
#
|
|
75
|
+
# @return [Time, nil]
|
|
76
|
+
optional :previous_key_expires_at, Time, api_name: :previousKeyExpiresAt, nil?: true
|
|
77
|
+
|
|
78
|
+
# @!attribute secret
|
|
79
|
+
# The full API key. Only present in the response that creates or rotates the key,
|
|
80
|
+
# and never shown again.
|
|
81
|
+
#
|
|
82
|
+
# @return [String, nil]
|
|
83
|
+
optional :secret, String
|
|
84
|
+
end
|
|
85
|
+
|
|
86
|
+
# @!method initialize(id:, date_created:, date_last_used:, date_updated:, secure_key:, status:, expires_at: nil, last_rotated_at: nil, name: nil, previous_key_expires_at: nil, secret: nil)
|
|
87
|
+
# Some parameter documentations has been truncated, see
|
|
88
|
+
# {Openlayer::Models::Workspaces::APIKeyRetrieveResponse} for more details.
|
|
89
|
+
#
|
|
90
|
+
# @param id [String] The API key id.
|
|
91
|
+
#
|
|
92
|
+
# @param date_created [Time] The API key creation date.
|
|
93
|
+
#
|
|
94
|
+
# @param date_last_used [Time, nil] The API key last use date.
|
|
95
|
+
#
|
|
96
|
+
# @param date_updated [Time] The API key last update date.
|
|
97
|
+
#
|
|
98
|
+
# @param secure_key [String] An obfuscated hint of the API key value. When a key is created or rotated this a
|
|
99
|
+
#
|
|
100
|
+
# @param status [Symbol, Openlayer::Models::Workspaces::APIKeyRetrieveResponse::Status] The key's lifecycle state. `active`: the current secret authenticates. `rotating
|
|
101
|
+
#
|
|
102
|
+
# @param expires_at [Time, nil] When the key stops authenticating. `null` means the key never expires. Set when
|
|
103
|
+
#
|
|
104
|
+
# @param last_rotated_at [Time, nil] When the key was last rotated.
|
|
105
|
+
#
|
|
106
|
+
# @param name [String, nil] The API key name.
|
|
107
|
+
#
|
|
108
|
+
# @param previous_key_expires_at [Time, nil] While `status` is `rotating`, when the previous secret stops authenticating.
|
|
109
|
+
#
|
|
110
|
+
# @param secret [String] The full API key. Only present in the response that creates or rotates the key,
|
|
111
|
+
|
|
112
|
+
# The key's lifecycle state. `active`: the current secret authenticates.
|
|
113
|
+
# `rotating`: the key was rotated and the previous secret still authenticates
|
|
114
|
+
# until `previousKeyExpiresAt`. `expired`: `expiresAt` has passed, no secret
|
|
115
|
+
# authenticates, and the key can't be rotated.
|
|
116
|
+
#
|
|
117
|
+
# @see Openlayer::Models::Workspaces::APIKeyRetrieveResponse#status
|
|
118
|
+
module Status
|
|
119
|
+
extend Openlayer::Internal::Type::Enum
|
|
120
|
+
|
|
121
|
+
ACTIVE = :active
|
|
122
|
+
ROTATING = :rotating
|
|
123
|
+
EXPIRED = :expired
|
|
124
|
+
|
|
125
|
+
# @!method self.values
|
|
126
|
+
# @return [Array<Symbol>]
|
|
127
|
+
end
|
|
128
|
+
end
|
|
129
|
+
end
|
|
130
|
+
end
|
|
131
|
+
end
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Openlayer
|
|
4
|
+
module Models
|
|
5
|
+
module Workspaces
|
|
6
|
+
# @see Openlayer::Resources::Workspaces::APIKeys#rotate
|
|
7
|
+
class APIKeyRotateParams < Openlayer::Internal::Type::BaseModel
|
|
8
|
+
extend Openlayer::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Openlayer::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute workspace_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :workspace_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute api_key_id
|
|
17
|
+
#
|
|
18
|
+
# @return [String]
|
|
19
|
+
required :api_key_id, String
|
|
20
|
+
|
|
21
|
+
# @!attribute expires_at
|
|
22
|
+
# When the key stops authenticating. `null` means the key never expires. Set when
|
|
23
|
+
# the key is created or rotated, and must be in the future. When the request is
|
|
24
|
+
# authenticated with an API key that expires, the result can't be later than that
|
|
25
|
+
# key's expiry. On create, omit it to inherit that expiry. On rotate, omit it to
|
|
26
|
+
# keep the current one. It can't be changed with an update; rotate the key
|
|
27
|
+
# instead.
|
|
28
|
+
#
|
|
29
|
+
# @return [Time, nil]
|
|
30
|
+
optional :expires_at, Time, api_name: :expiresAt, nil?: true
|
|
31
|
+
|
|
32
|
+
# @!attribute grace_period_hours
|
|
33
|
+
# Hours the previous secret keeps authenticating. The default of 0 retires it
|
|
34
|
+
# immediately. It never outlives `expiresAt`. Only one previous secret is kept, so
|
|
35
|
+
# rotating again during a grace period retires the older one immediately.
|
|
36
|
+
#
|
|
37
|
+
# @return [Integer, nil]
|
|
38
|
+
optional :grace_period_hours, Integer, api_name: :gracePeriodHours
|
|
39
|
+
|
|
40
|
+
# @!method initialize(workspace_id:, api_key_id:, expires_at: nil, grace_period_hours: nil, request_options: {})
|
|
41
|
+
# Some parameter documentations has been truncated, see
|
|
42
|
+
# {Openlayer::Models::Workspaces::APIKeyRotateParams} for more details.
|
|
43
|
+
#
|
|
44
|
+
# @param workspace_id [String]
|
|
45
|
+
#
|
|
46
|
+
# @param api_key_id [String]
|
|
47
|
+
#
|
|
48
|
+
# @param expires_at [Time, nil] When the key stops authenticating. `null` means the key never expires. Set when
|
|
49
|
+
#
|
|
50
|
+
# @param grace_period_hours [Integer] Hours the previous secret keeps authenticating. The default of 0 retires it imme
|
|
51
|
+
#
|
|
52
|
+
# @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
|
|
53
|
+
end
|
|
54
|
+
end
|
|
55
|
+
end
|
|
56
|
+
end
|