{ "openapi": "3.1.0", "info": { "title": "Givebutter API Documentation", "version": "1.0.0", "description": "Givebutter Public API - Access and manage your campaigns, contacts, transactions, and more." }, "servers": [ { "url": "https:\/\/api.givebutter.com\/" } ], "security": [ { "http": [] } ], "paths": { "\/v1\/campaigns\/{campaign}\/discount-codes": { "get": { "operationId": "campaigns.discount-codes.index", "summary": "List all discount codes", "tags": [ "Campaign Discount Codes" ], "parameters": [ { "name": "campaign", "in": "path", "required": true, "description": "The campaign ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Paginated set of `CampaignDiscountCodeResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CampaignDiscountCodeResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } }, "post": { "operationId": "campaigns.discount-codes.store", "summary": "Create a discount code", "tags": [ "Campaign Discount Codes" ], "parameters": [ { "name": "campaign", "in": "path", "required": true, "description": "The campaign ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StoreCampaignDiscountCodeRequest" } } } }, "responses": { "200": { "description": "`CampaignDiscountCodeResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CampaignDiscountCodeResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/v1\/campaigns\/{campaign}\/discount-codes\/{discountCode}": { "get": { "operationId": "campaigns.discount-codes.show", "summary": "Get a discount code", "tags": [ "Campaign Discount Codes" ], "parameters": [ { "name": "campaign", "in": "path", "required": true, "description": "The campaign ID", "schema": { "type": "integer" } }, { "name": "discountCode", "in": "path", "required": true, "description": "The discount code ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`CampaignDiscountCodeResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CampaignDiscountCodeResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } }, "put": { "operationId": "campaigns.discount-codes.update", "summary": "Update a discount code", "tags": [ "Campaign Discount Codes" ], "parameters": [ { "name": "campaign", "in": "path", "required": true, "description": "The campaign ID", "schema": { "type": "integer" } }, { "name": "discountCode", "in": "path", "required": true, "description": "The discount code ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateCampaignDiscountCodeRequest" } } } }, "responses": { "200": { "description": "`CampaignDiscountCodeResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CampaignDiscountCodeResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "delete": { "operationId": "campaigns.discount-codes.destroy", "summary": "Delete a discount code", "tags": [ "Campaign Discount Codes" ], "parameters": [ { "name": "campaign", "in": "path", "required": true, "description": "The campaign ID", "schema": { "type": "integer" } }, { "name": "discountCode", "in": "path", "required": true, "description": "The discount code ID", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content" }, "422": { "description": "An error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "Cannot delete a discount code that has been used. Please update its status to inactive." } }, "required": [ "message" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/v1\/campaigns\/{campaign}\/members": { "get": { "operationId": "campaigns.members.index", "summary": "List all campaign members", "tags": [ "Campaign Members" ], "parameters": [ { "name": "campaign", "in": "path", "required": true, "description": "The campaign ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Paginated set of `CampaignMemberResource`", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CampaignMemberResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] }, { "type": "object" } ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/v1\/campaigns\/{campaign}\/members\/{member}": { "get": { "operationId": "campaigns.members.show", "summary": "Get a campaign member", "tags": [ "Campaign Members" ], "parameters": [ { "name": "campaign", "in": "path", "required": true, "description": "The campaign ID", "schema": { "type": "integer" } }, { "name": "member", "in": "path", "required": true, "description": "The member ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`CampaignMemberResource`", "content": { "application\/json": { "schema": { "anyOf": [ { "$ref": "#\/components\/schemas\/CampaignMemberResource" }, { "type": "object" } ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } }, "delete": { "operationId": "campaigns.members.destroy", "summary": "Delete a campaign member", "tags": [ "Campaign Members" ], "parameters": [ { "name": "campaign", "in": "path", "required": true, "description": "The campaign ID", "schema": { "type": "integer" } }, { "name": "member", "in": "path", "required": true, "description": "The member ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/v1\/campaigns\/{campaign}\/teams": { "get": { "operationId": "campaigns.teams.index", "summary": "List all campaign teams", "tags": [ "Campaign Teams" ], "parameters": [ { "name": "campaign", "in": "path", "required": true, "description": "The campaign ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Paginated set of `CampaignTeamResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CampaignTeamResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/v1\/campaigns\/{campaign}\/teams\/{team}": { "get": { "operationId": "campaigns.teams.show", "summary": "Get a campaign team", "tags": [ "Campaign Teams" ], "parameters": [ { "name": "campaign", "in": "path", "required": true, "description": "The campaign ID", "schema": { "type": "integer" } }, { "name": "team", "in": "path", "required": true, "description": "The team ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`CampaignTeamResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CampaignTeamResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } }, "delete": { "operationId": "campaigns.teams.destroy", "summary": "Delete a campaign team", "tags": [ "Campaign Teams" ], "parameters": [ { "name": "campaign", "in": "path", "required": true, "description": "The campaign ID", "schema": { "type": "integer" } }, { "name": "team", "in": "path", "required": true, "description": "The team ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/v1\/campaigns\/{campaign}\/items\/tickets": { "get": { "operationId": "campaigns.items.tickets.index", "summary": "List all campaign tickets", "tags": [ "Campaign Tickets" ], "parameters": [ { "name": "campaign", "in": "path", "required": true, "description": "The campaign ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Paginated set of `CampaignItemTicketResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CampaignItemTicketResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } }, "post": { "operationId": "campaigns.items.tickets.store", "summary": "Create a campaign ticket", "tags": [ "Campaign Tickets" ], "parameters": [ { "name": "campaign", "in": "path", "required": true, "description": "The campaign ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StoreCampaignItemTicketRequest" } } } }, "responses": { "200": { "description": "`CampaignItemTicketResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CampaignItemTicketResource" } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/v1\/campaigns\/{campaign}\/items\/tickets\/{ticketId}": { "get": { "operationId": "campaigns.items.tickets.show", "summary": "Get a campaign ticket", "tags": [ "Campaign Tickets" ], "parameters": [ { "name": "campaign", "in": "path", "required": true, "description": "The campaign ID", "schema": { "type": "integer" } }, { "name": "ticketId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`CampaignItemTicketResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CampaignItemTicketResource" } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/v1\/campaigns": { "get": { "operationId": "campaigns.index", "summary": "List all campaigns", "tags": [ "Campaigns" ], "parameters": [ { "name": "scope", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Paginated set of `CampaignResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CampaignResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 }, "unfiltered_total": { "type": "string" } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total", "unfiltered_total" ] } }, "required": [ "data", "links", "meta" ] } } } } } }, "post": { "operationId": "campaigns.store", "summary": "Create a campaign", "tags": [ "Campaigns" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StoreCampaignRequest" } } } }, "responses": { "200": { "description": "`CampaignResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CampaignResource" } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/v1\/campaigns\/{campaign}": { "get": { "operationId": "campaigns.show", "summary": "Get a campaign", "tags": [ "Campaigns" ], "parameters": [ { "name": "campaign", "in": "path", "required": true, "description": "The campaign ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`CampaignResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CampaignResource" } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } }, "put": { "operationId": "campaigns.update", "summary": "Update a campaign", "tags": [ "Campaigns" ], "parameters": [ { "name": "campaign", "in": "path", "required": true, "description": "The campaign ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateCampaignRequest" } } } }, "responses": { "200": { "description": "`CampaignResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CampaignResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } }, "delete": { "operationId": "campaigns.destroy", "summary": "Delete a campaign", "tags": [ "Campaigns" ], "parameters": [ { "name": "campaign", "in": "path", "required": true, "description": "The campaign ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "" }, "409": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string", "const": "This campaign has already raised money, and can not be deleted." } }, "required": [ "message" ] } }, "required": [ "error" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/v1\/contacts\/{contact}\/activities": { "get": { "operationId": "contacts.activities.index", "summary": "List all contact activities", "tags": [ "Contact Activities" ], "parameters": [ { "name": "contact", "in": "path", "required": true, "description": "The contact ID", "schema": { "type": "integer" } }, { "name": "type", "in": "query", "schema": { "$ref": "#\/components\/schemas\/ContactActivityTypeEnum" } } ], "responses": { "200": { "description": "Paginated set of `ContactActivityResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ContactActivityResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } }, "post": { "operationId": "contacts.activities.store", "summary": "Create a contact activity", "tags": [ "Contact Activities" ], "parameters": [ { "name": "contact", "in": "path", "required": true, "description": "The contact ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StoreContactActivityRequest" } } } }, "responses": { "200": { "description": "`ContactActivityResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ContactActivityResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/v1\/contacts\/{contact}\/activities\/{activity}": { "get": { "operationId": "contacts.activities.show", "summary": "Get a contact activity", "tags": [ "Contact Activities" ], "parameters": [ { "name": "contact", "in": "path", "required": true, "description": "The contact ID", "schema": { "type": "integer" } }, { "name": "activity", "in": "path", "required": true, "description": "The activity ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ContactActivityResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ContactActivityResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } }, "put": { "operationId": "contacts.activities.update", "summary": "Update a contact activity", "tags": [ "Contact Activities" ], "parameters": [ { "name": "contact", "in": "path", "required": true, "description": "The contact ID", "schema": { "type": "integer" } }, { "name": "activity", "in": "path", "required": true, "description": "The activity ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ContactActivityResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ContactActivityResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } }, "delete": { "operationId": "contacts.activities.destroy", "summary": "Delete a contact activity", "tags": [ "Contact Activities" ], "parameters": [ { "name": "contact", "in": "path", "required": true, "description": "The contact ID", "schema": { "type": "integer" } }, { "name": "activity", "in": "path", "required": true, "description": "The activity ID", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/v1\/contacts\/{contact}\/tags\/add": { "post": { "operationId": "contactTag.store", "summary": "Add tags to a contact", "tags": [ "Contact Tags" ], "parameters": [ { "name": "contact", "in": "path", "required": true, "description": "The contact ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string", "maxLength": 64 }, "minItems": 1 } }, "required": [ "tags" ] } } } }, "responses": { "200": { "description": "`ContactResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ContactResource" } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/v1\/contacts\/{contact}\/tags\/remove": { "post": { "operationId": "contactTag.destroy", "summary": "Remove tags from a contact", "tags": [ "Contact Tags" ], "parameters": [ { "name": "contact", "in": "path", "required": true, "description": "The contact ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string", "maxLength": 64 }, "minItems": 1 } }, "required": [ "tags" ] } } } }, "responses": { "200": { "description": "`ContactResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ContactResource" } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/v1\/contacts\/{contact}\/tags\/sync": { "post": { "operationId": "contactTag.sync", "summary": "Sync tags for a contact", "tags": [ "Contact Tags" ], "parameters": [ { "name": "contact", "in": "path", "required": true, "description": "The contact ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string", "maxLength": 64 }, "minItems": 1 } }, "required": [ "tags" ] } } } }, "responses": { "200": { "description": "`ContactResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ContactResource" } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" } } } }, "\/v1\/contacts": { "get": { "operationId": "contacts.index", "summary": "List all contacts", "tags": [ "Contacts" ], "parameters": [ { "name": "type", "in": "query", "schema": { "$ref": "#\/components\/schemas\/ContactType" } }, { "name": "createdAfter", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "createdBefore", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "updatedAfter", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "updatedBefore", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "totalContributionsMin", "in": "query", "schema": { "type": [ "number", "null" ] } }, { "name": "totalContributionsMax", "in": "query", "schema": { "type": [ "number", "null" ] } }, { "name": "recurringContributionsMin", "in": "query", "schema": { "type": [ "number", "null" ] } }, { "name": "recurringContributionsMax", "in": "query", "schema": { "type": [ "number", "null" ] } }, { "name": "tags", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "sortBy", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "name_or_company", "primary_email", "point_of_contact", "created_at", "total_contributions", "recurring_contributions", "last_donation_amount" ] } }, { "name": "sortByDesc", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "name_or_company", "primary_email", "point_of_contact", "created_at", "total_contributions", "recurring_contributions", "last_donation_amount" ] } }, { "name": "email", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "primaryEmail", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "firstName", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 1000 } }, { "name": "lastName", "in": "query", "schema": { "type": [ "string", "null" ], "maxLength": 1000 } } ], "responses": { "200": { "description": "Paginated set of `ContactResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ContactResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "post": { "operationId": "contacts.store", "summary": "Create a contact", "tags": [ "Contacts" ], "requestBody": { "content": { "application\/json": { "schema": { "allOf": [ { "$ref": "#\/components\/schemas\/StoreContactRequest" }, { "type": "object", "properties": { "force_create": { "type": "boolean", "default": false } } } ] } } } }, "responses": { "200": { "description": "`ContactResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ContactResource" } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/v1\/contacts\/{contact}": { "get": { "operationId": "contacts.show", "summary": "Get a contact", "tags": [ "Contacts" ], "parameters": [ { "name": "contact", "in": "path", "required": true, "description": "The contact ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ContactResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ContactResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } }, "put": { "operationId": "contacts.update", "summary": "Update a contact", "tags": [ "Contacts" ], "parameters": [ { "name": "contact", "in": "path", "required": true, "description": "The contact ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateContactRequest" } } } }, "responses": { "200": { "description": "`ContactResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ContactResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } }, "delete": { "operationId": "contacts.destroy", "summary": "Delete a contact", "tags": [ "Contacts" ], "parameters": [ { "name": "contact", "in": "path", "required": true, "description": "The contact ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/v1\/contacts\/{contact}\/restore": { "patch": { "operationId": "contact.restore", "summary": "Restore a contact", "tags": [ "Contacts" ], "parameters": [ { "name": "contact", "in": "path", "required": true, "description": "The contact ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ContactResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ContactResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/v1\/funds": { "get": { "operationId": "funds.index", "summary": "List all funds", "tags": [ "Funds" ], "responses": { "200": { "description": "Paginated set of `FundResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/FundResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } } } }, "post": { "operationId": "funds.store", "summary": "Create a fund", "tags": [ "Funds" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255 }, "code": { "type": [ "string", "null" ], "maxLength": 255 } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "`FundResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/FundResource" } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/v1\/funds\/{fund}": { "get": { "operationId": "funds.show", "summary": "Get a fund", "tags": [ "Funds" ], "parameters": [ { "name": "fund", "in": "path", "required": true, "description": "The fund fid", "schema": { "type": [ "string", "null" ] } } ], "responses": { "200": { "description": "`FundResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/FundResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } }, "put": { "operationId": "funds.update", "summary": "Update a fund", "tags": [ "Funds" ], "parameters": [ { "name": "fund", "in": "path", "required": true, "description": "The fund fid", "schema": { "type": [ "string", "null" ] } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255 }, "code": { "type": [ "string", "null" ], "maxLength": 255 } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "`FundResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/FundResource" } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } }, "delete": { "operationId": "funds.destroy", "summary": "Delete a fund", "tags": [ "Funds" ], "parameters": [ { "name": "fund", "in": "path", "required": true, "description": "The fund fid", "schema": { "type": [ "string", "null" ] } } ], "responses": { "200": { "description": "" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/v1\/households\/{household}\/contacts": { "get": { "operationId": "households.contacts.index", "summary": "List all contacts associated with a household", "tags": [ "Household Contacts" ], "parameters": [ { "name": "household", "in": "path", "required": true, "description": "The household ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Paginated set of `ContactResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ContactResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } }, "post": { "operationId": "households.contacts.store", "summary": "Add a contact to a household", "tags": [ "Household Contacts" ], "parameters": [ { "name": "household", "in": "path", "required": true, "description": "The household ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "contact_id": { "type": "integer" } }, "required": [ "contact_id" ] } } } }, "responses": { "200": { "description": "`App.Http.Resources.API.HouseholdResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/App.Http.Resources.API.HouseholdResource" } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/v1\/households\/{household}\/contacts\/{contact}": { "get": { "operationId": "households.contacts.show", "summary": "Get a contact associated with a household", "tags": [ "Household Contacts" ], "parameters": [ { "name": "household", "in": "path", "required": true, "description": "The household ID", "schema": { "type": "integer" } }, { "name": "contact", "in": "path", "required": true, "description": "The contact ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`ContactResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ContactResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } }, "delete": { "operationId": "households.contacts.destroy", "summary": "Remove a contact from a household", "tags": [ "Household Contacts" ], "parameters": [ { "name": "household", "in": "path", "required": true, "description": "The household ID", "schema": { "type": "integer" } }, { "name": "contact", "in": "path", "required": true, "description": "The contact ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`App.Http.Resources.API.HouseholdResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/App.Http.Resources.API.HouseholdResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/v1\/households": { "get": { "operationId": "households.index", "summary": "List all households", "tags": [ "Households" ], "parameters": [ { "name": "headContactId", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "contacts", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "query", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "sortBy", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "sortByDesc", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "page", "in": "query", "schema": { "type": "string", "default": 1 } } ], "responses": { "200": { "description": "Array of `HouseholdResource`", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/HouseholdResource" } } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "post": { "operationId": "households.store", "summary": "Create a household", "tags": [ "Households" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/HouseholdStoreRequest" } } } }, "responses": { "200": { "description": "`App.Http.Resources.API.HouseholdResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/App.Http.Resources.API.HouseholdResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/v1\/households\/{household}": { "get": { "operationId": "households.show", "summary": "Get a household", "tags": [ "Households" ], "parameters": [ { "name": "household", "in": "path", "required": true, "description": "The household ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`App.Http.Resources.API.HouseholdResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/App.Http.Resources.API.HouseholdResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } }, "put": { "operationId": "households.update", "summary": "Update a household", "tags": [ "Households" ], "parameters": [ { "name": "household", "in": "path", "required": true, "description": "The household ID", "schema": { "type": "integer" } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/HouseholdUpdateRequest" } } } }, "responses": { "200": { "description": "`App.Http.Resources.API.HouseholdResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/App.Http.Resources.API.HouseholdResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "delete": { "operationId": "households.destroy", "summary": "Delete a household", "tags": [ "Households" ], "parameters": [ { "name": "household", "in": "path", "required": true, "description": "The household ID", "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No content" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/v1\/messages": { "get": { "operationId": "messages.index", "summary": "List all messages", "tags": [ "Messages" ], "responses": { "200": { "description": "Paginated set of `MessageResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/MessageResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } } } } }, "\/v1\/messages\/{message}": { "get": { "operationId": "messages.show", "summary": "Get a message", "tags": [ "Messages" ], "parameters": [ { "name": "message", "in": "path", "required": true, "description": "The message ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`MessageResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/MessageResource" } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/v1\/payouts": { "get": { "operationId": "payouts.index", "summary": "List all payouts", "tags": [ "Payouts" ], "responses": { "200": { "description": "Paginated set of `PayoutResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PayoutResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } } } } }, "\/v1\/payouts\/{payout}": { "get": { "operationId": "payouts.show", "summary": "Get a payout", "tags": [ "Payouts" ], "parameters": [ { "name": "payout", "in": "path", "required": true, "description": "The payout number", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`PayoutResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PayoutResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/v1\/pledges": { "get": { "operationId": "pledges.index", "summary": "List all pledges", "tags": [ "Pledges" ], "responses": { "200": { "description": "Paginated set of `PledgeResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PledgeResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } } } } }, "\/v1\/pledges\/{pledge}": { "get": { "operationId": "pledges.show", "summary": "Get a pledge", "tags": [ "Pledges" ], "parameters": [ { "name": "pledge", "in": "path", "required": true, "description": "The pledge ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`PledgeResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/PledgeResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/v1\/plans": { "get": { "operationId": "plans.index", "summary": "List all recurring plans", "tags": [ "Recurring Plans" ], "parameters": [ { "name": "contacts", "in": "query", "schema": { "type": [ "string", "null" ] } } ], "responses": { "200": { "description": "Paginated set of `RecurringPlanResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/RecurringPlanResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/v1\/plans\/{plan}": { "get": { "operationId": "plans.show", "summary": "Get a recurring plan", "tags": [ "Recurring Plans" ], "parameters": [ { "name": "plan", "in": "path", "required": true, "description": "The plan uid", "schema": { "type": [ "string", "null" ] } }, { "name": "first_name", "in": "query", "schema": { "type": "string", "maxLength": 255 } }, { "name": "last_name", "in": "query", "schema": { "type": "string", "maxLength": 255 } }, { "name": "email", "in": "query", "schema": { "type": "string" } }, { "name": "amount", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`RecurringPlanResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/RecurringPlanResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/sso\/v1\/account": { "get": { "operationId": "sso.account", "tags": [ "Sso Accounts" ], "responses": { "200": { "description": "`SsoAccountResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SsoAccountResource" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/sso\/v1\/campaigns\/{campaign}": { "get": { "operationId": "sso.campaigns.show", "tags": [ "Sso Campaigns" ], "parameters": [ { "name": "campaign", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "`CampaignResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/CampaignResource" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/tickets": { "get": { "operationId": "tickets.index", "summary": "List all tickets", "tags": [ "Tickets" ], "responses": { "200": { "description": "Paginated set of `TicketResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TicketResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } } } } }, "\/v1\/tickets\/{ticket}": { "get": { "operationId": "tickets.show", "summary": "Get a ticket", "tags": [ "Tickets" ], "parameters": [ { "name": "ticket", "in": "path", "required": true, "description": "The ticket uid", "schema": { "type": [ "string", "null" ] } } ], "responses": { "200": { "description": "`TicketResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TicketResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/v1\/transactions": { "get": { "operationId": "transactions.index", "summary": "List all transactions", "tags": [ "Transactions" ], "parameters": [ { "name": "transactedAfter", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "transactedBefore", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "createdAfter", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "createdBefore", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "updatedAfter", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "updatedBefore", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "checkDepositedAfter", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "checkDepositedBefore", "in": "query", "schema": { "type": [ "string", "null" ], "format": "date-time" } }, { "name": "contacts", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "method", "in": "query", "schema": { "type": [ "string", "null" ] } }, { "name": "scope", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "all", "benefiting", "chapters" ] } }, { "name": "sortBy", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "amount", "transacted_at", "created_at", "contact_name" ] } }, { "name": "sortByDesc", "in": "query", "schema": { "type": [ "string", "null" ], "enum": [ "amount", "transacted_at", "created_at", "contact_name" ] } } ], "responses": { "200": { "description": "Paginated set of `TransactionResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TransactionResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 }, "unfiltered_total": { "type": "integer" } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total", "unfiltered_total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } }, "post": { "operationId": "transactions.store", "summary": "Create a transaction", "tags": [ "Transactions" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/StoreTransactionRequest" } } } }, "responses": { "422": { "$ref": "#\/components\/responses\/ValidationException" }, "200": { "description": "`TransactionResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TransactionResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/NotFoundHttpException" } } } }, "\/v1\/transactions\/{transaction}": { "get": { "operationId": "transactions.show", "summary": "Get a transaction", "tags": [ "Transactions" ], "parameters": [ { "name": "transaction", "in": "path", "required": true, "description": "The transaction tid", "schema": { "type": [ "string", "null" ] } } ], "responses": { "200": { "description": "`TransactionResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TransactionResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } }, "put": { "operationId": "transactions.update", "summary": "Update a transaction", "tags": [ "Transactions" ], "parameters": [ { "name": "transaction", "in": "path", "required": true, "description": "The transaction tid", "schema": { "type": [ "string", "null" ] } } ], "requestBody": { "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UpdateTransactionRequest" } } } }, "responses": { "200": { "description": "`TransactionResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/TransactionResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/v1\/webhooks\/{webhook}\/activities": { "get": { "operationId": "webhooks.activities.index", "summary": "List all webhook activities", "tags": [ "Webhook Activities" ], "parameters": [ { "name": "webhook", "in": "path", "required": true, "description": "The webhook ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Paginated set of `WebhookActivityResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WebhookActivityResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/v1\/webhooks\/{webhook}\/activities\/{activity}": { "get": { "operationId": "webhooks.activities.show", "summary": "Get a webhook activity", "tags": [ "Webhook Activities" ], "parameters": [ { "name": "webhook", "in": "path", "required": true, "description": "The webhook ID", "schema": { "type": "string" } }, { "name": "activity", "in": "path", "required": true, "description": "The activity ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`WebhookActivityResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WebhookActivityResource" } } } }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/v1\/webhooks": { "get": { "operationId": "webhooks.index", "summary": "List all webhooks", "tags": [ "Webhooks" ], "responses": { "200": { "description": "Paginated set of `WebhookResource`", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WebhookResource" } }, "links": { "type": "object", "properties": { "first": { "type": [ "string", "null" ] }, "last": { "type": [ "string", "null" ] }, "prev": { "type": [ "string", "null" ] }, "next": { "type": [ "string", "null" ] } }, "required": [ "first", "last", "prev", "next" ] }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer", "minimum": 1 }, "from": { "type": [ "integer", "null" ], "minimum": 1 }, "last_page": { "type": "integer", "minimum": 1 }, "links": { "type": "array", "description": "Generated paginator links.", "items": { "type": "object", "properties": { "url": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "url", "label", "active" ] } }, "path": { "type": [ "string", "null" ], "description": "Base path for paginator generated URLs." }, "per_page": { "type": "integer", "description": "Number of items shown per page.", "minimum": 0 }, "to": { "type": [ "integer", "null" ], "description": "Number of the last item in the slice.", "minimum": 1 }, "total": { "type": "integer", "description": "Total number of items being paginated.", "minimum": 0 } }, "required": [ "current_page", "from", "last_page", "links", "path", "per_page", "to", "total" ] } }, "required": [ "data", "links", "meta" ] } } } } } }, "post": { "operationId": "webhooks.store", "summary": "Create a webhook", "tags": [ "Webhooks" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "event": { "type": "string", "enum": [ "campaign.created", "campaign.updated", "ticket.created", "transaction.succeeded", "contact.created", "plan.canceled", "plan.created", "plan.failed", "plan.paused", "plan.resumed", "plan.updated", "refund.created" ] }, "events": { "type": "array", "items": { "type": "string", "enum": [ "campaign.created", "campaign.updated", "ticket.created", "transaction.succeeded", "contact.created", "plan.canceled", "plan.created", "plan.failed", "plan.paused", "plan.resumed", "plan.updated", "refund.created" ] } }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "enabled": { "type": "boolean" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "`WebhookResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WebhookResource" } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/v1\/webhooks\/{webhook}": { "get": { "operationId": "webhooks.show", "summary": "Get a webhook", "tags": [ "Webhooks" ], "parameters": [ { "name": "webhook", "in": "path", "required": true, "description": "The webhook ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`WebhookResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WebhookResource" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } }, "put": { "operationId": "webhooks.update", "summary": "Update a webhook", "tags": [ "Webhooks" ], "parameters": [ { "name": "webhook", "in": "path", "required": true, "description": "The webhook ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "campaign.created", "campaign.updated", "ticket.created", "transaction.succeeded", "contact.created", "plan.canceled", "plan.created", "plan.failed", "plan.paused", "plan.resumed", "plan.updated", "refund.created" ] }, "minItems": 1 }, "name": { "type": [ "string", "null" ], "maxLength": 255 }, "enabled": { "type": "boolean" } }, "required": [ "url", "events" ] } } } }, "responses": { "200": { "description": "`WebhookResource`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/WebhookResource" } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } }, "delete": { "operationId": "webhooks.destroy", "summary": "Delete a webhook", "tags": [ "Webhooks" ], "parameters": [ { "name": "webhook", "in": "path", "required": true, "description": "The webhook ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } } }, "components": { "securitySchemes": { "http": { "type": "http", "scheme": "bearer" } }, "schemas": { "AddressResource": { "type": "object", "properties": { "id": { "type": "integer" }, "account_id": { "type": [ "integer", "null" ] }, "name": { "type": [ "string", "null" ] }, "address_1": { "type": "string" }, "address_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state": { "type": [ "string", "null" ] }, "zipcode": { "type": [ "string", "null" ] }, "country": { "type": "string" }, "type": { "type": "string" }, "is_primary": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "account_id", "name", "address_1", "address_2", "city", "state", "zipcode", "country", "type", "is_primary", "created_at", "updated_at" ], "title": "AddressResource" }, "App.Http.Resources.API.AddressResource": { "type": "object", "properties": { "address_1": { "type": "string" }, "address_2": { "type": [ "string", "null" ] }, "city": { "type": "string" }, "state": { "type": [ "string", "null" ] }, "zipcode": { "type": [ "string", "null" ] }, "country": { "type": "string" }, "type": { "type": "string" }, "is_primary": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "address_1", "address_2", "city", "state", "zipcode", "country", "type", "is_primary", "created_at", "updated_at" ], "title": "App.Http.Resources.API.AddressResource" }, "App.Http.Resources.API.HouseholdResource": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "head_contact_id": { "type": [ "integer", "null" ] }, "account_id": { "type": "integer" }, "envelope_name": { "type": [ "string", "null" ] }, "note": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "contacts": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ContactResource" } } }, "required": [ "id", "name", "head_contact_id", "account_id", "envelope_name", "note", "created_at", "updated_at" ], "title": "App.Http.Resources.API.HouseholdResource" }, "AssociatedCompanyResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "company_name": { "type": "string" }, "name_display": { "type": "string" }, "title": { "type": "string" }, "twitter_url": { "type": "string" }, "linkedin_url": { "type": "string" }, "facebook_url": { "type": "string" }, "tiktok_url": { "type": "string" }, "instagram_url": { "type": "string" }, "website_url": { "type": "string" }, "image_url": { "type": [ "string", "null" ] }, "emails": { "type": "object", "additionalProperties": {} }, "phones": { "type": "object", "additionalProperties": {} }, "primary_email": { "type": "string" }, "primary_phone": { "type": "string" }, "is_email_subscribed": { "type": "string" }, "is_phone_subscribed": { "type": "string" }, "is_address_subscribed": { "type": "string" }, "address_unsubscribed_at": { "type": "string" }, "note": { "type": "string" }, "addresses": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AddressResource" } }, "primary_address": { "$ref": "#\/components\/schemas\/AddressResource" }, "archived_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "first_time_supporter_at": { "type": "string" } }, "required": [ "id", "type", "company_name", "name_display", "title", "twitter_url", "linkedin_url", "facebook_url", "tiktok_url", "instagram_url", "website_url", "image_url", "emails", "phones", "primary_email", "primary_phone", "is_email_subscribed", "is_phone_subscribed", "is_address_subscribed", "address_unsubscribed_at", "note", "addresses", "primary_address", "archived_at", "created_at", "updated_at", "first_time_supporter_at" ], "title": "AssociatedCompanyResource" }, "CampaignDiscountCodeResource": { "type": "object", "properties": { "id": { "type": "string" }, "campaign_id": { "type": "string" }, "items": { "type": "string" }, "code": { "type": "string" }, "type": { "type": "string" }, "amount": { "type": "number" }, "used": { "type": "string" }, "uses": { "type": "string" }, "active": { "type": "string" }, "all_items": { "type": "string" }, "total_discount": { "type": "string" }, "starts_at": { "type": "string" }, "expires_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "campaign_id", "code", "type", "amount", "used", "uses", "active", "total_discount", "starts_at", "expires_at", "created_at", "updated_at" ], "title": "CampaignDiscountCodeResource" }, "CampaignItemTicketResource": { "type": "object", "properties": { "id": { "type": "string" }, "campaign_id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "price": { "type": "string" }, "total_quantity": { "type": "string" }, "subtype": { "type": "string" }, "active": { "type": "string" }, "retail_price": { "type": "string" }, "bundle_only": { "type": "string" }, "hide_remaining": { "type": "string" }, "scope": { "type": "string" }, "bundles": { "type": "string" }, "custom_fields": { "type": "string" }, "pictures": { "type": "string" } }, "required": [ "id", "campaign_id", "name", "description", "price", "total_quantity", "subtype", "active", "retail_price", "bundle_only", "hide_remaining", "scope", "bundles", "custom_fields", "pictures" ], "title": "CampaignItemTicketResource" }, "CampaignMemberResource": { "type": "object", "properties": { "id": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "display_name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "picture": { "type": "string" }, "raised": { "type": "number" }, "goal": { "type": "integer" }, "donors": { "type": "integer" }, "items": { "type": "integer" }, "url": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "first_name", "last_name", "display_name", "email", "phone", "picture", "raised", "goal", "donors", "items", "url", "created_at", "updated_at" ], "title": "CampaignMemberResource" }, "CampaignResource": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "account_id": { "type": "string" }, "event_id": { "type": "string" }, "type": { "type": "string" }, "title": { "type": "string" }, "subtitle": { "type": "string" }, "description": { "type": "string" }, "slug": { "type": "string" }, "url": { "type": "string" }, "goal": { "type": [ "integer", "null" ] }, "raised": { "type": "number" }, "donors": { "type": "integer" }, "currency": { "type": "string" }, "cover": { "type": "string" }, "status": { "type": "string" }, "timezone": { "type": "string" }, "end_at": { "type": "string" }, "event": { "$ref": "#\/components\/schemas\/EventResource" }, "settings": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CampaignSettingResource" } }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "code", "account_id", "event_id", "type", "title", "subtitle", "description", "slug", "url", "goal", "raised", "donors", "currency", "cover", "status", "timezone", "end_at", "settings", "created_at", "updated_at" ], "title": "CampaignResource" }, "CampaignSettingResource": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "title": "CampaignSettingResource" }, "CampaignTeamResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "logo": { "type": "string" }, "slug": { "type": "string" }, "url": { "type": "string" }, "raised": { "type": "number" }, "goal": { "type": "number" }, "supporters": { "type": "integer" }, "members": { "type": "integer" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "name", "logo", "slug", "url", "raised", "goal", "supporters", "members", "created_at", "updated_at" ], "title": "CampaignTeamResource" }, "ContactActivityResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "source": { "type": "string" }, "data": { "type": "string" }, "resource": { "anyOf": [ { "$ref": "#\/components\/schemas\/TransactionResource" }, { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, { "type": "null" }, { "$ref": "#\/components\/schemas\/RecurringPlanResource" }, { "$ref": "#\/components\/schemas\/TicketResource" }, { "$ref": "#\/components\/schemas\/MessageResource" } ] }, "resource_type": { "type": [ "string", "null" ], "enum": [ "transaction", "plan", "ticket", "message", "mail_piece", "soft_credit", "subscription_log", null ] }, "created_by": { "$ref": "#\/components\/schemas\/PublicUserResource" }, "occurred_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "type", "source", "data", "resource", "resource_type", "occurred_at", "created_at", "updated_at" ], "title": "ContactActivityResource" }, "ContactActivityTypeEnum": { "type": "string", "enum": [ "archived", "campaign.joined", "email", "email.subscribed", "email.unsubscribed", "letter", "meeting", "note", "phone_call", "recurring_plan.canceled", "recurring_plan.created", "recurring_plan.activated", "signup_form.submitted", "sms", "sms.subscribed", "sms.unsubscribed", "subscription_form.submitted", "completed_task", "created_task", "ticket.issued", "transaction.recieved", "transaction.succeeded", "transaction.acknowledged", "transaction.unacknowledged", "unarchived", "volunteer_activity", "soft_credited", "tagged", "untagged", "custom_field.updated", "video_message.sent", "video_message.deleted" ], "title": "ContactActivityTypeEnum" }, "ContactResource": { "type": "object", "properties": { "id": { "type": "string" }, "external_id": { "type": "string" }, "contact_since": { "type": "string" }, "type": { "type": "string" }, "prefix": { "type": "string" }, "first_name": { "type": "string" }, "preferred_name": { "type": "string" }, "middle_name": { "type": "string" }, "last_name": { "type": "string" }, "suffix": { "type": "string" }, "gender": { "type": "string" }, "pronouns": { "type": "string" }, "dob": { "type": "string" }, "company": { "type": "string" }, "employer": { "type": "string" }, "company_name": { "type": "string" }, "point_of_contact": { "anyOf": [ { "$ref": "#\/components\/schemas\/PointOfContactResource" }, { "type": "null" } ] }, "associated_companies": { "type": [ "array", "null" ], "items": { "$ref": "#\/components\/schemas\/AssociatedCompanyResource" } }, "title": { "type": "string" }, "website_url": { "type": "string" }, "twitter_url": { "type": "string" }, "linkedin_url": { "type": "string" }, "facebook_url": { "type": "string" }, "tiktok_url": { "type": "string" }, "instagram_url": { "type": "string" }, "emails": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmailResource" } }, "phones": { "type": "array", "items": { "$ref": "#\/components\/schemas\/PhoneResource" } }, "primary_email": { "type": "string" }, "primary_phone": { "type": "string" }, "note": { "type": "string" }, "addresses": { "type": "array", "items": { "$ref": "#\/components\/schemas\/App.Http.Resources.API.AddressResource" } }, "primary_address": { "anyOf": [ { "$ref": "#\/components\/schemas\/App.Http.Resources.API.AddressResource" }, { "type": "null" } ] }, "last_donation_amount": { "type": "string" }, "stats": { "type": "object", "properties": { "total_contributions": { "type": "string" }, "recurring_contributions": { "type": "string" } }, "required": [ "total_contributions", "recurring_contributions" ] }, "tags": { "type": "string" }, "custom_fields": { "type": "array", "items": {} }, "external_ids": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ExternalIdResource" } }, "is_email_subscribed": { "type": "string" }, "is_phone_subscribed": { "type": "string" }, "is_address_subscribed": { "type": "string" }, "email_opt_in": { "type": "string" }, "sms_opt_in": { "type": "string" }, "address_unsubscribed_at": { "type": "string" }, "archived_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "salutation_name": { "type": "string" } }, "required": [ "id", "external_id", "contact_since", "type", "prefix", "first_name", "preferred_name", "middle_name", "last_name", "suffix", "gender", "pronouns", "dob", "company", "employer", "company_name", "title", "website_url", "twitter_url", "linkedin_url", "facebook_url", "tiktok_url", "instagram_url", "emails", "phones", "primary_email", "primary_phone", "note", "addresses", "primary_address", "last_donation_amount", "stats", "tags", "custom_fields", "external_ids", "is_email_subscribed", "is_phone_subscribed", "is_address_subscribed", "email_opt_in", "sms_opt_in", "address_unsubscribed_at", "archived_at", "created_at", "updated_at", "salutation_name" ], "title": "ContactResource" }, "ContactType": { "type": "string", "enum": [ "individual", "company" ], "title": "ContactType" }, "CustomFieldResponseResource": { "type": "object", "properties": { "id": { "type": "integer" }, "field_id": { "type": "integer" }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "type": { "type": "string" }, "value": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "field_id", "title", "description", "type", "value", "created_at", "updated_at" ], "title": "CustomFieldResponseResource" }, "DedicationResource": { "type": "object", "properties": { "type": { "type": "string" }, "name": { "type": "string" }, "recipient": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] } }, "required": [ "name", "email" ] }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "type", "name", "recipient", "created_at", "updated_at" ], "title": "DedicationResource" }, "DedicationType": { "type": "string", "enum": [ "in_memory_of", "in_honor_of" ], "title": "DedicationType" }, "DiscountCodeType": { "type": "string", "enum": [ "percentage", "fixed" ], "title": "DiscountCodeType" }, "EmailResource": { "type": "object", "properties": { "type": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "type", "value" ], "title": "EmailResource" }, "EventResource": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "type": "string" }, "location_name": { "type": "string" }, "address_formatted": { "type": "string" }, "google_place_id": { "type": "string" }, "start_at": { "type": "string" }, "end_at": { "type": "string" }, "timezone": { "type": "string" }, "details": { "type": "string" }, "private": { "type": "string" }, "tickets_required": { "type": "string" }, "livestream": { "type": "string" }, "livestream_start_at": { "type": "string" }, "livestream_end_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "title", "type", "location_name", "address_formatted", "google_place_id", "start_at", "end_at", "timezone", "details", "private", "tickets_required", "livestream", "livestream_start_at", "livestream_end_at", "created_at", "updated_at" ], "title": "EventResource" }, "ExternalIdResource": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" }, "external_id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "label", "external_id", "created_at", "updated_at" ], "title": "ExternalIdResource" }, "FundResource": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "code": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "raised": { "type": "number" }, "supporters": { "type": "integer" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "code", "name", "raised", "supporters", "created_at", "updated_at" ], "title": "FundResource" }, "GenderEnum": { "type": "string", "enum": [ "male", "female", "other" ], "title": "GenderEnum" }, "GivingSpaceResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "amount": { "type": "number" }, "message": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "name", "amount", "message", "created_at", "updated_at" ], "title": "GivingSpaceResource" }, "HouseholdResource": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "head_contact_id": { "type": [ "integer", "null" ] }, "account_id": { "type": "integer" }, "envelope_name": { "type": [ "string", "null" ] }, "note": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "contacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "account_id": { "type": "string" }, "company_name": { "type": "string" }, "first_name": { "type": "string" }, "first_name_display": { "type": "string" }, "last_name": { "type": "string" }, "last_name_display": { "type": "string" }, "middle_name": { "type": "string" }, "name_display": { "type": "string" }, "pronouns": { "type": "string" }, "primary_email": { "type": "string" }, "primary_phone": { "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "account_id", "company_name", "first_name", "first_name_display", "last_name", "last_name_display", "middle_name", "name_display", "pronouns", "primary_email", "primary_phone", "type" ] } } }, "required": [ "id", "name", "head_contact_id", "account_id", "envelope_name", "note", "created_at", "updated_at" ], "title": "HouseholdResource" }, "HouseholdStoreRequest": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255 }, "head_contact_id": { "type": [ "integer", "null" ] }, "note": { "type": [ "string", "null" ] }, "envelope_name": { "type": [ "string", "null" ], "maxLength": 255 } }, "required": [ "name" ], "title": "HouseholdStoreRequest" }, "HouseholdUpdateRequest": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255 }, "head_contact_id": { "type": [ "integer", "null" ] }, "note": { "type": [ "string", "null" ] }, "envelope_name": { "type": [ "string", "null" ], "maxLength": 255 } }, "title": "HouseholdUpdateRequest" }, "MessageResource": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "channel": { "type": "string" }, "internal_name": { "type": "string" }, "subject": { "type": "string" }, "preheader": { "type": "string" }, "body": { "type": "string" }, "recipient_filters": { "type": "string" }, "recipient_count": { "type": "string" }, "sent_at": { "type": "string" }, "sending_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "status", "channel", "internal_name", "body", "recipient_filters", "recipient_count", "sent_at", "sending_at", "created_at", "updated_at" ], "title": "MessageResource" }, "PaymentMethodEnum": { "type": "string", "enum": [ "ach", "card", "cash", "check", "digital_wallet", "donor_advised_fund", "paypal", "venmo", "cashapp", "terminal", "stock", "in-kind", "property", "other", "none" ], "title": "PaymentMethodEnum" }, "PayoutResource": { "type": "object", "properties": { "id": { "type": "string" }, "campaign_id": { "type": "string" }, "method": { "type": "string" }, "status": { "type": "string" }, "amount": { "type": "number" }, "fee": { "type": "number" }, "tip": { "type": "number" }, "payout": { "type": "number" }, "currency": { "type": "string" }, "address": { "type": "string" }, "memo": { "type": "string" }, "expected_at": { "type": "string" }, "paid_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "campaign_id", "method", "status", "amount", "fee", "tip", "payout", "currency", "memo", "expected_at", "paid_at", "created_at", "updated_at" ], "title": "PayoutResource" }, "PhoneResource": { "type": "object", "properties": { "type": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "type", "value" ], "title": "PhoneResource" }, "PledgeResource": { "type": "object", "properties": { "id": { "type": "string" }, "contact_id": { "type": "string" }, "campaign_id": { "type": "string" }, "fund_id": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string" }, "status_friendly": { "type": "string" }, "amount": { "type": "string" }, "amount_fulfilled": { "type": "string" }, "amount_remaining": { "type": "string" }, "allow_custom_amount": { "type": "string" }, "installment_frequency": { "type": "string" }, "first_installment_date": { "type": "string" }, "next_installment_date": { "type": "string" }, "expected_fulfillment_date": { "type": "string" }, "memo": { "type": "string" }, "auto_remind": { "type": "string" }, "last_reminded_at": { "type": "string" }, "fee_coverage_type": { "type": "string" }, "fee_coverage_visibility": { "type": "string" }, "include_in_campaign_goal": { "type": "string" }, "tips_enabled": { "type": "string" }, "canceled_at": { "type": "string" }, "pledged_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "contact_id", "campaign_id", "fund_id", "type", "status", "status_friendly", "amount", "amount_fulfilled", "amount_remaining", "allow_custom_amount", "installment_frequency", "first_installment_date", "next_installment_date", "expected_fulfillment_date", "memo", "auto_remind", "last_reminded_at", "fee_coverage_type", "fee_coverage_visibility", "include_in_campaign_goal", "tips_enabled", "canceled_at", "pledged_at", "created_at", "updated_at" ], "title": "PledgeResource" }, "PointOfContactResource": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "prefix": { "type": "string" }, "first_name": { "type": "string" }, "middle_name": { "type": "string" }, "last_name": { "type": "string" }, "suffix": { "type": "string" }, "gender": { "type": "string" }, "pronouns": { "type": "string" }, "dob": { "type": "string" }, "employer": { "type": "string" }, "title": { "type": "string" }, "twitter_url": { "type": "string" }, "linkedin_url": { "type": "string" }, "facebook_url": { "type": "string" }, "tiktok_url": { "type": "string" }, "instagram_url": { "type": "string" }, "website_url": { "type": "string" }, "emails": { "type": "object", "additionalProperties": {} }, "phones": { "type": "object", "additionalProperties": {} }, "primary_email": { "type": "string" }, "primary_phone": { "type": "string" }, "is_email_subscribed": { "type": "string" }, "is_phone_subscribed": { "type": "string" }, "is_address_subscribed": { "type": "string" }, "address_unsubscribed_at": { "type": "string" }, "archived_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "first_time_supporter_at": { "type": "string" } }, "required": [ "id", "type", "prefix", "first_name", "middle_name", "last_name", "suffix", "gender", "pronouns", "dob", "employer", "title", "twitter_url", "linkedin_url", "facebook_url", "tiktok_url", "instagram_url", "website_url", "emails", "phones", "primary_email", "primary_phone", "is_email_subscribed", "is_phone_subscribed", "is_address_subscribed", "address_unsubscribed_at", "archived_at", "created_at", "updated_at", "first_time_supporter_at" ], "title": "PointOfContactResource" }, "PublicUserResource": { "type": "object", "properties": { "id": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "first_name", "last_name", "email" ], "title": "PublicUserResource" }, "RecurringPlanResource": { "type": "object", "properties": { "id": { "type": "string" }, "contact_id": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "frequency": { "type": "string" }, "status": { "type": "string" }, "method": { "type": "string" }, "amount": { "type": "string" }, "fee_covered": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "start_at": { "type": "string" }, "canceled_at": { "type": "string" }, "next_bill_date": { "type": "string" } }, "required": [ "id", "contact_id", "first_name", "last_name", "email", "phone", "frequency", "status", "method", "amount", "fee_covered", "created_at", "updated_at", "start_at", "canceled_at", "next_bill_date" ], "title": "RecurringPlanResource" }, "SsoAccountResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "logo": { "type": "string" }, "cover": { "type": "string" }, "tagline": { "type": "string" }, "description": { "type": "string" }, "slug": { "type": "string" }, "url": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "website": { "type": "string" }, "facebook": { "type": "string" }, "linkedin": { "type": "string" }, "twitter": { "type": "string" }, "snapchat": { "type": "string" }, "instagram": { "type": "string" }, "tiktok": { "type": "string" }, "youtube": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "last_campaign_id": { "type": "string" } }, "required": [ "id", "name", "logo", "cover", "tagline", "description", "slug", "url", "phone", "email", "website", "facebook", "linkedin", "twitter", "snapchat", "instagram", "tiktok", "youtube", "created_at", "updated_at", "last_campaign_id" ], "title": "SsoAccountResource" }, "StoreCampaignDiscountCodeRequest": { "type": "object", "properties": { "items": { "type": [ "array", "null" ], "items": { "type": "string" } }, "type": { "$ref": "#\/components\/schemas\/DiscountCodeType" }, "active": { "type": "boolean" }, "amount": { "type": "number", "minimum": 1, "maximum": 100 }, "code": { "type": "string", "maxLength": 255 }, "uses": { "type": [ "number", "null" ], "minimum": 1 }, "starts_at": { "type": [ "string", "null" ], "format": "date-time" }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "type", "active", "amount", "code" ], "title": "StoreCampaignDiscountCodeRequest" }, "StoreCampaignItemTicketRequest": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255 }, "price": { "type": "number", "minimum": 0 }, "total_quantity": { "type": [ "integer", "null" ], "minimum": 0 }, "subtype": { "type": [ "string", "null" ], "enum": [ "physical", "digital", "hybrid" ], "maxLength": 255 }, "active": { "type": [ "boolean", "null" ] }, "retail_price": { "type": [ "number", "null" ], "minimum": 0 }, "description": { "type": [ "string", "null" ], "maxLength": 5000 }, "bundle_only": { "type": [ "boolean", "null" ] }, "hide_remaining": { "type": [ "boolean", "null" ] }, "scope": { "type": [ "string", "null" ], "enum": [ "registrant", "event" ], "maxLength": 255 }, "bundles": { "type": [ "array", "null" ], "items": { "type": "string" } }, "custom_fields": { "type": [ "array", "null" ], "items": { "type": "string" } }, "pictures": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [ "name", "price" ], "title": "StoreCampaignItemTicketRequest" }, "StoreCampaignRequest": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "general", "collect", "fundraise", "event" ], "maxLength": 255 }, "title": { "type": "string", "maxLength": 150 }, "subtitle": { "type": [ "string", "null" ], "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "goal": { "type": [ "integer", "null" ], "minimum": 0 }, "end_at": { "type": [ "string", "null" ], "format": "date-time" }, "slug": { "type": "string", "maxLength": 255 }, "beneficiary_id": { "type": [ "integer", "null" ] }, "timezone": { "type": [ "string", "null" ], "maxLength": 255 }, "currency": { "type": "string", "enum": [ "USD" ] }, "settings": { "type": [ "array", "null" ], "items": { "description": "A campaign setting. The `name` field determines the expected shape of `value`.", "oneOf": [ { "title": "hide_time_remaining", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "hide_time_remaining" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "show_countdown_clock", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "show_countdown_clock" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "hide_money_raised", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "hide_money_raised" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "theme_color", "type": "object", "description": "Hex color in the form `#rrggbb`.", "properties": { "name": { "type": "string", "enum": [ "theme_color" ] }, "value": { "type": [ "string", "null" ], "pattern": "^#[0-9a-fA-F]{6}$" } }, "required": [ "name" ] }, { "title": "use_actual_cover_size", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "use_actual_cover_size" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "disable_embed_branding", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "disable_embed_branding" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "custom_donate_text", "type": "object", "description": "Donate button text. Max 100 characters.", "properties": { "name": { "type": "string", "enum": [ "custom_donate_text" ] }, "value": { "type": [ "string", "null" ], "maxLength": 100 } }, "required": [ "name" ] }, { "title": "hide_supporter_feed", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "hide_supporter_feed" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "auction_tab_text", "type": "object", "description": "Accepts a `string` value.", "properties": { "name": { "type": "string", "enum": [ "auction_tab_text" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "name" ] }, { "title": "hide_auction_components", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "hide_auction_components" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "hide_contact_information", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "hide_contact_information" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "meta_image_alt_text", "type": "object", "description": "Accepts a `string` value.", "properties": { "name": { "type": "string", "enum": [ "meta_image_alt_text" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "name" ] }, { "title": "disable_donations", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "disable_donations" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "minimum_donation", "type": "object", "description": "Accepts a `decimal` value.", "properties": { "name": { "type": "string", "enum": [ "minimum_donation" ] }, "value": { "type": [ "number", "null" ], "format": "decimal" } }, "required": [ "name" ] }, { "title": "require_donor_phone", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "require_donor_phone" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "enforce_end_at", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "enforce_end_at" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "disable_recurring", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "disable_recurring" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "thank_you_message", "type": "object", "description": "Accepts a `string` value.", "properties": { "name": { "type": "string", "enum": [ "thank_you_message" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "name" ] }, { "title": "default_fund", "type": "object", "description": "Accepts a `string` value.", "properties": { "name": { "type": "string", "enum": [ "default_fund" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "name" ] }, { "title": "hide_fund", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "hide_fund" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "require_address", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "require_address" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "default_frequency", "type": "object", "description": "Default donation frequency. Typically `once`, `monthly`, `quarterly`, or `yearly`.", "properties": { "name": { "type": "string", "enum": [ "default_frequency" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "name" ] }, { "title": "display_frequencies", "type": "object", "description": "Donation frequencies to display. Typical values: `once`, `monthly`, `quarterly`, `yearly`.", "properties": { "name": { "type": "string", "enum": [ "display_frequencies" ] }, "value": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [ "name" ] }, { "title": "public_check_payments", "type": "object", "description": "Mailing instructions for check donations. Max 1000 characters.", "properties": { "name": { "type": "string", "enum": [ "public_check_payments" ] }, "value": { "type": [ "string", "null" ], "maxLength": 1000 } }, "required": [ "name" ] }, { "title": "recurring_upsell", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "recurring_upsell" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "disable_company_field", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "disable_company_field" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "hide_fee_collection", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "hide_fee_collection" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "force_fee_collection", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "force_fee_collection" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "custom_donation_amounts", "type": "object", "description": "Custom donation amounts. JSON object; the dashboard groups amounts by frequency (`once`, `monthly`, `quarterly`, `yearly`).", "properties": { "name": { "type": "string", "enum": [ "custom_donation_amounts" ] }, "value": {} }, "required": [ "name" ] }, { "title": "disable_dedications", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "disable_dedications" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "hide_other_option", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "hide_other_option" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "remove_tips_increase_fee", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "remove_tips_increase_fee" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "custom_fee_text", "type": "object", "description": "Custom fee text. Accepts a JSON object.", "properties": { "name": { "type": "string", "enum": [ "custom_fee_text" ] }, "value": { "type": [ "object", "null" ] } }, "required": [ "name" ] }, { "title": "custom_flow_heading", "type": "object", "description": "Accepts a `string` value.", "properties": { "name": { "type": "string", "enum": [ "custom_flow_heading" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "name" ] }, { "title": "fund_sort_by", "type": "object", "description": "Fund sort order. One of `order_asc`, `name_asc`, `created_at_desc`.", "properties": { "name": { "type": "string", "enum": [ "fund_sort_by" ] }, "value": { "type": [ "string", "null" ], "enum": [ "order_asc", "name_asc", "created_at_desc" ] } }, "required": [ "name" ] }, { "title": "require_fund", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "require_fund" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "suggested_amounts_mode", "type": "object", "description": "Accepts a `string` value.", "properties": { "name": { "type": "string", "enum": [ "suggested_amounts_mode" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "name" ] }, { "title": "disable_team_fundraising", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "disable_team_fundraising" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "disable_public_join", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "disable_public_join" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "disable_public_join_button", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "disable_public_join_button" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "custom_team_members_heading", "type": "object", "description": "Accepts a `string` value.", "properties": { "name": { "type": "string", "enum": [ "custom_team_members_heading" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "name" ] }, { "title": "custom_join_text", "type": "object", "description": "Join button text. Max 18 characters.", "properties": { "name": { "type": "string", "enum": [ "custom_join_text" ] }, "value": { "type": [ "string", "null" ], "maxLength": 18 } }, "required": [ "name" ] }, { "title": "disallow_new_teams", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "disallow_new_teams" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "hide_member_raised", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "hide_member_raised" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "custom_team_leaderboard_heading", "type": "object", "description": "Accepts a `string` value.", "properties": { "name": { "type": "string", "enum": [ "custom_team_leaderboard_heading" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "name" ] }, { "title": "enable_registration_fundraising", "type": "object", "description": "Registration fundraising configuration. JSON object (e.g. `goal`, `minimum`, `description`).", "properties": { "name": { "type": "string", "enum": [ "enable_registration_fundraising" ] }, "value": { "type": [ "object", "null" ] } }, "required": [ "name" ] }, { "title": "registration_thank_you_message", "type": "object", "description": "Accepts a `string` value.", "properties": { "name": { "type": "string", "enum": [ "registration_thank_you_message" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "name" ] }, { "title": "multi_team_fundraising", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "multi_team_fundraising" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "multi_team_fundraising_limit", "type": "object", "description": "Accepts a `integer` value.", "properties": { "name": { "type": "string", "enum": [ "multi_team_fundraising_limit" ] }, "value": { "type": [ "integer", "null" ] } }, "required": [ "name" ] }, { "title": "hide_team_raised", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "hide_team_raised" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "require_team_for_members", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "require_team_for_members" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "team_order", "type": "object", "description": "Team list ordering. Typical values: `name`, `donors`, `created_at`.", "properties": { "name": { "type": "string", "enum": [ "team_order" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "name" ] }, { "title": "require_ticket_phone", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "require_ticket_phone" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "enable_event_reminders", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "enable_event_reminders" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] } ], "discriminator": { "propertyName": "name" } } } }, "required": [ "type", "title" ], "title": "StoreCampaignRequest" }, "StoreContactActivityRequest": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "meeting", "note", "phone_call", "sms", "completed_task", "volunteer_activity" ] }, "note": { "type": [ "string", "null" ] }, "subject": { "type": [ "string", "null" ], "maxLength": 255 }, "occurred_at": { "type": [ "string", "null" ], "format": "date-time" }, "timezone": { "type": [ "string", "null" ], "maxLength": 255 } }, "required": [ "type" ], "title": "StoreContactActivityRequest" }, "StoreContactRequest": { "type": "object", "properties": { "first_name": { "type": [ "string", "null" ], "maxLength": 255 }, "last_name": { "type": [ "string", "null" ], "maxLength": 255 }, "middle_name": { "type": [ "string", "null" ], "maxLength": 255 }, "preferred_name": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 255 }, "primary_email": { "type": [ "string", "null" ] }, "primary_phone": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ], "maxLength": 255 }, "external_id": { "type": [ "string", "null" ], "maxLength": 255 }, "contact_since": { "type": [ "string", "null" ], "format": "date-time" }, "type": { "$ref": "#\/components\/schemas\/ContactType" }, "gender": { "$ref": "#\/components\/schemas\/GenderEnum" }, "pronouns": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 255 }, "suffix": { "type": [ "string", "null" ], "maxLength": 32 }, "prefix": { "type": [ "string", "null" ], "maxLength": 32 }, "address_1": { "type": [ "string", "null" ], "maxLength": 255 }, "address_2": { "type": [ "string", "null" ], "maxLength": 255 }, "city": { "type": [ "string", "null" ], "maxLength": 255 }, "state": { "type": [ "string", "null" ], "maxLength": 255 }, "zipcode": { "type": [ "string", "null" ], "maxLength": 255 }, "country": { "type": [ "string", "null" ] }, "primary_address_1": { "type": [ "string", "null" ], "maxLength": 255 }, "primary_address_2": { "type": [ "string", "null" ], "maxLength": 255 }, "primary_city": { "type": [ "string", "null" ], "maxLength": 255 }, "primary_state": { "type": [ "string", "null" ], "maxLength": 255 }, "primary_zipcode": { "type": [ "string", "null" ], "maxLength": 255 }, "primary_country": { "type": [ "string", "null" ] }, "emails": { "type": [ "array", "null" ], "items": { "type": "string" } }, "phones": { "type": [ "array", "null" ], "items": { "type": "string" } }, "dob": { "type": "string" }, "employer": { "type": [ "string", "null" ], "maxLength": 255 }, "company": { "type": [ "string", "null" ], "maxLength": 255 }, "title": { "type": [ "string", "null" ], "maxLength": 255 }, "twitter_url": { "type": [ "string", "null" ] }, "linkedin_url": { "type": [ "string", "null" ] }, "facebook_url": { "type": [ "string", "null" ] }, "tiktok_url": { "type": [ "string", "null" ] }, "instagram_url": { "type": [ "string", "null" ] }, "note": { "type": [ "string", "null" ] }, "email_subscription": { "type": [ "boolean", "null" ] }, "phone_subscription": { "type": [ "boolean", "null" ] }, "address_subscription": { "type": [ "boolean", "null" ] }, "custom_fields": { "type": [ "array", "null" ], "items": { "type": "string" } }, "tags": { "type": [ "array", "null" ], "items": { "type": "string", "maxLength": 64 } }, "addresses": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "address_1": { "type": [ "string", "null" ], "maxLength": 255 }, "address_2": { "type": [ "string", "null" ], "maxLength": 255 }, "city": { "type": [ "string", "null" ], "maxLength": 255 }, "state": { "type": [ "string", "null" ], "maxLength": 255 }, "zipcode": { "type": [ "string", "null" ], "maxLength": 255 }, "country": { "type": [ "string", "null" ] } } } } }, "title": "StoreContactRequest" }, "StoreTransactionRequest": { "type": "object", "properties": { "campaign_code": { "type": [ "string", "null" ] }, "campaign_title": { "type": "string", "maxLength": 255 }, "campaign_team_id": { "type": [ "integer", "null" ] }, "team_member_id": { "type": [ "integer", "null" ] }, "contact_id": { "type": [ "integer", "null" ] }, "contact_external_id": { "type": [ "string", "null" ], "maxLength": 255 }, "fund_code": { "type": [ "string", "null" ], "maxLength": 255 }, "method": { "$ref": "#\/components\/schemas\/PaymentMethodEnum" }, "transacted_at": { "type": "string", "format": "date-time" }, "mark_deposited": { "type": [ "boolean", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "acknowledged_at": { "type": [ "string", "null" ], "format": "date-time" }, "external_label": { "type": [ "string", "null" ], "maxLength": 255 }, "external_id": { "type": [ "string", "null" ], "maxLength": 255 }, "contact_contact_since": { "type": [ "string", "null" ], "format": "date-time" }, "amount": { "type": "string" }, "fee_covered": { "type": [ "string", "null" ] }, "platform_fee": { "type": [ "string", "null" ] }, "processing_fee": { "type": [ "string", "null" ] }, "check_number": { "type": [ "string", "null" ], "maxLength": 255 }, "check_deposited_at": { "type": [ "string", "null" ], "format": "date-time" }, "company": { "type": [ "string", "null" ], "maxLength": 255 }, "internal_note": { "type": [ "string", "null" ], "maxLength": 131070 }, "first_name": { "type": [ "string", "null" ], "maxLength": 255 }, "last_name": { "type": [ "string", "null" ], "maxLength": 255 }, "email": { "type": [ "string", "null" ], "maxLength": 255 }, "phone": { "type": [ "string", "null" ] }, "address_1": { "type": [ "string", "null" ], "maxLength": 255 }, "address_2": { "type": [ "string", "null" ], "maxLength": 255 }, "city": { "type": [ "string", "null" ], "maxLength": 255 }, "state": { "type": [ "string", "null" ], "maxLength": 255 }, "zipcode": { "type": [ "string", "null" ], "maxLength": 255 }, "country": { "type": [ "string", "null" ] }, "dedication_type": { "$ref": "#\/components\/schemas\/DedicationType" }, "dedication_name": { "type": [ "string", "null" ], "maxLength": 255 }, "dedication_recipient_name": { "type": [ "string", "null" ], "maxLength": 255 }, "dedication_recipient_email": { "type": [ "string", "null" ] }, "giving_space_message": { "type": [ "string", "null" ], "maxLength": 65535 }, "appeal_code": { "type": [ "string", "null" ], "maxLength": 255 }, "appeal_name": { "type": [ "string", "null" ], "maxLength": 255 }, "appeal_status": { "type": [ "string", "null" ] } }, "required": [ "method", "transacted_at", "amount" ], "title": "StoreTransactionRequest" }, "TicketResource": { "type": "object", "properties": { "id": { "type": "string" }, "id_suffix": { "type": "string" }, "transaction_id": { "type": "string" }, "name": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "price": { "type": "number" }, "pdf": { "type": "string" }, "checked_in_at": { "type": "string" }, "custom_fields": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CustomFieldResponseResource" } }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "retail_price": { "type": [ "string", "null" ] } }, "required": [ "id", "id_suffix", "transaction_id", "name", "first_name", "last_name", "email", "phone", "title", "description", "price", "pdf", "checked_in_at", "custom_fields", "created_at", "updated_at", "retail_price" ], "title": "TicketResource" }, "TransactionLineItemResource": { "type": "object", "properties": { "type": { "type": "string" }, "subtype": { "type": "string" }, "description": { "type": "string" }, "quantity": { "type": "integer" }, "price": { "type": "number" }, "discount": { "type": "number" }, "total": { "type": "number" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "type", "subtype", "description", "quantity", "price", "discount", "total", "created_at", "updated_at" ], "title": "TransactionLineItemResource" }, "TransactionResource": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "plan_id": { "type": "string" }, "pledge_id": { "type": "string" }, "amount": { "type": "number" }, "fee": { "type": "number" }, "fee_covered": { "type": "number" }, "donated": { "type": "number" }, "payout": { "type": "number" }, "captured": { "type": "string" }, "captured_at": { "type": "string" }, "timezone": { "type": "string" }, "refunded": { "type": "string" }, "refunded_at": { "type": "string" }, "line_items": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TransactionLineItemResource" } }, "fair_market_value_amount": { "type": [ "string", "null" ] }, "tax_deductible_amount": { "type": [ "string", "null" ] }, "is_recurring": { "type": "string" } }, "required": [ "id", "plan_id", "pledge_id", "amount", "fee", "fee_covered", "donated", "payout", "captured", "captured_at", "timezone", "refunded", "refunded_at", "line_items", "fair_market_value_amount", "tax_deductible_amount", "is_recurring" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "number": { "type": "string" }, "campaign_id": { "type": "string" }, "campaign_code": { "type": "string" }, "campaign_title": { "type": "string" }, "plan_id": { "type": "string" }, "pledge_id": { "type": "string" }, "team_id": { "type": "string" }, "team_name": { "type": "string" }, "member_id": { "type": "string" }, "member_name": { "type": "string" }, "fund_id": { "type": "string" }, "fund_code": { "type": "string" }, "contact_id": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "company_name": { "type": "string" }, "company": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "address": { "type": "string" }, "status": { "type": "string" }, "payment_method": { "type": "string" }, "method": { "type": "string" }, "is_offline": { "type": "string" }, "check_number": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "check_deposited_at": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "internal_note": { "type": "string" }, "amount": { "type": "number" }, "fee": { "type": "number" }, "fee_covered": { "type": "number" }, "donated": { "type": "number" }, "payout": { "type": "number" }, "currency": { "type": "string" }, "transacted_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "timezone": { "type": "string" }, "giving_space": { "anyOf": [ { "$ref": "#\/components\/schemas\/GivingSpaceResource" }, { "type": "null" } ] }, "dedication": { "anyOf": [ { "$ref": "#\/components\/schemas\/DedicationResource" }, { "type": "null" } ] }, "transactions": { "type": "array", "prefixItems": [ { "$ref": "#\/components\/schemas\/TransactionResource" } ], "minItems": 1, "maxItems": 1, "additionalItems": false }, "custom_fields": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CustomFieldResponseResource" } }, "utm_parameters": { "type": "string" }, "external_id": { "anyOf": [ { "$ref": "#\/components\/schemas\/ExternalIdResource" }, { "type": "null" } ] }, "communication_opt_in": { "type": "string" }, "session_id": { "type": "string" }, "attribution_data": { "type": "string" }, "fair_market_value_amount": { "type": [ "string", "null" ] }, "tax_deductible_amount": { "type": [ "string", "null" ] }, "is_recurring": { "type": "string" }, "payout_id": { "anyOf": [ { "type": "string" }, { "type": "object" } ] } }, "required": [ "id", "number", "campaign_id", "campaign_code", "campaign_title", "plan_id", "pledge_id", "team_id", "team_name", "member_id", "member_name", "fund_id", "fund_code", "contact_id", "first_name", "last_name", "company_name", "company", "email", "phone", "address", "status", "payment_method", "method", "is_offline", "check_number", "check_deposited_at", "internal_note", "amount", "fee", "fee_covered", "donated", "payout", "currency", "transacted_at", "created_at", "updated_at", "timezone", "giving_space", "dedication", "transactions", "custom_fields", "utm_parameters", "external_id", "communication_opt_in", "session_id", "attribution_data", "fair_market_value_amount", "tax_deductible_amount", "is_recurring", "payout_id" ] } ], "title": "TransactionResource" }, "UpdateCampaignDiscountCodeRequest": { "type": "object", "properties": { "items": { "type": [ "array", "null" ], "items": { "type": "string" } }, "amount": { "type": "number", "minimum": 1, "maximum": 100 }, "type": { "$ref": "#\/components\/schemas\/DiscountCodeType" }, "active": { "type": "boolean" }, "code": { "type": "string", "maxLength": 255 }, "uses": { "type": [ "number", "null" ], "minimum": 1 }, "starts_at": { "type": [ "string", "null" ], "format": "date-time" }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "amount" ], "title": "UpdateCampaignDiscountCodeRequest" }, "UpdateCampaignRequest": { "type": "object", "properties": { "published": { "type": "boolean" }, "public": { "type": "boolean" }, "type": { "type": "string", "enum": [ "general", "collect", "fundraise", "event" ], "maxLength": 255 }, "title": { "type": "string", "maxLength": 150 }, "subtitle": { "type": [ "string", "null" ], "maxLength": 255 }, "description": { "type": [ "string", "null" ] }, "goal": { "type": [ "integer", "null" ], "minimum": 0 }, "end_at": { "type": [ "string", "null" ], "format": "date-time" }, "short_code": { "type": [ "string", "null" ], "maxLength": 255 }, "slug": { "type": "string", "maxLength": 255 }, "beneficiary_id": { "type": [ "integer", "null" ] }, "timezone": { "type": [ "string", "null" ], "maxLength": 255 }, "currency": { "type": "string", "enum": [ "USD" ] }, "default_appeal_id": { "type": [ "integer", "null" ] }, "cover": { "type": "object", "properties": { "source": { "type": [ "string", "null" ], "enum": [ "upload", "youtube", "vimeo", "twitch", "facebook" ] }, "type": { "type": [ "string", "null" ], "enum": [ "image", "video" ] }, "url": { "type": [ "string", "null" ] } } }, "settings": { "type": [ "array", "null" ], "items": { "description": "A campaign setting. The `name` field determines the expected shape of `value`.", "oneOf": [ { "title": "hide_time_remaining", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "hide_time_remaining" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "show_countdown_clock", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "show_countdown_clock" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "hide_money_raised", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "hide_money_raised" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "theme_color", "type": "object", "description": "Hex color in the form `#rrggbb`.", "properties": { "name": { "type": "string", "enum": [ "theme_color" ] }, "value": { "type": [ "string", "null" ], "pattern": "^#[0-9a-fA-F]{6}$" } }, "required": [ "name" ] }, { "title": "use_actual_cover_size", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "use_actual_cover_size" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "disable_embed_branding", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "disable_embed_branding" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "custom_donate_text", "type": "object", "description": "Donate button text. Max 100 characters.", "properties": { "name": { "type": "string", "enum": [ "custom_donate_text" ] }, "value": { "type": [ "string", "null" ], "maxLength": 100 } }, "required": [ "name" ] }, { "title": "hide_supporter_feed", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "hide_supporter_feed" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "auction_tab_text", "type": "object", "description": "Accepts a `string` value.", "properties": { "name": { "type": "string", "enum": [ "auction_tab_text" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "name" ] }, { "title": "hide_auction_components", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "hide_auction_components" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "hide_contact_information", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "hide_contact_information" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "meta_image_alt_text", "type": "object", "description": "Accepts a `string` value.", "properties": { "name": { "type": "string", "enum": [ "meta_image_alt_text" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "name" ] }, { "title": "disable_donations", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "disable_donations" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "minimum_donation", "type": "object", "description": "Accepts a `decimal` value.", "properties": { "name": { "type": "string", "enum": [ "minimum_donation" ] }, "value": { "type": [ "number", "null" ], "format": "decimal" } }, "required": [ "name" ] }, { "title": "require_donor_phone", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "require_donor_phone" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "enforce_end_at", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "enforce_end_at" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "disable_recurring", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "disable_recurring" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "thank_you_message", "type": "object", "description": "Accepts a `string` value.", "properties": { "name": { "type": "string", "enum": [ "thank_you_message" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "name" ] }, { "title": "default_fund", "type": "object", "description": "Accepts a `string` value.", "properties": { "name": { "type": "string", "enum": [ "default_fund" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "name" ] }, { "title": "hide_fund", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "hide_fund" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "require_address", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "require_address" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "default_frequency", "type": "object", "description": "Default donation frequency. Typically `once`, `monthly`, `quarterly`, or `yearly`.", "properties": { "name": { "type": "string", "enum": [ "default_frequency" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "name" ] }, { "title": "display_frequencies", "type": "object", "description": "Donation frequencies to display. Typical values: `once`, `monthly`, `quarterly`, `yearly`.", "properties": { "name": { "type": "string", "enum": [ "display_frequencies" ] }, "value": { "type": [ "array", "null" ], "items": { "type": "string" } } }, "required": [ "name" ] }, { "title": "public_check_payments", "type": "object", "description": "Mailing instructions for check donations. Max 1000 characters.", "properties": { "name": { "type": "string", "enum": [ "public_check_payments" ] }, "value": { "type": [ "string", "null" ], "maxLength": 1000 } }, "required": [ "name" ] }, { "title": "recurring_upsell", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "recurring_upsell" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "disable_company_field", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "disable_company_field" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "hide_fee_collection", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "hide_fee_collection" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "force_fee_collection", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "force_fee_collection" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "custom_donation_amounts", "type": "object", "description": "Custom donation amounts. JSON object; the dashboard groups amounts by frequency (`once`, `monthly`, `quarterly`, `yearly`).", "properties": { "name": { "type": "string", "enum": [ "custom_donation_amounts" ] }, "value": {} }, "required": [ "name" ] }, { "title": "disable_dedications", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "disable_dedications" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "hide_other_option", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "hide_other_option" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "remove_tips_increase_fee", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "remove_tips_increase_fee" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "custom_fee_text", "type": "object", "description": "Custom fee text. Accepts a JSON object.", "properties": { "name": { "type": "string", "enum": [ "custom_fee_text" ] }, "value": { "type": [ "object", "null" ] } }, "required": [ "name" ] }, { "title": "custom_flow_heading", "type": "object", "description": "Accepts a `string` value.", "properties": { "name": { "type": "string", "enum": [ "custom_flow_heading" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "name" ] }, { "title": "fund_sort_by", "type": "object", "description": "Fund sort order. One of `order_asc`, `name_asc`, `created_at_desc`.", "properties": { "name": { "type": "string", "enum": [ "fund_sort_by" ] }, "value": { "type": [ "string", "null" ], "enum": [ "order_asc", "name_asc", "created_at_desc" ] } }, "required": [ "name" ] }, { "title": "require_fund", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "require_fund" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "suggested_amounts_mode", "type": "object", "description": "Accepts a `string` value.", "properties": { "name": { "type": "string", "enum": [ "suggested_amounts_mode" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "name" ] }, { "title": "disable_team_fundraising", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "disable_team_fundraising" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "disable_public_join", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "disable_public_join" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "disable_public_join_button", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "disable_public_join_button" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "custom_team_members_heading", "type": "object", "description": "Accepts a `string` value.", "properties": { "name": { "type": "string", "enum": [ "custom_team_members_heading" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "name" ] }, { "title": "custom_join_text", "type": "object", "description": "Join button text. Max 18 characters.", "properties": { "name": { "type": "string", "enum": [ "custom_join_text" ] }, "value": { "type": [ "string", "null" ], "maxLength": 18 } }, "required": [ "name" ] }, { "title": "disallow_new_teams", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "disallow_new_teams" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "hide_member_raised", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "hide_member_raised" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "custom_team_leaderboard_heading", "type": "object", "description": "Accepts a `string` value.", "properties": { "name": { "type": "string", "enum": [ "custom_team_leaderboard_heading" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "name" ] }, { "title": "enable_registration_fundraising", "type": "object", "description": "Registration fundraising configuration. JSON object (e.g. `goal`, `minimum`, `description`).", "properties": { "name": { "type": "string", "enum": [ "enable_registration_fundraising" ] }, "value": { "type": [ "object", "null" ] } }, "required": [ "name" ] }, { "title": "registration_thank_you_message", "type": "object", "description": "Accepts a `string` value.", "properties": { "name": { "type": "string", "enum": [ "registration_thank_you_message" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "name" ] }, { "title": "multi_team_fundraising", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "multi_team_fundraising" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "multi_team_fundraising_limit", "type": "object", "description": "Accepts a `integer` value.", "properties": { "name": { "type": "string", "enum": [ "multi_team_fundraising_limit" ] }, "value": { "type": [ "integer", "null" ] } }, "required": [ "name" ] }, { "title": "hide_team_raised", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "hide_team_raised" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "require_team_for_members", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "require_team_for_members" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "team_order", "type": "object", "description": "Team list ordering. Typical values: `name`, `donors`, `created_at`.", "properties": { "name": { "type": "string", "enum": [ "team_order" ] }, "value": { "type": [ "string", "null" ] } }, "required": [ "name" ] }, { "title": "require_ticket_phone", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "require_ticket_phone" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] }, { "title": "enable_event_reminders", "type": "object", "description": "Accepts a `boolean` value.", "properties": { "name": { "type": "string", "enum": [ "enable_event_reminders" ] }, "value": { "type": [ "boolean", "null" ] } }, "required": [ "name" ] } ], "discriminator": { "propertyName": "name" } } } }, "title": "UpdateCampaignRequest" }, "UpdateContactRequest": { "type": "object", "properties": { "first_name": { "type": [ "string", "null" ], "description": "Required for individual contacts. Optional for company contacts, which require company_name instead.", "maxLength": 255 }, "last_name": { "type": [ "string", "null" ], "description": "Required for individual contacts. Optional for company contacts, which require company_name instead.", "maxLength": 255 }, "middle_name": { "type": [ "string", "null" ], "maxLength": 255 }, "preferred_name": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 255 }, "gender": { "$ref": "#\/components\/schemas\/GenderEnum" }, "pronouns": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 255 }, "suffix": { "type": [ "string", "null" ], "maxLength": 32 }, "prefix": { "type": [ "string", "null" ], "maxLength": 32 }, "type": { "description": "Determines which fields are required: individual contacts require a name, company contacts require company_name.", "$ref": "#\/components\/schemas\/ContactType" }, "company_name": { "type": [ "string", "null" ], "description": "Required for company contacts. Optional for individual contacts, which require first_name and last_name instead.", "maxLength": 255 }, "employer": { "type": [ "string", "null" ], "maxLength": 255 }, "company": { "type": [ "string", "null" ], "maxLength": 255 }, "title": { "type": [ "string", "null" ], "maxLength": 255 }, "twitter_url": { "type": [ "string", "null" ] }, "linkedin_url": { "type": [ "string", "null" ] }, "facebook_url": { "type": [ "string", "null" ] }, "tiktok_url": { "type": [ "string", "null" ] }, "website_url": { "type": [ "string", "null" ], "format": "uri", "maxLength": 2048 }, "note": { "type": [ "string", "null" ] }, "bio": { "type": [ "string", "null" ], "maxLength": 2000 }, "external_id": { "type": [ "string", "null" ], "maxLength": 255 }, "contact_since": { "type": [ "string", "null" ], "format": "date-time" }, "dob": { "type": "string" }, "email_opt_in": { "type": [ "boolean", "null" ] }, "sms_opt_in": { "type": [ "boolean", "null" ] }, "address_subscription": { "type": [ "boolean", "null" ] }, "custom_fields": { "type": [ "array", "null" ], "items": { "type": "string" } }, "tags": { "type": [ "array", "null" ], "items": { "type": "string", "maxLength": 64 } }, "remove_emails": { "type": [ "array", "null" ], "items": { "type": "string", "format": "email" } }, "remove_phones": { "type": [ "array", "null" ], "items": { "type": "string" } }, "remove_address_ids": { "type": [ "array", "null" ], "items": { "type": "integer" } }, "emails": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "value": { "type": [ "string", "null" ], "format": "email" }, "type": { "type": [ "string", "null" ] }, "is_primary": { "type": "boolean" } } } }, "phones": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "value": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ] }, "is_primary": { "type": "boolean" } } } }, "addresses": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "id": { "type": "integer" }, "address_1": { "type": [ "string", "null" ], "maxLength": 255 }, "address_2": { "type": [ "string", "null" ], "maxLength": 255 }, "city": { "type": [ "string", "null" ], "maxLength": 255 }, "state": { "type": [ "string", "null" ], "maxLength": 255 }, "zipcode": { "type": [ "string", "null" ], "maxLength": 255 }, "country": { "type": [ "string", "null" ], "maxLength": 255 }, "is_primary": { "type": "boolean" } } } } }, "title": "UpdateContactRequest" }, "UpdateTransactionRequest": { "type": "object", "properties": { "transaction_id": { "type": "string" }, "internal_note": { "type": [ "string", "null" ], "maxLength": 131070 }, "check_number": { "type": [ "string", "null" ], "maxLength": 255 }, "check_deposited_at": { "type": [ "string", "null" ], "format": "date-time" }, "custom_fields": { "type": "array", "items": { "type": "string" } }, "team_id": { "type": "string" }, "campaign_member_id": { "type": "string" }, "fund_id": { "type": "string" }, "campaign_id": { "type": "string" }, "method": { "type": "string" }, "transacted_at": { "type": "string" }, "appeal_id": { "type": "string" }, "offline_payment_received": { "type": "string" }, "dedication": { "type": "object", "properties": { "type": { "$ref": "#\/components\/schemas\/DedicationType" }, "name": { "type": "string", "maxLength": 255 }, "recipient_name": { "type": [ "string", "null" ], "maxLength": 255 }, "recipient_email": { "type": [ "string", "null" ], "format": "email" } }, "required": [ "type", "name", "recipient_name", "recipient_email" ] } }, "title": "UpdateTransactionRequest" }, "WebhookActivityResource": { "type": "object", "properties": { "id": { "type": "string" }, "webhook_id": { "type": "string" }, "status": { "type": "string" }, "status_description": { "type": "string" }, "event": { "type": "string" }, "url": { "type": "string" }, "payload": { "type": "array", "items": {} }, "response": { "type": [ "array", "null" ], "items": {} }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "webhook_id", "status", "status_description", "event", "url", "payload", "response", "created_at", "updated_at" ], "title": "WebhookActivityResource" }, "WebhookResource": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "signature": { "type": [ "string", "null" ] }, "events": { "type": "array", "items": {} }, "enabled": { "type": "boolean" }, "url": { "type": "string" }, "last_status": { "type": "string" }, "last_status_description": { "type": "string" }, "last_used_at": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "name", "events", "enabled", "url", "last_status", "last_status_description", "last_used_at", "created_at", "updated_at" ], "title": "WebhookResource" } }, "responses": { "AuthenticationException": { "description": "Unauthenticated", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "AuthorizationException": { "description": "Authorization error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "ValidationException": { "description": "Validation error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Errors overview." }, "errors": { "type": "object", "description": "A detailed description of each field that failed validation.", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "message", "errors" ] } } } }, "ModelNotFoundException": { "description": "Not found", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "NotFoundHttpException": { "description": "Not found", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } } } } }