openapi

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

ChangeBasePath changes base path to allow switching to mocks

func (*APIClient) GetConfig ¶

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

func (*ApiAuthApiService) Login ¶

func (a *ApiAuthApiService) Login(ctx _context.Context, localVarOptionals *LoginOpts) (AccessToken, *_nethttp.Response, error)

Login Login ### Present client credentials to obtain an authorization token Looker API implements the OAuth2 [Resource Owner Password Credentials Grant](https://looker.com/docs/r/api/outh2_resource_owner_pc) pattern. The client credentials required for this login must be obtained by creating an API3 key on a user account in the Looker Admin console. The API3 key consists of a public `client_id` and a private `client_secret`. The access token returned by `login` must be used in the HTTP Authorization header of subsequent API requests, like this: ``` Authorization: token 4QDkCyCtZzYgj4C2p2cj3csJH7zqS5RzKs2kTnG4 ``` Replace \"4QDkCy...\" with the `access_token` value returned by `login`. The word `token` is a string literal and must be included exactly as shown. This function can accept `client_id` and `client_secret` parameters as URL query params or as www-form-urlencoded params in the body of the HTTP request. Since there is a small risk that URL parameters may be visible to intermediate nodes on the network route (proxies, routers, etc), passing credentials in the body of the request is considered more secure than URL params. Example of passing credentials in the HTTP request body: ```` POST HTTP /login Content-Type: application/x-www-form-urlencoded client_id=CGc9B7v7J48dQSJvxxx&client_secret=nNVS9cSS3xNpSC9JdsBvvvvv ```` ### Best Practice: Always pass credentials in body params. Pass credentials in URL query params **only** when you cannot pass body params due to application, tool, or other limitations. For more information and detailed examples of Looker API authorization, see [How to Authenticate to Looker API3](https://github.com/looker/looker-sdk-ruby/blob/master/authentication.md).

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *LoginOpts - Optional Parameters:
• @param "ClientId" (optional.String) - client_id part of API3 Key.
• @param "ClientSecret" (optional.String) - client_secret part of API3 Key.

@return AccessToken

func (*ApiAuthApiService) LoginUser ¶

func (a *ApiAuthApiService) LoginUser(ctx _context.Context, userId int64) (AccessToken, *_nethttp.Response, error)

LoginUser Login user ### Create an access token for a given user. This can only be called by an authenticated admin user. It allows that admin to generate a new authentication token for the user with the given user id. That token can then be used for subsequent API calls - which are then performed *as* that target user. The target user does *not* need to have a pre-existing API client_id/client_secret pair. And, no such credentials are created by this call. This allows for building systems where api user authentication for an arbitrary number of users is done outside of Looker and funneled through a single 'service account' with admin permissions. Note that a new access token is generated on each call. If target users are going to be making numerous API calls in a short period then it is wise to cache this authentication token rather than call this before each of those API calls. See 'login' for more detail on the access token and how to use it.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param userId Id of user.

@return AccessToken

func (*ApiAuthApiService) Logout ¶

func (a *ApiAuthApiService) Logout(ctx _context.Context) (string, *_nethttp.Response, error)

Logout Logout ### Logout of the API and invalidate the current access token.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return string

func (*AuthApiService) AllUserLoginLockouts ¶

func (a *AuthApiService) AllUserLoginLockouts(ctx _context.Context, localVarOptionals *AllUserLoginLockoutsOpts) ([]UserLoginLockout, *_nethttp.Response, error)

AllUserLoginLockouts Get All User Login Lockouts ### Get currently locked-out users.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *AllUserLoginLockoutsOpts - Optional Parameters:
• @param "Fields" (optional.String) - Include only these fields in the response

@return []UserLoginLockout

func (*AuthApiService) CreateOidcTestConfig ¶

func (a *AuthApiService) CreateOidcTestConfig(ctx _context.Context, body OidcConfig) (OidcConfig, *_nethttp.Response, error)

CreateOidcTestConfig Create OIDC Test Configuration ### Create a OIDC test configuration.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body OIDC test config

@return OidcConfig

func (*AuthApiService) CreateSamlTestConfig ¶

func (a *AuthApiService) CreateSamlTestConfig(ctx _context.Context, body SamlConfig) (SamlConfig, *_nethttp.Response, error)

CreateSamlTestConfig Create SAML Test Configuration ### Create a SAML test configuration.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body SAML test config

@return SamlConfig

func (*AuthApiService) CreateSsoEmbedUrl ¶

func (a *AuthApiService) CreateSsoEmbedUrl(ctx _context.Context, body EmbedSsoUrlParams) (EmbedSsoUrl, *_nethttp.Response, error)

CreateSsoEmbedUrl Create SSO Embed Url ### Create SSO Embed URL Creates an SSO embed URL and cryptographically signs it with an embed secret. This signed URL can then be used to instantiate a Looker embed session in a PBL web application. Do not make any modifications to this URL - any change may invalidate the signature and cause the URL to fail to load a Looker embed session. A signed SSO embed URL can only be used once. After it has been used to request a page from the Looker server, the URL is invalid. Future requests using the same URL will fail. This is to prevent 'replay attacks'. The `target_url` property must be a complete URL of a Looker UI page - scheme, hostname, path and query params. To load a dashboard with id 56 and with a filter of `Date=1 years`, the looker URL would look like `https:/myname.looker.com/dashboards/56?Date=1%20years`. The best way to obtain this target_url is to navigate to the desired Looker page in your web browser, copy the URL shown in the browser address bar and paste it into the `target_url` property as a quoted string value in this API request. Permissions for the embed user are defined by the groups in which the embed user is a member (group_ids property) and the lists of models and permissions assigned to the embed user. At a minimum, you must provide values for either the group_ids property, or both the models and permissions properties. These properties are additive; an embed user can be a member of certain groups AND be granted access to models and permissions. The embed user's access is the union of permissions granted by the group_ids, models, and permissions properties. This function does not strictly require all group_ids, user attribute names, or model names to exist at the moment the SSO embed url is created. Unknown group_id, user attribute names or model names will be passed through to the output URL. 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 `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 newest active secret defined in the Looker instance. #### Security Note Protect this signed URL as you would an access token or password credentials - do not write it to disk, do not pass it to a third party, and only pass it through a secure HTTPS encrypted transport.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body SSO parameters

@return EmbedSsoUrl

func (*AuthApiService) DeleteOidcTestConfig ¶

func (a *AuthApiService) DeleteOidcTestConfig(ctx _context.Context, testSlug string) (string, *_nethttp.Response, error)

DeleteOidcTestConfig Delete OIDC Test Configuration ### Delete a OIDC test configuration.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param testSlug Slug of test config

@return string

func (*AuthApiService) DeleteSamlTestConfig ¶

func (a *AuthApiService) DeleteSamlTestConfig(ctx _context.Context, testSlug string) (string, *_nethttp.Response, error)

DeleteSamlTestConfig Delete SAML Test Configuration ### Delete a SAML test configuration.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param testSlug Slug of test config

@return string

func (*AuthApiService) DeleteUserLoginLockout ¶

func (a *AuthApiService) DeleteUserLoginLockout(ctx _context.Context, key string) (string, *_nethttp.Response, error)

DeleteUserLoginLockout Delete User Login Lockout ### Removes login lockout for the associated user.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param key The key associated with the locked user

@return string

func (*AuthApiService) FetchAndParseSamlIdpMetadata ¶

func (a *AuthApiService) FetchAndParseSamlIdpMetadata(ctx _context.Context, body string) (SamlMetadataParseResult, *_nethttp.Response, error)

FetchAndParseSamlIdpMetadata Parse SAML IdP Url ### Fetch the given url and parse it as a SAML IdP metadata document and return the result. Note that this requires that the url be public or at least at a location where the Looker instance can fetch it without requiring any special authentication.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body SAML IdP metadata public url

@return SamlMetadataParseResult

func (*AuthApiService) ForcePasswordResetAtNextLoginForAllUsers ¶

func (a *AuthApiService) ForcePasswordResetAtNextLoginForAllUsers(ctx _context.Context) (string, *_nethttp.Response, error)

ForcePasswordResetAtNextLoginForAllUsers Force password reset ### Force all credentials_email users to reset their login passwords upon their next login.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return string

func (*AuthApiService) LdapConfig ¶

func (a *AuthApiService) LdapConfig(ctx _context.Context) (LdapConfig, *_nethttp.Response, error)

LdapConfig Get LDAP Configuration ### Get the LDAP configuration. Looker can be optionally configured to authenticate users against an Active Directory or other LDAP directory server. LDAP setup requires coordination with an administrator of that directory server. Only Looker administrators can read and update the LDAP configuration. Configuring LDAP impacts authentication for all users. This configuration should be done carefully. Looker maintains a single LDAP configuration. It can be read and updated. Updates only succeed if the new state will be valid (in the sense that all required fields are populated); it is up to you to ensure that the configuration is appropriate and correct). LDAP is enabled or disabled for Looker using the **enabled** field. Looker will never return an **auth_password** field. That value can be set, but never retrieved. See the [Looker LDAP docs](https://www.looker.com/docs/r/api/ldap_setup) for additional information.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return LdapConfig

func (*AuthApiService) OidcConfig ¶

func (a *AuthApiService) OidcConfig(ctx _context.Context) (OidcConfig, *_nethttp.Response, error)

OidcConfig Get OIDC Configuration ### Get the OIDC configuration. Looker can be optionally configured to authenticate users against an OpenID Connect (OIDC) authentication server. OIDC setup requires coordination with an administrator of that server. Only Looker administrators can read and update the OIDC configuration. Configuring OIDC impacts authentication for all users. This configuration should be done carefully. Looker maintains a single OIDC configuation. It can be read and updated. Updates only succeed if the new state will be valid (in the sense that all required fields are populated); it is up to you to ensure that the configuration is appropriate and correct). OIDC is enabled or disabled for Looker using the **enabled** field.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return OidcConfig

func (*AuthApiService) OidcTestConfig ¶

func (a *AuthApiService) OidcTestConfig(ctx _context.Context, testSlug string) (OidcConfig, *_nethttp.Response, error)

OidcTestConfig Get OIDC Test Configuration ### Get a OIDC test configuration by test_slug.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param testSlug Slug of test config

@return OidcConfig

func (*AuthApiService) ParseSamlIdpMetadata ¶

func (a *AuthApiService) ParseSamlIdpMetadata(ctx _context.Context, body string) (SamlMetadataParseResult, *_nethttp.Response, error)

ParseSamlIdpMetadata Parse SAML IdP XML ### Parse the given xml as a SAML IdP metadata document and return the result.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body SAML IdP metadata xml

@return SamlMetadataParseResult

func (*AuthApiService) PasswordConfig ¶

func (a *AuthApiService) PasswordConfig(ctx _context.Context) (PasswordConfig, *_nethttp.Response, error)

PasswordConfig Get Password Config ### Get password config.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return PasswordConfig

func (*AuthApiService) SamlConfig ¶

func (a *AuthApiService) SamlConfig(ctx _context.Context) (SamlConfig, *_nethttp.Response, error)

SamlConfig Get SAML Configuration ### Get the SAML configuration. Looker can be optionally configured to authenticate users against a SAML authentication server. SAML setup requires coordination with an administrator of that server. Only Looker administrators can read and update the SAML configuration. Configuring SAML impacts authentication for all users. This configuration should be done carefully. Looker maintains a single SAML configuation. It can be read and updated. Updates only succeed if the new state will be valid (in the sense that all required fields are populated); it is up to you to ensure that the configuration is appropriate and correct). SAML is enabled or disabled for Looker using the **enabled** field.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return SamlConfig

func (*AuthApiService) SamlTestConfig ¶

func (a *AuthApiService) SamlTestConfig(ctx _context.Context, testSlug string) (SamlConfig, *_nethttp.Response, error)

SamlTestConfig Get SAML Test Configuration ### Get a SAML test configuration by test_slug.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param testSlug Slug of test config

@return SamlConfig

func (*AuthApiService) SearchUserLoginLockouts ¶

func (a *AuthApiService) SearchUserLoginLockouts(ctx _context.Context, localVarOptionals *SearchUserLoginLockoutsOpts) ([]UserLoginLockout, *_nethttp.Response, error)

SearchUserLoginLockouts Search User Login Lockouts ### Search currently locked-out users.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *SearchUserLoginLockoutsOpts - Optional Parameters:
• @param "Fields" (optional.String) - Include only these fields in the response
• @param "Page" (optional.Int64) - Return only page N of paginated results
• @param "PerPage" (optional.Int64) - Return N rows of data per page
• @param "Sorts" (optional.String) - Fields to sort by.
• @param "AuthType" (optional.String) - Auth type user is locked out for (email, ldap, totp, api)
• @param "FullName" (optional.String) - Match name
• @param "Email" (optional.String) - Match email
• @param "RemoteId" (optional.String) - Match remote LDAP ID
• @param "FilterOr" (optional.Bool) - Combine given search criteria in a boolean OR expression

@return []UserLoginLockout

func (*AuthApiService) SessionConfig ¶

func (a *AuthApiService) SessionConfig(ctx _context.Context) (SessionConfig, *_nethttp.Response, error)

SessionConfig Get Session Config ### Get session config.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return SessionConfig

func (*AuthApiService) TestLdapConfigAuth ¶

func (a *AuthApiService) TestLdapConfigAuth(ctx _context.Context, body LdapConfig) (LdapConfigTestResult, *_nethttp.Response, error)

TestLdapConfigAuth Test LDAP Auth ### Test the connection authentication settings for an LDAP configuration. This tests that the connection is possible and that a 'server' account to be used by Looker can authenticate to the LDAP server given connection and authentication information. **connection_host**, **connection_port**, and **auth_username**, are required. **connection_tls** and **auth_password** are optional. Example: ```json { \"connection_host\": \"ldap.example.com\", \"connection_port\": \"636\", \"connection_tls\": true, \"auth_username\": \"cn=looker,dc=example,dc=com\", \"auth_password\": \"secret\" } ``` Looker will never return an **auth_password**. If this request omits the **auth_password** field, then the **auth_password** value from the active config (if present) will be used for the test. The active LDAP settings are not modified.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body LDAP Config

@return LdapConfigTestResult

func (*AuthApiService) TestLdapConfigConnection ¶

func (a *AuthApiService) TestLdapConfigConnection(ctx _context.Context, body LdapConfig) (LdapConfigTestResult, *_nethttp.Response, error)

TestLdapConfigConnection Test LDAP Connection ### Test the connection settings for an LDAP configuration. This tests that the connection is possible given a connection_host and connection_port. **connection_host** and **connection_port** are required. **connection_tls** is optional. Example: ```json { \"connection_host\": \"ldap.example.com\", \"connection_port\": \"636\", \"connection_tls\": true } ``` No authentication to the LDAP server is attempted. The active LDAP settings are not modified.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body LDAP Config

@return LdapConfigTestResult

func (*AuthApiService) TestLdapConfigUserAuth ¶

func (a *AuthApiService) TestLdapConfigUserAuth(ctx _context.Context, body LdapConfig) (LdapConfigTestResult, *_nethttp.Response, error)

TestLdapConfigUserAuth Test LDAP User Auth ### Test the user authentication settings for an LDAP configuration. This test accepts a full LDAP configuration along with a username/password pair and attempts to authenticate the user with the LDAP server. The configuration is validated before attempting the authentication. Looker will never return an **auth_password**. If this request omits the **auth_password** field, then the **auth_password** value from the active config (if present) will be used for the test. **test_ldap_user** and **test_ldap_password** are required. The active LDAP settings are not modified.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body LDAP Config

@return LdapConfigTestResult

func (*AuthApiService) TestLdapConfigUserInfo ¶

func (a *AuthApiService) TestLdapConfigUserInfo(ctx _context.Context, body LdapConfig) (LdapConfigTestResult, *_nethttp.Response, error)

TestLdapConfigUserInfo Test LDAP User Info ### Test the user authentication settings for an LDAP configuration without authenticating the user. This test will let you easily test the mapping for user properties and roles for any user without needing to authenticate as that user. This test accepts a full LDAP configuration along with a username and attempts to find the full info for the user from the LDAP server without actually authenticating the user. So, user password is not required.The configuration is validated before attempting to contact the server. **test_ldap_user** is required. The active LDAP settings are not modified.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body LDAP Config

@return LdapConfigTestResult

func (*AuthApiService) UpdateLdapConfig ¶

func (a *AuthApiService) UpdateLdapConfig(ctx _context.Context, body LdapConfig) (LdapConfig, *_nethttp.Response, error)

UpdateLdapConfig Update LDAP Configuration ### Update the LDAP configuration. Configuring LDAP impacts authentication for all users. This configuration should be done carefully. Only Looker administrators can read and update the LDAP configuration. LDAP is enabled or disabled for Looker using the **enabled** field. It is **highly** recommended that any LDAP setting changes be tested using the APIs below before being set globally. See the [Looker LDAP docs](https://www.looker.com/docs/r/api/ldap_setup) for additional information.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body LDAP Config

@return LdapConfig

func (*AuthApiService) UpdateOidcConfig ¶

func (a *AuthApiService) UpdateOidcConfig(ctx _context.Context, body OidcConfig) (OidcConfig, *_nethttp.Response, error)

UpdateOidcConfig Update OIDC Configuration ### Update the OIDC configuration. Configuring OIDC impacts authentication for all users. This configuration should be done carefully. Only Looker administrators can read and update the OIDC configuration. OIDC is enabled or disabled for Looker using the **enabled** field. It is **highly** recommended that any OIDC setting changes be tested using the APIs below before being set globally.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body OIDC Config

@return OidcConfig

func (*AuthApiService) UpdatePasswordConfig ¶

func (a *AuthApiService) UpdatePasswordConfig(ctx _context.Context, body PasswordConfig) (PasswordConfig, *_nethttp.Response, error)

UpdatePasswordConfig Update Password Config ### Update password config.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body Password Config

@return PasswordConfig

func (*AuthApiService) UpdateSamlConfig ¶

func (a *AuthApiService) UpdateSamlConfig(ctx _context.Context, body SamlConfig) (SamlConfig, *_nethttp.Response, error)

UpdateSamlConfig Update SAML Configuration ### Update the SAML configuration. Configuring SAML impacts authentication for all users. This configuration should be done carefully. Only Looker administrators can read and update the SAML configuration. SAML is enabled or disabled for Looker using the **enabled** field. It is **highly** recommended that any SAML setting changes be tested using the APIs below before being set globally.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body SAML Config

@return SamlConfig

func (*AuthApiService) UpdateSessionConfig ¶

func (a *AuthApiService) UpdateSessionConfig(ctx _context.Context, body SessionConfig) (SessionConfig, *_nethttp.Response, error)

UpdateSessionConfig Update Session Config ### Update session config.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body Session Config

@return SessionConfig

func (*ColorCollectionApiService) AllColorCollections ¶

func (a *ColorCollectionApiService) AllColorCollections(ctx _context.Context, localVarOptionals *AllColorCollectionsOpts) ([]ColorCollection, *_nethttp.Response, error)

AllColorCollections Get all Color Collections ### Get an array of all existing Color Collections Get a **single** color collection by id with ColorCollection(#!/ColorCollection/color_collection) Get all **standard** color collections with ColorCollection(#!/ColorCollection/color_collections_standard) Get all **custom** color collections with ColorCollection(#!/ColorCollection/color_collections_custom) **Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *AllColorCollectionsOpts - Optional Parameters:
• @param "Fields" (optional.String) - Requested fields.

@return []ColorCollection

func (*ColorCollectionApiService) ColorCollection ¶

func (a *ColorCollectionApiService) ColorCollection(ctx _context.Context, collectionId string, localVarOptionals *ColorCollectionOpts) (ColorCollection, *_nethttp.Response, error)

ColorCollection Get Color Collection by ID ### Get a Color Collection by ID Use this to retrieve a specific Color Collection. Get a **single** color collection by id with ColorCollection(#!/ColorCollection/color_collection) Get all **standard** color collections with ColorCollection(#!/ColorCollection/color_collections_standard) Get all **custom** color collections with ColorCollection(#!/ColorCollection/color_collections_custom) **Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param collectionId Id of Color Collection
• @param optional nil or *ColorCollectionOpts - Optional Parameters:
• @param "Fields" (optional.String) - Requested fields.

@return ColorCollection

func (*ColorCollectionApiService) ColorCollectionsCustom ¶

func (a *ColorCollectionApiService) ColorCollectionsCustom(ctx _context.Context, localVarOptionals *ColorCollectionsCustomOpts) ([]ColorCollection, *_nethttp.Response, error)

ColorCollectionsCustom Get all Custom Color Collections ### Get an array of all existing **Custom** Color Collections Get a **single** color collection by id with ColorCollection(#!/ColorCollection/color_collection) Get all **standard** color collections with ColorCollection(#!/ColorCollection/color_collections_standard) **Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *ColorCollectionsCustomOpts - Optional Parameters:
• @param "Fields" (optional.String) - Requested fields.

@return []ColorCollection

func (*ColorCollectionApiService) ColorCollectionsStandard ¶

func (a *ColorCollectionApiService) ColorCollectionsStandard(ctx _context.Context, localVarOptionals *ColorCollectionsStandardOpts) ([]ColorCollection, *_nethttp.Response, error)

ColorCollectionsStandard Get all Standard Color Collections ### Get an array of all existing **Standard** Color Collections Get a **single** color collection by id with ColorCollection(#!/ColorCollection/color_collection) Get all **custom** color collections with ColorCollection(#!/ColorCollection/color_collections_custom) **Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *ColorCollectionsStandardOpts - Optional Parameters:
• @param "Fields" (optional.String) - Requested fields.

@return []ColorCollection

func (*ColorCollectionApiService) CreateColorCollection ¶

func (a *ColorCollectionApiService) CreateColorCollection(ctx _context.Context, body ColorCollection) (ColorCollection, *_nethttp.Response, error)

CreateColorCollection Create ColorCollection ### Create a custom color collection with the specified information Creates a new custom color collection object, returning the details, including the created id. **Update** an existing color collection with [Update Color Collection](#!/ColorCollection/update_color_collection) **Permanently delete** an existing custom color collection with [Delete Color Collection](#!/ColorCollection/delete_color_collection) **Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body ColorCollection

@return ColorCollection

func (*ColorCollectionApiService) DefaultColorCollection ¶

func (a *ColorCollectionApiService) DefaultColorCollection(ctx _context.Context) (ColorCollection, *_nethttp.Response, error)

DefaultColorCollection Get Default Color Collection ### Get the default color collection Use this to retrieve the default Color Collection. Set the default color collection with ColorCollection(#!/ColorCollection/set_default_color_collection)

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ColorCollection

func (*ColorCollectionApiService) DeleteColorCollection ¶

func (a *ColorCollectionApiService) DeleteColorCollection(ctx _context.Context, collectionId string) (*_nethttp.Response, error)

DeleteColorCollection Delete ColorCollection ### Delete a custom color collection by id This operation permanently deletes the identified **Custom** color collection. **Standard** color collections cannot be deleted Because multiple color collections can have the same label, they must be deleted by ID, not name. **Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param collectionId Id of Color Collection

func (*ColorCollectionApiService) SetDefaultColorCollection ¶

func (a *ColorCollectionApiService) SetDefaultColorCollection(ctx _context.Context, collectionId string) (ColorCollection, *_nethttp.Response, error)

SetDefaultColorCollection Set Default Color Collection ### Set the global default Color Collection by ID Returns the new specified default Color Collection object. **Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param collectionId ID of color collection to set as default

@return ColorCollection

func (*ColorCollectionApiService) UpdateColorCollection ¶

func (a *ColorCollectionApiService) UpdateColorCollection(ctx _context.Context, collectionId string, body ColorCollection) (ColorCollection, *_nethttp.Response, error)

UpdateColorCollection Update Custom Color collection ### Update a custom color collection by id. **Note**: Only an API user with the Admin role can call this endpoint. Unauthorized requests will return `Not Found` (404) errors.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param collectionId Id of Custom Color Collection
• @param body ColorCollection

@return ColorCollection

func (*ConfigApiService) AllLegacyFeatures ¶

func (a *ConfigApiService) AllLegacyFeatures(ctx _context.Context) ([]LegacyFeature, *_nethttp.Response, error)

AllLegacyFeatures Get All Legacy Features ### Get all legacy features.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []LegacyFeature

func (*ConfigApiService) AllLocales ¶

func (a *ConfigApiService) AllLocales(ctx _context.Context) ([]Locale, *_nethttp.Response, error)

AllLocales Get All Locales ### Get a list of locales that Looker supports.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Locale

func (*ConfigApiService) AllTimezones ¶

func (a *ConfigApiService) AllTimezones(ctx _context.Context) ([]Timezone, *_nethttp.Response, error)

AllTimezones Get All Timezones ### Get a list of timezones that Looker supports (e.g. useful for scheduling tasks).

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []Timezone

func (*ConfigApiService) BackupConfiguration ¶

func (a *ConfigApiService) BackupConfiguration(ctx _context.Context) (BackupConfiguration, *_nethttp.Response, error)

BackupConfiguration Get Backup Configuration ### Get the current Looker internal database backup configuration.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return BackupConfiguration

func (*ConfigApiService) CustomWelcomeEmail ¶

func (a *ConfigApiService) CustomWelcomeEmail(ctx _context.Context) (CustomWelcomeEmail, *_nethttp.Response, error)

CustomWelcomeEmail Get Custom Welcome Email ### Get the current status and content of custom welcome emails

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return CustomWelcomeEmail

func (*ConfigApiService) InternalHelpResources ¶

func (a *ConfigApiService) InternalHelpResources(ctx _context.Context) (InternalHelpResources, *_nethttp.Response, error)

InternalHelpResources Get Internal Help Resources ### Get and set the options for internal help resources

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return InternalHelpResources

func (*ConfigApiService) InternalHelpResourcesContent ¶

func (a *ConfigApiService) InternalHelpResourcesContent(ctx _context.Context) (InternalHelpResourcesContent, *_nethttp.Response, error)

InternalHelpResourcesContent Get Internal Help Resources Content ### Set the menu item name and content for internal help resources

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return InternalHelpResourcesContent

func (*ConfigApiService) LegacyFeature ¶

func (a *ConfigApiService) LegacyFeature(ctx _context.Context, legacyFeatureId int64) (LegacyFeature, *_nethttp.Response, error)

LegacyFeature Get Legacy Feature ### Get information about the legacy feature with a specific id.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param legacyFeatureId id of legacy feature

@return LegacyFeature

func (*ConfigApiService) UpdateBackupConfiguration ¶

func (a *ConfigApiService) UpdateBackupConfiguration(ctx _context.Context, body BackupConfiguration) (BackupConfiguration, *_nethttp.Response, error)

UpdateBackupConfiguration Update Backup Configuration ### Update the Looker internal database backup configuration.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body Options for Backup Configuration

@return BackupConfiguration

func (*ConfigApiService) UpdateCustomWelcomeEmail ¶

func (a *ConfigApiService) UpdateCustomWelcomeEmail(ctx _context.Context, body CustomWelcomeEmail, localVarOptionals *UpdateCustomWelcomeEmailOpts) (CustomWelcomeEmail, *_nethttp.Response, error)

UpdateCustomWelcomeEmail Update Custom Welcome Email Content Update custom welcome email setting and values. Optionally send a test email with the new content to the currently logged in user.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body Custom Welcome Email setting and value to save
• @param optional nil or *UpdateCustomWelcomeEmailOpts - Optional Parameters:
• @param "SendTestWelcomeEmail" (optional.Bool) - If true a test email with the content from the request will be sent to the current user after saving

@return CustomWelcomeEmail

func (*ConfigApiService) UpdateCustomWelcomeEmailTest ¶

func (a *ConfigApiService) UpdateCustomWelcomeEmailTest(ctx _context.Context, body WelcomeEmailTest) (WelcomeEmailTest, *_nethttp.Response, error)

UpdateCustomWelcomeEmailTest Send a test welcome email to the currently logged in user with the supplied content Requests to this endpoint will send a welcome email with the custom content provided in the body to the currently logged in user.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body Body of the email to be sent.

@return WelcomeEmailTest

func (*ConfigApiService) UpdateInternalHelpResources ¶

func (a *ConfigApiService) UpdateInternalHelpResources(ctx _context.Context, body InternalHelpResources) (InternalHelpResources, *_nethttp.Response, error)

UpdateInternalHelpResources Update internal help resources configuration Update internal help resources settings

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body Custom Welcome Email

@return InternalHelpResources

func (*ConfigApiService) UpdateInternalHelpResourcesContent ¶

func (a *ConfigApiService) UpdateInternalHelpResourcesContent(ctx _context.Context, body InternalHelpResourcesContent) (InternalHelpResourcesContent, *_nethttp.Response, error)

UpdateInternalHelpResourcesContent Update internal help resources content Update internal help resources content

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body Internal Help Resources Content

@return InternalHelpResourcesContent

func (*ConfigApiService) UpdateLegacyFeature ¶

func (a *ConfigApiService) UpdateLegacyFeature(ctx _context.Context, legacyFeatureId int64, body LegacyFeature) (LegacyFeature, *_nethttp.Response, error)

UpdateLegacyFeature Update Legacy Feature ### Update information about the legacy feature with a specific id.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param legacyFeatureId id of legacy feature
• @param body Legacy Feature

@return LegacyFeature

func (*ConfigApiService) UpdateWhitelabelConfiguration ¶

func (a *ConfigApiService) UpdateWhitelabelConfiguration(ctx _context.Context, body WhitelabelConfiguration) (WhitelabelConfiguration, *_nethttp.Response, error)

UpdateWhitelabelConfiguration Update Whitelabel configuration ### Update the whitelabel configuration

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body Whitelabel configuration

@return WhitelabelConfiguration

func (*ConfigApiService) Versions ¶

func (a *ConfigApiService) Versions(ctx _context.Context, localVarOptionals *VersionsOpts) (ApiVersion, *_nethttp.Response, error)

Versions Get ApiVersion ### Get information about all API versions supported by this Looker instance.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *VersionsOpts - Optional Parameters:
• @param "Fields" (optional.String) - Requested fields.

@return ApiVersion

func (*ConfigApiService) WhitelabelConfiguration ¶

func (a *ConfigApiService) WhitelabelConfiguration(ctx _context.Context, localVarOptionals *WhitelabelConfigurationOpts) (WhitelabelConfiguration, *_nethttp.Response, error)

WhitelabelConfiguration Get Whitelabel configuration ### This feature is enabled only by special license. ### Gets the whitelabel configuration, which includes hiding documentation links, custom favicon uploading, etc.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *WhitelabelConfigurationOpts - Optional Parameters:
• @param "Fields" (optional.String) - Requested fields.

@return WhitelabelConfiguration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerUrl ¶

func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)

ServerUrl returns URL based on server settings

func (*ConnectionApiService) AllConnections ¶

func (a *ConnectionApiService) AllConnections(ctx _context.Context, localVarOptionals *AllConnectionsOpts) ([]DbConnection, *_nethttp.Response, error)

AllConnections Get All Connections ### Get information about all connections.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *AllConnectionsOpts - Optional Parameters:
• @param "Fields" (optional.String) - Requested fields.

@return []DbConnection

func (*ConnectionApiService) AllDialectInfos ¶

func (a *ConnectionApiService) AllDialectInfos(ctx _context.Context, localVarOptionals *AllDialectInfosOpts) ([]DialectInfo, *_nethttp.Response, error)

AllDialectInfos Get All Dialect Infos ### Get information about all dialects.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *AllDialectInfosOpts - Optional Parameters:
• @param "Fields" (optional.String) - Requested fields.

@return []DialectInfo

func (*ConnectionApiService) Connection ¶

func (a *ConnectionApiService) Connection(ctx _context.Context, connectionName string, localVarOptionals *ConnectionOpts) (DbConnection, *_nethttp.Response, error)

Connection Get Connection ### Get information about a connection.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param connectionName Name of connection
• @param optional nil or *ConnectionOpts - Optional Parameters:
• @param "Fields" (optional.String) - Requested fields.

@return DbConnection

func (*ConnectionApiService) CreateConnection ¶

func (a *ConnectionApiService) CreateConnection(ctx _context.Context, body DbConnection) (DbConnection, *_nethttp.Response, error)

CreateConnection Create Connection ### Create a connection using the specified configuration.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body Connection

@return DbConnection

func (*ConnectionApiService) DeleteConnection ¶

func (a *ConnectionApiService) DeleteConnection(ctx _context.Context, connectionName string) (string, *_nethttp.Response, error)

DeleteConnection Delete Connection ### Delete a connection.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param connectionName Name of connection

@return string

func (*ConnectionApiService) DeleteConnectionOverride ¶

func (a *ConnectionApiService) DeleteConnectionOverride(ctx _context.Context, connectionName string, overrideContext string) (string, *_nethttp.Response, error)

DeleteConnectionOverride Delete Connection Override ### Delete a connection override.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param connectionName Name of connection
• @param overrideContext Context of connection override

@return string

func (*ConnectionApiService) TestConnection ¶

func (a *ConnectionApiService) TestConnection(ctx _context.Context, connectionName string, localVarOptionals *TestConnectionOpts) ([]DbConnectionTestResult, *_nethttp.Response, error)

TestConnection Test Connection ### Test an existing connection. Note that a connection's 'dialect' property has a 'connection_tests' property that lists the specific types of tests that the connection supports. This API is rate limited. Unsupported tests in the request will be ignored.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param connectionName Name of connection
• @param optional nil or *TestConnectionOpts - Optional Parameters:
• @param "Tests" (optional.Interface of []string) - Array of names of tests to run

@return []DbConnectionTestResult

func (*ConnectionApiService) TestConnectionConfig ¶

func (a *ConnectionApiService) TestConnectionConfig(ctx _context.Context, body DbConnection, localVarOptionals *TestConnectionConfigOpts) ([]DbConnectionTestResult, *_nethttp.Response, error)

TestConnectionConfig Test Connection Configuration ### Test a connection configuration. Note that a connection's 'dialect' property has a 'connection_tests' property that lists the specific types of tests that the connection supports. This API is rate limited. Unsupported tests in the request will be ignored.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body Connection
• @param optional nil or *TestConnectionConfigOpts - Optional Parameters:
• @param "Tests" (optional.Interface of []string) - Array of names of tests to run

@return []DbConnectionTestResult

func (*ConnectionApiService) UpdateConnection ¶

func (a *ConnectionApiService) UpdateConnection(ctx _context.Context, connectionName string, body DbConnection) (DbConnection, *_nethttp.Response, error)

UpdateConnection Update Connection ### Update a connection using the specified configuration.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param connectionName Name of connection
• @param body Connection

@return DbConnection

func (*ContentApiService) AllContentMetadataAccesses ¶

func (a *ContentApiService) AllContentMetadataAccesses(ctx _context.Context, contentMetadataId int64, localVarOptionals *AllContentMetadataAccessesOpts) ([]ContentMetaGroupUser, *_nethttp.Response, error)

AllContentMetadataAccesses Get All Content Metadata Accesses ### All content metadata access records for a content metadata item.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param contentMetadataId Id of content metadata
• @param optional nil or *AllContentMetadataAccessesOpts - Optional Parameters:
• @param "Fields" (optional.String) - Requested fields.

@return []ContentMetaGroupUser

func (*ContentApiService) AllContentMetadatas ¶

func (a *ContentApiService) AllContentMetadatas(ctx _context.Context, parentId int64, localVarOptionals *AllContentMetadatasOpts) ([]ContentMeta, *_nethttp.Response, error)

AllContentMetadatas Get All Content Metadatas ### Get information about all content metadata in a space.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param parentId Parent space of content.
• @param optional nil or *AllContentMetadatasOpts - Optional Parameters:
• @param "Fields" (optional.String) - Requested fields.

@return []ContentMeta

func (*ContentApiService) ContentFavorite ¶

func (a *ContentApiService) ContentFavorite(ctx _context.Context, contentFavoriteId int64, localVarOptionals *ContentFavoriteOpts) (ContentFavorite, *_nethttp.Response, error)

ContentFavorite Get Favorite Content ### Get favorite content by its id

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param contentFavoriteId Id of favorite content
• @param optional nil or *ContentFavoriteOpts - Optional Parameters:
• @param "Fields" (optional.String) - Requested fields.

@return ContentFavorite

func (*ContentApiService) ContentMetadata ¶

func (a *ContentApiService) ContentMetadata(ctx _context.Context, contentMetadataId int64, localVarOptionals *ContentMetadataOpts) (ContentMeta, *_nethttp.Response, error)

ContentMetadata Get Content Metadata ### Get information about an individual content metadata record.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param contentMetadataId Id of content metadata
• @param optional nil or *ContentMetadataOpts - Optional Parameters:
• @param "Fields" (optional.String) - Requested fields.

@return ContentMeta

func (*ContentApiService) ContentValidation ¶

func (a *ContentApiService) ContentValidation(ctx _context.Context, localVarOptionals *ContentValidationOpts) (ContentValidation, *_nethttp.Response, error)

ContentValidation Validate Content ### Validate All Content Requires Content Validation Labs Feature be enabled Performs validation of all looks and dashboards Returns a list of errors found as well as metadata about the content validation run.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *ContentValidationOpts - Optional Parameters:
• @param "Fields" (optional.String) - Requested fields.

@return ContentValidation

func (*ContentApiService) CreateContentFavorite ¶

func (a *ContentApiService) CreateContentFavorite(ctx _context.Context, body ContentFavorite) (ContentFavorite, *_nethttp.Response, error)

CreateContentFavorite Create Favorite Content ### Create favorite content

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body Favorite Content

@return ContentFavorite

func (*ContentApiService) CreateContentMetadataAccess ¶

func (a *ContentApiService) CreateContentMetadataAccess(ctx _context.Context, body ContentMetaGroupUser, localVarOptionals *CreateContentMetadataAccessOpts) (ContentMetaGroupUser, *_nethttp.Response, error)

CreateContentMetadataAccess Create Content Metadata Access ### Create content metadata access.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param body Content Metadata Access
• @param optional nil or *CreateContentMetadataAccessOpts - Optional Parameters:
• @param "SendBoardsNotificationEmail" (optional.Bool) - Optionally sends notification email when granting access to a board.

@return ContentMetaGroupUser

func (*ContentApiService) DeleteContentFavorite ¶

func (a *ContentApiService) DeleteContentFavorite(ctx _context.Context, contentFavoriteId int64) (string, *_nethttp.Response, error)

DeleteContentFavorite Delete Favorite Content ### Delete favorite content

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param contentFavoriteId Id of favorite content

@return string

func (*ContentApiService) DeleteContentMetadataAccess ¶

func (a *ContentApiService) DeleteContentMetadataAccess(ctx _context.Context, contentMetadataAccessId int64) (string, *_nethttp.Response, error)

DeleteContentMetadataAccess Delete Content Metadata Access ### Remove content metadata access.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param contentMetadataAccessId Id of content metadata access

@return string

func (*ContentApiService) SearchContentFavorites ¶

func (a *ContentApiService) SearchContentFavorites(ctx _context.Context, localVarOptionals *SearchContentFavoritesOpts) ([]ContentFavorite, *_nethttp.Response, error)

SearchContentFavorites Search Favorite Contents ### Search Favorite Content 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.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *SearchContentFavoritesOpts - Optional Parameters:
• @param "Id" (optional.Int64) - Match content favorite id(s)
• @param "UserId" (optional.Int64) - Match user id(s)
• @param "ContentMetadataId" (optional.Int64) - Match content metadata id(s)
• @param "DashboardId" (optional.Int64) - Match dashboard id(s)
• @param "LookId" (optional.Int64) - Match look id(s)
• @param "Limit" (optional.Int64) - Number of results to return. (used with offset)
• @param "Offset" (optional.Int64) - Number of results to skip before returning any. (used with limit)
• @param "Sorts" (optional.String) - Fields to sort by.
• @param "Fields" (optional.String) - Requested fields.
• @param "FilterOr" (optional.Bool) - Combine given search criteria in a boolean OR expression

@return []ContentFavorite

func (*ContentApiService) SearchContentViews ¶

func (a *ContentApiService) SearchContentViews(ctx _context.Context, localVarOptionals *SearchContentViewsOpts) ([]ContentView, *_nethttp.Response, error)

SearchContentViews Search Content Views ### Search Content Views 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.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param optional nil or *SearchContentViewsOpts - Optional Parameters:
• @param "ViewCount" (optional.Int64) - Match view count
• @param "GroupId" (optional.Int64) - Match Group Id
• @param "LookId" (optional.String) - Match look_id
• @param "DashboardId" (optional.String) - Match dashboard_id
• @param "ContentMetadataId" (optional.Int64) - Match content metadata id
• @param "StartOfWeekDate" (optional.String) - Match start of week date
• @param "AllTime" (optional.Bool) - True if only all time view records should be returned
• @param "UserId" (optional.Int64) - Match user id
• @param "Fields" (optional.String) - Requested fields
• @param "Limit" (optional.Int64) - Number of results to return. Use with `offset` to manage pagination of results
• @param "Offset" (optional.Int64) - Number of results to skip before returning data
• @param "Sorts" (optional.String) - Fields to sort by
• @param "FilterOr" (optional.Bool) - Combine given search criteria in a boolean OR expression

@return []ContentView

func (*ContentApiService) UpdateContentMetadata ¶

func (a *ContentApiService) UpdateContentMetadata(ctx _context.Context, contentMetadataId int64, body ContentMeta) (ContentMeta, *_nethttp.Response, error)

UpdateContentMetadata Update Content Metadata ### Move a piece of content.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param contentMetadataId Id of content metadata
• @param body Content Metadata

@return ContentMeta

func (*ContentApiService) UpdateContentMetadataAccess ¶

func (a *ContentApiService) UpdateContentMetadataAccess(ctx _context.Context, contentMetadataAccessId int64, body ContentMetaGroupUser) (ContentMetaGroupUser, *_nethttp.Response, error)

UpdateContentMetadataAccess Update Content Metadata Access ### Update type of access for content metadata.

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param contentMetadataAccessId Id of content metadata access
• @param body Content Metadata Access

@return ContentMetaGroupUser