looker-sdk 25.18.0__tar.gz → 26.0.0__tar.gz

{looker_sdk-25.18.0 → looker_sdk-26.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: looker_sdk
-Version: 25.18.0
+Version: 26.0.0
 Summary: Looker REST API
 Home-page: https://pypi.python.org/pypi/looker_sdk
 Author: Looker Data Sciences, Inc.
@@ -9,6 +9,20 @@ Keywords: Looker,Looker API,looker_sdk,Looker API 4.0
 Requires-Python: >=3.6
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
+Requires-Dist: requests>=2.22
+Requires-Dist: typing-extensions>=4.1.1
+Requires-Dist: attrs>=20.1.0; python_version >= "3.7"
+Requires-Dist: cattrs>=1.3; python_version >= "3.7"
+Dynamic: author
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 ===========
 Looker SDK

{looker_sdk-25.18.0 → looker_sdk-26.0.0}/looker_sdk/sdk/api40/methods.py

@@ -21,7 +21,7 @@
 # SOFTWARE.
 #
 
-# 476 API methods
+# 478 API methods
 
 
 # NOTE: Do not edit this file generated by Looker SDK Codegen for API 4.0
@@ -3779,6 +3779,29 @@ class Looker40SDK(api_methods.APIMethods):
         )
         return response
 
+    # ### Delete an OAuth Application.
+    #
+    # This is an OAuth Application which Looker uses to access external systems.
+    #
+    # DELETE /external_oauth_applications/{client_id} -> str
+    def delete_external_oauth_application(
+        self,
+        # The client ID of the OAuth App to delete
+        client_id: str,
+        transport_options: Optional[transport.TransportOptions] = None,
+    ) -> str:
+        """Delete External OAuth Application"""
+        client_id = self.encode_path_param(client_id)
+        response = cast(
+            str,
+            self.delete(
+                path=f"/external_oauth_applications/{client_id}",
+                structure=str,
+                transport_options=transport_options,
+            ),
+        )
+        return response
+
     # ### Create OAuth User state.
     #
     # POST /external_oauth_applications/user_state -> mdls.CreateOAuthApplicationUserStateResponse
@@ -4115,6 +4138,8 @@ class Looker40SDK(api_methods.APIMethods):
         look_id: Optional[str] = None,
         # Match board id(s). To create a list of multiple ids, use commas as separators
         board_id: Optional[str] = None,
+        # Match lookml dashboard id(s). To create a list of multiple ids, use commas as separators
+        lookml_dashboard_id: Optional[str] = None,
         # If true, and board_id is provided, returns the content favorites for all items on the board. If false, returns the content favorite for the board itself.
         include_board_items: Optional[bool] = None,
         # Number of results to return. (used with offset)
@@ -4142,6 +4167,7 @@ class Looker40SDK(api_methods.APIMethods):
                     "dashboard_id": dashboard_id,
                     "look_id": look_id,
                     "board_id": board_id,
+                    "lookml_dashboard_id": lookml_dashboard_id,
                     "include_board_items": include_board_items,
                     "limit": limit,
                     "offset": offset,
@@ -7637,6 +7663,8 @@ class Looker40SDK(api_methods.APIMethods):
         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,
+        # Whether or not to include self service models (Defaults to false)
+        include_self_service: Optional[bool] = None,
         transport_options: Optional[transport.TransportOptions] = None,
     ) -> Sequence[mdls.LookmlModel]:
         """Get All LookML Models"""
@@ -7652,6 +7680,7 @@ class Looker40SDK(api_methods.APIMethods):
                     "exclude_empty": exclude_empty,
                     "exclude_hidden": exclude_hidden,
                     "include_internal": include_internal,
+                    "include_self_service": include_self_service,
                 },
                 transport_options=transport_options,
             ),
@@ -8533,6 +8562,10 @@ class Looker40SDK(api_methods.APIMethods):
     # metadata. The remote git repository MUST be configured with the Looker-generated deploy
     # key for this project prior to setting the project's `git_remote_url`.
     #
+    # Note that Looker will validate the git connection when the `git_remote_url` is modified.
+    # If Looker cannot connect to the remote repository (e.g. because the deploy key has not
+    # been added), the update will fail with a 400 Bad Request error.
+    #
     # To set up a Looker project with a git repository residing on the Looker server (a 'bare' git repo):
     #
     # 1. Call `update_session` to select the 'dev' workspace.
@@ -12127,7 +12160,7 @@ class Looker40SDK(api_methods.APIMethods):
         group_id: Optional[str] = None,
         # Search for users who can manage API3 credentials. This field may only be applicable for [Looker (Google Cloud core)](https://cloud.google.com/looker/docs/r/looker-core/overview). Availability of this filter is limited to users with permission to view complete user details. This is an experimental feature and may not yet be available on your instance.
         can_manage_api3_creds: Optional[bool] = None,
-        # Search for service account users. Send true to get only service accounts, or false to get all other types of users. This field may only be applicable for [Looker (Google Cloud core)](https://cloud.google.com/looker/docs/r/looker-core/overview). Availability of this filter is limited to users with permission to view complete user details. This is an experimental feature and may not yet be available on your instance.
+        # Search for service account users. Send true to get only service accounts, or false to get all other types of users. Availability of this filter is limited to users with permission to view complete user details.
         is_service_account: Optional[bool] = None,
         transport_options: Optional[transport.TransportOptions] = None,
     ) -> Sequence[mdls.User]:
@@ -12282,7 +12315,19 @@ class Looker40SDK(api_methods.APIMethods):
 
     # ### Delete the user with a specific id.
     #
-    # **DANGER** this will delete the user and all looks and other information owned by the user.
+    # **This action cannot be undone.** If you want to keep the user's content, we recommend disabling their accounts instead of deleting them.
+    #
+    # Deletion will have the following impact:
+    # * Their reports, Looks and dashboards will be moved to Trash.
+    # * Any public URLs owned by them will no longer work.
+    # * Schedules created by the users or that use their content will be deleted.
+    # * Alerts will continue to run, but will not be visible or editable from the dashboard.
+    #
+    # The user cannot delete themselves.
+    # The last administrator user cannot be deleted.
+    #
+    # Deleting Service Accounts via this endpoint is deprecated and can be blocked in future versions.
+    # Please use the dedicated `delete_service_account` endpoint.
     #
     # DELETE /users/{user_id} -> str
     def delete_user(
@@ -12359,6 +12404,65 @@ class Looker40SDK(api_methods.APIMethods):
         )
         return response
 
+    # ### Update information for a specific service account. This action is restricted to Looker admins.
+    #
+    # This endpoint is exclusively for updating service accounts. To update a regular user, please use the `PATCH /api/3.x/users/:user_id` endpoint instead.
+    #
+    # PATCH /users/service_accounts/{user_id} -> mdls.ServiceAccount
+    def update_service_account(
+        self,
+        # Id of service account
+        user_id: str,
+        body: mdls.WriteServiceAccount,
+        # Requested fields.
+        fields: Optional[str] = None,
+        transport_options: Optional[transport.TransportOptions] = None,
+    ) -> mdls.ServiceAccount:
+        """Update Service Account"""
+        user_id = self.encode_path_param(user_id)
+        response = cast(
+            mdls.ServiceAccount,
+            self.patch(
+                path=f"/users/service_accounts/{user_id}",
+                structure=mdls.ServiceAccount,
+                query_params={"fields": fields},
+                body=body,
+                transport_options=transport_options,
+            ),
+        )
+        return response
+
+    # ### Delete the service account with a specific id.
+    #
+    # **This action cannot be undone.** If you want to keep the service account's content, we recommend disabling their accounts instead of deleting them.
+    #
+    # Deletion will have the following impact:
+    # * Their reports, Looks and dashboards will be moved to Trash.
+    # * Any public URLs owned by them will no longer work.
+    # * Schedules created by the service account or that use their content will be deleted.
+    # * Alerts will continue to run, but will not be visible or editable from the dashboard.
+    #
+    # The service account cannot delete itself.
+    #
+    # DELETE /users/service_accounts/{user_id} -> str
+    def delete_service_account(
+        self,
+        # Id of service account user
+        user_id: str,
+        transport_options: Optional[transport.TransportOptions] = None,
+    ) -> str:
+        """Delete Service Account"""
+        user_id = self.encode_path_param(user_id)
+        response = cast(
+            str,
+            self.delete(
+                path=f"/users/service_accounts/{user_id}",
+                structure=str,
+                transport_options=transport_options,
+            ),
+        )
+        return response
+
     # ### Email/password login information for the specified user.
     #
     # Calls to this endpoint may be denied by [Looker (Google Cloud core)](https://cloud.google.com/looker/docs/r/looker-core/overview).
@@ -12593,8 +12697,6 @@ class Looker40SDK(api_methods.APIMethods):
 
     # ### Google authentication login information for the specified user.
     #
-    # Calls to this endpoint may be denied by [Looker (Google Cloud core)](https://cloud.google.com/looker/docs/r/looker-core/overview).
-    #
     # GET /users/{user_id}/credentials_google -> mdls.CredentialsGoogle
     def user_credentials_google(
         self,
@@ -12619,8 +12721,6 @@ class Looker40SDK(api_methods.APIMethods):
 
     # ### Google authentication login information for the specified user.
     #
-    # Calls to this endpoint may be denied by [Looker (Google Cloud core)](https://cloud.google.com/looker/docs/r/looker-core/overview).
-    #
     # DELETE /users/{user_id}/credentials_google -> str
     def delete_user_credentials_google(
         self,
@@ -12642,8 +12742,6 @@ class Looker40SDK(api_methods.APIMethods):
 
     # ### Saml authentication login information for the specified user.
     #
-    # Calls to this endpoint may be denied by [Looker (Google Cloud core)](https://cloud.google.com/looker/docs/r/looker-core/overview).
-    #
     # GET /users/{user_id}/credentials_saml -> mdls.CredentialsSaml
     def user_credentials_saml(
         self,
@@ -12668,8 +12766,6 @@ class Looker40SDK(api_methods.APIMethods):
 
     # ### Saml authentication login information for the specified user.
     #
-    # Calls to this endpoint may be denied by [Looker (Google Cloud core)](https://cloud.google.com/looker/docs/r/looker-core/overview).
-    #
     # DELETE /users/{user_id}/credentials_saml -> str
     def delete_user_credentials_saml(
         self,
@@ -12691,8 +12787,6 @@ class Looker40SDK(api_methods.APIMethods):
 
     # ### OpenID Connect (OIDC) authentication login information for the specified user.
     #
-    # Calls to this endpoint may be denied by [Looker (Google Cloud core)](https://cloud.google.com/looker/docs/r/looker-core/overview).
-    #
     # GET /users/{user_id}/credentials_oidc -> mdls.CredentialsOIDC
     def user_credentials_oidc(
         self,
@@ -12717,8 +12811,6 @@ class Looker40SDK(api_methods.APIMethods):
 
     # ### OpenID Connect (OIDC) authentication login information for the specified user.
     #
-    # Calls to this endpoint may be denied by [Looker (Google Cloud core)](https://cloud.google.com/looker/docs/r/looker-core/overview).
-    #
     # DELETE /users/{user_id}/credentials_oidc -> str
     def delete_user_credentials_oidc(
         self,
@@ -12740,8 +12832,6 @@ class Looker40SDK(api_methods.APIMethods):
 
     # ### API login information for the specified user. This is for the newer API keys that can be added for any user.
     #
-    # Calls to this endpoint may be denied by [Looker (Google Cloud core)](https://cloud.google.com/looker/docs/r/looker-core/overview).
-    #
     # GET /users/{user_id}/credentials_api3/{credentials_api3_id} -> mdls.CredentialsApi3
     def user_credentials_api3(
         self,
@@ -12769,8 +12859,6 @@ class Looker40SDK(api_methods.APIMethods):
 
     # ### API login information for the specified user. This is for the newer API keys that can be added for any user.
     #
-    # Calls to this endpoint may be denied by [Looker (Google Cloud core)](https://cloud.google.com/looker/docs/r/looker-core/overview).
-    #
     # PATCH /users/{user_id}/credentials_api3/{credentials_api3_id} -> mdls.CredentialsApi3
     def update_user_credentials_api3(
         self,
@@ -12800,8 +12888,6 @@ class Looker40SDK(api_methods.APIMethods):
 
     # ### API login information for the specified user. This is for the newer API keys that can be added for any user.
     #
-    # Calls to this endpoint may be denied by [Looker (Google Cloud core)](https://cloud.google.com/looker/docs/r/looker-core/overview).
-    #
     # DELETE /users/{user_id}/credentials_api3/{credentials_api3_id} -> str
     def delete_user_credentials_api3(
         self,
@@ -12826,8 +12912,6 @@ class Looker40SDK(api_methods.APIMethods):
 
     # ### API login information for the specified user. This is for the newer API keys that can be added for any user.
     #
-    # Calls to this endpoint may be denied by [Looker (Google Cloud core)](https://cloud.google.com/looker/docs/r/looker-core/overview).
-    #
     # GET /users/{user_id}/credentials_api3 -> Sequence[mdls.CredentialsApi3]
     def all_user_credentials_api3s(
         self,
@@ -12852,8 +12936,6 @@ class Looker40SDK(api_methods.APIMethods):
 
     # ### API login information for the specified user. This is for the newer API keys that can be added for any user.
     #
-    # Calls to this endpoint may be denied by [Looker (Google Cloud core)](https://cloud.google.com/looker/docs/r/looker-core/overview).
-    #
     # POST /users/{user_id}/credentials_api3 -> mdls.CreateCredentialsApi3
     def create_user_credentials_api3(
         self,
@@ -13008,8 +13090,6 @@ class Looker40SDK(api_methods.APIMethods):
 
     # ### Web login session for the specified user.
     #
-    # Calls to this endpoint may be denied by [Looker (Google Cloud core)](https://cloud.google.com/looker/docs/r/looker-core/overview).
-    #
     # GET /users/{user_id}/sessions/{session_id} -> mdls.Session
     def user_session(
         self,
@@ -13037,8 +13117,6 @@ class Looker40SDK(api_methods.APIMethods):
 
     # ### Web login session for the specified user.
     #
-    # Calls to this endpoint may be denied by [Looker (Google Cloud core)](https://cloud.google.com/looker/docs/r/looker-core/overview).
-    #
     # DELETE /users/{user_id}/sessions/{session_id} -> str
     def delete_user_session(
         self,
@@ -13063,8 +13141,6 @@ class Looker40SDK(api_methods.APIMethods):
 
     # ### Web login session for the specified user.
     #
-    # Calls to this endpoint may be denied by [Looker (Google Cloud core)](https://cloud.google.com/looker/docs/r/looker-core/overview).
-    #
     # GET /users/{user_id}/sessions -> Sequence[mdls.Session]
     def all_user_sessions(
         self,
@@ -13375,8 +13451,6 @@ class Looker40SDK(api_methods.APIMethods):
 
     # ### Create a service account with the specified information. This action is restricted to Looker admins.
     #
-    # Calls to this endpoint may only be available for [Looker (Google Cloud core)](https://cloud.google.com/looker/docs/r/looker-core/overview).
-    #
     # POST /users/service_accounts -> mdls.ServiceAccount
     def create_service_account(
         self,
@@ -13398,36 +13472,6 @@ class Looker40SDK(api_methods.APIMethods):
         )
         return response
 
-    # ### Update information for a specific service account. This action is restricted to Looker admins.
-    #
-    # This endpoint is exclusively for updating service accounts. To update a regular user, please use the `PATCH /api/3.x/users/:user_id` endpoint instead.
-    #
-    # Calls to this endpoint may only be available for [Looker (Google Cloud core)](https://cloud.google.com/looker/docs/r/looker-core/overview).
-    #
-    # PATCH /users/service_accounts/{user_id} -> mdls.ServiceAccount
-    def update_service_account(
-        self,
-        # Id of service account
-        user_id: str,
-        body: mdls.WriteServiceAccount,
-        # Requested fields.
-        fields: Optional[str] = None,
-        transport_options: Optional[transport.TransportOptions] = None,
-    ) -> mdls.ServiceAccount:
-        """Update Service Account"""
-        user_id = self.encode_path_param(user_id)
-        response = cast(
-            mdls.ServiceAccount,
-            self.patch(
-                path=f"/users/service_accounts/{user_id}",
-                structure=mdls.ServiceAccount,
-                query_params={"fields": fields},
-                body=body,
-                transport_options=transport_options,
-            ),
-        )
-        return response
-
     # endregion
 
     # region UserAttribute: Manage User Attributes