Skip to content

Commit 71157d3

Browse files
prognostikosprognostikos
committed
update source files after build
1 parent d77633c commit 71157d3

2 files changed

Lines changed: 0 additions & 224 deletions

File tree

‎source/includes/resources.md‎

Lines changed: 0 additions & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -1528,115 +1528,6 @@ HTTP/1.1 200 OK
15281528
```
15291529
15301530
1531-
## <a name="resource-fundraiser_invitation">Fundraiser Invitation</a>
1532-
1533-
1534-
An invitation to create a fundraiser for a specific project
1535-
1536-
### Attributes
1537-
1538-
| Name | Type | Description | Example |
1539-
| ------- | ------- | ------- | ------- |
1540-
| **created_at** | *date-time* | when the invitation was created | `"2012-01-01T12:00:00Z"` |
1541-
| **[id](#resource-common)** | *string* | The unique identifier of the fundraiser invitation | `1234567` |
1542-
| **[invitation_link](#resource-common)** | *uri* | | `"https://example.betternow.org/i/invitation-token"` |
1543-
| **[invitee:avatar_url](#resource-user)** | *uri* | The URL for the avatar image for the user. 92x92 pixels | `"https://cdn.example.net/avatar.jpg"` |
1544-
| **[invitee:first_name](#resource-user)** | *string* | The first name of the user | `"Firstname"` |
1545-
| **[invitee:last_name](#resource-user)** | *string* | The last name of the user | `"Lastname"` |
1546-
| **[invitee:middle_name](#resource-user)** | *string* | The middle name of the user (not available in all regions) | `"Middlename"` |
1547-
| **[invitee:private_person_url](#resource-user)** | *uri* | The URL to retreive private information about the user. A secret key is required for this URL | `"https://api.betternow.org/people/3e9344ff-69be-4ab5-a254-07b067325ebe"` |
1548-
| **[inviter:avatar_url](#resource-user)** | *uri* | The URL for the avatar image for the user. 92x92 pixels | `"https://cdn.example.net/avatar.jpg"` |
1549-
| **[inviter:first_name](#resource-user)** | *string* | The first name of the user | `"Firstname"` |
1550-
| **[inviter:last_name](#resource-user)** | *string* | The last name of the user | `"Lastname"` |
1551-
| **[inviter:middle_name](#resource-user)** | *string* | The middle name of the user (not available in all regions) | `"Middlename"` |
1552-
| **[inviter:private_person_url](#resource-user)** | *uri* | The URL to retreive private information about the user. A secret key is required for this URL | `"https://api.betternow.org/people/3e9344ff-69be-4ab5-a254-07b067325ebe"` |
1553-
| **[project:html_url](#resource-common)** | *uri* | The current url to view the project page on BetterNow. This can, and does, change. Requests to old urls will be redirect to the current url. | `"https://dk.betternow.org/projects/helpnow-projekt"` |
1554-
| **[project:id](#resource-common)** | *string* | Unique identifier of project | `1234567` |
1555-
| **[project:name](#resource-common)** | *string* | The name of the Project | `"HelpNows generelle arbejde"` |
1556-
| **[project:url](#resource-common)** | *uri* | | `"https://api.betternow.org/projects/1234567"` |
1557-
| **updated_at** | *date-time* | when invitation was updated | `"2012-01-01T12:00:00Z"` |
1558-
1559-
### Fundraiser Invitation Create
1560-
1561-
Create a fundraiser invitation. Requires a secret key.
1562-
1563-
```
1564-
POST /fundraiser-invitations
1565-
```
1566-
1567-
#### Required Parameters
1568-
1569-
| Name | Type | Description | Example |
1570-
| ------- | ------- | ------- | ------- |
1571-
| **email** | *string* | The email that will be sent the invitation | `"user@example.com"` |
1572-
| **first_name** | *string* | The first name of the user | `"Firstname"` |
1573-
| **inviter_email** | *string* | Must be an exisiting user in the BetterNow system | `"user@example.com"` |
1574-
| **last_name** | *string* | The last name of the user | `"Lastname"` |
1575-
| **project_id** | *string* | Unique identifier of project | `1234567` |
1576-
| **site_id** | *integer* | unique identifier of site | `1234567` |
1577-
1578-
1579-
#### Optional Parameters
1580-
1581-
| Name | Type | Description | Example |
1582-
| ------- | ------- | ------- | ------- |
1583-
| **middle_name** | *string* | The middle name of the user (not available in all regions) | `"Middlename"` |
1584-
1585-
1586-
#### Curl Example
1587-
1588-
```bash
1589-
$ curl -n -X POST https://api.betternow.org/fundraiser-invitations \
1590-
-d '{
1591-
"inviter_email": "user@example.com",
1592-
"site_id": 1234567,
1593-
"project_id": 1234567,
1594-
"email": "user@example.com",
1595-
"first_name": "Firstname",
1596-
"middle_name": "Middlename",
1597-
"last_name": "Lastname"
1598-
}' \
1599-
-H "Content-Type: application/json" \
1600-
-H "Accept: application/vnd.betternow+json; version=1"
1601-
```
1602-
1603-
1604-
#### Response Example
1605-
1606-
```
1607-
HTTP/1.1 200 OK
1608-
```
1609-
1610-
```json
1611-
{
1612-
"created_at": "2012-01-01T12:00:00Z",
1613-
"id": 1234567,
1614-
"inviter": {
1615-
"avatar_url": "https://cdn.example.net/avatar.jpg",
1616-
"first_name": "Firstname",
1617-
"middle_name": "Middlename",
1618-
"last_name": "Lastname",
1619-
"private_person_url": "https://api.betternow.org/people/3e9344ff-69be-4ab5-a254-07b067325ebe"
1620-
},
1621-
"invitee": {
1622-
"avatar_url": "https://cdn.example.net/avatar.jpg",
1623-
"first_name": "Firstname",
1624-
"middle_name": "Middlename",
1625-
"last_name": "Lastname",
1626-
"private_person_url": "https://api.betternow.org/people/3e9344ff-69be-4ab5-a254-07b067325ebe"
1627-
},
1628-
"invitation_link": "https://example.betternow.org/i/invitation-token",
1629-
"project": {
1630-
"id": 1234567,
1631-
"name": "HelpNows generelle arbejde",
1632-
"url": "https://api.betternow.org/projects/1234567",
1633-
"html_url": "https://dk.betternow.org/projects/helpnow-projekt"
1634-
},
1635-
"updated_at": "2012-01-01T12:00:00Z"
1636-
}
1637-
```
1638-
1639-
16401531
## <a name="resource-fundraiser_update">Fundraiser Update</a>
16411532
16421533

‎source/schema.json‎

Lines changed: 0 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -1776,118 +1776,6 @@
17761776
"object"
17771777
]
17781778
},
1779-
"fundraiser_invitation": {
1780-
"$schema": "http://json-schema.org/draft-04/hyper-schema",
1781-
"title": "Fundraiser Invitation",
1782-
"definitions": {
1783-
"created_at": {
1784-
"description": "when the invitation was created",
1785-
"example": "2012-01-01T12:00:00Z",
1786-
"format": "date-time",
1787-
"type": [
1788-
"string"
1789-
]
1790-
},
1791-
"id": {
1792-
"description": "The unique identifier of the fundraiser invitation",
1793-
"$ref": "#/definitions/common/definitions/id"
1794-
},
1795-
"inviter": {
1796-
"description": "The person who created the invitation",
1797-
"$ref": "#/definitions/user/definitions/user_summary"
1798-
},
1799-
"invitee": {
1800-
"description": "The person who has been invited",
1801-
"$ref": "#/definitions/user/definitions/user_summary"
1802-
},
1803-
"invitation_link": {
1804-
"example": "https://example.betternow.org/i/invitation-token",
1805-
"$ref": "#/definitions/common/definitions/url"
1806-
},
1807-
"project": {
1808-
"$ref": "#/definitions/project/definitions/project_summary"
1809-
},
1810-
"updated_at": {
1811-
"description": "when invitation was updated",
1812-
"example": "2012-01-01T12:00:00Z",
1813-
"format": "date-time",
1814-
"type": [
1815-
"string"
1816-
]
1817-
}
1818-
},
1819-
"description": "An invitation to create a fundraiser for a specific project",
1820-
"links": [
1821-
{
1822-
"description": "Create a fundraiser invitation. Requires a secret key.",
1823-
"href": "/fundraiser-invitations",
1824-
"method": "POST",
1825-
"rel": "fundraiser_invitation",
1826-
"title": "Create",
1827-
"schema": {
1828-
"properties": {
1829-
"inviter_email": {
1830-
"description": "Must be an exisiting user in the BetterNow system",
1831-
"$ref": "#/definitions/person/definitions/email"
1832-
},
1833-
"site_id": {
1834-
"$ref": "#/definitions/site/definitions/id"
1835-
},
1836-
"project_id": {
1837-
"$ref": "#/definitions/project/definitions/id"
1838-
},
1839-
"email": {
1840-
"description": "The email that will be sent the invitation",
1841-
"$ref": "#/definitions/person/definitions/email"
1842-
},
1843-
"first_name": {
1844-
"$ref": "#/definitions/person/definitions/first_name"
1845-
},
1846-
"middle_name": {
1847-
"$ref": "#/definitions/person/definitions/middle_name"
1848-
},
1849-
"last_name": {
1850-
"$ref": "#/definitions/person/definitions/last_name"
1851-
}
1852-
},
1853-
"required": [
1854-
"site_id",
1855-
"project_id",
1856-
"inviter_email",
1857-
"email",
1858-
"first_name",
1859-
"last_name"
1860-
]
1861-
}
1862-
}
1863-
],
1864-
"properties": {
1865-
"created_at": {
1866-
"$ref": "#/definitions/fundraiser_invitation/definitions/created_at"
1867-
},
1868-
"id": {
1869-
"$ref": "#/definitions/fundraiser_invitation/definitions/id"
1870-
},
1871-
"inviter": {
1872-
"$ref": "#/definitions/fundraiser_invitation/definitions/inviter"
1873-
},
1874-
"invitee": {
1875-
"$ref": "#/definitions/fundraiser_invitation/definitions/invitee"
1876-
},
1877-
"invitation_link": {
1878-
"$ref": "#/definitions/fundraiser_invitation/definitions/invitation_link"
1879-
},
1880-
"project": {
1881-
"$ref": "#/definitions/fundraiser_invitation/definitions/project"
1882-
},
1883-
"updated_at": {
1884-
"$ref": "#/definitions/fundraiser_invitation/definitions/updated_at"
1885-
}
1886-
},
1887-
"type": [
1888-
"object"
1889-
]
1890-
},
18911779
"fundraiser_update": {
18921780
"$schema": "http://json-schema.org/draft-04/hyper-schema",
18931781
"title": "Fundraiser Update",
@@ -3281,9 +3169,6 @@
32813169
"fundraiser": {
32823170
"$ref": "#/definitions/fundraiser"
32833171
},
3284-
"fundraiser_invitation": {
3285-
"$ref": "#/definitions/fundraiser_invitation"
3286-
},
32873172
"fundraiser_update": {
32883173
"$ref": "#/definitions/fundraiser_update"
32893174
},

0 commit comments

Comments
 (0)