ex_heroku_client v0.1.0 Heroku.UserPreferences

Summary

Functions

Calls GET /users/#{user-preferences_identity}/preferences

Calls PATCH /users/#{user-preferences_identity}/preferences

Functions

get(user-preferences_identity)

Calls GET /users/#{user-preferences_identity}/preferences

update(user-preferences_identity, params \\ %{})

Calls PATCH /users/#{user-preferences_identity}/preferences

params is JSON encoded and passed as the request body.

params Schema

{
  "properties": {
    "default-organization": {
      "description": "User's default organization",
      "example": "sushi-inc",
      "readOnly": false,
      "type": [
        "string",
        "null"
      ]
    },
    "dismissed-getting-started": {
      "description": "Whether the user has dismissed the getting started banner",
      "example": true,
      "readOnly": false,
      "type": [
        "boolean",
        "null"
      ]
    },
    "dismissed-github-banner": {
      "description": "Whether the user has dismissed the GitHub link banner",
      "example": true,
      "readOnly": false,
      "type": [
        "boolean",
        "null"
      ]
    },
    "dismissed-org-access-controls": {
      "description": "Whether the user has dismissed the Organization Access Controls banner",
      "example": true,
      "readOnly": false,
      "type": [
        "boolean",
        "null"
      ]
    },
    "dismissed-org-wizard-notification": {
      "description": "Whether the user has dismissed the Organization Wizard",
      "example": true,
      "readOnly": false,
      "type": [
        "boolean",
        "null"
      ]
    },
    "dismissed-pipelines-banner": {
      "description": "Whether the user has dismissed the Pipelines banner",
      "example": true,
      "readOnly": false,
      "type": [
        "boolean",
        "null"
      ]
    },
    "dismissed-pipelines-github-banner": {
      "description": "Whether the user has dismissed the GitHub banner on a pipeline overview",
      "example": true,
      "readOnly": false,
      "type": [
        "boolean",
        "null"
      ]
    },
    "dismissed-pipelines-github-banners": {
      "additionalItems": true,
      "description": "Which pipeline uuids the user has dismissed the GitHub banner for",
      "example": [
        "96c68759-f310-4910-9867-e0b062064098"
      ],
      "items": {
        "description": "unique identifier of pipeline",
        "example": "01234567-89ab-cdef-0123-456789abcdef",
        "format": "uuid",
        "readOnly": true,
        "type": [
          "string"
        ]
      },
      "readOnly": false,
      "type": [
        "null",
        "array"
      ]
    },
    "dismissed-sms-banner": {
      "description": "Whether the user has dismissed the 2FA SMS banner",
      "example": true,
      "readOnly": false,
      "type": [
        "boolean",
        "null"
      ]
    },
    "timezone": {
      "description": "User's default timezone",
      "example": "UTC",
      "readOnly": false,
      "type": [
        "string",
        "null"
      ]
    }
  }
}