Download the PHP package seregazhuk/favro-api without Composer

On this page you can find all versions of the php package seregazhuk/favro-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of seregazhuk/favro-api

Informations about the package favro-api

Favro PHP Api

Dependencies

Library requires CURL extension and PHP 5.6 or above.

Installation

The recommended way to install this library is via Composer. New to Composer?

Quick Start

First of all you need to select your current organization, because nearly all API requests require the organizationId of the organization that these call are being made against. You can set your current organization in two ways: by name or by Id.

You can get all your organization and then set it by id:

Rate limiting

To get your current rate limit information use getRateInfo() method:

Result will be an array of three elements:

Key Description
reset The time at which the current rate limit window resets in UTC.
remaining The number of requests remaining in the current rate limit window.
limit The maximum number of requests permitted to make per hour.

More information about rate limiting is available in the official api docs.

Users

Get all users

The response will be an array of users:

Get a user

Arguments:

Argument Type Description
userId string The id of the user to be retrieved.

The response returns a user object:

Organizations

Get all organizations

The response will be an array of organizations:

Get an organization

Arguments:

Argument Type Description
organizationId string The id of the organization to be retrieved.

The response returns an organization object:

Create an organization

Argument $attributes is an array and contains the following values:

Index Type Description
name string The name of the organization.
shareToUsers array The users who will be invited to the organization. See below for a description of a user share object.

shareToUsers is also an array with the following structure:

Index Type Description
userId string The userId of the existing user. Required if email is not provided.
email string Email. Required if userId is not provided.
role string The role of the user in the organization. Refer to organization roles. Required.
delete boolean Removes user from the organization if value equals to true. Optional.

The response will be the created organization:

Update an organization

Arguments:

Argument Type Description
organizationId string The id of the organization to update.
attributes array Array of attributes to be updated.

attributes is an array with the following structure:

Index Type Description
name string The name of the organization.
members array Update user roles in the organization. See below for a description of a user share object.
shareToUsers array The users who will be invited to the organization. See below for a description of a user share object.

shareToUsers is also an array with the following structure:

Index Type Description
userId string The userId of the existing user. Required if email is not provided.
email string Email. Required if userId is not provided.
role string The role of the user in the organization. Refer to organization roles. Required.
delete boolean Removes user from the organization if value equals to true. Optional.

The response will be the updated organization:

Collections

Get all collections

The response will be a paginated list of collections:

Get an collection

Arguments:

Argument Type Description
collectionId string The id of the collection to be retrieved.

The response returns a collection object:

Create a collection

Argument $attributes is an array and contains the following values:

Index Type Description
name string The name of the collection. Required.
starPage boolean Star the collection for authorized user. Defaults to false.
shareWidgetsByDefault boolean Share widgets to the collection members by default. Defaults to true.
publicSharing string Public share role for the collection. Refer to collection public sharing.
background string The background color of the collection. Refer to collection background.
shareToUsers array The users who will be invited to the collection. See below for a description of a user share object.

shareToUsers is also an array with the following structure:

Index Type Description
userId string The userId of the existing user. Required if email is not provided.
email string Email. Required if userId is not provided.
role string The role of the user in the collection. Refer to collection roles. Required.
delete boolean Removes user from the collection if value equals to true. Optional.

The response will be the created collection:

Update a collection

Arguments:

Argument Type Description
collectionId string The id of the collection to update.
attributes array Array of attributes to be updated.

attributes is an array with the following structure:

Index Type Description
name string The name of the collection. Required.
starPage boolean Star the collection for authorized user. Defaults to false.
shareWidgetsByDefault boolean Share widgets to the collection members by default. Defaults to true.
publicSharing string Public share role for the collection. Refer to collection public sharing.
background string The background color of the collection. Refer to collection background.
shareToUsers array The users who will be invited to the collection. See below for a description of a user share object.

shareToUsers is also an array with the following structure:

Index Type Description
userId string The userId of the existing user. Required if email is not provided.
email string Email. Required if userId is not provided.
role string The role of the user in the collection. Refer to collection roles. Required.
delete boolean Removes user from the collection if value equals to true. Optional.

The response will be the updated collection:

Delete a collection

Arguments:

Argument Type Description
collectionId string The id of the collection to be deleted.

Widgets

Get all widgets

Arguments:

Argument Type Description
collectionId string The id of the collection to filter by. Optional.
includePublic boolean Include publicly shared widgets. Defaults to false.

The response will be a paginated array of widgets:

Get a widget

Arguments:

Argument Type Description
widgetCommonId string The id of the widget to be retrieved.

The response returns a widget object:

Create a widget

Argument $attributes is an array and contains the following values:

Index Type Description
collectionId string The collectionId of the collection to create the widget in. Required.
name string The name of the widget. Required.
type string The type of widget to create. Refer to widget types. Required.
color string The color of the widget icon. Refer to widget colors.
publicSharing string The public sharing level of the widget. Refer to widget public sharing.
shareToUsers array The list of users to share the widget to. See below for a description of a user share object.

shareToUsers is also an array with the following structure:

Index Type Description
userId string The userId of the existing user. Required if email is not provided.
email string Email. Required if userId is not provided.
role string The role of the user on the widget. Refer to widget roles. Required.
delete boolean Removes user from the widget if value equals to true. Optional.

The response will be the created widget:

Update a widget

Arguments:

Argument Type Description
widgetCommonId string The common id of the widget to update. Required
attributes array Array of attributes to be updated.

attributes is an array with the following structure:

Index Type Description
name string The name of the widget. Required.
archive boolean Archive or unarchive widget. Requires collectionId to be specified in the request.
collectionId string The id of the collection where widget will be archived. Required if archive is included in the request.
color string The color of widget label. Look at widget colors.
publicSharing number The public sharing level of the widget. Refer to widget public sharing.
members array Update user roles on the widget. See below for a description of a user share object.
shareToUsers array The list of users to share the widget to. See below for a description of a user share object.

shareToUsers is also an array with the following structure:

Index Type Description
userId string The userId of the existing user. Required if email is not provided.
email string Email. Required if userId is not provided.
role string The role of the user on the widget. Refer to widget roles. Required.
delete boolean Removes user from the widget if value equals to true. Optional.

The response will be the updated widget:

Delete a widget

Arguments:

Argument Type Description
widgetCommonId string The common id of the widget to be deleted. Required.
collectionId string The id of collection where widget will be deleted. Optional. If ommitted all instances of the widget will be deleted.

Columns

Get all columns

Arguments:

Argument Type Description
widgetCommonId string The common id of the widget to filter by. Required.

The response will be a paginated array of columns:

Get a column

Arguments:

Argument Type Description
columnId string The id of the column to be retrieved.

The response returns a column object:

Create a column

Argument $attributes is an array and contains the following values:

Index Type Description
widgetCommonId string The widgetCommonId to create the column on. Required.
name string The name of the column. Required.
position string The position of the column on the widget. By default the column will be placed at the end of the widget. Optional.

The response will be the created column:

Update a column

Arguments:

Argument Type Description
columnId string The id of the column to update.
attributes array Array of attributes to be updated.

attributes is an array with the following structure:

Index Type Description
name string The name of the column.
position string The position of the column.

The response will be the updated column:

Delete a column

Deleting a column will also delete any cards that exist within that column.

Arguments:

Argument Type Description
columnId string The id of the column to be deleted. Required.

Cards

Get Get all cards

In order to use this endpoint you must specify either todoList or one of cardCommonId, widgetCommonId or collectionId.

Arguments:

Argument Type Description
todoList boolean Return cards from todolist only. Defaults to false.
cardCommonId string The common id of the card to filter by.
widgetCommonId string The common id of the widget to filter by.
collectionId string The id of the collection to filter by.
unique boolean If true, return unique cards only. Defaults to false.

The response will be a paginated array of cards:

Get a card

Arguments:

Argument Type Description
cardId string The id of the card to be retrieved. Required.

The response returns a card object:

Create a card

Argument $attributes is an array and contains the following values:

Index Type Description
widgetCommonId string The widgetCommonId to create the card on. One of organizationId, widgetCommonId is required. If not set, the card will be created in the user’s todo list.
laneId string The laneId to create the card in. This is only applicable if creating the card on a widget that has lanes enabled. Optional.
columnId string The columnId to create the card in. It must belong to the widget specified in the widgetCommonId parameter. WidgetCommonId is required if this parameter is set.
parentCardId string If creating a card on a backlog widget, it is possible to create this card as a child of the card specified by this parameter. Optional.
name string The name of the card. Required.
detailedDescription string The detailed description of the card. Supports formatting.
assignmentIds array The list of assignments (array of userIds). Optional.
tags array The list of tag names or card tags that will be added to card. If current tag is not exist in the organization, it will be created.
tagIds array The list of tag IDs, that will be added to card.
startDate string The start date of card. Format ISO-8601.
dueDate string The due date of card. Format ISO-8601.
tasklists array The list of card tasklists.

The response will be the created card:

Update a card

Arguments:

Argument Type Description
cardId string The id of the card to update. Required.
attributes array Array of attributes to be updated.

attributes is an array with the following structure:

Index Type Description
name string The name of the card.
detailedDescription string The detailed description of the card. Supports formatting.
widgetCommonId string The widgetCommonId to commit the card in. Optional.
laneId string The laneId to commit the card in. This is only applicable if creating the card on a widget that has lanes enabled. Optional.
columnId string The columnId to commit the card in. It must belong to the widget specified in the widgetCommonId parameter. Optional.
parentCardId string If commiting a card on a backlog widget, it is possible to create this card as a child of the card specified by this parameter. Optional.
addAssignmentIds array The list of assignments, that will be added to card (array of userIds). Optional.
removeAssignmentIds array The list of assignments, that will be removed from card (array of userIds). Optional.
addTags array The list of tag names or card tags that will be added to the card. If the tag does not exist in the organization it will be created.
addTagIds array A list of tagIds that will be added to card.
removeTags array The list of tag names, that will be removed from card.
removeTagIds array The list of tag IDs, that will be removed from card.
startDate string The start date of card. Format ISO-8601. If null, start date will be removed.
dueDate string The due date of card. Format ISO-8601. If null, due date will be removed.
addTasklists array The list of card tasklists, that will be added to card.

The response will be the updated cards:

Delete a card

Arguments:

Argument Type Description
cardId string The id of card to be deleted. Required.
everywhere boolean If true, all copies of card will be deleted too. Defaults to false.

The response returns an array of cardIds for the cards that were deleted.

Tags

Get all tags

Arguments:

Argument Type Description
name string The name of the tag to filter by. Optional.
color string The color of the tag to filter by. Optional.

The response will be a paginated array of tags:

Get a tag

Argument Type Description
tagId string The id of the tag to be retrieved.

The response returns a tag object:

Create a tag

Argument $attributes is an array and contains the following values:

Index Type Description
cardCommonId string The common id of the card to post the tag on. Required.
name string The name of the tag. Required.
color string The color of the tag. If not specified, color will be selected randomly. Refer to tag colors.

The response will be the created tag:

Update a tag

Argument Type Description
tagId string The id of the tag to update.
attributes array Array of attributes to be updated.

attributes is an array with the following structure:

Index Type Description
name string The name of the tag to edit. Optional.
color string The color of the tag to edit. Optional. Refer to tag colors.

The response will be the updated tag:

Delete a tag

Arguments:

Argument Type Description
tagId string The id of the tag to be deleted. Required.

Tasks

Get all tasks

Arguments:

Argument Type Description
cardCommonId string The card common id to filter by. Required.
taskListId string The task list id to filter by. Optional.

The response will be a paginated array of card tasks:

Get a task

Argument Type Description
taskId string The id of the task to be retrieved.

The response returns a task object:

Create a task

Argument $attributes is an array and contains the following values:

Index Type Description
taskListId string The task list id to post the task on. Required.
name string The name of the task. Required.
position number Task position in the task list. Optional.
completed boolean Task completion state. Optional.

The response will be the created task:

Update a task

Argument Type Description
taskId string The id of the task to update.
attributes array Array of attributes to be updated.

attributes is an array with the following structure:

Index Type Description
name string The name of the task to edit. Optional.
position string Task position in the list. Optional.
completed string Task completion state. Optional.

The response will be the updated task:

Delete a task

Arguments:

Argument Type Description
taskId string The id of the task to be deleted. Required.

Tasklists

Get all tasklists

Arguments:

Argument Type Description
cardCommonId string The card common id to filter by. Required.

The response will be a paginated array of card task lists:

Get a task list

Argument Type Description
taskListId string The id of the task list to be retrieved.

The response returns a task list object:

Create a task list

Argument $attributes is an array and contains the following values:

Index Type Description
cardCommonId string The card common id to post the task list on. Required
name string The name of the task list. Required.
position string Task position of the task list. Optional.
tasks array The list of card task. Optional.

The response will be the created task list:

Update a task list

Argument Type Description
taskId string The id of the task list to update.
attributes array Array of attributes to be updated.

attributes is an array with the following structure:

Index Type Description
name string The name of the task list to edit. Optional.
position number Task position of the task list. Optional.

The response will be the updated task:

Delete a task list

Arguments:

Argument Type Description
taskListId string The id of the task list to be deleted. Required.

Comments

Get all comments

Arguments:

Argument Type Description
cardCommonId string The card common id to filter by. Required.

The response will be a paginated array of comments:

Get a comment

Argument Type Description
commentId string The id of the comment to be retrieved.

The response returns a comment object:

Create a comment

How can I thank you?

Why not star the github repo? I'd love the attention!

Thanks!

All versions of favro-api with dependencies

PHP Build Version
Package Version
Requires php Version >=5.6
guzzlehttp/guzzle Version ^6.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package seregazhuk/favro-api contains the following files

Loading the files please wait ....