Skip to main content

Gcp/gmailpostmastertools

@swamp/gcp/gmailpostmastertoolsv2026.07.29.1· 2d agoMODELS
01README

Google Cloud gmailpostmastertools infrastructure models

02Release Notes
  • Updated: domains, domains_users, domains_trafficstats
03Models3
@swamp/gcp/gmailpostmastertools/domainsv2026.07.29.1domains.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
domainId?stringRequired. The domain to add. e.g., "example.com"
fn create()
Create a domains
fn get(identifier: string)
Get a domains
ArgumentTypeDescription
identifierstringThe name of the domains
fn delete(identifier: string)
Delete the domains
ArgumentTypeDescription
identifierstringThe name of the domains
fn sync(identifier?: string)
Sync domains state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific domains by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List domains resources
ArgumentTypeDescription
pageSize?numberOptional. Requested page size. Server may return fewer domains than requested. If unspecified, the default value for this field is 10. The maximum value for this field is 200.
maxPages?numberMaximum number of pages to fetch (default: 10)
fn get_compliance_status()
get compliance status
fn get_verification_token()
get verification token
fn verify(verificationMethod?: any)
verify
ArgumentTypeDescription
verificationMethod?any

Resources

state(infinite)— Information about a domain registered by the user.
@swamp/gcp/gmailpostmastertools/domains-trafficstatsv2026.07.29.1domains_trafficstats.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
fn get(identifier: string)
Get a trafficStats
ArgumentTypeDescription
identifierstringThe name of the trafficStats
fn sync(identifier?: string)
Sync trafficStats state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific trafficStats by name (e.g. one discovered by list)
fn list(endDate_day?: number, endDate_month?: number, endDate_year?: number, pageSize?: number, startDate_day?: number, startDate_month?: number, startDate_year?: number, maxPages?: number)
List trafficStats resources
ArgumentTypeDescription
endDate_day?numberDay of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
endDate_month?numberMonth of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
endDate_year?numberYear of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
pageSize?numberRequested page size. Server may return fewer TrafficStats than requested. If unspecified, server will pick an appropriate default.
startDate_day?numberDay of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
startDate_month?numberMonth of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
startDate_year?numberYear of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— Email traffic statistics pertaining to a specific date.
@swamp/gcp/gmailpostmastertools/domains-usersv2026.07.29.1domains_users.ts

Global Arguments

ArgumentTypeDescription
accessToken?stringGCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?stringGCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault.
project?stringGCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?stringComma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?stringGCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials.
permission?enumThe permission level that the user has for the specified domain.
userId?stringRequired. The user to create.
accessGranter?stringOutput only. The user that added the current user.
createTime?stringOutput only. The time the user was granted access.
name?stringIdentifier. The resource name of the user. Format: users/{user} Note: {user} is the user's email address.
user?stringThe user's email address.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
fn create()
Create a users
fn get(identifier: string)
Get a users
ArgumentTypeDescription
identifierstringThe name of the users
fn update(identifier?: string)
Update users attributes
ArgumentTypeDescription
identifier?stringTarget a specific users by name (e.g. one discovered by list)
fn delete(identifier: string)
Delete the users
ArgumentTypeDescription
identifierstringThe name of the users
fn sync(identifier?: string)
Sync users state from GCP
ArgumentTypeDescription
identifier?stringTarget a specific users by name (e.g. one discovered by list)
fn list(pageSize?: number, maxPages?: number)
List users resources
ArgumentTypeDescription
pageSize?numberOptional. Requested page size. Server may return fewer users than requested. If unspecified, the default value for this field is 10. The maximum value for this field is 200.
maxPages?numberMaximum number of pages to fetch (default: 10)

Resources

state(infinite)— [Developer Preview](https://developers.google.com/workspace/preview): Informa...
04Previous Versions19
2026.07.21.4
  • Added: domains_users, domains_trafficstats
  • Updated: domains
2026.07.21.1
  • Updated: domains
2026.07.20.2
  • Added: domains_users, domains_trafficstats
  • Updated: domains

Added 2, modified 1 models

2026.07.20.1
  • Updated: domains

Removed 2, modified 1 models

2026.07.19.1
  • Updated: domains, domains_users, domains_trafficstats
2026.07.18.1
  • Updated: domains, domains_users, domains_trafficstats
2026.07.17.3
  • Updated: domains_users
2026.07.17.2
  • Updated: domains_users
2026.07.17.1
  • Updated: domains_users, domains_trafficstats
2026.06.24.1
  • Added: domains_users
  • Updated: domains

Added 1, modified 1 models

2026.06.08.2
  • Updated: domains, domains_trafficstats
2026.06.07.1
  • Updated: domains, domains_trafficstats
2026.06.05.1
  • Added: domains_trafficstats

Added 1 models

2026.05.25.2
  • Updated: domains

Modified 1 models

2026.05.24.1
  • Updated: domains
2026.05.21.2
  • Updated: domains
2026.05.21.1
2026.05.19.2
2026.05.19.1
05Stats
A
100 / 100
Downloads
0
Archive size
36.9 KB
Verified by Swamp
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License declared1/1earned
  • Verified public repository2/2earned
06Platforms
07Labels