Current section
16 Versions
Jump to
Current section
16 Versions
Compare versions
14
files changed
+458
additions
-166
deletions
| @@ -10,7 +10,6 @@ | |
| 10 10 | <<"lib/google_api/digital_asset_links/v1/api/assetlinks.ex">>, |
| 11 11 | <<"lib/google_api/digital_asset_links/v1/api/statements.ex">>, |
| 12 12 | <<"lib/google_api/digital_asset_links/v1/connection.ex">>, |
| 13 | - <<"lib/google_api/digital_asset_links/v1/deserializer.ex">>, |
| 14 13 | <<"lib/google_api/digital_asset_links/v1/model">>, |
| 15 14 | <<"lib/google_api/digital_asset_links/v1/model/android_app_asset.ex">>, |
| 16 15 | <<"lib/google_api/digital_asset_links/v1/model/asset.ex">>, |
| @@ -19,7 +18,6 @@ | |
| 19 18 | <<"lib/google_api/digital_asset_links/v1/model/list_response.ex">>, |
| 20 19 | <<"lib/google_api/digital_asset_links/v1/model/statement.ex">>, |
| 21 20 | <<"lib/google_api/digital_asset_links/v1/model/web_asset.ex">>, |
| 22 | - <<"lib/google_api/digital_asset_links/v1/request_builder.ex">>, |
| 23 21 | <<"mix.exs">>,<<"README.md">>,<<"LICENSE">>]}. |
| 24 22 | {<<"licenses">>,[<<"Apache 2.0">>]}. |
| 25 23 | {<<"links">>, |
| @@ -33,4 +31,4 @@ | |
| 33 31 | {<<"optional">>,false}, |
| 34 32 | {<<"repository">>,<<"hexpm">>}, |
| 35 33 | {<<"requirement">>,<<"~> 0.1.0">>}]]}. |
| 36 | - {<<"version">>,<<"0.1.0">>}. |
| 34 | + {<<"version">>,<<"0.2.0">>}. |
| @@ -1,4 +1,4 @@ | |
| 1 | - # Copyright 2017 Google Inc. |
| 1 | + # Copyright 2019 Google LLC |
| 2 2 | # |
| 3 3 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 4 | # you may not use this file except in compliance with the License. |
| @@ -12,8 +12,7 @@ | |
| 12 12 | # See the License for the specific language governing permissions and |
| 13 13 | # limitations under the License. |
| 14 14 | |
| 15 | - # NOTE: This class is auto generated by the swagger code generator program. |
| 16 | - # https://github.com/swagger-api/swagger-codegen.git |
| 15 | + # NOTE: This class is auto generated by the elixir code generator program. |
| 17 16 | # Do not edit the class manually. |
| 18 17 | |
| 19 18 | defmodule GoogleApi.DigitalAssetLinks.V1.Api.Assetlinks do |
| @@ -25,37 +24,185 @@ defmodule GoogleApi.DigitalAssetLinks.V1.Api.Assetlinks do | |
| 25 24 | alias GoogleApi.Gax.{Request, Response} |
| 26 25 | |
| 27 26 | @doc """ |
| 28 | - Determines whether the specified (directional) relationship exists between the specified source and target assets. The relation describes the intent of the link between the two assets as claimed by the source asset. An example for such relationships is the delegation of privileges or permissions. This command is most often used by infrastructure systems to check preconditions for an action. For example, a client may want to know if it is OK to send a web URL to a particular mobile app instead. The client can check for the relevant asset link from the website to the mobile app to decide if the operation should be allowed. A note about security: if you specify a secure asset as the source, such as an HTTPS website or an Android app, the API will ensure that any statements used to generate the response have been made in a secure way by the owner of that asset. Conversely, if the source asset is an insecure HTTP website (that is, the URL starts with `http://` instead of `https://`), the API cannot verify its statements securely, and it is not possible to ensure that the website's statements have not been altered by a third party. For more information, see the [Digital Asset Links technical design specification](https://github.com/google/digitalassetlinks/blob/master/well-known/details.md). |
| 27 | + Determines whether the specified (directional) relationship exists between |
| 28 | + the specified source and target assets. |
| 29 | + |
| 30 | + The relation describes the intent of the link between the two assets as |
| 31 | + claimed by the source asset. An example for such relationships is the |
| 32 | + delegation of privileges or permissions. |
| 33 | + |
| 34 | + This command is most often used by infrastructure systems to check |
| 35 | + preconditions for an action. For example, a client may want to know if it |
| 36 | + is OK to send a web URL to a particular mobile app instead. The client can |
| 37 | + check for the relevant asset link from the website to the mobile app to |
| 38 | + decide if the operation should be allowed. |
| 39 | + |
| 40 | + A note about security: if you specify a secure asset as the source, such as |
| 41 | + an HTTPS website or an Android app, the API will ensure that any |
| 42 | + statements used to generate the response have been made in a secure way by |
| 43 | + the owner of that asset. Conversely, if the source asset is an insecure |
| 44 | + HTTP website (that is, the URL starts with `http://` instead of |
| 45 | + `https://`), the API cannot verify its statements securely, and it is not |
| 46 | + possible to ensure that the website's statements have not been altered by a |
| 47 | + third party. For more information, see the [Digital Asset Links technical |
| 48 | + design |
| 49 | + specification](https://github.com/google/digitalassetlinks/blob/master/well-known/details.md). |
| 29 50 | |
| 30 51 | ## Parameters |
| 31 52 | |
| 32 | - - connection (GoogleApi.DigitalAssetLinks.V1.Connection): Connection to server |
| 33 | - - optional_params (KeywordList): [optional] Optional parameters |
| 34 | - - :$.xgafv (String.t): V1 error format. |
| 35 | - - :access_token (String.t): OAuth access token. |
| 36 | - - :alt (String.t): Data format for response. |
| 37 | - - :callback (String.t): JSONP |
| 38 | - - :fields (String.t): Selector specifying which fields to include in a partial response. |
| 39 | - - :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| 40 | - - :oauth_token (String.t): OAuth 2.0 token for the current user. |
| 41 | - - :prettyPrint (boolean()): Returns response with indentations and line breaks. |
| 42 | - - :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
| 43 | - - :upload_protocol (String.t): Upload protocol for media (e.g. \"raw\", \"multipart\"). |
| 44 | - - :uploadType (String.t): Legacy upload protocol for media (e.g. \"media\", \"multipart\"). |
| 45 | - - :relation (String.t): Query string for the relation. We identify relations with strings of the format `<kind>/<detail>`, where `<kind>` must be one of a set of pre-defined purpose categories, and `<detail>` is a free-form lowercase alphanumeric string that describes the specific use case of the statement. Refer to [our API documentation](/digital-asset-links/v1/relation-strings) for the current list of supported relations. For a query to match an asset link, both the query's and the asset link's relation strings must match exactly. Example: A query with relation `delegate_permission/common.handle_all_urls` matches an asset link with relation `delegate_permission/common.handle_all_urls`. |
| 46 | - - :source.androidApp.certificate.sha256Fingerprint (String.t): The uppercase SHA-265 fingerprint of the certificate. From the PEM certificate, it can be acquired like this: $ keytool -printcert -file $CERTFILE | grep SHA256: SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \\ 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \\ 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the contents of this field would be `14:6D:E9:83:C5:73: 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: 44:E5`. If these tools are not available to you, you can convert the PEM certificate into the DER format, compute the SHA-256 hash of that string and represent the result as a hexstring (that is, uppercase hexadecimal representations of each octet, separated by colons). |
| 47 | - - :source.androidApp.packageName (String.t): Android App assets are naturally identified by their Java package name. For example, the Google Maps app uses the package name `com.google.android.apps.maps`. REQUIRED |
| 48 | - - :source.web.site (String.t): Web assets are identified by a URL that contains only the scheme, hostname and port parts. The format is http[s]://<hostname>[:<port>] Hostnames must be fully qualified: they must end in a single period (\"`.`\"). Only the schemes \"http\" and \"https\" are currently allowed. Port numbers are given as a decimal number, and they must be omitted if the standard port numbers are used: 80 for http and 443 for https. We call this limited URL the \"site\". All URLs that share the same scheme, hostname and port are considered to be a part of the site and thus belong to the web asset. Example: the asset with the site `https://www.google.com` contains all these URLs: * `https://www.google.com/` * `https://www.google.com:443/` * `https://www.google.com/foo` * `https://www.google.com/foo?bar` * `https://www.google.com/foo#bar` * `https://user@password:www.google.com/` But it does not contain these URLs: * `http://www.google.com/` (wrong scheme) * `https://google.com/` (hostname does not match) * `https://www.google.com:444/` (port does not match) REQUIRED |
| 49 | - - :target.androidApp.certificate.sha256Fingerprint (String.t): The uppercase SHA-265 fingerprint of the certificate. From the PEM certificate, it can be acquired like this: $ keytool -printcert -file $CERTFILE | grep SHA256: SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \\ 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \\ 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the contents of this field would be `14:6D:E9:83:C5:73: 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: 44:E5`. If these tools are not available to you, you can convert the PEM certificate into the DER format, compute the SHA-256 hash of that string and represent the result as a hexstring (that is, uppercase hexadecimal representations of each octet, separated by colons). |
| 50 | - - :target.androidApp.packageName (String.t): Android App assets are naturally identified by their Java package name. For example, the Google Maps app uses the package name `com.google.android.apps.maps`. REQUIRED |
| 51 | - - :target.web.site (String.t): Web assets are identified by a URL that contains only the scheme, hostname and port parts. The format is http[s]://<hostname>[:<port>] Hostnames must be fully qualified: they must end in a single period (\"`.`\"). Only the schemes \"http\" and \"https\" are currently allowed. Port numbers are given as a decimal number, and they must be omitted if the standard port numbers are used: 80 for http and 443 for https. We call this limited URL the \"site\". All URLs that share the same scheme, hostname and port are considered to be a part of the site and thus belong to the web asset. Example: the asset with the site `https://www.google.com` contains all these URLs: * `https://www.google.com/` * `https://www.google.com:443/` * `https://www.google.com/foo` * `https://www.google.com/foo?bar` * `https://www.google.com/foo#bar` * `https://user@password:www.google.com/` But it does not contain these URLs: * `http://www.google.com/` (wrong scheme) * `https://google.com/` (hostname does not match) * `https://www.google.com:444/` (port does not match) REQUIRED |
| 53 | + * `connection` (*type:* `GoogleApi.DigitalAssetLinks.V1.Connection.t`) - Connection to server |
| 54 | + * `optional_params` (*type:* `keyword()`) - Optional parameters |
| 55 | + * `:$.xgafv` (*type:* `String.t`) - V1 error format. |
| 56 | + * `:access_token` (*type:* `String.t`) - OAuth access token. |
| 57 | + * `:alt` (*type:* `String.t`) - Data format for response. |
| 58 | + * `:callback` (*type:* `String.t`) - JSONP |
| 59 | + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. |
| 60 | + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| 61 | + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. |
| 62 | + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. |
| 63 | + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
| 64 | + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). |
| 65 | + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). |
| 66 | + * `:relation` (*type:* `String.t`) - Query string for the relation. |
| 67 | + |
| 68 | + We identify relations with strings of the format `<kind>/<detail>`, where |
| 69 | + `<kind>` must be one of a set of pre-defined purpose categories, and |
| 70 | + `<detail>` is a free-form lowercase alphanumeric string that describes the |
| 71 | + specific use case of the statement. |
| 72 | + |
| 73 | + Refer to [our API documentation](/digital-asset-links/v1/relation-strings) |
| 74 | + for the current list of supported relations. |
| 75 | + |
| 76 | + For a query to match an asset link, both the query's and the asset link's |
| 77 | + relation strings must match exactly. |
| 78 | + |
| 79 | + Example: A query with relation `delegate_permission/common.handle_all_urls` |
| 80 | + matches an asset link with relation |
| 81 | + `delegate_permission/common.handle_all_urls`. |
| 82 | + * `:source.androidApp.certificate.sha256Fingerprint` (*type:* `String.t`) - The uppercase SHA-265 fingerprint of the certificate. From the PEM |
| 83 | + certificate, it can be acquired like this: |
| 84 | + |
| 85 | + $ keytool -printcert -file $CERTFILE | grep SHA256: |
| 86 | + SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ |
| 87 | + 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 |
| 88 | + |
| 89 | + or like this: |
| 90 | + |
| 91 | + $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 |
| 92 | + SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ |
| 93 | + 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 |
| 94 | + |
| 95 | + In this example, the contents of this field would be `14:6D:E9:83:C5:73: |
| 96 | + 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: |
| 97 | + 44:E5`. |
| 98 | + |
| 99 | + If these tools are not available to you, you can convert the PEM |
| 100 | + certificate into the DER format, compute the SHA-256 hash of that string |
| 101 | + and represent the result as a hexstring (that is, uppercase hexadecimal |
| 102 | + representations of each octet, separated by colons). |
| 103 | + * `:source.androidApp.packageName` (*type:* `String.t`) - Android App assets are naturally identified by their Java package name. |
| 104 | + For example, the Google Maps app uses the package name |
| 105 | + `com.google.android.apps.maps`. |
| 106 | + REQUIRED |
| 107 | + * `:source.web.site` (*type:* `String.t`) - Web assets are identified by a URL that contains only the scheme, hostname |
| 108 | + and port parts. The format is |
| 109 | + |
| 110 | + http[s]://<hostname>[:<port>] |
| 111 | + |
| 112 | + Hostnames must be fully qualified: they must end in a single period |
| 113 | + ("`.`"). |
| 114 | + |
| 115 | + Only the schemes "http" and "https" are currently allowed. |
| 116 | + |
| 117 | + Port numbers are given as a decimal number, and they must be omitted if the |
| 118 | + standard port numbers are used: 80 for http and 443 for https. |
| 119 | + |
| 120 | + We call this limited URL the "site". All URLs that share the same scheme, |
| 121 | + hostname and port are considered to be a part of the site and thus belong |
| 122 | + to the web asset. |
| 123 | + |
| 124 | + Example: the asset with the site `https://www.google.com` contains all |
| 125 | + these URLs: |
| 126 | + |
| 127 | + * `https://www.google.com/` |
| 128 | + * `https://www.google.com:443/` |
| 129 | + * `https://www.google.com/foo` |
| 130 | + * `https://www.google.com/foo?bar` |
| 131 | + * `https://www.google.com/foo#bar` |
| 132 | + * `https://user@password:www.google.com/` |
| 133 | + |
| 134 | + But it does not contain these URLs: |
| 135 | + |
| 136 | + * `http://www.google.com/` (wrong scheme) |
| 137 | + * `https://google.com/` (hostname does not match) |
| 138 | + * `https://www.google.com:444/` (port does not match) |
| 139 | + REQUIRED |
| 140 | + * `:target.androidApp.certificate.sha256Fingerprint` (*type:* `String.t`) - The uppercase SHA-265 fingerprint of the certificate. From the PEM |
| 141 | + certificate, it can be acquired like this: |
| 142 | + |
| 143 | + $ keytool -printcert -file $CERTFILE | grep SHA256: |
| 144 | + SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ |
| 145 | + 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 |
| 146 | + |
| 147 | + or like this: |
| 148 | + |
| 149 | + $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 |
| 150 | + SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ |
| 151 | + 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 |
| 152 | + |
| 153 | + In this example, the contents of this field would be `14:6D:E9:83:C5:73: |
| 154 | + 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: |
| 155 | + 44:E5`. |
| 156 | + |
| 157 | + If these tools are not available to you, you can convert the PEM |
| 158 | + certificate into the DER format, compute the SHA-256 hash of that string |
| 159 | + and represent the result as a hexstring (that is, uppercase hexadecimal |
| 160 | + representations of each octet, separated by colons). |
| 161 | + * `:target.androidApp.packageName` (*type:* `String.t`) - Android App assets are naturally identified by their Java package name. |
| 162 | + For example, the Google Maps app uses the package name |
| 163 | + `com.google.android.apps.maps`. |
| 164 | + REQUIRED |
| 165 | + * `:target.web.site` (*type:* `String.t`) - Web assets are identified by a URL that contains only the scheme, hostname |
| 166 | + and port parts. The format is |
| 167 | + |
| 168 | + http[s]://<hostname>[:<port>] |
| 169 | + |
| 170 | + Hostnames must be fully qualified: they must end in a single period |
| 171 | + ("`.`"). |
| 172 | + |
| 173 | + Only the schemes "http" and "https" are currently allowed. |
| 174 | + |
| 175 | + Port numbers are given as a decimal number, and they must be omitted if the |
| 176 | + standard port numbers are used: 80 for http and 443 for https. |
| 177 | + |
| 178 | + We call this limited URL the "site". All URLs that share the same scheme, |
| 179 | + hostname and port are considered to be a part of the site and thus belong |
| 180 | + to the web asset. |
| 181 | + |
| 182 | + Example: the asset with the site `https://www.google.com` contains all |
| 183 | + these URLs: |
| 184 | + |
| 185 | + * `https://www.google.com/` |
| 186 | + * `https://www.google.com:443/` |
| 187 | + * `https://www.google.com/foo` |
| 188 | + * `https://www.google.com/foo?bar` |
| 189 | + * `https://www.google.com/foo#bar` |
| 190 | + * `https://user@password:www.google.com/` |
| 191 | + |
| 192 | + But it does not contain these URLs: |
| 193 | + |
| 194 | + * `http://www.google.com/` (wrong scheme) |
| 195 | + * `https://google.com/` (hostname does not match) |
| 196 | + * `https://www.google.com:444/` (port does not match) |
| 197 | + REQUIRED |
| 198 | + * `opts` (*type:* `keyword()`) - Call options |
| 52 199 | |
| 53 200 | ## Returns |
| 54 201 | |
| 55 | - {:ok, %GoogleApi.DigitalAssetLinks.V1.Model.CheckResponse{}} on success |
| 56 | - {:error, info} on failure |
| 202 | + * `{:ok, %GoogleApi.DigitalAssetLinks.V1.Model.CheckResponse{}}` on success |
| 203 | + * `{:error, info}` on failure |
| 57 204 | """ |
| 58 | - @spec digitalassetlinks_assetlinks_check(Tesla.Env.client(), keyword()) :: |
| 205 | + @spec digitalassetlinks_assetlinks_check(Tesla.Env.client(), keyword(), keyword()) :: |
| 59 206 | {:ok, GoogleApi.DigitalAssetLinks.V1.Model.CheckResponse.t()} | {:error, Tesla.Env.t()} |
| 60 207 | def digitalassetlinks_assetlinks_check(connection, optional_params \\ [], opts \\ []) do |
| 61 208 | optional_params_config = %{ |
| @@ -68,8 +215,8 @@ defmodule GoogleApi.DigitalAssetLinks.V1.Api.Assetlinks do | |
| 68 215 | :oauth_token => :query, |
| 69 216 | :prettyPrint => :query, |
| 70 217 | :quotaUser => :query, |
| 71 | - :upload_protocol => :query, |
| 72 218 | :uploadType => :query, |
| 219 | + :upload_protocol => :query, |
| 73 220 | :relation => :query, |
| 74 221 | :"source.androidApp.certificate.sha256Fingerprint" => :query, |
| 75 222 | :"source.androidApp.packageName" => :query, |
| @@ -82,7 +229,7 @@ defmodule GoogleApi.DigitalAssetLinks.V1.Api.Assetlinks do | |
| 82 229 | request = |
| 83 230 | Request.new() |
| 84 231 | |> Request.method(:get) |
| 85 | - |> Request.url("/v1/assetlinks:check") |
| 232 | + |> Request.url("/v1/assetlinks:check", %{}) |
| 86 233 | |> Request.add_optional_params(optional_params_config, optional_params) |
| 87 234 | |
| 88 235 | connection |
| @@ -1,4 +1,4 @@ | |
| 1 | - # Copyright 2017 Google Inc. |
| 1 | + # Copyright 2019 Google LLC |
| 2 2 | # |
| 3 3 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 4 | # you may not use this file except in compliance with the License. |
| @@ -12,8 +12,7 @@ | |
| 12 12 | # See the License for the specific language governing permissions and |
| 13 13 | # limitations under the License. |
| 14 14 | |
| 15 | - # NOTE: This class is auto generated by the swagger code generator program. |
| 16 | - # https://github.com/swagger-api/swagger-codegen.git |
| 15 | + # NOTE: This class is auto generated by the elixir code generator program. |
| 17 16 | # Do not edit the class manually. |
| 18 17 | |
| 19 18 | defmodule GoogleApi.DigitalAssetLinks.V1.Api.Statements do |
| @@ -25,34 +24,119 @@ defmodule GoogleApi.DigitalAssetLinks.V1.Api.Statements do | |
| 25 24 | alias GoogleApi.Gax.{Request, Response} |
| 26 25 | |
| 27 26 | @doc """ |
| 28 | - Retrieves a list of all statements from a given source that match the specified target and statement string. The API guarantees that all statements with secure source assets, such as HTTPS websites or Android apps, have been made in a secure way by the owner of those assets, as described in the [Digital Asset Links technical design specification](https://github.com/google/digitalassetlinks/blob/master/well-known/details.md). Specifically, you should consider that for insecure websites (that is, where the URL starts with `http://` instead of `https://`), this guarantee cannot be made. The `List` command is most useful in cases where the API client wants to know all the ways in which two assets are related, or enumerate all the relationships from a particular source asset. Example: a feature that helps users navigate to related items. When a mobile app is running on a device, the feature would make it easy to navigate to the corresponding web site or Google+ profile. |
| 27 | + Retrieves a list of all statements from a given source that match the |
| 28 | + specified target and statement string. |
| 29 | + |
| 30 | + The API guarantees that all statements with secure source assets, such as |
| 31 | + HTTPS websites or Android apps, have been made in a secure way by the owner |
| 32 | + of those assets, as described in the [Digital Asset Links technical design |
| 33 | + specification](https://github.com/google/digitalassetlinks/blob/master/well-known/details.md). |
| 34 | + Specifically, you should consider that for insecure websites (that is, |
| 35 | + where the URL starts with `http://` instead of `https://`), this guarantee |
| 36 | + cannot be made. |
| 37 | + |
| 38 | + The `List` command is most useful in cases where the API client wants to |
| 39 | + know all the ways in which two assets are related, or enumerate all the |
| 40 | + relationships from a particular source asset. Example: a feature that |
| 41 | + helps users navigate to related items. When a mobile app is running on a |
| 42 | + device, the feature would make it easy to navigate to the corresponding web |
| 43 | + site or Google+ profile. |
| 29 44 | |
| 30 45 | ## Parameters |
| 31 46 | |
| 32 | - - connection (GoogleApi.DigitalAssetLinks.V1.Connection): Connection to server |
| 33 | - - optional_params (KeywordList): [optional] Optional parameters |
| 34 | - - :$.xgafv (String.t): V1 error format. |
| 35 | - - :access_token (String.t): OAuth access token. |
| 36 | - - :alt (String.t): Data format for response. |
| 37 | - - :callback (String.t): JSONP |
| 38 | - - :fields (String.t): Selector specifying which fields to include in a partial response. |
| 39 | - - :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| 40 | - - :oauth_token (String.t): OAuth 2.0 token for the current user. |
| 41 | - - :prettyPrint (boolean()): Returns response with indentations and line breaks. |
| 42 | - - :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
| 43 | - - :upload_protocol (String.t): Upload protocol for media (e.g. \"raw\", \"multipart\"). |
| 44 | - - :uploadType (String.t): Legacy upload protocol for media (e.g. \"media\", \"multipart\"). |
| 45 | - - :relation (String.t): Use only associations that match the specified relation. See the [`Statement`](#Statement) message for a detailed definition of relation strings. For a query to match a statement, one of the following must be true: * both the query's and the statement's relation strings match exactly, or * the query's relation string is empty or missing. Example: A query with relation `delegate_permission/common.handle_all_urls` matches an asset link with relation `delegate_permission/common.handle_all_urls`. |
| 46 | - - :source.androidApp.certificate.sha256Fingerprint (String.t): The uppercase SHA-265 fingerprint of the certificate. From the PEM certificate, it can be acquired like this: $ keytool -printcert -file $CERTFILE | grep SHA256: SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \\ 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 or like this: $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \\ 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 In this example, the contents of this field would be `14:6D:E9:83:C5:73: 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: 44:E5`. If these tools are not available to you, you can convert the PEM certificate into the DER format, compute the SHA-256 hash of that string and represent the result as a hexstring (that is, uppercase hexadecimal representations of each octet, separated by colons). |
| 47 | - - :source.androidApp.packageName (String.t): Android App assets are naturally identified by their Java package name. For example, the Google Maps app uses the package name `com.google.android.apps.maps`. REQUIRED |
| 48 | - - :source.web.site (String.t): Web assets are identified by a URL that contains only the scheme, hostname and port parts. The format is http[s]://<hostname>[:<port>] Hostnames must be fully qualified: they must end in a single period (\"`.`\"). Only the schemes \"http\" and \"https\" are currently allowed. Port numbers are given as a decimal number, and they must be omitted if the standard port numbers are used: 80 for http and 443 for https. We call this limited URL the \"site\". All URLs that share the same scheme, hostname and port are considered to be a part of the site and thus belong to the web asset. Example: the asset with the site `https://www.google.com` contains all these URLs: * `https://www.google.com/` * `https://www.google.com:443/` * `https://www.google.com/foo` * `https://www.google.com/foo?bar` * `https://www.google.com/foo#bar` * `https://user@password:www.google.com/` But it does not contain these URLs: * `http://www.google.com/` (wrong scheme) * `https://google.com/` (hostname does not match) * `https://www.google.com:444/` (port does not match) REQUIRED |
| 47 | + * `connection` (*type:* `GoogleApi.DigitalAssetLinks.V1.Connection.t`) - Connection to server |
| 48 | + * `optional_params` (*type:* `keyword()`) - Optional parameters |
| 49 | + * `:$.xgafv` (*type:* `String.t`) - V1 error format. |
| 50 | + * `:access_token` (*type:* `String.t`) - OAuth access token. |
| 51 | + * `:alt` (*type:* `String.t`) - Data format for response. |
| 52 | + * `:callback` (*type:* `String.t`) - JSONP |
| 53 | + * `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response. |
| 54 | + * `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. |
| 55 | + * `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user. |
| 56 | + * `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks. |
| 57 | + * `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. |
| 58 | + * `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart"). |
| 59 | + * `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart"). |
| 60 | + * `:relation` (*type:* `String.t`) - Use only associations that match the specified relation. |
| 61 | + |
| 62 | + See the [`Statement`](#Statement) message for a detailed definition of |
| 63 | + relation strings. |
| 64 | + |
| 65 | + For a query to match a statement, one of the following must be true: |
| 66 | + |
| 67 | + * both the query's and the statement's relation strings match exactly, |
| 68 | + or |
| 69 | + * the query's relation string is empty or missing. |
| 70 | + |
| 71 | + Example: A query with relation `delegate_permission/common.handle_all_urls` |
| 72 | + matches an asset link with relation |
| 73 | + `delegate_permission/common.handle_all_urls`. |
| 74 | + * `:source.androidApp.certificate.sha256Fingerprint` (*type:* `String.t`) - The uppercase SHA-265 fingerprint of the certificate. From the PEM |
| 75 | + certificate, it can be acquired like this: |
| 76 | + |
| 77 | + $ keytool -printcert -file $CERTFILE | grep SHA256: |
| 78 | + SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \ |
| 79 | + 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 |
| 80 | + |
| 81 | + or like this: |
| 82 | + |
| 83 | + $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256 |
| 84 | + SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \ |
| 85 | + 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5 |
| 86 | + |
| 87 | + In this example, the contents of this field would be `14:6D:E9:83:C5:73: |
| 88 | + 06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF: |
| 89 | + 44:E5`. |
| 90 | + |
| 91 | + If these tools are not available to you, you can convert the PEM |
| 92 | + certificate into the DER format, compute the SHA-256 hash of that string |
| 93 | + and represent the result as a hexstring (that is, uppercase hexadecimal |
| 94 | + representations of each octet, separated by colons). |
| 95 | + * `:source.androidApp.packageName` (*type:* `String.t`) - Android App assets are naturally identified by their Java package name. |
| 96 | + For example, the Google Maps app uses the package name |
| 97 | + `com.google.android.apps.maps`. |
| 98 | + REQUIRED |
| 99 | + * `:source.web.site` (*type:* `String.t`) - Web assets are identified by a URL that contains only the scheme, hostname |
| 100 | + and port parts. The format is |
| 101 | + |
| 102 | + http[s]://<hostname>[:<port>] |
| 103 | + |
| 104 | + Hostnames must be fully qualified: they must end in a single period |
| 105 | + ("`.`"). |
| 106 | + |
| 107 | + Only the schemes "http" and "https" are currently allowed. |
| 108 | + |
| 109 | + Port numbers are given as a decimal number, and they must be omitted if the |
| 110 | + standard port numbers are used: 80 for http and 443 for https. |
| 111 | + |
| 112 | + We call this limited URL the "site". All URLs that share the same scheme, |
| 113 | + hostname and port are considered to be a part of the site and thus belong |
| 114 | + to the web asset. |
| 115 | + |
| 116 | + Example: the asset with the site `https://www.google.com` contains all |
| 117 | + these URLs: |
| 118 | + |
| 119 | + * `https://www.google.com/` |
| 120 | + * `https://www.google.com:443/` |
| 121 | + * `https://www.google.com/foo` |
| 122 | + * `https://www.google.com/foo?bar` |
| 123 | + * `https://www.google.com/foo#bar` |
| 124 | + * `https://user@password:www.google.com/` |
| 125 | + |
| 126 | + But it does not contain these URLs: |
| 127 | + |
| 128 | + * `http://www.google.com/` (wrong scheme) |
| 129 | + * `https://google.com/` (hostname does not match) |
| 130 | + * `https://www.google.com:444/` (port does not match) |
| 131 | + REQUIRED |
| 132 | + * `opts` (*type:* `keyword()`) - Call options |
| 49 133 | |
| 50 134 | ## Returns |
| 51 135 | |
| 52 | - {:ok, %GoogleApi.DigitalAssetLinks.V1.Model.ListResponse{}} on success |
| 53 | - {:error, info} on failure |
| 136 | + * `{:ok, %GoogleApi.DigitalAssetLinks.V1.Model.ListResponse{}}` on success |
| 137 | + * `{:error, info}` on failure |
| 54 138 | """ |
| 55 | - @spec digitalassetlinks_statements_list(Tesla.Env.client(), keyword()) :: |
| 139 | + @spec digitalassetlinks_statements_list(Tesla.Env.client(), keyword(), keyword()) :: |
| 56 140 | {:ok, GoogleApi.DigitalAssetLinks.V1.Model.ListResponse.t()} | {:error, Tesla.Env.t()} |
| 57 141 | def digitalassetlinks_statements_list(connection, optional_params \\ [], opts \\ []) do |
| 58 142 | optional_params_config = %{ |
| @@ -65,8 +149,8 @@ defmodule GoogleApi.DigitalAssetLinks.V1.Api.Statements do | |
| 65 149 | :oauth_token => :query, |
| 66 150 | :prettyPrint => :query, |
| 67 151 | :quotaUser => :query, |
| 68 | - :upload_protocol => :query, |
| 69 152 | :uploadType => :query, |
| 153 | + :upload_protocol => :query, |
| 70 154 | :relation => :query, |
| 71 155 | :"source.androidApp.certificate.sha256Fingerprint" => :query, |
| 72 156 | :"source.androidApp.packageName" => :query, |
| @@ -76,7 +160,7 @@ defmodule GoogleApi.DigitalAssetLinks.V1.Api.Statements do | |
| 76 160 | request = |
| 77 161 | Request.new() |
| 78 162 | |> Request.method(:get) |
| 79 | - |> Request.url("/v1/statements:list") |
| 163 | + |> Request.url("/v1/statements:list", %{}) |
| 80 164 | |> Request.add_optional_params(optional_params_config, optional_params) |
| 81 165 | |
| 82 166 | connection |
| @@ -1,4 +1,4 @@ | |
| 1 | - # Copyright 2017 Google Inc. |
| 1 | + # Copyright 2019 Google LLC |
| 2 2 | # |
| 3 3 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 4 | # you may not use this file except in compliance with the License. |
| @@ -12,8 +12,7 @@ | |
| 12 12 | # See the License for the specific language governing permissions and |
| 13 13 | # limitations under the License. |
| 14 14 | |
| 15 | - # NOTE: This class is auto generated by the swagger code generator program. |
| 16 | - # https://github.com/swagger-api/swagger-codegen.git |
| 15 | + # NOTE: This class is auto generated by the elixir code generator program. |
| 17 16 | # Do not edit the class manually. |
| 18 17 | |
| 19 18 | defmodule GoogleApi.DigitalAssetLinks.V1.Connection do |
| @@ -21,8 +20,10 @@ defmodule GoogleApi.DigitalAssetLinks.V1.Connection do | |
| 21 20 | Handle Tesla connections for GoogleApi.DigitalAssetLinks.V1. |
| 22 21 | """ |
| 23 22 | |
| 23 | + @type t :: Tesla.Env.client() |
| 24 | + |
| 24 25 | use GoogleApi.Gax.Connection, |
| 25 26 | scopes: [], |
| 26 27 | otp_app: :google_api_digital_asset_links, |
| 27 | - base_url: "https://digitalassetlinks.googleapis.com" |
| 28 | + base_url: "https://digitalassetlinks.googleapis.com/" |
| 28 29 | end |
| @@ -1,25 +0,0 @@ | |
| 1 | - # Copyright 2017 Google Inc. |
| 2 | - # |
| 3 | - # Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | - # you may not use this file except in compliance with the License. |
| 5 | - # You may obtain a copy of the License at |
| 6 | - # |
| 7 | - # http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | - # |
| 9 | - # Unless required by applicable law or agreed to in writing, software |
| 10 | - # distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | - # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | - # See the License for the specific language governing permissions and |
| 13 | - # limitations under the License. |
| 14 | - |
| 15 | - # NOTE: This class is auto generated by the swagger code generator program. |
| 16 | - # https://github.com/swagger-api/swagger-codegen.git |
| 17 | - # Do not edit the class manually. |
| 18 | - |
| 19 | - defmodule GoogleApi.DigitalAssetLinks.V1.Deserializer do |
| 20 | - @moduledoc """ |
| 21 | - Helper functions for deserializing responses into models. |
| 22 | - |
| 23 | - This module is no longer used. Please use GoogleApi.Gax.ModelBase instead. |
| 24 | - """ |
| 25 | - end |
Loading more files…