looker-sdk 25.16.0__py3-none-any.whl → 25.20.0__py3-none-any.whl

looker_sdk/sdk/api40/methods.py

@@ -21,7 +21,7 @@
 # SOFTWARE.
 #
 
-# 472 API methods
+# 476 API methods
 
 
 # NOTE: Do not edit this file generated by Looker SDK Codegen for API 4.0
@@ -417,7 +417,10 @@ class Looker40SDK(api_methods.APIMethods):
     #
     # See 'login' for more detail on the access token and how to use it.
     #
-    # Calls to this endpoint may be denied by [Looker (Google Cloud core)](https://cloud.google.com/looker/docs/r/looker-core/overview).
+    # In [Looker (Google Cloud core)](https://cloud.google.com/looker/docs/r/looker-core/overview) this call will be denied unless all of the following criteria are met:
+    #   1. The calling user is an [API-only Service Account](https://cloud.google.com/looker/docs/looker-core-user-management#creating_an_api-only_service_account) with the Admin role
+    #   2. The target user is an [Embed User type](https://cloud.google.com/looker/docs/r/single-sign-on-embedding)
+    # Regular user types can not be impersonated in [Looker (Google Cloud core)](https://cloud.google.com/looker/docs/r/looker-core/overview). If your application needs to call the API for these users, use OAuth authentication instead.
     #
     # POST /login/{user_id} -> mdls.AccessToken
     def login_user(
@@ -5025,6 +5028,76 @@ class Looker40SDK(api_methods.APIMethods):
         )
         return response
 
+    # ### Search LookML Dashboards
+    #
+    # Returns an array of **LookML Dashboard** objects that match the specified search criteria.
+    # Note, this only returns LookML Dashboards in production.
+    #
+    # If multiple search params are given and `filter_or` is FALSE or not specified,
+    # search params are combined in a logical AND operation.
+    # Only rows that match *all* search param criteria will be returned.
+    #
+    # If `filter_or` is TRUE, multiple search params are combined in a logical OR operation.
+    # Results will include rows that match **any** of the search criteria.
+    #
+    # String search params use case-insensitive matching.
+    # String search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions.
+    # example="dan%" will match "danger" and "Danzig" but not "David"
+    # example="D_m%" will match "Damage" and "dump"
+    #
+    # Integer search params can accept a single value or a comma separated list of values. The multiple
+    # values will be combined under a logical OR operation - results will match at least one of
+    # the given values.
+    #
+    # Most search params can accept "IS NULL" and "NOT NULL" as special expressions to match
+    # or exclude (respectively) rows where the column is null.
+    #
+    # Boolean search params accept only "true" and "false" as values.
+    #
+    #
+    # The parameters `limit`, and `offset` are recommended for fetching results in page-size chunks.
+    #
+    # Get a **single LookML dashboard** by id with [dashboard_lookml()](#!/Dashboard/dashboard_lookml)
+    #
+    # GET /dashboards/lookml/search -> mdls.DashboardLookml
+    def search_lookml_dashboards(
+        self,
+        # Filter on a particular folder.
+        folder_id: Optional[str] = None,
+        # Match LookML Dashboard title.
+        title: Optional[str] = None,
+        # Filter on a content favorite id.
+        content_favorite_id: Optional[str] = None,
+        # Requested fields.
+        fields: Optional[str] = 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,
+        # One or more fields to sort by. Sortable fields: [:title, :id, :folder_id, :content_favorite_id, :content_metadata_id]
+        sorts: Optional[str] = None,
+        transport_options: Optional[transport.TransportOptions] = None,
+    ) -> mdls.DashboardLookml:
+        """Search LookML Dashboards"""
+        response = cast(
+            mdls.DashboardLookml,
+            self.get(
+                path="/dashboards/lookml/search",
+                structure=mdls.DashboardLookml,
+                query_params={
+                    "folder_id": folder_id,
+                    "title": title,
+                    "content_favorite_id": content_favorite_id,
+                    "fields": fields,
+                    "limit": limit,
+                    "offset": offset,
+                    "sorts": sorts,
+                },
+                transport_options=transport_options,
+            ),
+        )
+        return response
+
     # ### Get lookml of a UDD
     #
     # Returns a JSON object that contains the dashboard id and the full lookml
@@ -6981,6 +7054,30 @@ class Looker40SDK(api_methods.APIMethods):
         )
         return response
 
+    # Checks to see if the user is able to connect to their integration hub
+    #
+    # GET /integration_hubs/{integration_hub_id}/health -> mdls.IntegrationHubHealthResult
+    def get_integration_hub_health(
+        self,
+        # Id of integration_hub
+        integration_hub_id: str,
+        # Requested fields.
+        fields: Optional[str] = None,
+        transport_options: Optional[transport.TransportOptions] = None,
+    ) -> mdls.IntegrationHubHealthResult:
+        """Check the health of Integration Hub"""
+        integration_hub_id = self.encode_path_param(integration_hub_id)
+        response = cast(
+            mdls.IntegrationHubHealthResult,
+            self.get(
+                path=f"/integration_hubs/{integration_hub_id}/health",
+                structure=mdls.IntegrationHubHealthResult,
+                query_params={"fields": fields},
+                transport_options=transport_options,
+            ),
+        )
+        return response
+
     # Accepts the legal agreement for a given integration hub. This only works for integration hubs that have legal_agreement_required set to true and legal_agreement_signed set to false.
     #
     # POST /integration_hubs/{integration_hub_id}/accept_legal_agreement -> mdls.IntegrationHub
@@ -7540,6 +7637,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"""
@@ -7555,6 +7654,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,
             ),
@@ -10348,6 +10448,8 @@ class Looker40SDK(api_methods.APIMethods):
         fields: Optional[str] = None,
         # Optional list of ids to get specific roles.
         ids: Optional[mdls.DelimSequence[str]] = None,
+        # Get all Looker support roles.
+        get_all_support_roles: Optional[bool] = None,
         transport_options: Optional[transport.TransportOptions] = None,
     ) -> Sequence[mdls.Role]:
         """Get All Roles"""
@@ -10356,7 +10458,11 @@ class Looker40SDK(api_methods.APIMethods):
             self.get(
                 path="/roles",
                 structure=Sequence[mdls.Role],
-                query_params={"fields": fields, "ids": ids},
+                query_params={
+                    "fields": fields,
+                    "ids": ids,
+                    "get_all_support_roles": get_all_support_roles,
+                },
                 transport_options=transport_options,
             ),
         )
@@ -10426,8 +10532,6 @@ 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"""
@@ -10445,7 +10549,6 @@ 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,
             ),
@@ -12011,13 +12114,13 @@ class Looker40SDK(api_methods.APIMethods):
         first_name: Optional[str] = None,
         # Match Last name.
         last_name: Optional[str] = None,
-        # Search for user accounts associated with Looker employees
+        # Search for user accounts associated with Looker employees. Availability of this filter is limited to users with permission to view complete user details.
         verified_looker_employee: Optional[bool] = None,
         # Search for only embed users
         embed_user: Optional[bool] = None,
-        # Search for the user with this email address
+        # Search for the user with this email address. Availability of this filter is limited to users with permission to view complete user details.
         email: Optional[str] = None,
-        # Search for disabled user accounts
+        # Search for disabled user accounts. Availability of this filter is limited to users with permission to view complete user details.
         is_disabled: Optional[bool] = None,
         # Combine given search criteria in a boolean OR expression
         filter_or: Optional[bool] = None,
@@ -12025,8 +12128,10 @@ class Looker40SDK(api_methods.APIMethods):
         content_metadata_id: Optional[str] = None,
         # Search for users who are direct members of this group
         group_id: Optional[str] = None,
-        # Search for users who can manage API3 credentials
+        # 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.
+        is_service_account: Optional[bool] = None,
         transport_options: Optional[transport.TransportOptions] = None,
     ) -> Sequence[mdls.User]:
         """Search Users"""
@@ -12053,6 +12158,7 @@ class Looker40SDK(api_methods.APIMethods):
                     "content_metadata_id": content_metadata_id,
                     "group_id": group_id,
                     "can_manage_api3_creds": can_manage_api3_creds,
+                    "is_service_account": is_service_account,
                 },
                 transport_options=transport_options,
             ),
@@ -13270,6 +13376,61 @@ class Looker40SDK(api_methods.APIMethods):
         )
         return response
 
+    # ### 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,
+        body: mdls.WriteServiceAccount,
+        # Requested fields.
+        fields: Optional[str] = None,
+        transport_options: Optional[transport.TransportOptions] = None,
+    ) -> mdls.ServiceAccount:
+        """Create Service Account"""
+        response = cast(
+            mdls.ServiceAccount,
+            self.post(
+                path="/users/service_accounts",
+                structure=mdls.ServiceAccount,
+                query_params={"fields": fields},
+                body=body,
+                transport_options=transport_options,
+            ),
+        )
+        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