@maxim_mazurok/gapi.client.dataform-v1beta1 0.0.20250119 → 0.0.20250223

package/index.d.ts

@@ -9,14 +9,14 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://dataform.googleapis.com/$discovery/rest?version=v1beta1
-// Revision: 20250119
+// Revision: 20250223
 
 /// <reference types="gapi.client" />
 
 declare namespace gapi.client {
   /** Load Dataform API v1beta1 */
   function load(
-    urlOrObject: 'https://dataform.googleapis.com/$discovery/rest?version=v1beta1'
+    urlOrObject: 'https://dataform.googleapis.com/$discovery/rest?version=v1beta1',
   ): Promise<void>;
   /** @deprecated Please load APIs with discovery documents. */
   function load(name: 'dataform', version: 'v1beta1'): Promise<void>;
@@ -24,7 +24,7 @@ declare namespace gapi.client {
   function load(
     name: 'dataform',
     version: 'v1beta1',
-    callback: () => any
+    callback: () => any,
   ): void;
 
   namespace dataform {
@@ -57,6 +57,7 @@ declare namespace gapi.client {
       role?: string;
     }
     interface CancelWorkflowInvocationRequest {}
+    interface CancelWorkflowInvocationResponse {}
     interface CodeCompilationConfig {
       /** Optional. The default schema (BigQuery dataset ID) for assertions. */
       assertionSchema?: string;
@@ -66,6 +67,7 @@ declare namespace gapi.client {
       defaultDatabase?: string;
       /** Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations. */
       defaultLocation?: string;
+      /** Optional. The default notebook runtime options. */
       defaultNotebookRuntimeOptions?: NotebookRuntimeOptions;
       /** Optional. The default schema (BigQuery dataset ID). */
       defaultSchema?: string;
@@ -109,7 +111,7 @@ declare namespace gapi.client {
     interface CommitRepositoryChangesRequest {
       /** Required. The changes to commit to the repository. */
       commitMetadata?: CommitMetadata;
-      /** A map to the path of the file to the operation. The path is the full file path including filename, from repository root. */
+      /** Optional. A map to the path of the file to the operation. The path is the full file path including filename, from repository root. */
       fileOperations?: {[P in string]: FileOperation};
       /** Optional. The commit SHA which must be the repository's current HEAD before applying this commit; otherwise this request will fail. If unset, no validation on the current HEAD commit SHA is performed. */
       requiredHeadCommitSha?: string;
@@ -126,6 +128,7 @@ declare namespace gapi.client {
       /** Optional. Full file paths to commit including filename, rooted at workspace root. If left empty, all files will be committed. */
       paths?: string[];
     }
+    interface CommitWorkspaceChangesResponse {}
     interface CompilationError {
       /** Output only. The identifier of the action where this error occurred, if available. */
       actionTarget?: Target;
@@ -191,7 +194,7 @@ declare namespace gapi.client {
       name?: string;
     }
     interface DataEncryptionState {
-      /** The KMS key version name with which data of a resource is encrypted. */
+      /** Required. The KMS key version name with which data of a resource is encrypted. */
       kmsKeyVersionName?: string;
     }
     interface Declaration {
@@ -451,10 +454,12 @@ declare namespace gapi.client {
       /** Optional. The name of the branch in the Git remote from which to pull commits. If left unset, the repository's default branch name will be used. */
       remoteBranch?: string;
     }
+    interface PullGitCommitsResponse {}
     interface PushGitCommitsRequest {
       /** Optional. The name of the branch in the Git remote to which commits should be pushed. If left unset, the repository's default branch name will be used. */
       remoteBranch?: string;
     }
+    interface PushGitCommitsResponse {}
     interface QueryCompilationResultActionsResponse {
       /** List of compilation result actions. */
       compilationResultActions?: CompilationResultAction[];
@@ -549,10 +554,12 @@ declare namespace gapi.client {
       /** Required. The directory's full path including directory name, relative to the workspace root. */
       path?: string;
     }
+    interface RemoveDirectoryResponse {}
     interface RemoveFileRequest {
       /** Required. The file's full path including filename, relative to the workspace root. */
       path?: string;
     }
+    interface RemoveFileResponse {}
     interface Repository {
       /** Output only. The timestamp of when the repository was created. */
       createTime?: string;
@@ -585,10 +592,11 @@ declare namespace gapi.client {
       /** Optional. Full file paths to reset back to their committed state including filename, rooted at workspace root. If left empty, all files will be reset. */
       paths?: string[];
     }
+    interface ResetWorkspaceChangesResponse {}
     interface ScheduledExecutionRecord {
       /** The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful. */
       errorStatus?: Status;
-      /** The timestamp of this execution attempt. */
+      /** Output only. The timestamp of this execution attempt. */
       executionTime?: string;
       /** The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*‍/locations/*‍/repositories/*‍/workflowInvocations/*`. */
       workflowInvocation?: string;
@@ -598,7 +606,7 @@ declare namespace gapi.client {
       compilationResult?: string;
       /** The error status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful. */
       errorStatus?: Status;
-      /** The timestamp of this release attempt. */
+      /** Output only. The timestamp of this release attempt. */
       releaseTime?: string;
     }
     interface SearchFilesResponse {
@@ -632,11 +640,11 @@ declare namespace gapi.client {
       message?: string;
     }
     interface Target {
-      /** The action's database (Google Cloud project ID) . */
+      /** Optional. The action's database (Google Cloud project ID) . */
       database?: string;
-      /** The action's name, within `database` and `schema`. */
+      /** Optional. The action's name, within `database` and `schema`. */
       name?: string;
-      /** The action's schema (BigQuery dataset ID), within `database`. */
+      /** Optional. The action's schema (BigQuery dataset ID), within `database`. */
       schema?: string;
     }
     interface TestIamPermissionsRequest {
@@ -650,7 +658,7 @@ declare namespace gapi.client {
     interface UncommittedFileChange {
       /** The file's full path including filename, relative to the workspace root. */
       path?: string;
-      /** Indicates the status of the file. */
+      /** Output only. Indicates the status of the file. */
       state?: string;
     }
     interface WorkflowConfig {
@@ -797,7 +805,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: CompilationResult
+        body: CompilationResult,
       ): Request<CompilationResult>;
       /** Fetches a single CompilationResult. */
       get(request?: {
@@ -956,7 +964,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: ReleaseConfig
+        body: ReleaseConfig,
       ): Request<ReleaseConfig>;
       /** Deletes a single ReleaseConfig. */
       delete(request?: {
@@ -1103,7 +1111,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: ReleaseConfig
+        body: ReleaseConfig,
       ): Request<ReleaseConfig>;
     }
     interface WorkflowConfigsResource {
@@ -1167,7 +1175,7 @@ declare namespace gapi.client {
           /** Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name. */
           workflowConfigId?: string;
         },
-        body: WorkflowConfig
+        body: WorkflowConfig,
       ): Request<WorkflowConfig>;
       /** Deletes a single WorkflowConfig. */
       delete(request?: {
@@ -1314,7 +1322,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: WorkflowConfig
+        body: WorkflowConfig,
       ): Request<WorkflowConfig>;
     }
     interface WorkflowInvocationsResource {
@@ -1374,7 +1382,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: CancelWorkflowInvocationRequest
+        body: CancelWorkflowInvocationRequest,
       ): Request<{}>;
       /** Creates a new WorkflowInvocation in a given Repository. */
       create(request: {
@@ -1432,7 +1440,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: WorkflowInvocation
+        body: WorkflowInvocation,
       ): Request<WorkflowInvocation>;
       /** Deletes a single WorkflowInvocation. */
       delete(request?: {
@@ -1612,7 +1620,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: CommitWorkspaceChangesRequest
+        body: CommitWorkspaceChangesRequest,
       ): Request<{}>;
       /** Creates a new Workspace in a given Repository. */
       create(request: {
@@ -1674,7 +1682,7 @@ declare namespace gapi.client {
           /** Required. The ID to use for the workspace, which will become the final component of the workspace's resource name. */
           workspaceId?: string;
         },
-        body: Workspace
+        body: Workspace,
       ): Request<Workspace>;
       /** Deletes a single Workspace. */
       delete(request?: {
@@ -1900,7 +1908,7 @@ declare namespace gapi.client {
           /** Required. The workspace's name. */
           workspace: string;
         },
-        body: InstallNpmPackagesRequest
+        body: InstallNpmPackagesRequest,
       ): Request<{}>;
       /** Lists Workspaces in a given Repository. */
       list(request?: {
@@ -1993,7 +2001,7 @@ declare namespace gapi.client {
           /** Required. The workspace's name. */
           workspace: string;
         },
-        body: MakeDirectoryRequest
+        body: MakeDirectoryRequest,
       ): Request<{}>;
       /** Moves a directory (inside a Workspace), and all of its contents, to a new location. */
       moveDirectory(request: {
@@ -2051,7 +2059,7 @@ declare namespace gapi.client {
           /** Required. The workspace's name. */
           workspace: string;
         },
-        body: MoveDirectoryRequest
+        body: MoveDirectoryRequest,
       ): Request<{}>;
       /** Moves a file (inside a Workspace) to a new location. */
       moveFile(request: {
@@ -2109,7 +2117,7 @@ declare namespace gapi.client {
           /** Required. The workspace's name. */
           workspace: string;
         },
-        body: MoveFileRequest
+        body: MoveFileRequest,
       ): Request<{}>;
       /** Pulls Git commits from the Repository's remote into a Workspace. */
       pull(request: {
@@ -2167,7 +2175,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: PullGitCommitsRequest
+        body: PullGitCommitsRequest,
       ): Request<{}>;
       /** Pushes Git commits from a Workspace to the Repository's remote. */
       push(request: {
@@ -2225,7 +2233,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: PushGitCommitsRequest
+        body: PushGitCommitsRequest,
       ): Request<{}>;
       /** Returns the contents of a given Workspace directory. */
       queryDirectoryContents(request?: {
@@ -2347,7 +2355,7 @@ declare namespace gapi.client {
           /** Required. The workspace's name. */
           workspace: string;
         },
-        body: RemoveDirectoryRequest
+        body: RemoveDirectoryRequest,
       ): Request<{}>;
       /** Deletes a file (inside a Workspace). */
       removeFile(request: {
@@ -2405,7 +2413,7 @@ declare namespace gapi.client {
           /** Required. The workspace's name. */
           workspace: string;
         },
-        body: RemoveFileRequest
+        body: RemoveFileRequest,
       ): Request<{}>;
       /** Performs a Git reset for uncommitted files in a Workspace. */
       reset(request: {
@@ -2463,7 +2471,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: ResetWorkspaceChangesRequest
+        body: ResetWorkspaceChangesRequest,
       ): Request<{}>;
       /** Finds the contents of a given Workspace directory by filter. */
       searchFiles(request?: {
@@ -2526,7 +2534,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: SetIamPolicyRequest
+        body: SetIamPolicyRequest,
       ): Request<Policy>;
       /** Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. */
       testIamPermissions(
@@ -2556,7 +2564,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: TestIamPermissionsRequest
+        body: TestIamPermissionsRequest,
       ): Request<TestIamPermissionsResponse>;
       /** Writes to a file (inside a Workspace). */
       writeFile(request: {
@@ -2614,7 +2622,7 @@ declare namespace gapi.client {
           /** Required. The workspace's name. */
           workspace: string;
         },
-        body: WriteFileRequest
+        body: WriteFileRequest,
       ): Request<{}>;
     }
     interface RepositoriesResource {
@@ -2674,7 +2682,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: CommitRepositoryChangesRequest
+        body: CommitRepositoryChangesRequest,
       ): Request<CommitRepositoryChangesResponse>;
       /** Computes a Repository's Git access token status. */
       computeAccessTokenStatus(request?: {
@@ -2763,7 +2771,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: Repository
+        body: Repository,
       ): Request<Repository>;
       /** Deletes a single Repository. */
       delete(request?: {
@@ -2777,7 +2785,7 @@ declare namespace gapi.client {
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
-        /** If set to true, any child resources of this repository will also be deleted. (Otherwise, the request will only succeed if the repository has no child resources.) */
+        /** Optional. If set to true, any child resources of this repository will also be deleted. (Otherwise, the request will only succeed if the repository has no child resources.) */
         force?: boolean;
         /** 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. */
         key?: string;
@@ -3003,7 +3011,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: Repository
+        body: Repository,
       ): Request<Repository>;
       /** Returns the contents of a given Repository directory. The Repository must not have a value for `git_remote_settings.url`. */
       queryDirectoryContents(request?: {
@@ -3099,7 +3107,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: SetIamPolicyRequest
+        body: SetIamPolicyRequest,
       ): Request<Policy>;
       /** Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. */
       testIamPermissions(
@@ -3129,7 +3137,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: TestIamPermissionsRequest
+        body: TestIamPermissionsRequest,
       ): Request<TestIamPermissionsResponse>;
       compilationResults: CompilationResultsResource;
       releaseConfigs: ReleaseConfigsResource;
@@ -3285,7 +3293,7 @@ declare namespace gapi.client {
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
           uploadType?: string;
         },
-        body: Config
+        body: Config,
       ): Request<Config>;
       repositories: RepositoriesResource;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.dataform-v1beta1",
-  "version": "0.0.20250119",
+  "version": "0.0.20250223",
   "description": "TypeScript typings for Dataform API v1beta1",
   "repository": {
     "type": "git",

package/readme.md

@@ -30,7 +30,7 @@ gapi.client.load(
   () => {
     // now we can use:
     // gapi.client.dataform
-  }
+  },
 );
 ```
 
@@ -48,6 +48,9 @@ Don't forget to authenticate your client before sending any request to resources
 // declare client_id registered in Google Developers Console
 var client_id = '',
   scope = [
+    // View and manage your data in Google BigQuery and see the email address for your Google Account
+    'https://www.googleapis.com/auth/bigquery',
+
     // See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
     'https://www.googleapis.com/auth/cloud-platform',
   ],
@@ -62,7 +65,7 @@ gapi.auth.authorize(
     } else {
       /* handle authorization error */
     }
-  }
+  },
 );
 ```