{"items":[{"type":"link","label":"Fundraising","link":"/apis/fundraising/fundraising-v1","routeSlug":"/apis/fundraising/fundraising-v1","content":{"contentType":"overview","meta":{"name":"Fundraising"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"fundraising-v1.json","url":"/_bundle/apis/fundraising/fundraising-v1.json?download"},{"kind":"download","label":"fundraising-v1.yaml","url":"/_bundle/apis/fundraising/fundraising-v1.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Fundraising (v1-2025-04-18)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Service providing access to Fundraising resources and features"}],"sectionId":"/apis/fundraising/fundraising-v1"}],"sectionId":"/apis/fundraising/fundraising-v1"}]}]}},{"type":"group","label":"Appeals","link":"/apis/fundraising/fundraising-v1/appeals","routeSlug":"/apis/fundraising/fundraising-v1/appeals","items":[{"label":"Gets all of the appeals in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/appeals/listappeals","routeSlug":"/apis/fundraising/fundraising-v1/appeals/listappeals","metadata":{"seo":{"title":"Gets all of the appeals in the system.","description":"This method will scan all appeals and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAppeals","name":"Gets all of the appeals in the system.","isWebhook":false,"pointer":"/paths/~1appeals~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the appeals in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all appeals and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1appeals~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1appeals~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/appeals/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/appeals/{tenantId}","href":"appeals/listappeals","openApiOperationId":"listAppeals","summary":"Gets all of the appeals in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The appealswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_519"}},"schemaId":"schema_519","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1appeals~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_519","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_519"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appeals/listappeals"}],"panels":[]}]},"httpPath":"/appeals/{tenantId}"},{"label":"Creates a new appeal record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/appeals/createappeal","routeSlug":"/apis/fundraising/fundraising-v1/appeals/createappeal","metadata":{"seo":{"title":"Creates a new appeal record that does not already exist.","description":"This method will auto-generate an ID and create a new appeal. If an ID is specified for the appeal, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAppeal","name":"Creates a new appeal record that does not already exist.","isWebhook":false,"pointer":"/paths/~1appeals~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new appeal record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new appeal. If an ID is specified for the appeal, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1appeals~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Appeal"}},"schemaId":"components/schemas/Appeal","pointer":"/paths/~1appeals~1{tenantId}/post/requestBody","description":"The appeal that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/appeals/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Appeal"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/appeals/{tenantId}","href":"appeals/createappeal","openApiOperationId":"createAppeal","summary":"Creates a new appeal record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Appeal","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Appeal"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The appeal was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Appeal"}},"schemaId":"components/schemas/Appeal","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The appeal you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The appeal could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add appeal based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1appeals~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Appeal","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Appeal"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appeals/createappeal"}],"panels":[]}]},"httpPath":"/appeals/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/appeals/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/appeals/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1appeals~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1appeals~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1appeals~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/appeals/{tenantId}/batch","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/appeals/{tenantId}/batch","href":"appeals/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The appeal could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve appeal based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1appeals~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appeals/executebatchoperations"}],"panels":[]}]},"httpPath":"/appeals/{tenantId}/batch"},{"label":"Returns a list of records with the specified campaign_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/appeals/listappealsbycampaignid","routeSlug":"/apis/fundraising/fundraising-v1/appeals/listappealsbycampaignid","metadata":{"seo":{"title":"Returns a list of records with the specified campaign_id","description":"Returns a list of records with the specified campaign_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAppealsByCampaignId","name":"Returns a list of records with the specified campaign_id","isWebhook":false,"pointer":"/paths/~1appeals~1{tenantId}~1campaign~1{campaign_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified campaign_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified campaign_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true},{"name":"campaign_id","in":"path","schemaId":"schema_518","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The campaign_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1appeals~1{tenantId}~1campaign~1{campaign_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1appeals~1{tenantId}~1campaign~1{campaign_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/appeals/{tenantId}/campaign/{campaign_id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"campaign_id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/appeals/{tenantId}/campaign/{campaign_id}","href":"appeals/listappealsbycampaignid","openApiOperationId":"listAppealsByCampaignId","summary":"Returns a list of records with the specified campaign_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAppealsResponse"}},"schemaId":"components/schemas/ListAppealsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1appeals~1{tenantId}~1campaign~1{campaign_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListAppealsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAppealsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appeals/listappealsbycampaignid"}],"panels":[]}]},"httpPath":"/appeals/{tenantId}/campaign/{campaign_id}"},{"label":"Searches for appeals using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/appeals/searchforappeals","routeSlug":"/apis/fundraising/fundraising-v1/appeals/searchforappeals","metadata":{"seo":{"title":"Searches for appeals using predefined parameters","description":"Searches for appeals using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForAppeals","name":"Searches for appeals using predefined parameters","isWebhook":false,"pointer":"/paths/~1appeals~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for appeals using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for appeals using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1appeals~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_518","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1appeals~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppealSearchParameters"}},"schemaId":"components/schemas/AppealSearchParameters","pointer":"/paths/~1appeals~1{tenantId}~1search/post/requestBody","description":"The appeal that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/appeals/{tenantId}/search","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AppealSearchParameters"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/appeals/{tenantId}/search","href":"appeals/searchforappeals","openApiOperationId":"searchForAppeals","summary":"Searches for appeals using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/AppealSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AppealSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The appeal search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedAppealSearchResults"}},"schemaId":"components/schemas/PagedAppealSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The appeal you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The appeal could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add appeal based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1appeals~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedAppealSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedAppealSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appeals/searchforappeals"}],"panels":[]}]},"httpPath":"/appeals/{tenantId}/search"},{"label":"Returns a appeal from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/appeals/deleteappeal","routeSlug":"/apis/fundraising/fundraising-v1/appeals/deleteappeal","metadata":{"seo":{"title":"Returns a appeal from the system by its ID.","description":"This method will delete a appeal with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAppeal","name":"Returns a appeal from the system by its ID.","isWebhook":false,"pointer":"/paths/~1appeals~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a appeal from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a appeal with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the appeal to delete.","required":true}],"pointer":"/paths/~1appeals~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/appeals/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/appeals/{tenantId}/{id}","href":"appeals/deleteappeal","openApiOperationId":"deleteAppeal","summary":"Returns a appeal from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The appeal was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The appeal could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The appeal could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to delete appeal based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1appeals~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appeals/deleteappeal"}],"panels":[]}]},"httpPath":"/appeals/{tenantId}/{id}"},{"label":"Returns a appeal from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/appeals/getappeal","routeSlug":"/apis/fundraising/fundraising-v1/appeals/getappeal","metadata":{"seo":{"title":"Returns a appeal from the system by its ID.","description":"This method will look up a appeal by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAppeal","name":"Returns a appeal from the system by its ID.","isWebhook":false,"pointer":"/paths/~1appeals~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a appeal from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a appeal by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the appeal to return.","required":true}],"pointer":"/paths/~1appeals~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_518","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1appeals~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/appeals/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/appeals/{tenantId}/{id}","href":"appeals/getappeal","openApiOperationId":"getAppeal","summary":"Returns a appeal from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The appeal was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Appeal"}},"schemaId":"components/schemas/Appeal","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The appeal could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve appeal based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1appeals~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Appeal","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Appeal"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appeals/getappeal"}],"panels":[]}]},"httpPath":"/appeals/{tenantId}/{id}"},{"label":"Partially updates a appeal with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/appeals/patchappeal","routeSlug":"/apis/fundraising/fundraising-v1/appeals/patchappeal","metadata":{"seo":{"title":"Partially updates a appeal with the specified ID.","description":"This method will patch an existing appeal with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAppeal","name":"Partially updates a appeal with the specified ID.","isWebhook":false,"pointer":"/paths/~1appeals~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a appeal with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing appeal with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the appeal to patch.","required":true}],"pointer":"/paths/~1appeals~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"schemaId":"schema_521","pointer":"/paths/~1appeals~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/appeals/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_521"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/appeals/{tenantId}/{id}","href":"appeals/patchappeal","openApiOperationId":"patchAppeal","summary":"Partially updates a appeal with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"schema_521","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The appeal was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Appeal"}},"schemaId":"components/schemas/Appeal","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The appeal could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The appeal could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve appeal based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1appeals~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Appeal","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Appeal"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appeals/patchappeal"}],"panels":[]}]},"httpPath":"/appeals/{tenantId}/{id}"},{"label":"Updates a appeal with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/appeals/updateappeal","routeSlug":"/apis/fundraising/fundraising-v1/appeals/updateappeal","metadata":{"seo":{"title":"Updates a appeal with the specified ID.","description":"This method will update an existing appeal with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAppeal","name":"Updates a appeal with the specified ID.","isWebhook":false,"pointer":"/paths/~1appeals~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a appeal with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing appeal with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the appeal to update.","required":true}],"pointer":"/paths/~1appeals~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Appeal"}},"schemaId":"components/schemas/Appeal","pointer":"/paths/~1appeals~1{tenantId}~1{id}/put/requestBody","description":"The updated appeal that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/appeals/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Appeal"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/appeals/{tenantId}/{id}","href":"appeals/updateappeal","openApiOperationId":"updateAppeal","summary":"Updates a appeal with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Appeal","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Appeal"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The appeal was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Appeal"}},"schemaId":"components/schemas/Appeal","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The appeal supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The appeal could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The appeal could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve appeal based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1appeals~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Appeal","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Appeal"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appeals/updateappeal"}],"panels":[]}]},"httpPath":"/appeals/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Appeals"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Appeals","showPageActions":true},{"nodeType":"markdoc","content":"Appeals"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/appeals/{tenantId}","summary":"Gets all of the appeals in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appeals/listappeals","deprecated":false},{"title":"/appeals/{tenantId}","summary":"Creates a new appeal record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appeals/createappeal","deprecated":false},{"title":"/appeals/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appeals/executebatchoperations","deprecated":false},{"title":"/appeals/{tenantId}/campaign/{campaign_id}","summary":"Returns a list of records with the specified campaign_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appeals/listappealsbycampaignid","deprecated":false},{"title":"/appeals/{tenantId}/search","summary":"Searches for appeals using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appeals/searchforappeals","deprecated":false},{"title":"/appeals/{tenantId}/{id}","summary":"Returns a appeal from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appeals/deleteappeal","deprecated":false},{"title":"/appeals/{tenantId}/{id}","summary":"Returns a appeal from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appeals/getappeal","deprecated":false},{"title":"/appeals/{tenantId}/{id}","summary":"Partially updates a appeal with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/appeals/patchappeal","deprecated":false},{"title":"/appeals/{tenantId}/{id}","summary":"Updates a appeal with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appeals/updateappeal","deprecated":false}]}]}]}]}},{"type":"group","label":"Billing Templates","link":"/apis/fundraising/fundraising-v1/billing-templates","routeSlug":"/apis/fundraising/fundraising-v1/billing-templates","items":[{"label":"Gets all of the billing templates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/billing-templates/listbillingtemplates","routeSlug":"/apis/fundraising/fundraising-v1/billing-templates/listbillingtemplates","metadata":{"seo":{"title":"Gets all of the billing templates in the system.","description":"This method will scan all billing templates and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBillingTemplates","name":"Gets all of the billing templates in the system.","isWebhook":false,"pointer":"/paths/~1billingTemplates~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the billing templates in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all billing templates and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingTemplates~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1billingTemplates~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingTemplates/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingTemplates/{tenantId}","href":"billing-templates/listbillingtemplates","openApiOperationId":"listBillingTemplates","summary":"Gets all of the billing templates in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing templateswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_522"}},"schemaId":"schema_522","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1billingTemplates~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_522","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_522"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-templates/listbillingtemplates"}],"panels":[]}]},"httpPath":"/billingTemplates/{tenantId}"},{"label":"Creates a new billing template record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/billing-templates/createbillingtemplate","routeSlug":"/apis/fundraising/fundraising-v1/billing-templates/createbillingtemplate","metadata":{"seo":{"title":"Creates a new billing template record that does not already exist.","description":"This method will auto-generate an ID and create a new billing template. If an ID is specified for the billing template, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBillingTemplate","name":"Creates a new billing template record that does not already exist.","isWebhook":false,"pointer":"/paths/~1billingTemplates~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new billing template record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new billing template. If an ID is specified for the billing template, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingTemplates~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"schemaId":"components/schemas/BillingTemplate","pointer":"/paths/~1billingTemplates~1{tenantId}/post/requestBody","description":"The billing template that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billingTemplates/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingTemplates/{tenantId}","href":"billing-templates/createbillingtemplate","openApiOperationId":"createBillingTemplate","summary":"Creates a new billing template record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BillingTemplate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing template was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"schemaId":"components/schemas/BillingTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The billing template you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The billing template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add billing template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1billingTemplates~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-templates/createbillingtemplate"}],"panels":[]}]},"httpPath":"/billingTemplates/{tenantId}"},{"label":"Generates a billing run from a template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/billing-templates/generatebillingrunfromtemplate","routeSlug":"/apis/fundraising/fundraising-v1/billing-templates/generatebillingrunfromtemplate","metadata":{"seo":{"title":"Generates a billing run from a template","description":"Generates a billing run from a template"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateBillingRunFromTemplate","name":"Generates a billing run from a template","isWebhook":false,"pointer":"/paths/~1billingTemplates~1{tenantId}~1fromTemplate~1{templateId}~1{referenceDate}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generates a billing run from a template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true},{"name":"templateId","in":"path","schemaId":"schema_518","description":"The template","required":true},{"name":"referenceDate","in":"path","schemaId":"schema_518","description":"The reference date","required":true}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1fromTemplate~1{templateId}~1{referenceDate}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingTemplates/{tenantId}/fromTemplate/{templateId}/{referenceDate}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_518"},{"name":"referenceDate","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingTemplates/{tenantId}/fromTemplate/{templateId}/{referenceDate}","href":"billing-templates/generatebillingrunfromtemplate","openApiOperationId":"generateBillingRunFromTemplate","summary":"Generates a billing run from a template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1fromTemplate~1{templateId}~1{referenceDate}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-templates/generatebillingrunfromtemplate"}],"panels":[]}]},"httpPath":"/billingTemplates/{tenantId}/fromTemplate/{templateId}/{referenceDate}"},{"label":"Returns a billing template from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/billing-templates/deletebillingtemplate","routeSlug":"/apis/fundraising/fundraising-v1/billing-templates/deletebillingtemplate","metadata":{"seo":{"title":"Returns a billing template from the system by its ID.","description":"This method will delete a billing template with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBillingTemplate","name":"Returns a billing template from the system by its ID.","isWebhook":false,"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a billing template from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a billing template with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the billing template to delete.","required":true}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/billingTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingTemplates/{tenantId}/{id}","href":"billing-templates/deletebillingtemplate","openApiOperationId":"deleteBillingTemplate","summary":"Returns a billing template from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing template was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The billing template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The billing template could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to delete billing template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-templates/deletebillingtemplate"}],"panels":[]}]},"httpPath":"/billingTemplates/{tenantId}/{id}"},{"label":"Returns a billing template from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/billing-templates/getbillingtemplate","routeSlug":"/apis/fundraising/fundraising-v1/billing-templates/getbillingtemplate","metadata":{"seo":{"title":"Returns a billing template from the system by its ID.","description":"This method will look up a billing template by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBillingTemplate","name":"Returns a billing template from the system by its ID.","isWebhook":false,"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a billing template from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a billing template by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the billing template to return.","required":true}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_518","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingTemplates/{tenantId}/{id}","href":"billing-templates/getbillingtemplate","openApiOperationId":"getBillingTemplate","summary":"Returns a billing template from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing template was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"schemaId":"components/schemas/BillingTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The billing template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve billing template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-templates/getbillingtemplate"}],"panels":[]}]},"httpPath":"/billingTemplates/{tenantId}/{id}"},{"label":"Partially updates a billing template with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/billing-templates/patchbillingtemplate","routeSlug":"/apis/fundraising/fundraising-v1/billing-templates/patchbillingtemplate","metadata":{"seo":{"title":"Partially updates a billing template with the specified ID.","description":"This method will patch an existing billing template with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchBillingTemplate","name":"Partially updates a billing template with the specified ID.","isWebhook":false,"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a billing template with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing billing template with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the billing template to patch.","required":true}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"schemaId":"schema_521","pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/billingTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_521"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingTemplates/{tenantId}/{id}","href":"billing-templates/patchbillingtemplate","openApiOperationId":"patchBillingTemplate","summary":"Partially updates a billing template with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"schema_521","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing template was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"schemaId":"components/schemas/BillingTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The billing template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The billing template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve billing template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-templates/patchbillingtemplate"}],"panels":[]}]},"httpPath":"/billingTemplates/{tenantId}/{id}"},{"label":"Updates a billing template with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/billing-templates/updatebillingtemplate","routeSlug":"/apis/fundraising/fundraising-v1/billing-templates/updatebillingtemplate","metadata":{"seo":{"title":"Updates a billing template with the specified ID.","description":"This method will update an existing billing template with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBillingTemplate","name":"Updates a billing template with the specified ID.","isWebhook":false,"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a billing template with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing billing template with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the billing template to update.","required":true}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"schemaId":"components/schemas/BillingTemplate","pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/put/requestBody","description":"The updated billing template that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/billingTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingTemplates/{tenantId}/{id}","href":"billing-templates/updatebillingtemplate","openApiOperationId":"updateBillingTemplate","summary":"Updates a billing template with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BillingTemplate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing template was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"schemaId":"components/schemas/BillingTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The billing template supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The billing template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The billing template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve billing template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-templates/updatebillingtemplate"}],"panels":[]}]},"httpPath":"/billingTemplates/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Billing Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Billing Templates","showPageActions":true},{"nodeType":"markdoc","content":"Billing Templates"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/billingTemplates/{tenantId}","summary":"Gets all of the billing templates in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-templates/listbillingtemplates","deprecated":false},{"title":"/billingTemplates/{tenantId}","summary":"Creates a new billing template record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-templates/createbillingtemplate","deprecated":false},{"title":"/billingTemplates/{tenantId}/fromTemplate/{templateId}/{referenceDate}","summary":"Generates a billing run from a template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-templates/generatebillingrunfromtemplate","deprecated":false},{"title":"/billingTemplates/{tenantId}/{id}","summary":"Returns a billing template from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/billing-templates/deletebillingtemplate","deprecated":false},{"title":"/billingTemplates/{tenantId}/{id}","summary":"Returns a billing template from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-templates/getbillingtemplate","deprecated":false},{"title":"/billingTemplates/{tenantId}/{id}","summary":"Partially updates a billing template with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/billing-templates/patchbillingtemplate","deprecated":false},{"title":"/billingTemplates/{tenantId}/{id}","summary":"Updates a billing template with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/billing-templates/updatebillingtemplate","deprecated":false}]}]}]}]}},{"type":"group","label":"Campaigns","link":"/apis/fundraising/fundraising-v1/campaigns","routeSlug":"/apis/fundraising/fundraising-v1/campaigns","items":[{"label":"Creates a new campaign record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/campaigns/createcampaign","routeSlug":"/apis/fundraising/fundraising-v1/campaigns/createcampaign","metadata":{"seo":{"title":"Creates a new campaign record that does not already exist.","description":"This method will auto-generate an ID and create a new campaign. If an ID is specified for the campaign, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCampaign","name":"Creates a new campaign record that does not already exist.","isWebhook":false,"pointer":"/paths/~1campaigns~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new campaign record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new campaign. If an ID is specified for the campaign, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1campaigns~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Campaign"}},"schemaId":"components/schemas/Campaign","pointer":"/paths/~1campaigns~1{tenantId}/post/requestBody","description":"The campaign that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/campaigns/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Campaign"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/campaigns/{tenantId}","href":"campaigns/createcampaign","openApiOperationId":"createCampaign","summary":"Creates a new campaign record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Campaign","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Campaign"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The campaign was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Campaign"}},"schemaId":"components/schemas/Campaign","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The campaign you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The campaign could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add campaign based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1campaigns~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Campaign","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Campaign"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/createcampaign"}],"panels":[]}]},"httpPath":"/campaigns/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/campaigns/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/campaigns/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1campaigns~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1campaigns~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1campaigns~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/campaigns/{tenantId}/batch","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/campaigns/{tenantId}/batch","href":"campaigns/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The campaign could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve campaign based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1campaigns~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/executebatchoperations"}],"panels":[]}]},"httpPath":"/campaigns/{tenantId}/batch"},{"label":"Searches for campaigns using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/campaigns/searchforcampaigns","routeSlug":"/apis/fundraising/fundraising-v1/campaigns/searchforcampaigns","metadata":{"seo":{"title":"Searches for campaigns using predefined parameters","description":"Searches for campaigns using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForCampaigns","name":"Searches for campaigns using predefined parameters","isWebhook":false,"pointer":"/paths/~1campaigns~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for campaigns using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for campaigns using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1campaigns~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_518","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1campaigns~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CampaignSearchParameters"}},"schemaId":"components/schemas/CampaignSearchParameters","pointer":"/paths/~1campaigns~1{tenantId}~1search/post/requestBody","description":"The campaign that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/campaigns/{tenantId}/search","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CampaignSearchParameters"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/campaigns/{tenantId}/search","href":"campaigns/searchforcampaigns","openApiOperationId":"searchForCampaigns","summary":"Searches for campaigns using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CampaignSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CampaignSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The campaign search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedCampaignSearchResults"}},"schemaId":"components/schemas/PagedCampaignSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The campaign you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The campaign could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add campaign based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1campaigns~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedCampaignSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedCampaignSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/searchforcampaigns"}],"panels":[]}]},"httpPath":"/campaigns/{tenantId}/search"},{"label":"Returns a campaign from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/campaigns/deletecampaign","routeSlug":"/apis/fundraising/fundraising-v1/campaigns/deletecampaign","metadata":{"seo":{"title":"Returns a campaign from the system by its ID.","description":"This method will delete a campaign with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCampaign","name":"Returns a campaign from the system by its ID.","isWebhook":false,"pointer":"/paths/~1campaigns~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a campaign from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a campaign with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the campaign to delete.","required":true}],"pointer":"/paths/~1campaigns~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/campaigns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/campaigns/{tenantId}/{id}","href":"campaigns/deletecampaign","openApiOperationId":"deleteCampaign","summary":"Returns a campaign from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The campaign was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The campaign could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The campaign could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to delete campaign based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1campaigns~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/deletecampaign"}],"panels":[]}]},"httpPath":"/campaigns/{tenantId}/{id}"},{"label":"Returns a campaign from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/campaigns/getcampaign","routeSlug":"/apis/fundraising/fundraising-v1/campaigns/getcampaign","metadata":{"seo":{"title":"Returns a campaign from the system by its ID.","description":"This method will look up a campaign by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCampaign","name":"Returns a campaign from the system by its ID.","isWebhook":false,"pointer":"/paths/~1campaigns~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a campaign from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a campaign by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the campaign to return.","required":true}],"pointer":"/paths/~1campaigns~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_518","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1campaigns~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/campaigns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/campaigns/{tenantId}/{id}","href":"campaigns/getcampaign","openApiOperationId":"getCampaign","summary":"Returns a campaign from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The campaign was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Campaign"}},"schemaId":"components/schemas/Campaign","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The campaign could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve campaign based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1campaigns~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Campaign","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Campaign"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/getcampaign"}],"panels":[]}]},"httpPath":"/campaigns/{tenantId}/{id}"},{"label":"Partially updates a campaign with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/campaigns/patchcampaign","routeSlug":"/apis/fundraising/fundraising-v1/campaigns/patchcampaign","metadata":{"seo":{"title":"Partially updates a campaign with the specified ID.","description":"This method will patch an existing campaign with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCampaign","name":"Partially updates a campaign with the specified ID.","isWebhook":false,"pointer":"/paths/~1campaigns~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a campaign with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing campaign with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the campaign to patch.","required":true}],"pointer":"/paths/~1campaigns~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"schemaId":"schema_521","pointer":"/paths/~1campaigns~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/campaigns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_521"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/campaigns/{tenantId}/{id}","href":"campaigns/patchcampaign","openApiOperationId":"patchCampaign","summary":"Partially updates a campaign with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"schema_521","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The campaign was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Campaign"}},"schemaId":"components/schemas/Campaign","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The campaign could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The campaign could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve campaign based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1campaigns~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Campaign","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Campaign"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/patchcampaign"}],"panels":[]}]},"httpPath":"/campaigns/{tenantId}/{id}"},{"label":"Updates a campaign with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/campaigns/updatecampaign","routeSlug":"/apis/fundraising/fundraising-v1/campaigns/updatecampaign","metadata":{"seo":{"title":"Updates a campaign with the specified ID.","description":"This method will update an existing campaign with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCampaign","name":"Updates a campaign with the specified ID.","isWebhook":false,"pointer":"/paths/~1campaigns~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a campaign with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing campaign with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the campaign to update.","required":true}],"pointer":"/paths/~1campaigns~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Campaign"}},"schemaId":"components/schemas/Campaign","pointer":"/paths/~1campaigns~1{tenantId}~1{id}/put/requestBody","description":"The updated campaign that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/campaigns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Campaign"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/campaigns/{tenantId}/{id}","href":"campaigns/updatecampaign","openApiOperationId":"updateCampaign","summary":"Updates a campaign with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Campaign","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Campaign"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The campaign was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Campaign"}},"schemaId":"components/schemas/Campaign","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The campaign supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The campaign could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The campaign could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve campaign based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1campaigns~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Campaign","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Campaign"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/updatecampaign"}],"panels":[]}]},"httpPath":"/campaigns/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Campaigns"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Campaigns","showPageActions":true},{"nodeType":"markdoc","content":"Campaigns"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/campaigns/{tenantId}","summary":"Creates a new campaign record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/campaigns/createcampaign","deprecated":false},{"title":"/campaigns/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/campaigns/executebatchoperations","deprecated":false},{"title":"/campaigns/{tenantId}/search","summary":"Searches for campaigns using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/campaigns/searchforcampaigns","deprecated":false},{"title":"/campaigns/{tenantId}/{id}","summary":"Returns a campaign from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/campaigns/deletecampaign","deprecated":false},{"title":"/campaigns/{tenantId}/{id}","summary":"Returns a campaign from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaigns/getcampaign","deprecated":false},{"title":"/campaigns/{tenantId}/{id}","summary":"Partially updates a campaign with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/campaigns/patchcampaign","deprecated":false},{"title":"/campaigns/{tenantId}/{id}","summary":"Updates a campaign with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/campaigns/updatecampaign","deprecated":false}]}]}]}]}},{"type":"group","label":"Donor Clubs","link":"/apis/fundraising/fundraising-v1/donor-clubs","routeSlug":"/apis/fundraising/fundraising-v1/donor-clubs","items":[{"label":"Gets all of the donor clubs in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-clubs/listdonorclubs","routeSlug":"/apis/fundraising/fundraising-v1/donor-clubs/listdonorclubs","metadata":{"seo":{"title":"Gets all of the donor clubs in the system.","description":"This method will scan all donor clubs and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDonorClubs","name":"Gets all of the donor clubs in the system.","isWebhook":false,"pointer":"/paths/~1donorClubs~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the donor clubs in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all donor clubs and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1donorClubs~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1donorClubs~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/donorClubs/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/donorClubs/{tenantId}","href":"donor-clubs/listdonorclubs","openApiOperationId":"listDonorClubs","summary":"Gets all of the donor clubs in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor clubswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_523"}},"schemaId":"schema_523","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorClubs~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_523","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_523"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-clubs/listdonorclubs"}],"panels":[]}]},"httpPath":"/donorClubs/{tenantId}"},{"label":"Creates a new donor club record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-clubs/createdonorclub","routeSlug":"/apis/fundraising/fundraising-v1/donor-clubs/createdonorclub","metadata":{"seo":{"title":"Creates a new donor club record that does not already exist.","description":"This method will auto-generate an ID and create a new donor club. If an ID is specified for the donor club, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDonorClub","name":"Creates a new donor club record that does not already exist.","isWebhook":false,"pointer":"/paths/~1donorClubs~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new donor club record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new donor club. If an ID is specified for the donor club, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1donorClubs~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DonorClub"}},"schemaId":"components/schemas/DonorClub","pointer":"/paths/~1donorClubs~1{tenantId}/post/requestBody","description":"The donor club that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/donorClubs/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DonorClub"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/donorClubs/{tenantId}","href":"donor-clubs/createdonorclub","openApiOperationId":"createDonorClub","summary":"Creates a new donor club record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DonorClub","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DonorClub"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor club was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorClub"}},"schemaId":"components/schemas/DonorClub","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The donor club you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The donor club could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add donor club based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorClubs~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DonorClub","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorClub"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-clubs/createdonorclub"}],"panels":[]}]},"httpPath":"/donorClubs/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-clubs/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/donor-clubs/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1donorClubs~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1donorClubs~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1donorClubs~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/donorClubs/{tenantId}/batch","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/donorClubs/{tenantId}/batch","href":"donor-clubs/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The donor club could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve donor club based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorClubs~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-clubs/executebatchoperations"}],"panels":[]}]},"httpPath":"/donorClubs/{tenantId}/batch"},{"label":"Returns a donor club from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-clubs/deletedonorclub","routeSlug":"/apis/fundraising/fundraising-v1/donor-clubs/deletedonorclub","metadata":{"seo":{"title":"Returns a donor club from the system by its ID.","description":"This method will delete a donor club with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDonorClub","name":"Returns a donor club from the system by its ID.","isWebhook":false,"pointer":"/paths/~1donorClubs~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a donor club from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a donor club with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the donor club to delete.","required":true}],"pointer":"/paths/~1donorClubs~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/donorClubs/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/donorClubs/{tenantId}/{id}","href":"donor-clubs/deletedonorclub","openApiOperationId":"deleteDonorClub","summary":"Returns a donor club from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor club was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The donor club could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The donor club could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to delete donor club based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorClubs~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-clubs/deletedonorclub"}],"panels":[]}]},"httpPath":"/donorClubs/{tenantId}/{id}"},{"label":"Returns a donor club from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-clubs/getdonorclub","routeSlug":"/apis/fundraising/fundraising-v1/donor-clubs/getdonorclub","metadata":{"seo":{"title":"Returns a donor club from the system by its ID.","description":"This method will look up a donor club by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDonorClub","name":"Returns a donor club from the system by its ID.","isWebhook":false,"pointer":"/paths/~1donorClubs~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a donor club from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a donor club by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the donor club to return.","required":true}],"pointer":"/paths/~1donorClubs~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_518","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1donorClubs~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/donorClubs/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/donorClubs/{tenantId}/{id}","href":"donor-clubs/getdonorclub","openApiOperationId":"getDonorClub","summary":"Returns a donor club from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor club was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorClub"}},"schemaId":"components/schemas/DonorClub","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The donor club could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve donor club based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorClubs~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DonorClub","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorClub"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-clubs/getdonorclub"}],"panels":[]}]},"httpPath":"/donorClubs/{tenantId}/{id}"},{"label":"Partially updates a donor club with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-clubs/patchdonorclub","routeSlug":"/apis/fundraising/fundraising-v1/donor-clubs/patchdonorclub","metadata":{"seo":{"title":"Partially updates a donor club with the specified ID.","description":"This method will patch an existing donor club with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchDonorClub","name":"Partially updates a donor club with the specified ID.","isWebhook":false,"pointer":"/paths/~1donorClubs~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a donor club with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing donor club with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the donor club to patch.","required":true}],"pointer":"/paths/~1donorClubs~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"schemaId":"schema_521","pointer":"/paths/~1donorClubs~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/donorClubs/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_521"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/donorClubs/{tenantId}/{id}","href":"donor-clubs/patchdonorclub","openApiOperationId":"patchDonorClub","summary":"Partially updates a donor club with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"schema_521","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor club was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorClub"}},"schemaId":"components/schemas/DonorClub","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The donor club could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The donor club could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve donor club based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorClubs~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DonorClub","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorClub"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-clubs/patchdonorclub"}],"panels":[]}]},"httpPath":"/donorClubs/{tenantId}/{id}"},{"label":"Updates a donor club with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-clubs/updatedonorclub","routeSlug":"/apis/fundraising/fundraising-v1/donor-clubs/updatedonorclub","metadata":{"seo":{"title":"Updates a donor club with the specified ID.","description":"This method will update an existing donor club with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDonorClub","name":"Updates a donor club with the specified ID.","isWebhook":false,"pointer":"/paths/~1donorClubs~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a donor club with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing donor club with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the donor club to update.","required":true}],"pointer":"/paths/~1donorClubs~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DonorClub"}},"schemaId":"components/schemas/DonorClub","pointer":"/paths/~1donorClubs~1{tenantId}~1{id}/put/requestBody","description":"The updated donor club that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/donorClubs/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DonorClub"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/donorClubs/{tenantId}/{id}","href":"donor-clubs/updatedonorclub","openApiOperationId":"updateDonorClub","summary":"Updates a donor club with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DonorClub","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DonorClub"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor club was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorClub"}},"schemaId":"components/schemas/DonorClub","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The donor club supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The donor club could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The donor club could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve donor club based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorClubs~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DonorClub","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorClub"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-clubs/updatedonorclub"}],"panels":[]}]},"httpPath":"/donorClubs/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Donor Clubs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Donor Clubs","showPageActions":true},{"nodeType":"markdoc","content":"Donor Clubs"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/donorClubs/{tenantId}","summary":"Gets all of the donor clubs in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/donor-clubs/listdonorclubs","deprecated":false},{"title":"/donorClubs/{tenantId}","summary":"Creates a new donor club record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/donor-clubs/createdonorclub","deprecated":false},{"title":"/donorClubs/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/donor-clubs/executebatchoperations","deprecated":false},{"title":"/donorClubs/{tenantId}/{id}","summary":"Returns a donor club from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/donor-clubs/deletedonorclub","deprecated":false},{"title":"/donorClubs/{tenantId}/{id}","summary":"Returns a donor club from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/donor-clubs/getdonorclub","deprecated":false},{"title":"/donorClubs/{tenantId}/{id}","summary":"Partially updates a donor club with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/donor-clubs/patchdonorclub","deprecated":false},{"title":"/donorClubs/{tenantId}/{id}","summary":"Updates a donor club with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/donor-clubs/updatedonorclub","deprecated":false}]}]}]}]}},{"type":"group","label":"Donor Levels","link":"/apis/fundraising/fundraising-v1/donor-levels","routeSlug":"/apis/fundraising/fundraising-v1/donor-levels","items":[{"label":"Gets all of the donor levels in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-levels/listdonorlevels","routeSlug":"/apis/fundraising/fundraising-v1/donor-levels/listdonorlevels","metadata":{"seo":{"title":"Gets all of the donor levels in the system.","description":"This method will scan all donor levels and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDonorLevels","name":"Gets all of the donor levels in the system.","isWebhook":false,"pointer":"/paths/~1donorLevels~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the donor levels in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all donor levels and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1donorLevels~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1donorLevels~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/donorLevels/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/donorLevels/{tenantId}","href":"donor-levels/listdonorlevels","openApiOperationId":"listDonorLevels","summary":"Gets all of the donor levels in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor levelswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_524"}},"schemaId":"schema_524","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorLevels~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_524","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_524"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-levels/listdonorlevels"}],"panels":[]}]},"httpPath":"/donorLevels/{tenantId}"},{"label":"Creates a new donor level record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-levels/createdonorlevel","routeSlug":"/apis/fundraising/fundraising-v1/donor-levels/createdonorlevel","metadata":{"seo":{"title":"Creates a new donor level record that does not already exist.","description":"This method will auto-generate an ID and create a new donor level. If an ID is specified for the donor level, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDonorLevel","name":"Creates a new donor level record that does not already exist.","isWebhook":false,"pointer":"/paths/~1donorLevels~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new donor level record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new donor level. If an ID is specified for the donor level, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1donorLevels~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DonorLevel"}},"schemaId":"components/schemas/DonorLevel","pointer":"/paths/~1donorLevels~1{tenantId}/post/requestBody","description":"The donor level that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/donorLevels/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DonorLevel"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/donorLevels/{tenantId}","href":"donor-levels/createdonorlevel","openApiOperationId":"createDonorLevel","summary":"Creates a new donor level record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DonorLevel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DonorLevel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor level was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorLevel"}},"schemaId":"components/schemas/DonorLevel","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The donor level you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The donor level could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add donor level based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorLevels~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DonorLevel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorLevel"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-levels/createdonorlevel"}],"panels":[]}]},"httpPath":"/donorLevels/{tenantId}"},{"label":"Returns a donor level from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-levels/deletedonorlevel","routeSlug":"/apis/fundraising/fundraising-v1/donor-levels/deletedonorlevel","metadata":{"seo":{"title":"Returns a donor level from the system by its ID.","description":"This method will delete a donor level with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDonorLevel","name":"Returns a donor level from the system by its ID.","isWebhook":false,"pointer":"/paths/~1donorLevels~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a donor level from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a donor level with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the donor level to delete.","required":true}],"pointer":"/paths/~1donorLevels~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/donorLevels/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/donorLevels/{tenantId}/{id}","href":"donor-levels/deletedonorlevel","openApiOperationId":"deleteDonorLevel","summary":"Returns a donor level from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor level was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The donor level could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The donor level could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to delete donor level based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorLevels~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-levels/deletedonorlevel"}],"panels":[]}]},"httpPath":"/donorLevels/{tenantId}/{id}"},{"label":"Returns a donor level from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-levels/getdonorlevel","routeSlug":"/apis/fundraising/fundraising-v1/donor-levels/getdonorlevel","metadata":{"seo":{"title":"Returns a donor level from the system by its ID.","description":"This method will look up a donor level by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDonorLevel","name":"Returns a donor level from the system by its ID.","isWebhook":false,"pointer":"/paths/~1donorLevels~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a donor level from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a donor level by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the donor level to return.","required":true}],"pointer":"/paths/~1donorLevels~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_518","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1donorLevels~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/donorLevels/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/donorLevels/{tenantId}/{id}","href":"donor-levels/getdonorlevel","openApiOperationId":"getDonorLevel","summary":"Returns a donor level from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor level was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorLevel"}},"schemaId":"components/schemas/DonorLevel","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The donor level could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve donor level based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorLevels~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DonorLevel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorLevel"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-levels/getdonorlevel"}],"panels":[]}]},"httpPath":"/donorLevels/{tenantId}/{id}"},{"label":"Partially updates a donor level with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-levels/patchdonorlevel","routeSlug":"/apis/fundraising/fundraising-v1/donor-levels/patchdonorlevel","metadata":{"seo":{"title":"Partially updates a donor level with the specified ID.","description":"This method will patch an existing donor level with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchDonorLevel","name":"Partially updates a donor level with the specified ID.","isWebhook":false,"pointer":"/paths/~1donorLevels~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a donor level with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing donor level with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the donor level to patch.","required":true}],"pointer":"/paths/~1donorLevels~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"schemaId":"schema_521","pointer":"/paths/~1donorLevels~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/donorLevels/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_521"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/donorLevels/{tenantId}/{id}","href":"donor-levels/patchdonorlevel","openApiOperationId":"patchDonorLevel","summary":"Partially updates a donor level with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"schema_521","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor level was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorLevel"}},"schemaId":"components/schemas/DonorLevel","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The donor level could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The donor level could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve donor level based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorLevels~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DonorLevel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorLevel"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-levels/patchdonorlevel"}],"panels":[]}]},"httpPath":"/donorLevels/{tenantId}/{id}"},{"label":"Updates a donor level with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-levels/updatedonorlevel","routeSlug":"/apis/fundraising/fundraising-v1/donor-levels/updatedonorlevel","metadata":{"seo":{"title":"Updates a donor level with the specified ID.","description":"This method will update an existing donor level with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDonorLevel","name":"Updates a donor level with the specified ID.","isWebhook":false,"pointer":"/paths/~1donorLevels~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a donor level with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing donor level with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the donor level to update.","required":true}],"pointer":"/paths/~1donorLevels~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DonorLevel"}},"schemaId":"components/schemas/DonorLevel","pointer":"/paths/~1donorLevels~1{tenantId}~1{id}/put/requestBody","description":"The updated donor level that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/donorLevels/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DonorLevel"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/donorLevels/{tenantId}/{id}","href":"donor-levels/updatedonorlevel","openApiOperationId":"updateDonorLevel","summary":"Updates a donor level with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DonorLevel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DonorLevel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor level was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorLevel"}},"schemaId":"components/schemas/DonorLevel","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The donor level supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The donor level could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The donor level could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve donor level based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorLevels~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DonorLevel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorLevel"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-levels/updatedonorlevel"}],"panels":[]}]},"httpPath":"/donorLevels/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Donor Levels"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Donor Levels","showPageActions":true},{"nodeType":"markdoc","content":"Donor Levels"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/donorLevels/{tenantId}","summary":"Gets all of the donor levels in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/donor-levels/listdonorlevels","deprecated":false},{"title":"/donorLevels/{tenantId}","summary":"Creates a new donor level record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/donor-levels/createdonorlevel","deprecated":false},{"title":"/donorLevels/{tenantId}/{id}","summary":"Returns a donor level from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/donor-levels/deletedonorlevel","deprecated":false},{"title":"/donorLevels/{tenantId}/{id}","summary":"Returns a donor level from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/donor-levels/getdonorlevel","deprecated":false},{"title":"/donorLevels/{tenantId}/{id}","summary":"Partially updates a donor level with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/donor-levels/patchdonorlevel","deprecated":false},{"title":"/donorLevels/{tenantId}/{id}","summary":"Updates a donor level with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/donor-levels/updatedonorlevel","deprecated":false}]}]}]}]}},{"type":"group","label":"Donor Statement Templates","link":"/apis/fundraising/fundraising-v1/donor-statement-templates","routeSlug":"/apis/fundraising/fundraising-v1/donor-statement-templates","items":[{"label":"Gets all of the donor statement templates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statement-templates/listdonorstatementtemplates","routeSlug":"/apis/fundraising/fundraising-v1/donor-statement-templates/listdonorstatementtemplates","metadata":{"seo":{"title":"Gets all of the donor statement templates in the system.","description":"This method will scan all donor statement templates and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDonorStatementTemplates","name":"Gets all of the donor statement templates in the system.","isWebhook":false,"pointer":"/paths/~1donorStatementTemplates~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the donor statement templates in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all donor statement templates and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1donorStatementTemplates~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1donorStatementTemplates~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/donorStatementTemplates/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/donorStatementTemplates/{tenantId}","href":"donor-statement-templates/listdonorstatementtemplates","openApiOperationId":"listDonorStatementTemplates","summary":"Gets all of the donor statement templates in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor statement templateswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_525"}},"schemaId":"schema_525","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorStatementTemplates~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_525","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_525"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-statement-templates/listdonorstatementtemplates"}],"panels":[]}]},"httpPath":"/donorStatementTemplates/{tenantId}"},{"label":"Creates a new donor statement template record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statement-templates/createdonorstatementtemplate","routeSlug":"/apis/fundraising/fundraising-v1/donor-statement-templates/createdonorstatementtemplate","metadata":{"seo":{"title":"Creates a new donor statement template record that does not already exist.","description":"This method will auto-generate an ID and create a new donor statement template. If an ID is specified for the donor statement template, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDonorStatementTemplate","name":"Creates a new donor statement template record that does not already exist.","isWebhook":false,"pointer":"/paths/~1donorStatementTemplates~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new donor statement template record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new donor statement template. If an ID is specified for the donor statement template, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1donorStatementTemplates~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DonorStatementTemplate"}},"schemaId":"components/schemas/DonorStatementTemplate","pointer":"/paths/~1donorStatementTemplates~1{tenantId}/post/requestBody","description":"The donor statement template that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/donorStatementTemplates/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DonorStatementTemplate"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/donorStatementTemplates/{tenantId}","href":"donor-statement-templates/createdonorstatementtemplate","openApiOperationId":"createDonorStatementTemplate","summary":"Creates a new donor statement template record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DonorStatementTemplate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DonorStatementTemplate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor statement template was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorStatementTemplate"}},"schemaId":"components/schemas/DonorStatementTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The donor statement template you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The donor statement template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add donor statement template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorStatementTemplates~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DonorStatementTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorStatementTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-statement-templates/createdonorstatementtemplate"}],"panels":[]}]},"httpPath":"/donorStatementTemplates/{tenantId}"},{"label":"Returns a donor statement template from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statement-templates/deletedonorstatementtemplate","routeSlug":"/apis/fundraising/fundraising-v1/donor-statement-templates/deletedonorstatementtemplate","metadata":{"seo":{"title":"Returns a donor statement template from the system by its ID.","description":"This method will delete a donor statement template with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDonorStatementTemplate","name":"Returns a donor statement template from the system by its ID.","isWebhook":false,"pointer":"/paths/~1donorStatementTemplates~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a donor statement template from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a donor statement template with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the donor statement template to delete.","required":true}],"pointer":"/paths/~1donorStatementTemplates~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/donorStatementTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/donorStatementTemplates/{tenantId}/{id}","href":"donor-statement-templates/deletedonorstatementtemplate","openApiOperationId":"deleteDonorStatementTemplate","summary":"Returns a donor statement template from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor statement template was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The donor statement template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The donor statement template could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to delete donor statement template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorStatementTemplates~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-statement-templates/deletedonorstatementtemplate"}],"panels":[]}]},"httpPath":"/donorStatementTemplates/{tenantId}/{id}"},{"label":"Returns a donor statement template from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statement-templates/getdonorstatementtemplate","routeSlug":"/apis/fundraising/fundraising-v1/donor-statement-templates/getdonorstatementtemplate","metadata":{"seo":{"title":"Returns a donor statement template from the system by its ID.","description":"This method will look up a donor statement template by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDonorStatementTemplate","name":"Returns a donor statement template from the system by its ID.","isWebhook":false,"pointer":"/paths/~1donorStatementTemplates~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a donor statement template from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a donor statement template by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the donor statement template to return.","required":true}],"pointer":"/paths/~1donorStatementTemplates~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_518","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1donorStatementTemplates~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/donorStatementTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/donorStatementTemplates/{tenantId}/{id}","href":"donor-statement-templates/getdonorstatementtemplate","openApiOperationId":"getDonorStatementTemplate","summary":"Returns a donor statement template from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor statement template was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorStatementTemplate"}},"schemaId":"components/schemas/DonorStatementTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The donor statement template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve donor statement template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorStatementTemplates~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DonorStatementTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorStatementTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-statement-templates/getdonorstatementtemplate"}],"panels":[]}]},"httpPath":"/donorStatementTemplates/{tenantId}/{id}"},{"label":"Partially updates a donor statement template with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statement-templates/patchdonorstatementtemplate","routeSlug":"/apis/fundraising/fundraising-v1/donor-statement-templates/patchdonorstatementtemplate","metadata":{"seo":{"title":"Partially updates a donor statement template with the specified ID.","description":"This method will patch an existing donor statement template with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchDonorStatementTemplate","name":"Partially updates a donor statement template with the specified ID.","isWebhook":false,"pointer":"/paths/~1donorStatementTemplates~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a donor statement template with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing donor statement template with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the donor statement template to patch.","required":true}],"pointer":"/paths/~1donorStatementTemplates~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"schemaId":"schema_521","pointer":"/paths/~1donorStatementTemplates~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/donorStatementTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_521"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/donorStatementTemplates/{tenantId}/{id}","href":"donor-statement-templates/patchdonorstatementtemplate","openApiOperationId":"patchDonorStatementTemplate","summary":"Partially updates a donor statement template with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"schema_521","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor statement template was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorStatementTemplate"}},"schemaId":"components/schemas/DonorStatementTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The donor statement template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The donor statement template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve donor statement template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorStatementTemplates~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DonorStatementTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorStatementTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-statement-templates/patchdonorstatementtemplate"}],"panels":[]}]},"httpPath":"/donorStatementTemplates/{tenantId}/{id}"},{"label":"Updates a donor statement template with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statement-templates/updatedonorstatementtemplate","routeSlug":"/apis/fundraising/fundraising-v1/donor-statement-templates/updatedonorstatementtemplate","metadata":{"seo":{"title":"Updates a donor statement template with the specified ID.","description":"This method will update an existing donor statement template with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDonorStatementTemplate","name":"Updates a donor statement template with the specified ID.","isWebhook":false,"pointer":"/paths/~1donorStatementTemplates~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a donor statement template with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing donor statement template with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the donor statement template to update.","required":true}],"pointer":"/paths/~1donorStatementTemplates~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DonorStatementTemplate"}},"schemaId":"components/schemas/DonorStatementTemplate","pointer":"/paths/~1donorStatementTemplates~1{tenantId}~1{id}/put/requestBody","description":"The updated donor statement template that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/donorStatementTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DonorStatementTemplate"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/donorStatementTemplates/{tenantId}/{id}","href":"donor-statement-templates/updatedonorstatementtemplate","openApiOperationId":"updateDonorStatementTemplate","summary":"Updates a donor statement template with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DonorStatementTemplate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DonorStatementTemplate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor statement template was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorStatementTemplate"}},"schemaId":"components/schemas/DonorStatementTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The donor statement template supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The donor statement template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The donor statement template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve donor statement template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorStatementTemplates~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DonorStatementTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorStatementTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-statement-templates/updatedonorstatementtemplate"}],"panels":[]}]},"httpPath":"/donorStatementTemplates/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Donor Statement Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Donor Statement Templates","showPageActions":true},{"nodeType":"markdoc","content":"Donor Statement Templates"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/donorStatementTemplates/{tenantId}","summary":"Gets all of the donor statement templates in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/donor-statement-templates/listdonorstatementtemplates","deprecated":false},{"title":"/donorStatementTemplates/{tenantId}","summary":"Creates a new donor statement template record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/donor-statement-templates/createdonorstatementtemplate","deprecated":false},{"title":"/donorStatementTemplates/{tenantId}/{id}","summary":"Returns a donor statement template from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/donor-statement-templates/deletedonorstatementtemplate","deprecated":false},{"title":"/donorStatementTemplates/{tenantId}/{id}","summary":"Returns a donor statement template from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/donor-statement-templates/getdonorstatementtemplate","deprecated":false},{"title":"/donorStatementTemplates/{tenantId}/{id}","summary":"Partially updates a donor statement template with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/donor-statement-templates/patchdonorstatementtemplate","deprecated":false},{"title":"/donorStatementTemplates/{tenantId}/{id}","summary":"Updates a donor statement template with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/donor-statement-templates/updatedonorstatementtemplate","deprecated":false}]}]}]}]}},{"type":"group","label":"Donor Statements","link":"/apis/fundraising/fundraising-v1/donor-statements","routeSlug":"/apis/fundraising/fundraising-v1/donor-statements","items":[{"label":"Creates a new donor statement record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statements/createdonorstatement","routeSlug":"/apis/fundraising/fundraising-v1/donor-statements/createdonorstatement","metadata":{"seo":{"title":"Creates a new donor statement record that does not already exist.","description":"This method will auto-generate an ID and create a new donor statement. If an ID is specified for the donor statement, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDonorStatement","name":"Creates a new donor statement record that does not already exist.","isWebhook":false,"pointer":"/paths/~1donorStatements~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new donor statement record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new donor statement. If an ID is specified for the donor statement, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1donorStatements~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DonorStatement"}},"schemaId":"components/schemas/DonorStatement","pointer":"/paths/~1donorStatements~1{tenantId}/post/requestBody","description":"The donor statement that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/donorStatements/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DonorStatement"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/donorStatements/{tenantId}","href":"donor-statements/createdonorstatement","openApiOperationId":"createDonorStatement","summary":"Creates a new donor statement record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DonorStatement","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DonorStatement"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor statement was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorStatement"}},"schemaId":"components/schemas/DonorStatement","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The donor statement you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The donor statement could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add donor statement based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorStatements~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DonorStatement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorStatement"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-statements/createdonorstatement"}],"panels":[]}]},"httpPath":"/donorStatements/{tenantId}"},{"label":"Returns a list of records with the specified donor_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statements/liststatementsbydonorid","routeSlug":"/apis/fundraising/fundraising-v1/donor-statements/liststatementsbydonorid","metadata":{"seo":{"title":"Returns a list of records with the specified donor_id","description":"Returns a list of records with the specified donor_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listStatementsByDonorId","name":"Returns a list of records with the specified donor_id","isWebhook":false,"pointer":"/paths/~1donorStatements~1{tenantId}~1donor~1{donor_type}~1{donor_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified donor_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified donor_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true},{"name":"donor_type","in":"path","schemaId":"schema_518","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The donor_type to use for record lookup"},"children":[]}]}]}],"required":true},{"name":"donor_id","in":"path","schemaId":"schema_518","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The donor_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1donorStatements~1{tenantId}~1donor~1{donor_type}~1{donor_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1donorStatements~1{tenantId}~1donor~1{donor_type}~1{donor_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/donorStatements/{tenantId}/donor/{donor_type}/{donor_id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"donor_type","in":"path","required":true,"schemaId":"schema_518"},{"name":"donor_id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/donorStatements/{tenantId}/donor/{donor_type}/{donor_id}","href":"donor-statements/liststatementsbydonorid","openApiOperationId":"listStatementsByDonorId","summary":"Returns a list of records with the specified donor_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListDonorStatementsResponse"}},"schemaId":"components/schemas/ListDonorStatementsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorStatements~1{tenantId}~1donor~1{donor_type}~1{donor_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListDonorStatementsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListDonorStatementsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-statements/liststatementsbydonorid"}],"panels":[]}]},"httpPath":"/donorStatements/{tenantId}/donor/{donor_type}/{donor_id}"},{"label":"Returns a donor statement from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statements/deletedonorstatement","routeSlug":"/apis/fundraising/fundraising-v1/donor-statements/deletedonorstatement","metadata":{"seo":{"title":"Returns a donor statement from the system by its ID.","description":"This method will delete a donor statement with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDonorStatement","name":"Returns a donor statement from the system by its ID.","isWebhook":false,"pointer":"/paths/~1donorStatements~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a donor statement from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a donor statement with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the donor statement to delete.","required":true}],"pointer":"/paths/~1donorStatements~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/donorStatements/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/donorStatements/{tenantId}/{id}","href":"donor-statements/deletedonorstatement","openApiOperationId":"deleteDonorStatement","summary":"Returns a donor statement from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor statement was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The donor statement could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The donor statement could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to delete donor statement based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorStatements~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-statements/deletedonorstatement"}],"panels":[]}]},"httpPath":"/donorStatements/{tenantId}/{id}"},{"label":"Returns a donor statement from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statements/getdonorstatement","routeSlug":"/apis/fundraising/fundraising-v1/donor-statements/getdonorstatement","metadata":{"seo":{"title":"Returns a donor statement from the system by its ID.","description":"This method will look up a donor statement by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDonorStatement","name":"Returns a donor statement from the system by its ID.","isWebhook":false,"pointer":"/paths/~1donorStatements~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a donor statement from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a donor statement by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the donor statement to return.","required":true}],"pointer":"/paths/~1donorStatements~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_518","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1donorStatements~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/donorStatements/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/donorStatements/{tenantId}/{id}","href":"donor-statements/getdonorstatement","openApiOperationId":"getDonorStatement","summary":"Returns a donor statement from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor statement was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorStatement"}},"schemaId":"components/schemas/DonorStatement","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The donor statement could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve donor statement based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorStatements~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DonorStatement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorStatement"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-statements/getdonorstatement"}],"panels":[]}]},"httpPath":"/donorStatements/{tenantId}/{id}"},{"label":"Partially updates a donor statement with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statements/patchdonorstatement","routeSlug":"/apis/fundraising/fundraising-v1/donor-statements/patchdonorstatement","metadata":{"seo":{"title":"Partially updates a donor statement with the specified ID.","description":"This method will patch an existing donor statement with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchDonorStatement","name":"Partially updates a donor statement with the specified ID.","isWebhook":false,"pointer":"/paths/~1donorStatements~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a donor statement with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing donor statement with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the donor statement to patch.","required":true}],"pointer":"/paths/~1donorStatements~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"schemaId":"schema_521","pointer":"/paths/~1donorStatements~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/donorStatements/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_521"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/donorStatements/{tenantId}/{id}","href":"donor-statements/patchdonorstatement","openApiOperationId":"patchDonorStatement","summary":"Partially updates a donor statement with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"schema_521","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor statement was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorStatement"}},"schemaId":"components/schemas/DonorStatement","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The donor statement could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The donor statement could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve donor statement based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorStatements~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DonorStatement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorStatement"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-statements/patchdonorstatement"}],"panels":[]}]},"httpPath":"/donorStatements/{tenantId}/{id}"},{"label":"Updates a donor statement with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statements/updatedonorstatement","routeSlug":"/apis/fundraising/fundraising-v1/donor-statements/updatedonorstatement","metadata":{"seo":{"title":"Updates a donor statement with the specified ID.","description":"This method will update an existing donor statement with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDonorStatement","name":"Updates a donor statement with the specified ID.","isWebhook":false,"pointer":"/paths/~1donorStatements~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a donor statement with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing donor statement with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the donor statement to update.","required":true}],"pointer":"/paths/~1donorStatements~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DonorStatement"}},"schemaId":"components/schemas/DonorStatement","pointer":"/paths/~1donorStatements~1{tenantId}~1{id}/put/requestBody","description":"The updated donor statement that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/donorStatements/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DonorStatement"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/donorStatements/{tenantId}/{id}","href":"donor-statements/updatedonorstatement","openApiOperationId":"updateDonorStatement","summary":"Updates a donor statement with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DonorStatement","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DonorStatement"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor statement was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorStatement"}},"schemaId":"components/schemas/DonorStatement","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The donor statement supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The donor statement could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The donor statement could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve donor statement based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donorStatements~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DonorStatement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonorStatement"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donor-statements/updatedonorstatement"}],"panels":[]}]},"httpPath":"/donorStatements/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Donor Statements"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Donor Statements","showPageActions":true},{"nodeType":"markdoc","content":"Donor Statements"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/donorStatements/{tenantId}","summary":"Creates a new donor statement record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/donor-statements/createdonorstatement","deprecated":false},{"title":"/donorStatements/{tenantId}/donor/{donor_type}/{donor_id}","summary":"Returns a list of records with the specified donor_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/donor-statements/liststatementsbydonorid","deprecated":false},{"title":"/donorStatements/{tenantId}/{id}","summary":"Returns a donor statement from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/donor-statements/deletedonorstatement","deprecated":false},{"title":"/donorStatements/{tenantId}/{id}","summary":"Returns a donor statement from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/donor-statements/getdonorstatement","deprecated":false},{"title":"/donorStatements/{tenantId}/{id}","summary":"Partially updates a donor statement with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/donor-statements/patchdonorstatement","deprecated":false},{"title":"/donorStatements/{tenantId}/{id}","summary":"Updates a donor statement with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/donor-statements/updatedonorstatement","deprecated":false}]}]}]}]}},{"type":"group","label":"Donors","link":"/apis/fundraising/fundraising-v1/donors","routeSlug":"/apis/fundraising/fundraising-v1/donors","items":[{"label":"Creates a new donor record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donors/createdonor","routeSlug":"/apis/fundraising/fundraising-v1/donors/createdonor","metadata":{"seo":{"title":"Creates a new donor record that does not already exist.","description":"This method will auto-generate an ID and create a new donor. If an ID is specified for the donor, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDonor","name":"Creates a new donor record that does not already exist.","isWebhook":false,"pointer":"/paths/~1donors~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new donor record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new donor. If an ID is specified for the donor, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1donors~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Donor"}},"schemaId":"components/schemas/Donor","pointer":"/paths/~1donors~1{tenantId}/post/requestBody","description":"The donor that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/donors/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Donor"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/donors/{tenantId}","href":"donors/createdonor","openApiOperationId":"createDonor","summary":"Creates a new donor record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Donor","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Donor"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Donor"}},"schemaId":"components/schemas/Donor","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The donor you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The donor could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add donor based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donors~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Donor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Donor"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donors/createdonor"}],"panels":[]}]},"httpPath":"/donors/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donors/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/donors/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1donors~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1donors~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1donors~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/donors/{tenantId}/batch","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/donors/{tenantId}/batch","href":"donors/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The donor could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve donor based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donors~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donors/executebatchoperations"}],"panels":[]}]},"httpPath":"/donors/{tenantId}/batch"},{"label":"Recalculate Totals/Donor Clubs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donors/recalculatedonortotals","routeSlug":"/apis/fundraising/fundraising-v1/donors/recalculatedonortotals","metadata":{"seo":{"title":"Recalculate Totals/Donor Clubs","description":"Goes through and recalculates all donor totals and automatic donor club assignments"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"recalculateDonorTotals","name":"Recalculate Totals/Donor Clubs","isWebhook":false,"pointer":"/paths/~1donors~1{tenantId}~1recalculateDonorTotals/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Recalculate Totals/Donor Clubs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Goes through and recalculates all donor totals and automatic donor club assignments"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true}],"pointer":"/paths/~1donors~1{tenantId}~1recalculateDonorTotals/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/donors/{tenantId}/recalculateDonorTotals","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/donors/{tenantId}/recalculateDonorTotals","href":"donors/recalculatedonortotals","openApiOperationId":"recalculateDonorTotals","summary":"Recalculate Totals/Donor Clubs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donors~1{tenantId}~1recalculateDonorTotals/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donors/recalculatedonortotals"}],"panels":[]}]},"httpPath":"/donors/{tenantId}/recalculateDonorTotals"},{"label":"Searches for donors using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donors/searchfordonors","routeSlug":"/apis/fundraising/fundraising-v1/donors/searchfordonors","metadata":{"seo":{"title":"Searches for donors using predefined parameters","description":"Searches for donors using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForDonors","name":"Searches for donors using predefined parameters","isWebhook":false,"pointer":"/paths/~1donors~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for donors using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for donors using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1donors~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_518","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1donors~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DonorSearchParameters"}},"schemaId":"components/schemas/DonorSearchParameters","pointer":"/paths/~1donors~1{tenantId}~1search/post/requestBody","description":"The donor that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/donors/{tenantId}/search","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DonorSearchParameters"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/donors/{tenantId}/search","href":"donors/searchfordonors","openApiOperationId":"searchForDonors","summary":"Searches for donors using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DonorSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DonorSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedDonorSearchResults"}},"schemaId":"components/schemas/PagedDonorSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The donor you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The donor could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add donor based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donors~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedDonorSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedDonorSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donors/searchfordonors"}],"panels":[]}]},"httpPath":"/donors/{tenantId}/search"},{"label":"Returns a donor from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donors/deletedonor","routeSlug":"/apis/fundraising/fundraising-v1/donors/deletedonor","metadata":{"seo":{"title":"Returns a donor from the system by its ID.","description":"This method will delete a donor with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDonor","name":"Returns a donor from the system by its ID.","isWebhook":false,"pointer":"/paths/~1donors~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a donor from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a donor with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the donor to delete.","required":true}],"pointer":"/paths/~1donors~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/donors/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/donors/{tenantId}/{id}","href":"donors/deletedonor","openApiOperationId":"deleteDonor","summary":"Returns a donor from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The donor could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The donor could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to delete donor based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donors~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donors/deletedonor"}],"panels":[]}]},"httpPath":"/donors/{tenantId}/{id}"},{"label":"Returns a donor from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donors/getdonor","routeSlug":"/apis/fundraising/fundraising-v1/donors/getdonor","metadata":{"seo":{"title":"Returns a donor from the system by its ID.","description":"This method will look up a donor by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDonor","name":"Returns a donor from the system by its ID.","isWebhook":false,"pointer":"/paths/~1donors~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a donor from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a donor by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the donor to return.","required":true}],"pointer":"/paths/~1donors~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_518","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1donors~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/donors/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/donors/{tenantId}/{id}","href":"donors/getdonor","openApiOperationId":"getDonor","summary":"Returns a donor from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Donor"}},"schemaId":"components/schemas/Donor","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The donor could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve donor based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donors~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Donor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Donor"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donors/getdonor"}],"panels":[]}]},"httpPath":"/donors/{tenantId}/{id}"},{"label":"Partially updates a donor with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donors/patchdonor","routeSlug":"/apis/fundraising/fundraising-v1/donors/patchdonor","metadata":{"seo":{"title":"Partially updates a donor with the specified ID.","description":"This method will patch an existing donor with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchDonor","name":"Partially updates a donor with the specified ID.","isWebhook":false,"pointer":"/paths/~1donors~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a donor with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing donor with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the donor to patch.","required":true}],"pointer":"/paths/~1donors~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"schemaId":"schema_521","pointer":"/paths/~1donors~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/donors/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_521"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/donors/{tenantId}/{id}","href":"donors/patchdonor","openApiOperationId":"patchDonor","summary":"Partially updates a donor with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"schema_521","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Donor"}},"schemaId":"components/schemas/Donor","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The donor could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The donor could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve donor based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donors~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Donor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Donor"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donors/patchdonor"}],"panels":[]}]},"httpPath":"/donors/{tenantId}/{id}"},{"label":"Updates a donor with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donors/updatedonor","routeSlug":"/apis/fundraising/fundraising-v1/donors/updatedonor","metadata":{"seo":{"title":"Updates a donor with the specified ID.","description":"This method will update an existing donor with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDonor","name":"Updates a donor with the specified ID.","isWebhook":false,"pointer":"/paths/~1donors~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a donor with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing donor with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the donor to update.","required":true}],"pointer":"/paths/~1donors~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Donor"}},"schemaId":"components/schemas/Donor","pointer":"/paths/~1donors~1{tenantId}~1{id}/put/requestBody","description":"The updated donor that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/donors/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Donor"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/donors/{tenantId}/{id}","href":"donors/updatedonor","openApiOperationId":"updateDonor","summary":"Updates a donor with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Donor","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Donor"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donor was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Donor"}},"schemaId":"components/schemas/Donor","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The donor supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The donor could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The donor could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve donor based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1donors~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Donor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Donor"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donors/updatedonor"}],"panels":[]}]},"httpPath":"/donors/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Donors"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Donors","showPageActions":true},{"nodeType":"markdoc","content":"Donors"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/donors/{tenantId}","summary":"Creates a new donor record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/donors/createdonor","deprecated":false},{"title":"/donors/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/donors/executebatchoperations","deprecated":false},{"title":"/donors/{tenantId}/recalculateDonorTotals","summary":"Recalculate Totals/Donor Clubs","prefix":{"name":"post","color":"post"},"badges":[],"link":"/donors/recalculatedonortotals","deprecated":false},{"title":"/donors/{tenantId}/search","summary":"Searches for donors using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/donors/searchfordonors","deprecated":false},{"title":"/donors/{tenantId}/{id}","summary":"Returns a donor from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/donors/deletedonor","deprecated":false},{"title":"/donors/{tenantId}/{id}","summary":"Returns a donor from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/donors/getdonor","deprecated":false},{"title":"/donors/{tenantId}/{id}","summary":"Partially updates a donor with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/donors/patchdonor","deprecated":false},{"title":"/donors/{tenantId}/{id}","summary":"Updates a donor with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/donors/updatedonor","deprecated":false}]}]}]}]}},{"type":"group","label":"Fund Categories","link":"/apis/fundraising/fundraising-v1/fund-categories","routeSlug":"/apis/fundraising/fundraising-v1/fund-categories","items":[{"label":"Gets all of the fund categories in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/fund-categories/listfundcategories","routeSlug":"/apis/fundraising/fundraising-v1/fund-categories/listfundcategories","metadata":{"seo":{"title":"Gets all of the fund categories in the system.","description":"This method will scan all fund categories and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFundCategories","name":"Gets all of the fund categories in the system.","isWebhook":false,"pointer":"/paths/~1fundCategories~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the fund categories in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all fund categories and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1fundCategories~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1fundCategories~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fundCategories/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/fundCategories/{tenantId}","href":"fund-categories/listfundcategories","openApiOperationId":"listFundCategories","summary":"Gets all of the fund categories in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fund categorieswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_526"}},"schemaId":"schema_526","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1fundCategories~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_526","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_526"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fund-categories/listfundcategories"}],"panels":[]}]},"httpPath":"/fundCategories/{tenantId}"},{"label":"Creates a new fund category record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/fund-categories/createfundcategory","routeSlug":"/apis/fundraising/fundraising-v1/fund-categories/createfundcategory","metadata":{"seo":{"title":"Creates a new fund category record that does not already exist.","description":"This method will auto-generate an ID and create a new fund category. If an ID is specified for the fund category, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFundCategory","name":"Creates a new fund category record that does not already exist.","isWebhook":false,"pointer":"/paths/~1fundCategories~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new fund category record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new fund category. If an ID is specified for the fund category, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1fundCategories~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FundCategory"}},"schemaId":"components/schemas/FundCategory","pointer":"/paths/~1fundCategories~1{tenantId}/post/requestBody","description":"The fund category that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fundCategories/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FundCategory"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/fundCategories/{tenantId}","href":"fund-categories/createfundcategory","openApiOperationId":"createFundCategory","summary":"Creates a new fund category record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/FundCategory","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FundCategory"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fund category was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FundCategory"}},"schemaId":"components/schemas/FundCategory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The fund category you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The fund category could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add fund category based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1fundCategories~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FundCategory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FundCategory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fund-categories/createfundcategory"}],"panels":[]}]},"httpPath":"/fundCategories/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/fund-categories/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/fund-categories/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1fundCategories~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1fundCategories~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1fundCategories~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fundCategories/{tenantId}/batch","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/fundCategories/{tenantId}/batch","href":"fund-categories/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The fund category could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve fund category based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1fundCategories~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fund-categories/executebatchoperations"}],"panels":[]}]},"httpPath":"/fundCategories/{tenantId}/batch"},{"label":"Returns a fund category from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/fund-categories/deletefundcategory","routeSlug":"/apis/fundraising/fundraising-v1/fund-categories/deletefundcategory","metadata":{"seo":{"title":"Returns a fund category from the system by its ID.","description":"This method will delete a fund category with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteFundCategory","name":"Returns a fund category from the system by its ID.","isWebhook":false,"pointer":"/paths/~1fundCategories~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a fund category from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a fund category with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the fund category to delete.","required":true}],"pointer":"/paths/~1fundCategories~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/fundCategories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/fundCategories/{tenantId}/{id}","href":"fund-categories/deletefundcategory","openApiOperationId":"deleteFundCategory","summary":"Returns a fund category from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fund category was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The fund category could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The fund category could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to delete fund category based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1fundCategories~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fund-categories/deletefundcategory"}],"panels":[]}]},"httpPath":"/fundCategories/{tenantId}/{id}"},{"label":"Returns a fund category from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/fund-categories/getfundcategory","routeSlug":"/apis/fundraising/fundraising-v1/fund-categories/getfundcategory","metadata":{"seo":{"title":"Returns a fund category from the system by its ID.","description":"This method will look up a fund category by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFundCategory","name":"Returns a fund category from the system by its ID.","isWebhook":false,"pointer":"/paths/~1fundCategories~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a fund category from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a fund category by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the fund category to return.","required":true}],"pointer":"/paths/~1fundCategories~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_518","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1fundCategories~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fundCategories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/fundCategories/{tenantId}/{id}","href":"fund-categories/getfundcategory","openApiOperationId":"getFundCategory","summary":"Returns a fund category from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fund category was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FundCategory"}},"schemaId":"components/schemas/FundCategory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The fund category could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve fund category based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1fundCategories~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FundCategory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FundCategory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fund-categories/getfundcategory"}],"panels":[]}]},"httpPath":"/fundCategories/{tenantId}/{id}"},{"label":"Partially updates a fund category with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/fund-categories/patchfundcategory","routeSlug":"/apis/fundraising/fundraising-v1/fund-categories/patchfundcategory","metadata":{"seo":{"title":"Partially updates a fund category with the specified ID.","description":"This method will patch an existing fund category with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchFundCategory","name":"Partially updates a fund category with the specified ID.","isWebhook":false,"pointer":"/paths/~1fundCategories~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a fund category with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing fund category with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the fund category to patch.","required":true}],"pointer":"/paths/~1fundCategories~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"schemaId":"schema_521","pointer":"/paths/~1fundCategories~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/fundCategories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_521"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/fundCategories/{tenantId}/{id}","href":"fund-categories/patchfundcategory","openApiOperationId":"patchFundCategory","summary":"Partially updates a fund category with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"schema_521","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fund category was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FundCategory"}},"schemaId":"components/schemas/FundCategory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The fund category could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The fund category could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve fund category based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1fundCategories~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FundCategory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FundCategory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fund-categories/patchfundcategory"}],"panels":[]}]},"httpPath":"/fundCategories/{tenantId}/{id}"},{"label":"Updates a fund category with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/fund-categories/updatefundcategory","routeSlug":"/apis/fundraising/fundraising-v1/fund-categories/updatefundcategory","metadata":{"seo":{"title":"Updates a fund category with the specified ID.","description":"This method will update an existing fund category with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateFundCategory","name":"Updates a fund category with the specified ID.","isWebhook":false,"pointer":"/paths/~1fundCategories~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a fund category with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing fund category with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the fund category to update.","required":true}],"pointer":"/paths/~1fundCategories~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FundCategory"}},"schemaId":"components/schemas/FundCategory","pointer":"/paths/~1fundCategories~1{tenantId}~1{id}/put/requestBody","description":"The updated fund category that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/fundCategories/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FundCategory"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/fundCategories/{tenantId}/{id}","href":"fund-categories/updatefundcategory","openApiOperationId":"updateFundCategory","summary":"Updates a fund category with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/FundCategory","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FundCategory"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fund category was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FundCategory"}},"schemaId":"components/schemas/FundCategory","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The fund category supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The fund category could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The fund category could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve fund category based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1fundCategories~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FundCategory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FundCategory"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fund-categories/updatefundcategory"}],"panels":[]}]},"httpPath":"/fundCategories/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Fund Categories"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fund Categories","showPageActions":true},{"nodeType":"markdoc","content":"Fund Categories"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/fundCategories/{tenantId}","summary":"Gets all of the fund categories in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fund-categories/listfundcategories","deprecated":false},{"title":"/fundCategories/{tenantId}","summary":"Creates a new fund category record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fund-categories/createfundcategory","deprecated":false},{"title":"/fundCategories/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fund-categories/executebatchoperations","deprecated":false},{"title":"/fundCategories/{tenantId}/{id}","summary":"Returns a fund category from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/fund-categories/deletefundcategory","deprecated":false},{"title":"/fundCategories/{tenantId}/{id}","summary":"Returns a fund category from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fund-categories/getfundcategory","deprecated":false},{"title":"/fundCategories/{tenantId}/{id}","summary":"Partially updates a fund category with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/fund-categories/patchfundcategory","deprecated":false},{"title":"/fundCategories/{tenantId}/{id}","summary":"Updates a fund category with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/fund-categories/updatefundcategory","deprecated":false}]}]}]}]}},{"type":"group","label":"Funds","link":"/apis/fundraising/fundraising-v1/funds","routeSlug":"/apis/fundraising/fundraising-v1/funds","items":[{"label":"Gets all of the funds in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/funds/listfunds","routeSlug":"/apis/fundraising/fundraising-v1/funds/listfunds","metadata":{"seo":{"title":"Gets all of the funds in the system.","description":"This method will scan all funds and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFunds","name":"Gets all of the funds in the system.","isWebhook":false,"pointer":"/paths/~1funds~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the funds in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all funds and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1funds~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1funds~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/funds/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/funds/{tenantId}","href":"funds/listfunds","openApiOperationId":"listFunds","summary":"Gets all of the funds in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fundswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}},"schemaId":"schema_527","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1funds~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_527","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_527"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/funds/listfunds"}],"panels":[]}]},"httpPath":"/funds/{tenantId}"},{"label":"Creates a new fund record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/funds/createfund","routeSlug":"/apis/fundraising/fundraising-v1/funds/createfund","metadata":{"seo":{"title":"Creates a new fund record that does not already exist.","description":"This method will auto-generate an ID and create a new fund. If an ID is specified for the fund, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFund","name":"Creates a new fund record that does not already exist.","isWebhook":false,"pointer":"/paths/~1funds~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new fund record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new fund. If an ID is specified for the fund, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1funds~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Fund"}},"schemaId":"components/schemas/Fund","pointer":"/paths/~1funds~1{tenantId}/post/requestBody","description":"The fund that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/funds/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Fund"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/funds/{tenantId}","href":"funds/createfund","openApiOperationId":"createFund","summary":"Creates a new fund record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Fund","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Fund"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fund was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fund"}},"schemaId":"components/schemas/Fund","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The fund you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The fund could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add fund based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1funds~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Fund","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fund"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/funds/createfund"}],"panels":[]}]},"httpPath":"/funds/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/funds/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/funds/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1funds~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1funds~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1funds~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/funds/{tenantId}/batch","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/funds/{tenantId}/batch","href":"funds/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The fund could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve fund based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1funds~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/funds/executebatchoperations"}],"panels":[]}]},"httpPath":"/funds/{tenantId}/batch"},{"label":"Returns a fund from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/funds/deletefund","routeSlug":"/apis/fundraising/fundraising-v1/funds/deletefund","metadata":{"seo":{"title":"Returns a fund from the system by its ID.","description":"This method will delete a fund with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteFund","name":"Returns a fund from the system by its ID.","isWebhook":false,"pointer":"/paths/~1funds~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a fund from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a fund with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the fund to delete.","required":true}],"pointer":"/paths/~1funds~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/funds/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/funds/{tenantId}/{id}","href":"funds/deletefund","openApiOperationId":"deleteFund","summary":"Returns a fund from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fund was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The fund could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The fund could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to delete fund based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1funds~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/funds/deletefund"}],"panels":[]}]},"httpPath":"/funds/{tenantId}/{id}"},{"label":"Returns a fund from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/funds/getfund","routeSlug":"/apis/fundraising/fundraising-v1/funds/getfund","metadata":{"seo":{"title":"Returns a fund from the system by its ID.","description":"This method will look up a fund by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFund","name":"Returns a fund from the system by its ID.","isWebhook":false,"pointer":"/paths/~1funds~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a fund from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a fund by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the fund to return.","required":true}],"pointer":"/paths/~1funds~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_518","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1funds~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/funds/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/funds/{tenantId}/{id}","href":"funds/getfund","openApiOperationId":"getFund","summary":"Returns a fund from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fund was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fund"}},"schemaId":"components/schemas/Fund","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The fund could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve fund based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1funds~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Fund","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fund"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/funds/getfund"}],"panels":[]}]},"httpPath":"/funds/{tenantId}/{id}"},{"label":"Partially updates a fund with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/funds/patchfund","routeSlug":"/apis/fundraising/fundraising-v1/funds/patchfund","metadata":{"seo":{"title":"Partially updates a fund with the specified ID.","description":"This method will patch an existing fund with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchFund","name":"Partially updates a fund with the specified ID.","isWebhook":false,"pointer":"/paths/~1funds~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a fund with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing fund with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the fund to patch.","required":true}],"pointer":"/paths/~1funds~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"schemaId":"schema_521","pointer":"/paths/~1funds~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/funds/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_521"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/funds/{tenantId}/{id}","href":"funds/patchfund","openApiOperationId":"patchFund","summary":"Partially updates a fund with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"schema_521","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fund was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fund"}},"schemaId":"components/schemas/Fund","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The fund could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The fund could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve fund based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1funds~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Fund","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fund"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/funds/patchfund"}],"panels":[]}]},"httpPath":"/funds/{tenantId}/{id}"},{"label":"Updates a fund with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/funds/updatefund","routeSlug":"/apis/fundraising/fundraising-v1/funds/updatefund","metadata":{"seo":{"title":"Updates a fund with the specified ID.","description":"This method will update an existing fund with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateFund","name":"Updates a fund with the specified ID.","isWebhook":false,"pointer":"/paths/~1funds~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a fund with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing fund with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the fund to update.","required":true}],"pointer":"/paths/~1funds~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Fund"}},"schemaId":"components/schemas/Fund","pointer":"/paths/~1funds~1{tenantId}~1{id}/put/requestBody","description":"The updated fund that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/funds/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Fund"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/funds/{tenantId}/{id}","href":"funds/updatefund","openApiOperationId":"updateFund","summary":"Updates a fund with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Fund","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Fund"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fund was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fund"}},"schemaId":"components/schemas/Fund","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The fund supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The fund could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The fund could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve fund based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1funds~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Fund","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Fund"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/funds/updatefund"}],"panels":[]}]},"httpPath":"/funds/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Funds"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Funds","showPageActions":true},{"nodeType":"markdoc","content":"Funds"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/funds/{tenantId}","summary":"Gets all of the funds in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/funds/listfunds","deprecated":false},{"title":"/funds/{tenantId}","summary":"Creates a new fund record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/funds/createfund","deprecated":false},{"title":"/funds/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/funds/executebatchoperations","deprecated":false},{"title":"/funds/{tenantId}/{id}","summary":"Returns a fund from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/funds/deletefund","deprecated":false},{"title":"/funds/{tenantId}/{id}","summary":"Returns a fund from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/funds/getfund","deprecated":false},{"title":"/funds/{tenantId}/{id}","summary":"Partially updates a fund with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/funds/patchfund","deprecated":false},{"title":"/funds/{tenantId}/{id}","summary":"Updates a fund with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/funds/updatefund","deprecated":false}]}]}]}]}},{"type":"group","label":"Gift Notices","link":"/apis/fundraising/fundraising-v1/gift-notices","routeSlug":"/apis/fundraising/fundraising-v1/gift-notices","items":[{"label":"Gets all of the gift notices in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gift-notices/listgiftnotices","routeSlug":"/apis/fundraising/fundraising-v1/gift-notices/listgiftnotices","metadata":{"seo":{"title":"Gets all of the gift notices in the system.","description":"This method will scan all gift notices and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGiftNotices","name":"Gets all of the gift notices in the system.","isWebhook":false,"pointer":"/paths/~1giftNotices~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the gift notices in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all gift notices and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1giftNotices~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1giftNotices~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/giftNotices/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/giftNotices/{tenantId}","href":"gift-notices/listgiftnotices","openApiOperationId":"listGiftNotices","summary":"Gets all of the gift notices in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The gift noticeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528"}},"schemaId":"schema_528","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1giftNotices~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_528","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gift-notices/listgiftnotices"}],"panels":[]}]},"httpPath":"/giftNotices/{tenantId}"},{"label":"Creates a new gift notice record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gift-notices/creategiftnotice","routeSlug":"/apis/fundraising/fundraising-v1/gift-notices/creategiftnotice","metadata":{"seo":{"title":"Creates a new gift notice record that does not already exist.","description":"This method will auto-generate an ID and create a new gift notice. If an ID is specified for the gift notice, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createGiftNotice","name":"Creates a new gift notice record that does not already exist.","isWebhook":false,"pointer":"/paths/~1giftNotices~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new gift notice record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new gift notice. If an ID is specified for the gift notice, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1giftNotices~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GiftNotice"}},"schemaId":"components/schemas/GiftNotice","pointer":"/paths/~1giftNotices~1{tenantId}/post/requestBody","description":"The gift notice that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/giftNotices/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GiftNotice"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/giftNotices/{tenantId}","href":"gift-notices/creategiftnotice","openApiOperationId":"createGiftNotice","summary":"Creates a new gift notice record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/GiftNotice","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GiftNotice"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The gift notice was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GiftNotice"}},"schemaId":"components/schemas/GiftNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The gift notice you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The gift notice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add gift notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1giftNotices~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GiftNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GiftNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gift-notices/creategiftnotice"}],"panels":[]}]},"httpPath":"/giftNotices/{tenantId}"},{"label":"Returns a gift notice from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gift-notices/deletegiftnotice","routeSlug":"/apis/fundraising/fundraising-v1/gift-notices/deletegiftnotice","metadata":{"seo":{"title":"Returns a gift notice from the system by its ID.","description":"This method will delete a gift notice with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteGiftNotice","name":"Returns a gift notice from the system by its ID.","isWebhook":false,"pointer":"/paths/~1giftNotices~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a gift notice from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a gift notice with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the gift notice to delete.","required":true}],"pointer":"/paths/~1giftNotices~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/giftNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/giftNotices/{tenantId}/{id}","href":"gift-notices/deletegiftnotice","openApiOperationId":"deleteGiftNotice","summary":"Returns a gift notice from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The gift notice was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The gift notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The gift notice could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to delete gift notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1giftNotices~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gift-notices/deletegiftnotice"}],"panels":[]}]},"httpPath":"/giftNotices/{tenantId}/{id}"},{"label":"Returns a gift notice from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gift-notices/getgiftnotice","routeSlug":"/apis/fundraising/fundraising-v1/gift-notices/getgiftnotice","metadata":{"seo":{"title":"Returns a gift notice from the system by its ID.","description":"This method will look up a gift notice by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGiftNotice","name":"Returns a gift notice from the system by its ID.","isWebhook":false,"pointer":"/paths/~1giftNotices~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a gift notice from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a gift notice by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the gift notice to return.","required":true}],"pointer":"/paths/~1giftNotices~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_518","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1giftNotices~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/giftNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/giftNotices/{tenantId}/{id}","href":"gift-notices/getgiftnotice","openApiOperationId":"getGiftNotice","summary":"Returns a gift notice from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The gift notice was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GiftNotice"}},"schemaId":"components/schemas/GiftNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The gift notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve gift notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1giftNotices~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GiftNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GiftNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gift-notices/getgiftnotice"}],"panels":[]}]},"httpPath":"/giftNotices/{tenantId}/{id}"},{"label":"Partially updates a gift notice with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gift-notices/patchgiftnotice","routeSlug":"/apis/fundraising/fundraising-v1/gift-notices/patchgiftnotice","metadata":{"seo":{"title":"Partially updates a gift notice with the specified ID.","description":"This method will patch an existing gift notice with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchGiftNotice","name":"Partially updates a gift notice with the specified ID.","isWebhook":false,"pointer":"/paths/~1giftNotices~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a gift notice with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing gift notice with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the gift notice to patch.","required":true}],"pointer":"/paths/~1giftNotices~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"schemaId":"schema_521","pointer":"/paths/~1giftNotices~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/giftNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_521"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/giftNotices/{tenantId}/{id}","href":"gift-notices/patchgiftnotice","openApiOperationId":"patchGiftNotice","summary":"Partially updates a gift notice with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"schema_521","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The gift notice was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GiftNotice"}},"schemaId":"components/schemas/GiftNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The gift notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The gift notice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve gift notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1giftNotices~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GiftNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GiftNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gift-notices/patchgiftnotice"}],"panels":[]}]},"httpPath":"/giftNotices/{tenantId}/{id}"},{"label":"Updates a gift notice with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gift-notices/updategiftnotice","routeSlug":"/apis/fundraising/fundraising-v1/gift-notices/updategiftnotice","metadata":{"seo":{"title":"Updates a gift notice with the specified ID.","description":"This method will update an existing gift notice with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateGiftNotice","name":"Updates a gift notice with the specified ID.","isWebhook":false,"pointer":"/paths/~1giftNotices~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a gift notice with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing gift notice with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the gift notice to update.","required":true}],"pointer":"/paths/~1giftNotices~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GiftNotice"}},"schemaId":"components/schemas/GiftNotice","pointer":"/paths/~1giftNotices~1{tenantId}~1{id}/put/requestBody","description":"The updated gift notice that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/giftNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GiftNotice"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/giftNotices/{tenantId}/{id}","href":"gift-notices/updategiftnotice","openApiOperationId":"updateGiftNotice","summary":"Updates a gift notice with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/GiftNotice","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GiftNotice"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The gift notice was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GiftNotice"}},"schemaId":"components/schemas/GiftNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The gift notice supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The gift notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The gift notice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve gift notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1giftNotices~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GiftNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GiftNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gift-notices/updategiftnotice"}],"panels":[]}]},"httpPath":"/giftNotices/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Gift Notices"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gift Notices","showPageActions":true},{"nodeType":"markdoc","content":"Gift Notices"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/giftNotices/{tenantId}","summary":"Gets all of the gift notices in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gift-notices/listgiftnotices","deprecated":false},{"title":"/giftNotices/{tenantId}","summary":"Creates a new gift notice record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gift-notices/creategiftnotice","deprecated":false},{"title":"/giftNotices/{tenantId}/{id}","summary":"Returns a gift notice from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/gift-notices/deletegiftnotice","deprecated":false},{"title":"/giftNotices/{tenantId}/{id}","summary":"Returns a gift notice from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gift-notices/getgiftnotice","deprecated":false},{"title":"/giftNotices/{tenantId}/{id}","summary":"Partially updates a gift notice with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/gift-notices/patchgiftnotice","deprecated":false},{"title":"/giftNotices/{tenantId}/{id}","summary":"Updates a gift notice with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/gift-notices/updategiftnotice","deprecated":false}]}]}]}]}},{"type":"group","label":"Gifts","link":"/apis/fundraising/fundraising-v1/gifts","routeSlug":"/apis/fundraising/fundraising-v1/gifts","items":[{"label":"Gets all of the gifts in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/listgifts","routeSlug":"/apis/fundraising/fundraising-v1/gifts/listgifts","metadata":{"seo":{"title":"Gets all of the gifts in the system.","description":"This method will scan all gifts and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGifts","name":"Gets all of the gifts in the system.","isWebhook":false,"pointer":"/paths/~1gifts~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the gifts in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all gifts and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1gifts~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1gifts~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/gifts/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/gifts/{tenantId}","href":"gifts/listgifts","openApiOperationId":"listGifts","summary":"Gets all of the gifts in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The giftswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_529"}},"schemaId":"schema_529","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1gifts~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_529","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_529"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/listgifts"}],"panels":[]}]},"httpPath":"/gifts/{tenantId}"},{"label":"Creates a new gift record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/creategift","routeSlug":"/apis/fundraising/fundraising-v1/gifts/creategift","metadata":{"seo":{"title":"Creates a new gift record that does not already exist.","description":"This method will auto-generate an ID and create a new gift. If an ID is specified for the gift, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createGift","name":"Creates a new gift record that does not already exist.","isWebhook":false,"pointer":"/paths/~1gifts~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new gift record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new gift. If an ID is specified for the gift, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1gifts~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Gift"}},"schemaId":"components/schemas/Gift","pointer":"/paths/~1gifts~1{tenantId}/post/requestBody","description":"The gift that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/gifts/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Gift"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/gifts/{tenantId}","href":"gifts/creategift","openApiOperationId":"createGift","summary":"Creates a new gift record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Gift","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Gift"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The gift was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Gift"}},"schemaId":"components/schemas/Gift","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The gift you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The gift could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add gift based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1gifts~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Gift","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Gift"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/creategift"}],"panels":[]}]},"httpPath":"/gifts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/gifts/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1gifts~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1gifts~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1gifts~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/gifts/{tenantId}/batch","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/gifts/{tenantId}/batch","href":"gifts/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The gift could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve gift based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1gifts~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/executebatchoperations"}],"panels":[]}]},"httpPath":"/gifts/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/listgiftsbycontactid","routeSlug":"/apis/fundraising/fundraising-v1/gifts/listgiftsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGiftsByContactId","name":"Returns a list of records with the specified contact_id","isWebhook":false,"pointer":"/paths/~1gifts~1{tenantId}~1contact~1{contact_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified contact_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified contact_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true},{"name":"contact_id","in":"path","schemaId":"schema_518","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1gifts~1{tenantId}~1contact~1{contact_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1gifts~1{tenantId}~1contact~1{contact_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/gifts/{tenantId}/contact/{contact_id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"contact_id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/gifts/{tenantId}/contact/{contact_id}","href":"gifts/listgiftsbycontactid","openApiOperationId":"listGiftsByContactId","summary":"Returns a list of records with the specified contact_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListGiftsResponse"}},"schemaId":"components/schemas/ListGiftsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1gifts~1{tenantId}~1contact~1{contact_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListGiftsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListGiftsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/listgiftsbycontactid"}],"panels":[]}]},"httpPath":"/gifts/{tenantId}/contact/{contact_id}"},{"label":"Returns a list of records with the specified donor_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/listgiftsbydonorid","routeSlug":"/apis/fundraising/fundraising-v1/gifts/listgiftsbydonorid","metadata":{"seo":{"title":"Returns a list of records with the specified donor_id","description":"Returns a list of records with the specified donor_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGiftsByDonorId","name":"Returns a list of records with the specified donor_id","isWebhook":false,"pointer":"/paths/~1gifts~1{tenantId}~1donor~1{donor_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified donor_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified donor_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true},{"name":"donor_id","in":"path","schemaId":"schema_518","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The donor_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1gifts~1{tenantId}~1donor~1{donor_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1gifts~1{tenantId}~1donor~1{donor_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/gifts/{tenantId}/donor/{donor_id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"donor_id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/gifts/{tenantId}/donor/{donor_id}","href":"gifts/listgiftsbydonorid","openApiOperationId":"listGiftsByDonorId","summary":"Returns a list of records with the specified donor_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListGiftsResponse"}},"schemaId":"components/schemas/ListGiftsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1gifts~1{tenantId}~1donor~1{donor_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListGiftsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListGiftsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/listgiftsbydonorid"}],"panels":[]}]},"httpPath":"/gifts/{tenantId}/donor/{donor_id}"},{"label":"Generates an order from a fundraising gift","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/generateorder","routeSlug":"/apis/fundraising/fundraising-v1/gifts/generateorder","metadata":{"seo":{"title":"Generates an order from a fundraising gift","description":"This method will examine a fundraising gift and generate an appropriate order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateOrder","name":"Generates an order from a fundraising gift","isWebhook":false,"pointer":"/paths/~1gifts~1{tenantId}~1generateOrder/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generates an order from a fundraising gift","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will examine a fundraising gift and generate an appropriate order"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1gifts~1{tenantId}~1generateOrder/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GiftPayload"}},"schemaId":"components/schemas/GiftPayload","pointer":"/paths/~1gifts~1{tenantId}~1generateOrder/post/requestBody","description":"The gift to generate an order"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/gifts/{tenantId}/generateOrder","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GiftPayload"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/gifts/{tenantId}/generateOrder","href":"gifts/generateorder","openApiOperationId":"generateOrder","summary":"Generates an order from a fundraising gift"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/GiftPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GiftPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conflicts were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_530"}},"schemaId":"schema_530","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1gifts~1{tenantId}~1generateOrder/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_530","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_530"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/generateorder"}],"panels":[]}]},"httpPath":"/gifts/{tenantId}/generateOrder"},{"label":"Returns a list of records with the specified master_gift_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/listgiftsbymastergiftid","routeSlug":"/apis/fundraising/fundraising-v1/gifts/listgiftsbymastergiftid","metadata":{"seo":{"title":"Returns a list of records with the specified master_gift_id","description":"Returns a list of records with the specified master_gift_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGiftsByMasterGiftId","name":"Returns a list of records with the specified master_gift_id","isWebhook":false,"pointer":"/paths/~1gifts~1{tenantId}~1masterGift~1{master_gift_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified master_gift_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified master_gift_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true},{"name":"master_gift_id","in":"path","schemaId":"schema_518","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The master_gift_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1gifts~1{tenantId}~1masterGift~1{master_gift_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1gifts~1{tenantId}~1masterGift~1{master_gift_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/gifts/{tenantId}/masterGift/{master_gift_id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"master_gift_id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/gifts/{tenantId}/masterGift/{master_gift_id}","href":"gifts/listgiftsbymastergiftid","openApiOperationId":"listGiftsByMasterGiftId","summary":"Returns a list of records with the specified master_gift_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListGiftsResponse"}},"schemaId":"components/schemas/ListGiftsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1gifts~1{tenantId}~1masterGift~1{master_gift_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListGiftsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListGiftsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/listgiftsbymastergiftid"}],"panels":[]}]},"httpPath":"/gifts/{tenantId}/masterGift/{master_gift_id}"},{"label":"Migrate Donation Orders","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/migratedonations","routeSlug":"/apis/fundraising/fundraising-v1/gifts/migratedonations","metadata":{"seo":{"title":"Migrate Donation Orders","description":"Will migrate all previous orders for donation products"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"migrateDonations","name":"Migrate Donation Orders","isWebhook":false,"pointer":"/paths/~1gifts~1{tenantId}~1migrateDonationOrders/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Migrate Donation Orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Will migrate all previous orders for donation products"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1gifts~1{tenantId}~1migrateDonationOrders/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/gifts/{tenantId}/migrateDonationOrders","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/gifts/{tenantId}/migrateDonationOrders","href":"gifts/migratedonations","openApiOperationId":"migrateDonations","summary":"Migrate Donation Orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conflicts were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_530"}},"schemaId":"schema_530","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1gifts~1{tenantId}~1migrateDonationOrders/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_530","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_530"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/migratedonations"}],"panels":[]}]},"httpPath":"/gifts/{tenantId}/migrateDonationOrders"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/listgiftsbyorderid","routeSlug":"/apis/fundraising/fundraising-v1/gifts/listgiftsbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGiftsByOrderId","name":"Returns a list of records with the specified order_id","isWebhook":false,"pointer":"/paths/~1gifts~1{tenantId}~1order~1{order_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified order_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified order_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true},{"name":"order_id","in":"path","schemaId":"schema_518","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1gifts~1{tenantId}~1order~1{order_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1gifts~1{tenantId}~1order~1{order_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/gifts/{tenantId}/order/{order_id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"order_id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/gifts/{tenantId}/order/{order_id}","href":"gifts/listgiftsbyorderid","openApiOperationId":"listGiftsByOrderId","summary":"Returns a list of records with the specified order_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListGiftsResponse"}},"schemaId":"components/schemas/ListGiftsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1gifts~1{tenantId}~1order~1{order_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListGiftsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListGiftsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/listgiftsbyorderid"}],"panels":[]}]},"httpPath":"/gifts/{tenantId}/order/{order_id}"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/listgiftsbyorganizationid","routeSlug":"/apis/fundraising/fundraising-v1/gifts/listgiftsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGiftsByOrganizationId","name":"Returns a list of records with the specified organization_id","isWebhook":false,"pointer":"/paths/~1gifts~1{tenantId}~1organization~1{organization_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified organization_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified organization_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true},{"name":"organization_id","in":"path","schemaId":"schema_518","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1gifts~1{tenantId}~1organization~1{organization_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1gifts~1{tenantId}~1organization~1{organization_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/gifts/{tenantId}/organization/{organization_id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"organization_id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/gifts/{tenantId}/organization/{organization_id}","href":"gifts/listgiftsbyorganizationid","openApiOperationId":"listGiftsByOrganizationId","summary":"Returns a list of records with the specified organization_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListGiftsResponse"}},"schemaId":"components/schemas/ListGiftsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1gifts~1{tenantId}~1organization~1{organization_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListGiftsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListGiftsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/listgiftsbyorganizationid"}],"panels":[]}]},"httpPath":"/gifts/{tenantId}/organization/{organization_id}"},{"label":"Returns a list of records with the specified pledge_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/listgiftsbypledgeid","routeSlug":"/apis/fundraising/fundraising-v1/gifts/listgiftsbypledgeid","metadata":{"seo":{"title":"Returns a list of records with the specified pledge_id","description":"Returns a list of records with the specified pledge_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGiftsByPledgeId","name":"Returns a list of records with the specified pledge_id","isWebhook":false,"pointer":"/paths/~1gifts~1{tenantId}~1pledge~1{pledge_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified pledge_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified pledge_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true},{"name":"pledge_id","in":"path","schemaId":"schema_518","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The pledge_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1gifts~1{tenantId}~1pledge~1{pledge_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1gifts~1{tenantId}~1pledge~1{pledge_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/gifts/{tenantId}/pledge/{pledge_id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"pledge_id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/gifts/{tenantId}/pledge/{pledge_id}","href":"gifts/listgiftsbypledgeid","openApiOperationId":"listGiftsByPledgeId","summary":"Returns a list of records with the specified pledge_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListGiftsResponse"}},"schemaId":"components/schemas/ListGiftsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1gifts~1{tenantId}~1pledge~1{pledge_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListGiftsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListGiftsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/listgiftsbypledgeid"}],"panels":[]}]},"httpPath":"/gifts/{tenantId}/pledge/{pledge_id}"},{"label":"Preview Gift Receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/previewreceipt","routeSlug":"/apis/fundraising/fundraising-v1/gifts/previewreceipt","metadata":{"seo":{"title":"Preview Gift Receipt","description":"Sends out a preview of the gift receipt email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewReceipt","name":"Preview Gift Receipt","isWebhook":false,"pointer":"/paths/~1gifts~1{tenantId}~1previewReceipt/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preview Gift Receipt","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the gift receipt email"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true}],"pointer":"/paths/~1gifts~1{tenantId}~1previewReceipt/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewReceiptRequest"}},"schemaId":"components/schemas/PreviewReceiptRequest","pointer":"/paths/~1gifts~1{tenantId}~1previewReceipt/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/gifts/{tenantId}/previewReceipt","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewReceiptRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/gifts/{tenantId}/previewReceipt","href":"gifts/previewreceipt","openApiOperationId":"previewReceipt","summary":"Preview Gift Receipt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewReceiptRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewReceiptRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1gifts~1{tenantId}~1previewReceipt/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/previewreceipt"}],"panels":[]}]},"httpPath":"/gifts/{tenantId}/previewReceipt"},{"label":"Resend Receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/processgift","routeSlug":"/apis/fundraising/fundraising-v1/gifts/processgift","metadata":{"seo":{"title":"Resend Receipt","description":"Resends the gift receipt"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processGift","name":"Resend Receipt","isWebhook":false,"pointer":"/paths/~1gifts~1{tenantId}~1process/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend Receipt","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Resends the gift receipt"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true}],"pointer":"/paths/~1gifts~1{tenantId}~1process/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProcessGiftInfo"}},"schemaId":"components/schemas/ProcessGiftInfo","pointer":"/paths/~1gifts~1{tenantId}~1process/post/requestBody","description":"Payload for the gift"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/gifts/{tenantId}/process","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProcessGiftInfo"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/gifts/{tenantId}/process","href":"gifts/processgift","openApiOperationId":"processGift","summary":"Resend Receipt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ProcessGiftInfo","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProcessGiftInfo"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1gifts~1{tenantId}~1process/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/processgift"}],"panels":[]}]},"httpPath":"/gifts/{tenantId}/process"},{"label":"Get Public Giving Form Manifest","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/getpublicgivingformmanifest","routeSlug":"/apis/fundraising/fundraising-v1/gifts/getpublicgivingformmanifest","metadata":{"seo":{"title":"Get Public Giving Form Manifest","description":"Public API Endpoint that gets information used to populate the giving form"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPublicGivingFormManifest","name":"Get Public Giving Form Manifest","isWebhook":false,"pointer":"/paths/~1gifts~1{tenantId}~1public~1givingFormManifest/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Public Giving Form Manifest","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Public API Endpoint that gets information used to populate the giving form"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true}],"pointer":"/paths/~1gifts~1{tenantId}~1public~1givingFormManifest/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"givingProcessId","in":"query","schemaId":"schema_518"},{"name":"campaignId","in":"query","schemaId":"schema_518"},{"name":"appealId","in":"query","schemaId":"schema_518"}],"pointer":"/paths/~1gifts~1{tenantId}~1public~1givingFormManifest/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/gifts/{tenantId}/public/givingFormManifest","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"givingProcessId","in":"query","required":false,"schemaId":"schema_518"},{"name":"campaignId","in":"query","required":false,"schemaId":"schema_518"},{"name":"appealId","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/gifts/{tenantId}/public/givingFormManifest","href":"gifts/getpublicgivingformmanifest","openApiOperationId":"getPublicGivingFormManifest","summary":"Get Public Giving Form Manifest"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1gifts~1{tenantId}~1public~1givingFormManifest/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/getpublicgivingformmanifest"}],"panels":[]}]},"httpPath":"/gifts/{tenantId}/public/givingFormManifest"},{"label":"Resend Receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/processgiftpublicly","routeSlug":"/apis/fundraising/fundraising-v1/gifts/processgiftpublicly","metadata":{"seo":{"title":"Resend Receipt","description":"Resends the gift receipt"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processGiftPublicly","name":"Resend Receipt","isWebhook":false,"pointer":"/paths/~1gifts~1{tenantId}~1public~1process/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend Receipt","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Resends the gift receipt"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true}],"pointer":"/paths/~1gifts~1{tenantId}~1public~1process/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"x-aws-waf-token","in":"header","schemaId":"schema_518","description":"AWS WAF Captcha Token that is issues as a part of the WAF validation flow for protected public endpoints"}],"pointer":"/paths/~1gifts~1{tenantId}~1public~1process/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProcessGiftInfo"}},"schemaId":"components/schemas/ProcessGiftInfo","pointer":"/paths/~1gifts~1{tenantId}~1public~1process/post/requestBody","description":"Payload for the gift"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/gifts/{tenantId}/public/process","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[{"name":"x-aws-waf-token","in":"header","required":false,"schemaId":"schema_518"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ProcessGiftInfo"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/gifts/{tenantId}/public/process","href":"gifts/processgiftpublicly","openApiOperationId":"processGiftPublicly","summary":"Resend Receipt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ProcessGiftInfo","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProcessGiftInfo"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1gifts~1{tenantId}~1public~1process/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/processgiftpublicly"}],"panels":[]}]},"httpPath":"/gifts/{tenantId}/public/process"},{"label":"Returns a list of records with the specified recurring_gift_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/listgiftsbyrecurringgiftid","routeSlug":"/apis/fundraising/fundraising-v1/gifts/listgiftsbyrecurringgiftid","metadata":{"seo":{"title":"Returns a list of records with the specified recurring_gift_id","description":"Returns a list of records with the specified recurring_gift_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGiftsByRecurringGiftId","name":"Returns a list of records with the specified recurring_gift_id","isWebhook":false,"pointer":"/paths/~1gifts~1{tenantId}~1recurringGift~1{recurring_gift_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified recurring_gift_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified recurring_gift_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true},{"name":"recurring_gift_id","in":"path","schemaId":"schema_518","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recurring_gift_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1gifts~1{tenantId}~1recurringGift~1{recurring_gift_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1gifts~1{tenantId}~1recurringGift~1{recurring_gift_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/gifts/{tenantId}/recurringGift/{recurring_gift_id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"recurring_gift_id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/gifts/{tenantId}/recurringGift/{recurring_gift_id}","href":"gifts/listgiftsbyrecurringgiftid","openApiOperationId":"listGiftsByRecurringGiftId","summary":"Returns a list of records with the specified recurring_gift_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListGiftsResponse"}},"schemaId":"components/schemas/ListGiftsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1gifts~1{tenantId}~1recurringGift~1{recurring_gift_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListGiftsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListGiftsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/listgiftsbyrecurringgiftid"}],"panels":[]}]},"httpPath":"/gifts/{tenantId}/recurringGift/{recurring_gift_id}"},{"label":"Resend Receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/resendreceipt","routeSlug":"/apis/fundraising/fundraising-v1/gifts/resendreceipt","metadata":{"seo":{"title":"Resend Receipt","description":"Resends the gift receipt"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"resendReceipt","name":"Resend Receipt","isWebhook":false,"pointer":"/paths/~1gifts~1{tenantId}~1resendReceipt~1{id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend Receipt","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Resends the gift receipt"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the gift","required":true}],"pointer":"/paths/~1gifts~1{tenantId}~1resendReceipt~1{id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/gifts/{tenantId}/resendReceipt/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/gifts/{tenantId}/resendReceipt/{id}","href":"gifts/resendreceipt","openApiOperationId":"resendReceipt","summary":"Resend Receipt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1gifts~1{tenantId}~1resendReceipt~1{id}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/resendreceipt"}],"panels":[]}]},"httpPath":"/gifts/{tenantId}/resendReceipt/{id}"},{"label":"Searches for gifts using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/searchforgifts","routeSlug":"/apis/fundraising/fundraising-v1/gifts/searchforgifts","metadata":{"seo":{"title":"Searches for gifts using predefined parameters","description":"Searches for gifts using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForGifts","name":"Searches for gifts using predefined parameters","isWebhook":false,"pointer":"/paths/~1gifts~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for gifts using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for gifts using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1gifts~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_518","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1gifts~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GiftSearchParameters"}},"schemaId":"components/schemas/GiftSearchParameters","pointer":"/paths/~1gifts~1{tenantId}~1search/post/requestBody","description":"The gift that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/gifts/{tenantId}/search","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GiftSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/gifts/{tenantId}/search","href":"gifts/searchforgifts","openApiOperationId":"searchForGifts","summary":"Searches for gifts using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/GiftSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GiftSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The gift search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedGiftSearchResults"}},"schemaId":"components/schemas/PagedGiftSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The gift you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The gift could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add gift based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1gifts~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedGiftSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedGiftSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/searchforgifts"}],"panels":[]}]},"httpPath":"/gifts/{tenantId}/search"},{"label":"List Donor Soft Credits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/getsoftcreditsfordonor","routeSlug":"/apis/fundraising/fundraising-v1/gifts/getsoftcreditsfordonor","metadata":{"seo":{"title":"List Donor Soft Credits","description":"Lists all the soft credits for a donor"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSoftCreditsForDonor","name":"List Donor Soft Credits","isWebhook":false,"pointer":"/paths/~1gifts~1{tenantId}~1softCredits~1{donorId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Donor Soft Credits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all the soft credits for a donor"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"donorId","in":"path","schemaId":"schema_518","description":"The contact id","required":true}],"pointer":"/paths/~1gifts~1{tenantId}~1softCredits~1{donorId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"The contact id"}],"pointer":"/paths/~1gifts~1{tenantId}~1softCredits~1{donorId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/gifts/{tenantId}/softCredits/{donorId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"donorId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/gifts/{tenantId}/softCredits/{donorId}","href":"gifts/getsoftcreditsfordonor","openApiOperationId":"getSoftCreditsForDonor","summary":"List Donor Soft Credits"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The soft credits was retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Gift"}},"schemaId":"components/schemas/Gift","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The members supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The members could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Request limit exceeded... please try your request again in a few seconds","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1gifts~1{tenantId}~1softCredits~1{donorId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Gift","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Gift"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/getsoftcreditsfordonor"}],"panels":[]}]},"httpPath":"/gifts/{tenantId}/softCredits/{donorId}"},{"label":"Returns a gift from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/deletegift","routeSlug":"/apis/fundraising/fundraising-v1/gifts/deletegift","metadata":{"seo":{"title":"Returns a gift from the system by its ID.","description":"This method will delete a gift with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteGift","name":"Returns a gift from the system by its ID.","isWebhook":false,"pointer":"/paths/~1gifts~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a gift from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a gift with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the gift to delete.","required":true}],"pointer":"/paths/~1gifts~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/gifts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/gifts/{tenantId}/{id}","href":"gifts/deletegift","openApiOperationId":"deleteGift","summary":"Returns a gift from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The gift was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The gift could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The gift could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to delete gift based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1gifts~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/deletegift"}],"panels":[]}]},"httpPath":"/gifts/{tenantId}/{id}"},{"label":"Returns a gift from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/getgift","routeSlug":"/apis/fundraising/fundraising-v1/gifts/getgift","metadata":{"seo":{"title":"Returns a gift from the system by its ID.","description":"This method will look up a gift by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGift","name":"Returns a gift from the system by its ID.","isWebhook":false,"pointer":"/paths/~1gifts~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a gift from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a gift by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the gift to return.","required":true}],"pointer":"/paths/~1gifts~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_518","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1gifts~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/gifts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/gifts/{tenantId}/{id}","href":"gifts/getgift","openApiOperationId":"getGift","summary":"Returns a gift from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The gift was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Gift"}},"schemaId":"components/schemas/Gift","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The gift could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve gift based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1gifts~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Gift","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Gift"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/getgift"}],"panels":[]}]},"httpPath":"/gifts/{tenantId}/{id}"},{"label":"Partially updates a gift with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/patchgift","routeSlug":"/apis/fundraising/fundraising-v1/gifts/patchgift","metadata":{"seo":{"title":"Partially updates a gift with the specified ID.","description":"This method will patch an existing gift with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchGift","name":"Partially updates a gift with the specified ID.","isWebhook":false,"pointer":"/paths/~1gifts~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a gift with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing gift with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the gift to patch.","required":true}],"pointer":"/paths/~1gifts~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"schemaId":"schema_521","pointer":"/paths/~1gifts~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/gifts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_521"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/gifts/{tenantId}/{id}","href":"gifts/patchgift","openApiOperationId":"patchGift","summary":"Partially updates a gift with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"schema_521","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The gift was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Gift"}},"schemaId":"components/schemas/Gift","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The gift could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The gift could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve gift based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1gifts~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Gift","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Gift"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/patchgift"}],"panels":[]}]},"httpPath":"/gifts/{tenantId}/{id}"},{"label":"Updates a gift with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/updategift","routeSlug":"/apis/fundraising/fundraising-v1/gifts/updategift","metadata":{"seo":{"title":"Updates a gift with the specified ID.","description":"This method will update an existing gift with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateGift","name":"Updates a gift with the specified ID.","isWebhook":false,"pointer":"/paths/~1gifts~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a gift with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing gift with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the gift to update.","required":true}],"pointer":"/paths/~1gifts~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Gift"}},"schemaId":"components/schemas/Gift","pointer":"/paths/~1gifts~1{tenantId}~1{id}/put/requestBody","description":"The updated gift that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/gifts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Gift"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/gifts/{tenantId}/{id}","href":"gifts/updategift","openApiOperationId":"updateGift","summary":"Updates a gift with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Gift","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Gift"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The gift was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Gift"}},"schemaId":"components/schemas/Gift","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The gift supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The gift could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The gift could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve gift based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1gifts~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Gift","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Gift"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gifts/updategift"}],"panels":[]}]},"httpPath":"/gifts/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Gifts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gifts","showPageActions":true},{"nodeType":"markdoc","content":"Gifts"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/gifts/{tenantId}","summary":"Gets all of the gifts in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gifts/listgifts","deprecated":false},{"title":"/gifts/{tenantId}","summary":"Creates a new gift record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gifts/creategift","deprecated":false},{"title":"/gifts/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gifts/executebatchoperations","deprecated":false},{"title":"/gifts/{tenantId}/contact/{contact_id}","summary":"Returns a list of records with the specified contact_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gifts/listgiftsbycontactid","deprecated":false},{"title":"/gifts/{tenantId}/donor/{donor_id}","summary":"Returns a list of records with the specified donor_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gifts/listgiftsbydonorid","deprecated":false},{"title":"/gifts/{tenantId}/generateOrder","summary":"Generates an order from a fundraising gift","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gifts/generateorder","deprecated":false},{"title":"/gifts/{tenantId}/masterGift/{master_gift_id}","summary":"Returns a list of records with the specified master_gift_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gifts/listgiftsbymastergiftid","deprecated":false},{"title":"/gifts/{tenantId}/migrateDonationOrders","summary":"Migrate Donation Orders","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gifts/migratedonations","deprecated":false},{"title":"/gifts/{tenantId}/order/{order_id}","summary":"Returns a list of records with the specified order_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gifts/listgiftsbyorderid","deprecated":false},{"title":"/gifts/{tenantId}/organization/{organization_id}","summary":"Returns a list of records with the specified organization_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gifts/listgiftsbyorganizationid","deprecated":false},{"title":"/gifts/{tenantId}/pledge/{pledge_id}","summary":"Returns a list of records with the specified pledge_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gifts/listgiftsbypledgeid","deprecated":false},{"title":"/gifts/{tenantId}/previewReceipt","summary":"Preview Gift Receipt","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gifts/previewreceipt","deprecated":false},{"title":"/gifts/{tenantId}/process","summary":"Resend Receipt","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gifts/processgift","deprecated":false},{"title":"/gifts/{tenantId}/public/givingFormManifest","summary":"Get Public Giving Form Manifest","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gifts/getpublicgivingformmanifest","deprecated":false},{"title":"/gifts/{tenantId}/public/process","summary":"Resend Receipt","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gifts/processgiftpublicly","deprecated":false},{"title":"/gifts/{tenantId}/recurringGift/{recurring_gift_id}","summary":"Returns a list of records with the specified recurring_gift_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gifts/listgiftsbyrecurringgiftid","deprecated":false},{"title":"/gifts/{tenantId}/resendReceipt/{id}","summary":"Resend Receipt","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gifts/resendreceipt","deprecated":false},{"title":"/gifts/{tenantId}/search","summary":"Searches for gifts using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gifts/searchforgifts","deprecated":false},{"title":"/gifts/{tenantId}/softCredits/{donorId}","summary":"List Donor Soft Credits","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gifts/getsoftcreditsfordonor","deprecated":false},{"title":"/gifts/{tenantId}/{id}","summary":"Returns a gift from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/gifts/deletegift","deprecated":false},{"title":"/gifts/{tenantId}/{id}","summary":"Returns a gift from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gifts/getgift","deprecated":false},{"title":"/gifts/{tenantId}/{id}","summary":"Partially updates a gift with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/gifts/patchgift","deprecated":false},{"title":"/gifts/{tenantId}/{id}","summary":"Updates a gift with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/gifts/updategift","deprecated":false}]}]}]}]}},{"type":"group","label":"Giving Processes","link":"/apis/fundraising/fundraising-v1/giving-processes","routeSlug":"/apis/fundraising/fundraising-v1/giving-processes","items":[{"label":"Gets all of the giving processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/giving-processes/listgivingprocesses","routeSlug":"/apis/fundraising/fundraising-v1/giving-processes/listgivingprocesses","metadata":{"seo":{"title":"Gets all of the giving processes in the system.","description":"This method will scan all giving processes and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGivingProcesses","name":"Gets all of the giving processes in the system.","isWebhook":false,"pointer":"/paths/~1givingProcesses~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the giving processes in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all giving processes and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1givingProcesses~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1givingProcesses~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/givingProcesses/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/givingProcesses/{tenantId}","href":"giving-processes/listgivingprocesses","openApiOperationId":"listGivingProcesses","summary":"Gets all of the giving processes in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The giving processeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}},"schemaId":"schema_531","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1givingProcesses~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_531","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/giving-processes/listgivingprocesses"}],"panels":[]}]},"httpPath":"/givingProcesses/{tenantId}"},{"label":"Creates a new giving process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/giving-processes/creategivingprocess","routeSlug":"/apis/fundraising/fundraising-v1/giving-processes/creategivingprocess","metadata":{"seo":{"title":"Creates a new giving process record that does not already exist.","description":"This method will auto-generate an ID and create a new giving process. If an ID is specified for the giving process, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createGivingProcess","name":"Creates a new giving process record that does not already exist.","isWebhook":false,"pointer":"/paths/~1givingProcesses~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new giving process record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new giving process. If an ID is specified for the giving process, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1givingProcesses~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GivingProcess"}},"schemaId":"components/schemas/GivingProcess","pointer":"/paths/~1givingProcesses~1{tenantId}/post/requestBody","description":"The giving process that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/givingProcesses/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GivingProcess"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/givingProcesses/{tenantId}","href":"giving-processes/creategivingprocess","openApiOperationId":"createGivingProcess","summary":"Creates a new giving process record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/GivingProcess","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GivingProcess"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The giving process was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GivingProcess"}},"schemaId":"components/schemas/GivingProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The giving process you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The giving process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add giving process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1givingProcesses~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GivingProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GivingProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/giving-processes/creategivingprocess"}],"panels":[]}]},"httpPath":"/givingProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/giving-processes/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/giving-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1givingProcesses~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1givingProcesses~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1givingProcesses~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/givingProcesses/{tenantId}/batch","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/givingProcesses/{tenantId}/batch","href":"giving-processes/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The giving process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve giving process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1givingProcesses~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/giving-processes/executebatchoperations"}],"panels":[]}]},"httpPath":"/givingProcesses/{tenantId}/batch"},{"label":"Gets all of the processes a contact/org is eligible to use","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/giving-processes/geteligibleprocesses","routeSlug":"/apis/fundraising/fundraising-v1/giving-processes/geteligibleprocesses","metadata":{"seo":{"title":"Gets all of the processes a contact/org is eligible to use","description":"Gets all of the processes a contact/org is eligible to use"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEligibleProcesses","name":"Gets all of the processes a contact/org is eligible to use","isWebhook":false,"pointer":"/paths/~1givingProcesses~1{tenantId}~1eligible~1{customerType}~1{contactOrOrganizationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the processes a contact/org is eligible to use","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed","required":true},{"name":"customerType","in":"path","schemaId":"schema_532","description":"The contact or organization type","required":true},{"name":"contactOrOrganizationId","in":"path","schemaId":"schema_518","description":"The contact or organization id","required":true}],"pointer":"/paths/~1givingProcesses~1{tenantId}~1eligible~1{customerType}~1{contactOrOrganizationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/givingProcesses/{tenantId}/eligible/{customerType}/{contactOrOrganizationId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"customerType","in":"path","required":true,"schemaId":"schema_532"},{"name":"contactOrOrganizationId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/givingProcesses/{tenantId}/eligible/{customerType}/{contactOrOrganizationId}","href":"giving-processes/geteligibleprocesses","openApiOperationId":"getEligibleProcesses","summary":"Gets all of the processes a contact/org is eligible to use"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Processes were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}},"schemaId":"schema_531","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Request limit exceeded... please try your request again in a few seconds","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"An internal server error occured.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1givingProcesses~1{tenantId}~1eligible~1{customerType}~1{contactOrOrganizationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_531","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/giving-processes/geteligibleprocesses"}],"panels":[]}]},"httpPath":"/givingProcesses/{tenantId}/eligible/{customerType}/{contactOrOrganizationId}"},{"label":"Returns a giving process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/giving-processes/deletegivingprocess","routeSlug":"/apis/fundraising/fundraising-v1/giving-processes/deletegivingprocess","metadata":{"seo":{"title":"Returns a giving process from the system by its ID.","description":"This method will delete a giving process with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteGivingProcess","name":"Returns a giving process from the system by its ID.","isWebhook":false,"pointer":"/paths/~1givingProcesses~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a giving process from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a giving process with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the giving process to delete.","required":true}],"pointer":"/paths/~1givingProcesses~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/givingProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/givingProcesses/{tenantId}/{id}","href":"giving-processes/deletegivingprocess","openApiOperationId":"deleteGivingProcess","summary":"Returns a giving process from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The giving process was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The giving process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The giving process could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to delete giving process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1givingProcesses~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/giving-processes/deletegivingprocess"}],"panels":[]}]},"httpPath":"/givingProcesses/{tenantId}/{id}"},{"label":"Returns a giving process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/giving-processes/getgivingprocess","routeSlug":"/apis/fundraising/fundraising-v1/giving-processes/getgivingprocess","metadata":{"seo":{"title":"Returns a giving process from the system by its ID.","description":"This method will look up a giving process by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGivingProcess","name":"Returns a giving process from the system by its ID.","isWebhook":false,"pointer":"/paths/~1givingProcesses~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a giving process from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a giving process by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the giving process to return.","required":true}],"pointer":"/paths/~1givingProcesses~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_518","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1givingProcesses~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/givingProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/givingProcesses/{tenantId}/{id}","href":"giving-processes/getgivingprocess","openApiOperationId":"getGivingProcess","summary":"Returns a giving process from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The giving process was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GivingProcess"}},"schemaId":"components/schemas/GivingProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The giving process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve giving process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1givingProcesses~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GivingProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GivingProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/giving-processes/getgivingprocess"}],"panels":[]}]},"httpPath":"/givingProcesses/{tenantId}/{id}"},{"label":"Partially updates a giving process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/giving-processes/patchgivingprocess","routeSlug":"/apis/fundraising/fundraising-v1/giving-processes/patchgivingprocess","metadata":{"seo":{"title":"Partially updates a giving process with the specified ID.","description":"This method will patch an existing giving process with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchGivingProcess","name":"Partially updates a giving process with the specified ID.","isWebhook":false,"pointer":"/paths/~1givingProcesses~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a giving process with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing giving process with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the giving process to patch.","required":true}],"pointer":"/paths/~1givingProcesses~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"schemaId":"schema_521","pointer":"/paths/~1givingProcesses~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/givingProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_521"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/givingProcesses/{tenantId}/{id}","href":"giving-processes/patchgivingprocess","openApiOperationId":"patchGivingProcess","summary":"Partially updates a giving process with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"schema_521","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The giving process was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GivingProcess"}},"schemaId":"components/schemas/GivingProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The giving process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The giving process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve giving process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1givingProcesses~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GivingProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GivingProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/giving-processes/patchgivingprocess"}],"panels":[]}]},"httpPath":"/givingProcesses/{tenantId}/{id}"},{"label":"Updates a giving process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/giving-processes/updategivingprocess","routeSlug":"/apis/fundraising/fundraising-v1/giving-processes/updategivingprocess","metadata":{"seo":{"title":"Updates a giving process with the specified ID.","description":"This method will update an existing giving process with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateGivingProcess","name":"Updates a giving process with the specified ID.","isWebhook":false,"pointer":"/paths/~1givingProcesses~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a giving process with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing giving process with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the giving process to update.","required":true}],"pointer":"/paths/~1givingProcesses~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GivingProcess"}},"schemaId":"components/schemas/GivingProcess","pointer":"/paths/~1givingProcesses~1{tenantId}~1{id}/put/requestBody","description":"The updated giving process that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/givingProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GivingProcess"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/givingProcesses/{tenantId}/{id}","href":"giving-processes/updategivingprocess","openApiOperationId":"updateGivingProcess","summary":"Updates a giving process with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/GivingProcess","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GivingProcess"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The giving process was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GivingProcess"}},"schemaId":"components/schemas/GivingProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The giving process supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The giving process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The giving process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve giving process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1givingProcesses~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GivingProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GivingProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/giving-processes/updategivingprocess"}],"panels":[]}]},"httpPath":"/givingProcesses/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Giving Processes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Giving Processes","showPageActions":true},{"nodeType":"markdoc","content":"Giving Processes"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/givingProcesses/{tenantId}","summary":"Gets all of the giving processes in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/giving-processes/listgivingprocesses","deprecated":false},{"title":"/givingProcesses/{tenantId}","summary":"Creates a new giving process record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/giving-processes/creategivingprocess","deprecated":false},{"title":"/givingProcesses/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/giving-processes/executebatchoperations","deprecated":false},{"title":"/givingProcesses/{tenantId}/eligible/{customerType}/{contactOrOrganizationId}","summary":"Gets all of the processes a contact/org is eligible to use","prefix":{"name":"get","color":"get"},"badges":[],"link":"/giving-processes/geteligibleprocesses","deprecated":false},{"title":"/givingProcesses/{tenantId}/{id}","summary":"Returns a giving process from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/giving-processes/deletegivingprocess","deprecated":false},{"title":"/givingProcesses/{tenantId}/{id}","summary":"Returns a giving process from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/giving-processes/getgivingprocess","deprecated":false},{"title":"/givingProcesses/{tenantId}/{id}","summary":"Partially updates a giving process with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/giving-processes/patchgivingprocess","deprecated":false},{"title":"/givingProcesses/{tenantId}/{id}","summary":"Updates a giving process with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/giving-processes/updategivingprocess","deprecated":false}]}]}]}]}},{"type":"group","label":"Pledge Levels","link":"/apis/fundraising/fundraising-v1/pledge-levels","routeSlug":"/apis/fundraising/fundraising-v1/pledge-levels","items":[{"label":"Gets all of the pledge levels in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-levels/listpledgelevels","routeSlug":"/apis/fundraising/fundraising-v1/pledge-levels/listpledgelevels","metadata":{"seo":{"title":"Gets all of the pledge levels in the system.","description":"This method will scan all pledge levels and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPledgeLevels","name":"Gets all of the pledge levels in the system.","isWebhook":false,"pointer":"/paths/~1pledgeLevels~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the pledge levels in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all pledge levels and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1pledgeLevels~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1pledgeLevels~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pledgeLevels/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/pledgeLevels/{tenantId}","href":"pledge-levels/listpledgelevels","openApiOperationId":"listPledgeLevels","summary":"Gets all of the pledge levels in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The pledge levelswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_533"}},"schemaId":"schema_533","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledgeLevels~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_533","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_533"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledge-levels/listpledgelevels"}],"panels":[]}]},"httpPath":"/pledgeLevels/{tenantId}"},{"label":"Creates a new pledge level record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-levels/createpledgelevel","routeSlug":"/apis/fundraising/fundraising-v1/pledge-levels/createpledgelevel","metadata":{"seo":{"title":"Creates a new pledge level record that does not already exist.","description":"This method will auto-generate an ID and create a new pledge level. If an ID is specified for the pledge level, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPledgeLevel","name":"Creates a new pledge level record that does not already exist.","isWebhook":false,"pointer":"/paths/~1pledgeLevels~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new pledge level record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new pledge level. If an ID is specified for the pledge level, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1pledgeLevels~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PledgeLevel"}},"schemaId":"components/schemas/PledgeLevel","pointer":"/paths/~1pledgeLevels~1{tenantId}/post/requestBody","description":"The pledge level that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pledgeLevels/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PledgeLevel"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/pledgeLevels/{tenantId}","href":"pledge-levels/createpledgelevel","openApiOperationId":"createPledgeLevel","summary":"Creates a new pledge level record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PledgeLevel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PledgeLevel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The pledge level was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PledgeLevel"}},"schemaId":"components/schemas/PledgeLevel","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The pledge level you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The pledge level could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add pledge level based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledgeLevels~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PledgeLevel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PledgeLevel"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledge-levels/createpledgelevel"}],"panels":[]}]},"httpPath":"/pledgeLevels/{tenantId}"},{"label":"Returns a pledge level from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-levels/deletepledgelevel","routeSlug":"/apis/fundraising/fundraising-v1/pledge-levels/deletepledgelevel","metadata":{"seo":{"title":"Returns a pledge level from the system by its ID.","description":"This method will delete a pledge level with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePledgeLevel","name":"Returns a pledge level from the system by its ID.","isWebhook":false,"pointer":"/paths/~1pledgeLevels~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a pledge level from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a pledge level with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the pledge level to delete.","required":true}],"pointer":"/paths/~1pledgeLevels~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/pledgeLevels/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/pledgeLevels/{tenantId}/{id}","href":"pledge-levels/deletepledgelevel","openApiOperationId":"deletePledgeLevel","summary":"Returns a pledge level from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The pledge level was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The pledge level could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The pledge level could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to delete pledge level based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledgeLevels~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledge-levels/deletepledgelevel"}],"panels":[]}]},"httpPath":"/pledgeLevels/{tenantId}/{id}"},{"label":"Returns a pledge level from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-levels/getpledgelevel","routeSlug":"/apis/fundraising/fundraising-v1/pledge-levels/getpledgelevel","metadata":{"seo":{"title":"Returns a pledge level from the system by its ID.","description":"This method will look up a pledge level by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPledgeLevel","name":"Returns a pledge level from the system by its ID.","isWebhook":false,"pointer":"/paths/~1pledgeLevels~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a pledge level from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a pledge level by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the pledge level to return.","required":true}],"pointer":"/paths/~1pledgeLevels~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_518","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1pledgeLevels~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pledgeLevels/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/pledgeLevels/{tenantId}/{id}","href":"pledge-levels/getpledgelevel","openApiOperationId":"getPledgeLevel","summary":"Returns a pledge level from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The pledge level was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PledgeLevel"}},"schemaId":"components/schemas/PledgeLevel","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The pledge level could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve pledge level based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledgeLevels~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PledgeLevel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PledgeLevel"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledge-levels/getpledgelevel"}],"panels":[]}]},"httpPath":"/pledgeLevels/{tenantId}/{id}"},{"label":"Partially updates a pledge level with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-levels/patchpledgelevel","routeSlug":"/apis/fundraising/fundraising-v1/pledge-levels/patchpledgelevel","metadata":{"seo":{"title":"Partially updates a pledge level with the specified ID.","description":"This method will patch an existing pledge level with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchPledgeLevel","name":"Partially updates a pledge level with the specified ID.","isWebhook":false,"pointer":"/paths/~1pledgeLevels~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a pledge level with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing pledge level with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the pledge level to patch.","required":true}],"pointer":"/paths/~1pledgeLevels~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"schemaId":"schema_521","pointer":"/paths/~1pledgeLevels~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/pledgeLevels/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_521"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/pledgeLevels/{tenantId}/{id}","href":"pledge-levels/patchpledgelevel","openApiOperationId":"patchPledgeLevel","summary":"Partially updates a pledge level with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"schema_521","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The pledge level was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PledgeLevel"}},"schemaId":"components/schemas/PledgeLevel","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The pledge level could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The pledge level could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve pledge level based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledgeLevels~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PledgeLevel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PledgeLevel"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledge-levels/patchpledgelevel"}],"panels":[]}]},"httpPath":"/pledgeLevels/{tenantId}/{id}"},{"label":"Updates a pledge level with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-levels/updatepledgelevel","routeSlug":"/apis/fundraising/fundraising-v1/pledge-levels/updatepledgelevel","metadata":{"seo":{"title":"Updates a pledge level with the specified ID.","description":"This method will update an existing pledge level with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePledgeLevel","name":"Updates a pledge level with the specified ID.","isWebhook":false,"pointer":"/paths/~1pledgeLevels~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a pledge level with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing pledge level with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the pledge level to update.","required":true}],"pointer":"/paths/~1pledgeLevels~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PledgeLevel"}},"schemaId":"components/schemas/PledgeLevel","pointer":"/paths/~1pledgeLevels~1{tenantId}~1{id}/put/requestBody","description":"The updated pledge level that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/pledgeLevels/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PledgeLevel"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/pledgeLevels/{tenantId}/{id}","href":"pledge-levels/updatepledgelevel","openApiOperationId":"updatePledgeLevel","summary":"Updates a pledge level with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PledgeLevel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PledgeLevel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The pledge level was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PledgeLevel"}},"schemaId":"components/schemas/PledgeLevel","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The pledge level supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The pledge level could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The pledge level could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve pledge level based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledgeLevels~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PledgeLevel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PledgeLevel"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledge-levels/updatepledgelevel"}],"panels":[]}]},"httpPath":"/pledgeLevels/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Pledge Levels"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pledge Levels","showPageActions":true},{"nodeType":"markdoc","content":"Pledge Levels"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/pledgeLevels/{tenantId}","summary":"Gets all of the pledge levels in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pledge-levels/listpledgelevels","deprecated":false},{"title":"/pledgeLevels/{tenantId}","summary":"Creates a new pledge level record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pledge-levels/createpledgelevel","deprecated":false},{"title":"/pledgeLevels/{tenantId}/{id}","summary":"Returns a pledge level from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/pledge-levels/deletepledgelevel","deprecated":false},{"title":"/pledgeLevels/{tenantId}/{id}","summary":"Returns a pledge level from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pledge-levels/getpledgelevel","deprecated":false},{"title":"/pledgeLevels/{tenantId}/{id}","summary":"Partially updates a pledge level with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/pledge-levels/patchpledgelevel","deprecated":false},{"title":"/pledgeLevels/{tenantId}/{id}","summary":"Updates a pledge level with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/pledge-levels/updatepledgelevel","deprecated":false}]}]}]}]}},{"type":"group","label":"Pledge Notices","link":"/apis/fundraising/fundraising-v1/pledge-notices","routeSlug":"/apis/fundraising/fundraising-v1/pledge-notices","items":[{"label":"Gets all of the pledge notices in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-notices/listpledgenotices","routeSlug":"/apis/fundraising/fundraising-v1/pledge-notices/listpledgenotices","metadata":{"seo":{"title":"Gets all of the pledge notices in the system.","description":"This method will scan all pledge notices and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPledgeNotices","name":"Gets all of the pledge notices in the system.","isWebhook":false,"pointer":"/paths/~1pledgeNotices~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the pledge notices in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all pledge notices and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1pledgeNotices~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1pledgeNotices~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pledgeNotices/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/pledgeNotices/{tenantId}","href":"pledge-notices/listpledgenotices","openApiOperationId":"listPledgeNotices","summary":"Gets all of the pledge notices in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The pledge noticeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledgeNotices~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledge-notices/listpledgenotices"}],"panels":[]}]},"httpPath":"/pledgeNotices/{tenantId}"},{"label":"Creates a new pledge notice record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-notices/createpledgenotice","routeSlug":"/apis/fundraising/fundraising-v1/pledge-notices/createpledgenotice","metadata":{"seo":{"title":"Creates a new pledge notice record that does not already exist.","description":"This method will auto-generate an ID and create a new pledge notice. If an ID is specified for the pledge notice, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPledgeNotice","name":"Creates a new pledge notice record that does not already exist.","isWebhook":false,"pointer":"/paths/~1pledgeNotices~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new pledge notice record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new pledge notice. If an ID is specified for the pledge notice, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1pledgeNotices~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PledgeNotice"}},"schemaId":"components/schemas/PledgeNotice","pointer":"/paths/~1pledgeNotices~1{tenantId}/post/requestBody","description":"The pledge notice that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pledgeNotices/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PledgeNotice"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/pledgeNotices/{tenantId}","href":"pledge-notices/createpledgenotice","openApiOperationId":"createPledgeNotice","summary":"Creates a new pledge notice record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PledgeNotice","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PledgeNotice"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The pledge notice was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PledgeNotice"}},"schemaId":"components/schemas/PledgeNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The pledge notice you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The pledge notice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add pledge notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledgeNotices~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PledgeNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PledgeNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledge-notices/createpledgenotice"}],"panels":[]}]},"httpPath":"/pledgeNotices/{tenantId}"},{"label":"Returns a pledge notice from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-notices/deletepledgenotice","routeSlug":"/apis/fundraising/fundraising-v1/pledge-notices/deletepledgenotice","metadata":{"seo":{"title":"Returns a pledge notice from the system by its ID.","description":"This method will delete a pledge notice with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePledgeNotice","name":"Returns a pledge notice from the system by its ID.","isWebhook":false,"pointer":"/paths/~1pledgeNotices~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a pledge notice from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a pledge notice with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the pledge notice to delete.","required":true}],"pointer":"/paths/~1pledgeNotices~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/pledgeNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/pledgeNotices/{tenantId}/{id}","href":"pledge-notices/deletepledgenotice","openApiOperationId":"deletePledgeNotice","summary":"Returns a pledge notice from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The pledge notice was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The pledge notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The pledge notice could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to delete pledge notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledgeNotices~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledge-notices/deletepledgenotice"}],"panels":[]}]},"httpPath":"/pledgeNotices/{tenantId}/{id}"},{"label":"Returns a pledge notice from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-notices/getpledgenotice","routeSlug":"/apis/fundraising/fundraising-v1/pledge-notices/getpledgenotice","metadata":{"seo":{"title":"Returns a pledge notice from the system by its ID.","description":"This method will look up a pledge notice by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPledgeNotice","name":"Returns a pledge notice from the system by its ID.","isWebhook":false,"pointer":"/paths/~1pledgeNotices~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a pledge notice from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a pledge notice by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the pledge notice to return.","required":true}],"pointer":"/paths/~1pledgeNotices~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_518","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1pledgeNotices~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pledgeNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/pledgeNotices/{tenantId}/{id}","href":"pledge-notices/getpledgenotice","openApiOperationId":"getPledgeNotice","summary":"Returns a pledge notice from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The pledge notice was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PledgeNotice"}},"schemaId":"components/schemas/PledgeNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The pledge notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve pledge notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledgeNotices~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PledgeNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PledgeNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledge-notices/getpledgenotice"}],"panels":[]}]},"httpPath":"/pledgeNotices/{tenantId}/{id}"},{"label":"Partially updates a pledge notice with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-notices/patchpledgenotice","routeSlug":"/apis/fundraising/fundraising-v1/pledge-notices/patchpledgenotice","metadata":{"seo":{"title":"Partially updates a pledge notice with the specified ID.","description":"This method will patch an existing pledge notice with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchPledgeNotice","name":"Partially updates a pledge notice with the specified ID.","isWebhook":false,"pointer":"/paths/~1pledgeNotices~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a pledge notice with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing pledge notice with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the pledge notice to patch.","required":true}],"pointer":"/paths/~1pledgeNotices~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"schemaId":"schema_521","pointer":"/paths/~1pledgeNotices~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/pledgeNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_521"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/pledgeNotices/{tenantId}/{id}","href":"pledge-notices/patchpledgenotice","openApiOperationId":"patchPledgeNotice","summary":"Partially updates a pledge notice with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"schema_521","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The pledge notice was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PledgeNotice"}},"schemaId":"components/schemas/PledgeNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The pledge notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The pledge notice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve pledge notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledgeNotices~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PledgeNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PledgeNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledge-notices/patchpledgenotice"}],"panels":[]}]},"httpPath":"/pledgeNotices/{tenantId}/{id}"},{"label":"Updates a pledge notice with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-notices/updatepledgenotice","routeSlug":"/apis/fundraising/fundraising-v1/pledge-notices/updatepledgenotice","metadata":{"seo":{"title":"Updates a pledge notice with the specified ID.","description":"This method will update an existing pledge notice with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePledgeNotice","name":"Updates a pledge notice with the specified ID.","isWebhook":false,"pointer":"/paths/~1pledgeNotices~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a pledge notice with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing pledge notice with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the pledge notice to update.","required":true}],"pointer":"/paths/~1pledgeNotices~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PledgeNotice"}},"schemaId":"components/schemas/PledgeNotice","pointer":"/paths/~1pledgeNotices~1{tenantId}~1{id}/put/requestBody","description":"The updated pledge notice that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/pledgeNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PledgeNotice"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/pledgeNotices/{tenantId}/{id}","href":"pledge-notices/updatepledgenotice","openApiOperationId":"updatePledgeNotice","summary":"Updates a pledge notice with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PledgeNotice","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PledgeNotice"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The pledge notice was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PledgeNotice"}},"schemaId":"components/schemas/PledgeNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The pledge notice supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The pledge notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The pledge notice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve pledge notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledgeNotices~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PledgeNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PledgeNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledge-notices/updatepledgenotice"}],"panels":[]}]},"httpPath":"/pledgeNotices/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Pledge Notices"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pledge Notices","showPageActions":true},{"nodeType":"markdoc","content":"Pledge Notices"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/pledgeNotices/{tenantId}","summary":"Gets all of the pledge notices in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pledge-notices/listpledgenotices","deprecated":false},{"title":"/pledgeNotices/{tenantId}","summary":"Creates a new pledge notice record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pledge-notices/createpledgenotice","deprecated":false},{"title":"/pledgeNotices/{tenantId}/{id}","summary":"Returns a pledge notice from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/pledge-notices/deletepledgenotice","deprecated":false},{"title":"/pledgeNotices/{tenantId}/{id}","summary":"Returns a pledge notice from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pledge-notices/getpledgenotice","deprecated":false},{"title":"/pledgeNotices/{tenantId}/{id}","summary":"Partially updates a pledge notice with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/pledge-notices/patchpledgenotice","deprecated":false},{"title":"/pledgeNotices/{tenantId}/{id}","summary":"Updates a pledge notice with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/pledge-notices/updatepledgenotice","deprecated":false}]}]}]}]}},{"type":"group","label":"Pledges","link":"/apis/fundraising/fundraising-v1/pledges","routeSlug":"/apis/fundraising/fundraising-v1/pledges","items":[{"label":"Creates a new pledge record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/createpledge","routeSlug":"/apis/fundraising/fundraising-v1/pledges/createpledge","metadata":{"seo":{"title":"Creates a new pledge record that does not already exist.","description":"This method will auto-generate an ID and create a new pledge. If an ID is specified for the pledge, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPledge","name":"Creates a new pledge record that does not already exist.","isWebhook":false,"pointer":"/paths/~1pledges~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new pledge record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new pledge. If an ID is specified for the pledge, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1pledges~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Pledge"}},"schemaId":"components/schemas/Pledge","pointer":"/paths/~1pledges~1{tenantId}/post/requestBody","description":"The pledge that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pledges/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Pledge"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/pledges/{tenantId}","href":"pledges/createpledge","openApiOperationId":"createPledge","summary":"Creates a new pledge record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Pledge","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Pledge"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The pledge was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pledge"}},"schemaId":"components/schemas/Pledge","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The pledge you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The pledge could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add pledge based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledges~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Pledge","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pledge"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledges/createpledge"}],"panels":[]}]},"httpPath":"/pledges/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/pledges/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1pledges~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1pledges~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1pledges~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pledges/{tenantId}/batch","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/pledges/{tenantId}/batch","href":"pledges/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The pledge could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve pledge based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledges~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledges/executebatchoperations"}],"panels":[]}]},"httpPath":"/pledges/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/listpledgesbycontactid","routeSlug":"/apis/fundraising/fundraising-v1/pledges/listpledgesbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPledgesByContactId","name":"Returns a list of records with the specified contact_id","isWebhook":false,"pointer":"/paths/~1pledges~1{tenantId}~1contact~1{contact_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified contact_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified contact_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true},{"name":"contact_id","in":"path","schemaId":"schema_518","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1pledges~1{tenantId}~1contact~1{contact_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1pledges~1{tenantId}~1contact~1{contact_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pledges/{tenantId}/contact/{contact_id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"contact_id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/pledges/{tenantId}/contact/{contact_id}","href":"pledges/listpledgesbycontactid","openApiOperationId":"listPledgesByContactId","summary":"Returns a list of records with the specified contact_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPledgesResponse"}},"schemaId":"components/schemas/ListPledgesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledges~1{tenantId}~1contact~1{contact_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListPledgesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPledgesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledges/listpledgesbycontactid"}],"panels":[]}]},"httpPath":"/pledges/{tenantId}/contact/{contact_id}"},{"label":"Returns a list of records with the specified donor_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/listpledgesbydonorid","routeSlug":"/apis/fundraising/fundraising-v1/pledges/listpledgesbydonorid","metadata":{"seo":{"title":"Returns a list of records with the specified donor_id","description":"Returns a list of records with the specified donor_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPledgesByDonorId","name":"Returns a list of records with the specified donor_id","isWebhook":false,"pointer":"/paths/~1pledges~1{tenantId}~1donor~1{donor_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified donor_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified donor_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true},{"name":"donor_id","in":"path","schemaId":"schema_518","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The donor_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1pledges~1{tenantId}~1donor~1{donor_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1pledges~1{tenantId}~1donor~1{donor_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pledges/{tenantId}/donor/{donor_id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"donor_id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/pledges/{tenantId}/donor/{donor_id}","href":"pledges/listpledgesbydonorid","openApiOperationId":"listPledgesByDonorId","summary":"Returns a list of records with the specified donor_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPledgesResponse"}},"schemaId":"components/schemas/ListPledgesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledges~1{tenantId}~1donor~1{donor_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListPledgesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPledgesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledges/listpledgesbydonorid"}],"panels":[]}]},"httpPath":"/pledges/{tenantId}/donor/{donor_id}"},{"label":"Generates an order from a fundraising pledge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/generateorder","routeSlug":"/apis/fundraising/fundraising-v1/pledges/generateorder","metadata":{"seo":{"title":"Generates an order from a fundraising pledge","description":"This method will examine a fundraising pledge and generate an appropriate order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateOrder","name":"Generates an order from a fundraising pledge","isWebhook":false,"pointer":"/paths/~1pledges~1{tenantId}~1generateOrder/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generates an order from a fundraising pledge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will examine a fundraising pledge and generate an appropriate order"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1pledges~1{tenantId}~1generateOrder/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PledgePayload"}},"schemaId":"components/schemas/PledgePayload","pointer":"/paths/~1pledges~1{tenantId}~1generateOrder/post/requestBody","description":"The pledge to generate an order"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pledges/{tenantId}/generateOrder","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PledgePayload"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/pledges/{tenantId}/generateOrder","href":"pledges/generateorder","openApiOperationId":"generateOrder","summary":"Generates an order from a fundraising pledge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PledgePayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PledgePayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conflicts were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_530"}},"schemaId":"schema_530","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledges~1{tenantId}~1generateOrder/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_530","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_530"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledges/generateorder"}],"panels":[]}]},"httpPath":"/pledges/{tenantId}/generateOrder"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/listpledgesbyorderid","routeSlug":"/apis/fundraising/fundraising-v1/pledges/listpledgesbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPledgesByOrderId","name":"Returns a list of records with the specified order_id","isWebhook":false,"pointer":"/paths/~1pledges~1{tenantId}~1order~1{order_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified order_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified order_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true},{"name":"order_id","in":"path","schemaId":"schema_518","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1pledges~1{tenantId}~1order~1{order_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1pledges~1{tenantId}~1order~1{order_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pledges/{tenantId}/order/{order_id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"order_id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/pledges/{tenantId}/order/{order_id}","href":"pledges/listpledgesbyorderid","openApiOperationId":"listPledgesByOrderId","summary":"Returns a list of records with the specified order_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPledgesResponse"}},"schemaId":"components/schemas/ListPledgesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledges~1{tenantId}~1order~1{order_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListPledgesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPledgesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledges/listpledgesbyorderid"}],"panels":[]}]},"httpPath":"/pledges/{tenantId}/order/{order_id}"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/listpledgesbyorganizationid","routeSlug":"/apis/fundraising/fundraising-v1/pledges/listpledgesbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPledgesByOrganizationId","name":"Returns a list of records with the specified organization_id","isWebhook":false,"pointer":"/paths/~1pledges~1{tenantId}~1organization~1{organization_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified organization_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified organization_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true},{"name":"organization_id","in":"path","schemaId":"schema_518","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1pledges~1{tenantId}~1organization~1{organization_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1pledges~1{tenantId}~1organization~1{organization_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pledges/{tenantId}/organization/{organization_id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"organization_id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/pledges/{tenantId}/organization/{organization_id}","href":"pledges/listpledgesbyorganizationid","openApiOperationId":"listPledgesByOrganizationId","summary":"Returns a list of records with the specified organization_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPledgesResponse"}},"schemaId":"components/schemas/ListPledgesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledges~1{tenantId}~1organization~1{organization_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListPledgesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPledgesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledges/listpledgesbyorganizationid"}],"panels":[]}]},"httpPath":"/pledges/{tenantId}/organization/{organization_id}"},{"label":"Sends out a preview of the pledge notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/previewemail","routeSlug":"/apis/fundraising/fundraising-v1/pledges/previewemail","metadata":{"seo":{"title":"Sends out a preview of the pledge notification email","description":"Sends out a preview of the pledge notification email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewEmail","name":"Sends out a preview of the pledge notification email","isWebhook":false,"pointer":"/paths/~1pledges~1{tenantId}~1previewEmail/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends out a preview of the pledge notification email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the pledge notification email"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true}],"pointer":"/paths/~1pledges~1{tenantId}~1previewEmail/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"schemaId":"components/schemas/PreviewEmailRequest","pointer":"/paths/~1pledges~1{tenantId}~1previewEmail/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pledges/{tenantId}/previewEmail","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/pledges/{tenantId}/previewEmail","href":"pledges/previewemail","openApiOperationId":"previewEmail","summary":"Sends out a preview of the pledge notification email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewEmailRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledges~1{tenantId}~1previewEmail/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledges/previewemail"}],"panels":[]}]},"httpPath":"/pledges/{tenantId}/previewEmail"},{"label":"Preview Pledge Receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/previewreceipt","routeSlug":"/apis/fundraising/fundraising-v1/pledges/previewreceipt","metadata":{"seo":{"title":"Preview Pledge Receipt","description":"Sends out a preview of the pledge receipt email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewReceipt","name":"Preview Pledge Receipt","isWebhook":false,"pointer":"/paths/~1pledges~1{tenantId}~1previewReceipt/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preview Pledge Receipt","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the pledge receipt email"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true}],"pointer":"/paths/~1pledges~1{tenantId}~1previewReceipt/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewReceiptRequest"}},"schemaId":"components/schemas/PreviewReceiptRequest","pointer":"/paths/~1pledges~1{tenantId}~1previewReceipt/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pledges/{tenantId}/previewReceipt","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewReceiptRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/pledges/{tenantId}/previewReceipt","href":"pledges/previewreceipt","openApiOperationId":"previewReceipt","summary":"Preview Pledge Receipt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewReceiptRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewReceiptRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledges~1{tenantId}~1previewReceipt/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledges/previewreceipt"}],"panels":[]}]},"httpPath":"/pledges/{tenantId}/previewReceipt"},{"label":"Resend Receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/processpledge","routeSlug":"/apis/fundraising/fundraising-v1/pledges/processpledge","metadata":{"seo":{"title":"Resend Receipt","description":"Resends the pledge receipt"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processPledge","name":"Resend Receipt","isWebhook":false,"pointer":"/paths/~1pledges~1{tenantId}~1process/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend Receipt","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Resends the pledge receipt"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true}],"pointer":"/paths/~1pledges~1{tenantId}~1process/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProcessPledgeInfo"}},"schemaId":"components/schemas/ProcessPledgeInfo","pointer":"/paths/~1pledges~1{tenantId}~1process/post/requestBody","description":"Payload for the pledge"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pledges/{tenantId}/process","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProcessPledgeInfo"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/pledges/{tenantId}/process","href":"pledges/processpledge","openApiOperationId":"processPledge","summary":"Resend Receipt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ProcessPledgeInfo","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProcessPledgeInfo"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledges~1{tenantId}~1process/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledges/processpledge"}],"panels":[]}]},"httpPath":"/pledges/{tenantId}/process"},{"label":"Resend Receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/processpledgepublicly","routeSlug":"/apis/fundraising/fundraising-v1/pledges/processpledgepublicly","metadata":{"seo":{"title":"Resend Receipt","description":"Resends the pledge receipt"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processPledgePublicly","name":"Resend Receipt","isWebhook":false,"pointer":"/paths/~1pledges~1{tenantId}~1public~1process/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend Receipt","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Resends the pledge receipt"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true}],"pointer":"/paths/~1pledges~1{tenantId}~1public~1process/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProcessPledgeInfo"}},"schemaId":"components/schemas/ProcessPledgeInfo","pointer":"/paths/~1pledges~1{tenantId}~1public~1process/post/requestBody","description":"Payload for the pledge"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pledges/{tenantId}/public/process","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ProcessPledgeInfo"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/pledges/{tenantId}/public/process","href":"pledges/processpledgepublicly","openApiOperationId":"processPledgePublicly","summary":"Resend Receipt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ProcessPledgeInfo","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProcessPledgeInfo"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledges~1{tenantId}~1public~1process/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledges/processpledgepublicly"}],"panels":[]}]},"httpPath":"/pledges/{tenantId}/public/process"},{"label":"Resend Receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/resendreceipt","routeSlug":"/apis/fundraising/fundraising-v1/pledges/resendreceipt","metadata":{"seo":{"title":"Resend Receipt","description":"Resends the pledge receipt"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"resendReceipt","name":"Resend Receipt","isWebhook":false,"pointer":"/paths/~1pledges~1{tenantId}~1resendReceipt~1{id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend Receipt","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Resends the pledge receipt"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the pledge","required":true}],"pointer":"/paths/~1pledges~1{tenantId}~1resendReceipt~1{id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pledges/{tenantId}/resendReceipt/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/pledges/{tenantId}/resendReceipt/{id}","href":"pledges/resendreceipt","openApiOperationId":"resendReceipt","summary":"Resend Receipt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledges~1{tenantId}~1resendReceipt~1{id}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledges/resendreceipt"}],"panels":[]}]},"httpPath":"/pledges/{tenantId}/resendReceipt/{id}"},{"label":"Searches for pledges using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/searchforpledges","routeSlug":"/apis/fundraising/fundraising-v1/pledges/searchforpledges","metadata":{"seo":{"title":"Searches for pledges using predefined parameters","description":"Searches for pledges using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForPledges","name":"Searches for pledges using predefined parameters","isWebhook":false,"pointer":"/paths/~1pledges~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for pledges using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for pledges using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1pledges~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_518","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1pledges~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PledgeSearchParameters"}},"schemaId":"components/schemas/PledgeSearchParameters","pointer":"/paths/~1pledges~1{tenantId}~1search/post/requestBody","description":"The pledge that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pledges/{tenantId}/search","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PledgeSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/pledges/{tenantId}/search","href":"pledges/searchforpledges","openApiOperationId":"searchForPledges","summary":"Searches for pledges using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PledgeSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PledgeSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The pledge search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedPledgeSearchResults"}},"schemaId":"components/schemas/PagedPledgeSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The pledge you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The pledge could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add pledge based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledges~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedPledgeSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedPledgeSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledges/searchforpledges"}],"panels":[]}]},"httpPath":"/pledges/{tenantId}/search"},{"label":"Returns a pledge from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/deletepledge","routeSlug":"/apis/fundraising/fundraising-v1/pledges/deletepledge","metadata":{"seo":{"title":"Returns a pledge from the system by its ID.","description":"This method will delete a pledge with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePledge","name":"Returns a pledge from the system by its ID.","isWebhook":false,"pointer":"/paths/~1pledges~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a pledge from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a pledge with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the pledge to delete.","required":true}],"pointer":"/paths/~1pledges~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/pledges/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/pledges/{tenantId}/{id}","href":"pledges/deletepledge","openApiOperationId":"deletePledge","summary":"Returns a pledge from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The pledge was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The pledge could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The pledge could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to delete pledge based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledges~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledges/deletepledge"}],"panels":[]}]},"httpPath":"/pledges/{tenantId}/{id}"},{"label":"Returns a pledge from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/getpledge","routeSlug":"/apis/fundraising/fundraising-v1/pledges/getpledge","metadata":{"seo":{"title":"Returns a pledge from the system by its ID.","description":"This method will look up a pledge by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPledge","name":"Returns a pledge from the system by its ID.","isWebhook":false,"pointer":"/paths/~1pledges~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a pledge from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a pledge by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the pledge to return.","required":true}],"pointer":"/paths/~1pledges~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_518","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1pledges~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pledges/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/pledges/{tenantId}/{id}","href":"pledges/getpledge","openApiOperationId":"getPledge","summary":"Returns a pledge from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The pledge was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pledge"}},"schemaId":"components/schemas/Pledge","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The pledge could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve pledge based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledges~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Pledge","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pledge"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledges/getpledge"}],"panels":[]}]},"httpPath":"/pledges/{tenantId}/{id}"},{"label":"Partially updates a pledge with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/patchpledge","routeSlug":"/apis/fundraising/fundraising-v1/pledges/patchpledge","metadata":{"seo":{"title":"Partially updates a pledge with the specified ID.","description":"This method will patch an existing pledge with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchPledge","name":"Partially updates a pledge with the specified ID.","isWebhook":false,"pointer":"/paths/~1pledges~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a pledge with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing pledge with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the pledge to patch.","required":true}],"pointer":"/paths/~1pledges~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"schemaId":"schema_521","pointer":"/paths/~1pledges~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/pledges/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_521"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/pledges/{tenantId}/{id}","href":"pledges/patchpledge","openApiOperationId":"patchPledge","summary":"Partially updates a pledge with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"schema_521","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The pledge was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pledge"}},"schemaId":"components/schemas/Pledge","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The pledge could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The pledge could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve pledge based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledges~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Pledge","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pledge"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledges/patchpledge"}],"panels":[]}]},"httpPath":"/pledges/{tenantId}/{id}"},{"label":"Updates a pledge with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/updatepledge","routeSlug":"/apis/fundraising/fundraising-v1/pledges/updatepledge","metadata":{"seo":{"title":"Updates a pledge with the specified ID.","description":"This method will update an existing pledge with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePledge","name":"Updates a pledge with the specified ID.","isWebhook":false,"pointer":"/paths/~1pledges~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a pledge with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing pledge with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the pledge to update.","required":true}],"pointer":"/paths/~1pledges~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Pledge"}},"schemaId":"components/schemas/Pledge","pointer":"/paths/~1pledges~1{tenantId}~1{id}/put/requestBody","description":"The updated pledge that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/pledges/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Pledge"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/pledges/{tenantId}/{id}","href":"pledges/updatepledge","openApiOperationId":"updatePledge","summary":"Updates a pledge with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Pledge","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Pledge"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The pledge was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pledge"}},"schemaId":"components/schemas/Pledge","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The pledge supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The pledge could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The pledge could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve pledge based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1pledges~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Pledge","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Pledge"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/pledges/updatepledge"}],"panels":[]}]},"httpPath":"/pledges/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Pledges"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pledges","showPageActions":true},{"nodeType":"markdoc","content":"Pledges"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/pledges/{tenantId}","summary":"Creates a new pledge record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pledges/createpledge","deprecated":false},{"title":"/pledges/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pledges/executebatchoperations","deprecated":false},{"title":"/pledges/{tenantId}/contact/{contact_id}","summary":"Returns a list of records with the specified contact_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pledges/listpledgesbycontactid","deprecated":false},{"title":"/pledges/{tenantId}/donor/{donor_id}","summary":"Returns a list of records with the specified donor_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pledges/listpledgesbydonorid","deprecated":false},{"title":"/pledges/{tenantId}/generateOrder","summary":"Generates an order from a fundraising pledge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pledges/generateorder","deprecated":false},{"title":"/pledges/{tenantId}/order/{order_id}","summary":"Returns a list of records with the specified order_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pledges/listpledgesbyorderid","deprecated":false},{"title":"/pledges/{tenantId}/organization/{organization_id}","summary":"Returns a list of records with the specified organization_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pledges/listpledgesbyorganizationid","deprecated":false},{"title":"/pledges/{tenantId}/previewEmail","summary":"Sends out a preview of the pledge notification email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pledges/previewemail","deprecated":false},{"title":"/pledges/{tenantId}/previewReceipt","summary":"Preview Pledge Receipt","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pledges/previewreceipt","deprecated":false},{"title":"/pledges/{tenantId}/process","summary":"Resend Receipt","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pledges/processpledge","deprecated":false},{"title":"/pledges/{tenantId}/public/process","summary":"Resend Receipt","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pledges/processpledgepublicly","deprecated":false},{"title":"/pledges/{tenantId}/resendReceipt/{id}","summary":"Resend Receipt","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pledges/resendreceipt","deprecated":false},{"title":"/pledges/{tenantId}/search","summary":"Searches for pledges using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pledges/searchforpledges","deprecated":false},{"title":"/pledges/{tenantId}/{id}","summary":"Returns a pledge from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/pledges/deletepledge","deprecated":false},{"title":"/pledges/{tenantId}/{id}","summary":"Returns a pledge from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pledges/getpledge","deprecated":false},{"title":"/pledges/{tenantId}/{id}","summary":"Partially updates a pledge with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/pledges/patchpledge","deprecated":false},{"title":"/pledges/{tenantId}/{id}","summary":"Updates a pledge with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/pledges/updatepledge","deprecated":false}]}]}]}]}},{"type":"group","label":"Premiums","link":"/apis/fundraising/fundraising-v1/premiums","routeSlug":"/apis/fundraising/fundraising-v1/premiums","items":[{"label":"Gets all of the premiums in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/premiums/listpremiums","routeSlug":"/apis/fundraising/fundraising-v1/premiums/listpremiums","metadata":{"seo":{"title":"Gets all of the premiums in the system.","description":"This method will scan all premiums and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPremiums","name":"Gets all of the premiums in the system.","isWebhook":false,"pointer":"/paths/~1premiums~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the premiums in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all premiums and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1premiums~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1premiums~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/premiums/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/premiums/{tenantId}","href":"premiums/listpremiums","openApiOperationId":"listPremiums","summary":"Gets all of the premiums in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The premiumswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_535"}},"schemaId":"schema_535","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1premiums~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_535","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_535"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/premiums/listpremiums"}],"panels":[]}]},"httpPath":"/premiums/{tenantId}"},{"label":"Creates a new premium record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/premiums/createpremium","routeSlug":"/apis/fundraising/fundraising-v1/premiums/createpremium","metadata":{"seo":{"title":"Creates a new premium record that does not already exist.","description":"This method will auto-generate an ID and create a new premium. If an ID is specified for the premium, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPremium","name":"Creates a new premium record that does not already exist.","isWebhook":false,"pointer":"/paths/~1premiums~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new premium record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new premium. If an ID is specified for the premium, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1premiums~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Premium"}},"schemaId":"components/schemas/Premium","pointer":"/paths/~1premiums~1{tenantId}/post/requestBody","description":"The premium that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/premiums/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Premium"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/premiums/{tenantId}","href":"premiums/createpremium","openApiOperationId":"createPremium","summary":"Creates a new premium record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Premium","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Premium"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The premium was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Premium"}},"schemaId":"components/schemas/Premium","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The premium you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The premium could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add premium based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1premiums~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Premium","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Premium"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/premiums/createpremium"}],"panels":[]}]},"httpPath":"/premiums/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/premiums/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/premiums/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1premiums~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1premiums~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1premiums~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/premiums/{tenantId}/batch","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/premiums/{tenantId}/batch","href":"premiums/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The premium could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve premium based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1premiums~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/premiums/executebatchoperations"}],"panels":[]}]},"httpPath":"/premiums/{tenantId}/batch"},{"label":"Returns a premium from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/premiums/deletepremium","routeSlug":"/apis/fundraising/fundraising-v1/premiums/deletepremium","metadata":{"seo":{"title":"Returns a premium from the system by its ID.","description":"This method will delete a premium with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePremium","name":"Returns a premium from the system by its ID.","isWebhook":false,"pointer":"/paths/~1premiums~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a premium from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a premium with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the premium to delete.","required":true}],"pointer":"/paths/~1premiums~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/premiums/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/premiums/{tenantId}/{id}","href":"premiums/deletepremium","openApiOperationId":"deletePremium","summary":"Returns a premium from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The premium was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The premium could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The premium could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to delete premium based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1premiums~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/premiums/deletepremium"}],"panels":[]}]},"httpPath":"/premiums/{tenantId}/{id}"},{"label":"Returns a premium from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/premiums/getpremium","routeSlug":"/apis/fundraising/fundraising-v1/premiums/getpremium","metadata":{"seo":{"title":"Returns a premium from the system by its ID.","description":"This method will look up a premium by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPremium","name":"Returns a premium from the system by its ID.","isWebhook":false,"pointer":"/paths/~1premiums~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a premium from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a premium by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the premium to return.","required":true}],"pointer":"/paths/~1premiums~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_518","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1premiums~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/premiums/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/premiums/{tenantId}/{id}","href":"premiums/getpremium","openApiOperationId":"getPremium","summary":"Returns a premium from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The premium was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Premium"}},"schemaId":"components/schemas/Premium","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The premium could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve premium based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1premiums~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Premium","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Premium"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/premiums/getpremium"}],"panels":[]}]},"httpPath":"/premiums/{tenantId}/{id}"},{"label":"Partially updates a premium with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/premiums/patchpremium","routeSlug":"/apis/fundraising/fundraising-v1/premiums/patchpremium","metadata":{"seo":{"title":"Partially updates a premium with the specified ID.","description":"This method will patch an existing premium with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchPremium","name":"Partially updates a premium with the specified ID.","isWebhook":false,"pointer":"/paths/~1premiums~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a premium with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing premium with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the premium to patch.","required":true}],"pointer":"/paths/~1premiums~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"schemaId":"schema_521","pointer":"/paths/~1premiums~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/premiums/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_521"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/premiums/{tenantId}/{id}","href":"premiums/patchpremium","openApiOperationId":"patchPremium","summary":"Partially updates a premium with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"schema_521","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The premium was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Premium"}},"schemaId":"components/schemas/Premium","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The premium could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The premium could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve premium based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1premiums~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Premium","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Premium"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/premiums/patchpremium"}],"panels":[]}]},"httpPath":"/premiums/{tenantId}/{id}"},{"label":"Updates a premium with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/premiums/updatepremium","routeSlug":"/apis/fundraising/fundraising-v1/premiums/updatepremium","metadata":{"seo":{"title":"Updates a premium with the specified ID.","description":"This method will update an existing premium with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePremium","name":"Updates a premium with the specified ID.","isWebhook":false,"pointer":"/paths/~1premiums~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a premium with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing premium with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the premium to update.","required":true}],"pointer":"/paths/~1premiums~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Premium"}},"schemaId":"components/schemas/Premium","pointer":"/paths/~1premiums~1{tenantId}~1{id}/put/requestBody","description":"The updated premium that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/premiums/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Premium"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/premiums/{tenantId}/{id}","href":"premiums/updatepremium","openApiOperationId":"updatePremium","summary":"Updates a premium with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Premium","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Premium"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The premium was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Premium"}},"schemaId":"components/schemas/Premium","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The premium supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The premium could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The premium could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve premium based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1premiums~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Premium","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Premium"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/premiums/updatepremium"}],"panels":[]}]},"httpPath":"/premiums/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Premiums"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Premiums","showPageActions":true},{"nodeType":"markdoc","content":"Premiums"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/premiums/{tenantId}","summary":"Gets all of the premiums in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/premiums/listpremiums","deprecated":false},{"title":"/premiums/{tenantId}","summary":"Creates a new premium record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/premiums/createpremium","deprecated":false},{"title":"/premiums/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/premiums/executebatchoperations","deprecated":false},{"title":"/premiums/{tenantId}/{id}","summary":"Returns a premium from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/premiums/deletepremium","deprecated":false},{"title":"/premiums/{tenantId}/{id}","summary":"Returns a premium from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/premiums/getpremium","deprecated":false},{"title":"/premiums/{tenantId}/{id}","summary":"Partially updates a premium with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/premiums/patchpremium","deprecated":false},{"title":"/premiums/{tenantId}/{id}","summary":"Updates a premium with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/premiums/updatepremium","deprecated":false}]}]}]}]}},{"type":"group","label":"Products","link":"/apis/fundraising/fundraising-v1/products","routeSlug":"/apis/fundraising/fundraising-v1/products","items":[{"label":"Gets all of the products in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/products/listproducts","routeSlug":"/apis/fundraising/fundraising-v1/products/listproducts","metadata":{"seo":{"title":"Gets all of the products in the system.","description":"This method will scan all products and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProducts","name":"Gets all of the products in the system.","isWebhook":false,"pointer":"/paths/~1products~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the products in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all products and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1products~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1products~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/products/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/products/{tenantId}","href":"products/listproducts","openApiOperationId":"listProducts","summary":"Gets all of the products in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The productswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_536"}},"schemaId":"schema_536","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1products~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_536","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_536"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/listproducts"}],"panels":[]}]},"httpPath":"/products/{tenantId}"},{"label":"Creates a new product record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/products/createproduct","routeSlug":"/apis/fundraising/fundraising-v1/products/createproduct","metadata":{"seo":{"title":"Creates a new product record that does not already exist.","description":"This method will auto-generate an ID and create a new product. If an ID is specified for the product, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProduct","name":"Creates a new product record that does not already exist.","isWebhook":false,"pointer":"/paths/~1products~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new product record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new product. If an ID is specified for the product, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1products~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Product"}},"schemaId":"components/schemas/Product","pointer":"/paths/~1products~1{tenantId}/post/requestBody","description":"The product that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/products/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Product"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/products/{tenantId}","href":"products/createproduct","openApiOperationId":"createProduct","summary":"Creates a new product record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Product","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Product"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Product"}},"schemaId":"components/schemas/Product","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The product you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The product could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1products~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Product","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Product"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/createproduct"}],"panels":[]}]},"httpPath":"/products/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/products/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/products/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1products~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1products~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1products~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/products/{tenantId}/batch","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/products/{tenantId}/batch","href":"products/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1products~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/executebatchoperations"}],"panels":[]}]},"httpPath":"/products/{tenantId}/batch"},{"label":"Returns a list of records with the specified fund_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/products/listproductsbyfundid","routeSlug":"/apis/fundraising/fundraising-v1/products/listproductsbyfundid","metadata":{"seo":{"title":"Returns a list of records with the specified fund_id","description":"Returns a list of records with the specified fund_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProductsByFundId","name":"Returns a list of records with the specified fund_id","isWebhook":false,"pointer":"/paths/~1products~1{tenantId}~1fund~1{fund_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified fund_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified fund_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true},{"name":"fund_id","in":"path","schemaId":"schema_518","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fund_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1products~1{tenantId}~1fund~1{fund_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1products~1{tenantId}~1fund~1{fund_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/products/{tenantId}/fund/{fund_id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"fund_id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/products/{tenantId}/fund/{fund_id}","href":"products/listproductsbyfundid","openApiOperationId":"listProductsByFundId","summary":"Returns a list of records with the specified fund_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListProductsResponse"}},"schemaId":"components/schemas/ListProductsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1products~1{tenantId}~1fund~1{fund_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListProductsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListProductsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/listproductsbyfundid"}],"panels":[]}]},"httpPath":"/products/{tenantId}/fund/{fund_id}"},{"label":"Returns a product from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/products/deleteproduct","routeSlug":"/apis/fundraising/fundraising-v1/products/deleteproduct","metadata":{"seo":{"title":"Returns a product from the system by its ID.","description":"This method will delete a product with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProduct","name":"Returns a product from the system by its ID.","isWebhook":false,"pointer":"/paths/~1products~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a product from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a product with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the product to delete.","required":true}],"pointer":"/paths/~1products~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/products/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/products/{tenantId}/{id}","href":"products/deleteproduct","openApiOperationId":"deleteProduct","summary":"Returns a product from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The product could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to delete product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1products~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/deleteproduct"}],"panels":[]}]},"httpPath":"/products/{tenantId}/{id}"},{"label":"Returns a product from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/products/getproduct","routeSlug":"/apis/fundraising/fundraising-v1/products/getproduct","metadata":{"seo":{"title":"Returns a product from the system by its ID.","description":"This method will look up a product by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProduct","name":"Returns a product from the system by its ID.","isWebhook":false,"pointer":"/paths/~1products~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a product from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a product by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the product to return.","required":true}],"pointer":"/paths/~1products~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_518","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1products~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/products/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/products/{tenantId}/{id}","href":"products/getproduct","openApiOperationId":"getProduct","summary":"Returns a product from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Product"}},"schemaId":"components/schemas/Product","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1products~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Product","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Product"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/getproduct"}],"panels":[]}]},"httpPath":"/products/{tenantId}/{id}"},{"label":"Partially updates a product with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/products/patchproduct","routeSlug":"/apis/fundraising/fundraising-v1/products/patchproduct","metadata":{"seo":{"title":"Partially updates a product with the specified ID.","description":"This method will patch an existing product with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchProduct","name":"Partially updates a product with the specified ID.","isWebhook":false,"pointer":"/paths/~1products~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a product with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing product with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the product to patch.","required":true}],"pointer":"/paths/~1products~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"schemaId":"schema_521","pointer":"/paths/~1products~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/products/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_521"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/products/{tenantId}/{id}","href":"products/patchproduct","openApiOperationId":"patchProduct","summary":"Partially updates a product with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"schema_521","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Product"}},"schemaId":"components/schemas/Product","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The product could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1products~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Product","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Product"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/patchproduct"}],"panels":[]}]},"httpPath":"/products/{tenantId}/{id}"},{"label":"Updates a product with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/products/updateproduct","routeSlug":"/apis/fundraising/fundraising-v1/products/updateproduct","metadata":{"seo":{"title":"Updates a product with the specified ID.","description":"This method will update an existing product with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProduct","name":"Updates a product with the specified ID.","isWebhook":false,"pointer":"/paths/~1products~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a product with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing product with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the product to update.","required":true}],"pointer":"/paths/~1products~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Product"}},"schemaId":"components/schemas/Product","pointer":"/paths/~1products~1{tenantId}~1{id}/put/requestBody","description":"The updated product that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/products/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Product"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/products/{tenantId}/{id}","href":"products/updateproduct","openApiOperationId":"updateProduct","summary":"Updates a product with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Product","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Product"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Product"}},"schemaId":"components/schemas/Product","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The product supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The product could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1products~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Product","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Product"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/products/updateproduct"}],"panels":[]}]},"httpPath":"/products/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Products","showPageActions":true},{"nodeType":"markdoc","content":"Products"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/products/{tenantId}","summary":"Gets all of the products in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/listproducts","deprecated":false},{"title":"/products/{tenantId}","summary":"Creates a new product record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/products/createproduct","deprecated":false},{"title":"/products/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/products/executebatchoperations","deprecated":false},{"title":"/products/{tenantId}/fund/{fund_id}","summary":"Returns a list of records with the specified fund_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/listproductsbyfundid","deprecated":false},{"title":"/products/{tenantId}/{id}","summary":"Returns a product from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/products/deleteproduct","deprecated":false},{"title":"/products/{tenantId}/{id}","summary":"Returns a product from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/products/getproduct","deprecated":false},{"title":"/products/{tenantId}/{id}","summary":"Partially updates a product with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/products/patchproduct","deprecated":false},{"title":"/products/{tenantId}/{id}","summary":"Updates a product with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/products/updateproduct","deprecated":false}]}]}]}]}},{"type":"group","label":"Query Definitions","link":"/apis/fundraising/fundraising-v1/query-definitions","routeSlug":"/apis/fundraising/fundraising-v1/query-definitions","items":[{"label":"Returns a list of records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/query-definitions/getquerydefinitions","routeSlug":"/apis/fundraising/fundraising-v1/query-definitions/getquerydefinitions","metadata":{"seo":{"title":"Returns a list of records","description":"Returns a list of records"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getQueryDefinitions","name":"Returns a list of records","isWebhook":false,"pointer":"/paths/~1queryDefinitions~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of records"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true}],"pointer":"/paths/~1queryDefinitions~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/queryDefinitions/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/queryDefinitions/{tenantId}","href":"query-definitions/getquerydefinitions","openApiOperationId":"getQueryDefinitions","summary":"Returns a list of records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListStandardQueryDefinitionsResponse"}},"schemaId":"components/schemas/ListStandardQueryDefinitionsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1queryDefinitions~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListStandardQueryDefinitionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListStandardQueryDefinitionsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/query-definitions/getquerydefinitions"}],"panels":[]}]},"httpPath":"/queryDefinitions/{tenantId}"}],"content":{"contentType":"group","meta":{"name":"Query Definitions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query Definitions","showPageActions":true},{"nodeType":"markdoc","content":"Query Definitions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/queryDefinitions/{tenantId}","summary":"Returns a list of records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/query-definitions/getquerydefinitions","deprecated":false}]}]}]}]}},{"type":"group","label":"Recurring Gifts","link":"/apis/fundraising/fundraising-v1/recurring-gifts","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts","items":[{"label":"Gets all of the recurring gifts in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/recurring-gifts/listrecurringgifts","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts/listrecurringgifts","metadata":{"seo":{"title":"Gets all of the recurring gifts in the system.","description":"This method will scan all recurring gifts and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRecurringGifts","name":"Gets all of the recurring gifts in the system.","isWebhook":false,"pointer":"/paths/~1recurringGifts~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the recurring gifts in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all recurring gifts and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1recurringGifts~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1recurringGifts~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/recurringGifts/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/recurringGifts/{tenantId}","href":"recurring-gifts/listrecurringgifts","openApiOperationId":"listRecurringGifts","summary":"Gets all of the recurring gifts in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring giftswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_537"}},"schemaId":"schema_537","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1recurringGifts~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_537","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_537"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-gifts/listrecurringgifts"}],"panels":[]}]},"httpPath":"/recurringGifts/{tenantId}"},{"label":"Creates a new recurring gift record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/recurring-gifts/createrecurringgift","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts/createrecurringgift","metadata":{"seo":{"title":"Creates a new recurring gift record that does not already exist.","description":"This method will auto-generate an ID and create a new recurring gift. If an ID is specified for the recurring gift, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRecurringGift","name":"Creates a new recurring gift record that does not already exist.","isWebhook":false,"pointer":"/paths/~1recurringGifts~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new recurring gift record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new recurring gift. If an ID is specified for the recurring gift, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1recurringGifts~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RecurringGift"}},"schemaId":"components/schemas/RecurringGift","pointer":"/paths/~1recurringGifts~1{tenantId}/post/requestBody","description":"The recurring gift that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/recurringGifts/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RecurringGift"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/recurringGifts/{tenantId}","href":"recurring-gifts/createrecurringgift","openApiOperationId":"createRecurringGift","summary":"Creates a new recurring gift record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/RecurringGift","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RecurringGift"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring gift was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringGift"}},"schemaId":"components/schemas/RecurringGift","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The recurring gift you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The recurring gift could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add recurring gift based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1recurringGifts~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RecurringGift","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringGift"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-gifts/createrecurringgift"}],"panels":[]}]},"httpPath":"/recurringGifts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/recurring-gifts/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1recurringGifts~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1recurringGifts~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1recurringGifts~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/recurringGifts/{tenantId}/batch","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/recurringGifts/{tenantId}/batch","href":"recurring-gifts/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The recurring gift could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve recurring gift based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1recurringGifts~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-gifts/executebatchoperations"}],"panels":[]}]},"httpPath":"/recurringGifts/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/recurring-gifts/listrecurringgiftsbycontactid","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts/listrecurringgiftsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRecurringGiftsByContactId","name":"Returns a list of records with the specified contact_id","isWebhook":false,"pointer":"/paths/~1recurringGifts~1{tenantId}~1contact~1{contact_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified contact_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified contact_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true},{"name":"contact_id","in":"path","schemaId":"schema_518","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1recurringGifts~1{tenantId}~1contact~1{contact_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1recurringGifts~1{tenantId}~1contact~1{contact_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/recurringGifts/{tenantId}/contact/{contact_id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"contact_id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/recurringGifts/{tenantId}/contact/{contact_id}","href":"recurring-gifts/listrecurringgiftsbycontactid","openApiOperationId":"listRecurringGiftsByContactId","summary":"Returns a list of records with the specified contact_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRecurringGiftsResponse"}},"schemaId":"components/schemas/ListRecurringGiftsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1recurringGifts~1{tenantId}~1contact~1{contact_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListRecurringGiftsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRecurringGiftsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-gifts/listrecurringgiftsbycontactid"}],"panels":[]}]},"httpPath":"/recurringGifts/{tenantId}/contact/{contact_id}"},{"label":"Returns a list of records with the specified donor_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/recurring-gifts/listgiftsbydonorid","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts/listgiftsbydonorid","metadata":{"seo":{"title":"Returns a list of records with the specified donor_id","description":"Returns a list of records with the specified donor_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGiftsByDonorId","name":"Returns a list of records with the specified donor_id","isWebhook":false,"pointer":"/paths/~1recurringGifts~1{tenantId}~1donor~1{donor_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified donor_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified donor_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true},{"name":"donor_id","in":"path","schemaId":"schema_518","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The donor_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1recurringGifts~1{tenantId}~1donor~1{donor_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1recurringGifts~1{tenantId}~1donor~1{donor_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/recurringGifts/{tenantId}/donor/{donor_id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"donor_id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/recurringGifts/{tenantId}/donor/{donor_id}","href":"recurring-gifts/listgiftsbydonorid","openApiOperationId":"listGiftsByDonorId","summary":"Returns a list of records with the specified donor_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRecurringGiftsResponse"}},"schemaId":"components/schemas/ListRecurringGiftsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1recurringGifts~1{tenantId}~1donor~1{donor_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListRecurringGiftsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRecurringGiftsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-gifts/listgiftsbydonorid"}],"panels":[]}]},"httpPath":"/recurringGifts/{tenantId}/donor/{donor_id}"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/recurring-gifts/listrecurringgiftsbyorganizationid","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts/listrecurringgiftsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRecurringGiftsByOrganizationId","name":"Returns a list of records with the specified organization_id","isWebhook":false,"pointer":"/paths/~1recurringGifts~1{tenantId}~1organization~1{organization_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified organization_id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of records with the specified organization_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The tenant","required":true},{"name":"organization_id","in":"path","schemaId":"schema_518","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1recurringGifts~1{tenantId}~1organization~1{organization_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1recurringGifts~1{tenantId}~1organization~1{organization_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/recurringGifts/{tenantId}/organization/{organization_id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"organization_id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/recurringGifts/{tenantId}/organization/{organization_id}","href":"recurring-gifts/listrecurringgiftsbyorganizationid","openApiOperationId":"listRecurringGiftsByOrganizationId","summary":"Returns a list of records with the specified organization_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRecurringGiftsResponse"}},"schemaId":"components/schemas/ListRecurringGiftsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1recurringGifts~1{tenantId}~1organization~1{organization_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListRecurringGiftsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRecurringGiftsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-gifts/listrecurringgiftsbyorganizationid"}],"panels":[]}]},"httpPath":"/recurringGifts/{tenantId}/organization/{organization_id}"},{"label":"Searches for recurring gifts using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/recurring-gifts/searchforrecurringgifts","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts/searchforrecurringgifts","metadata":{"seo":{"title":"Searches for recurring gifts using predefined parameters","description":"Searches for recurring gifts using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForRecurringGifts","name":"Searches for recurring gifts using predefined parameters","isWebhook":false,"pointer":"/paths/~1recurringGifts~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for recurring gifts using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for recurring gifts using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1recurringGifts~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_518","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_518","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1recurringGifts~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RecurringGiftSearchParameters"}},"schemaId":"components/schemas/RecurringGiftSearchParameters","pointer":"/paths/~1recurringGifts~1{tenantId}~1search/post/requestBody","description":"The recurring gift that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/recurringGifts/{tenantId}/search","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_518"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RecurringGiftSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/recurringGifts/{tenantId}/search","href":"recurring-gifts/searchforrecurringgifts","openApiOperationId":"searchForRecurringGifts","summary":"Searches for recurring gifts using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/RecurringGiftSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RecurringGiftSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring gift search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedRecurringGiftSearchResults"}},"schemaId":"components/schemas/PagedRecurringGiftSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The recurring gift you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The recurring gift could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add recurring gift based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1recurringGifts~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedRecurringGiftSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedRecurringGiftSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-gifts/searchforrecurringgifts"}],"panels":[]}]},"httpPath":"/recurringGifts/{tenantId}/search"},{"label":"Returns a recurring gift from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/recurring-gifts/deleterecurringgift","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts/deleterecurringgift","metadata":{"seo":{"title":"Returns a recurring gift from the system by its ID.","description":"This method will delete a recurring gift with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRecurringGift","name":"Returns a recurring gift from the system by its ID.","isWebhook":false,"pointer":"/paths/~1recurringGifts~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a recurring gift from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a recurring gift with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the recurring gift to delete.","required":true}],"pointer":"/paths/~1recurringGifts~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/recurringGifts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/recurringGifts/{tenantId}/{id}","href":"recurring-gifts/deleterecurringgift","openApiOperationId":"deleteRecurringGift","summary":"Returns a recurring gift from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring gift was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The recurring gift could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The recurring gift could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to delete recurring gift based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1recurringGifts~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-gifts/deleterecurringgift"}],"panels":[]}]},"httpPath":"/recurringGifts/{tenantId}/{id}"},{"label":"Returns a recurring gift from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/recurring-gifts/getrecurringgift","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts/getrecurringgift","metadata":{"seo":{"title":"Returns a recurring gift from the system by its ID.","description":"This method will look up a recurring gift by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRecurringGift","name":"Returns a recurring gift from the system by its ID.","isWebhook":false,"pointer":"/paths/~1recurringGifts~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a recurring gift from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a recurring gift by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the recurring gift to return.","required":true}],"pointer":"/paths/~1recurringGifts~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_518","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1recurringGifts~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/recurringGifts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/recurringGifts/{tenantId}/{id}","href":"recurring-gifts/getrecurringgift","openApiOperationId":"getRecurringGift","summary":"Returns a recurring gift from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring gift was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringGift"}},"schemaId":"components/schemas/RecurringGift","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The recurring gift could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve recurring gift based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1recurringGifts~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RecurringGift","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringGift"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-gifts/getrecurringgift"}],"panels":[]}]},"httpPath":"/recurringGifts/{tenantId}/{id}"},{"label":"Partially updates a recurring gift with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/recurring-gifts/patchrecurringgift","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts/patchrecurringgift","metadata":{"seo":{"title":"Partially updates a recurring gift with the specified ID.","description":"This method will patch an existing recurring gift with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchRecurringGift","name":"Partially updates a recurring gift with the specified ID.","isWebhook":false,"pointer":"/paths/~1recurringGifts~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a recurring gift with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing recurring gift with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the recurring gift to patch.","required":true}],"pointer":"/paths/~1recurringGifts~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"schemaId":"schema_521","pointer":"/paths/~1recurringGifts~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/recurringGifts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_521"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/recurringGifts/{tenantId}/{id}","href":"recurring-gifts/patchrecurringgift","openApiOperationId":"patchRecurringGift","summary":"Partially updates a recurring gift with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"schema_521","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring gift was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringGift"}},"schemaId":"components/schemas/RecurringGift","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The recurring gift could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The recurring gift could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve recurring gift based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1recurringGifts~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RecurringGift","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringGift"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-gifts/patchrecurringgift"}],"panels":[]}]},"httpPath":"/recurringGifts/{tenantId}/{id}"},{"label":"Updates a recurring gift with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/recurring-gifts/updaterecurringgift","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts/updaterecurringgift","metadata":{"seo":{"title":"Updates a recurring gift with the specified ID.","description":"This method will update an existing recurring gift with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRecurringGift","name":"Updates a recurring gift with the specified ID.","isWebhook":false,"pointer":"/paths/~1recurringGifts~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a recurring gift with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing recurring gift with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the recurring gift to update.","required":true}],"pointer":"/paths/~1recurringGifts~1{tenantId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RecurringGift"}},"schemaId":"components/schemas/RecurringGift","pointer":"/paths/~1recurringGifts~1{tenantId}~1{id}/put/requestBody","description":"The updated recurring gift that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/recurringGifts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RecurringGift"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/recurringGifts/{tenantId}/{id}","href":"recurring-gifts/updaterecurringgift","openApiOperationId":"updateRecurringGift","summary":"Updates a recurring gift with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/RecurringGift","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RecurringGift"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring gift was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringGift"}},"schemaId":"components/schemas/RecurringGift","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The recurring gift supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The recurring gift could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The recurring gift could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve recurring gift based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1recurringGifts~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RecurringGift","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringGift"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-gifts/updaterecurringgift"}],"panels":[]}]},"httpPath":"/recurringGifts/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Recurring Gifts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Recurring Gifts","showPageActions":true},{"nodeType":"markdoc","content":"Recurring Gifts"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/recurringGifts/{tenantId}","summary":"Gets all of the recurring gifts in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/recurring-gifts/listrecurringgifts","deprecated":false},{"title":"/recurringGifts/{tenantId}","summary":"Creates a new recurring gift record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/recurring-gifts/createrecurringgift","deprecated":false},{"title":"/recurringGifts/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/recurring-gifts/executebatchoperations","deprecated":false},{"title":"/recurringGifts/{tenantId}/contact/{contact_id}","summary":"Returns a list of records with the specified contact_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/recurring-gifts/listrecurringgiftsbycontactid","deprecated":false},{"title":"/recurringGifts/{tenantId}/donor/{donor_id}","summary":"Returns a list of records with the specified donor_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/recurring-gifts/listgiftsbydonorid","deprecated":false},{"title":"/recurringGifts/{tenantId}/organization/{organization_id}","summary":"Returns a list of records with the specified organization_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/recurring-gifts/listrecurringgiftsbyorganizationid","deprecated":false},{"title":"/recurringGifts/{tenantId}/search","summary":"Searches for recurring gifts using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/recurring-gifts/searchforrecurringgifts","deprecated":false},{"title":"/recurringGifts/{tenantId}/{id}","summary":"Returns a recurring gift from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/recurring-gifts/deleterecurringgift","deprecated":false},{"title":"/recurringGifts/{tenantId}/{id}","summary":"Returns a recurring gift from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/recurring-gifts/getrecurringgift","deprecated":false},{"title":"/recurringGifts/{tenantId}/{id}","summary":"Partially updates a recurring gift with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/recurring-gifts/patchrecurringgift","deprecated":false},{"title":"/recurringGifts/{tenantId}/{id}","summary":"Updates a recurring gift with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/recurring-gifts/updaterecurringgift","deprecated":false}]}]}]}]}},{"type":"group","label":"Settings","link":"/apis/fundraising/fundraising-v1/settings","routeSlug":"/apis/fundraising/fundraising-v1/settings","items":[{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/settings/deletesetting","routeSlug":"/apis/fundraising/fundraising-v1/settings/deletesetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will delete a setting with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSetting","name":"Returns a setting from the system by its ID.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a setting from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a setting with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/settings/{tenantId}","href":"settings/deletesetting","openApiOperationId":"deleteSetting","summary":"Returns a setting from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The setting could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to delete setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1settings~1{tenantId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/deletesetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"},{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/settings/getsetting","routeSlug":"/apis/fundraising/fundraising-v1/settings/getsetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will look up a setting by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSetting","name":"Returns a setting from the system by its ID.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a setting from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a setting by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_518","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_518","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1settings~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_518"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_518"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/settings/{tenantId}","href":"settings/getsetting","openApiOperationId":"getSetting","summary":"Returns a setting from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1settings~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/getsetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"},{"label":"Partially updates a setting with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/settings/patchsetting","routeSlug":"/apis/fundraising/fundraising-v1/settings/patchsetting","metadata":{"seo":{"title":"Partially updates a setting with the specified ID.","description":"This method will patch an existing setting with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchSetting","name":"Partially updates a setting with the specified ID.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a setting with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing setting with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"schemaId":"schema_521","pointer":"/paths/~1settings~1{tenantId}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_521"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/settings/{tenantId}","href":"settings/patchsetting","openApiOperationId":"patchSetting","summary":"Partially updates a setting with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"schema_521","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_521"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The setting could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1settings~1{tenantId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/patchsetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"},{"label":"Creates a new setting record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/settings/createsetting","routeSlug":"/apis/fundraising/fundraising-v1/settings/createsetting","metadata":{"seo":{"title":"Creates a new setting record that does not already exist.","description":"This method will auto-generate an ID and create a new setting. If an ID is specified for the setting, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSetting","name":"Creates a new setting record that does not already exist.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new setting record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new setting. If an ID is specified for the setting, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","pointer":"/paths/~1settings~1{tenantId}/post/requestBody","description":"The setting that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Setting"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/settings/{tenantId}","href":"settings/createsetting","openApiOperationId":"createSetting","summary":"Creates a new setting record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Setting"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The setting you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The setting could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to add setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1settings~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/createsetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"},{"label":"Updates a setting with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/settings/updatesetting","routeSlug":"/apis/fundraising/fundraising-v1/settings/updatesetting","metadata":{"seo":{"title":"Updates a setting with the specified ID.","description":"This method will update an existing setting with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSetting","name":"Updates a setting with the specified ID.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a setting with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing setting with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","pointer":"/paths/~1settings~1{tenantId}/put/requestBody","description":"The updated setting that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Setting"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/settings/{tenantId}","href":"settings/updatesetting","openApiOperationId":"updateSetting","summary":"Updates a setting with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Setting"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The setting supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"409","description":"The setting could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1settings~1{tenantId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/updatesetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"}],"content":{"contentType":"group","meta":{"name":"Settings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Settings","showPageActions":true},{"nodeType":"markdoc","content":"Settings"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/settings/{tenantId}","summary":"Returns a setting from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/settings/deletesetting","deprecated":false},{"title":"/settings/{tenantId}","summary":"Returns a setting from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settings/getsetting","deprecated":false},{"title":"/settings/{tenantId}","summary":"Partially updates a setting with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/settings/patchsetting","deprecated":false},{"title":"/settings/{tenantId}","summary":"Creates a new setting record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/settings/createsetting","deprecated":false},{"title":"/settings/{tenantId}","summary":"Updates a setting with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/settings/updatesetting","deprecated":false}]}]}]}]}},{"type":"group","label":"Statistics","link":"/apis/fundraising/fundraising-v1/statistics","routeSlug":"/apis/fundraising/fundraising-v1/statistics","items":[{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/statistics/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/statistics/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1statistics~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1statistics~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1statistics~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/statistics/{tenantId}/batch","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statistics/{tenantId}/batch","href":"statistics/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The statistic could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve statistic based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1statistics~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statistics/executebatchoperations"}],"panels":[]}]},"httpPath":"/statistics/{tenantId}/batch"},{"label":"Returns a statistic from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/statistics/getstatistic","routeSlug":"/apis/fundraising/fundraising-v1/statistics/getstatistic","metadata":{"seo":{"title":"Returns a statistic from the system by its ID.","description":"This method will look up a statistic by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStatistic","name":"Returns a statistic from the system by its ID.","isWebhook":false,"pointer":"/paths/~1statistics~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a statistic from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a statistic by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_518","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_518","description":"The ID of the statistic to return.","required":true}],"pointer":"/paths/~1statistics~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"parameters","in":"query","schemaId":"schema_518","description":"Parameters to the query"},{"name":"recalculate","in":"query","schemaId":"schema_538","description":"If true, the latest statistic will be calculated and the cache will be updated"}],"pointer":"/paths/~1statistics~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/statistics/{tenantId}/{id}","servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_518"},{"name":"id","in":"path","required":true,"schemaId":"schema_518"}],"query":[{"name":"parameters","in":"query","required":false,"schemaId":"schema_518"},{"name":"recalculate","in":"query","required":false,"schemaId":"schema_538"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statistics/{tenantId}/{id}","href":"statistics/getstatistic","openApiOperationId":"getStatistic","summary":"Returns a statistic from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","description":"Mock server","isMockServer":true},{"url":"https://fundraising.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The statistic was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Statistic"}},"schemaId":"components/schemas/Statistic","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"404","description":"The statistic could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"429","description":"Limit exceeded... unable to retrieve statistic based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_520"}],"pointer":"/paths/~1statistics~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Statistic","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Statistic"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statistics/getstatistic"}],"panels":[]}]},"httpPath":"/statistics/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Statistics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Statistics","showPageActions":true},{"nodeType":"markdoc","content":"Statistics"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/statistics/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/statistics/executebatchoperations","deprecated":false},{"title":"/statistics/{tenantId}/{id}","summary":"Returns a statistic from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statistics/getstatistic","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"additionalProperties":false,"description":"A complete address","properties":{"city":{"description":"The city of the address","title":"City","type":"string"},"country":{"description":"The country ISO code","title":"Country","type":"string"},"country_name":{"description":"The full name of hte country","title":"Country Name","type":"string"},"county":{"description":"The county","title":"County","type":"string"},"latitude":{"format":"double","title":"Latitude","type":"number"},"line1":{"description":"The first line of the address","title":"Line 1","type":"string"},"line2":{"description":"The second line of the address","title":"Line 2","type":"string"},"line3":{"description":"The third line of the address","title":"Line 3","type":"string"},"longitude":{"format":"double","title":"Longitude","type":"number"},"postal_code":{"description":"The zip/postal code","title":"Postal Code","type":"string"},"state":{"description":"The state/province of the address","title":"State","type":"string"},"time_zone_id":{"title":"Time Zone","type":"string"}},"type":"object"}},"components/schemas/Appeal":{"id":"components/schemas/Appeal","kind":"json-schema","title":"Appeal","data":{"additionalProperties":false,"properties":{"campaign_id":{"description":"The campaign to which this appeal is linked","title":"Campaign","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"fundraising_products":{"items":{"additionalProperties":false,"properties":{"fund_id":{"description":"The fund","title":"Fund","type":"string"},"product_id":{"description":"The product","title":"Product","type":"string"}},"required":["fund_id","product_id"],"type":"object"},"minItems":1,"type":"array"},"goal":{"description":"Goal for the appeal","format":"float","title":"Goal","type":"number"},"id":{"description":"The unique, string identifier of this appeal","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"name":{"description":"The name of the appeal","title":"Name","type":"string"},"notes":{"description":"The notes for the appeal","title":"Notes","type":"string"},"override_fundraising_products":{"description":"If true, specific products are used for gifts in this campaign","title":"Override Fundraising Products","type":"boolean"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["campaign_id","fundraising_products","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/AppealSearchParameters":{"id":"components/schemas/AppealSearchParameters","kind":"json-schema","title":"AppealSearchParameters","data":{"additionalProperties":false,"properties":{"date":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Date","type":"array"},"goal":{"format":"float","title":"Goal","type":"number"},"ids":{"description":"IDs to search","items":{"type":"string"},"title":"Ids","type":"array"},"name":{"title":"Name","type":"string"}},"type":"object"}},"components/schemas/AppealSearchResults":{"id":"components/schemas/AppealSearchResults","kind":"json-schema","title":"AppealSearchResults","data":{"additionalProperties":false,"properties":{"end_date":{"description":"The end date of the appeal","format":"date-time","title":"End Date","type":"string"},"goal":{"description":"The gaol for the appeal","format":"float","title":"Goal","type":"number"},"id":{"description":"The id","title":"ID","type":"string"},"is_active":{"description":"Is the appeal active","title":"Is Active","type":"boolean"},"name":{"description":"The name","title":"Name","type":"string"},"start_date":{"description":"The start date of the appeal","format":"date-time","title":"Start Date","type":"string"}},"type":"object"}},"components/schemas/BatchOperationRequest":{"id":"components/schemas/BatchOperationRequest","kind":"json-schema","title":"BatchOperationRequest","data":{"additionalProperties":false,"properties":{"operations":{"items":{"additionalProperties":false,"properties":{"id":{"description":"The ID of the record","oneOf":[{"x-required":true}],"title":"ID","type":"string"},"object":{"title":"Object","type":"object"},"operation":{"enum":["create","delete","patch","read","update"],"title":"Operation","type":"string"},"patch_directives":{"items":{"additionalProperties":false,"properties":{"op":{"description":"The operation","enum":["add","copy","move","remove","replace","test"],"title":"Op","type":"string"},"path":{"description":"The JSON path","title":"Path","type":"string"},"value":{"title":"Value","type":"string"}},"required":["op","path"],"type":"object"},"maxItems":100,"minItems":1,"oneOf":[{"x-required":true}],"type":"array"}},"required":["operation"],"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/BatchOperationResponse":{"id":"components/schemas/BatchOperationResponse","kind":"json-schema","title":"BatchOperationResponse","data":{"additionalProperties":false,"properties":{"error_count":{"description":"Number of error results","format":"float","title":"Error Count","type":"number"},"results":{"items":{"additionalProperties":false,"properties":{"error_message":{"title":"Error Message","type":"string"},"id":{"description":"The ID of the record","title":"ID","type":"string"},"object":{"title":"Object","type":"object"},"operation":{"enum":["create","delete","patch","read","update"],"title":"Operation","type":"string"},"outcome":{"enum":["error","no change","success"],"title":"Outcome","type":"string"}},"required":["id","operation"],"type":"object"},"type":"array"},"success_count":{"description":"Number of successful results","format":"float","title":"Success Count","type":"number"}},"type":"object"}},"components/schemas/BillingTemplate":{"id":"components/schemas/BillingTemplate","kind":"json-schema","title":"BillingTemplate","data":{"properties":{"advance_phases":{"description":"When true, training providers should be sent invoices for training registrations","title":"Advance Phases","type":"boolean"},"description":{"description":"A description of the template","title":"Description","type":"string"},"fundraising_notice_options":{"properties":{"expiration_date_range_end":{"description":"The date to use to filter out which memberships are candidate","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"title":"Unit Of Time","type":"string"}},"required":["position","relative_to"],"title":"Expiration Date Range End","type":"object"},"expiration_date_range_start":{"description":"The date to use to filter out which memberships are candidate","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"title":"Unit Of Time","type":"string"}},"required":["position","relative_to"],"title":"Expiration Date Range Start","type":"object"},"notice_id":{"description":"The notice to send the school","title":"Notice","type":"string"},"phase_ids":{"items":{"type":"string"},"minItems":1,"title":"Phases","type":"array"},"phase_restriction":{"description":"Determines if/how to restrict the programs in this run","enum":["exclude","include","none"],"title":"Phase Restriction","type":"string"},"program_ids":{"items":{"type":"string"},"minItems":1,"title":"Programs","type":"array"},"program_restriction":{"description":"Determines if/how to restrict the programs in this run","enum":["exclude","include","none"],"title":"Program Restriction","type":"string"},"school_ids":{"items":{"type":"string"},"minItems":1,"title":"Schools","type":"array"},"school_restriction":{"description":"Determines if/how to restrict the programs in this run","enum":["exclude","include","none"],"title":"School Restriction","type":"string"}},"required":["expiration_date_range_end","expiration_date_range_start","phase_ids","program_ids","school_ids"],"title":"Fundraising Notice Options","type":"object"},"id":{"description":"The unique, string identifier of this billing template","pattern":"/^[\\w|-]+$/","title":"ID","type":"string"},"is_active":{"description":"Whether or not this billing template is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the billing template","title":"Name","type":"string"},"notification_email":{"description":"Te address to send notifications","title":"Notification Email","type":"string"},"phase_advancement_options":{"properties":{"expiration_date_range_end":{"description":"The date to use to filter out which memberships are candidate","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"title":"Unit Of Time","type":"string"}},"required":["position","relative_to"],"title":"Expiration Date Range End","type":"object"},"expiration_date_range_start":{"description":"The date to use to filter out which memberships are candidate","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"title":"Unit Of Time","type":"string"}},"required":["position","relative_to"],"title":"Expiration Date Range Start","type":"object"},"notice_id":{"description":"The notice to send the school when advancing","title":"Notice","type":"string"},"phase_ids":{"items":{"type":"string"},"minItems":1,"title":"Phases","type":"array"},"phase_restriction":{"description":"Determines if/how to restrict the programs in this run","enum":["exclude","include","none"],"title":"Phase Restriction","type":"string"},"program_ids":{"items":{"type":"string"},"minItems":1,"title":"Programs","type":"array"},"program_restriction":{"description":"Determines if/how to restrict the programs in this run","enum":["exclude","include","none"],"title":"Program Restriction","type":"string"},"school_ids":{"items":{"type":"string"},"minItems":1,"title":"Schools","type":"array"},"school_restriction":{"description":"Determines if/how to restrict the programs in this run","enum":["exclude","include","none"],"title":"School Restriction","type":"string"}},"required":["expiration_date_range_end","expiration_date_range_start","phase_ids","program_ids","school_ids"],"title":"Phase Advancement Options","type":"object"},"send_fundraising_notices":{"description":"If set, this billing run will perform phase advancements","title":"Send Fundraising Notices","type":"boolean"},"send_team_notices":{"description":"If set, this billing run will perform phase advancements","title":"Send Team Notices","type":"boolean"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"team_notice_options":{"properties":{"phase_ids":{"items":{"type":"string"},"minItems":1,"title":"Phases","type":"array"},"phase_restriction":{"description":"Determines if/how to restrict the programs in this run","enum":["exclude","include","none"],"title":"Phase Restriction","type":"string"},"program_ids":{"items":{"type":"string"},"minItems":1,"title":"Programs","type":"array"},"program_restriction":{"description":"Determines if/how to restrict the programs in this run","enum":["exclude","include","none"],"title":"Program Restriction","type":"string"},"school_ids":{"items":{"type":"string"},"minItems":1,"title":"Schools","type":"array"},"school_restriction":{"description":"Determines if/how to restrict the programs in this run","enum":["exclude","include","none"],"title":"School Restriction","type":"string"},"team_notice_id":{"description":"The notice to send the school","title":"Team Notice","type":"string"},"visit_start_date_range_end":{"description":"The date to use to filter out which visits to use","format":"date","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"title":"Unit Of Time","type":"string"}},"required":["position","relative_to"],"title":"Visit Start Date Range End","type":"object"},"visit_start_date_range_start":{"description":"The date to use to filter out which visits to use","format":"date","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"title":"Unit Of Time","type":"string"}},"required":["position","relative_to"],"title":"Visit Start Date Range Start","type":"object"},"visit_type_ids":{"items":{"type":"string"},"minItems":1,"title":"Visit Types","type":"array"},"visit_type_restriction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines if/how to restrict the visit_types in this run"},"children":[]}]}]}],"enum":["exclude","include","none"],"title":"Visit Type Restriction","type":"string"}},"required":["phase_ids","program_ids","school_ids","visit_start_date_range_end","visit_start_date_range_start","visit_type_ids"],"title":"Team Notice Options","type":"object"}},"required":["fundraising_notice_options","id","name","phase_advancement_options","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","team_notice_options"],"type":"object"}},"components/schemas/Campaign":{"id":"components/schemas/Campaign","kind":"json-schema","title":"Campaign","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"end_date":{"description":"The close date for the campaign","format":"date-time","title":"End Date","type":"string"},"fundraising_products":{"items":{"additionalProperties":false,"properties":{"fund_id":{"description":"The fund","title":"Fund","type":"string"},"product_id":{"description":"The product","title":"Product","type":"string"}},"required":["fund_id","product_id"],"type":"object"},"minItems":1,"type":"array"},"goal":{"description":"The goal for the campaign","format":"float","title":"Goal","type":"number"},"id":{"description":"The unique, string identifier of this campaign","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"image_uri":{"description":"An image for the campaign","title":"Image Uri","type":"string"},"is_active":{"description":"Whether or not this campaign is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the campaign","title":"Name","type":"string"},"notes":{"description":"The notes for the campaign","title":"Notes","type":"string"},"override_fundraising_products":{"description":"If true, specific products are used for gifts in this campaign","title":"Override Fundraising Products","type":"boolean"},"start_date":{"description":"The open date for the campaign","format":"date-time","title":"Start Date","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["fundraising_products","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/CampaignSearchParameters":{"id":"components/schemas/CampaignSearchParameters","kind":"json-schema","title":"CampaignSearchParameters","data":{"additionalProperties":false,"properties":{"end_date":{"title":"End Date","type":"string"},"ids":{"description":"IDs to search","items":{"type":"string"},"title":"Ids","type":"array"},"name":{"title":"Name","type":"string"},"start_date":{"title":"Start Date","type":"string"}},"type":"object"}},"components/schemas/CampaignSearchResults":{"id":"components/schemas/CampaignSearchResults","kind":"json-schema","title":"CampaignSearchResults","data":{"additionalProperties":false,"properties":{"end_date":{"description":"The end date","title":"End Date","type":"string"},"goal":{"description":"The campaign goal","title":"Goal","type":"string"},"id":{"description":"The id","title":"ID","type":"string"},"is_active":{"description":"Is this campaign active","title":"Is Active","type":"boolean"},"name":{"description":"The name","title":"Name","type":"string"},"notes":{"description":"The internal notes on the campaign","title":"Notes","type":"string"},"start_date":{"description":"The start date","title":"Start Date","type":"string"}},"type":"object"}},"components/schemas/CustomFieldValue":{"id":"components/schemas/CustomFieldValue","kind":"json-schema","title":"CustomFieldValue","data":{"additionalProperties":false,"properties":{"boolean_value":{"description":"The boolean value","title":"Boolean Value","type":"boolean"},"custom_field_id":{"description":"The unique identifier of the custom field","title":"Custom Field","type":"string"},"file_url_value":{"description":"The pointer to a file value","title":"File Url Value","type":"string"},"list_value":{"description":"The list value","items":{"type":"string"},"title":"List Value","type":"array"},"numeric_value":{"description":"The numeric value","format":"float","title":"Numeric Value","type":"number"},"string_value":{"description":"The string value of the custom field","title":"String Value","type":"string"},"table_value":{"description":"A list of objects (a table)","items":{"additionalProperties":false,"properties":{},"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/Donor":{"id":"components/schemas/Donor","kind":"json-schema","title":"Donor","data":{"additionalProperties":false,"properties":{"amount_of_largest_gift":{"format":"float","title":"Amount Of Largest Gift","type":"number"},"anonymous":{"description":"Set if this donor has requested anonymity","title":"Anonymous","type":"boolean"},"city":{"description":"The member city","title":"City","type":"string"},"contact_id":{"description":"The contact for this donor","title":"Contact","type":"string"},"country":{"description":"The member country","title":"Country","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date_of_last_gift":{"description":"The date the last gift was given","title":"Date Of Last Gift","type":"string"},"donor_club_history":{"items":{"additionalProperties":false,"properties":{"donor_club_id":{"description":"The historical donor club (or null if none)","title":"Donor Club","type":"string"},"end_date":{"title":"End Date","type":"string"},"start_date":{"title":"Start Date","type":"string"}},"type":"object"},"type":"array"},"donor_club_id":{"description":"The donor level","title":"Donor Club","type":"string"},"email_address":{"description":"The member's email address","title":"Email Address","type":"string"},"first_name":{"description":"The member's first name","title":"First Name","type":"string"},"id":{"description":"The unique, string identifier of this donor","pattern":"^[\\w-|:]+$","title":"ID","type":"string"},"job_title":{"description":"The member job title","title":"Job Title","type":"string"},"last_name":{"description":"The member's last name","title":"Last Name","type":"string"},"name":{"description":"The member's name","title":"Name","type":"string"},"notes":{"description":"Notes on the donor","title":"Notes","type":"string"},"organization_id":{"description":"The organization for this donor","title":"Organization","type":"string"},"pledge_balance":{"description":"Outstanding balance on pledges","format":"float","title":"Pledge Balance","type":"number"},"state":{"description":"The state","title":"State","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"total_amount_of_gifts":{"description":"Total amount/value of gifts given","format":"float","title":"Total Amount Of Gifts","type":"number"},"total_number_of_gifts":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total # of gifts given"},"children":[]}]}]}],"format":"float","title":"Total Number Of Gifts","type":"number"},"type":{"description":"The donor type","enum":["contact","organization"],"title":"Type","type":"string"}},"required":["contact_id","id","name","organization_id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type"],"type":"object"}},"components/schemas/DonorClub":{"id":"components/schemas/DonorClub","kind":"json-schema","title":"DonorClub","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"display_order":{"description":"The display order of this club","format":"float","title":"Display Order","type":"number"},"id":{"description":"The unique, string identifier of this donor club","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this donor club is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the donor club","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/DonorLevel":{"id":"components/schemas/DonorLevel","kind":"json-schema","title":"DonorLevel","data":{"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"display_order":{"description":"The order in which to display the field","title":"Display Order","type":"string"},"id":{"description":"The unique, string identifier of this donor level","pattern":"/^[\\w:|-]+$/","title":"ID","type":"string"},"name":{"description":"The name of the donor level","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/DonorSearchParameters":{"id":"components/schemas/DonorSearchParameters","kind":"json-schema","title":"DonorSearchParameters","data":{"additionalProperties":false,"properties":{"city":{"description":"City to search","title":"City","type":"string"},"contact_id":{"items":{"type":"string"},"title":"Contact","type":"array"},"email_address":{"title":"Email Address","type":"string"},"first_name":{"title":"First Name","type":"string"},"ids":{"description":"IDs to search","items":{"type":"string"},"title":"Ids","type":"array"},"job_title":{"title":"Job Title","type":"string"},"last_name":{"title":"Last Name","type":"string"},"nickname":{"title":"Nickname","type":"string"},"organization_id":{"items":{"type":"string"},"title":"Organization","type":"array"},"state":{"description":"The state","title":"State","type":"string"},"type":{"title":"Type","type":"string"}},"type":"object"}},"components/schemas/DonorSearchResults":{"id":"components/schemas/DonorSearchResults","kind":"json-schema","title":"DonorSearchResults","data":{"additionalProperties":false,"properties":{"city":{"description":"City to search","title":"City","type":"string"},"contact_id":{"description":"The contact of the donor","title":"Contact","type":"string"},"domain_name":{"description":"The domain name","title":"Domain Name","type":"string"},"id":{"description":"The id","title":"ID","type":"string"},"name":{"description":"The name","title":"Name","type":"string"},"organization":{"description":"The organization of the donor","title":"Organization","type":"string"},"state":{"description":"The state","title":"State","type":"string"},"type":{"description":"The type of the donor: contact or organization","title":"Type","type":"string"}},"type":"object"}},"components/schemas/DonorStatement":{"id":"components/schemas/DonorStatement","kind":"json-schema","title":"DonorStatement","data":{"properties":{"contact_id":{"description":"The contact for this donor","title":"Contact","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The date/time of the donation","format":"date-time","title":"Date","type":"string"},"donor_id":{"description":"The id for the donor","title":"Donor","type":"string"},"donor_type":{"description":"The donor type","enum":["contact","organization"],"title":"Donor Type","type":"string"},"id":{"description":"The unique, string identifier of this donor statement","pattern":"/^[\\w:|-]+$/","title":"ID","type":"string"},"name":{"description":"The name of the donor statement","title":"Name","type":"string"},"organization_id":{"description":"The organization for this donor","title":"Organization","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"uri":{"title":"Uri","type":"string"}},"required":["contact_id","date","donor_id","donor_type","id","name","organization_id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","uri"],"type":"object"}},"components/schemas/DonorStatementTemplate":{"id":"components/schemas/DonorStatementTemplate","kind":"json-schema","title":"DonorStatementTemplate","data":{"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"email":{"description":"The email to send","properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email","type":"object"},"id":{"description":"The unique, string identifier of this donor statement template","pattern":"/^[\\w:|-]+$/","title":"ID","type":"string"},"name":{"description":"The name of the donor statement template","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"template":{"description":"The template of the Donor Statement","title":"Template","type":"string"}},"required":["email","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","template"],"type":"object"}},"components/schemas/Fund":{"id":"components/schemas/Fund","kind":"json-schema","title":"Fund","data":{"additionalProperties":false,"properties":{"annual_contribution_limit":{"format":"float","minimum":0,"title":"Annual Contribution Limit","type":"number"},"business_unit_id":{"description":"The business unit to which the fund belongs","title":"Business Unit","type":"string"},"category_id":{"description":"The associated category for the fund","title":"Category","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"display_order":{"description":"The display order fund","format":"float","title":"Display Order","type":"number"},"enable_annual_contribution_limits":{"description":"If true, this fund has a limit on how much can be given to it in a given year","title":"Enable Annual Contribution Limits","type":"boolean"},"hide_from_portal":{"description":"Should this be hidden in the portal","title":"Hide From Portal","type":"boolean"},"id":{"description":"The unique, string identifier of this fund","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this fund is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the fund","title":"Name","type":"string"},"restricted":{"description":"Whether or not this is a restricted fund","title":"Restricted","type":"boolean"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["annual_contribution_limit","business_unit_id","category_id","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/FundCategory":{"id":"components/schemas/FundCategory","kind":"json-schema","title":"FundCategory","data":{"additionalProperties":false,"properties":{"display_order":{"description":"Display order of the categories","format":"float","title":"Display Order","type":"number"},"id":{"description":"The unique, string identifier of this fund category","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this fund category is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the fund category","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Gift":{"id":"components/schemas/Gift","kind":"json-schema","title":"Gift","data":{"additionalProperties":false,"properties":{"amount":{"description":"Gift amount","format":"float","title":"Amount","type":"number"},"amount_allocated_to_primary_fund":{"description":"When gift is split, this is the amount that is allocated to the primary fund","format":"float","title":"Amount Allocated To Primary Fund","type":"number"},"amount_allocated_to_splits":{"description":"When gift is split, this is the amount that is allocated to splits","format":"float","title":"Amount Allocated To Splits","type":"number"},"anonymous":{"description":"Anonymous","title":"Anonymous","type":"boolean"},"appeal_id":{"description":"The id for the appeal associated with the gift","title":"Appeal","type":"string"},"campaign_id":{"description":"The id for the campaign associated with the gift","title":"Campaign","type":"string"},"contact_id":{"description":"The rolodex contact id for the gift giver","title":"Contact","type":"string"},"cover_transaction_costs":{"description":"If selected, the donor covers the transaction fees","title":"Cover Transaction Costs","type":"boolean"},"currency_code":{"description":"The currency code of the gift","title":"Currency Code","type":"string"},"currency_symbol":{"description":"Currency","title":"Currency Symbol","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The creation date for the gift","title":"Date","type":"string"},"details":{"description":"Any details about the gift","title":"Details","type":"string"},"donor_id":{"description":"The donor record associated with this gift","title":"Donor","type":"string"},"donor_type":{"description":"The donor type for the gift","enum":["contact","organization"],"title":"Donor Type","type":"string"},"fund_id":{"description":"The id for the fund associated with the gift","title":"Fund","type":"string"},"giving_process_id":{"description":"The process of that led to the gift","title":"Giving Process","type":"string"},"has_soft_credits":{"description":"If true, this gift has soft credits to others","title":"Has Soft Credits","type":"boolean"},"has_splits":{"description":"If true, this gift is split into different funds","title":"Has Splits","type":"boolean"},"id":{"description":"The unique, string identifier of this gift","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"make_recurring":{"description":"Whether to make this a recurring gift","title":"Make Recurring","type":"boolean"},"master_gift_id":{"description":"If this gift is linked to another, it is here","title":"Master Gift","type":"string"},"notes":{"description":"Notes about the gift","title":"Notes","type":"string"},"number":{"description":"The gift number","format":"float","title":"Number","type":"number"},"order_id":{"description":"The id for the order associated with the gift","title":"Order","type":"string"},"order_line_item_id":{"description":"The id for the order line item associated with the gift","title":"Order Line Item","type":"string"},"organization_id":{"description":"The organization id associated with this gift","title":"Organization","type":"string"},"payment_id":{"description":"The payment that generated this gift","title":"Payment","type":"string"},"planned_gift_info":{"additionalProperties":false,"description":"Information about the gift if type is planned","properties":{"anticipated_date":{"description":"The creation date for the gift","format":"date-time","title":"Anticipated Date","type":"string"}},"required":["anticipated_date"],"title":"Planned Gift Info","type":"object"},"pledge_id":{"description":"The pledge associated with this gift","title":"Pledge","type":"string"},"premium_assignment":{"enum":["assigned","declined by donor","not applicable"],"title":"Premium Assignment","type":"string"},"premium_fair_market_value":{"description":"The amount of any premiums associated with the gift","format":"float","title":"Premium Fair Market Value","type":"number"},"premium_id":{"description":"If the user has selected a premium it is here","title":"Premium","type":"string"},"recurring_frequency":{"enum":["monthly","quarterly","yearly"],"title":"Recurring Frequency","type":"string"},"recurring_gift_end_date":{"description":"optional end date for gift","title":"Recurring Gift End Date","type":"string"},"recurring_gift_id":{"description":"The id for the recurring gift associated with this gift","title":"Recurring Gift","type":"string"},"refund_id":{"description":"The payment that generated this gift","title":"Refund","type":"string"},"shipping_address":{"$ref":"#/components/schemas/Address"},"soft_credits":{"items":{"additionalProperties":false,"properties":{"amount":{"description":"The amount of soft credit that the person should receive","format":"float","title":"Amount","type":"number"},"contact_id":{"oneOf":[{"x-required":true}],"title":"Contact","type":"string"},"donor_type":{"enum":["contact","organization"],"title":"Donor Type","type":"string"},"fund_id":{"description":"The fund to which this credit is allocated","title":"Fund","type":"string"},"organization_id":{"oneOf":[{"x-required":true}],"title":"Organization","type":"string"},"percentage":{"description":"The percentage to attribute gifts","format":"float","maximum":100,"minimum":0,"title":"Percentage","type":"number"},"reason":{"enum":["matching","other","relationship","tribute"],"title":"Reason","type":"string"}},"required":["amount","fund_id","percentage","reason"],"type":"object"},"minItems":1,"type":"array"},"splits":{"description":"An array of fund allocations for this gift","items":{"additionalProperties":false,"properties":{"amount":{"description":"The amount for this allocation of the gift","format":"float","title":"Amount","type":"number"},"fund_id":{"description":"The id for the fund associated with the gift allocation","title":"Fund","type":"string"}},"required":["amount","fund_id"],"type":"object"},"type":"array"},"stock_gift_info":{"additionalProperties":false,"description":"Information about the gift if type is a stock","properties":{"number_of_shares":{"description":"The number of shares of the stock gift","format":"float","title":"Number Of Shares","type":"number"},"stock_symbol":{"description":"The stock symbol of the stock gift","title":"Stock Symbol","type":"string"}},"required":["number_of_shares","stock_symbol"],"title":"Stock Gift Info","type":"object"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"tax_deductible_amount":{"description":"The amount of the gift less any premiums","format":"float","title":"Tax Deductible Amount","type":"number"},"tribute_gift":{"description":"Whether or not this is a tribute gift","title":"Tribute Gift","type":"boolean"},"tribute_gift_info":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/Address"},"contact_id":{"description":"The optional linked contact","title":"Contact","type":"string"},"details":{"description":"Additional details","title":"Details","type":"string"},"email_address":{"format":"email","oneOf":[{"x-required":true}],"title":"Email Address","type":"string"},"inform_honoree":{"description":"If true, the honoree is informed about the gift","title":"Inform Honoree","type":"boolean"},"inform_honoree_by":{"enum":["email","mail"],"oneOf":[{"x-required":true}],"title":"Inform Honoree By","type":"string"},"message":{"description":"Message to send when notifying","oneOf":[{"x-required":true}],"title":"Message","type":"string"},"name":{"description":"The name","title":"Name","type":"string"},"type":{"enum":["in honor of","in memory of"],"title":"Type","type":"string"}},"required":["name","type"],"title":"Tribute Gift Info","type":"object"},"type":{"description":"The type of gift","enum":["cash","in kind","matching","planned","pledge payment","pledge payment reversal","stock"],"title":"Type","type":"string"}},"required":["amount","amount_allocated_to_primary_fund","amount_allocated_to_splits","contact_id","donor_id","donor_type","fund_id","id","master_gift_id","organization_id","payment_id","planned_gift_info","pledge_id","refund_id","soft_credits","stock_gift_info","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","tax_deductible_amount","type"],"type":"object"}},"components/schemas/GiftNotice":{"id":"components/schemas/GiftNotice","kind":"json-schema","title":"GiftNotice","data":{"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"email":{"description":"The email to send","properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email","type":"object"},"id":{"description":"The unique, string identifier of this gift notice","pattern":"/^[\\w:|-]+$/","title":"ID","type":"string"},"name":{"description":"The name of the gift notice","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["email","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/GiftPayload":{"id":"components/schemas/GiftPayload","kind":"json-schema","title":"GiftPayload","data":{"additionalProperties":false,"properties":{"amount":{"description":"Gift amount","format":"float","title":"Amount","type":"number"},"anonymous":{"description":"Anonymous","title":"Anonymous","type":"boolean"},"appeal_id":{"description":"The id for the appeal associated with the gift","title":"Appeal","type":"string"},"campaign_id":{"description":"The id for the campaign associated with the gift","title":"Campaign","type":"string"},"contact_id":{"description":"The rolodex contact id for the gift giver","title":"Contact","type":"string"},"cover_transaction_costs":{"description":"If selected, the donor covers the transaction fees","title":"Cover Transaction Costs","type":"boolean"},"currency_code":{"description":"The currency code of the gift","title":"Currency Code","type":"string"},"currency_symbol":{"description":"Currency","title":"Currency Symbol","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"donor_type":{"description":"The donor type for the gift","enum":["contact","organization"],"title":"Donor Type","type":"string"},"fund_id":{"description":"The id for the fund associated with the gift","title":"Fund","type":"string"},"giving_process_id":{"description":"The process of that led to the gift","title":"Giving Process","type":"string"},"has_splits":{"description":"If true, this gift is split into different funds","title":"Has Splits","type":"boolean"},"make_recurring":{"description":"Whether to make this a recurring gift","title":"Make Recurring","type":"boolean"},"notes":{"description":"Notes about the gift","title":"Notes","type":"string"},"organization_id":{"description":"The organization id associated with this gift","title":"Organization","type":"string"},"premium_assignment":{"enum":["assigned","declined by donor","not applicable"],"title":"Premium Assignment","type":"string"},"premium_fair_market_value":{"description":"The amount of any premiums associated with the gift","format":"float","title":"Premium Fair Market Value","type":"number"},"premium_id":{"description":"If the user has selected a premium it is here","title":"Premium","type":"string"},"recurring_frequency":{"enum":["monthly","quarterly","yearly"],"title":"Recurring Frequency","type":"string"},"recurring_gift_end_date":{"description":"optional end date for gift","title":"Recurring Gift End Date","type":"string"},"shipping_address":{"$ref":"#/components/schemas/Address"},"splits":{"description":"An array of fund allocations for this gift","items":{"additionalProperties":false,"properties":{"amount":{"description":"The amount for this allocation of the gift","format":"float","title":"Amount","type":"number"},"fund_id":{"description":"The id for the fund associated with the gift allocation","title":"Fund","type":"string"}},"required":["amount","fund_id"],"type":"object"},"type":"array"},"tribute_gift":{"description":"Whether or not this is a tribute gift","title":"Tribute Gift","type":"boolean"},"tribute_gift_info":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/Address"},"contact_id":{"description":"The optional linked contact","title":"Contact","type":"string"},"details":{"description":"Additional details","title":"Details","type":"string"},"email_address":{"format":"email","oneOf":[{"x-required":true}],"title":"Email Address","type":"string"},"inform_honoree":{"description":"If true, the honoree is informed about the gift","title":"Inform Honoree","type":"boolean"},"inform_honoree_by":{"enum":["email","mail"],"oneOf":[{"x-required":true}],"title":"Inform Honoree By","type":"string"},"message":{"description":"Message to send when notifying","oneOf":[{"x-required":true}],"title":"Message","type":"string"},"name":{"description":"The name","title":"Name","type":"string"},"type":{"enum":["in honor of","in memory of"],"title":"Type","type":"string"}},"required":["name","type"],"title":"Tribute Gift Info","type":"object"}},"required":["amount","contact_id","donor_type","fund_id","organization_id"],"type":"object"}},"components/schemas/GiftSearchParameters":{"id":"components/schemas/GiftSearchParameters","kind":"json-schema","title":"GiftSearchParameters","data":{"additionalProperties":false,"properties":{"appeal_id":{"description":"Appeal ids to search","items":{"type":"string"},"title":"Appeal","type":"array"},"campaign_id":{"description":"Campaign ids to search","items":{"type":"string"},"title":"Campaign","type":"array"},"contact_id":{"description":"Contact ids for the donor","items":{"type":"string"},"title":"Contact","type":"array"},"date":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Date","type":"array"},"fund_id":{"description":"Fund ids to search","items":{"type":"string"},"title":"Fund","type":"array"},"ids":{"description":"IDs to search","items":{"type":"string"},"title":"Ids","type":"array"},"master_gift_id":{"description":"Parent gift ids to search","items":{"type":"string"},"title":"Master Gift","type":"array"},"order_id":{"description":"Order ids to search","items":{"type":"string"},"title":"Order","type":"array"},"organization_id":{"description":"Organization ids for the donor","items":{"type":"string"},"title":"Organization","type":"array"},"pledge_id":{"description":"Pledge ids to search","items":{"type":"string"},"title":"Pledge","type":"array"},"recurring_gift_id":{"description":"Recurring gift ids to search","items":{"type":"string"},"title":"Recurring Gift","type":"array"},"type":{"description":"Types of the gifts","items":{"type":"string"},"title":"Type","type":"array"}},"type":"object"}},"components/schemas/GiftSearchResults":{"id":"components/schemas/GiftSearchResults","kind":"json-schema","title":"GiftSearchResults","data":{"additionalProperties":false,"properties":{"appeal_id":{"description":"Appeal id for the gift","title":"Appeal","type":"string"},"campaign_id":{"description":"Campaign id for the gift","title":"Campaign","type":"string"},"contact_id":{"description":"Contact ids for the donor","title":"Contact","type":"string"},"date":{"title":"Date","type":"string"},"fund_id":{"description":"Fund id for the gift","title":"Fund","type":"string"},"id":{"description":"ID of the gift","title":"ID","type":"string"},"master_gift_id":{"description":"Parent gift id for the gift","title":"Master Gift","type":"string"},"order_id":{"description":"Order id for the gift","title":"Order","type":"string"},"organization_id":{"description":"Organization ids for the donor","title":"Organization","type":"string"},"pledge_id":{"description":"Pledge id for the gift","title":"Pledge","type":"string"},"recurring_gift_id":{"description":"Recurring gift id for the gift","title":"Recurring Gift","type":"string"},"type":{"description":"Types of the gifts","title":"Type","type":"string"}},"type":"object"}},"components/schemas/GivingProcess":{"id":"components/schemas/GivingProcess","kind":"json-schema","title":"GivingProcess","data":{"additionalProperties":false,"properties":{"acknowledgement_settings":{"additionalProperties":false,"properties":{"checkbox_text":{"description":"The value to show on the textbox label","title":"Checkbox Text","type":"string"},"html":{"description":"HTML to show","title":"Html","type":"string"}},"required":["checkbox_text"],"title":"Acknowledgement Settings","type":"object"},"allow_anonymous_gifts":{"description":"If true, anonymous gifts are allowed","title":"Allow Anonymous Gifts","type":"boolean"},"allow_pledges":{"description":"Whether pledges are allowed in this process","title":"Allow Pledges","type":"boolean"},"allow_recurring_gifts":{"description":"Whether recurring gifts are allowed in this process","title":"Allow Recurring Gifts","type":"boolean"},"allow_tribute_gifts":{"description":"If set, donors are able to donor in honor of/in memory of","title":"Allow Tribute Gifts","type":"boolean"},"appeal_id":{"description":"The appeal to which gifts given in this process should be associated","title":"Appeal","type":"string"},"campaign_id":{"description":"The campaign to which gifts given in this process should be associated","title":"Campaign","type":"string"},"checkout_settings":{"additionalProperties":false,"properties":{"allow_customer_to_choose_installment_plan":{"description":"If true, the customer can choose their installment plan","title":"Allow Customer To Choose Installment Plan","type":"boolean"},"bank_account_id":{"description":"The default bank account that the store should use to receive payments","title":"Bank Account","type":"string"},"bill_my_organization_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Bill My Organization Options","type":"object"},"bill_my_parent_organization_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Bill My Parent Organization Options","type":"object"},"business_unit_id":{"description":"The business unit of the store","title":"Business Unit","type":"string"},"cancellation_fee_product_id":{"description":"The ID of the product used for cancellation fees","title":"Cancellation Fee Product","type":"string"},"checkout_donation_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"simple_checkout_donation_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"allow_user_to_specify_custom_amount":{"description":"If set, the user can specify their own custom donation","title":"Allow User To Specify Custom Amount","type":"boolean"},"donation_ask_text":{"description":"The text shown to the user when making the donation","title":"Donation Ask Text","type":"string"},"donation_denominations":{"items":{"format":"double","type":"number"},"title":"Donation Denominations","type":"array"},"donation_information":{"description":"Additional information about the donation","title":"Donation Information","type":"string"},"donation_product_id":{"description":"The misc product that should be used","title":"Donation Product","type":"string"},"override_donation_denominations":{"description":"If set, donation denominations are specified here and the defaults are not used","title":"Override Donation Denominations","type":"boolean"},"suggested_donation":{"description":"A suggested donation","format":"double","title":"Suggested Donation","type":"number"}},"required":["donation_product_id"],"title":"Simple Checkout Donation Options","type":"object"},"type":{"enum":["simple"],"title":"Type","type":"string"}},"title":"Checkout Donation Options","type":"object"},"credit_card_minimum_range_end":{"description":"If set, the maximum amount for which credit cards can be taken","format":"float","title":"Credit Card Minimum Range End","type":"number"},"credit_card_minimum_range_start":{"description":"If set, the minimum amount for which credit cards can be taken","format":"float","title":"Credit Card Minimum Range Start","type":"number"},"credit_card_mode":{"description":"Determines whether or not credit cards are accepted","enum":["disabled","enabled","range"],"title":"Credit Card Mode","type":"string"},"credit_card_processing_fee_mode":{"description":"Determines how credit card processing fees should be handled","enum":["charge","do not charge","prompt user"],"title":"Credit Card Processing Fee Mode","type":"string"},"credit_card_processing_fee_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"fee_percentage":{"description":"The fee percentage to charge for credit card processing ","format":"float","title":"Fee Percentage","type":"number"},"maximum_fee":{"description":"The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged","format":"float","title":"Maximum Fee","type":"number"},"minimum_fee":{"description":"The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged","format":"float","title":"Minimum Fee","type":"number"},"product_id":{"description":"The misc product to use for the credit card processing","title":"Product","type":"string"},"prompt_sub_text":{"description":"Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used","title":"Prompt Sub Text","type":"string"},"prompt_text":{"description":"The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used","title":"Prompt Text","type":"string"}},"required":["fee_percentage","product_id"],"title":"Credit Card Processing Fee Options","type":"object"},"disable_electronic_payment_vaulting":{"description":"If set, in the portal people are not allowed to save credit cards","title":"Disable Electronic Payment Vaulting","type":"boolean"},"enable_bill_my_organization":{"description":"If set, the user has the option to bill their organization","title":"Enable Bill My Organization","type":"boolean"},"enable_bill_my_parent_organization":{"description":"If set, the user has the option to bill their organization's parent organization","title":"Enable Bill My Parent Organization","type":"boolean"},"enable_donations_at_checkout":{"description":"If selected, users will be prompted to make a donation upon checking out","title":"Enable Donations At Checkout","type":"boolean"},"enable_electronic_checks":{"description":"If set, electronic checks are allowed","title":"Enable Electronic Checks","type":"boolean"},"enable_pay_later":{"description":"If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed","title":"Enable Pay Later","type":"boolean"},"enable_payroll_deduction":{"description":"If set, payroll deduction is allowed","title":"Enable Payroll Deduction","type":"boolean"},"enable_split_payments":{"description":"If set, users are allowed to split payments","title":"Enable Split Payments","type":"boolean"},"installment_plan_options":{"items":{"additionalProperties":false,"properties":{"additional_cost":{"description":"The additional cost of the installment plan","format":"double","title":"Additional Cost","type":"number"},"installment_plan_id":{"description":"The installment plan that this product supports","title":"Installment Plan","type":"string"},"is_default":{"description":"Whether this is the default installment plan option","title":"Is Default","type":"boolean"}},"required":["installment_plan_id"],"type":"object"},"minItems":1,"oneOf":[{"x-required":true}],"type":"array"},"invoice_payment_terms_id":{"description":"The payment terms for invoices; if left blank, default is used","title":"Invoice Payment Terms","type":"string"},"invoice_template_id":{"description":"The template to use for invoices created during this process","title":"Invoice Template","type":"string"},"merchant_account_id":{"description":"The merchant account that the store should use to receive payments","title":"Merchant Account","type":"string"},"pay_later_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Pay Later Options","type":"object"},"restocking_fee_product_id":{"description":"The ID of the product used for restocking fees","title":"Restocking Fee Product","type":"string"},"special_instructions":{"description":"Instructions shown to the user","title":"Special Instructions","type":"string"},"use_pro_forma_invoices":{"description":"Whether to use pro forma invoices when user elects to pay later","title":"Use Pro Forma Invoices","type":"boolean"}},"required":["bank_account_id","business_unit_id","merchant_account_id"],"title":"Checkout Settings","type":"object"},"default_fund_id":{"description":"The default fund that a gift should be allocated to when the user makes an non-targeted gift","title":"Default Fund","type":"string"},"donor_instructions":{"description":"Instructions shown to donors on the giving form","title":"Donor Instructions","type":"string"},"enable_gift_receipt":{"description":"Enable confirmation email for submitted gift forms","title":"Enable Gift Receipt","type":"boolean"},"enable_pledge_receipt":{"description":"Enable confirmation email for submitted pledge forms","title":"Enable Pledge Receipt","type":"boolean"},"enable_premiums":{"description":"If set, premiums are automatically assigned with gifts","title":"Enable Premiums","type":"boolean"},"gift_receipt":{"additionalProperties":false,"description":"The confirmation email for submitted gift forms","properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Gift Receipt","type":"object"},"id":{"description":"The unique, string identifier of this application process","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this process is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the application process","title":"Name","type":"string"},"new_donor_contact_options":{"additionalProperties":false,"description":"The fields that should show for new contacts being created in the portal during the contribution process","properties":{},"title":"New Donor Contact Options","type":"object"},"override_checkout_settings":{"description":"Whether or not to override POC settings","title":"Override Checkout Settings","type":"boolean"},"pledge_installment_plans":{"items":{"additionalProperties":false,"properties":{"installment_plan_id":{"description":"The installment plan","title":"Installment Plan","type":"string"},"name":{"description":"The description of the installment plan to be shown to the user","title":"Name","type":"string"}},"required":["installment_plan_id","name"],"type":"object"},"minItems":1,"type":"array"},"pledge_receipt":{"additionalProperties":false,"description":"The confirmation email for submitted pledge forms","properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Pledge Receipt","type":"object"},"pledges_generate_pro_forma_invoices":{"description":"If true, pledges will generate pro forma (not real) invoices","title":"Pledges Generate Pro Forma Invoices","type":"boolean"},"premium_rules":{"items":{"additionalProperties":false,"properties":{"gift_amount_range_end":{"description":"The ending range","format":"float","title":"Gift Amount Range End","type":"number"},"gift_amount_range_start":{"description":"The starting range for the premium rule","format":"float","title":"Gift Amount Range Start","type":"number"},"premium_id":{"description":"The premium","title":"Premium","type":"string"}},"required":["premium_id"],"type":"object"},"type":"array"},"premium_shipping_method_id":{"description":"The shipping method to use for premiums","title":"Premium Shipping Method","type":"string"},"recurring_gift_options":{"additionalProperties":false,"properties":{"allow_donor_to_specify_end_date":{"description":"If set, the user can indicate when they want the gifts to end","title":"Allow Donor To Specify End Date","type":"boolean"},"enable_annually":{"description":"If set, donors can have annual recurring gifts","title":"Enable Annually","type":"boolean"},"enable_monthly":{"description":"If set, donors can have monthly recurring gifts","title":"Enable Monthly","type":"boolean"},"enable_quarterly":{"description":"If set, donors can have quarterly recurring gifts","title":"Enable Quarterly","type":"boolean"}},"title":"Recurring Gift Options","type":"object"},"require_acknowledgement":{"description":"If set, donors must acknowledge a checkbox before proceeding","title":"Require Acknowledgement","type":"boolean"},"show_campaign_progress":{"description":"If set, then the campaign in use for the giving form will show progress at the time of giving","title":"Show Campaign Progress","type":"boolean"},"suggest_giving_amounts":{"description":"If true, giving amounts are suggested; otherwise, the donor is free to enter their own","title":"Suggest Giving Amounts","type":"boolean"},"suggested_gift_amount":{"description":"The suggested amount of given, set by default","format":"float","title":"Suggested Gift Amount","type":"number"},"suggested_giving_amounts":{"items":{"format":"float","minimum":1,"type":"number"},"maxItems":10,"minItems":1,"title":"Suggested Giving Amounts","type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"targeted_giving":{"description":"Whether targeted giving is enabled for this process","enum":["disabled","specify multiple funds","specify single fund"],"title":"Targeted Giving","type":"string"},"targeted_giving_options":{"additionalProperties":false,"properties":{"restrict_to_fund_categories":{"description":"Should this process be restricted to specific categories","title":"Restrict To Fund Categories","type":"boolean"},"restrict_to_fund_types":{"description":"Should this process be restricted to certain types of funds","title":"Restrict To Fund Types","type":"boolean"},"restrict_to_funds":{"description":"Should this process be restricted to specific funds","title":"Restrict To Funds","type":"boolean"},"restricted_fund_category_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Restricted Fund Categories","type":"array"},"restricted_fund_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Restricted Funds","type":"array"},"restricted_fund_types":{"items":{"enum":["restricted funds","unrestricted funds"],"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Restricted Fund Types","type":"array"}},"title":"Targeted Giving Options","type":"object"},"tribute_gift_options":{"additionalProperties":false,"properties":{"email_notification":{"additionalProperties":false,"description":"The templated email to send to honorees","oneOf":[{"x-required":true}],"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email Notification","type":"object"},"honoree_notification":{"enum":["disabled","email","email or mail","mail"],"title":"Honoree Notification","type":"string"}},"title":"Tribute Gift Options","type":"object"}},"required":["acknowledgement_settings","checkout_settings","default_fund_id","gift_receipt","id","name","pledge_installment_plans","pledge_receipt","premium_rules","premium_shipping_method_id","recurring_gift_options","suggested_giving_amounts","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","targeted_giving","tribute_gift_options"],"type":"object"}},"components/schemas/ListAppealsResponse":{"id":"components/schemas/ListAppealsResponse","kind":"json-schema","title":"ListAppealsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Appeal"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListDonorStatementsResponse":{"id":"components/schemas/ListDonorStatementsResponse","kind":"json-schema","title":"ListDonorStatementsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/DonorStatement"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListGiftsResponse":{"id":"components/schemas/ListGiftsResponse","kind":"json-schema","title":"ListGiftsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Gift"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListPledgesResponse":{"id":"components/schemas/ListPledgesResponse","kind":"json-schema","title":"ListPledgesResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Pledge"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListProductsResponse":{"id":"components/schemas/ListProductsResponse","kind":"json-schema","title":"ListProductsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Product"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListRecurringGiftsResponse":{"id":"components/schemas/ListRecurringGiftsResponse","kind":"json-schema","title":"ListRecurringGiftsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/RecurringGift"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListStandardQueryDefinitionsResponse":{"id":"components/schemas/ListStandardQueryDefinitionsResponse","kind":"json-schema","title":"ListStandardQueryDefinitionsResponse","data":{"items":{"$ref":"#/components/schemas/StandardQueryDefinition"},"type":"array"}},"components/schemas/PagedAppealSearchResults":{"id":"components/schemas/PagedAppealSearchResults","kind":"json-schema","title":"PagedAppealSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/AppealSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedCampaignSearchResults":{"id":"components/schemas/PagedCampaignSearchResults","kind":"json-schema","title":"PagedCampaignSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/CampaignSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedDonorSearchResults":{"id":"components/schemas/PagedDonorSearchResults","kind":"json-schema","title":"PagedDonorSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/DonorSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedGiftSearchResults":{"id":"components/schemas/PagedGiftSearchResults","kind":"json-schema","title":"PagedGiftSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/GiftSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedPledgeSearchResults":{"id":"components/schemas/PagedPledgeSearchResults","kind":"json-schema","title":"PagedPledgeSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/PledgeSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedRecurringGiftSearchResults":{"id":"components/schemas/PagedRecurringGiftSearchResults","kind":"json-schema","title":"PagedRecurringGiftSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/RecurringGiftSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PatchDirective":{"id":"components/schemas/PatchDirective","kind":"json-schema","title":"PatchDirective","data":{"additionalProperties":false,"properties":{"op":{"description":"The operation","enum":["add","copy","move","remove","replace","test"],"title":"Op","type":"string"},"path":{"description":"The JSON path","title":"Path","type":"string"},"value":{"description":"The updated value","title":"Value","type":"string"}},"required":["op","path"],"type":"object"}},"components/schemas/Pledge":{"id":"components/schemas/Pledge","kind":"json-schema","title":"Pledge","data":{"additionalProperties":false,"properties":{"amount":{"description":"Gift amount","format":"float","title":"Amount","type":"number"},"amount_allocated_to_primary_fund":{"description":"When gift is split, this is the amount that is allocated to the primary fund","format":"float","title":"Amount Allocated To Primary Fund","type":"number"},"amount_allocated_to_splits":{"description":"When gift is split, this is the amount that is allocated to splits","format":"float","title":"Amount Allocated To Splits","type":"number"},"amount_fulfilled":{"description":"Amount of pledge fulfilled","format":"float","title":"Amount Fulfilled","type":"number"},"amount_outstanding":{"description":"The amount of outstanding on the pledge","format":"float","title":"Amount Outstanding","type":"number"},"anonymous":{"description":"Anonymous","title":"Anonymous","type":"boolean"},"appeal_id":{"description":"The id for the appeal associated with the gift","title":"Appeal","type":"string"},"campaign_id":{"description":"The id for the campaign associated with the gift","title":"Campaign","type":"string"},"contact_id":{"description":"The rolodex contact id for the gift giver","title":"Contact","type":"string"},"cover_transaction_costs":{"description":"If selected, the donor covers the transaction fees","title":"Cover Transaction Costs","type":"boolean"},"currency_code":{"description":"The currency code of the gift","title":"Currency Code","type":"string"},"currency_symbol":{"description":"Currency","title":"Currency Symbol","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The creation date for the gift","title":"Date","type":"string"},"donor_id":{"description":"The donor record associated with this gift","title":"Donor","type":"string"},"donor_type":{"description":"The donor type for the gift","enum":["contact","organization"],"title":"Donor Type","type":"string"},"fund_id":{"description":"The id for the fund associated with the gift","title":"Fund","type":"string"},"giving_process_id":{"description":"The process of that led to the gift","title":"Giving Process","type":"string"},"has_soft_credits":{"description":"If true, this gift has soft credits to others","title":"Has Soft Credits","type":"boolean"},"has_splits":{"description":"If true, this gift is split into different funds","title":"Has Splits","type":"boolean"},"id":{"description":"The unique, string identifier of this pledge","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"installment_plan_id":{"description":"The installment plan for the pledge","title":"Installment Plan","type":"string"},"next_payment_date":{"description":"The next processing date of the pledge","title":"Next Payment Date","type":"string"},"notes":{"description":"Notes about the gift","title":"Notes","type":"string"},"number":{"description":"The gift number","format":"float","title":"Number","type":"number"},"order_id":{"description":"The id for the order associated with the gift","title":"Order","type":"string"},"order_line_item_id":{"description":"The id for the order line item associated with the gift","title":"Order Line Item","type":"string"},"organization_id":{"description":"The organization id associated with this gift","title":"Organization","type":"string"},"payment_info":{"additionalProperties":false,"description":"Payment information for the recurring gift","properties":{"card_expiration":{"description":"The expiration date of the card","title":"Card Expiration","type":"string"},"card_type":{"description":"The type of card being used, or CHECK if electronic check","enum":["american express","discover","electronic check","mastercard","other","visa"],"title":"Card Type","type":"string"},"merchant_account_tokens":{"items":{"additionalProperties":false,"properties":{"merchant_account_id":{"description":"The merchant account id","title":"Merchant Account","type":"string"},"token":{"description":"The token representing the card/electronic check info","title":"Token","type":"string"}},"required":["merchant_account_id","token"],"type":"object"},"minItems":1,"type":"array"},"payment_account":{"description":"The masked payment account information","title":"Payment Account","type":"string"},"payment_origin":{"description":"Whether or not this is a saved payment method","enum":["ad hoc","saved","single token"],"title":"Payment Origin","type":"string"},"token":{"description":"For integrated payments, the single token","title":"Token","type":"string"},"type":{"description":"The type of payment","enum":["credit card","electronic check"],"title":"Type","type":"string"}},"required":["payment_origin","type"],"title":"Payment Info","type":"object"},"premium_assignment":{"enum":["assigned","declined by donor","not applicable"],"title":"Premium Assignment","type":"string"},"premium_fair_market_value":{"description":"The amount of any premiums associated with the gift","format":"float","title":"Premium Fair Market Value","type":"number"},"premium_id":{"description":"If the user has selected a premium it is here","title":"Premium","type":"string"},"remaining_payments":{"description":"The number of payments remaining on the pledge","format":"float","title":"Remaining Payments","type":"number"},"shipping_address":{"$ref":"#/components/schemas/Address"},"soft_credits":{"items":{"additionalProperties":false,"properties":{"amount":{"description":"The amount of soft credit that the person should receive","format":"float","title":"Amount","type":"number"},"contact_id":{"oneOf":[{"x-required":true}],"title":"Contact","type":"string"},"donor_type":{"enum":["contact","organization"],"title":"Donor Type","type":"string"},"fund_id":{"description":"The fund to which this credit is allocated","title":"Fund","type":"string"},"organization_id":{"oneOf":[{"x-required":true}],"title":"Organization","type":"string"},"percentage":{"description":"The percentage to attribute gifts","format":"float","maximum":100,"minimum":0,"title":"Percentage","type":"number"},"reason":{"enum":["matching","other","relationship","tribute"],"title":"Reason","type":"string"}},"required":["amount","fund_id","percentage","reason"],"type":"object"},"minItems":1,"type":"array"},"splits":{"description":"An array of fund allocations for this gift","items":{"additionalProperties":false,"properties":{"amount":{"description":"The amount for this allocation of the gift","format":"float","title":"Amount","type":"number"},"fund_id":{"description":"The id for the fund associated with the gift allocation","title":"Fund","type":"string"}},"required":["amount","fund_id"],"type":"object"},"type":"array"},"status":{"description":"The status of the pledge","enum":["cancelled","open","paid","paused"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"tax_deductible_amount":{"description":"The amount of the gift less any premiums","format":"float","title":"Tax Deductible Amount","type":"number"},"tribute_gift":{"description":"Whether or not this is a tribute gift","title":"Tribute Gift","type":"boolean"},"tribute_gift_info":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/Address"},"contact_id":{"description":"The optional linked contact","title":"Contact","type":"string"},"details":{"description":"Additional details","title":"Details","type":"string"},"email_address":{"format":"email","oneOf":[{"x-required":true}],"title":"Email Address","type":"string"},"inform_honoree":{"description":"If true, the honoree is informed about the gift","title":"Inform Honoree","type":"boolean"},"inform_honoree_by":{"enum":["email","mail"],"oneOf":[{"x-required":true}],"title":"Inform Honoree By","type":"string"},"message":{"description":"Message to send when notifying","oneOf":[{"x-required":true}],"title":"Message","type":"string"},"name":{"description":"The name","title":"Name","type":"string"},"type":{"enum":["in honor of","in memory of"],"title":"Type","type":"string"}},"required":["name","type"],"title":"Tribute Gift Info","type":"object"}},"required":["amount","amount_allocated_to_primary_fund","amount_allocated_to_splits","amount_fulfilled","amount_outstanding","contact_id","donor_id","donor_type","fund_id","id","installment_plan_id","organization_id","remaining_payments","soft_credits","status","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","tax_deductible_amount"],"type":"object"}},"components/schemas/PledgeLevel":{"id":"components/schemas/PledgeLevel","kind":"json-schema","title":"PledgeLevel","data":{"properties":{"amount_per_payment":{"description":"The amount each payment can be","title":"Amount Per Payment","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"display_order":{"description":"The order in which to display the pledge level","format":"float","title":"Display Order","type":"number"},"id":{"description":"The unique, string identifier of this pledge level","pattern":"/^[\\w:|-]+$/","title":"ID","type":"string"},"name":{"description":"The name of the pledge level","title":"Name","type":"string"},"number_of_payments":{"description":"The number of payment in this pledge level","format":"float","title":"Number Of Payments","type":"number"},"payment_frequency":{"enum":["annual","monthly","quarterly"],"title":"Payment Frequency","type":"string"},"processing_day":{"description":"The day of the month on which to process payments","title":"Processing Day","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"total":{"description":"Total pledge amount for the pledge level","title":"Total","type":"string"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/PledgeNotice":{"id":"components/schemas/PledgeNotice","kind":"json-schema","title":"PledgeNotice","data":{"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"email":{"description":"The email to send","properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email","type":"object"},"id":{"description":"The unique, string identifier of this pledge notice","pattern":"/^[\\w:|-]+$/","title":"ID","type":"string"},"name":{"description":"The name of the pledge notice","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["email","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/PledgePayload":{"id":"components/schemas/PledgePayload","kind":"json-schema","title":"PledgePayload","data":{"additionalProperties":false,"properties":{"amount":{"description":"Gift amount","format":"float","title":"Amount","type":"number"},"anonymous":{"description":"Anonymous","title":"Anonymous","type":"boolean"},"appeal_id":{"description":"The id for the appeal associated with the gift","title":"Appeal","type":"string"},"campaign_id":{"description":"The id for the campaign associated with the gift","title":"Campaign","type":"string"},"contact_id":{"description":"The rolodex contact id for the gift giver","title":"Contact","type":"string"},"cover_transaction_costs":{"description":"If selected, the donor covers the transaction fees","title":"Cover Transaction Costs","type":"boolean"},"currency_code":{"description":"The currency code of the gift","title":"Currency Code","type":"string"},"currency_symbol":{"description":"Currency","title":"Currency Symbol","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"donor_type":{"description":"The donor type for the gift","enum":["contact","organization"],"title":"Donor Type","type":"string"},"fund_id":{"description":"The id for the fund associated with the gift","title":"Fund","type":"string"},"giving_process_id":{"description":"The process of that led to the gift","title":"Giving Process","type":"string"},"has_splits":{"description":"If true, this gift is split into different funds","title":"Has Splits","type":"boolean"},"installment_plan_id":{"description":"The installment plan for the pledge","title":"Installment Plan","type":"string"},"notes":{"description":"Notes about the gift","title":"Notes","type":"string"},"organization_id":{"description":"The organization id associated with this gift","title":"Organization","type":"string"},"premium_assignment":{"enum":["assigned","declined by donor","not applicable"],"title":"Premium Assignment","type":"string"},"premium_fair_market_value":{"description":"The amount of any premiums associated with the gift","format":"float","title":"Premium Fair Market Value","type":"number"},"premium_id":{"description":"If the user has selected a premium it is here","title":"Premium","type":"string"},"shipping_address":{"$ref":"#/components/schemas/Address"},"splits":{"description":"An array of fund allocations for this gift","items":{"additionalProperties":false,"properties":{"amount":{"description":"The amount for this allocation of the gift","format":"float","title":"Amount","type":"number"},"fund_id":{"description":"The id for the fund associated with the gift allocation","title":"Fund","type":"string"}},"required":["amount","fund_id"],"type":"object"},"type":"array"},"tribute_gift":{"description":"Whether or not this is a tribute gift","title":"Tribute Gift","type":"boolean"},"tribute_gift_info":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/Address"},"contact_id":{"description":"The optional linked contact","title":"Contact","type":"string"},"details":{"description":"Additional details","title":"Details","type":"string"},"email_address":{"format":"email","oneOf":[{"x-required":true}],"title":"Email Address","type":"string"},"inform_honoree":{"description":"If true, the honoree is informed about the gift","title":"Inform Honoree","type":"boolean"},"inform_honoree_by":{"enum":["email","mail"],"oneOf":[{"x-required":true}],"title":"Inform Honoree By","type":"string"},"message":{"description":"Message to send when notifying","oneOf":[{"x-required":true}],"title":"Message","type":"string"},"name":{"description":"The name","title":"Name","type":"string"},"type":{"enum":["in honor of","in memory of"],"title":"Type","type":"string"}},"required":["name","type"],"title":"Tribute Gift Info","type":"object"}},"required":["amount","contact_id","donor_type","fund_id","installment_plan_id","organization_id"],"type":"object"}},"components/schemas/PledgeSearchParameters":{"id":"components/schemas/PledgeSearchParameters","kind":"json-schema","title":"PledgeSearchParameters","data":{"additionalProperties":false,"properties":{"appeal_id":{"description":"Appeal ids to search","items":{"type":"string"},"title":"Appeal","type":"array"},"campaign_id":{"description":"Campaign ids to search","items":{"type":"string"},"title":"Campaign","type":"array"},"contact_id":{"description":"Contact ids for the donor","items":{"type":"string"},"title":"Contact","type":"array"},"date":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Date","type":"array"},"fund_id":{"description":"Fund ids to search","items":{"type":"string"},"title":"Fund","type":"array"},"ids":{"description":"IDs to search","items":{"type":"string"},"title":"Ids","type":"array"},"order_id":{"description":"Order ids to search","items":{"type":"string"},"title":"Order","type":"array"},"organization_id":{"description":"Organization ids for the donor","items":{"type":"string"},"title":"Organization","type":"array"},"status":{"description":"Recurring gift ids to search","items":{"type":"string"},"title":"Status","type":"array"},"type":{"description":"Types of the gifts","items":{"type":"string"},"title":"Type","type":"array"}},"type":"object"}},"components/schemas/PledgeSearchResults":{"id":"components/schemas/PledgeSearchResults","kind":"json-schema","title":"PledgeSearchResults","data":{"additionalProperties":false,"properties":{"appeal_id":{"description":"Appeal id for the gift","title":"Appeal","type":"string"},"campaign_id":{"description":"Campaign id for the gift","title":"Campaign","type":"string"},"contact_id":{"description":"Contact ids for the donor","title":"Contact","type":"string"},"date":{"title":"Date","type":"string"},"fund_id":{"description":"Fund id for the gift","title":"Fund","type":"string"},"id":{"description":"ID of the gift","title":"ID","type":"string"},"order_id":{"description":"Order id for the gift","title":"Order","type":"string"},"organization_id":{"description":"Organization ids for the donor","title":"Organization","type":"string"},"status":{"description":"Status","title":"Status","type":"string"},"type":{"description":"Types of the gifts","title":"Type","type":"string"}},"type":"object"}},"components/schemas/Premium":{"id":"components/schemas/Premium","kind":"json-schema","title":"Premium","data":{"additionalProperties":false,"properties":{"description":{"description":"Optional description","title":"Description","type":"string"},"fair_market_value":{"description":"The FMV of the premium, used to calculate the tax deductible value of the gift","format":"float","title":"Fair Market Value","type":"number"},"id":{"description":"The unique, string identifier of this premium","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"image_url":{"description":"Image to be displayed of the product","title":"Image Url","type":"string"},"is_active":{"description":"Whether or not this premium is active","title":"Is Active","type":"boolean"},"merchandise_id":{"description":"The merchandise linked to this premium","title":"Merchandise","type":"string"},"name":{"description":"The name of the premium","title":"Name","type":"string"},"quantity":{"description":"The quantity of merchandise to give","format":"float","title":"Quantity","type":"number"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["fair_market_value","id","merchandise_id","name","quantity","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/PreviewEmailRequest":{"id":"components/schemas/PreviewEmailRequest","kind":"json-schema","title":"PreviewEmailRequest","data":{"additionalProperties":false,"properties":{"destination_email_address":{"title":"Destination Email Address","type":"string"},"email_template":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email Template","type":"object"},"pledge_id":{"title":"Pledge","type":"string"},"recurring_gift_id":{"title":"Recurring Gift","type":"string"}},"required":["destination_email_address","recurring_gift_id"],"type":"object"}},"components/schemas/PreviewReceiptRequest":{"id":"components/schemas/PreviewReceiptRequest","kind":"json-schema","title":"PreviewReceiptRequest","data":{"additionalProperties":false,"properties":{"destination_email_address":{"title":"Destination Email Address","type":"string"},"email_template":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email Template","type":"object"},"gift_id":{"title":"Gift","type":"string"},"pledge_id":{"title":"Pledge","type":"string"}},"required":["destination_email_address","pledge_id"],"type":"object"}},"components/schemas/ProcessGiftInfo":{"id":"components/schemas/ProcessGiftInfo","kind":"json-schema","title":"ProcessGiftInfo","data":{"additionalProperties":false,"properties":{"donor_info":{"additionalProperties":false,"description":"Optional info for public gifts","properties":{},"title":"Donor Info","type":"object"},"electronic_payment_info":{"additionalProperties":false,"description":"The payment info","properties":{},"title":"Electronic Payment Info","type":"object"},"gift_payload":{"additionalProperties":false,"properties":{"amount":{"description":"Gift amount","format":"float","title":"Amount","type":"number"},"anonymous":{"description":"Anonymous","title":"Anonymous","type":"boolean"},"appeal_id":{"description":"The id for the appeal associated with the gift","title":"Appeal","type":"string"},"campaign_id":{"description":"The id for the campaign associated with the gift","title":"Campaign","type":"string"},"contact_id":{"description":"The rolodex contact id for the gift giver","oneOf":[{"x-required":true}],"title":"Contact","type":"string"},"cover_transaction_costs":{"description":"If selected, the donor covers the transaction fees","title":"Cover Transaction Costs","type":"boolean"},"currency_code":{"description":"The currency code of the gift","title":"Currency Code","type":"string"},"currency_symbol":{"description":"Currency","title":"Currency Symbol","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"donor_type":{"description":"The donor type for the gift","enum":["contact","organization"],"title":"Donor Type","type":"string"},"fund_id":{"description":"The id for the fund associated with the gift","title":"Fund","type":"string"},"giving_process_id":{"description":"The process of that led to the gift","title":"Giving Process","type":"string"},"has_splits":{"description":"If true, this gift is split into different funds","title":"Has Splits","type":"boolean"},"make_recurring":{"description":"Whether to make this a recurring gift","title":"Make Recurring","type":"boolean"},"notes":{"description":"Notes about the gift","title":"Notes","type":"string"},"organization_id":{"description":"The organization id associated with this gift","oneOf":[{"x-required":true}],"title":"Organization","type":"string"},"premium_assignment":{"enum":["assigned","declined by donor","not applicable"],"title":"Premium Assignment","type":"string"},"premium_fair_market_value":{"description":"The amount of any premiums associated with the gift","format":"float","title":"Premium Fair Market Value","type":"number"},"premium_id":{"description":"If the user has selected a premium it is here","title":"Premium","type":"string"},"recurring_frequency":{"enum":["monthly","quarterly","yearly"],"title":"Recurring Frequency","type":"string"},"recurring_gift_end_date":{"description":"optional end date for gift","title":"Recurring Gift End Date","type":"string"},"shipping_address":{"$ref":"#/components/schemas/Address"},"splits":{"description":"An array of fund allocations for this gift","items":{"additionalProperties":false,"properties":{"amount":{"description":"The amount for this allocation of the gift","format":"float","title":"Amount","type":"number"},"fund_id":{"description":"The id for the fund associated with the gift allocation","title":"Fund","type":"string"}},"required":["amount","fund_id"],"type":"object"},"type":"array"},"tribute_gift":{"description":"Whether or not this is a tribute gift","title":"Tribute Gift","type":"boolean"},"tribute_gift_info":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/Address"},"contact_id":{"description":"The optional linked contact","title":"Contact","type":"string"},"details":{"description":"Additional details","title":"Details","type":"string"},"email_address":{"format":"email","oneOf":[{"x-required":true}],"title":"Email Address","type":"string"},"inform_honoree":{"description":"If true, the honoree is informed about the gift","title":"Inform Honoree","type":"boolean"},"inform_honoree_by":{"enum":["email","mail"],"oneOf":[{"x-required":true}],"title":"Inform Honoree By","type":"string"},"message":{"description":"Message to send when notifying","oneOf":[{"x-required":true}],"title":"Message","type":"string"},"name":{"description":"The name","title":"Name","type":"string"},"type":{"enum":["in honor of","in memory of"],"title":"Type","type":"string"}},"required":["name","type"],"title":"Tribute Gift Info","type":"object"}},"required":["amount","donor_type","fund_id"],"title":"Gift Payload","type":"object"}},"required":["gift_payload"],"type":"object"}},"components/schemas/ProcessPledgeInfo":{"id":"components/schemas/ProcessPledgeInfo","kind":"json-schema","title":"ProcessPledgeInfo","data":{"additionalProperties":false,"properties":{"donor_info":{"additionalProperties":false,"description":"Optional info for public pledges","properties":{},"title":"Donor Info","type":"object"},"electronic_payment_info":{"additionalProperties":false,"description":"The payment info","properties":{},"title":"Electronic Payment Info","type":"object"},"pledge_payload":{"additionalProperties":false,"properties":{"amount":{"description":"Gift amount","format":"float","title":"Amount","type":"number"},"anonymous":{"description":"Anonymous","title":"Anonymous","type":"boolean"},"appeal_id":{"description":"The id for the appeal associated with the gift","title":"Appeal","type":"string"},"campaign_id":{"description":"The id for the campaign associated with the gift","title":"Campaign","type":"string"},"contact_id":{"description":"The rolodex contact id for the gift giver","oneOf":[{"x-required":true}],"title":"Contact","type":"string"},"cover_transaction_costs":{"description":"If selected, the donor covers the transaction fees","title":"Cover Transaction Costs","type":"boolean"},"currency_code":{"description":"The currency code of the gift","title":"Currency Code","type":"string"},"currency_symbol":{"description":"Currency","title":"Currency Symbol","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"donor_type":{"description":"The donor type for the gift","enum":["contact","organization"],"title":"Donor Type","type":"string"},"fund_id":{"description":"The id for the fund associated with the gift","title":"Fund","type":"string"},"giving_process_id":{"description":"The process of that led to the gift","title":"Giving Process","type":"string"},"has_splits":{"description":"If true, this gift is split into different funds","title":"Has Splits","type":"boolean"},"installment_plan_id":{"description":"The installment plan for the pledge","title":"Installment Plan","type":"string"},"notes":{"description":"Notes about the gift","title":"Notes","type":"string"},"organization_id":{"description":"The organization id associated with this gift","oneOf":[{"x-required":true}],"title":"Organization","type":"string"},"premium_assignment":{"enum":["assigned","declined by donor","not applicable"],"title":"Premium Assignment","type":"string"},"premium_fair_market_value":{"description":"The amount of any premiums associated with the gift","format":"float","title":"Premium Fair Market Value","type":"number"},"premium_id":{"description":"If the user has selected a premium it is here","title":"Premium","type":"string"},"shipping_address":{"$ref":"#/components/schemas/Address"},"splits":{"description":"An array of fund allocations for this gift","items":{"additionalProperties":false,"properties":{"amount":{"description":"The amount for this allocation of the gift","format":"float","title":"Amount","type":"number"},"fund_id":{"description":"The id for the fund associated with the gift allocation","title":"Fund","type":"string"}},"required":["amount","fund_id"],"type":"object"},"type":"array"},"tribute_gift":{"description":"Whether or not this is a tribute gift","title":"Tribute Gift","type":"boolean"},"tribute_gift_info":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/Address"},"contact_id":{"description":"The optional linked contact","title":"Contact","type":"string"},"details":{"description":"Additional details","title":"Details","type":"string"},"email_address":{"format":"email","oneOf":[{"x-required":true}],"title":"Email Address","type":"string"},"inform_honoree":{"description":"If true, the honoree is informed about the gift","title":"Inform Honoree","type":"boolean"},"inform_honoree_by":{"enum":["email","mail"],"oneOf":[{"x-required":true}],"title":"Inform Honoree By","type":"string"},"message":{"description":"Message to send when notifying","oneOf":[{"x-required":true}],"title":"Message","type":"string"},"name":{"description":"The name","title":"Name","type":"string"},"type":{"enum":["in honor of","in memory of"],"title":"Type","type":"string"}},"required":["name","type"],"title":"Tribute Gift Info","type":"object"}},"required":["amount","donor_type","fund_id","installment_plan_id"],"title":"Pledge Payload","type":"object"}},"required":["pledge_payload"],"type":"object"}},"components/schemas/Product":{"id":"components/schemas/Product","kind":"json-schema","title":"Product","data":{"additionalProperties":false,"properties":{"allow_customer_to_choose_installment_plan":{"description":"If true, the customer can choose their installment plan","title":"Allow Customer To Choose Installment Plan","type":"boolean"},"bulk_pricing_rules":{"items":{"additionalProperties":false,"properties":{"discount_amount":{"description":"The percentage/flat rate","format":"float","minimum":0,"title":"Discount Amount","type":"number"},"discount_type":{"description":"The type of discount rule","enum":["flat rate","percentage"],"title":"Discount Type","type":"string"},"ending_range":{"description":"The ending range of the rule","minimum":0,"title":"Ending Range","type":"integer"},"starting_range":{"description":"The starting range of the rule","minimum":0,"title":"Starting Range","type":"integer"}},"required":["discount_amount","discount_type"],"type":"object"},"minItems":1,"type":"array"},"bundled_products":{"items":{"additionalProperties":false,"properties":{"member_price":{"description":"The member price","format":"double","title":"Member Price","type":"number"},"price":{"description":"The price to bundle","format":"double","title":"Price","type":"number"},"product_id":{"description":"The product ID","title":"Product","type":"string"},"product_type":{"description":"The product type","title":"Product Type","type":"string"},"quantity":{"description":"The quantity to bundle","title":"Quantity","type":"integer"},"type":{"enum":["bundled product","inline bundled product"],"title":"Type","type":"string"}},"required":["product_id","product_type","quantity","type"],"type":"object"},"minItems":1,"type":"array"},"bundled_products_inventory_handling":{"description":"Whether to track inventory for the entire bundle, or for each product separately","enum":["bundle","each product"],"title":"Bundled Products Inventory Handling","type":"string"},"business_unit_id":{"description":"The business unit of the product","title":"Business Unit","type":"string"},"cancellation_fee":{"description":"Cancellation fees associated with this product","format":"double","title":"Cancellation Fee","type":"number"},"commerce_entitlements_to_create":{"items":{"additionalProperties":false,"properties":{"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"quantity":{"description":"The quantity","format":"float","title":"Quantity","type":"number"},"relative_expiration_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"},"type_id":{"description":"The type of entitlement","title":"Type","type":"string"}},"required":["expiration_type","type_id"],"type":"object"},"type":"array"},"coupon_codes":{"items":{"additionalProperties":false,"properties":{"coupon_code_generation_process_id":{"description":"The process by which the coupons are generated","title":"Coupon Code Generation Process","type":"string"},"coupon_code_type":{"enum":["multi use","single use"],"title":"Coupon Code Type","type":"string"},"coupon_id":{"title":"Coupon","type":"string"},"coupon_type":{"title":"Coupon Type","type":"string"},"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"maximum_number_of_total_uses":{"description":"The maximum number of total uses","minimum":1,"oneOf":[{"enum":[1],"x-required":true}],"title":"Maximum Number Of Total Uses","type":"integer"},"maximum_number_of_uses_per_customer":{"description":"The maximum number of total uses for a given customer","minimum":1,"oneOf":[{"enum":[1],"x-required":true}],"title":"Maximum Number Of Uses Per Customer","type":"integer"},"quantity":{"description":"The number of coupons to generate","maximum":250,"title":"Quantity","type":"integer"},"relative_expiration_date":{"additionalProperties":false,"description":"Expiration date relative to purchase","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"},"restrict_to_contact":{"description":"If true, the code generated is restricted to the contact who made the purchase","title":"Restrict To Contact","type":"boolean"},"restrict_to_organization":{"description":"If true, the code generated is restricted to the organization made the purchase","title":"Restrict To Organization","type":"boolean"}},"required":["coupon_code_generation_process_id","coupon_code_type","coupon_id","coupon_type","quantity"],"type":"object"},"minItems":1,"type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"custom_pricing_options":{"additionalProperties":false,"properties":{"lambda_function_id":{"description":"The custom lambda function to use","title":"Lambda Function","type":"string"}},"required":["lambda_function_id"],"title":"Custom Pricing Options","type":"object"},"document_entitlements_to_create":{"items":{"additionalProperties":false,"properties":{"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"file_cabinet_id":{"description":"The file cabinet","title":"File Cabinet","type":"string"},"item_id":{"description":"The item","title":"Item","type":"string"},"library_path":{"description":"The optional path that items will be mounted onto the digital library","title":"Library Path","type":"string"},"relative_expiration_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"}},"required":["expiration_type","file_cabinet_id"],"type":"object"},"type":"array"},"enable_bulk_pricing":{"description":"Whether or not bulk pricing is enabled","title":"Enable Bulk Pricing","type":"boolean"},"enable_bundled_products":{"description":"Whether to enable bundled products","title":"Enable Bundled Products","type":"boolean"},"enable_cancellation_fees":{"description":"Whether or not cancellation fees are applicable","title":"Enable Cancellation Fees","type":"boolean"},"enable_commerce_entitlement_creation":{"description":"If set, document entitlements will be created to access folders or documents","title":"Enable Commerce Entitlement Creation","type":"boolean"},"enable_coupon_code_generation":{"description":"If true, purchasing this product will generate coupons","title":"Enable Coupon Code Generation","type":"boolean"},"enable_custom_pricing":{"description":"If set, the order engine will call out to a custom lambda function for custom/complex pricing","title":"Enable Custom Pricing","type":"boolean"},"enable_document_entitlement_creation":{"description":"If set, document entitlements will be created to access folders or documents","title":"Enable Document Entitlement Creation","type":"boolean"},"enable_product_confirmation_email":{"description":"If enabled, a custom email goes out whenever this product is ordered","title":"Enable Product Confirmation Email","type":"boolean"},"enable_purchase_limits":{"description":"If true, purchase limits are in place for this product","title":"Enable Purchase Limits","type":"boolean"},"enable_purchasing_eligibility":{"description":"If set, purchases of this merchandise are restricted","title":"Enable Purchasing Eligibility","type":"boolean"},"enable_special_prices":{"description":"Whether to enable special pricing logic","title":"Enable Special Prices","type":"boolean"},"enable_task_generation":{"description":"If set, tasks will be generated","title":"Enable Task Generation","type":"boolean"},"fund_id":{"description":"The fund to which this product belongs","title":"Fund","type":"string"},"hide_from_portal":{"description":"If set, this product should not be shown in the portal","title":"Hide From Portal","type":"boolean"},"id":{"description":"The unique, string identifier of this miscellaneous product","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"installment_plan_options":{"items":{"additionalProperties":false,"properties":{"additional_cost":{"description":"The additional cost of the installment plan","format":"double","title":"Additional Cost","type":"number"},"installment_plan_id":{"description":"The installment plan that this product supports","title":"Installment Plan","type":"string"},"is_default":{"description":"Whether this is the default installment plan option","title":"Is Default","type":"boolean"}},"required":["installment_plan_id"],"type":"object"},"minItems":1,"type":"array"},"is_active":{"description":"Whether this product is active/used","title":"Is Active","type":"boolean"},"name":{"description":"The name of the miscellaneous product","title":"Name","type":"string"},"notes":{"description":"Notes","title":"Notes","type":"string"},"portal_options":{"additionalProperties":false,"properties":{"available_from":{"description":"The date from which this product should be available","format":"date-time","title":"Available From","type":"string"},"available_until":{"description":"The date until which this product should be available","format":"date-time","title":"Available Until","type":"string"}},"title":"Portal Options","type":"object"},"product_confirmation_email_options":{"additionalProperties":false,"properties":{"product_confirmation_email_id":{"oneOf":[{"x-required":true}],"title":"Product Confirmation Email","type":"string"},"product_specific_email":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Product Specific Email","type":"object"},"type":{"enum":["product specific","shared"],"title":"Type","type":"string"}},"title":"Product Confirmation Email Options","type":"object"},"publish_to_portal":{"description":"Whether or not this product should be available in the portal","title":"Publish To Portal","type":"boolean"},"purchase_limits":{"additionalProperties":false,"properties":{"error_message":{"description":"The error message to show","title":"Error Message","type":"string"},"maximum":{"description":"The maximum","format":"float","title":"Maximum","type":"number"},"relative_time_window":{"additionalProperties":false,"description":"the time window","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Time Window","type":"object"},"time_period":{"enum":["all time","sliding time window"],"title":"Time Period","type":"string"},"type":{"enum":["per customer"],"title":"Type","type":"string"}},"required":["maximum","time_period","type"],"title":"Purchase Limits","type":"object"},"purchasing_eligibility_criteria":{"title":"Purchasing Eligibility Criteria","type":"object"},"special_prices":{"items":{"additionalProperties":false,"properties":{"criteria":{"title":"Criteria","type":"object"},"enable_formula":{"description":"if set, a formula is used to calculate the price. If the formula fails, the price is used","title":"Enable Formula","type":"boolean"},"formula":{"description":"The formula evaluated using the expr-eval npm package","oneOf":[{"x-required":true}],"title":"Formula","type":"string"},"name":{"title":"Name","type":"string"},"price":{"format":"float","title":"Price","type":"number"}},"required":["criteria","price"],"type":"object"},"minItems":1,"type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"tasks_to_generate":{"items":{"additionalProperties":false,"properties":{"assignee_type":{"enum":["assignment role","queue","user"],"title":"Assignee Type","type":"string"},"assignment_role_id":{"description":"The assignment role that should receive the ask","oneOf":[{"x-required":true}],"title":"Assignment Role","type":"string"},"description":{"description":"A description","title":"Description","type":"string"},"due_date_type":{"description":"Whether there is a due date","enum":["none","relative date","specific date"],"title":"Due Date Type","type":"string"},"name":{"description":"The name of the task","title":"Name","type":"string"},"notify_assignees":{"description":"Notify assignee when the task is created","title":"Notify Assignees","type":"boolean"},"priority":{"enum":["high","low","normal","urgent"],"title":"Priority","type":"string"},"queue_id":{"description":"The queue that should be assigned the ask","oneOf":[{"x-required":true}],"title":"Queue","type":"string"},"relative_due_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Due Date","type":"object"},"specific_due_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Specific Due Date","type":"string"},"type_id":{"description":"The type of task","title":"Type","type":"string"},"user_id":{"description":"The user that should be assigned the ask","oneOf":[{"x-required":true}],"title":"User","type":"string"}},"required":["assignee_type","due_date_type","name","type_id"],"type":"object"},"type":"array"},"type":{"description":"The product type","enum":["fundraising-products"],"title":"Type","type":"string"}},"required":["bulk_pricing_rules","bundled_products","business_unit_id","coupon_codes","custom_pricing_options","fund_id","id","installment_plan_options","name","product_confirmation_email_options","purchase_limits","special_prices","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/RecurringGift":{"id":"components/schemas/RecurringGift","kind":"json-schema","title":"RecurringGift","data":{"additionalProperties":false,"properties":{"amount":{"description":"The total amount of the gift","format":"float","title":"Amount","type":"number"},"appeal_id":{"description":"The appeal","title":"Appeal","type":"string"},"campaign_id":{"description":"The campaign","title":"Campaign","type":"string"},"contact_id":{"description":"The rolodex contact id for the gift giver","title":"Contact","type":"string"},"currency_code":{"description":"The currency code of the gift","title":"Currency Code","type":"string"},"currency_symbol":{"description":"Currency","title":"Currency Symbol","type":"string"},"date":{"description":"The initial date of the recurring gift","title":"Date","type":"string"},"donor_id":{"description":"The donor ID","title":"Donor","type":"string"},"donor_type":{"description":"The donor type for the gift","enum":["contact","organization"],"title":"Donor Type","type":"string"},"end_at":{"description":"The date at which this recurring gift should end","title":"End At","type":"string"},"frequency":{"enum":["annually","monthly","quarterly"],"title":"Frequency","type":"string"},"fund_id":{"description":"The fund ID for this recurring gift","title":"Fund","type":"string"},"id":{"description":"The ID of the target gift","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"last_gift_id":{"description":"The last gift created by this recurring gift","title":"Last Gift","type":"string"},"last_processing_date":{"description":"The last time this recurring gift was processed","format":"date-time","title":"Last Processing Date","type":"string"},"next_gift_date":{"description":"The next date that this should be gift should be processed ","title":"Next Gift Date","type":"string"},"notes":{"description":"Notes for the recurring gift","title":"Notes","type":"string"},"number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recurring gift #"},"children":[]}]}]}],"format":"float","title":"Number","type":"number"},"order_id":{"description":"The originating gift order","title":"Order","type":"string"},"organization_id":{"description":"The organization id associated with this gift","title":"Organization","type":"string"},"payment_info":{"additionalProperties":false,"description":"Payment information for the recurring gift","properties":{"card_expiration":{"description":"The expiration date of the card","title":"Card Expiration","type":"string"},"card_type":{"description":"The type of card being used, or CHECK if electronic check","enum":["american express","discover","electronic check","mastercard","other","visa"],"title":"Card Type","type":"string"},"merchant_account_tokens":{"items":{"additionalProperties":false,"properties":{"merchant_account_id":{"description":"The merchant account id","title":"Merchant Account","type":"string"},"token":{"description":"The token representing the card/electronic check info","title":"Token","type":"string"}},"required":["merchant_account_id","token"],"type":"object"},"minItems":1,"type":"array"},"payment_account":{"description":"The masked payment account information","title":"Payment Account","type":"string"},"payment_origin":{"description":"Whether or not this is a saved payment method","enum":["ad hoc","saved","single token"],"title":"Payment Origin","type":"string"},"token":{"description":"For integrated payments, the single token","title":"Token","type":"string"},"type":{"description":"The type of payment","enum":["credit card","electronic check"],"title":"Type","type":"string"}},"required":["payment_origin","type"],"title":"Payment Info","type":"object"},"status":{"enum":["active","cancelled","completed","payment error","suspended"],"title":"Status","type":"string"},"suspended_until":{"description":"If suspended, the date at which the suspension should be lifted","title":"Suspended Until","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"total_amount_given":{"description":"The total amount given in this recurring gift","format":"float","title":"Total Amount Given","type":"number"},"total_number_of_gifts":{"description":"The total amount number of gifts given in this recurring gift","format":"float","title":"Total Number Of Gifts","type":"number"}},"required":["amount","contact_id","date","donor_id","donor_type","frequency","fund_id","id","next_gift_date","order_id","organization_id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/RecurringGiftSearchParameters":{"id":"components/schemas/RecurringGiftSearchParameters","kind":"json-schema","title":"RecurringGiftSearchParameters","data":{"additionalProperties":false,"properties":{"status":{"items":{"type":"string"},"title":"Status","type":"array"}},"type":"object"}},"components/schemas/RecurringGiftSearchResults":{"id":"components/schemas/RecurringGiftSearchResults","kind":"json-schema","title":"RecurringGiftSearchResults","data":{"additionalProperties":false,"properties":{"status":{"title":"Status","type":"string"}},"type":"object"}},"components/schemas/Setting":{"id":"components/schemas/Setting","kind":"json-schema","title":"Setting","data":{"additionalProperties":false,"properties":{"allow_customer_to_choose_installment_plan":{"description":"If true, the customer can choose their installment plan","title":"Allow Customer To Choose Installment Plan","type":"boolean"},"apply_soft_credits_to_relationships":{"description":"Whether or not to automatically apply soft credits to relationships","title":"Apply Soft Credits To Relationships","type":"boolean"},"automatic_donor_club_assignment":{"enum":["by lifetime giving","by recent giving","disabled"],"title":"Automatic Donor Club Assignment","type":"string"},"automatically_create_gifts_from_donations":{"description":"If true, gifts are automatically created from donations","title":"Automatically Create Gifts From Donations","type":"boolean"},"bank_account_id":{"description":"The default bank account that the store should use to receive payments","title":"Bank Account","type":"string"},"bill_my_organization_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Bill My Organization Options","type":"object"},"bill_my_parent_organization_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Bill My Parent Organization Options","type":"object"},"business_unit_id":{"description":"The business unit of the store","title":"Business Unit","type":"string"},"cancellation_fee_product_id":{"description":"The ID of the product used for cancellation fees","title":"Cancellation Fee Product","type":"string"},"checkout_donation_options":{"additionalProperties":false,"properties":{"simple_checkout_donation_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"allow_user_to_specify_custom_amount":{"description":"If set, the user can specify their own custom donation","title":"Allow User To Specify Custom Amount","type":"boolean"},"donation_ask_text":{"description":"The text shown to the user when making the donation","title":"Donation Ask Text","type":"string"},"donation_denominations":{"items":{"format":"double","type":"number"},"title":"Donation Denominations","type":"array"},"donation_information":{"description":"Additional information about the donation","title":"Donation Information","type":"string"},"donation_product_id":{"description":"The misc product that should be used","title":"Donation Product","type":"string"},"override_donation_denominations":{"description":"If set, donation denominations are specified here and the defaults are not used","title":"Override Donation Denominations","type":"boolean"},"suggested_donation":{"description":"A suggested donation","format":"double","title":"Suggested Donation","type":"number"}},"required":["donation_product_id"],"title":"Simple Checkout Donation Options","type":"object"},"type":{"enum":["simple"],"title":"Type","type":"string"}},"title":"Checkout Donation Options","type":"object"},"credit_card_minimum_range_end":{"description":"If set, the maximum amount for which credit cards can be taken","format":"float","title":"Credit Card Minimum Range End","type":"number"},"credit_card_minimum_range_start":{"description":"If set, the minimum amount for which credit cards can be taken","format":"float","title":"Credit Card Minimum Range Start","type":"number"},"credit_card_mode":{"description":"Determines whether or not credit cards are accepted","enum":["disabled","enabled","range"],"title":"Credit Card Mode","type":"string"},"credit_card_processing_fee_mode":{"description":"Determines how credit card processing fees should be handled","enum":["charge","do not charge","prompt user"],"title":"Credit Card Processing Fee Mode","type":"string"},"credit_card_processing_fee_options":{"additionalProperties":false,"properties":{"fee_percentage":{"description":"The fee percentage to charge for credit card processing ","format":"float","title":"Fee Percentage","type":"number"},"maximum_fee":{"description":"The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged","format":"float","title":"Maximum Fee","type":"number"},"minimum_fee":{"description":"The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged","format":"float","title":"Minimum Fee","type":"number"},"product_id":{"description":"The misc product to use for the credit card processing","title":"Product","type":"string"},"prompt_sub_text":{"description":"Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used","title":"Prompt Sub Text","type":"string"},"prompt_text":{"description":"The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used","title":"Prompt Text","type":"string"}},"required":["fee_percentage","product_id"],"title":"Credit Card Processing Fee Options","type":"object"},"default_fund_id":{"description":"The default fund to use for donations","title":"Default Fund","type":"string"},"default_giving_process_id":{"description":"The default giving process, when non is specified","title":"Default Giving Process","type":"string"},"disable_electronic_payment_vaulting":{"description":"If set, in the portal people are not allowed to save credit cards","title":"Disable Electronic Payment Vaulting","type":"boolean"},"donation_fund_mappings":{"items":{"additionalProperties":false,"properties":{"appeal_id":{"description":"The optional appeal","title":"Appeal","type":"string"},"campaign_id":{"description":"The optional campaign","title":"Campaign","type":"string"},"donation_product_id":{"description":"The product","title":"Donation Product","type":"string"},"fund_id":{"description":"The fund","title":"Fund","type":"string"}},"required":["donation_product_id","fund_id"],"type":"object"},"minItems":1,"type":"array"},"donation_product_giving_process_id":{"description":"The giving process to use for donation products; if not set, the default giving process is used","title":"Donation Product Giving Process","type":"string"},"donor_club_giving_tiers":{"items":{"additionalProperties":false,"properties":{"donor_club_id":{"description":"The donor club to assign donors who meet this criteria","title":"Donor Club","type":"string"},"tier_end":{"description":"The maximum tier, INCLUSIVE","format":"float","title":"Tier End","type":"number"},"tier_start":{"description":"The minimum giving tier","format":"float","title":"Tier Start","type":"number"}},"required":["donor_club_id","tier_end","tier_start"],"type":"object"},"minItems":1,"type":"array"},"enable_bill_my_organization":{"description":"If set, the user has the option to bill their organization","title":"Enable Bill My Organization","type":"boolean"},"enable_bill_my_parent_organization":{"description":"If set, the user has the option to bill their organization's parent organization","title":"Enable Bill My Parent Organization","type":"boolean"},"enable_donations_at_checkout":{"description":"If selected, users will be prompted to make a donation upon checking out","title":"Enable Donations At Checkout","type":"boolean"},"enable_electronic_checks":{"description":"If set, electronic checks are allowed","title":"Enable Electronic Checks","type":"boolean"},"enable_pay_later":{"description":"If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed","title":"Enable Pay Later","type":"boolean"},"enable_payroll_deduction":{"description":"If set, payroll deduction is allowed","title":"Enable Payroll Deduction","type":"boolean"},"enable_split_payments":{"description":"If set, users are allowed to split payments","title":"Enable Split Payments","type":"boolean"},"installment_plan_options":{"items":{"additionalProperties":false,"properties":{"additional_cost":{"description":"The additional cost of the installment plan","format":"double","title":"Additional Cost","type":"number"},"installment_plan_id":{"description":"The installment plan that this product supports","title":"Installment Plan","type":"string"},"is_default":{"description":"Whether this is the default installment plan option","title":"Is Default","type":"boolean"}},"required":["installment_plan_id"],"type":"object"},"minItems":1,"type":"array"},"invoice_payment_terms_id":{"description":"The payment terms for invoices; if left blank, default is used","title":"Invoice Payment Terms","type":"string"},"invoice_template_id":{"description":"The template to use for invoices created during this process","title":"Invoice Template","type":"string"},"merchant_account_id":{"description":"The merchant account that the store should use to receive payments","title":"Merchant Account","type":"string"},"notes":{"description":"The notes on the setting","title":"Notes","type":"string"},"pay_later_options":{"additionalProperties":false,"properties":{"billing_address":{"enum":["do not show","optional","required"],"title":"Billing Address","type":"string"},"purchase_order_number":{"enum":["do not show","optional","required"],"title":"Purchase Order Number","type":"string"},"reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reference #"},"children":[]}]}]}],"title":"Reference Number","type":"string"}},"title":"Pay Later Options","type":"object"},"preceding_months":{"format":"float","minimum":1,"title":"Preceding Months","type":"number"},"public_giving_page_captcha_mode":{"description":"The capatcha mode for public giving","enum":["disabled","v3"],"title":"Public Giving Page Captcha Mode","type":"string"},"public_giving_page_captcha_options":{"additionalProperties":false,"properties":{"site_key":{"description":"Site key","title":"Site Key","type":"string"}},"required":["site_key"],"title":"Public Giving Page Captcha Options","type":"object"},"restocking_fee_product_id":{"description":"The ID of the product used for restocking fees","title":"Restocking Fee Product","type":"string"},"soft_credit_relationships":{"items":{"additionalProperties":false,"properties":{"direction":{"enum":["both","left to right","right to left"],"title":"Direction","type":"string"},"percentage":{"description":"The percentage to attribute gifts","format":"float","maximum":100,"minimum":0,"title":"Percentage","type":"number"},"relationship_type_id":{"description":"The relationship type","title":"Relationship Type","type":"string"}},"required":["direction","percentage","relationship_type_id"],"type":"object"},"minItems":1,"type":"array"},"special_instructions":{"description":"Instructions shown to the user","title":"Special Instructions","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"use_pro_forma_invoices":{"description":"Whether to use pro forma invoices when user elects to pay later","title":"Use Pro Forma Invoices","type":"boolean"}},"required":["bank_account_id","business_unit_id","checkout_donation_options","credit_card_processing_fee_options","default_fund_id","default_giving_process_id","donation_fund_mappings","donor_club_giving_tiers","installment_plan_options","merchant_account_id","preceding_months","public_giving_page_captcha_options","soft_credit_relationships","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/StandardQueryDefinition":{"id":"components/schemas/StandardQueryDefinition","kind":"json-schema","title":"StandardQueryDefinition","data":{"additionalProperties":false,"properties":{"category":{"title":"Category","type":"string"},"definition":{"additionalProperties":false,"properties":{},"title":"Definition","type":"object"},"id":{"title":"ID","type":"string"},"name":{"title":"Name","type":"string"}},"type":"object"}},"components/schemas/Statistic":{"id":"components/schemas/Statistic","kind":"json-schema","title":"Statistic","data":{"additionalProperties":false,"properties":{"dataSource":{"description":"The datasource used to generate this value","title":"Datasource","type":"string"},"error":{"description":"If the cache encountered an error, this is it","title":"Error","type":"string"},"id":{"description":"The unique, string identifier of this statistic","pattern":"^[\\w-:%\\/]+$","title":"ID","type":"string"},"name":{"description":"The name of the statistic","title":"Name","type":"string"},"status":{"description":"The description of the statistic","enum":["error","processing","valid"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"value":{"description":"The numeric value of the statistic","format":"float","title":"Value","type":"number"},"value_difference_numeric":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a value & previous value is present, this is the numeric difference"},"children":[]}]}]}],"format":"float","title":"Value Difference Numeric","type":"number"},"value_difference_percentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a value & previous value is present, this is the percentage difference"},"children":[]}]}]}],"format":"float","title":"Value Difference Percentage","type":"number"},"value_for_previous_period":{"description":"For statistics that can compare values from a previous period, this is the value","format":"float","title":"Value For Previous Period","type":"number"},"values":{"description":"If the stat hs values in a row form, this variable contains it","items":{"additionalProperties":false,"properties":{},"type":"object"},"type":"array"}},"required":["id","name","status","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","value"],"type":"object"}},"components/schemas/StepFunctionExecutionToken":{"id":"components/schemas/StepFunctionExecutionToken","kind":"json-schema","title":"StepFunctionExecutionToken","data":{"additionalProperties":false,"properties":{"executionArn":{"description":"The arn of the execution","title":"Executionarn","type":"string"},"notification_channel":{"description":"The id of the channel where progress updates will be posted","title":"Notification Channel","type":"string"},"notification_publishKey":{"description":"The publish key for the channel where progress updates will be posted","title":"Notification Publishkey","type":"string"},"notification_subscribeKey":{"description":"The subscribe key for the channel where progress updates will be posted","title":"Notification Subscribekey","type":"string"},"start_date":{"description":"The start date of the execution","format":"date-time","title":"Start Date","type":"string"}},"required":["executionArn"],"type":"object"}},"schema_518":{"kind":"json-schema","data":{"type":"string"},"id":"schema_518"},"schema_519":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Appeal"},"type":"array"},"id":"schema_519"},"schema_520":{"kind":"json-schema","data":{"type":"object","properties":{"Access-Control-Allow-Headers":{"type":"string"},"Access-Control-Allow-Methods":{"type":"string"},"Access-Control-Allow-Origin":{"type":"string"}}},"id":"schema_520"},"schema_521":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/PatchDirective"},"type":"array"},"id":"schema_521"},"schema_522":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/BillingTemplate"},"type":"array"},"id":"schema_522"},"schema_523":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/DonorClub"},"type":"array"},"id":"schema_523"},"schema_524":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/DonorLevel"},"type":"array"},"id":"schema_524"},"schema_525":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/DonorStatementTemplate"},"type":"array"},"id":"schema_525"},"schema_526":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/FundCategory"},"type":"array"},"id":"schema_526"},"schema_527":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Fund"},"type":"array"},"id":"schema_527"},"schema_528":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/GiftNotice"},"type":"array"},"id":"schema_528"},"schema_529":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Gift"},"type":"array"},"id":"schema_529"},"schema_530":{"kind":"json-schema","data":{"type":"object"},"id":"schema_530"},"schema_531":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/GivingProcess"},"type":"array"},"id":"schema_531"},"schema_532":{"kind":"json-schema","data":{"type":"string","enum":["contact","organization"]},"id":"schema_532"},"schema_533":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/PledgeLevel"},"type":"array"},"id":"schema_533"},"schema_534":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/PledgeNotice"},"type":"array"},"id":"schema_534"},"schema_535":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Premium"},"type":"array"},"id":"schema_535"},"schema_536":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Product"},"type":"array"},"id":"schema_536"},"schema_537":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/RecurringGift"},"type":"array"},"id":"schema_537"},"schema_538":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_538"}},"exampleStore":{},"securitySchemeStore":{"knox-authorizer":{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"servers":[{"url":"/_mock/apis/fundraising/fundraising-v1","isMockServer":true,"description":"Mock server"},{"url":"https://fundraising.api.rhythmsoftware.com"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/apis/fundraising/fundraising-v1","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/fundraising/fundraising-v1.json?download"},{"url":"/_bundle/apis/fundraising/fundraising-v1.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Fundraising","description":"Service providing access to Fundraising resources and features"}},"baseSlug":"/apis/fundraising/fundraising-v1","routesMapping":{}}