{
  "type": "object",
  "required": [
    "suppressions"
  ],
  "properties": {
    "suppressions": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "description",
          "id",
          "is_default",
          "name",
          "suppressed"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "description": "The id of the suppression group."
          },
          "name": {
            "type": "string",
            "description": "The name of the suppression group."
          },
          "is_default": {
            "type": "boolean",
            "description": "Indicates if the suppression group  is set as the default."
          },
          "suppressed": {
            "type": "boolean",
            "description": "Indicates if the given email address is suppressed for this group."
          },
          "description": {
            "type": "string",
            "description": "The description of the suppression group."
          }
        }
      },
      "description": "The array of suppression groups."
    }
  }
}

{
  "type": "object",
  "example": {},
  "properties": {}
}

{
  "type": "array",
  "items": {
    "type": "string",
    "format": "email"
  },
  "description": "The email address from your search that do exist in the suppression group."
}

{
  "type": "object",
  "required": [
    "id",
    "name",
    "description",
    "is_default"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "description": "The ID of the suppression group."
    },
    "name": {
      "type": "string",
      "description": "The name of the suppression group."
    },
    "is_default": {
      "type": "boolean",
      "description": "Indicates if this is the default suppression group."
    },
    "description": {
      "type": "string",
      "description": "A brief description of the suppression group."
    }
  }
}

{
  "type": "object",
  "example": {},
  "properties": {}
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/suppression_group"
  }
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/suppression-group-request-base"
    },
    {
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "integer",
          "description": "The ID of the suppression group."
        },
        "unsubscribes": {
          "type": "integer",
          "description": "The number of unsubscribes, or suppressions, in this group."
        },
        "last_email_sent_at": {
          "type": "string",
          "nullable": true
        }
      }
    }
  ]
}

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "The unique identifier of the sender."
        }
      }
    },
    {
      "$ref": "#/components/schemas/senders-id-request-body"
    },
    {
      "type": "object",
      "properties": {
        "locked": {
          "type": "boolean",
          "description": "A sender identity is locked when it is associated with a campaign in the Draft, Scheduled, or In Progress state. You can't update or delete a locked sender identity."
        },
        "verified": {
          "type": "object",
          "properties": {
            "reason": {
              "type": "string",
              "nullable": true,
              "description": "The reason for a verification failure, or null if verification succeeeded or has yet to take place."
            },
            "status": {
              "type": "boolean",
              "description": "Whether the sender identity has been verified. Only verified sender identities can be used to send email."
            }
          },
          "description": "Only verified sender identities can be used to send email."
        },
        "created_at": {
          "type": "integer",
          "description": "The time the sender identity was created."
        },
        "updated_at": {
          "type": "integer",
          "description": "The time the sender identity was last updated."
        }
      }
    }
  ],
  "title": "Sender ID Response Body"
}

{
  "type": "object",
  "example": {},
  "properties": {}
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "scope_group_name": {
      "type": "string",
      "description": "name of feature teammate will be given access to"
    }
  }
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "integer",
        "description": "Request ID"
      },
      "email": {
        "type": "string",
        "description": "Teammate's email"
      },
      "username": {
        "type": "string",
        "description": "Teammate's username"
      },
      "last_name": {
        "type": "string",
        "description": "Teammate's last name"
      },
      "first_name": {
        "type": "string",
        "description": "Teammate's first name"
      },
      "scope_group_name": {
        "type": "string",
        "description": "Name of group of scopes associated to page teammate is requesting access to"
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "result": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "description": "Email address teammate invite will be sent to"
          },
          "token": {
            "type": "string",
            "description": "Invitation token used to identify user"
          },
          "scopes": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of permissions to give teammate if they accept"
          },
          "is_admin": {
            "type": "boolean",
            "description": "Set to true to indicate teammate should have the same set of permissions as parent user"
          },
          "expiration_date": {
            "type": "integer",
            "description": "timestamp indicates when invite will expire. Expiration is 7 days after invite creation"
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "result": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "zip": {
            "type": "string",
            "description": "(optional) Teammate's zip"
          },
          "city": {
            "type": "string",
            "description": "(optional) Teammate's city"
          },
          "email": {
            "type": "string",
            "description": "Teammate's email"
          },
          "phone": {
            "type": "string",
            "description": "(optional) Teammate's phone number"
          },
          "state": {
            "type": "string",
            "description": "(optional) Teammate's state"
          },
          "address": {
            "type": "string",
            "description": "(optional) Teammate's address"
          },
          "country": {
            "type": "string",
            "description": "(optional) Teammate's country"
          },
          "website": {
            "type": "string",
            "description": "(optional) Teammate's website"
          },
          "address2": {
            "type": "string",
            "description": "(optional) Teammate's address"
          },
          "is_admin": {
            "type": "boolean",
            "description": "Set to true if teammate has admin privileges"
          },
          "username": {
            "type": "string",
            "description": "Teammate's username"
          },
          "last_name": {
            "type": "string",
            "description": "Teammate's last name"
          },
          "user_type": {
            "enum": [
              "admin",
              "owner",
              "teammate"
            ],
            "type": "string",
            "description": "Indicate the type of user: owner user, teammate admin user, or normal teammate"
          },
          "first_name": {
            "type": "string",
            "description": "Teammate's first name"
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "zip": {
      "type": "string",
      "description": "(optional) Teammate's zip"
    },
    "city": {
      "type": "string",
      "description": "(optional) Teammate's city"
    },
    "email": {
      "type": "string",
      "description": "Teammate's email"
    },
    "phone": {
      "type": "string",
      "description": "(optional) Teammate's phone number"
    },
    "state": {
      "type": "string",
      "description": "(optional) Teammate's state"
    },
    "scopes": {
      "type": "array",
      "items": {},
      "description": "Scopes associated to teammate"
    },
    "address": {
      "type": "string",
      "description": "(optional) Teammate's address"
    },
    "country": {
      "type": "string",
      "description": "(optional) Teammate's country"
    },
    "website": {
      "type": "string",
      "description": "(optional) Teammate's website"
    },
    "address2": {
      "type": "string",
      "description": "(optional) Teammate's address"
    },
    "is_admin": {
      "type": "boolean",
      "description": "Set to true if teammate has admin privileges"
    },
    "username": {
      "type": "string",
      "description": "Teammate's username"
    },
    "last_name": {
      "type": "string",
      "description": "Teammate's last name"
    },
    "user_type": {
      "enum": [
        "admin",
        "owner",
        "teammate"
      ],
      "type": "string",
      "description": "Indicate the type of user: account owner, teammate admin user, or normal teammate"
    },
    "first_name": {
      "type": "string",
      "description": "Teammate's first name"
    }
  }
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "example": {
    "email": "teammate1@example.com",
    "scopes": [
      "user.profile.read",
      "user.profile.update"
    ],
    "is_admin": false
  },
  "required": [
    "email",
    "scopes",
    "is_admin"
  ],
  "properties": {
    "email": {
      "type": "string",
      "pattern": "^.*@.*\\..*",
      "maxLength": 255,
      "minLength": 5,
      "description": "New teammate's email"
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Set to specify list of scopes that teammate should have. Should be empty if teammate is an admin."
    },
    "is_admin": {
      "type": "boolean",
      "default": false,
      "description": "Set to true if teammate should be an admin user"
    }
  }
}

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "Teammate's email address"
    },
    "token": {
      "type": "string",
      "description": "Token to identify invite"
    },
    "scopes": {
      "type": "array",
      "items": {},
      "description": "Initial set of permissions to give to teammate if they accept the invite"
    },
    "is_admin": {
      "type": "boolean",
      "description": "Set to true if teammate should have admin privileges"
    }
  }
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "Teammate's email address"
    },
    "token": {
      "type": "string",
      "description": "ID to identify invite"
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Initial set of permissions to give to teammate if they accept the invite"
    },
    "is_admin": {
      "type": "boolean",
      "description": "Set to true if teammate should have admin privileges"
    }
  }
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "example": {
    "scopes": [
      "user.profile.read",
      "user.profile.edit"
    ],
    "is_admin": false
  },
  "required": [
    "scopes",
    "is_admin"
  ],
  "properties": {
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Provide list of scopes that should be given to teammate. If specifying list of scopes, is_admin should be set to False."
    },
    "is_admin": {
      "type": "boolean",
      "description": "Set to True if this teammate should be promoted to an admin user. If True, scopes should be an empty array."
    }
  }
}

{
  "type": "object",
  "properties": {
    "zip": {
      "type": "string",
      "description": "(optional) Teammate's zip"
    },
    "city": {
      "type": "string",
      "description": "(optional) Teammate's city"
    },
    "email": {
      "type": "string",
      "description": "Teammate's email address"
    },
    "phone": {
      "type": "string",
      "description": "(optional) Teammate's phone number"
    },
    "state": {
      "type": "string",
      "description": "(optional) Teammate's state"
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Scopes given to teammate"
    },
    "address": {
      "type": "string",
      "description": "(optional) Teammate's address"
    },
    "country": {
      "type": "string",
      "description": "(optional) Teammate's country"
    },
    "website": {
      "type": "string",
      "description": "(optional) Teammate's website"
    },
    "address2": {
      "type": "string",
      "description": "(optional) Teammate's address"
    },
    "is_admin": {
      "type": "boolean",
      "description": "Set to true if teammate has admin priveleges"
    },
    "username": {
      "type": "string",
      "description": "Teammate's username"
    },
    "last_name": {
      "type": "string",
      "description": "Teammate's last name"
    },
    "user_type": {
      "enum": [
        "admin",
        "owner",
        "teammate"
      ],
      "type": "string",
      "description": "Indicate the type of user: owner user, teammate admin user, or normal teammate"
    },
    "first_name": {
      "type": "string",
      "description": "Teammate's first name"
    }
  }
}

{
  "type": "object",
  "example": {},
  "properties": {}
}

{
  "type": "object",
  "example": {
    "name": "example_name"
  },
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 100,
      "description": "The name for the new transactional template."
    }
  }
}

{
  "type": "object",
  "example": {
    "name": "new_example_name"
  },
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 100,
      "description": "The name of the transactional template."
    }
  }
}

{
  "type": "object",
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "description": "The email address currently on file for your account."
    }
  }
}

{
  "type": "object",
  "required": [
    "remain",
    "total",
    "overage",
    "used",
    "last_reset",
    "next_reset",
    "reset_frequency"
  ],
  "properties": {
    "used": {
      "type": "integer",
      "description": "The number of credits that you have used."
    },
    "total": {
      "type": "integer",
      "description": "The total number of credits assigned to your account."
    },
    "remain": {
      "type": "integer",
      "description": "The remaining number of credits available on your account."
    },
    "overage": {
      "type": "integer",
      "description": "The number of overdrawn credits for your account."
    },
    "last_reset": {
      "type": "string",
      "description": "The date that your credit balance was last reset."
    },
    "next_reset": {
      "type": "string",
      "description": "The next date that your credit balance will be reset."
    },
    "reset_frequency": {
      "type": "string",
      "description": "The frequency at which your credit balance will be reset."
    }
  }
}

{
  "type": "object",
  "title": "GET User Account response",
  "required": [
    "type",
    "reputation"
  ],
  "properties": {
    "type": {
      "enum": [
        "free",
        "paid"
      ],
      "type": "string",
      "description": "The type of account for this user."
    },
    "reputation": {
      "type": "number",
      "description": "The sender reputation for this user."
    }
  }
}

{
  "type": "object",
  "title": "GET User Profile response",
  "required": [
    "address",
    "city",
    "company",
    "country",
    "first_name",
    "last_name",
    "phone",
    "state",
    "website",
    "zip"
  ],
  "properties": {
    "zip": {
      "type": "string",
      "description": "The user's zip code."
    },
    "city": {
      "type": "string",
      "description": "The user's city."
    },
    "phone": {
      "type": "string",
      "description": "The user's phone number."
    },
    "state": {
      "type": "string",
      "description": "The user's state."
    },
    "address": {
      "type": "string",
      "description": "The user's address."
    },
    "company": {
      "type": "string",
      "description": "The name of the user's company."
    },
    "country": {
      "type": "string",
      "description": "The user's country."
    },
    "website": {
      "type": "string",
      "description": "The user's website URL."
    },
    "address2": {
      "type": "string",
      "description": "The second line of the user's address."
    },
    "last_name": {
      "type": "string",
      "description": "The user's last name."
    },
    "first_name": {
      "type": "string",
      "description": "The user's first name."
    }
  }
}

{
  "type": "object",
  "required": [
    "username",
    "user_id"
  ],
  "properties": {
    "user_id": {
      "type": "integer",
      "description": "The user ID for your account."
    },
    "username": {
      "type": "string",
      "description": "Your account username."
    }
  }
}

{
  "type": "object",
  "example": {
    "email": "example@example.com"
  },
  "properties": {
    "email": {
      "type": "string",
      "description": "The new email address that you would like to use for your account."
    }
  }
}

{
  "type": "object",
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "description": "The current email address on file for your account."
    }
  }
}

{
  "type": "object",
  "example": {
    "new_password": "new_password",
    "old_password": "old_password"
  },
  "required": [
    "new_password",
    "old_password"
  ],
  "properties": {
    "new_password": {
      "type": "string",
      "description": "The new password you would like to use for your account."
    },
    "old_password": {
      "type": "string",
      "description": "The old password for your account."
    }
  }
}

{
  "type": "object",
  "properties": {}
}

{
  "type": "object",
  "example": {
    "username": "test_username"
  },
  "properties": {
    "username": {
      "type": "string",
      "description": "The new username you would like to use for your account."
    }
  }
}

{
  "type": "object",
  "required": [
    "username"
  ],
  "properties": {
    "username": {
      "type": "string",
      "description": "The current username on file for your account."
    }
  }
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "message"
        ],
        "properties": {
          "field": {
            "type": "string",
            "nullable": true
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "message"
        ],
        "properties": {
          "field": {
            "type": "string",
            "nullable": true
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "message"
        ],
        "properties": {
          "field": {
            "type": "string",
            "nullable": true
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "example": {
    "enabled": true
  },
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean"
    }
  }
}

{
  "type": "object",
  "required": [
    "public_key"
  ],
  "properties": {
    "public_key": {
      "type": "string",
      "description": "The public key you can use to verify the Twilio SendGrid signature."
    }
  }
}

{
  "type": "object",
  "properties": {
    "result": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/parse-setting"
      },
      "description": "The list of your current inbound parse settings."
    }
  }
}

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "date",
      "stats"
    ],
    "properties": {
      "date": {
        "type": "string",
        "description": "The date that the stats were collected."
      },
      "stats": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "metrics": {
              "type": "object",
              "required": [
                "received"
              ],
              "properties": {
                "received": {
                  "type": "number",
                  "description": "The number of emails received and parsed by the Parse Webhook."
                }
              }
            }
          }
        },
        "description": "The Parse Webhook usage statistics."
      }
    }
  }
}

{
  "type": "object",
  "required": [
    "public_key"
  ],
  "properties": {
    "public_key": {
      "type": "string",
      "description": "The public key you can use to verify the Twilio SendGrid signature."
    }
  }
}