looker-sdk 24.2.1__tar.gz → 25.0.0__tar.gz

{looker_sdk-24.2.1 → looker_sdk-25.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: looker_sdk
-Version: 24.2.1
+Version: 25.0.0
 Summary: Looker REST API
 Home-page: https://pypi.python.org/pypi/looker_sdk
 Author: Looker Data Sciences, Inc.

{looker_sdk-24.2.1 → looker_sdk-25.0.0}/looker_sdk/error.py

@@ -82,7 +82,7 @@ class SDKError(Exception):
     documentation_url: {self.documentation_url}
     error_doc_url:     {self.error_doc_url}
     error details:
-    {sep.join(self.errors)}
+    {sep.join(str(error) for error in self.errors)}
     """
 
 
@@ -99,7 +99,7 @@ class ErrorDocHelper:
     ERROR_CODES_URL: str = "https://static-a.cdn.looker.app/errorcodes/"
     lookup_dict: Dict[str, Dict[str, str]] = {}
     RE_PATTERN: str = (
-        """(https://docs\.looker\.com/r/err/|https://cloud\.google\.com/looker/docs/r/err/)(.*)/(\d{3})(.*)"""
+        r'(https://docs\.looker\.com/r/err/|https://cloud\.google\.com/looker/docs/r/err/)(.*)/(\d{3})(.*)'
     )
     pattern = re.compile(RE_PATTERN, flags=re.IGNORECASE)
 

{looker_sdk-24.2.1 → looker_sdk-25.0.0}/looker_sdk/sdk/api40/methods.py

@@ -21,7 +21,7 @@
 # SOFTWARE.
 #
 
-# 464 API methods
+# 467 API methods
 
 
 # NOTE: Do not edit this file generated by Looker SDK Codegen for API 4.0
@@ -751,7 +751,7 @@ class Looker40SDK(api_methods.APIMethods):
     #
     # The value of the `secret` field will be set by Looker and returned.
     #
-    # Calls to this endpoint require [Embedding](https://cloud.google.com/looker/docs/r/looker-core-feature-embed) to be enabled
+    # **NOTE**: Calls to this endpoint require [Embedding](https://cloud.google.com/looker/docs/r/looker-core-feature-embed) to be enabled. Usage of this endpoint is not authorized for Looker Core Standard and Looker Core Enterprise.
     #
     # POST /embed_config/secrets -> mdls.EmbedSecret
     def create_embed_secret(
@@ -773,7 +773,7 @@ class Looker40SDK(api_methods.APIMethods):
 
     # ### Delete an embed secret.
     #
-    # Calls to this endpoint require [Embedding](https://cloud.google.com/looker/docs/r/looker-core-feature-embed) to be enabled
+    # **NOTE**: Calls to this endpoint require [Embedding](https://cloud.google.com/looker/docs/r/looker-core-feature-embed) to be enabled. Usage of this endpoint is not authorized for Looker Core Standard and Looker Core Enterprise.
     #
     # DELETE /embed_config/secrets/{embed_secret_id} -> str
     def delete_embed_secret(
@@ -819,8 +819,11 @@ class Looker40SDK(api_methods.APIMethods):
     #
     # This function does not strictly require all group_ids, user attribute names, or model names to exist at the moment the
     # embed url is created. Unknown group_id, user attribute names or model names will be passed through to the output URL.
+    # Because of this, **these parameters are not validated** when the API call is made.
     #
-    # To diagnose potential problems with an SSO embed URL, you can copy the signed URL into the Embed URI Validator text box in `<your looker instance>/admin/embed`.
+    # The [Get Embed Url](https://cloud.google.com/looker/docs/r/get-signed-url) dialog can be used to determine and validate the correct permissions for signing an embed url.
+    # This dialog also provides the SDK syntax for the API call to make. Alternatively, you can copy the signed URL into the Embed URI Validator text box
+    # in `<your looker instance>/admin/embed` to diagnose potential problems.
     #
     # The `secret_id` parameter is optional. If specified, its value must be the id of an active secret defined in the Looker instance.
     # if not specified, the URL will be signed using the most recent active signing secret. If there is no active secret for signing embed urls,
@@ -834,7 +837,7 @@ class Looker40SDK(api_methods.APIMethods):
     # encrypted transport.
     #
     #
-    # Calls to this endpoint require [Embedding](https://cloud.google.com/looker/docs/r/looker-core-feature-embed) to be enabled
+    # **NOTE**: Calls to this endpoint require [Embedding](https://cloud.google.com/looker/docs/r/looker-core-feature-embed) to be enabled. Usage of this endpoint is not authorized for Looker Core Standard and Looker Core Enterprise.
     #
     # POST /embed/sso_url -> mdls.EmbedUrlResponse
     def create_sso_embed_url(
@@ -881,7 +884,7 @@ class Looker40SDK(api_methods.APIMethods):
     # encrypted transport.
     #
     #
-    # Calls to this endpoint require [Embedding](https://cloud.google.com/looker/docs/r/looker-core-feature-embed) to be enabled
+    # **NOTE**: Calls to this endpoint require [Embedding](https://cloud.google.com/looker/docs/r/looker-core-feature-embed) to be enabled. Usage of this endpoint is not authorized for Looker Core Standard and Looker Core Enterprise.
     #
     # POST /embed/token_url/me -> mdls.EmbedUrlResponse
     def create_embed_url_as_me(
@@ -953,7 +956,7 @@ class Looker40SDK(api_methods.APIMethods):
     # - Navigation token - lives for 10 minutes. The Looker client will ask for this token once it is loaded into
     #   the iframe.
     #
-    # Calls to this endpoint require [Embedding](https://cloud.google.com/looker/docs/r/looker-core-feature-embed) to be enabled
+    # **NOTE**: Calls to this endpoint require [Embedding](https://cloud.google.com/looker/docs/r/looker-core-feature-embed) to be enabled. Usage of this endpoint is not authorized for Looker Core Standard and Looker Core Enterprise.
     #
     # POST /embed/cookieless_session/acquire -> mdls.EmbedCookielessSessionAcquireResponse
     def acquire_embed_cookieless_session(
@@ -979,7 +982,7 @@ class Looker40SDK(api_methods.APIMethods):
     # in the session and session reference data being cleared from the system. This endpoint can be used to log an embed
     # user out of the Looker instance.
     #
-    # Calls to this endpoint require [Embedding](https://cloud.google.com/looker/docs/r/looker-core-feature-embed) to be enabled
+    # **NOTE**: Calls to this endpoint require [Embedding](https://cloud.google.com/looker/docs/r/looker-core-feature-embed) to be enabled. Usage of this endpoint is not authorized for Looker Core Standard and Looker Core Enterprise.
     #
     # DELETE /embed/cookieless_session/{session_reference_token} -> str
     def delete_embed_cookieless_session(
@@ -1015,7 +1018,7 @@ class Looker40SDK(api_methods.APIMethods):
     # the session time to live in the `session_reference_token_ttl` response property. If this property
     # contains a zero, the embed session has expired.
     #
-    # Calls to this endpoint require [Embedding](https://cloud.google.com/looker/docs/r/looker-core-feature-embed) to be enabled
+    # **NOTE**: Calls to this endpoint require [Embedding](https://cloud.google.com/looker/docs/r/looker-core-feature-embed) to be enabled. Usage of this endpoint is not authorized for Looker Core Standard and Looker Core Enterprise.
     #
     # PUT /embed/cookieless_session/generate_tokens -> mdls.EmbedCookielessSessionGenerateTokensResponse
     def generate_tokens_for_cookieless_session(
@@ -3234,8 +3237,12 @@ class Looker40SDK(api_methods.APIMethods):
     #  - allow_user_timezones
     #  - custom_welcome_email
     #  - data_connector_default_enabled
+    #  - dashboard_auto_refresh_restriction
+    #  - dashboard_auto_refresh_minimum_interval
     #  - extension_framework_enabled
     #  - extension_load_url_enabled
+    #  - instance_config
+    #  - managed_certificate_uri
     #  - marketplace_auto_install_enabled
     #  - marketplace_automation
     #  - marketplace_terms_accepted
@@ -3275,8 +3282,12 @@ class Looker40SDK(api_methods.APIMethods):
     #  - allow_user_timezones
     #  - custom_welcome_email
     #  - data_connector_default_enabled
+    #  - dashboard_auto_refresh_restriction
+    #  - dashboard_auto_refresh_minimum_interval
     #  - extension_framework_enabled
     #  - extension_load_url_enabled
+    #  - instance_config
+    #  - managed_certificate_uri
     #  - marketplace_auto_install_enabled
     #  - marketplace_automation
     #  - marketplace_terms_accepted
@@ -3737,6 +3748,31 @@ class Looker40SDK(api_methods.APIMethods):
         )
         return response
 
+    # ### Update an OAuth Application's client secret.
+    #
+    # This is an OAuth Application which Looker uses to access external systems.
+    #
+    # PATCH /external_oauth_applications/{client_id} -> mdls.ExternalOauthApplication
+    def update_external_oauth_application(
+        self,
+        # The client ID of the OAuth App to update
+        client_id: str,
+        body: mdls.WriteExternalOauthApplication,
+        transport_options: Optional[transport.TransportOptions] = None,
+    ) -> mdls.ExternalOauthApplication:
+        """Update External OAuth Application"""
+        client_id = self.encode_path_param(client_id)
+        response = cast(
+            mdls.ExternalOauthApplication,
+            self.patch(
+                path=f"/external_oauth_applications/{client_id}",
+                structure=mdls.ExternalOauthApplication,
+                body=body,
+                transport_options=transport_options,
+            ),
+        )
+        return response
+
     # ### Create OAuth User state.
     #
     # POST /external_oauth_applications/user_state -> mdls.CreateOAuthApplicationUserStateResponse
@@ -4390,6 +4426,50 @@ class Looker40SDK(api_methods.APIMethods):
         )
         return response
 
+    # ### Get Content Summary
+    #
+    # Retrieves a collection of content items related to user activity and engagement, such as recently viewed content,
+    # favorites and scheduled items.
+    #
+    # GET /content_summary -> Sequence[mdls.ContentSummary]
+    def content_summary(
+        self,
+        # Comma-delimited names of fields to return in responses. Omit for all fields
+        fields: Optional[str] = None,
+        # Number of results to return. (used with offset)
+        limit: Optional[int] = None,
+        # Number of results to skip before returning any. (used with limit)
+        offset: Optional[int] = None,
+        # Match group id
+        target_group_id: Optional[str] = None,
+        # Match user id
+        target_user_id: Optional[str] = None,
+        # Content type to match, options are: look, dashboard. Can be provided as a comma delimited list.
+        target_content_type: Optional[str] = None,
+        # Fields to sort by
+        sorts: Optional[str] = None,
+        transport_options: Optional[transport.TransportOptions] = None,
+    ) -> Sequence[mdls.ContentSummary]:
+        """Search Content Summaries"""
+        response = cast(
+            Sequence[mdls.ContentSummary],
+            self.get(
+                path="/content_summary",
+                structure=Sequence[mdls.ContentSummary],
+                query_params={
+                    "fields": fields,
+                    "limit": limit,
+                    "offset": offset,
+                    "target_group_id": target_group_id,
+                    "target_user_id": target_user_id,
+                    "target_content_type": target_content_type,
+                    "sorts": sorts,
+                },
+                transport_options=transport_options,
+            ),
+        )
+        return response
+
     # ### Get an image representing the contents of a dashboard or look.
     #
     # The returned thumbnail is an abstract representation of the contents of a dashboard or look and does not
@@ -4444,6 +4524,10 @@ class Looker40SDK(api_methods.APIMethods):
         self,
         # Requested fields.
         fields: Optional[str] = None,
+        # Optional list of project names to filter by
+        project_names: Optional[mdls.DelimSequence[str]] = None,
+        # Optional list of space ids to filter by
+        space_ids: Optional[mdls.DelimSequence[str]] = None,
         transport_options: Optional[transport.TransportOptions] = None,
     ) -> mdls.ContentValidation:
         """Validate Content"""
@@ -4452,7 +4536,11 @@ class Looker40SDK(api_methods.APIMethods):
             self.get(
                 path="/content_validation",
                 structure=mdls.ContentValidation,
-                query_params={"fields": fields},
+                query_params={
+                    "fields": fields,
+                    "project_names": project_names,
+                    "space_ids": space_ids,
+                },
                 transport_options=transport_options,
             ),
         )
@@ -5950,19 +6038,19 @@ class Looker40SDK(api_methods.APIMethods):
     #
     # All personal folders will be returned.
     #
-    # GET /folders -> Sequence[mdls.Folder]
+    # GET /folders -> Sequence[mdls.FolderBase]
     def all_folders(
         self,
         # Requested fields.
         fields: Optional[str] = None,
         transport_options: Optional[transport.TransportOptions] = None,
-    ) -> Sequence[mdls.Folder]:
+    ) -> Sequence[mdls.FolderBase]:
         """Get All Folders"""
         response = cast(
-            Sequence[mdls.Folder],
+            Sequence[mdls.FolderBase],
             self.get(
                 path="/folders",
-                structure=Sequence[mdls.Folder],
+                structure=Sequence[mdls.FolderBase],
                 query_params={"fields": fields},
                 transport_options=transport_options,
             ),
@@ -7438,6 +7526,12 @@ class Looker40SDK(api_methods.APIMethods):
         limit: Optional[int] = None,
         # Number of results to skip before returning any. (Defaults to 0 if not set when limit is used)
         offset: Optional[int] = None,
+        # Whether or not to exclude models with no explores from the response (Defaults to false)
+        exclude_empty: Optional[bool] = None,
+        # Whether or not to exclude hidden explores from the response (Defaults to false)
+        exclude_hidden: Optional[bool] = None,
+        # Whether or not to include built-in models such as System Activity (Defaults to false)
+        include_internal: Optional[bool] = None,
         transport_options: Optional[transport.TransportOptions] = None,
     ) -> Sequence[mdls.LookmlModel]:
         """Get All LookML Models"""
@@ -7446,7 +7540,14 @@ class Looker40SDK(api_methods.APIMethods):
             self.get(
                 path="/lookml_models",
                 structure=Sequence[mdls.LookmlModel],
-                query_params={"fields": fields, "limit": limit, "offset": offset},
+                query_params={
+                    "fields": fields,
+                    "limit": limit,
+                    "offset": offset,
+                    "exclude_empty": exclude_empty,
+                    "exclude_hidden": exclude_hidden,
+                    "include_internal": include_internal,
+                },
                 transport_options=transport_options,
             ),
         )
@@ -8896,7 +8997,7 @@ class Looker40SDK(api_methods.APIMethods):
     #
     # Returns the results of an async query task if the query has completed.
     #
-    # If the query task is still running or waiting to run, this function returns 204 No Content.
+    # If the query task is still running or waiting to run, this function returns 202 Accepted.
     #
     # If the query task ID is invalid or the cached results of the query task have expired, this function returns 404 Not Found.
     #
@@ -8916,20 +9017,20 @@ class Looker40SDK(api_methods.APIMethods):
     # will be in the message of the 400 error response, but not as detailed as expressed in `json_detail.errors`.
     # These data formats can only carry row data, and error info is not row data.
     #
-    # GET /query_tasks/{query_task_id}/results -> mdls.QueryTask
+    # GET /query_tasks/{query_task_id}/results -> str
     def query_task_results(
         self,
         # ID of the Query Task
         query_task_id: str,
         transport_options: Optional[transport.TransportOptions] = None,
-    ) -> mdls.QueryTask:
+    ) -> str:
         """Get Async Query Results"""
         query_task_id = self.encode_path_param(query_task_id)
         response = cast(
-            mdls.QueryTask,
+            str,
             self.get(
                 path=f"/query_tasks/{query_task_id}/results",
-                structure=mdls.QueryTask,
+                structure=str,
                 transport_options=transport_options,
             ),
         )
@@ -10187,6 +10288,8 @@ class Looker40SDK(api_methods.APIMethods):
         built_in: Optional[bool] = None,
         # Combine given search criteria in a boolean OR expression.
         filter_or: Optional[bool] = None,
+        # Search for Looker support roles.
+        is_support_role: Optional[bool] = None,
         transport_options: Optional[transport.TransportOptions] = None,
     ) -> Sequence[mdls.Role]:
         """Search Roles"""
@@ -10204,6 +10307,7 @@ class Looker40SDK(api_methods.APIMethods):
                     "name": name,
                     "built_in": built_in,
                     "filter_or": filter_or,
+                    "is_support_role": is_support_role,
                 },
                 transport_options=transport_options,
             ),
@@ -10761,6 +10865,84 @@ class Looker40SDK(api_methods.APIMethods):
         )
         return response
 
+    # ### Search Scheduled Plans
+    #
+    # Returns all scheduled plans which matches the given search criteria.
+    #
+    # If no user_id is provided, this function returns the scheduled plans owned by the caller.
+    #
+    #
+    # To list all schedules for all users, pass `all_users=true`.
+    #
+    #
+    # The caller must have `see_schedules` permission to see other users' scheduled plans.
+    #
+    # GET /scheduled_plans/search -> Sequence[mdls.ScheduledPlan]
+    def search_scheduled_plans(
+        self,
+        # Return scheduled plans belonging to this user_id. If not provided, returns scheduled plans owned by the caller.
+        user_id: Optional[str] = None,
+        # Comma delimited list of field names. If provided, only the fields specified will be included in the response
+        fields: Optional[str] = None,
+        # Return scheduled plans belonging to all users (caller needs see_schedules permission)
+        all_users: Optional[bool] = None,
+        # Number of results to return. (used with offset and takes priority over page and per_page)
+        limit: Optional[int] = None,
+        # Number of results to skip before returning any. (used with limit and takes priority over page and per_page)
+        offset: Optional[int] = None,
+        # Fields to sort by.
+        sorts: Optional[str] = None,
+        # Match Scheduled plan's name.
+        name: Optional[str] = None,
+        # Returns scheduled plans belonging to user with this first name.
+        user_first_name: Optional[str] = None,
+        # Returns scheduled plans belonging to user with this last name.
+        user_last_name: Optional[str] = None,
+        # Returns scheduled plans created on this Dashboard.
+        dashboard_id: Optional[str] = None,
+        # Returns scheduled plans created on this Look.
+        look_id: Optional[str] = None,
+        # Returns scheduled plans created on this LookML Dashboard.
+        lookml_dashboard_id: Optional[str] = None,
+        # Match recipient address.
+        recipient: Optional[str] = None,
+        # Match scheduled plan's destination type.
+        destination_type: Optional[str] = None,
+        # Match scheduled plan's delivery format.
+        delivery_format: Optional[str] = None,
+        # Combine given search criteria in a boolean OR expression
+        filter_or: Optional[bool] = None,
+        transport_options: Optional[transport.TransportOptions] = None,
+    ) -> Sequence[mdls.ScheduledPlan]:
+        """Search Scheduled Plans"""
+        response = cast(
+            Sequence[mdls.ScheduledPlan],
+            self.get(
+                path="/scheduled_plans/search",
+                structure=Sequence[mdls.ScheduledPlan],
+                query_params={
+                    "user_id": user_id,
+                    "fields": fields,
+                    "all_users": all_users,
+                    "limit": limit,
+                    "offset": offset,
+                    "sorts": sorts,
+                    "name": name,
+                    "user_first_name": user_first_name,
+                    "user_last_name": user_last_name,
+                    "dashboard_id": dashboard_id,
+                    "look_id": look_id,
+                    "lookml_dashboard_id": lookml_dashboard_id,
+                    "recipient": recipient,
+                    "destination_type": destination_type,
+                    "delivery_format": delivery_format,
+                    "filter_or": filter_or,
+                },
+                transport_options=transport_options,
+            ),
+        )
+        return response
+
     # ### Get Scheduled Plans for a Look
     #
     # Returns all scheduled plans for a look which belong to the caller or given user.
@@ -11054,17 +11236,9 @@ class Looker40SDK(api_methods.APIMethods):
     #
     # | result_format | Description
     # | :-----------: | :--- |
-    # | json | Plain json
-    # | json_bi | (*RECOMMENDED*) Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query
-    # | json_detail | (*LEGACY*) Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query
-    # | csv | Comma separated values with a header
-    # | txt | Tab separated values with a header
-    # | html | Simple html
-    # | md | Simple markdown
-    # | xlsx | MS Excel spreadsheet
-    # | sql | Returns the generated SQL rather than running the query
+    # | json_bi | Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query
     #
-    # GET /sql_interface_queries/{query_id}/run/{result_format} -> mdls.QueryFormats
+    # GET /sql_interface_queries/{query_id}/run/{result_format} -> mdls.JsonBi
     def run_sql_interface_query(
         self,
         # Integer id of query
@@ -11072,14 +11246,14 @@ class Looker40SDK(api_methods.APIMethods):
         # Format of result, options are: ["json_bi"]
         result_format: str,
         transport_options: Optional[transport.TransportOptions] = None,
-    ) -> mdls.QueryFormats:
+    ) -> mdls.JsonBi:
         """Run SQL Interface Query"""
         result_format = self.encode_path_param(result_format)
         response = cast(
-            mdls.QueryFormats,
+            mdls.JsonBi,
             self.get(
                 path=f"/sql_interface_queries/{query_id}/run/{result_format}",
-                structure=mdls.QueryFormats,
+                structure=mdls.JsonBi,
                 transport_options=transport_options,
             ),
         )
@@ -12429,7 +12603,7 @@ class Looker40SDK(api_methods.APIMethods):
 
     # ### Embed login information for the specified user.
     #
-    # Calls to this endpoint require [Embedding](https://cloud.google.com/looker/docs/r/looker-core-feature-embed) to be enabled
+    # **NOTE**: Calls to this endpoint require [Embedding](https://cloud.google.com/looker/docs/r/looker-core-feature-embed) to be enabled. Usage of this endpoint is not authorized for Looker Core Standard and Looker Core Enterprise.
     #
     # GET /users/{user_id}/credentials_embed/{credentials_embed_id} -> mdls.CredentialsEmbed
     def user_credentials_embed(
@@ -12458,7 +12632,7 @@ class Looker40SDK(api_methods.APIMethods):
 
     # ### Embed login information for the specified user.
     #
-    # Calls to this endpoint require [Embedding](https://cloud.google.com/looker/docs/r/looker-core-feature-embed) to be enabled
+    # **NOTE**: Calls to this endpoint require [Embedding](https://cloud.google.com/looker/docs/r/looker-core-feature-embed) to be enabled. Usage of this endpoint is not authorized for Looker Core Standard and Looker Core Enterprise.
     #
     # DELETE /users/{user_id}/credentials_embed/{credentials_embed_id} -> str
     def delete_user_credentials_embed(
@@ -12484,7 +12658,7 @@ class Looker40SDK(api_methods.APIMethods):
 
     # ### Embed login information for the specified user.
     #
-    # Calls to this endpoint require [Embedding](https://cloud.google.com/looker/docs/r/looker-core-feature-embed) to be enabled
+    # **NOTE**: Calls to this endpoint require [Embedding](https://cloud.google.com/looker/docs/r/looker-core-feature-embed) to be enabled. Usage of this endpoint is not authorized for Looker Core Standard and Looker Core Enterprise.
     #
     # GET /users/{user_id}/credentials_embed -> Sequence[mdls.CredentialsEmbed]
     def all_user_credentials_embeds(
@@ -12874,6 +13048,7 @@ class Looker40SDK(api_methods.APIMethods):
     # associated credentials.  Will overwrite all associated email addresses with
     # the value supplied in the 'email' body param.
     # The user's 'is_disabled' status must be true.
+    # If the user has a credential email, they will receive a verification email and the user will be disabled until they verify the email
     #
     # Calls to this endpoint may be denied by [Looker (Google Cloud core)](https://cloud.google.com/looker/docs/r/looker-core/overview).
     #
@@ -12903,7 +13078,7 @@ class Looker40SDK(api_methods.APIMethods):
 
     # Create an embed user from an external user ID
     #
-    # Calls to this endpoint require [Embedding](https://cloud.google.com/looker/docs/r/looker-core-feature-embed) to be enabled
+    # **NOTE**: Calls to this endpoint require [Embedding](https://cloud.google.com/looker/docs/r/looker-core-feature-embed) to be enabled. Usage of this endpoint is not authorized for Looker Core Standard and Looker Core Enterprise.
     #
     # POST /users/embed_user -> mdls.UserPublic
     def create_embed_user(