View Source Eli.Admin.Organization (eli v0.1.0)

Summary

Functions

Examples

Eli.Admin.Organization.add_admin_user(
  "Session token",
  "c28de4d1-14ea-4494-99a9-cf7cf9f8f186",
  "user.email@domain.com")

#Req.Response<
  status: 201,
  body: %{
    "data" => %{
      "id" => "d008ae02-29a4-4cf5-95d9-2cd90fc29b4c",
      "user" => %{
        "email" => "user@domain.com",
        "name" => "User Name"
      }
    },
  },
  ...
>

Examples

#Req.Response<
  status: 201,
  body: %{
    "data" => %{
      "description" => "New orgranization description",
      "id" => "bf893f08-72ba-46f7-9320-0aec814d668c",
      "name" => "New Organization"
    }
  },
  ...
>

Examples

#Req.Response<
  status: 204,
  body: ""
  },
  ...
>

Examples

#Req.Response<
  status: 200,
  body: %{
    "data" => %{
      "description" => "A description example",
      "id" => "76f4b18b-e612-438c-a1e2-74b12beccdd1",
      "name" => "Org Name Example"
    }
  },
  ...
>

Examples

#Req.Response<
  status: 200,
  body: %{
    "data" => [
      %{
        "description" => "A description example",
        "id" => "76f4b18b-e612-438c-a1e2-74b12beccdd1",
        "name" => "Org Name Example"
      }
    ],
    "pagination" => %{
      "count" => 1,
      "first" => 1,
      "last" => 1,
      "next" => nil,
      "page" => 1,
      "per_page" => 20,
      "prev" => nil,
      "serie" => []
    }
  },
  ...
>

Examples

Eli.Admin.Organization.list_admin_user(
  "Session token",
  "c28de4d1-14ea-4494-99a9-cf7cf9f8f186")

#Req.Response<
  status: 200,
  body: %{
    "data" => [
      %{
        "id" => "d008ae02-29a4-4cf5-95d9-2cd90fc29b4c",
        "user" => %{
          "email" => "user@domain.com",
          "name" => "User Name"
        }
      }
    ],
    "pagination" => %{
      "count" => 1,
      "first" => 1,
      "last" => 1,
      "next" => nil,
      "page" => 1,
      "per_page" => 20,
      "prev" => nil,
      "serie" => []
    }
  },
  ...
>

Examples

Eli.Admin.Organization.remove_admin_user(
  "Session token",
  "c28de4d1-14ea-4494-99a9-cf7cf9f8f186",
  "47dff89a-97ca-4eca-8057-2a9398d90e03")

#Req.Response<
  status: 204,
  body: "",
  ...
>

Examples

#Req.Response<
  status: 200,
  body: %{
    "data" => %{
      "description" => "New Some description",
      "id" => "00543b54-ab48-458d-b73a-3fe0177315aa",
      "name" => "New name for Organization"
    }
  },
  ...
>

Functions

Link to this function

add_admin_user(session_token, id, email)

View Source

Examples

Eli.Admin.Organization.add_admin_user(
  "Session token",
  "c28de4d1-14ea-4494-99a9-cf7cf9f8f186",
  "user.email@domain.com")

#Req.Response<
  status: 201,
  body: %{
    "data" => %{
      "id" => "d008ae02-29a4-4cf5-95d9-2cd90fc29b4c",
      "user" => %{
        "email" => "user@domain.com",
        "name" => "User Name"
      }
    },
  },
  ...
>
Link to this function

create(session_token, organization)

View Source

Examples

#Req.Response<
  status: 201,
  body: %{
    "data" => %{
      "description" => "New orgranization description",
      "id" => "bf893f08-72ba-46f7-9320-0aec814d668c",
      "name" => "New Organization"
    }
  },
  ...
>
Link to this function

delete(session_token, id)

View Source

Examples

#Req.Response<
  status: 204,
  body: ""
  },
  ...
>

Examples

#Req.Response<
  status: 200,
  body: %{
    "data" => %{
      "description" => "A description example",
      "id" => "76f4b18b-e612-438c-a1e2-74b12beccdd1",
      "name" => "Org Name Example"
    }
  },
  ...
>
Link to this function

list(session_token, page \\ 1, per_page \\ 20)

View Source

Examples

#Req.Response<
  status: 200,
  body: %{
    "data" => [
      %{
        "description" => "A description example",
        "id" => "76f4b18b-e612-438c-a1e2-74b12beccdd1",
        "name" => "Org Name Example"
      }
    ],
    "pagination" => %{
      "count" => 1,
      "first" => 1,
      "last" => 1,
      "next" => nil,
      "page" => 1,
      "per_page" => 20,
      "prev" => nil,
      "serie" => []
    }
  },
  ...
>
Link to this function

list_admin_users(session_token, id, page \\ 1, per_page \\ 20)

View Source

Examples

Eli.Admin.Organization.list_admin_user(
  "Session token",
  "c28de4d1-14ea-4494-99a9-cf7cf9f8f186")

#Req.Response<
  status: 200,
  body: %{
    "data" => [
      %{
        "id" => "d008ae02-29a4-4cf5-95d9-2cd90fc29b4c",
        "user" => %{
          "email" => "user@domain.com",
          "name" => "User Name"
        }
      }
    ],
    "pagination" => %{
      "count" => 1,
      "first" => 1,
      "last" => 1,
      "next" => nil,
      "page" => 1,
      "per_page" => 20,
      "prev" => nil,
      "serie" => []
    }
  },
  ...
>
Link to this function

remove_admin_user(session_token, id, organization_admin_user_id)

View Source

Examples

Eli.Admin.Organization.remove_admin_user(
  "Session token",
  "c28de4d1-14ea-4494-99a9-cf7cf9f8f186",
  "47dff89a-97ca-4eca-8057-2a9398d90e03")

#Req.Response<
  status: 204,
  body: "",
  ...
>
Link to this function

update(session_token, id, organization)

View Source

Examples

#Req.Response<
  status: 200,
  body: %{
    "data" => %{
      "description" => "New Some description",
      "id" => "00543b54-ab48-458d-b73a-3fe0177315aa",
      "name" => "New name for Organization"
    }
  },
  ...
>