happygapi.firebase.projects — happygapi 0.4.8

Firebase Management API: projects. The Firebase Management API enables programmatic setup and management of Firebase projects, including a project's Firebase resources and Firebase apps. See: https://firebase.google.comapi/reference/rest/v1beta1/projects

addFirebase$ clj

(addFirebase$ auth parameters body)

https://firebase.google.comapi/reference/rest/v1beta1/projects/addFirebase

Required parameters: project

Optional parameters: none

Body:

{:locationId string}

Adds Firebase resources to the specified existing [Google Cloud Platform (GCP) Project] (https://cloud.google.com/resource-manager/reference/rest/v1/projects). Since a FirebaseProject is actually also a GCP Project, a FirebaseProject has the same underlying GCP identifiers (projectNumber and projectId). This allows for easy interop with Google APIs. The result of this call is an Operation. Poll the Operation to track the provisioning process by calling GetOperation until done is true. When done is true, the Operation has either succeeded or failed. If the Operation succeeded, its response is set to a FirebaseProject; if the Operation failed, its error is set to a google.rpc.Status. The Operation is automatically deleted after completion, so there is no need to call DeleteOperation. This method does not modify any billing account information on the underlying GCP Project. To call AddFirebase, a project member or service account must have the following permissions (the IAM roles of Editor and Owner contain these permissions): firebase.projects.update, resourcemanager.projects.get, serviceusage.services.enable, and serviceusage.services.get.

addGoogleAnalytics$ clj

(addGoogleAnalytics$ auth parameters body)

https://firebase.google.comapi/reference/rest/v1beta1/projects/addGoogleAnalytics

Required parameters: parent

Optional parameters: none

Body:

{:analyticsAccountId string, :analyticsPropertyId string}

Links the specified FirebaseProject with an existing Google Analytics account. Using this call, you can either: - Specify an analyticsAccountId to provision a new Google Analytics property within the specified account and associate the new property with the FirebaseProject. - Specify an existing analyticsPropertyId to associate the property with the FirebaseProject. Note that when you call AddGoogleAnalytics: 1. The first check determines if any existing data streams in the Google Analytics property correspond to any existing Firebase Apps in the FirebaseProject (based on the packageName or bundleId associated with the data stream). Then, as applicable, the data streams and apps are linked. Note that this auto-linking only applies to AndroidApps and IosApps. 2. If no corresponding data streams are found for the Firebase Apps, new data streams are provisioned in the Google Analytics property for each of the Firebase Apps. Note that a new data stream is always provisioned for a Web App even if it was previously associated with a data stream in the Analytics property. Learn more about the hierarchy and structure of Google Analytics accounts in the Analytics documentation. The result of this call is an Operation. Poll the Operation to track the provisioning process by calling GetOperation until done is true. When done is true, the Operation has either succeeded or failed. If the Operation succeeded, its response is set to an AnalyticsDetails; if the Operation failed, its error is set to a google.rpc.Status. To call AddGoogleAnalytics, a project member must be an Owner for the existing FirebaseProject and have the Edit permission for the Google Analytics account. If the FirebaseProject already has Google Analytics enabled, and you call AddGoogleAnalytics using an analyticsPropertyId that's different from the currently associated property, then the call will fail. Analytics may have already been enabled in the Firebase console or by specifying timeZone and regionCode in the call to AddFirebase.

androidApps-create$ clj

(androidApps-create$ auth parameters body)

https://firebase.google.comapi/reference/rest/v1beta1/projects/androidApps/create

Required parameters: parent

Optional parameters: none

Body:

{:appId string, :displayName string, :name string, :packageName string, :projectId string}

Requests the creation of a new AndroidApp in the specified FirebaseProject. The result of this call is an Operation which can be used to track the provisioning process. The Operation is automatically deleted after completion, so there is no need to call DeleteOperation.

androidApps-get$ clj

(androidApps-get$ auth parameters)

https://firebase.google.comapi/reference/rest/v1beta1/projects/androidApps/get

Required parameters: name

Optional parameters: none

Gets the specified AndroidApp.

androidApps-getConfig$ clj

(androidApps-getConfig$ auth parameters)

https://firebase.google.comapi/reference/rest/v1beta1/projects/androidApps/getConfig

Required parameters: name

Optional parameters: none

Gets the configuration artifact associated with the specified AndroidApp.

androidApps-list$ clj

(androidApps-list$ auth parameters)

https://firebase.google.comapi/reference/rest/v1beta1/projects/androidApps/list

Required parameters: parent

Optional parameters: pageSize, pageToken

Lists each AndroidApp associated with the specified FirebaseProject. The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests are made with a pageToken.

androidApps-patch$ clj

(androidApps-patch$ auth parameters body)

https://firebase.google.comapi/reference/rest/v1beta1/projects/androidApps/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:appId string, :displayName string, :name string, :packageName string, :projectId string}

Updates the attributes of the specified AndroidApp.

androidApps-sha-create$ clj

(androidApps-sha-create$ auth parameters body)

https://firebase.google.comapi/reference/rest/v1beta1/projects/androidApps/sha/create

Required parameters: parent

Optional parameters: none

Body:

{:certType string, :shaHash string, :name string}

Adds a ShaCertificate to the specified AndroidApp.

androidApps-sha-delete$ clj

(androidApps-sha-delete$ auth parameters)

https://firebase.google.comapi/reference/rest/v1beta1/projects/androidApps/sha/delete

Required parameters: name

Optional parameters: none

Removes a ShaCertificate from the specified AndroidApp.

androidApps-sha-list$ clj

(androidApps-sha-list$ auth parameters)

https://firebase.google.comapi/reference/rest/v1beta1/projects/androidApps/sha/list

Required parameters: parent

Optional parameters: none

Lists the SHA-1 and SHA-256 certificates for the specified AndroidApp.

availableLocations-list$ clj

(availableLocations-list$ auth parameters)

https://firebase.google.comapi/reference/rest/v1beta1/projects/availableLocations/list

Required parameters: parent

Optional parameters: pageToken, pageSize

Lists the valid Google Cloud Platform (GCP) resource locations for the specified Project (including a FirebaseProject). One of these locations can be selected as the Project's default GCP resource location, which is the geographical location where the Project's resources, such as Cloud Firestore, will be provisioned by default. However, if the default GCP resource location has already been set for the Project, then this setting cannot be changed. This call checks for any possible location restrictions for the specified Project and, thus, might return a subset of all possible GCP resource locations. To list all GCP resource locations (regardless of any restrictions), call the endpoint without specifying a unique project identifier (that is, /v1beta1/{parent=projects/-}/listAvailableLocations). To call ListAvailableLocations with a specified project, a member must be at minimum a Viewer of the Project. Calls without a specified project do not require any specific project permissions.

defaultLocation-finalize$ clj

(defaultLocation-finalize$ auth parameters body)

https://firebase.google.comapi/reference/rest/v1beta1/projects/defaultLocation/finalize

Required parameters: parent

Optional parameters: none

Body:

{:locationId string}

Sets the default Google Cloud Platform (GCP) resource location for the specified FirebaseProject. This method creates an App Engine application with a default Cloud Storage bucket, located in the specified locationId. This location must be one of the available GCP resource locations. After the default GCP resource location is finalized, or if it was already set, it cannot be changed. The default GCP resource location for the specified FirebaseProject might already be set because either the underlying GCP Project already has an App Engine application or FinalizeDefaultLocation was previously called with a specified locationId. Any new calls to FinalizeDefaultLocation with a different specified locationId will return a 409 error. The result of this call is an Operation, which can be used to track the provisioning process. The response type of the Operation is google.protobuf.Empty. The Operation can be polled by its name using GetOperation until done is true. When done is true, the Operation has either succeeded or failed. If the Operation has succeeded, its response will be set to a google.protobuf.Empty; if the Operation has failed, its error will be set to a google.rpc.Status. The Operation is automatically deleted after completion, so there is no need to call DeleteOperation. All fields listed in the request body are required. To call FinalizeDefaultLocation, a member must be an Owner of the Project.

get$ clj

(get$ auth parameters)

https://firebase.google.comapi/reference/rest/v1beta1/projects/get

Required parameters: name

Optional parameters: none

Gets the specified FirebaseProject.

getAdminSdkConfig$ clj

(getAdminSdkConfig$ auth parameters)

https://firebase.google.comapi/reference/rest/v1beta1/projects/getAdminSdkConfig

Required parameters: name

Optional parameters: none

Gets the configuration artifact associated with the specified FirebaseProject, which can be used by servers to simplify initialization. Typically, this configuration is used with the Firebase Admin SDK initializeApp command.

getAnalyticsDetails$ clj

(getAnalyticsDetails$ auth parameters)

https://firebase.google.comapi/reference/rest/v1beta1/projects/getAnalyticsDetails

Required parameters: name

Optional parameters: none

Gets the Google Analytics details currently associated with the specified FirebaseProject. If the FirebaseProject is not yet linked to Google Analytics, then the response to GetAnalyticsDetails is NOT_FOUND.

iosApps-create$ clj

(iosApps-create$ auth parameters body)

https://firebase.google.comapi/reference/rest/v1beta1/projects/iosApps/create

Required parameters: parent

Optional parameters: none

Body:

{:projectId string, :appId string, :displayName string, :bundleId string, :appStoreId string, :name string}

Requests the creation of a new IosApp in the specified FirebaseProject. The result of this call is an Operation which can be used to track the provisioning process. The Operation is automatically deleted after completion, so there is no need to call DeleteOperation.

iosApps-get$ clj

(iosApps-get$ auth parameters)

https://firebase.google.comapi/reference/rest/v1beta1/projects/iosApps/get

Required parameters: name

Optional parameters: none

Gets the specified IosApp.

iosApps-getConfig$ clj

(iosApps-getConfig$ auth parameters)

https://firebase.google.comapi/reference/rest/v1beta1/projects/iosApps/getConfig

Required parameters: name

Optional parameters: none

Gets the configuration artifact associated with the specified IosApp.

iosApps-list$ clj

(iosApps-list$ auth parameters)

https://firebase.google.comapi/reference/rest/v1beta1/projects/iosApps/list

Required parameters: parent

Optional parameters: pageSize, pageToken

Lists each IosApp associated with the specified FirebaseProject. The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests are made with a pageToken.

iosApps-patch$ clj

(iosApps-patch$ auth parameters body)

https://firebase.google.comapi/reference/rest/v1beta1/projects/iosApps/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:projectId string, :appId string, :displayName string, :bundleId string, :appStoreId string, :name string}

Updates the attributes of the specified IosApp.

list$ clj

(list$ auth parameters)

https://firebase.google.comapi/reference/rest/v1beta1/projects/list

Required parameters: none

Optional parameters: pageToken, pageSize

Lists each FirebaseProject accessible to the caller. The elements are returned in no particular order, but they will be a consistent view of the Projects when additional requests are made with a pageToken. This method is eventually consistent with Project mutations, which means newly provisioned Projects and recent modifications to existing Projects might not be reflected in the set of Projects. The list will include only ACTIVE Projects. Use GetFirebaseProject for consistent reads as well as for additional Project details.

patch$ clj

(patch$ auth parameters body)

https://firebase.google.comapi/reference/rest/v1beta1/projects/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:name string, :projectId string, :projectNumber string, :displayName string, :state string, :resources {:hostingSite string, :locationId string, :realtimeDatabaseInstance string, :storageBucket string}}

Updates the attributes of the specified FirebaseProject. All query parameters are required.

removeAnalytics$ clj

(removeAnalytics$ auth parameters body)

https://firebase.google.comapi/reference/rest/v1beta1/projects/removeAnalytics

Required parameters: parent

Optional parameters: none

Body:

{:analyticsPropertyId string}

Unlinks the specified FirebaseProject from its Google Analytics account. This call removes the association of the specified FirebaseProject with its current Google Analytics property. However, this call does not delete the Google Analytics resources, such as the Google Analytics property or any data streams. These resources may be re-associated later to the FirebaseProject by calling AddGoogleAnalytics and specifying the same analyticsPropertyId. For Android Apps and iOS Apps, this call re-links data streams with their corresponding apps. However, for Web Apps, this call provisions a new data stream for each Web App. To call RemoveAnalytics, a project member must be an Owner for the FirebaseProject.

searchApps$ clj

(searchApps$ auth parameters)

https://firebase.google.comapi/reference/rest/v1beta1/projects/searchApps

Required parameters: parent

Optional parameters: filter, pageToken, pageSize

Lists all available Apps for the specified FirebaseProject. This is a convenience method. Typically, interaction with an App should be done using the platform-specific service, but some tool use-cases require a summary of all known Apps (such as for App selector interfaces).

webApps-create$ clj

(webApps-create$ auth parameters body)

https://firebase.google.comapi/reference/rest/v1beta1/projects/webApps/create

Required parameters: parent

Optional parameters: none

Body:

{:displayName string, :name string, :appUrls [string], :webId string, :appId string, :projectId string}

Requests the creation of a new WebApp in the specified FirebaseProject. The result of this call is an Operation which can be used to track the provisioning process. The Operation is automatically deleted after completion, so there is no need to call DeleteOperation.

webApps-get$ clj

(webApps-get$ auth parameters)

https://firebase.google.comapi/reference/rest/v1beta1/projects/webApps/get

Required parameters: name

Optional parameters: none

Gets the specified WebApp.

webApps-getConfig$ clj

(webApps-getConfig$ auth parameters)

https://firebase.google.comapi/reference/rest/v1beta1/projects/webApps/getConfig

Required parameters: name

Optional parameters: none

Gets the configuration artifact associated with the specified WebApp.

webApps-list$ clj

(webApps-list$ auth parameters)

https://firebase.google.comapi/reference/rest/v1beta1/projects/webApps/list

Required parameters: parent

Optional parameters: pageToken, pageSize

Lists each WebApp associated with the specified FirebaseProject. The elements are returned in no particular order, but will be a consistent view of the Apps when additional requests are made with a pageToken.

webApps-patch$ clj

(webApps-patch$ auth parameters body)

https://firebase.google.comapi/reference/rest/v1beta1/projects/webApps/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:displayName string, :name string, :appUrls [string], :webId string, :appId string, :projectId string}

Updates the attributes of the specified WebApp.