Gcp/gmailpostmastertools
@swamp/gcp/gmailpostmastertoolsv2026.07.29.1
01README
Google Cloud gmailpostmastertools infrastructure models
02Release Notes
- Updated: domains, domains_users, domains_trafficstats
03Models
@swamp/gcp/gmailpostmastertools/domainsv2026.07.29.1domains.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP 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? | string | Required. The domain to add. e.g., "example.com" |
fn create()
Create a domains
fn get(identifier: string)
Get a domains
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the domains |
fn delete(identifier: string)
Delete the domains
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the domains |
fn sync(identifier?: string)
Sync domains state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific domains by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List domains resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. 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? | number | Maximum 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
| Argument | Type | Description |
|---|---|---|
| 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
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP 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? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn get(identifier: string)
Get a trafficStats
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the trafficStats |
fn sync(identifier?: string)
Sync trafficStats state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target 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
| Argument | Type | Description |
|---|---|---|
| endDate_day? | number | Day 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? | number | Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| endDate_year? | number | Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| pageSize? | number | Requested page size. Server may return fewer TrafficStats than requested. If unspecified, server will pick an appropriate default. |
| startDate_day? | number | Day 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? | number | Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. |
| startDate_year? | number | Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. |
| maxPages? | number | Maximum 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
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP 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? | enum | The permission level that the user has for the specified domain. |
| userId? | string | Required. The user to create. |
| accessGranter? | string | Output only. The user that added the current user. |
| createTime? | string | Output only. The time the user was granted access. |
| name? | string | Identifier. The resource name of the user. Format: users/{user} Note: {user} is the user's email address. |
| user? | string | The user's email address. |
| parent? | string | The 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
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the users |
fn update(identifier?: string)
Update users attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific users by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the users
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the users |
fn sync(identifier?: string)
Sync users state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific users by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List users resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. 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? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— [Developer Preview](https://developers.google.com/workspace/preview): Informa...
04Previous Versions
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