mangopay v0.1.0 MangoPay.PermissionGroup

Functions for MangoPay permission group.

Link to this section Summary

Functions

List all permission groups

List all permission groups

Create a permission_group

Create a permission_group

Get a permission_group

Get a permission_group

Get path called

Get path called

Update a permission_group

Update a permission_group

Link to this section Functions

Link to this function all(query \\ %{})

List all permission groups.

Examples

query                    = %{
  "Page": 1,
  "Per_Page": 25,
  "Sort": "CreationDate:DESC"
}
{:ok, permission_groups} = MangoPay.PermissionGroups.all(query)
Link to this function all!(query \\ %{})

List all permission groups.

Examples

query             = %{
  "Page": 1,
  "Per_Page": 25,
  "Sort": "CreationDate:DESC"
}
permission_groups = MangoPay.PermissionGroups.all!(query)

Create a permission_group.

Examples

params         = %{
  "Tag": "custom meta",
  "Name": "Users only",
  "Scopes": %{
    "ClientDetails": %{
      "Read": false,
      "Edit": false,
      "Create": false
    }
  }
}
{:ok, permission_group} = MangoPay.PermissionGroup.create(params)
Link to this function create!(params)

Create a permission_group.

Examples

params         = %{
  "Tag": "custom meta",
  "Name": "Users only",
  "Scopes": %{
    "ClientDetails": %{
      "Read": false,
      "Edit": false,
      "Create": false
    }
  }
}
permission_group = MangoPay.PermissionGroup.create!(params)

Get a permission_group.

Examples

{:ok, permission_group} = MangoPay.PermissionGroup.get(id)

Get a permission_group.

Examples

permission_group = MangoPay.PermissionGroup.get!(id)

Get path called.

Examples

"/users" = MangoPay.User.path()

Get path called.

Examples

"/users/id" = MangoPay.User.path(id)
Link to this function update(id, params)

Update a permission_group.

Examples

params         = %{
  "Tag": "custom meta",
  "Name": "Users only",
  "Scopes": %{
    "ClientDetails": %{
      "Read": false,
      "Edit": false,
      "Create": false
    }
  }
}
{:ok, permission_group} = MangoPay.PermissionGroup.update(id, params)
Link to this function update!(id, params)

Update a permission_group.

Examples

params         = %{
  "Tag": "custom meta",
  "Name": "Users only",
  "Scopes": %{
    "ClientDetails": %{
      "Read": false,
      "Edit": false,
      "Create": false
    }
  }
}
permission_group = MangoPay.PermissionGroup.update(id, params)