diff --git a/composer.json b/composer.json index 874b93b1..39b1be5f 100644 --- a/composer.json +++ b/composer.json @@ -1,69 +1,69 @@ { - "name": "groton-school/sky-api", - "description": "PHP client for Blackbaud's SKY API", - "license": "GPL-3.0", - "authors": [ - { - "name": "Seth Battis", - "email": "sbattis@groton.org" - } - ], - "require": { - "ext-curl": "*", - "battis/data-utilities": "^1.2", - "battis/lazy-secrets": "^1.1", - "battis/openapi-client.base": "@dev", - "battis/openapi-client.generator": "@dev", - "guzzlehttp/guzzle": "^7.4", - "league/oauth2-client": "^2.6" - }, - "require-dev": { - "friendsofphp/php-cs-fixer": "^3.51", - "phar-io/version": "^3.2", - "php-di/php-di": "^7.0", - "phpstan/phpstan": "^1.10", - "symplify/monorepo-builder": "^11.2" - }, - "autoload": { - "psr-4": { - "Blackbaud\\SKY\\": [ - "packages/altru-administration/src/", - "packages/altru-analysis/src/", - "packages/altru-constituent/src/", - "packages/nxt-data-integration/src/", - "packages/oneroster/src/", - "packages/school/src/" - ], - "GrotonSchool\\OAuth2\\Client\\Provider\\": "packages/oauth2/src/", - "GrotonSchool\\SKY\\": "src", - "GrotonSchool\\SKY\\AppEngine\\": "packages/appengine-client/src" - } - }, - "scripts": { - "build": [ - "./runner 'GrotonSchool\\SKY\\Build\\Runner::run'" - ] - }, - "config": { - "sort-packages": true - }, - "replace": { - "groton-school/oauth2-blackbaudsky": "self.version", - "groton-school/oauth2-blackbaudsky-example": "self.version", - "groton-school/sky-api-altru-analysis": "self.version", - "groton-school/sky-api-altru-constituent": "self.version", - "groton-school/sky-api-appengine": "self.version", - "groton-school/sky-api-nxt-data-integration": "self.version", - "groton-school/sky-api-oneroster": "self.version", - "groton-school/sky-api-school": "self.version", - "groton-school/sky-api.altru-analysis": "self.version", - "groton-school/sky-api.altru-constituent": "self.version", - "groton-school/sky-api.appengine-client": "self.version", - "groton-school/sky-api.appengine-client-example": "self.version", - "groton-school/sky-api.nxt-data-integration": "self.version", - "groton-school/sky-api.oneroster": "self.version", - "groton-school/sky-api.school": "self.version" - }, - "minimum-stability": "dev", - "prefer-stable": true + "name": "groton-school/sky-api", + "description": "PHP client for Blackbaud's SKY API", + "license": "GPL-3.0", + "authors": [ + { + "name": "Seth Battis", + "email": "sbattis@groton.org" + } + ], + "require": { + "ext-curl": "*", + "battis/data-utilities": "^1.2", + "battis/lazy-secrets": "^1.1", + "battis/openapi-client.base": "dev-main", + "battis/openapi-client.generator": "dev-main", + "guzzlehttp/guzzle": "^7.4", + "league/oauth2-client": "^2.6" + }, + "require-dev": { + "friendsofphp/php-cs-fixer": "^3.51", + "phar-io/version": "^3.2", + "php-di/php-di": "^7.0", + "phpstan/phpstan": "^1.10", + "symplify/monorepo-builder": "^11.2" + }, + "autoload": { + "psr-4": { + "Blackbaud\\SKY\\": [ + "packages/altru-administration/src/", + "packages/altru-analysis/src/", + "packages/altru-constituent/src/", + "packages/nxt-data-integration/src/", + "packages/oneroster/src/", + "packages/school/src/" + ], + "GrotonSchool\\OAuth2\\Client\\Provider\\": "packages/oauth2/src/", + "GrotonSchool\\SKY\\": "src", + "GrotonSchool\\SKY\\AppEngine\\": "packages/appengine-client/src" + } + }, + "scripts": { + "build": [ + "./runner 'GrotonSchool\\SKY\\Build\\Runner::run'" + ] + }, + "config": { + "sort-packages": true + }, + "replace": { + "groton-school/oauth2-blackbaudsky": "self.version", + "groton-school/oauth2-blackbaudsky-example": "self.version", + "groton-school/sky-api-altru-analysis": "self.version", + "groton-school/sky-api-altru-constituent": "self.version", + "groton-school/sky-api-appengine": "self.version", + "groton-school/sky-api-nxt-data-integration": "self.version", + "groton-school/sky-api-oneroster": "self.version", + "groton-school/sky-api-school": "self.version", + "groton-school/sky-api.altru-analysis": "self.version", + "groton-school/sky-api.altru-constituent": "self.version", + "groton-school/sky-api.appengine-client": "self.version", + "groton-school/sky-api.appengine-client-example": "self.version", + "groton-school/sky-api.nxt-data-integration": "self.version", + "groton-school/sky-api.oneroster": "self.version", + "groton-school/sky-api.school": "self.version" + }, + "minimum-stability": "dev", + "prefer-stable": true } diff --git a/composer.lock b/composer.lock index 427ae30c..aa77661e 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "f708e4f55d03f09caf37a9e5f771d86d", + "content-hash": "4772994eeeae9a79f0005b6975f7c37d", "packages": [ { "name": "battis/data-utilities", @@ -136,12 +136,12 @@ "source": { "type": "git", "url": "https://github.com/battis/openapi-client.base.git", - "reference": "0d0f38f3d23bdabad11718bc064dc9fe5f827f2b" + "reference": "9f0501c00832757ae287e03d0adae4ebf1fd9ece" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/battis/openapi-client.base/zipball/0d0f38f3d23bdabad11718bc064dc9fe5f827f2b", - "reference": "0d0f38f3d23bdabad11718bc064dc9fe5f827f2b", + "url": "https://api.github.com/repos/battis/openapi-client.base/zipball/9f0501c00832757ae287e03d0adae4ebf1fd9ece", + "reference": "9f0501c00832757ae287e03d0adae4ebf1fd9ece", "shasum": "" }, "require": { @@ -169,7 +169,7 @@ "issues": "https://github.com/battis/openapi-client.base/issues", "source": "https://github.com/battis/openapi-client.base/tree/main" }, - "time": "2024-05-09T16:07:25+00:00" + "time": "2024-05-09T17:01:40+00:00" }, { "name": "battis/openapi-client.generator", @@ -177,18 +177,18 @@ "source": { "type": "git", "url": "https://github.com/battis/openapi-client.generator.git", - "reference": "9473ddda18fc7298c678b00c4267d11403cbc5bc" + "reference": "a0c4eb0d7c2ca2a62fb00cba49ec032529b4da62" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/battis/openapi-client.generator/zipball/9473ddda18fc7298c678b00c4267d11403cbc5bc", - "reference": "9473ddda18fc7298c678b00c4267d11403cbc5bc", + "url": "https://api.github.com/repos/battis/openapi-client.generator/zipball/a0c4eb0d7c2ca2a62fb00cba49ec032529b4da62", + "reference": "a0c4eb0d7c2ca2a62fb00cba49ec032529b4da62", "shasum": "" }, "require": { "battis/data-utilities": "^1.2", "battis/openapi-client.base": "@dev", - "battis/php-generator": "@dev", + "battis/php-generator": "dev-main", "cebe/php-openapi": "^1.7", "friendsofphp/php-cs-fixer": "^3.49", "league/html-to-markdown": "^5.1", @@ -224,20 +224,20 @@ "issues": "https://github.com/battis/openapi-client.generator/issues", "source": "https://github.com/battis/openapi-client.generator/tree/main" }, - "time": "2024-05-09T16:07:27+00:00" + "time": "2024-05-10T14:11:53+00:00" }, { "name": "battis/php-generator", - "version": "v0.2", + "version": "dev-main", "source": { "type": "git", "url": "https://github.com/battis/php-generator.git", - "reference": "bf00942847d04c6361207cad8d2b808868143a94" + "reference": "052e6846b3e79e72fd6cdea890e7c008f428041e" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/battis/php-generator/zipball/bf00942847d04c6361207cad8d2b808868143a94", - "reference": "bf00942847d04c6361207cad8d2b808868143a94", + "url": "https://api.github.com/repos/battis/php-generator/zipball/052e6846b3e79e72fd6cdea890e7c008f428041e", + "reference": "052e6846b3e79e72fd6cdea890e7c008f428041e", "shasum": "" }, "require": { @@ -246,6 +246,7 @@ "require-dev": { "phpunit/phpunit": "^11.0" }, + "default-branch": true, "type": "library", "autoload": { "psr-4": { @@ -265,9 +266,9 @@ "description": "Generate PHP code dynamically", "support": { "issues": "https://github.com/battis/php-generator/issues", - "source": "https://github.com/battis/php-generator/tree/v0.2" + "source": "https://github.com/battis/php-generator/tree/main" }, - "time": "2024-04-20T14:54:43+00:00" + "time": "2024-05-10T14:05:28+00:00" }, { "name": "brick/math", @@ -681,16 +682,16 @@ }, { "name": "friendsofphp/php-cs-fixer", - "version": "v3.56.0", + "version": "v3.56.1", "source": { "type": "git", "url": "https://github.com/PHP-CS-Fixer/PHP-CS-Fixer.git", - "reference": "4429303e62a4ce583ddfe64ff5c34c76bcf74931" + "reference": "69c6168ae8bc96dc656c7f6c7271120a68ae5903" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/PHP-CS-Fixer/PHP-CS-Fixer/zipball/4429303e62a4ce583ddfe64ff5c34c76bcf74931", - "reference": "4429303e62a4ce583ddfe64ff5c34c76bcf74931", + "url": "https://api.github.com/repos/PHP-CS-Fixer/PHP-CS-Fixer/zipball/69c6168ae8bc96dc656c7f6c7271120a68ae5903", + "reference": "69c6168ae8bc96dc656c7f6c7271120a68ae5903", "shasum": "" }, "require": { @@ -762,7 +763,7 @@ ], "support": { "issues": "https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/issues", - "source": "https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/tree/v3.56.0" + "source": "https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/tree/v3.56.1" }, "funding": [ { @@ -770,7 +771,7 @@ "type": "github" } ], - "time": "2024-05-07T15:50:05+00:00" + "time": "2024-05-10T11:31:15+00:00" }, { "name": "google/auth", @@ -2128,20 +2129,20 @@ }, { "name": "psr/http-factory", - "version": "1.0.2", + "version": "1.1.0", "source": { "type": "git", "url": "https://github.com/php-fig/http-factory.git", - "reference": "e616d01114759c4c489f93b099585439f795fe35" + "reference": "2b4765fddfe3b508ac62f829e852b1501d3f6e8a" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/php-fig/http-factory/zipball/e616d01114759c4c489f93b099585439f795fe35", - "reference": "e616d01114759c4c489f93b099585439f795fe35", + "url": "https://api.github.com/repos/php-fig/http-factory/zipball/2b4765fddfe3b508ac62f829e852b1501d3f6e8a", + "reference": "2b4765fddfe3b508ac62f829e852b1501d3f6e8a", "shasum": "" }, "require": { - "php": ">=7.0.0", + "php": ">=7.1", "psr/http-message": "^1.0 || ^2.0" }, "type": "library", @@ -2165,7 +2166,7 @@ "homepage": "https://www.php-fig.org/" } ], - "description": "Common interfaces for PSR-7 HTTP message factories", + "description": "PSR-17: Common interfaces for PSR-7 HTTP message factories", "keywords": [ "factory", "http", @@ -2177,9 +2178,9 @@ "response" ], "support": { - "source": "https://github.com/php-fig/http-factory/tree/1.0.2" + "source": "https://github.com/php-fig/http-factory" }, - "time": "2023-04-10T20:10:41+00:00" + "time": "2024-04-15T12:06:14+00:00" }, { "name": "psr/http-message", diff --git a/packages/altru-administration/src/Altru/Administration/Client.php b/packages/altru-administration/src/Altru/Administration/Client.php index e5ca248f..8cab9178 100644 --- a/packages/altru-administration/src/Altru/Administration/Client.php +++ b/packages/altru-administration/src/Altru/Administration/Client.php @@ -3,8 +3,12 @@ namespace Blackbaud\SKY\Altru\Administration; use Battis\OpenAPI\Client\BaseEndpoint; +use Blackbaud\SKY\Altru\Administration\Endpoints\Batches; use Blackbaud\SKY\Altru\Administration\Endpoints\Codetables; +use Blackbaud\SKY\Altru\Administration\Endpoints\Codetablesortmethods; use Blackbaud\SKY\Altru\Administration\Endpoints\Currencies; +use Blackbaud\SKY\Altru\Administration\Endpoints\Information; +use Blackbaud\SKY\Altru\Administration\Endpoints\Notifications; use Blackbaud\SKY\Altru\Administration\Endpoints\Simplelists; use Blackbaud\SKY\Altru\Administration\Endpoints\Sites; @@ -13,12 +17,20 @@ * * @property \Blackbaud\SKY\Altru\Administration\Endpoints\Simplelists * $simplelists Routing class for the subnamespace `Simplelists` + * @property \Blackbaud\SKY\Altru\Administration\Endpoints\Batches $batches + * Routing class for the subnamespace `Batches` + * @property \Blackbaud\SKY\Altru\Administration\Endpoints\Notifications + * $notifications + * @property \Blackbaud\SKY\Altru\Administration\Endpoints\Codetablesortmethods + * $codetablesortmethods + * @property \Blackbaud\SKY\Altru\Administration\Endpoints\Information + * $information * @property \Blackbaud\SKY\Altru\Administration\Endpoints\Codetables * $codetables Routing class for the subnamespace `Codetables` - * @property \Blackbaud\SKY\Altru\Administration\Endpoints\Sites $sites - * Routing class for the subnamespace `Sites` * @property \Blackbaud\SKY\Altru\Administration\Endpoints\Currencies * $currencies Routing class for the subnamespace `Currencies` + * @property \Blackbaud\SKY\Altru\Administration\Endpoints\Sites $sites + * Routing class for the subnamespace `Sites` * * @api */ @@ -30,9 +42,13 @@ class Client extends BaseEndpoint */ protected array $endpoints = [ "simplelists" => "\Blackbaud\SKY\Altru\Administration\Endpoints\Simplelists", + "batches" => "\Blackbaud\SKY\Altru\Administration\Endpoints\Batches", + "notifications" => "\Blackbaud\SKY\Altru\Administration\Endpoints\Notifications", + "codetablesortmethods" => "\Blackbaud\SKY\Altru\Administration\Endpoints\Codetablesortmethods", + "information" => "\Blackbaud\SKY\Altru\Administration\Endpoints\Information", "codetables" => "\Blackbaud\SKY\Altru\Administration\Endpoints\Codetables", - "sites" => "\Blackbaud\SKY\Altru\Administration\Endpoints\Sites", "currencies" => "\Blackbaud\SKY\Altru\Administration\Endpoints\Currencies", + "sites" => "\Blackbaud\SKY\Altru\Administration\Endpoints\Sites", ]; /** @@ -42,20 +58,44 @@ class Client extends BaseEndpoint protected ?Simplelists $_simplelists = null; /** - * @var ?\Blackbaud\SKY\Altru\Administration\Endpoints\Codetables - * $_codetables Routing class for the subnamespace `Codetables` + * @var ?\Blackbaud\SKY\Altru\Administration\Endpoints\Batches $_batches + * Routing class for the subnamespace `Batches` */ - protected ?Codetables $_codetables = null; + protected ?Batches $_batches = null; /** - * @var ?\Blackbaud\SKY\Altru\Administration\Endpoints\Sites $_sites - * Routing class for the subnamespace `Sites` + * @var ?\Blackbaud\SKY\Altru\Administration\Endpoints\Notifications + * $_notifications */ - protected ?Sites $_sites = null; + protected ?Notifications $_notifications = null; + + /** + * @var ?\Blackbaud\SKY\Altru\Administration\Endpoints\Codetablesortmethods + * $_codetablesortmethods + */ + protected ?Codetablesortmethods $_codetablesortmethods = null; + + /** + * @var ?\Blackbaud\SKY\Altru\Administration\Endpoints\Information + * $_information + */ + protected ?Information $_information = null; + + /** + * @var ?\Blackbaud\SKY\Altru\Administration\Endpoints\Codetables + * $_codetables Routing class for the subnamespace `Codetables` + */ + protected ?Codetables $_codetables = null; /** * @var ?\Blackbaud\SKY\Altru\Administration\Endpoints\Currencies * $_currencies Routing class for the subnamespace `Currencies` */ protected ?Currencies $_currencies = null; + + /** + * @var ?\Blackbaud\SKY\Altru\Administration\Endpoints\Sites $_sites + * Routing class for the subnamespace `Sites` + */ + protected ?Sites $_sites = null; } diff --git a/packages/altru-administration/src/Altru/Administration/Components/CodeTableListCollection.php b/packages/altru-administration/src/Altru/Administration/Components/CodeTableListCollection.php index 30facfb7..447f66d3 100644 --- a/packages/altru-administration/src/Altru/Administration/Components/CodeTableListCollection.php +++ b/packages/altru-administration/src/Altru/Administration/Components/CodeTableListCollection.php @@ -5,16 +5,22 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. * @property \Blackbaud\SKY\Altru\Administration\Components\CodeTableListSummary[] * $value The set of items included in the response. This may be a subset of * the items in the collection. + * @property string $infinity_session Values for cookies related to the + * Infinity load balancer session. + * @property string $session_key Session key for paging provided by user in + * request query parameter. + * @property int $total_available_rows The number of total rows available. + * @property string $more_rows_range_key Key for accessing cached results on + * subsequent calls to this data list. + * @property bool $data_no_longer_available Indicates data is no longer + * available in the context of this session. * * @api */ @@ -26,5 +32,10 @@ class CodeTableListCollection extends BaseComponent protected static array $fields = [ "count" => "int", "value" => "\Blackbaud\SKY\Altru\Administration\Components\CodeTableListSummary[]", + "infinity_session" => "string", + "session_key" => "string", + "total_available_rows" => "int", + "more_rows_range_key" => "string", + "data_no_longer_available" => "bool", ]; } diff --git a/packages/altru-administration/src/Altru/Administration/Components/CodeTableListSummary.php b/packages/altru-administration/src/Altru/Administration/Components/CodeTableListSummary.php index 4cc5daaf..dec9f15f 100644 --- a/packages/altru-administration/src/Altru/Administration/Components/CodeTableListSummary.php +++ b/packages/altru-administration/src/Altru/Administration/Components/CodeTableListSummary.php @@ -5,9 +5,9 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ListCodeTable + * ListCodeTables * - * @property string $id The id. + * @property string $id The ID. * @property string $description The description. * @property bool $active Indicates whether active. * @property string $sites The sites. diff --git a/packages/altru-administration/src/Altru/Administration/Components/CodeTableSortMethod.php b/packages/altru-administration/src/Altru/Administration/Components/CodeTableSortMethod.php new file mode 100644 index 00000000..b938e175 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/CodeTableSortMethod.php @@ -0,0 +1,23 @@ + "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/CurrencyListCollection.php b/packages/altru-administration/src/Altru/Administration/Components/CurrencyListCollection.php new file mode 100644 index 00000000..13b8aeea --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/CurrencyListCollection.php @@ -0,0 +1,41 @@ + "int", + "value" => "\Blackbaud\SKY\Altru\Administration\Components\CurrencyListSummary[]", + "infinity_session" => "string", + "session_key" => "string", + "total_available_rows" => "int", + "more_rows_range_key" => "string", + "data_no_longer_available" => "bool", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/CurrencyListSummary.php b/packages/altru-administration/src/Altru/Administration/Components/CurrencyListSummary.php new file mode 100644 index 00000000..b520c4d7 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/CurrencyListSummary.php @@ -0,0 +1,39 @@ + "string", + "name" => "string", + "iso_4217" => "string", + "locale" => "string", + "decimal_digits" => "int", + "currency_symbol" => "string", + "rounding_type" => "string", + "active" => "bool", + "organization_currency" => "bool", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/UpdateCodeTable.php b/packages/altru-administration/src/Altru/Administration/Components/EditCodeTable.php similarity index 93% rename from packages/altru-administration/src/Altru/Administration/Components/UpdateCodeTable.php rename to packages/altru-administration/src/Altru/Administration/Components/EditCodeTable.php index becb3a26..ca3b24fa 100644 --- a/packages/altru-administration/src/Altru/Administration/Components/UpdateCodeTable.php +++ b/packages/altru-administration/src/Altru/Administration/Components/EditCodeTable.php @@ -13,7 +13,7 @@ * * @api */ -class UpdateCodeTable extends BaseComponent +class EditCodeTable extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-administration/src/Altru/Administration/Components/FuzzyDate.php b/packages/altru-administration/src/Altru/Administration/Components/FuzzyDate.php new file mode 100644 index 00000000..4e142e32 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/FuzzyDate.php @@ -0,0 +1,26 @@ + "int", + "month" => "int", + "day" => "int", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/GetVersionInformationView.php b/packages/altru-administration/src/Altru/Administration/Components/GetVersionInformationView.php new file mode 100644 index 00000000..e0b3034f --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/GetVersionInformationView.php @@ -0,0 +1,26 @@ + "string", + "bbis_version" => "string", + "sql_clr_version" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewBatch.php b/packages/altru-administration/src/Altru/Administration/Components/NewBatch.php new file mode 100644 index 00000000..4f4838af --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewBatch.php @@ -0,0 +1,67 @@ + "string", + "description" => "string", + "owner_id" => "string", + "batch_template_id" => "string", + "originating_batch_id" => "string", + "projected_number_of_records" => "int", + "projected_total_amount" => "float", + "display_total_amount" => "bool", + "create_custom_batch" => "bool", + "can_change_batch_numbers" => "bool", + "auto_save_on_row_change" => "bool", + "override_batch_number" => "bool", + "can_edit_field_options" => "bool", + "skip_test_for_web_shell" => "bool", + "automatch_threshold" => "float", + "overall_match_threshold" => "float", + "specific_batch_type_id" => "string", + "check_for_duplicates" => "bool", + "disable_add_new_row" => "bool", + "skip_batch_assignment_alert" => "bool", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewNotification.php b/packages/altru-administration/src/Altru/Administration/Components/NewNotification.php new file mode 100644 index 00000000..1317defb --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewNotification.php @@ -0,0 +1,47 @@ + "string", + "message" => "string", + "record_type" => "string", + "record_id_set_register_id" => "string", + "application_user_record_type_id" => "string", + "application_user_id_set_register_id" => "string", + "apply_to" => "string", + "display_notification_window" => "bool", + "display_in_daily_sales" => "bool", + "valid_until" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRow.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRow.php new file mode 100644 index 00000000..313a515a --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRow.php @@ -0,0 +1,564 @@ + "string", + "constituent_id" => "string", + "constituent_lookup_id" => "string", + "type" => "string", + "date" => "string", + "amount" => "float", + "payment_method" => "string", + "constituent_account" => "string", + "do_not_acknowledge" => "bool", + "do_not_receipt" => "bool", + "check_date" => "\Blackbaud\SKY\Altru\Administration\Components\FuzzyDate", + "check_number" => "string", + "reference_number" => "string", + "reference_date" => "\Blackbaud\SKY\Altru\Administration\Components\FuzzyDate", + "credit_card_number" => "string", + "card_holder_name" => "string", + "expires_on" => "\Blackbaud\SKY\Altru\Administration\Components\FuzzyDate", + "credit_type" => "string", + "authorization_code" => "string", + "credit_card_token" => "string", + "issuer" => "string", + "merchant_account_id" => "string", + "number_of_units" => "float", + "symbol" => "string", + "median_price" => "float", + "property_sub_type" => "string", + "gift_in_kind_sub_type" => "string", + "receipt_amount" => "float", + "single_designation_id" => "string", + "splits" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowSplits[]", + "apply_by_percent" => "bool", + "revenue_streams" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowRevenueStreams[]", + "apply_to_shown_for_constituent_id" => "string", + "sequence" => "int", + "installment_frequency" => "string", + "installment_start_date" => "string", + "installment_end_date" => "string", + "number_of_installments" => "int", + "installment_amount" => "float", + "solicitors" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowSolicitors[]", + "benefits" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowBenefits[]", + "finder_number" => "int", + "source_code" => "string", + "appeal_id" => "string", + "finder_number_is_valid" => "bool", + "user_modified_benefits" => "bool", + "benefits_waived" => "bool", + "post_date" => "string", + "post_status" => "string", + "send_pledge_reminder" => "bool", + "sale_date" => "string", + "sale_amount" => "float", + "broker_fee" => "float", + "sale_post_status" => "string", + "sale_post_date" => "string", + "sale_low_price" => "float", + "sale_median_price" => "float", + "sale_high_price" => "float", + "note_title" => "string", + "note_date_entered" => "string", + "note_author_id" => "string", + "note_type" => "string", + "note_text_note" => "string", + "note_html_note" => "string", + "gift_amount" => "float", + "given_anonymously" => "bool", + "given_anonymously_defaulted_for_constituent_id" => "string", + "user_modified_receipt_amount" => "bool", + "pledge_sub_type" => "string", + "rejection" => "string", + "rejection_message" => "string", + "mailing_id" => "string", + "channel" => "string", + "installments" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowInstallments[]", + "payment_for_pledge_amount" => "float", + "recognitions" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowRecognitions[]", + "did_recognitions_default" => "bool", + "tributes" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowTributes[]", + "unapplied_matching_gift_splits" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowUnappliedMatchingGiftSplits[]", + "unapplied_matching_gift_amount" => "float", + "receipt_type" => "string", + "new_constituent" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowNewConstituent[]", + "other_payment_method" => "string", + "letter_code" => "string", + "acknowledge_date" => "string", + "reference" => "string", + "category_code" => "string", + "acknowledgee_id" => "string", + "application_info" => "string", + "other_type" => "string", + "opportunity_id" => "string", + "direct_debit_result_code" => "string", + "low_price" => "float", + "high_price" => "float", + "number_of_units_sold" => "float", + "user_modified_number_of_units_sold" => "bool", + "partial_credit_card_number" => "string", + "existing_constituent" => "bool", + "standing_order_reference_number" => "string", + "standing_order_reference_date" => "\Blackbaud\SKY\Altru\Administration\Components\FuzzyDate", + "standing_order_constituent_account" => "string", + "standing_order_setup" => "bool", + "standing_order_setup_date" => "string", + "tax_declarations" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowTaxDeclarations[]", + "constituent_type" => "string", + "transaction_id" => "string", + "transient_card" => "bool", + "declines_gift_aid" => "bool", + "ddi_source" => "string", + "ddi_source_date" => "string", + "covenant" => "bool", + "amount_for_vat" => "float", + "vat_tax_rate" => "string", + "vat_amount" => "float", + "additional_applications_stream" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowAdditionalApplicationsStream[]", + "revenue_lookup_id" => "string", + "application_solicitors" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowApplicationSolicitors[]", + "application_recognitions" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowApplicationRecognitions[]", + "mg_generated" => "bool", + "mg_altered" => "bool", + "matching_gifts" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowMatchingGifts[]", + "paying_pending_revenue_id" => "string", + "gift_in_kind_item_name" => "string", + "gift_in_kind_disposition" => "string", + "gift_in_kind_number_of_units" => "int", + "gift_in_kind_fair_market_value" => "float", + "direct_debit_is_rejected" => "bool", + "percentage_benefits" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowPercentageBenefits[]", + "gift_aid_sponsorship" => "bool", + "other_constituent_application_info" => "string", + "lock_box" => "string", + "lock_box_batch_number" => "string", + "lock_box_batch_sequence" => "int", + "pd_account_system_id" => "string", + "application_business_units" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowApplicationBusinessUnits[]", + "transaction_currency" => "string", + "base_currency_id" => "string", + "base_exchange_rate" => "string", + "exchange_rate" => "float", + "base_amount" => "float", + "generate_reference_number" => "bool", + "source_code_import" => "string", + "current_batch_row_id" => "string", + "set_null_base_exchange_rate_to_latest" => "bool", + "appeal_id_for_import" => "string", + "credit_card_attempt_count" => "int", + "vendor_id" => "string", + "client_app_license_id" => "string", + "bbnc_transaction_processor_id" => "string", + "bbnc_origin_appeal_id" => "string", + "bbnc_tran_id" => "int", + "bbnc_id" => "int", + "bbnc_origin_page_id" => "int", + "bbnc_origin_page_name" => "string", + "financial_institution_id" => "string", + "account_number" => "string", + "account_type" => "string", + "account_name" => "string", + "edit_constituent_context" => "string", + "receipt_number" => "string", + "receipt_stack_short_name" => "string", + "mark_gift_as_receipted" => "bool", + "email_id" => "int", + "email_subject" => "string", + "email_name" => "string", + "name" => "string", + "similar_address" => "string", + "unsimilar_address" => "string", + "new_address_end_date" => "string", + "new_address_primary" => "string", + "birth_date_rule" => "string", + "different_phone" => "string", + "new_phone_end_date" => "string", + "new_phone_primary" => "string", + "different_email" => "string", + "new_email_end_date" => "string", + "new_email_primary" => "string", + "use_global_settings" => "bool", + "do_manual_review_for_auto_match" => "bool", + "create_historical_name" => "string", + "constituent_has_edits" => "bool", + "first_payment_processed" => "string", + "payment_for_pledge_receipt_amount" => "float", + "sepa_mandate" => "string", + "add_sepa_mandate" => "bool", + "sepa_mandate_custom_identifier" => "string", + "sepa_mandate_signature_date" => "string", + "sepa_mandate_type" => "string", + "financial_institution_name" => "string", + "banking_system" => "string", + "branch_name" => "string", + "routing_number" => "string", + "sort_code" => "string", + "bic" => "string", + "bank_code" => "string", + "require_credit_card_processing" => "bool", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowAdditionalApplicationsStream.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowAdditionalApplicationsStream.php new file mode 100644 index 00000000..93b7d304 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowAdditionalApplicationsStream.php @@ -0,0 +1,57 @@ + "string", + "type" => "string", + "applied" => "float", + "applied_percent" => "float", + "designation_id" => "string", + "other_type" => "string", + "declines_gift_aid" => "bool", + "gift_aid_sponsorship" => "bool", + "opportunity_id" => "string", + "sponsorship" => "string", + "category_code" => "string", + "did_campaigns_default" => "bool", + "campaigns" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowAdditionalapplicationsstreamCampaigns[]", + "transaction_currency_id" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowAdditionalapplicationsstreamCampaigns.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowAdditionalapplicationsstreamCampaigns.php new file mode 100644 index 00000000..13cf76e3 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowAdditionalapplicationsstreamCampaigns.php @@ -0,0 +1,28 @@ + "string", + "campaign_id" => "string", + "campaign_sub_priority" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowApplicationBusinessUnits.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowApplicationBusinessUnits.php new file mode 100644 index 00000000..af36f888 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowApplicationBusinessUnits.php @@ -0,0 +1,34 @@ + "string", + "businessunits" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowApplicationbusinessunitsBusinessunits[]", + "override_business_units" => "bool", + "reason" => "string", + "application_declines_gift_aid" => "bool", + "application_sponsorship_id" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowApplicationRecognitions.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowApplicationRecognitions.php new file mode 100644 index 00000000..235d618b --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowApplicationRecognitions.php @@ -0,0 +1,46 @@ + "string", + "application_type_code" => "int", + "additional_application_type_code" => "int", + "additional_application_designation_id" => "string", + "application_amount" => "float", + "application_description" => "string", + "collection_description" => "string", + "recognitions" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowApplicationrecognitionsRecognitions[]", + "base_currency_id" => "string", + "additional_application_declines_gift_aid" => "bool", + "additional_application_sponsorship_id" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowApplicationSolicitors.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowApplicationSolicitors.php new file mode 100644 index 00000000..600c2daa --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowApplicationSolicitors.php @@ -0,0 +1,49 @@ + "string", + "application_type_code" => "int", + "additional_application_type_code" => "int", + "additional_application_designation_id" => "string", + "application_amount" => "float", + "application_description" => "string", + "collection_description" => "string", + "solicitors" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowApplicationsolicitorsSolicitors[]", + "additional_application_opportunity_id" => "string", + "base_currency_id" => "string", + "additional_application_declines_gift_aid" => "bool", + "additional_application_sponsorship_id" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowApplicationbusinessunitsBusinessunits.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowApplicationbusinessunitsBusinessunits.php new file mode 100644 index 00000000..9afee2cd --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowApplicationbusinessunitsBusinessunits.php @@ -0,0 +1,29 @@ + "string", + "amount" => "float", + "base_currency_id" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowApplicationrecognitionsRecognitions.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowApplicationrecognitionsRecognitions.php new file mode 100644 index 00000000..5a9a3b7a --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowApplicationrecognitionsRecognitions.php @@ -0,0 +1,34 @@ + "string", + "revenue_recognition_type" => "string", + "constituent_id" => "string", + "effective_date" => "string", + "amount" => "float", + "base_currency_id" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowApplicationsolicitorsSolicitors.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowApplicationsolicitorsSolicitors.php new file mode 100644 index 00000000..713db93d --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowApplicationsolicitorsSolicitors.php @@ -0,0 +1,28 @@ + "string", + "constituent_id" => "string", + "amount" => "float", + "base_currency_id" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowBenefits.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowBenefits.php new file mode 100644 index 00000000..17850dcd --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowBenefits.php @@ -0,0 +1,42 @@ + "string", + "benefit_id" => "string", + "quantity" => "int", + "unit_value" => "float", + "total_value" => "float", + "details" => "string", + "sequence" => "int", + "transaction_total_value" => "float", + "benefit_currency_id" => "string", + "transaction_currency_id" => "string", + "base_currency_id" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowInstallments.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowInstallments.php new file mode 100644 index 00000000..ba44a850 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowInstallments.php @@ -0,0 +1,37 @@ + "string", + "date" => "string", + "amount" => "float", + "applied" => "float", + "receipt_amount" => "float", + "sequence" => "int", + "transaction_currency_id" => "string", + "installmentsplits" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowInstallmentsInstallmentsplits[]", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowInstallmentsInstallmentsplits.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowInstallmentsInstallmentsplits.php new file mode 100644 index 00000000..d83b07f1 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowInstallmentsInstallmentsplits.php @@ -0,0 +1,40 @@ + "string", + "installment_split_id" => "string", + "designation" => "string", + "amount" => "float", + "applied" => "float", + "transaction_currency_id" => "string", + "revenue_split_id" => "string", + "payment_count" => "int", + "write_off_count" => "int", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowMatchingGifts.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowMatchingGifts.php new file mode 100644 index 00000000..af6f5deb --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowMatchingGifts.php @@ -0,0 +1,66 @@ + "string", + "matching_constituent_id" => "string", + "organization_id" => "string", + "relationship" => "string", + "relationship_context_id" => "string", + "matching_gift_condition" => "string", + "amount" => "float", + "date" => "string", + "single_designation_id" => "string", + "splits" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowMatchinggiftsSplits[]", + "could_not_default_matching_gift" => "bool", + "base_currency_id" => "string", + "transaction_currency" => "string", + "base_exchange_rate" => "string", + "exchange_rate" => "float", + "original_gift_transaction_currency_id" => "string", + "pd_account_system_id" => "string", + "apply_by_percent" => "bool", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowMatchinggiftsSplits.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowMatchinggiftsSplits.php new file mode 100644 index 00000000..c459657f --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowMatchinggiftsSplits.php @@ -0,0 +1,30 @@ + "string", + "designation_id" => "string", + "amount" => "float", + "sequence" => "int", + "transaction_currency_id" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowNewConstituent.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowNewConstituent.php new file mode 100644 index 00000000..eda2e925 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowNewConstituent.php @@ -0,0 +1,358 @@ + "bool", + "group" => "bool", + "household" => "bool", + "last_name" => "string", + "first_name" => "string", + "middle_name" => "string", + "title" => "string", + "suffix" => "string", + "nick_name" => "string", + "maiden_name" => "string", + "birthdate" => "\Blackbaud\SKY\Altru\Administration\Components\FuzzyDate", + "gender" => "string", + "marital_status" => "string", + "web_address" => "string", + "industry" => "string", + "num_employees" => "int", + "num_subsidiaries" => "int", + "parent_corp_id" => "string", + "address_address_type" => "string", + "address_country" => "string", + "address_address_block" => "string", + "address_city" => "string", + "address_state" => "string", + "address_post_code" => "string", + "address_do_not_mail" => "bool", + "address_do_not_mail_reason" => "string", + "phone_type" => "string", + "phone_number" => "string", + "email_address_type" => "string", + "email_address" => "string", + "existing_spouse" => "bool", + "spouse_id" => "string", + "spouse_last_name" => "string", + "spouse_first_name" => "string", + "spouse_middle_name" => "string", + "spouse_title" => "string", + "spouse_suffix" => "string", + "spouse_nick_name" => "string", + "spouse_maiden_name" => "string", + "spouse_birthdate" => "\Blackbaud\SKY\Altru\Administration\Components\FuzzyDate", + "spouse_gender" => "string", + "spouse_relationship_type" => "string", + "spouse_reciprocal_type" => "string", + "spouse_start_date" => "string", + "spouse_is_spouse" => "bool", + "spouse_class_of" => "int", + "copy_primary_information" => "bool", + "primary_relationship_exists" => "bool", + "primary_match_factor" => "float", + "reciprocal_relationship_exists" => "bool", + "reciprocal_match_factor" => "float", + "existing_business" => "string", + "business_id" => "string", + "business_name" => "string", + "business_address_type" => "string", + "business_country" => "string", + "business_address_block" => "string", + "business_city" => "string", + "business_state" => "string", + "business_post_code" => "string", + "business_do_not_mail" => "bool", + "business_phone_type" => "string", + "business_number" => "string", + "business_relationship_type" => "string", + "business_reciprocal_type" => "string", + "business_start_date" => "string", + "contact" => "bool", + "contact_type" => "string", + "primary_contact" => "bool", + "position" => "string", + "matching_gift_relationship" => "bool", + "gives_anonymously" => "bool", + "group_description" => "string", + "group_primary_contact" => "string", + "group_start_date" => "string", + "group_group_type" => "string", + "household_primary_contact_id" => "string", + "household_primary_contact_key_name" => "string", + "household_primary_contact_first_name" => "string", + "household_primary_contact_middle_name" => "string", + "household_primary_contact_title" => "string", + "household_primary_contact_suffix" => "string", + "household_primary_contact_copy_household_contact" => "bool", + "household_second_member_id" => "string", + "household_second_member_key_name" => "string", + "household_second_member_first_name" => "string", + "household_second_member_middle_name" => "string", + "household_second_member_title" => "string", + "household_second_member_suffix" => "string", + "household_second_member_copy_household_contact" => "bool", + "household_second_member_relationship_reciprocal_type" => "string", + "household_second_member_relationship_relationship_type" => "string", + "household_second_member_relationship_start_date" => "string", + "household_second_member_relationship_is_spouse" => "bool", + "spouse_relationship_type_code_id_simple_list" => "string", + "spouse_reciprocal_type_code_id_simple_list" => "string", + "business_relationship_type_code_id_simple_list" => "string", + "business_reciprocal_type_code_id_simple_list" => "string", + "household_second_member_relationship_reciprocal_type_code_id_simple_list" => "string", + "household_second_member_relationship_relationship_type_code_id_simple_list" => "string", + "business_primary_relationship_exists" => "string", + "business_primary_match_factor" => "int", + "business_reciprocal_relationship_exists" => "string", + "business_reciprocal_match_factor" => "int", + "business_primary_recognition_type" => "string", + "business_reciprocal_recognition_type" => "string", + "address_id" => "string", + "email_address_id" => "string", + "phone_id" => "string", + "constituency_code" => "string", + "site_id" => "string", + "constituent_security_group" => "string", + "info_source_code_id" => "string", + "nameformats" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowNewconstituentNameformats[]", + "original_first_name" => "string", + "original_last_name" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowNewconstituentNameformats.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowNewconstituentNameformats.php new file mode 100644 index 00000000..26b2f360 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowNewconstituentNameformats.php @@ -0,0 +1,26 @@ + "string", + "custom_name" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowPercentageBenefits.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowPercentageBenefits.php new file mode 100644 index 00000000..ec327eca --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowPercentageBenefits.php @@ -0,0 +1,40 @@ + "string", + "benefit_id" => "string", + "percent_applicable_amount" => "float", + "value_percent" => "float", + "total_value" => "float", + "details" => "string", + "sequence" => "int", + "transaction_currency_id" => "string", + "transaction_total_value" => "float", + "base_currency_id" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRecognitions.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRecognitions.php new file mode 100644 index 00000000..4e0b2da2 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRecognitions.php @@ -0,0 +1,34 @@ + "string", + "revenue_recognition_type" => "string", + "constituent_id" => "string", + "effective_date" => "string", + "amount" => "float", + "base_currency_id" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenueStreams.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenueStreams.php new file mode 100644 index 00000000..5ee80321 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenueStreams.php @@ -0,0 +1,91 @@ + "string", + "application_id" => "string", + "constituent_id" => "string", + "constituent_name" => "string", + "applied" => "float", + "applied_percent" => "float", + "balance" => "float", + "amount_due" => "float", + "date_due" => "string", + "type" => "string", + "receipt_amount" => "float", + "do_not_receipt" => "bool", + "description" => "string", + "was_generated" => "bool", + "pledges" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowRevenuestreamsPledges[]", + "memberships" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowRevenuestreamsMemberships[]", + "batch_revenue_registrant_id" => "string", + "over_payment_application_type" => "string", + "designation_list" => "string", + "application_commitment_id" => "string", + "sponsorship_opportunity" => "string", + "transaction_currency_id" => "string", + "application_currency_id" => "string", + "application_exchange_rate_id" => "string", + "application_applied_amount" => "float", + "pd_account_system_id" => "string", + "sponsorship_rg_additional_gift" => "bool", + "category_code" => "string", + "membership_program_name" => "string", + "membership_level_name" => "string", + "sort_order" => "int", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsMemberships.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsMemberships.php new file mode 100644 index 00000000..4440ea47 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsMemberships.php @@ -0,0 +1,54 @@ + "string", + "membership_level" => "string", + "membership_level_term" => "string", + "membership_type_code" => "string", + "number_of_children" => "int", + "comments" => "string", + "gift" => "bool", + "send_renewal" => "string", + "expiration_date" => "string", + "given_by_id" => "string", + "amount" => "float", + "members" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowRevenuestreamsMembershipsMembers[]", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsMembershipsMembers.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsMembershipsMembers.php new file mode 100644 index 00000000..1352481b --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsMembershipsMembers.php @@ -0,0 +1,29 @@ + "string", + "constituent_id" => "string", + "primary" => "bool", + "membershipcards" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowRevenuestreamsMembershipsMembersMembershipcards[]", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsMembershipsMembersMembershipcards.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsMembershipsMembersMembershipcards.php new file mode 100644 index 00000000..90bac300 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsMembershipsMembersMembershipcards.php @@ -0,0 +1,26 @@ + "string", + "name_on_card" => "string", + "expiration_date" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsPledges.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsPledges.php new file mode 100644 index 00000000..a30900f9 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsPledges.php @@ -0,0 +1,112 @@ + "int", + "constituent_id" => "string", + "date" => "string", + "amount" => "float", + "post_date" => "string", + "post_status" => "string", + "send_pledge_reminder" => "bool", + "frequency" => "string", + "number_of_installments" => "int", + "start_date" => "string", + "installment_amount" => "float", + "splits" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowRevenuestreamsPledgesSplits[]", + "installments" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowRevenuestreamsPledgesInstallments[]", + "finder_number" => "int", + "source_code" => "string", + "appeal_id" => "string", + "benefits" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowRevenuestreamsPledgesBenefits[]", + "benefits_waived" => "bool", + "given_anonymously" => "string", + "mailing_id" => "string", + "channel" => "string", + "do_not_acknowledge" => "bool", + "pledge_sub_type" => "string", + "single_designation_id" => "string", + "reference" => "string", + "category_code" => "string", + "opportunity_id" => "string", + "opportunity_constituent_name" => "string", + "opportunity_ask_date" => "string", + "opportunity_ask_amount" => "float", + "opportunity_status" => "string", + "percentagebenefits" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowRevenuestreamsPledgesPercentagebenefits[]", + "transaction_currency_id" => "string", + "base_currency_id" => "string", + "base_exchange_rate" => "string", + "exchange_rate" => "float", + "do_not_post" => "bool", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsPledgesBenefits.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsPledgesBenefits.php new file mode 100644 index 00000000..e122bea4 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsPledgesBenefits.php @@ -0,0 +1,42 @@ + "string", + "benefit_id" => "string", + "quantity" => "int", + "unit_value" => "float", + "total_value" => "float", + "details" => "string", + "sequence" => "int", + "transaction_total_value" => "float", + "benefit_currency_id" => "string", + "transaction_currency_id" => "string", + "base_currency_id" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsPledgesInstallments.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsPledgesInstallments.php new file mode 100644 index 00000000..a44fdcf3 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsPledgesInstallments.php @@ -0,0 +1,35 @@ + "string", + "date" => "string", + "amount" => "float", + "receipt_amount" => "float", + "sequence" => "int", + "transaction_currency_id" => "string", + "installmentsplits" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowRevenuestreamsPledgesInstallmentsInstallmentsplits[]", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsPledgesInstallmentsInstallmentsplits.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsPledgesInstallmentsInstallmentsplits.php new file mode 100644 index 00000000..19d375c3 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsPledgesInstallmentsInstallmentsplits.php @@ -0,0 +1,34 @@ + "string", + "installment_split_id" => "string", + "designation" => "string", + "amount" => "float", + "applied" => "float", + "transaction_currency_id" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsPledgesPercentagebenefits.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsPledgesPercentagebenefits.php new file mode 100644 index 00000000..139c0987 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsPledgesPercentagebenefits.php @@ -0,0 +1,40 @@ + "string", + "benefit_id" => "string", + "percent_applicable_amount" => "float", + "value_percent" => "float", + "total_value" => "float", + "details" => "string", + "sequence" => "int", + "transaction_currency_id" => "string", + "transaction_total_value" => "float", + "base_currency_id" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsPledgesSplits.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsPledgesSplits.php new file mode 100644 index 00000000..e241b8de --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowRevenuestreamsPledgesSplits.php @@ -0,0 +1,36 @@ + "string", + "designation_id" => "string", + "amount" => "float", + "application_code" => "int", + "type_code" => "int", + "declines_gift_aid" => "bool", + "transaction_currency_id" => "string", + "sponsorship_id" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowSolicitors.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowSolicitors.php new file mode 100644 index 00000000..ed1a0c46 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowSolicitors.php @@ -0,0 +1,28 @@ + "string", + "amount" => "float", + "sequence" => "int", + "base_currency_id" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowSplits.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowSplits.php new file mode 100644 index 00000000..b0770944 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowSplits.php @@ -0,0 +1,47 @@ + "string", + "id" => "string", + "designation_id" => "string", + "amount" => "float", + "sequence" => "int", + "application_code" => "int", + "type_code" => "int", + "did_campaigns_default" => "bool", + "campaigns" => "\Blackbaud\SKY\Altru\Administration\Components\NewRevenueBatchRowSplitsCampaigns[]", + "declines_gift_aid" => "bool", + "gift_aid_sponsorship" => "bool", + "opportunity_id" => "string", + "transaction_currency_id" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowSplitsCampaigns.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowSplitsCampaigns.php new file mode 100644 index 00000000..e5488c27 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowSplitsCampaigns.php @@ -0,0 +1,28 @@ + "string", + "campaign_id" => "string", + "campaign_sub_priority" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowTaxDeclarations.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowTaxDeclarations.php new file mode 100644 index 00000000..5f28ed39 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowTaxDeclarations.php @@ -0,0 +1,42 @@ + "string", + "charity_claim_reference_number" => "string", + "declaration_made" => "string", + "declaration_starts" => "string", + "declaration_ends" => "string", + "declaration_indicator" => "string", + "declaration_source" => "string", + "pays_tax" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowTributes.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowTributes.php new file mode 100644 index 00000000..e69910fe --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowTributes.php @@ -0,0 +1,32 @@ + "string", + "tribute_id" => "string", + "amount" => "float", + "designation_id" => "string", + "sequence" => "int", + "base_currency_id" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowUnappliedMatchingGiftSplits.php b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowUnappliedMatchingGiftSplits.php new file mode 100644 index 00000000..f2c54f77 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Components/NewRevenueBatchRowUnappliedMatchingGiftSplits.php @@ -0,0 +1,30 @@ + "string", + "designation_id" => "string", + "amount" => "float", + "sequence" => "int", + "transaction_currency_id" => "string", + ]; +} diff --git a/packages/altru-administration/src/Altru/Administration/Components/SiteSearchCollection.php b/packages/altru-administration/src/Altru/Administration/Components/SiteSearchCollection.php index a95bf193..fe9edf97 100644 --- a/packages/altru-administration/src/Altru/Administration/Components/SiteSearchCollection.php +++ b/packages/altru-administration/src/Altru/Administration/Components/SiteSearchCollection.php @@ -5,10 +5,7 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. diff --git a/packages/altru-administration/src/Altru/Administration/Components/SiteSearchSummary.php b/packages/altru-administration/src/Altru/Administration/Components/SiteSearchSummary.php index b7e492a3..c658b378 100644 --- a/packages/altru-administration/src/Altru/Administration/Components/SiteSearchSummary.php +++ b/packages/altru-administration/src/Altru/Administration/Components/SiteSearchSummary.php @@ -5,10 +5,10 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * SearchSite + * SearchSites * - * @property string $id The id. - * @property string $site_id The site id. + * @property string $id The ID. + * @property string $site_id The site ID. * @property string $name The name. * @property string $short_name The short name. * @property string $acronym The acronym. diff --git a/packages/altru-administration/src/Altru/Administration/Endpoints/Batches.php b/packages/altru-administration/src/Altru/Administration/Endpoints/Batches.php new file mode 100644 index 00000000..b1accccf --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Endpoints/Batches.php @@ -0,0 +1,59 @@ +> + * $endpoints Routing subpaths + */ + protected array $endpoints = [ + "revenue" => "\Blackbaud\SKY\Altru\Administration\Endpoints\Batches\Revenue", + ]; + + /** + * @var ?\Blackbaud\SKY\Altru\Administration\Endpoints\Batches\Revenue + * $_revenue + */ + protected ?Revenue $_revenue = null; + + /** + * Add operation for adding a batch + * + * @param \Blackbaud\SKY\Altru\Administration\Components\NewBatch + * $requestBody ConfigurationMessage object representing operation + * intended to be created + * + * @return \Blackbaud\SKY\Altru\Administration\Components\PostResponse + * Returned when the operation successfully creates the resource. + * + * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required + * parameters are not defined + */ + public function post(NewBatch $requestBody): PostResponse + { + assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); + + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); + } +} diff --git a/packages/altru-administration/src/Altru/Administration/Endpoints/Batches/Revenue.php b/packages/altru-administration/src/Altru/Administration/Endpoints/Batches/Revenue.php new file mode 100644 index 00000000..bdea5574 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Endpoints/Batches/Revenue.php @@ -0,0 +1,39 @@ +send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); + } +} diff --git a/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/Codetableentryid.php b/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/Codetableentryid.php index b08c7e8b..befc6ec9 100644 --- a/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/Codetableentryid.php +++ b/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/Codetableentryid.php @@ -33,7 +33,6 @@ public function deleteByCodeTableNameAndEntryId(array $params): mixed assert(isset($params['code_table_name']), new ArgumentException("Parameter `code_table_name` is required")); assert(isset($params['entry_id']), new ArgumentException("Parameter `entry_id` is required")); - return $this->send("delete", ["code_table_name" => $params['code_table_name'], - "entry_id" => $params['entry_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['code_table_name','entry_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } } diff --git a/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/Entries.php b/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/Entries.php index e3f0d41b..9d569873 100644 --- a/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/Entries.php +++ b/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/Entries.php @@ -32,6 +32,6 @@ public function searchByCodeTableName(array $params): CodeTableEntryCollection { assert(isset($params['code_table_name']), new ArgumentException("Parameter `code_table_name` is required")); - return new CodeTableEntryCollection($this->send("get", ["code_table_name" => $params['code_table_name']], [])); + return new CodeTableEntryCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['code_table_name']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/Entry.php b/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/Entry.php index de777bd2..8ca5e08b 100644 --- a/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/Entry.php +++ b/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/Entry.php @@ -4,9 +4,9 @@ use Battis\OpenAPI\Client\BaseEndpoint; use Battis\OpenAPI\Client\Exceptions\ArgumentException; +use Blackbaud\SKY\Altru\Administration\Components\EditCodeTable; use Blackbaud\SKY\Altru\Administration\Components\NewCodeTableEntry; use Blackbaud\SKY\Altru\Administration\Components\PostResponse; -use Blackbaud\SKY\Altru\Administration\Components\UpdateCodeTable; /** * @api @@ -38,15 +38,15 @@ public function postToCodeTableName(array $params, NewCodeTableEntry $requestBod assert(isset($params['code_table_name']), new ArgumentException("Parameter `code_table_name` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", ["code_table_name" => $params['code_table_name']], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['code_table_name']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } /** - * Updates a code table entry. + * Edit a code table entry. * * @param array{code_table_name: string} $params An associative array * - code_table_name: The name of the code table. - * @param \Blackbaud\SKY\Altru\Administration\Components\UpdateCodeTable + * @param \Blackbaud\SKY\Altru\Administration\Components\EditCodeTable * $requestBody ConfigurationMessage object representing operation * intended to be updated * @@ -56,11 +56,11 @@ public function postToCodeTableName(array $params, NewCodeTableEntry $requestBod * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required * parameters are not defined */ - public function patchOnCodeTableName(array $params, UpdateCodeTable $requestBody): mixed + public function patchOnCodeTableName(array $params, EditCodeTable $requestBody): mixed { assert(isset($params['code_table_name']), new ArgumentException("Parameter `code_table_name` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["code_table_name" => $params['code_table_name']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['code_table_name']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/Entrydescription.php b/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/Entrydescription.php index f1d8e81e..5e807e11 100644 --- a/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/Entrydescription.php +++ b/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/Entrydescription.php @@ -35,7 +35,6 @@ public function getByCodeTableNameAndEntryDescription(array $params): CodeTableE assert(isset($params['code_table_name']), new ArgumentException("Parameter `code_table_name` is required")); assert(isset($params['entry_description']), new ArgumentException("Parameter `entry_description` is required")); - return new CodeTableEntryId($this->send("get", ["code_table_name" => $params['code_table_name'], - "entry_description" => $params['entry_description']], [])); + return new CodeTableEntryId($this->send("get", array_filter($params, fn($key) => in_array($key, ['code_table_name','entry_description']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/Entryid.php b/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/Entryid.php index bc44eb81..edc06a8b 100644 --- a/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/Entryid.php +++ b/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/Entryid.php @@ -35,7 +35,6 @@ public function getByCodeTableNameAndEntryId(array $params): CodeTableEntryDescr assert(isset($params['code_table_name']), new ArgumentException("Parameter `code_table_name` is required")); assert(isset($params['entry_id']), new ArgumentException("Parameter `entry_id` is required")); - return new CodeTableEntryDescription($this->send("get", ["code_table_name" => $params['code_table_name'], - "entry_id" => $params['entry_id']], [])); + return new CodeTableEntryDescription($this->send("get", array_filter($params, fn($key) => in_array($key, ['code_table_name','entry_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/List.php b/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/List.php index 861a699e..021eba16 100644 --- a/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/List.php +++ b/packages/altru-administration/src/Altru/Administration/Endpoints/Codetables/List.php @@ -19,11 +19,20 @@ class List_ extends BaseEndpoint /** * List of entries defined for a given code table * - * @param array{code_table_id: string, include_inactive: bool, limit: int} - * $params An associative array + * @param array{code_table_id: string, include_inactive: bool, limit: int, + * session_key: string, infinity_session: string, more_rows_range_key: + * string, start_row_index: int} $params An associative array * - code_table_id: The code table id. * - include_inactive: include inactive? * - limit: Limits the number of records to return. + * - session_key: A unique key provided by user for paging results. + * The same key will be returned in a successful response. + * - infinity_session: Values for cookies related to the Infinity load + * balancer session. + * - more_rows_range_key: Key for accessing cached results on + * subsequent calls to this data list. + * - start_row_index: Number of rows to skip,get result after these + * rows. * * @return \Blackbaud\SKY\Altru\Administration\Components\CodeTableListCollection * Returned when the operation succeeds. The response body contains a @@ -37,8 +46,11 @@ public function searchByCodeTableId(array $params): CodeTableListCollection assert(isset($params['code_table_id']), new ArgumentException("Parameter `code_table_id` is required")); assert(isset($params['include_inactive']), new ArgumentException("Parameter `include_inactive` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); + assert(isset($params['session_key']), new ArgumentException("Parameter `session_key` is required")); + assert(isset($params['infinity_session']), new ArgumentException("Parameter `infinity_session` is required")); + assert(isset($params['more_rows_range_key']), new ArgumentException("Parameter `more_rows_range_key` is required")); + assert(isset($params['start_row_index']), new ArgumentException("Parameter `start_row_index` is required")); - return new CodeTableListCollection($this->send("get", ["code_table_id" => $params['code_table_id']], ["include_inactive" => $params['include_inactive'], - "limit" => $params['limit']])); + return new CodeTableListCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['code_table_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['include_inactive','limit','session_key','infinity_session','more_rows_range_key','start_row_index']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-administration/src/Altru/Administration/Endpoints/Codetablesortmethods.php b/packages/altru-administration/src/Altru/Administration/Endpoints/Codetablesortmethods.php new file mode 100644 index 00000000..1bb232b9 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Endpoints/Codetablesortmethods.php @@ -0,0 +1,39 @@ +send("get", array_filter($params, fn($key) => in_array($key, ['code_table_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); + } +} diff --git a/packages/altru-administration/src/Altru/Administration/Endpoints/Currencies.php b/packages/altru-administration/src/Altru/Administration/Endpoints/Currencies.php index 057acdc7..fda28c96 100644 --- a/packages/altru-administration/src/Altru/Administration/Endpoints/Currencies.php +++ b/packages/altru-administration/src/Altru/Administration/Endpoints/Currencies.php @@ -4,12 +4,15 @@ use Battis\OpenAPI\Client\BaseEndpoint; use Blackbaud\SKY\Altru\Administration\Endpoints\Currencies\Currencyconfiguration; +use Blackbaud\SKY\Altru\Administration\Endpoints\Currencies\List_; /** * Routing class for the subnamespace `Currencies` * * @property \Blackbaud\SKY\Altru\Administration\Endpoints\Currencies\Currencyconfiguration * $currencyconfiguration + * @property \Blackbaud\SKY\Altru\Administration\Endpoints\Currencies\List_ + * $list_ * * @api */ @@ -21,6 +24,7 @@ class Currencies extends BaseEndpoint */ protected array $endpoints = [ "currencyconfiguration" => "\Blackbaud\SKY\Altru\Administration\Endpoints\Currencies\Currencyconfiguration", + "list_" => "\Blackbaud\SKY\Altru\Administration\Endpoints\Currencies\List_", ]; /** @@ -28,4 +32,10 @@ class Currencies extends BaseEndpoint * $_currencyconfiguration */ protected ?Currencyconfiguration $_currencyconfiguration = null; + + /** + * @var ?\Blackbaud\SKY\Altru\Administration\Endpoints\Currencies\List_ + * $_list_ + */ + protected ?List_ $_list_ = null; } diff --git a/packages/altru-administration/src/Altru/Administration/Endpoints/Currencies/Currencyconfiguration.php b/packages/altru-administration/src/Altru/Administration/Endpoints/Currencies/Currencyconfiguration.php index ee166c7e..20bcbc5e 100644 --- a/packages/altru-administration/src/Altru/Administration/Endpoints/Currencies/Currencyconfiguration.php +++ b/packages/altru-administration/src/Altru/Administration/Endpoints/Currencies/Currencyconfiguration.php @@ -17,8 +17,8 @@ class Currencyconfiguration extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-adnmg/currencies/{currency_id}/currencyconfiguration"; /** - * This view form loads information necessary for formatting a value as - * currency. + * This view operation loads inoperationation necessary for + * operationatting a value as currency. * * @param array{currency_id: string} $params An associative array * - currency_id: The currency id. @@ -34,6 +34,6 @@ public function getByCurrencyId(array $params): CurrencyConfigurationView { assert(isset($params['currency_id']), new ArgumentException("Parameter `currency_id` is required")); - return new CurrencyConfigurationView($this->send("get", ["currency_id" => $params['currency_id']], [])); + return new CurrencyConfigurationView($this->send("get", array_filter($params, fn($key) => in_array($key, ['currency_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-administration/src/Altru/Administration/Endpoints/Currencies/List.php b/packages/altru-administration/src/Altru/Administration/Endpoints/Currencies/List.php new file mode 100644 index 00000000..bcee74fd --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Endpoints/Currencies/List.php @@ -0,0 +1,54 @@ +send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['includeinactive','limit','session_key','infinity_session','more_rows_range_key','start_row_index']), ARRAY_FILTER_USE_KEY))); + } +} diff --git a/packages/altru-administration/src/Altru/Administration/Endpoints/Information.php b/packages/altru-administration/src/Altru/Administration/Endpoints/Information.php new file mode 100644 index 00000000..07e4ade8 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Endpoints/Information.php @@ -0,0 +1,29 @@ +send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); + } +} diff --git a/packages/altru-administration/src/Altru/Administration/Endpoints/Notifications.php b/packages/altru-administration/src/Altru/Administration/Endpoints/Notifications.php new file mode 100644 index 00000000..51b170f5 --- /dev/null +++ b/packages/altru-administration/src/Altru/Administration/Endpoints/Notifications.php @@ -0,0 +1,39 @@ +send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); + } +} diff --git a/packages/altru-administration/src/Altru/Administration/Endpoints/Simplelists.php b/packages/altru-administration/src/Altru/Administration/Endpoints/Simplelists.php index a3153763..56688c08 100644 --- a/packages/altru-administration/src/Altru/Administration/Endpoints/Simplelists.php +++ b/packages/altru-administration/src/Altru/Administration/Endpoints/Simplelists.php @@ -59,6 +59,6 @@ public function getBySimpleListId(array $params): ApiCollectionSimpleListLoad assert(isset($params['simple_list_id']), new ArgumentException("Parameter `simple_list_id` is required")); assert(isset($params['parameters']), new ArgumentException("Parameter `parameters` is required")); - return new ApiCollectionSimpleListLoad($this->send("get", ["simple_list_id" => $params['simple_list_id']], ["parameters" => $params['parameters']])); + return new ApiCollectionSimpleListLoad($this->send("get", array_filter($params, fn($key) => in_array($key, ['simple_list_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['parameters']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-administration/src/Altru/Administration/Endpoints/Simplelists/Translation.php b/packages/altru-administration/src/Altru/Administration/Endpoints/Simplelists/Translation.php index fbd3fa0b..c110268e 100644 --- a/packages/altru-administration/src/Altru/Administration/Endpoints/Simplelists/Translation.php +++ b/packages/altru-administration/src/Altru/Administration/Endpoints/Simplelists/Translation.php @@ -38,7 +38,6 @@ public function getBySimpleListId(array $params): SimpleListTranslation assert(isset($params['entry_id']), new ArgumentException("Parameter `entry_id` is required")); assert(isset($params['simple_list_name']), new ArgumentException("Parameter `simple_list_name` is required")); - return new SimpleListTranslation($this->send("get", ["simple_list_id" => $params['simple_list_id']], ["entry_id" => $params['entry_id'], - "simple_list_name" => $params['simple_list_name']])); + return new SimpleListTranslation($this->send("get", array_filter($params, fn($key) => in_array($key, ['simple_list_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['entry_id','simple_list_name']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-administration/src/Altru/Administration/Endpoints/Sites/Search.php b/packages/altru-administration/src/Altru/Administration/Endpoints/Sites/Search.php index 4c3a45fc..524d21bc 100644 --- a/packages/altru-administration/src/Altru/Administration/Endpoints/Sites/Search.php +++ b/packages/altru-administration/src/Altru/Administration/Endpoints/Sites/Search.php @@ -27,7 +27,7 @@ class Search extends BaseEndpoint * - name: name * - short_name: short name * - acronym: acronym - * - sitetype: site type This codetable can be queried at + * - sitetype: site type This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/SITETYPECODE/entries * - limit: Limits the number of records to return. @@ -49,12 +49,6 @@ public function list_(array $params): SiteSearchCollection assert(isset($params['sitetype']), new ArgumentException("Parameter `sitetype` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); - return new SiteSearchCollection($this->send("get", [], ["id" => $params['id'], - "site_id" => $params['site_id'], - "name" => $params['name'], - "short_name" => $params['short_name'], - "acronym" => $params['acronym'], - "sitetype" => $params['sitetype'], - "limit" => $params['limit']])); + return new SiteSearchCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['id','site_id','name','short_name','acronym','sitetype','limit']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-analysis/src/Altru/Analysis/Components/AdHocQueryRead.php b/packages/altru-analysis/src/Altru/Analysis/Components/AdHocQueryRead.php index d2874527..0666da3c 100644 --- a/packages/altru-analysis/src/Altru/Analysis/Components/AdHocQueryRead.php +++ b/packages/altru-analysis/src/Altru/Analysis/Components/AdHocQueryRead.php @@ -7,6 +7,7 @@ /** * @property int $count * @property string[] $fields + * @property string[] $field_names * @property string $queryname * @property string $recordtypeid * @property \string[][] $rows @@ -21,6 +22,7 @@ class AdHocQueryRead extends BaseComponent protected static array $fields = [ "count" => "int", "fields" => "string[]", + "field_names" => "string[]", "queryname" => "string", "recordtypeid" => "string", "rows" => "\string[][]", diff --git a/packages/altru-analysis/src/Altru/Analysis/Endpoints/Adhocqueries.php b/packages/altru-analysis/src/Altru/Analysis/Endpoints/Adhocqueries.php index df77bf93..eac2c1e1 100644 --- a/packages/altru-analysis/src/Altru/Analysis/Endpoints/Adhocqueries.php +++ b/packages/altru-analysis/src/Altru/Analysis/Endpoints/Adhocqueries.php @@ -52,6 +52,6 @@ public function getByQueryId(array $params): AdHocQueryRead assert(isset($params['query_id']), new ArgumentException("Parameter `query_id` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); - return new AdHocQueryRead($this->send("get", ["query_id" => $params['query_id']], ["limit" => $params['limit']])); + return new AdHocQueryRead($this->send("get", array_filter($params, fn($key) => in_array($key, ['query_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['limit']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-analysis/src/Altru/Analysis/Endpoints/Adhocqueries/Id.php b/packages/altru-analysis/src/Altru/Analysis/Endpoints/Adhocqueries/Id.php index d8cbef6f..c48039b7 100644 --- a/packages/altru-analysis/src/Altru/Analysis/Endpoints/Adhocqueries/Id.php +++ b/packages/altru-analysis/src/Altru/Analysis/Endpoints/Adhocqueries/Id.php @@ -32,6 +32,6 @@ public function getByQueryName(array $params): GetAdHocQueryId { assert(isset($params['query_name']), new ArgumentException("Parameter `query_name` is required")); - return new GetAdHocQueryId($this->send("get", ["query_name" => $params['query_name']], [])); + return new GetAdHocQueryId($this->send("get", array_filter($params, fn($key) => in_array($key, ['query_name']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Client.php b/packages/altru-constituent/src/Altru/Constituent/Client.php index ce54a98d..b7b73a7c 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Client.php +++ b/packages/altru-constituent/src/Altru/Constituent/Client.php @@ -59,23 +59,24 @@ * $mergetwoconstituents * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituentinactivityreasoncodes * $constituentinactivityreasoncodes - * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituentmergeconfiguration - * $constituentmergeconfiguration * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Tribute $tribute * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Tributes $tributes * Routing class for the subnamespace `Tributes` * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituentappeals * $constituentappeals Routing class for the subnamespace `Constituentappeals` - * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\States $states * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituentappealresponses * $constituentappealresponses * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Fundraisers * $fundraisers Routing class for the subnamespace `Fundraisers` * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Educationalhistories - * $educationalhistories + * $educationalhistories Routing class for the subnamespace + * `Educationalhistories` * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Relationshipjobsinfo * $relationshipjobsinfo + * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\States $states + * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituentmergeconfiguration + * $constituentmergeconfiguration * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituent * $constituent Routing class for the subnamespace `Constituent` * @@ -102,15 +103,15 @@ class Client extends BaseEndpoint "constituentnotes" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituentnotes", "mergetwoconstituents" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Mergetwoconstituents", "constituentinactivityreasoncodes" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituentinactivityreasoncodes", - "constituentmergeconfiguration" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituentmergeconfiguration", "tribute" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Tribute", "tributes" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Tributes", "constituentappeals" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituentappeals", - "states" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\States", "constituentappealresponses" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituentappealresponses", "fundraisers" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Fundraisers", "educationalhistories" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Educationalhistories", "relationshipjobsinfo" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Relationshipjobsinfo", + "states" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\States", + "constituentmergeconfiguration" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituentmergeconfiguration", "constituent" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituent", ]; @@ -199,12 +200,6 @@ class Client extends BaseEndpoint */ protected ?Constituentinactivityreasoncodes $_constituentinactivityreasoncodes = null; - /** - * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituentmergeconfiguration - * $_constituentmergeconfiguration - */ - protected ?Constituentmergeconfiguration $_constituentmergeconfiguration = null; - /** * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Tribute $_tribute */ @@ -223,11 +218,6 @@ class Client extends BaseEndpoint */ protected ?Constituentappeals $_constituentappeals = null; - /** - * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\States $_states - */ - protected ?States $_states = null; - /** * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituentappealresponses * $_constituentappealresponses @@ -242,7 +232,8 @@ class Client extends BaseEndpoint /** * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Educationalhistories - * $_educationalhistories + * $_educationalhistories Routing class for the subnamespace + * `Educationalhistories` */ protected ?Educationalhistories $_educationalhistories = null; @@ -252,6 +243,17 @@ class Client extends BaseEndpoint */ protected ?Relationshipjobsinfo $_relationshipjobsinfo = null; + /** + * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\States $_states + */ + protected ?States $_states = null; + + /** + * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituentmergeconfiguration + * $_constituentmergeconfiguration + */ + protected ?Constituentmergeconfiguration $_constituentmergeconfiguration = null; + /** * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituent * $_constituent Routing class for the subnamespace `Constituent` diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddress.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddress.php index eb4f66a1..d19bdebf 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddress.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddress.php @@ -7,13 +7,13 @@ /** * GetConstituentAddress * - * @property string $address_type The type. This codetable can be queried at + * @property string $address_type The type. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/addresstypecode/entries * @property string $address_block The address. * @property string $city The city. * @property string $state The state. This simple list can be queried at - * https://api.sky.blackbaud.com/alt-adnmg/simplelists/7fa91401-596c-4f7c-936d-6e41683121d7?parameters=country\_id,{country\_id}. + * https://api.sky.blackbaud.com/alt-adnmg/simplelists/7fa91401-596c-4f7c-936d-6e41683121d7?parameters=countryid,{countryid}. * @property string $postcode The zip. * @property string $country The country. This simple list can be queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/c9649672-353d-42e8-8c25-4d34bbabfbba. @@ -29,31 +29,32 @@ * address. * @property bool $omit_from_validation Indicates whether omit this address * from validation. - * @property string $county The county. This codetable can be queried at + * @property string $county The county. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/countycode/entries * @property string $congressional_district The congressional district. This - * codetable can be queried at + * code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/congressionaldistrictcode/entries - * @property string $state_house_district The state house district. This - * codetable can be queried at + * @property string $state_house_district The state house district. This code + * table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/statehousedistrictcode/entries * @property string $state_senate_district The state senate district. This - * codetable can be queried at + * code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/statesenatedistrictcode/entries - * @property string $local_precinct The local precinct. This codetable can be + * @property string $local_precinct The local precinct. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/localprecinctcode/entries - * @property string $info_source The information source. This codetable can be - * queried at + * @property string $info_source The information source. This code table can + * be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/infosourcecode/entries - * @property string $region The region. This codetable can be queried at + * @property string $region The region. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/regioncode/entries - * @property string $last_validation_attempt_date The last attempt.Uses the - * format YYYY-MM-DD. An example date: *2019-11-21*. + * @property string $last_validation_attempt_date The last attempt. Uses the + * format YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $validation_message The validation message. * @property int $certification_data The certification data. * @property string $ncoa_last_submit_date The last submit date. Read-only in - * the SOAP API.Uses the format YYYY-MM-DD. An example date: *2019-11-21*. + * the SOAP API. Uses the format YYYY-MM-DDThh:mm:ss. An example date: + * *1955-11-05T22:04:00*. * @property string $ncoa_return The return code. Read-only in the SOAP API. * @property string $ncoa_footnote The footnote. Read-only in the SOAP API. * @property string $ncoa_dpv_footnote The dpv footnote. Read-only in the SOAP @@ -64,15 +65,15 @@ * Read-only in the SOAP API. * @property string $ncoa_mail_grade The mail grade. Read-only in the SOAP * API. - * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentAddressZiplookupcountries[] - * $zip_lookup_countries zip\_lookup\_countries - * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentAddressValidationcountries[] - * $validation_countries validation\_countries + * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentAddressZipLookupCountries[] + * $zip_lookup_countries Zip lookup countries. + * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentAddressValidationCountries[] + * $validation_countries Validation countries. * @property bool $update_contacts Indicates whether update contacts that use * this address. * @property bool $has_contacts Indicates whether has contacts. Read-only in * the SOAP API. - * @property string $do_not_mail_reason The reason. This codetable can be + * @property string $do_not_mail_reason The reason. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/donotmailreasoncode/entries * @property bool $household Indicates whether household. Read-only in the @@ -81,14 +82,15 @@ * Read-only in the SOAP API. * @property bool $update_matching_household_addresses Indicates whether * update matching addresses in household. - * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentAddressMatchinghouseholdmembers[] - * $matching_household_members matching\_household\_members - * @property string $historical_start_date The start date.Uses the format - * YYYY-MM-DD. An example date: *2019-11-21*. - * @property string $historical_end_date The end date.Uses the format - * YYYY-MM-DD. An example date: *2019-11-21*. - * @property string $date_added The date added. Read-only in the SOAP API.Uses - * the format YYYY-MM-DD. An example date: *2019-11-21*. + * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentAddressMatchingHouseholdMembers[] + * $matching_household_members Matching household members. + * @property string $historical_start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $historical_end_date The end date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $date_added The date added. Read-only in the SOAP API. + * Uses the format YYYY-MM-DDThh:mm:ss. An example date: + * *1955-11-05T22:04:00*. * @property string $info_source_comments The comments. * @property bool $confidential Indicates whether this address is * confidential. @@ -143,15 +145,15 @@ class ConstituentAddress extends BaseComponent "ncoa_move_date" => "\Blackbaud\SKY\Altru\Constituent\Components\FuzzyDate", "ncoa_dma_suppression" => "bool", "ncoa_mail_grade" => "string", - "zip_lookup_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentAddressZiplookupcountries[]", - "validation_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentAddressValidationcountries[]", + "zip_lookup_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentAddressZipLookupCountries[]", + "validation_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentAddressValidationCountries[]", "update_contacts" => "bool", "has_contacts" => "bool", "do_not_mail_reason" => "string", "household" => "bool", "household_member" => "bool", "update_matching_household_addresses" => "bool", - "matching_household_members" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentAddressMatchinghouseholdmembers[]", + "matching_household_members" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentAddressMatchingHouseholdMembers[]", "historical_start_date" => "string", "historical_end_date" => "string", "date_added" => "string", diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressListCollection.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressListCollection.php index a9d6c6c0..42b72aa3 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressListCollection.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressListCollection.php @@ -5,16 +5,22 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentAddressListSummary[] * $value The set of items included in the response. This may be a subset of * the items in the collection. + * @property string $infinity_session Values for cookies related to the + * Infinity load balancer session. + * @property string $session_key Session key for paging provided by user in + * request query parameter. + * @property int $total_available_rows The number of total rows available. + * @property string $more_rows_range_key Key for accessing cached results on + * subsequent calls to this data list. + * @property bool $data_no_longer_available Indicates data is no longer + * available in the context of this session. * * @api */ @@ -26,5 +32,10 @@ class ConstituentAddressListCollection extends BaseComponent protected static array $fields = [ "count" => "int", "value" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentAddressListSummary[]", + "infinity_session" => "string", + "session_key" => "string", + "total_available_rows" => "int", + "more_rows_range_key" => "string", + "data_no_longer_available" => "bool", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressListSummary.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressListSummary.php index 209ce668..f0cdf598 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressListSummary.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressListSummary.php @@ -5,19 +5,19 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ListConstituentAddress + * ListConstituentAddresses * - * @property string $id The id. + * @property string $id The ID. * @property string $contact_info The contact information. * @property string $type The type. * @property string $primary The primary. * @property string $do_not_contact The do not contact. * @property bool $confidential Indicates whether confidential. * @property bool $former Indicates whether isformer. - * @property string $start_date The start date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $end_date The end date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $end_date The end date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property bool $geocoded Indicates whether isgeocoded. * @property bool $pending_geocode Indicates whether pendinggeocode. * @property bool $invalid_geocode Indicates whether invalidgeocode. diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressMatchinghouseholdmembers.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressMatchinghouseholdmembers.php index 7b40f4e7..0b4ebb06 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressMatchinghouseholdmembers.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressMatchinghouseholdmembers.php @@ -5,7 +5,7 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ConstituentAddressMatchinghouseholdmembers + * ConstituentAddressMatchingHouseholdMembers * * @property string $constituent_id constituent id * @property string $name household member @@ -13,7 +13,7 @@ * * @api */ -class ConstituentAddressMatchinghouseholdmembers extends BaseComponent +class ConstituentAddressMatchingHouseholdMembers extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressSearchCollection.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressSearchCollection.php index c3c28373..2617085c 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressSearchCollection.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressSearchCollection.php @@ -5,10 +5,7 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressSearchSummary.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressSearchSummary.php index 179e59f0..01545e43 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressSearchSummary.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressSearchSummary.php @@ -5,9 +5,9 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * SearchConstituentAddress + * SearchConstituentAddresses * - * @property string $id The id. + * @property string $id The ID. * @property string $name The name. * @property string $address The address. * @property string $city The city. diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressValidationcountries.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressValidationcountries.php index b3a17c54..73bc5e6a 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressValidationcountries.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressValidationcountries.php @@ -5,14 +5,14 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ConstituentAddressValidationcountries + * ConstituentAddressValidationCountries * * @property string $country_id countryid * @property bool $browsable browsable * * @api */ -class ConstituentAddressValidationcountries extends BaseComponent +class ConstituentAddressValidationCountries extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressView.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressView.php index 120c01d0..4d93b62a 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressView.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressView.php @@ -8,7 +8,7 @@ * ViewConstituentAddress * * @property string $address_type The type. - * @property string $country_id The country id. + * @property string $country_id The country ID. * @property string $country The country. * @property string $address_block The address. * @property string $city The city. @@ -18,12 +18,12 @@ * @property bool $do_not_mail Indicates whether do not mail. * @property string $do_not_mail_reason_code The do not mail reason code. * @property bool $confidential Indicates whether is confidential. - * @property string $start_date The start date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $end_date The end date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $date_added The date added.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $end_date The end date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $date_added The date added. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property \Blackbaud\SKY\Altru\Constituent\Components\MonthDay * $seasonal_start_date MonthDay * @property \Blackbaud\SKY\Altru\Constituent\Components\MonthDay diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressZiplookupcountries.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressZiplookupcountries.php index 8e3f2458..a13644f4 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressZiplookupcountries.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAddressZiplookupcountries.php @@ -5,14 +5,14 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ConstituentAddressZiplookupcountries + * ConstituentAddressZipLookupCountries * * @property string $country_id countryid * @property string $country_name name * * @api */ -class ConstituentAddressZiplookupcountries extends BaseComponent +class ConstituentAddressZipLookupCountries extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAlternateLookupId.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAlternateLookupId.php index 002333fc..bd140b18 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAlternateLookupId.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAlternateLookupId.php @@ -7,10 +7,10 @@ /** * GetConstituentAlternateLookupId * - * @property string $alternate_lookup_id_type The type. This codetable can be + * @property string $alternate_lookup_id_type The type. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/alternatelookupidtypecode/entries - * @property string $alternate_lookup_id The lookup id. + * @property string $alternate_lookup_id The lookup ID. * * @api */ diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAlternateLookupIdListCollection.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAlternateLookupIdListCollection.php index 0a0ad623..b71045fc 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAlternateLookupIdListCollection.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAlternateLookupIdListCollection.php @@ -5,16 +5,22 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentAlternateLookupIdListSummary[] * $value The set of items included in the response. This may be a subset of * the items in the collection. + * @property string $infinity_session Values for cookies related to the + * Infinity load balancer session. + * @property string $session_key Session key for paging provided by user in + * request query parameter. + * @property int $total_available_rows The number of total rows available. + * @property string $more_rows_range_key Key for accessing cached results on + * subsequent calls to this data list. + * @property bool $data_no_longer_available Indicates data is no longer + * available in the context of this session. * * @api */ @@ -26,5 +32,10 @@ class ConstituentAlternateLookupIdListCollection extends BaseComponent protected static array $fields = [ "count" => "int", "value" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentAlternateLookupIdListSummary[]", + "infinity_session" => "string", + "session_key" => "string", + "total_available_rows" => "int", + "more_rows_range_key" => "string", + "data_no_longer_available" => "bool", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAlternateLookupIdListSummary.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAlternateLookupIdListSummary.php index bc813de4..fe54c76d 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAlternateLookupIdListSummary.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAlternateLookupIdListSummary.php @@ -5,11 +5,11 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ListConstituentAlternateLookupId + * ListConstituentAlternateLookupIds * - * @property string $id The id. + * @property string $id The ID. * @property string $type The type. - * @property string $alternate_lookup_id The lookup id. + * @property string $alternate_lookup_id The lookup ID. * * @api */ diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAppeal.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAppeal.php index 27b8b4ff..6518fa07 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAppeal.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAppeal.php @@ -11,8 +11,8 @@ * @property string $mkt_segmentation The mailing. This simple list can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/664c0aa7-9f88-46f6-ba84-7b412e1131b5?parameters=appeal\_id,{appeal\_id}. - * @property string $date_sent The date sent.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $date_sent The date sent. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $mkt_package_id The package. * @property string $source_code The source code. * @property string $comments The comments. diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAppealListCollection.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAppealListCollection.php index 255dbf98..ae651a4c 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAppealListCollection.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAppealListCollection.php @@ -5,16 +5,22 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentAppealListSummary[] * $value The set of items included in the response. This may be a subset of * the items in the collection. + * @property string $infinity_session Values for cookies related to the + * Infinity load balancer session. + * @property string $session_key Session key for paging provided by user in + * request query parameter. + * @property int $total_available_rows The number of total rows available. + * @property string $more_rows_range_key Key for accessing cached results on + * subsequent calls to this data list. + * @property bool $data_no_longer_available Indicates data is no longer + * available in the context of this session. * * @api */ @@ -26,5 +32,10 @@ class ConstituentAppealListCollection extends BaseComponent protected static array $fields = [ "count" => "int", "value" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentAppealListSummary[]", + "infinity_session" => "string", + "session_key" => "string", + "total_available_rows" => "int", + "more_rows_range_key" => "string", + "data_no_longer_available" => "bool", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAppealListSummary.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAppealListSummary.php index bd09f337..54a43487 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAppealListSummary.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAppealListSummary.php @@ -5,19 +5,19 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ListConstituentAppeal + * ListConstituentAppeals * - * @property string $id The id. - * @property string $appeal_id The appeal id. + * @property string $id The ID. + * @property string $appeal_id The appeal ID. * @property string $appeal The appeal. * @property string $description The description. - * @property string $date_sent The date sent.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $date_sent The date sent. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $source_code The source code. * @property int $finder_number The finder number. * @property string $comments The comments. - * @property string $mkt_segmentation_id The mailing id. - * @property string $mkt_segmentation_segment_id The segment id. + * @property string $mkt_segmentation_id The mailing ID. + * @property string $mkt_segmentation_segment_id The segment ID. * @property string $letter The letter. * @property string $package The package. * @property string $mailing The mailing. diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAppealResponse.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAppealResponse.php index 1baa8d08..cd0700ec 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAppealResponse.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAppealResponse.php @@ -8,7 +8,7 @@ * GetConstituentAppealResponse * * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentAppealResponseResponses[] - * $responses responses + * $responses Responses. * * @api */ diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAttribute.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAttribute.php index ba706703..a531500d 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAttribute.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAttribute.php @@ -17,11 +17,11 @@ * @property string $string_value The value. * @property int $number_value The value. * @property float $money_value The value. - * @property string $date_value The value.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $date_value The value. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $booleanvalue The value. Available values are *no*, *yes* - * @property string $code_table_value The value. This codetable can be queried - * at + * @property string $code_table_value The value. This code table can be + * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/addresstypecode/entries * @property \Blackbaud\SKY\Altru\Constituent\Components\FuzzyDate @@ -32,15 +32,15 @@ * @property string $memo_value The value. * @property string $comment The comment. * @property string $constituent_search_list_catalog_id The constituent search - * list catalog id. Read-only in the SOAP API. + * list catalog ID. Read-only in the SOAP API. * @property string $code_table_name The code table name. Read-only in the * SOAP API. - * @property string $start_date The start date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $end_date The end date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $end_date The end date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $currency The currency. This simple list can be queried at - * https://api.sky.blackbaud.com/alt-adnmg/simplelists/13612288-b37e-409d-ba52-6ab31637ddd6?parameters=transaction\_currency\_id,{transaction\_currency\_id}&parameters=base\_currency\_id,{base\_currency\_id}&parameters=current\_currency\_id,{currency\_id}. + * https://api.sky.blackbaud.com/alt-adnmg/simplelists/13612288-b37e-409d-ba52-6ab31637ddd6?parameters=transaction\_currency\_id,{transaction\_currency\_id}&parameters=base\_currency\_id,{base\_currency\_id}&parameters=current\_currency\_id,{currencyid}. * @property string $transaction_currency_id The transaction currency. * Read-only in the SOAP API. * @property string $base_currency_id The base currency. Read-only in the SOAP diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAttributeListCollection.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAttributeListCollection.php index 245f7b70..47c4287c 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAttributeListCollection.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAttributeListCollection.php @@ -5,16 +5,22 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentAttributeListSummary[] * $value The set of items included in the response. This may be a subset of * the items in the collection. + * @property string $infinity_session Values for cookies related to the + * Infinity load balancer session. + * @property string $session_key Session key for paging provided by user in + * request query parameter. + * @property int $total_available_rows The number of total rows available. + * @property string $more_rows_range_key Key for accessing cached results on + * subsequent calls to this data list. + * @property bool $data_no_longer_available Indicates data is no longer + * available in the context of this session. * * @api */ @@ -26,5 +32,10 @@ class ConstituentAttributeListCollection extends BaseComponent protected static array $fields = [ "count" => "int", "value" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentAttributeListSummary[]", + "infinity_session" => "string", + "session_key" => "string", + "total_available_rows" => "int", + "more_rows_range_key" => "string", + "data_no_longer_available" => "bool", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAttributeListSummary.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAttributeListSummary.php index 9e10a4b0..69eea438 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAttributeListSummary.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentAttributeListSummary.php @@ -5,18 +5,18 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ListConstituentAttribute + * ListConstituentAttributes * - * @property string $id The id. + * @property string $id The ID. * @property string $attribute_category_id The attributecategoryid. * @property string $category The category. * @property string $value The value. * @property string $attribute_key The attributekey. * @property string $comment The comment. - * @property string $start_date The start date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $end_date The end date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $end_date The end date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $attribute_group The attribute group. * * @api diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentConstituenciesdisplayorder.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentConstituenciesdisplayorder.php index 694f4bf3..64a89a4f 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentConstituenciesdisplayorder.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentConstituenciesdisplayorder.php @@ -5,7 +5,7 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ConstituentConstituenciesdisplayorder + * ConstituentConstituenciesDisplayOrder * * @property string $id id * @property string $description description @@ -14,7 +14,7 @@ * * @api */ -class ConstituentConstituenciesdisplayorder extends BaseComponent +class ConstituentConstituenciesDisplayOrder extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentContactListCollection.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentContactListCollection.php index 237f1c04..71f93211 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentContactListCollection.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentContactListCollection.php @@ -5,16 +5,22 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentContactListSummary[] * $value The set of items included in the response. This may be a subset of * the items in the collection. + * @property string $infinity_session Values for cookies related to the + * Infinity load balancer session. + * @property string $session_key Session key for paging provided by user in + * request query parameter. + * @property int $total_available_rows The number of total rows available. + * @property string $more_rows_range_key Key for accessing cached results on + * subsequent calls to this data list. + * @property bool $data_no_longer_available Indicates data is no longer + * available in the context of this session. * * @api */ @@ -26,5 +32,10 @@ class ConstituentContactListCollection extends BaseComponent protected static array $fields = [ "count" => "int", "value" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentContactListSummary[]", + "infinity_session" => "string", + "session_key" => "string", + "total_available_rows" => "int", + "more_rows_range_key" => "string", + "data_no_longer_available" => "bool", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentContactListSummary.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentContactListSummary.php index 595c893f..f9cab08b 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentContactListSummary.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentContactListSummary.php @@ -5,19 +5,18 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ListContactEmailAddress + * ListContactEmailAddresses * - * @property string $id The id. + * @property string $id The ID. * @property string $contact_info The contact information. * @property string $type The type. * @property string $is_primary The primary. * @property string $do_not_contact The do not contact. * @property bool $is_former Indicates whether isformer. - * @property string $start_date The start date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $end_date The end date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $imagekey The imagekey. + * @property string $start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $end_date The end date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property bool $invalid_email Indicates whether invalid email. * * @api @@ -36,7 +35,6 @@ class ConstituentContactListSummary extends BaseComponent "is_former" => "bool", "start_date" => "string", "end_date" => "string", - "imagekey" => "string", "invalid_email" => "bool", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentCorrespondenceCode.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentCorrespondenceCode.php index 7b1f1ad1..a6039b15 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentCorrespondenceCode.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentCorrespondenceCode.php @@ -10,8 +10,9 @@ * @property string $correspondence_code The the code associated with this * correspondence.. This simple list can be queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/63305295-220e-43a1-b744-359c7ffb77f5. - * @property string $date_sent The date when this correspondence was - * sent..Uses the format YYYY-MM-DD. An example date: *2019-11-21*. + * @property string $date_sent The date when this correspondence was sent.. + * Uses the format YYYY-MM-DDThh:mm:ss. An example date: + * *1955-11-05T22:04:00*. * @property string $comments The comments regarding this correspondence.. * @property bool $require_code Indicates whether require code. Read-only in * the SOAP API. diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentCorrespondenceCodeResponse.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentCorrespondenceCodeResponse.php new file mode 100644 index 00000000..5f76a5a6 --- /dev/null +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentCorrespondenceCodeResponse.php @@ -0,0 +1,23 @@ + "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentCorrespondenceCodeResponseResponses[]", + ]; +} diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentCorrespondenceCodeResponseResponses.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentCorrespondenceCodeResponseResponses.php new file mode 100644 index 00000000..888abb6e --- /dev/null +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentCorrespondenceCodeResponseResponses.php @@ -0,0 +1,31 @@ + "string", + "response_category" => "string", + "response" => "string", + "code" => "string", + ]; +} diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentDuplicateMatchListCollection.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentDuplicateMatchListCollection.php index 8916852d..5ccb7fc6 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentDuplicateMatchListCollection.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentDuplicateMatchListCollection.php @@ -5,16 +5,22 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentDuplicateMatchListSummary[] * $value The set of items included in the response. This may be a subset of * the items in the collection. + * @property string $infinity_session Values for cookies related to the + * Infinity load balancer session. + * @property string $session_key Session key for paging provided by user in + * request query parameter. + * @property int $total_available_rows The number of total rows available. + * @property string $more_rows_range_key Key for accessing cached results on + * subsequent calls to this data list. + * @property bool $data_no_longer_available Indicates data is no longer + * available in the context of this session. * * @api */ @@ -26,5 +32,10 @@ class ConstituentDuplicateMatchListCollection extends BaseComponent protected static array $fields = [ "count" => "int", "value" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentDuplicateMatchListSummary[]", + "infinity_session" => "string", + "session_key" => "string", + "total_available_rows" => "int", + "more_rows_range_key" => "string", + "data_no_longer_available" => "bool", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentDuplicateMatchListSummary.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentDuplicateMatchListSummary.php index f16cde36..0975e092 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentDuplicateMatchListSummary.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentDuplicateMatchListSummary.php @@ -5,9 +5,9 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ListConstituentDuplicateMatch + * ListConstituentDuplicateMatches * - * @property string $constituent_id The constituent id. + * @property string $constituent_id The constituent ID. * @property int $match_score The match score. * * @api diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentEmailAddress.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentEmailAddress.php index 41b0d0c1..5c93d57b 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentEmailAddress.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentEmailAddress.php @@ -7,7 +7,7 @@ /** * GetConstituentEmailAddress * - * @property string $email_address_type The type. This codetable can be + * @property string $email_address_type The type. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/emailaddresstypecode/entries * @property string $email_address The email address. @@ -25,10 +25,10 @@ * Read-only in the SOAP API. * @property bool $update_matching_household_email_address Indicates whether * update matching email addresses in household. - * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentEmailAddressMatchinghouseholdmembers[] - * $matching_household_members matching\_household\_members - * @property string $info_source The information source. This codetable can be - * queried at + * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentEmailAddressMatchingHouseholdMembers[] + * $matching_household_members Matching household members. + * @property string $info_source The information source. This code table can + * be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/infosourcecode/entries * @property string $info_source_comments The comments. * @property string $constituent_data_review_rollback_reason The reason. This @@ -42,14 +42,15 @@ * API. * @property string $origin The origin. Read-only in the SOAP API. Available * values are *user*, *web forms* - * @property string $start_date The start date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $end_date The end date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $end_date The end date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property bool $invalid_email Indicates whether invalid email. Read-only in * the SOAP API. * @property string $email_bounced_date The email bounced date. Read-only in - * the SOAP API.Uses the format YYYY-MM-DD. An example date: *2019-11-21*. + * the SOAP API. Uses the format YYYY-MM-DDThh:mm:ss. An example date: + * *1955-11-05T22:04:00*. * * @api */ @@ -69,7 +70,7 @@ class ConstituentEmailAddress extends BaseComponent "household" => "bool", "household_member" => "bool", "update_matching_household_email_address" => "bool", - "matching_household_members" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentEmailAddressMatchinghouseholdmembers[]", + "matching_household_members" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentEmailAddressMatchingHouseholdMembers[]", "info_source" => "string", "info_source_comments" => "string", "constituent_data_review_rollback_reason" => "string", diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentEmailAddressListCollection.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentEmailAddressListCollection.php index 411e4979..4aaad160 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentEmailAddressListCollection.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentEmailAddressListCollection.php @@ -5,16 +5,22 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentEmailAddressListSummary[] * $value The set of items included in the response. This may be a subset of * the items in the collection. + * @property string $infinity_session Values for cookies related to the + * Infinity load balancer session. + * @property string $session_key Session key for paging provided by user in + * request query parameter. + * @property int $total_available_rows The number of total rows available. + * @property string $more_rows_range_key Key for accessing cached results on + * subsequent calls to this data list. + * @property bool $data_no_longer_available Indicates data is no longer + * available in the context of this session. * * @api */ @@ -26,5 +32,10 @@ class ConstituentEmailAddressListCollection extends BaseComponent protected static array $fields = [ "count" => "int", "value" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentEmailAddressListSummary[]", + "infinity_session" => "string", + "session_key" => "string", + "total_available_rows" => "int", + "more_rows_range_key" => "string", + "data_no_longer_available" => "bool", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentEmailAddressListSummary.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentEmailAddressListSummary.php index dd50b6d8..7e78c86d 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentEmailAddressListSummary.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentEmailAddressListSummary.php @@ -5,22 +5,20 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ListConstituentEmailAddress + * ListConstituentEmailAddresses * - * @property string $id The id. + * @property string $id The ID. * @property string $email_address The email address. * @property string $type The type. * @property bool $primary Indicates whether primary. - * @property string $do_not_email The do not email. * @property string $info_source The information source. * @property string $info_source_comments The information source comments. * @property string $email_address_type_code_id The email address type code - * id. - * @property bool $donotemail Indicates whether donotemail. - * @property string $start_date The startdate.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $end_date The enddate.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * ID. + * @property string $start_date The startdate. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $end_date The enddate. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * * @api */ @@ -34,11 +32,9 @@ class ConstituentEmailAddressListSummary extends BaseComponent "email_address" => "string", "type" => "string", "primary" => "bool", - "do_not_email" => "string", "info_source" => "string", "info_source_comments" => "string", "email_address_type_code_id" => "string", - "donotemail" => "bool", "start_date" => "string", "end_date" => "string", ]; diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentEmailAddressMatchinghouseholdmembers.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentEmailAddressMatchinghouseholdmembers.php index 82e4b9a3..05e24e1b 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentEmailAddressMatchinghouseholdmembers.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentEmailAddressMatchinghouseholdmembers.php @@ -5,7 +5,7 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ConstituentEmailAddressMatchinghouseholdmembers + * ConstituentEmailAddressMatchingHouseholdMembers * * @property string $constituent_id constituent id * @property string $name household member @@ -13,7 +13,7 @@ * * @api */ -class ConstituentEmailAddressMatchinghouseholdmembers extends BaseComponent +class ConstituentEmailAddressMatchingHouseholdMembers extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentFundraiser.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentFundraiser.php index f36aa756..cafa4f77 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentFundraiser.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentFundraiser.php @@ -7,10 +7,10 @@ /** * GetConstituentFundraiser * - * @property string $date_from The date from.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $date_to The date to.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $date_from The date from. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $date_to The date to. Uses the format YYYY-MM-DDThh:mm:ss. + * An example date: *1955-11-05T22:04:00*. * * @api */ diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentFundraiserListCollection.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentFundraiserListCollection.php index a6d7a237..b2b8e02e 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentFundraiserListCollection.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentFundraiserListCollection.php @@ -5,16 +5,22 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentFundraiserListSummary[] * $value The set of items included in the response. This may be a subset of * the items in the collection. + * @property string $infinity_session Values for cookies related to the + * Infinity load balancer session. + * @property string $session_key Session key for paging provided by user in + * request query parameter. + * @property int $total_available_rows The number of total rows available. + * @property string $more_rows_range_key Key for accessing cached results on + * subsequent calls to this data list. + * @property bool $data_no_longer_available Indicates data is no longer + * available in the context of this session. * * @api */ @@ -26,5 +32,10 @@ class ConstituentFundraiserListCollection extends BaseComponent protected static array $fields = [ "count" => "int", "value" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentFundraiserListSummary[]", + "infinity_session" => "string", + "session_key" => "string", + "total_available_rows" => "int", + "more_rows_range_key" => "string", + "data_no_longer_available" => "bool", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentFundraiserListSummary.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentFundraiserListSummary.php index 7dfc5024..ed7bfa5e 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentFundraiserListSummary.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentFundraiserListSummary.php @@ -5,9 +5,9 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ListConstituentFundraiser + * ListConstituentFundraisers * - * @property string $id The id. + * @property string $id The ID. * @property string $name The name. * @property int $prospect_plans_as_primary_manager The prospect plans (as * primary manager). diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentFundraiserSearchCollection.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentFundraiserSearchCollection.php index 88cef5fb..1ac910a9 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentFundraiserSearchCollection.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentFundraiserSearchCollection.php @@ -5,10 +5,7 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentFundraiserSearchSummary.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentFundraiserSearchSummary.php index a30fb4fc..9e91b159 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentFundraiserSearchSummary.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentFundraiserSearchSummary.php @@ -5,9 +5,9 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * SearchConstituentFundraiser + * SearchConstituentFundraisers * - * @property string $id The id. + * @property string $id The ID. * @property string $sort_constituent_name The name. * @property string $city The city. * @property string $state The state. diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentInactivityReasonCodesListCollection.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentInactivityReasonCodesListCollection.php index 75e3e36b..1bfe2b9f 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentInactivityReasonCodesListCollection.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentInactivityReasonCodesListCollection.php @@ -5,16 +5,22 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentInactivityReasonCodesListSummary[] * $value The set of items included in the response. This may be a subset of * the items in the collection. + * @property string $infinity_session Values for cookies related to the + * Infinity load balancer session. + * @property string $session_key Session key for paging provided by user in + * request query parameter. + * @property int $total_available_rows The number of total rows available. + * @property string $more_rows_range_key Key for accessing cached results on + * subsequent calls to this data list. + * @property bool $data_no_longer_available Indicates data is no longer + * available in the context of this session. * * @api */ @@ -26,5 +32,10 @@ class ConstituentInactivityReasonCodesListCollection extends BaseComponent protected static array $fields = [ "count" => "int", "value" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentInactivityReasonCodesListSummary[]", + "infinity_session" => "string", + "session_key" => "string", + "total_available_rows" => "int", + "more_rows_range_key" => "string", + "data_no_longer_available" => "bool", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentInactivityReasonCodesListSummary.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentInactivityReasonCodesListSummary.php index 5e2d7bce..862dc2dd 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentInactivityReasonCodesListSummary.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentInactivityReasonCodesListSummary.php @@ -7,7 +7,7 @@ /** * ListConstituentInactivityReasonCodes * - * @property string $id The id. + * @property string $id The ID. * @property string $code The reason code. * @property string $description The description. * @property bool $active Indicates whether active. diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentInteraction.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentInteraction.php index dd0a1b0f..579d5de2 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentInteraction.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentInteraction.php @@ -7,23 +7,23 @@ /** * GetConstituentInteraction * - * @property string $interaction_type The contact method. This codetable can + * @property string $interaction_type The contact method. This code table can * be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/interactiontypecode/entries * @property string $objective The summary. * @property string $fundraiser_id The owner. - * @property string $expected_date The expected date.Uses the format - * YYYY-MM-DD. An example date: *2019-11-21*. - * @property string $actual_date The actual date.Uses the format YYYY-MM-DD. - * An example date: *2019-11-21*. + * @property string $expected_date The expected date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $actual_date The actual date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $status The status. Available values are *pending*, * *completed*, *canceled*, *declined* * @property string $comment The comment. * @property bool $step Indicates whether is step. Read-only in the SOAP API. * @property string $event_id The event. * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentInteractionParticipants[] - * $participants participants - * @property string $constituent_id The constituent id. Read-only in the SOAP + * $participants Participants. + * @property string $constituent_id The constituent ID. Read-only in the SOAP * API. * @property string $constituent_name The constituent name. Read-only in the * SOAP API. @@ -32,9 +32,9 @@ * https://api.sky.blackbaud.com/alt-adnmg/simplelists/cbba7545-b66f-44ac-aa24-d9c2f8cbc4ec. * @property string $interaction_subcategory The subcategory. This simple list * can be queried at - * https://api.sky.blackbaud.com/alt-adnmg/simplelists/0eacc39b-07d1-4641-8774-e319559535a7?parameters=interaction\_category\_id,{interaction\_category\_id}. + * https://api.sky.blackbaud.com/alt-adnmg/simplelists/0eacc39b-07d1-4641-8774-e319559535a7?parameters=interactioncategoryid,{interactioncategoryid}. * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentInteractionSites[] - * $sites sites + * $sites Sites. * @property \Blackbaud\SKY\Altru\Constituent\Components\HourMinute * $expected_start_time HourMinute * @property \Blackbaud\SKY\Altru\Constituent\Components\HourMinute diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentListCollection.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentListCollection.php index 9591a797..b6ed988e 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentListCollection.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentListCollection.php @@ -5,16 +5,22 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentListSummary[] * $value The set of items included in the response. This may be a subset of * the items in the collection. + * @property string $infinity_session Values for cookies related to the + * Infinity load balancer session. + * @property string $session_key Session key for paging provided by user in + * request query parameter. + * @property int $total_available_rows The number of total rows available. + * @property string $more_rows_range_key Key for accessing cached results on + * subsequent calls to this data list. + * @property bool $data_no_longer_available Indicates data is no longer + * available in the context of this session. * * @api */ @@ -26,5 +32,10 @@ class ConstituentListCollection extends BaseComponent protected static array $fields = [ "count" => "int", "value" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentListSummary[]", + "infinity_session" => "string", + "session_key" => "string", + "total_available_rows" => "int", + "more_rows_range_key" => "string", + "data_no_longer_available" => "bool", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentListSummary.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentListSummary.php index 3e395bd4..3b7a5a33 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentListSummary.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentListSummary.php @@ -7,14 +7,14 @@ /** * ListPatronData * - * @property string $id The id. + * @property string $id The ID. * @property string $sales_order_id The salesorderid. - * @property string $refund_date The refund date.Uses the format YYYY-MM-DD. - * An example date: *2019-11-21*. + * @property string $refund_date The refund date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property float $refund_total The refund amount. * @property string $refund_items The refund items. - * @property string $transaction_date The order date.Uses the format - * YYYY-MM-DD. An example date: *2019-11-21*. + * @property string $transaction_date The order date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $order_number The order number. * @property float $order_total The order total. * diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentMembershipsListCollection.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentMembershipsListCollection.php index 4fc9bcbd..81d21533 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentMembershipsListCollection.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentMembershipsListCollection.php @@ -5,16 +5,22 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentMembershipsListSummary[] * $value The set of items included in the response. This may be a subset of * the items in the collection. + * @property string $infinity_session Values for cookies related to the + * Infinity load balancer session. + * @property string $session_key Session key for paging provided by user in + * request query parameter. + * @property int $total_available_rows The number of total rows available. + * @property string $more_rows_range_key Key for accessing cached results on + * subsequent calls to this data list. + * @property bool $data_no_longer_available Indicates data is no longer + * available in the context of this session. * * @api */ @@ -26,5 +32,10 @@ class ConstituentMembershipsListCollection extends BaseComponent protected static array $fields = [ "count" => "int", "value" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentMembershipsListSummary[]", + "infinity_session" => "string", + "session_key" => "string", + "total_available_rows" => "int", + "more_rows_range_key" => "string", + "data_no_longer_available" => "bool", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentMembershipsListSummary.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentMembershipsListSummary.php index 1f70b573..6e7f3d5d 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentMembershipsListSummary.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentMembershipsListSummary.php @@ -7,10 +7,10 @@ /** * ListConstituentMemberships * - * @property string $id The id. + * @property string $id The ID. * @property string $membership_name The membership. * @property string $primary_member_name The primary member. - * @property string $combo_id The combo id. + * @property string $combo_id The combo ID. * @property int $status_code The status code. * * @api diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentMergeListCollection.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentMergeListCollection.php index b6237e12..b918484f 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentMergeListCollection.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentMergeListCollection.php @@ -5,16 +5,22 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentMergeListSummary[] * $value The set of items included in the response. This may be a subset of * the items in the collection. + * @property string $infinity_session Values for cookies related to the + * Infinity load balancer session. + * @property string $session_key Session key for paging provided by user in + * request query parameter. + * @property int $total_available_rows The number of total rows available. + * @property string $more_rows_range_key Key for accessing cached results on + * subsequent calls to this data list. + * @property bool $data_no_longer_available Indicates data is no longer + * available in the context of this session. * * @api */ @@ -26,5 +32,10 @@ class ConstituentMergeListCollection extends BaseComponent protected static array $fields = [ "count" => "int", "value" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentMergeListSummary[]", + "infinity_session" => "string", + "session_key" => "string", + "total_available_rows" => "int", + "more_rows_range_key" => "string", + "data_no_longer_available" => "bool", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentMergeListSummary.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentMergeListSummary.php index 8ea64a45..786f40a6 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentMergeListSummary.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentMergeListSummary.php @@ -5,9 +5,9 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ListConstituentMergeConfiguration + * ListConstituentMergeConfigurations * - * @property string $id The id. + * @property string $id The ID. * @property string $name The name. * @property string $description The description. * diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentNoteView.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentNoteView.php index f13b6ba6..4103194b 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentNoteView.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentNoteView.php @@ -7,8 +7,8 @@ /** * ViewConstituentNote * - * @property string $date_entered The date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $date_entered The date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $title The title. * @property string $text_note The note. * @property string $author The author. diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPhone.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPhone.php index de45a35a..4702f708 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPhone.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPhone.php @@ -7,7 +7,7 @@ /** * GetConstituentPhone * - * @property string $phone_type The type. This codetable can be queried at + * @property string $phone_type The type. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/phonetypecode/entries * @property string $number The number. * @property bool $primary Indicates whether set as primary phone number. @@ -24,14 +24,14 @@ * Read-only in the SOAP API. * @property bool $update_matching_household_phone Indicates whether update * matching phone numbers in household. - * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentPhoneMatchinghouseholdmembers[] - * $matching_household_members matching\_household\_members + * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentPhoneMatchingHouseholdMembers[] + * $matching_household_members Matching household members. * @property \Blackbaud\SKY\Altru\Constituent\Components\HourMinute * $start_time HourMinute * @property \Blackbaud\SKY\Altru\Constituent\Components\HourMinute $end_time * HourMinute - * @property string $info_source The information source. This codetable can be - * queried at + * @property string $info_source The information source. This code table can + * be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/infosourcecode/entries * @property string $info_source_comments The comments. * @property string $country The country. This simple list can be queried at @@ -40,17 +40,17 @@ * $seasonal_start_date MonthDay * @property \Blackbaud\SKY\Altru\Constituent\Components\MonthDay * $seasonal_end_date MonthDay - * @property string $start_date The start date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $end_date The end date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $do_not_call_reason The reason. This codetable can be + * @property string $start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $end_date The end date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $do_not_call_reason The reason. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/donotcallreasoncode/entries * @property bool $confidential Indicates whether this phone number is * confidential. - * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentPhoneCountrycodes[] - * $country_codes country\_codes + * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentPhoneCountryCodes[] + * $country_codes Country codes. * @property string $constituent_data_review_rollback_reason The reason. This * simple list can be queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/484441bc-f0e6-4f5f-a6bf-49f02881dd13. @@ -81,7 +81,7 @@ class ConstituentPhone extends BaseComponent "household" => "bool", "household_member" => "bool", "update_matching_household_phone" => "bool", - "matching_household_members" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentPhoneMatchinghouseholdmembers[]", + "matching_household_members" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentPhoneMatchingHouseholdMembers[]", "start_time" => "\Blackbaud\SKY\Altru\Constituent\Components\HourMinute", "end_time" => "\Blackbaud\SKY\Altru\Constituent\Components\HourMinute", "info_source" => "string", @@ -93,7 +93,7 @@ class ConstituentPhone extends BaseComponent "end_date" => "string", "do_not_call_reason" => "string", "confidential" => "bool", - "country_codes" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentPhoneCountrycodes[]", + "country_codes" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentPhoneCountryCodes[]", "constituent_data_review_rollback_reason" => "string", "forced_primary" => "bool", "can_edit_primary" => "bool", diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPhoneCountrycodes.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPhoneCountrycodes.php index e2f8af60..c1a3e577 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPhoneCountrycodes.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPhoneCountrycodes.php @@ -5,14 +5,14 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ConstituentPhoneCountrycodes + * ConstituentPhoneCountryCodes * * @property string $country_id countryid * @property string $country_code country code * * @api */ -class ConstituentPhoneCountrycodes extends BaseComponent +class ConstituentPhoneCountryCodes extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPhoneListCollection.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPhoneListCollection.php index ced59a7e..b93bc7ed 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPhoneListCollection.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPhoneListCollection.php @@ -5,16 +5,22 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentPhoneListSummary[] * $value The set of items included in the response. This may be a subset of * the items in the collection. + * @property string $infinity_session Values for cookies related to the + * Infinity load balancer session. + * @property string $session_key Session key for paging provided by user in + * request query parameter. + * @property int $total_available_rows The number of total rows available. + * @property string $more_rows_range_key Key for accessing cached results on + * subsequent calls to this data list. + * @property bool $data_no_longer_available Indicates data is no longer + * available in the context of this session. * * @api */ @@ -26,5 +32,10 @@ class ConstituentPhoneListCollection extends BaseComponent protected static array $fields = [ "count" => "int", "value" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentPhoneListSummary[]", + "infinity_session" => "string", + "session_key" => "string", + "total_available_rows" => "int", + "more_rows_range_key" => "string", + "data_no_longer_available" => "bool", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPhoneListSummary.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPhoneListSummary.php index 9e48584b..11c8855b 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPhoneListSummary.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPhoneListSummary.php @@ -5,9 +5,9 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ListConstituentPhone + * ListConstituentPhones * - * @property string $id The id. + * @property string $id The ID. * @property string $phone_number The phone number. * @property string $type The type. * @property bool $primary Indicates whether primary. @@ -19,12 +19,12 @@ * @property string $info_source The information source. * @property string $info_source_comments The information source comments. * @property string $country The country. - * @property string $phone_type_code_id The phone type code id. + * @property string $phone_type_code_id The phone type code ID. * @property bool $donotcall Indicates whether donotcall. - * @property string $start_date The startdate.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $end_date The enddate.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $start_date The startdate. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $end_date The enddate. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * * @api */ diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPhoneMatchinghouseholdmembers.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPhoneMatchinghouseholdmembers.php index 9dd9c38d..bdc256c4 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPhoneMatchinghouseholdmembers.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPhoneMatchinghouseholdmembers.php @@ -5,7 +5,7 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ConstituentPhoneMatchinghouseholdmembers + * ConstituentPhoneMatchingHouseholdMembers * * @property string $constituent_id constituent id * @property string $name household member @@ -13,7 +13,7 @@ * * @api */ -class ConstituentPhoneMatchinghouseholdmembers extends BaseComponent +class ConstituentPhoneMatchingHouseholdMembers extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPrimaryContactInformationView.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPrimaryContactInformationView.php index be0ea685..9af68b53 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPrimaryContactInformationView.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentPrimaryContactInformationView.php @@ -25,7 +25,7 @@ * @property string $do_not_mail_reason_code_id The donotmailreasoncodeid. * @property bool $do_not_call Indicates whether donotcall. * @property bool $do_not_email Indicates whether donotemail. - * @property bool $is_confidential Indicates whether isconfidential. + * @property bool $confidential Indicates whether isconfidential. * @property string $do_not_call_reason_code_id The donotcallreasoncodeid. * @property bool $phone_is_confidential Indicates whether * phoneisconfidential. @@ -56,7 +56,7 @@ class ConstituentPrimaryContactInformationView extends BaseComponent "do_not_mail_reason_code_id" => "string", "do_not_call" => "bool", "do_not_email" => "bool", - "is_confidential" => "bool", + "confidential" => "bool", "do_not_call_reason_code_id" => "string", "phone_is_confidential" => "bool", ]; diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSearchCollection.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSearchCollection.php index 71e8acbe..061f54d1 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSearchCollection.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSearchCollection.php @@ -5,10 +5,7 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSearchSummary.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSearchSummary.php index 7f209cbe..456ab610 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSearchSummary.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSearchSummary.php @@ -5,12 +5,11 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * SearchConstituent + * SearchConstituents * - * @property string $id The id. - * @property string $lookup_id The lookup id. + * @property string $id The ID. + * @property string $lookup_id The lookup ID. * @property string $sort_constituent_name The name. - * @property string $constituenttype The constituent type. * @property string $address The address. * @property string $city The city. * @property string $state The state. @@ -18,7 +17,6 @@ * @property string $country_id The country. * @property bool $gives_anonymously Indicates whether gives anonymously. * @property int $classof The primary class year. - * @property string $primarybusiness The primary business. * @property bool $organization Indicates whether is organization. * @property string $name The name. * @property string $email_address The email address. @@ -27,7 +25,7 @@ * @property string $middle_name The middle name. * @property string $suffix_code_id The suffix. * @property string $phone The phone. - * @property string $prospectmanager The prospect manager. + * @property string $prospect_manager The prospect manager. * * @api */ @@ -40,7 +38,6 @@ class ConstituentSearchSummary extends BaseComponent "id" => "string", "lookup_id" => "string", "sort_constituent_name" => "string", - "constituenttype" => "string", "address" => "string", "city" => "string", "state" => "string", @@ -48,7 +45,6 @@ class ConstituentSearchSummary extends BaseComponent "country_id" => "string", "gives_anonymously" => "bool", "classof" => "int", - "primarybusiness" => "string", "organization" => "bool", "name" => "string", "email_address" => "string", @@ -57,6 +53,6 @@ class ConstituentSearchSummary extends BaseComponent "middle_name" => "string", "suffix_code_id" => "string", "phone" => "string", - "prospectmanager" => "string", + "prospect_manager" => "string", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSocialmediaaccounts.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSocialmediaaccounts.php index 6dee0a7e..09f192ff 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSocialmediaaccounts.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSocialmediaaccounts.php @@ -5,7 +5,7 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ConstituentSocialmediaaccounts + * ConstituentSocialMediaAccounts * * @property string $id id * @property string $social_media_service_id socialmediaserviceid @@ -23,7 +23,7 @@ * * @api */ -class ConstituentSocialmediaaccounts extends BaseComponent +class ConstituentSocialMediaAccounts extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSolicitCode.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSolicitCode.php index 0b0fbc42..82af5a65 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSolicitCode.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSolicitCode.php @@ -10,10 +10,10 @@ * @property string $solicit_code The solicit code. This simple list can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/ea7286bd-d27b-4028-b507-4bdb92580499?parameters=feature\_id,{c5b90f15-b76b-48e3-bf4f-b55c8717d36e}&parameters=feature\_type,{1}. - * @property string $start_date The start date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $end_date The end date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $end_date The end date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $comments The comments. * * @api diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSolicitCodeListCollection.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSolicitCodeListCollection.php index 36f8e29e..2ae0fde8 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSolicitCodeListCollection.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSolicitCodeListCollection.php @@ -5,16 +5,22 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentSolicitCodeListSummary[] * $value The set of items included in the response. This may be a subset of * the items in the collection. + * @property string $infinity_session Values for cookies related to the + * Infinity load balancer session. + * @property string $session_key Session key for paging provided by user in + * request query parameter. + * @property int $total_available_rows The number of total rows available. + * @property string $more_rows_range_key Key for accessing cached results on + * subsequent calls to this data list. + * @property bool $data_no_longer_available Indicates data is no longer + * available in the context of this session. * * @api */ @@ -26,5 +32,10 @@ class ConstituentSolicitCodeListCollection extends BaseComponent protected static array $fields = [ "count" => "int", "value" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentSolicitCodeListSummary[]", + "infinity_session" => "string", + "session_key" => "string", + "total_available_rows" => "int", + "more_rows_range_key" => "string", + "data_no_longer_available" => "bool", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSolicitCodeListSummary.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSolicitCodeListSummary.php index 9a88b477..0d6a71b7 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSolicitCodeListSummary.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSolicitCodeListSummary.php @@ -5,19 +5,19 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ListConstituentSolicitCode + * ListConstituentSolicitCodes * - * @property string $id The id. + * @property string $id The ID. * @property string $description The code. * @property string $site The site. - * @property string $start_date The start date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $end_date The end date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $end_date The end date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $comments The comments. * @property bool $expired Indicates whether expired. * @property bool $editable Indicates whether editable. - * @property string $solicit_code_id The solicit code id. + * @property string $solicit_code_id The solicit code ID. * * @api */ diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentStudentrelationconstituencies.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentStudentrelationconstituencies.php index 71ddbd71..79ce5cce 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentStudentrelationconstituencies.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentStudentrelationconstituencies.php @@ -5,14 +5,14 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ConstituentStudentrelationconstituencies + * ConstituentStudentRelationConstituencies * * @property string $description description * @property int $sequence sequence * * @api */ -class ConstituentStudentrelationconstituencies extends BaseComponent +class ConstituentStudentRelationConstituencies extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSummaryProfileView.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSummaryProfileView.php index dfada583..1f84f98b 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSummaryProfileView.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentSummaryProfileView.php @@ -56,7 +56,7 @@ * @property string $primary_education The primary education. * @property string $primary_business_id The primarybusinessid. * @property string $primary_business The primary business. - * @property string $lookup_id The lookup id. + * @property string $lookup_id The lookup ID. * @property bool $wealthpoint_update_pending Indicates whether * wealthpointupdatepending. * @property bool $education_attribute_defined Indicates whether @@ -85,7 +85,7 @@ * @property string $committee_member_constituency_text The * committeememberconstituencytext. * @property string $faculty_constituency_text The facultyconstituencytext. - * @property bool $isdeceased Indicates whether isdeceased. + * @property bool $deceased Indicates whether isdeceased. * @property string $current_enrollment_id The currentenrollmentid. * @property string $current_school The school. * @property string $current_enrollment_id_2 The currentenrollmentid2. @@ -102,35 +102,35 @@ * phoneisconfidential. * @property bool $address_is_confidential Indicates whether * addressisconfidential. - * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentConstituenciesdisplayorder[] - * $constituencies_display_order constituencies\_display\_order + * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentConstituenciesDisplayOrder[] + * $constituencies_display_order Constituencies display order. * @property int $sponsor_type_code The sponsortypecode. * @property string $lifecycle_stage The donor lifecycle. - * @property string $lifecycle_stage_as_of The as of.Uses the format - * YYYY-MM-DD. An example date: *2019-11-21*. + * @property string $lifecycle_stage_as_of The as of. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $planned_giver_stage The plannedgiverstage. - * @property string $planned_giver_stage_as_of The as of.Uses the format - * YYYY-MM-DD. An example date: *2019-11-21*. + * @property string $planned_giver_stage_as_of The as of. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property int $donor_state_code The donorstatecode. * @property string $donor_state The donor state. - * @property string $last_revenue_date The lastrevenuedate.Uses the format - * YYYY-MM-DD. An example date: *2019-11-21*. + * @property string $last_revenue_date The lastrevenuedate. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $address_id The addressid. * @property string $phone_number_id The phonenumberid. * @property string $email_address_id The emailaddressid. * @property string $top_parent_id The topparentid. * @property string $top_parent The top parent organization. - * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentUserdefinedconstituencies[] - * $user_defined_constituencies user\_defined\_constituencies - * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentStudentrelationconstituencies[] - * $student_relation_constituencies student\_relation\_constituencies + * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentUserDefinedConstituencies[] + * $user_defined_constituencies User defined constituencies. + * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentStudentRelationConstituencies[] + * $student_relation_constituencies Student relation constituencies. * @property bool $user_granted_constitpersonalinfo_edit Indicates whether * user\_granted\_constitpersonalinfo\_edit. * @property string $name The name. * @property string $fundraising_group_constituency_text The * fundraisinggroupconstituencytext. - * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentSocialmediaaccounts[] - * $social_media_accounts social\_media\_accounts + * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentSocialMediaAccounts[] + * $social_media_accounts Social media accounts. * * @api */ @@ -205,7 +205,7 @@ class ConstituentSummaryProfileView extends BaseComponent "constituent_inactivity_reason" => "string", "committee_member_constituency_text" => "string", "faculty_constituency_text" => "string", - "isdeceased" => "bool", + "deceased" => "bool", "current_enrollment_id" => "string", "current_school" => "string", "current_enrollment_id_2" => "string", @@ -217,7 +217,7 @@ class ConstituentSummaryProfileView extends BaseComponent "student_relation_constituency_text" => "string", "phone_is_confidential" => "bool", "address_is_confidential" => "bool", - "constituencies_display_order" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentConstituenciesdisplayorder[]", + "constituencies_display_order" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentConstituenciesDisplayOrder[]", "sponsor_type_code" => "int", "lifecycle_stage" => "string", "lifecycle_stage_as_of" => "string", @@ -231,11 +231,11 @@ class ConstituentSummaryProfileView extends BaseComponent "email_address_id" => "string", "top_parent_id" => "string", "top_parent" => "string", - "user_defined_constituencies" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentUserdefinedconstituencies[]", - "student_relation_constituencies" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentStudentrelationconstituencies[]", + "user_defined_constituencies" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentUserDefinedConstituencies[]", + "student_relation_constituencies" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentStudentRelationConstituencies[]", "user_granted_constitpersonalinfo_edit" => "bool", "name" => "string", "fundraising_group_constituency_text" => "string", - "social_media_accounts" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentSocialmediaaccounts[]", + "social_media_accounts" => "\Blackbaud\SKY\Altru\Constituent\Components\ConstituentSocialMediaAccounts[]", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentUserdefinedconstituencies.php b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentUserdefinedconstituencies.php index 839f1cee..9a16e44f 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentUserdefinedconstituencies.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/ConstituentUserdefinedconstituencies.php @@ -5,14 +5,14 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ConstituentUserdefinedconstituencies + * ConstituentUserDefinedConstituencies * * @property string $description description * @property int $sequence sequence * * @api */ -class ConstituentUserdefinedconstituencies extends BaseComponent +class ConstituentUserDefinedConstituencies extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAddress.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAddress.php similarity index 78% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAddress.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAddress.php index 7242a5b2..1804ea5f 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAddress.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAddress.php @@ -5,15 +5,15 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateConstituentAddress + * EditConstituentAddress * - * @property string $address_type The type. This codetable can be queried at + * @property string $address_type The type. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/addresstypecode/entries * @property string $address_block The address. * @property string $city The city. * @property string $state The state. This simple list can be queried at - * https://api.sky.blackbaud.com/alt-adnmg/simplelists/7fa91401-596c-4f7c-936d-6e41683121d7?parameters=country\_id,{country\_id}. + * https://api.sky.blackbaud.com/alt-adnmg/simplelists/7fa91401-596c-4f7c-936d-6e41683121d7?parameters=countryid,{countryid}. * @property string $postcode The zip. * @property string $country The country. This simple list can be queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/c9649672-353d-42e8-8c25-4d34bbabfbba. @@ -29,31 +29,32 @@ * address. * @property bool $omit_from_validation Indicates whether omit this address * from validation. - * @property string $county The county. This codetable can be queried at + * @property string $county The county. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/countycode/entries * @property string $congressional_district The congressional district. This - * codetable can be queried at + * code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/congressionaldistrictcode/entries - * @property string $state_house_district The state house district. This - * codetable can be queried at + * @property string $state_house_district The state house district. This code + * table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/statehousedistrictcode/entries * @property string $state_senate_district The state senate district. This - * codetable can be queried at + * code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/statesenatedistrictcode/entries - * @property string $local_precinct The local precinct. This codetable can be + * @property string $local_precinct The local precinct. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/localprecinctcode/entries - * @property string $info_source The information source. This codetable can be - * queried at + * @property string $info_source The information source. This code table can + * be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/infosourcecode/entries - * @property string $region The region. This codetable can be queried at + * @property string $region The region. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/regioncode/entries - * @property string $last_validation_attempt_date The last attempt.Uses the - * format YYYY-MM-DD. An example date: *2019-11-21*. + * @property string $last_validation_attempt_date The last attempt. Uses the + * format YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $validation_message The validation message. * @property int $certification_data The certification data. * @property string $ncoa_last_submit_date The last submit date. Read-only in - * the SOAP API.Uses the format YYYY-MM-DD. An example date: *2019-11-21*. + * the SOAP API. Uses the format YYYY-MM-DDThh:mm:ss. An example date: + * *1955-11-05T22:04:00*. * @property string $ncoa_return The return code. Read-only in the SOAP API. * @property string $ncoa_footnote The footnote. Read-only in the SOAP API. * @property string $ncoa_dpv_footnote The dpv footnote. Read-only in the SOAP @@ -64,15 +65,15 @@ * Read-only in the SOAP API. * @property string $ncoa_mail_grade The mail grade. Read-only in the SOAP * API. - * @property \Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentAddressZiplookupcountries[] - * $zip_lookup_countries zip\_lookup\_countries - * @property \Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentAddressValidationcountries[] - * $validation_countries validation\_countries + * @property \Blackbaud\SKY\Altru\Constituent\Components\EditConstituentAddressZipLookupCountries[] + * $zip_lookup_countries Zip lookup countries. + * @property \Blackbaud\SKY\Altru\Constituent\Components\EditConstituentAddressValidationCountries[] + * $validation_countries Validation countries. * @property bool $update_contacts Indicates whether update contacts that use * this address. * @property bool $has_contacts Indicates whether has contacts. Read-only in * the SOAP API. - * @property string $do_not_mail_reason The reason. This codetable can be + * @property string $do_not_mail_reason The reason. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/donotmailreasoncode/entries * @property bool $household Indicates whether household. Read-only in the @@ -81,14 +82,15 @@ * Read-only in the SOAP API. * @property bool $update_matching_household_addresses Indicates whether * update matching addresses in household. - * @property \Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentAddressMatchinghouseholdmembers[] - * $matching_household_members matching\_household\_members - * @property string $historical_start_date The start date.Uses the format - * YYYY-MM-DD. An example date: *2019-11-21*. - * @property string $historical_end_date The end date.Uses the format - * YYYY-MM-DD. An example date: *2019-11-21*. - * @property string $date_added The date added. Read-only in the SOAP API.Uses - * the format YYYY-MM-DD. An example date: *2019-11-21*. + * @property \Blackbaud\SKY\Altru\Constituent\Components\EditConstituentAddressMatchingHouseholdMembers[] + * $matching_household_members Matching household members. + * @property string $historical_start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $historical_end_date The end date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $date_added The date added. Read-only in the SOAP API. + * Uses the format YYYY-MM-DDThh:mm:ss. An example date: + * *1955-11-05T22:04:00*. * @property string $info_source_comments The comments. * @property bool $confidential Indicates whether this address is * confidential. @@ -106,7 +108,7 @@ * * @api */ -class UpdateConstituentAddress extends BaseComponent +class EditConstituentAddress extends BaseComponent { /** * @var string[] $fields @@ -143,15 +145,15 @@ class UpdateConstituentAddress extends BaseComponent "ncoa_move_date" => "\Blackbaud\SKY\Altru\Constituent\Components\FuzzyDate", "ncoa_dma_suppression" => "bool", "ncoa_mail_grade" => "string", - "zip_lookup_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentAddressZiplookupcountries[]", - "validation_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentAddressValidationcountries[]", + "zip_lookup_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\EditConstituentAddressZipLookupCountries[]", + "validation_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\EditConstituentAddressValidationCountries[]", "update_contacts" => "bool", "has_contacts" => "bool", "do_not_mail_reason" => "string", "household" => "bool", "household_member" => "bool", "update_matching_household_addresses" => "bool", - "matching_household_members" => "\Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentAddressMatchinghouseholdmembers[]", + "matching_household_members" => "\Blackbaud\SKY\Altru\Constituent\Components\EditConstituentAddressMatchingHouseholdMembers[]", "historical_start_date" => "string", "historical_end_date" => "string", "date_added" => "string", diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentPhoneMatchinghouseholdmembers.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAddressMatchingHouseholdMembers.php similarity index 81% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentPhoneMatchinghouseholdmembers.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAddressMatchingHouseholdMembers.php index be9b2b1e..5be65765 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentPhoneMatchinghouseholdmembers.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAddressMatchingHouseholdMembers.php @@ -5,7 +5,7 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateConstituentPhoneMatchinghouseholdmembers + * EditConstituentAddressMatchingHouseholdMembers * * @property string $constituent_id constituent id * @property string $name household member @@ -13,7 +13,7 @@ * * @api */ -class UpdateConstituentPhoneMatchinghouseholdmembers extends BaseComponent +class EditConstituentAddressMatchingHouseholdMembers extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAddressValidationcountries.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAddressValidationCountries.php similarity index 75% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAddressValidationcountries.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAddressValidationCountries.php index ca9437bb..b95d0979 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAddressValidationcountries.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAddressValidationCountries.php @@ -5,14 +5,14 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateConstituentAddressValidationcountries + * EditConstituentAddressValidationCountries * * @property string $country_id countryid * @property bool $browsable browsable * * @api */ -class UpdateConstituentAddressValidationcountries extends BaseComponent +class EditConstituentAddressValidationCountries extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAddressZiplookupcountries.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAddressZipLookupCountries.php similarity index 76% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAddressZiplookupcountries.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAddressZipLookupCountries.php index ab1f4f91..c7a61d47 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAddressZiplookupcountries.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAddressZipLookupCountries.php @@ -5,14 +5,14 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateConstituentAddressZiplookupcountries + * EditConstituentAddressZipLookupCountries * * @property string $country_id countryid * @property string $country_name name * * @api */ -class UpdateConstituentAddressZiplookupcountries extends BaseComponent +class EditConstituentAddressZipLookupCountries extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAlternateLookupId.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAlternateLookupId.php similarity index 73% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAlternateLookupId.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAlternateLookupId.php index 495b9116..13f129f3 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAlternateLookupId.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAlternateLookupId.php @@ -5,16 +5,16 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateConstituentAlternateLookupId + * EditConstituentAlternateLookupId * - * @property string $alternate_lookup_id_type The type. This codetable can be + * @property string $alternate_lookup_id_type The type. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/alternatelookupidtypecode/entries - * @property string $alternate_lookup_id The lookup id. + * @property string $alternate_lookup_id The lookup ID. * * @api */ -class UpdateConstituentAlternateLookupId extends BaseComponent +class EditConstituentAlternateLookupId extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAppeal.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAppeal.php similarity index 82% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAppeal.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAppeal.php index a7884bd5..55184f72 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAppeal.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAppeal.php @@ -5,14 +5,14 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateConstituentAppeal + * EditConstituentAppeal * * @property string $appeal_id The appeal. * @property string $mkt_segmentation The mailing. This simple list can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/664c0aa7-9f88-46f6-ba84-7b412e1131b5?parameters=appeal\_id,{appeal\_id}. - * @property string $date_sent The date sent.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $date_sent The date sent. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $mkt_package_id The package. * @property string $source_code The source code. * @property string $comments The comments. @@ -21,7 +21,7 @@ * * @api */ -class UpdateConstituentAppeal extends BaseComponent +class EditConstituentAppeal extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAppealResponse.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAppealResponse.php similarity index 51% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAppealResponse.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAppealResponse.php index b5647486..4f4b6fe3 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAppealResponse.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAppealResponse.php @@ -5,19 +5,19 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateConstituentAppealResponse + * EditConstituentAppealResponse * - * @property \Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentAppealResponseResponses[] - * $responses responses + * @property \Blackbaud\SKY\Altru\Constituent\Components\EditConstituentAppealResponseResponses[] + * $responses Responses. * * @api */ -class UpdateConstituentAppealResponse extends BaseComponent +class EditConstituentAppealResponse extends BaseComponent { /** * @var string[] $fields */ protected static array $fields = [ - "responses" => "\Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentAppealResponseResponses[]", + "responses" => "\Blackbaud\SKY\Altru\Constituent\Components\EditConstituentAppealResponseResponses[]", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAppealResponseResponses.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAppealResponseResponses.php similarity index 87% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAppealResponseResponses.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAppealResponseResponses.php index 6029a251..e1da82ce 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAppealResponseResponses.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAppealResponseResponses.php @@ -5,7 +5,7 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateConstituentAppealResponseResponses + * EditConstituentAppealResponseResponses * * @property string $date date * @property string $response_category The category. This simple list can be @@ -17,7 +17,7 @@ * * @api */ -class UpdateConstituentAppealResponseResponses extends BaseComponent +class EditConstituentAppealResponseResponses extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAttribute.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAttribute.php similarity index 82% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAttribute.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAttribute.php index 2aa53223..092ff1bc 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAttribute.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentAttribute.php @@ -5,7 +5,7 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateConstituentAttribute + * EditConstituentAttribute * * @property string $header_caption The headercaption. Read-only in the SOAP * API. @@ -17,11 +17,11 @@ * @property string $string_value The value. * @property int $number_value The value. * @property float $money_value The value. - * @property string $date_value The value.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $date_value The value. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $booleanvalue The value. Available values are *no*, *yes* - * @property string $code_table_value The value. This codetable can be queried - * at + * @property string $code_table_value The value. This code table can be + * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/addresstypecode/entries * @property \Blackbaud\SKY\Altru\Constituent\Components\FuzzyDate @@ -32,15 +32,15 @@ * @property string $memo_value The value. * @property string $comment The comment. * @property string $constituent_search_list_catalog_id The constituent search - * list catalog id. Read-only in the SOAP API. + * list catalog ID. Read-only in the SOAP API. * @property string $code_table_name The code table name. Read-only in the * SOAP API. - * @property string $start_date The start date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $end_date The end date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $end_date The end date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $currency The currency. This simple list can be queried at - * https://api.sky.blackbaud.com/alt-adnmg/simplelists/13612288-b37e-409d-ba52-6ab31637ddd6?parameters=transaction\_currency\_id,{transaction\_currency\_id}&parameters=base\_currency\_id,{base\_currency\_id}&parameters=current\_currency\_id,{currency\_id}. + * https://api.sky.blackbaud.com/alt-adnmg/simplelists/13612288-b37e-409d-ba52-6ab31637ddd6?parameters=transaction\_currency\_id,{transaction\_currency\_id}&parameters=base\_currency\_id,{base\_currency\_id}&parameters=current\_currency\_id,{currencyid}. * @property string $transaction_currency_id The transaction currency. * Read-only in the SOAP API. * @property string $base_currency_id The base currency. Read-only in the SOAP @@ -48,7 +48,7 @@ * * @api */ -class UpdateConstituentAttribute extends BaseComponent +class EditConstituentAttribute extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentCorrespondenceCode.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentCorrespondenceCode.php similarity index 80% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentCorrespondenceCode.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentCorrespondenceCode.php index 5db75f6a..9497038a 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentCorrespondenceCode.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentCorrespondenceCode.php @@ -5,20 +5,21 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateConstituentCorrespondenceCode + * EditConstituentCorrespondenceCode * * @property string $correspondence_code The the code associated with this * correspondence.. This simple list can be queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/63305295-220e-43a1-b744-359c7ffb77f5. - * @property string $date_sent The date when this correspondence was - * sent..Uses the format YYYY-MM-DD. An example date: *2019-11-21*. + * @property string $date_sent The date when this correspondence was sent.. + * Uses the format YYYY-MM-DDThh:mm:ss. An example date: + * *1955-11-05T22:04:00*. * @property string $comments The comments regarding this correspondence.. * @property bool $require_code Indicates whether require code. Read-only in * the SOAP API. * * @api */ -class UpdateConstituentCorrespondenceCode extends BaseComponent +class EditConstituentCorrespondenceCode extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentCorrespondenceCodeResponse.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentCorrespondenceCodeResponse.php new file mode 100644 index 00000000..056cf31d --- /dev/null +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentCorrespondenceCodeResponse.php @@ -0,0 +1,23 @@ + "\Blackbaud\SKY\Altru\Constituent\Components\EditConstituentCorrespondenceCodeResponseResponses[]", + ]; +} diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentCorrespondenceCodeResponseResponses.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentCorrespondenceCodeResponseResponses.php new file mode 100644 index 00000000..31556711 --- /dev/null +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentCorrespondenceCodeResponseResponses.php @@ -0,0 +1,31 @@ + "string", + "response_category" => "string", + "response" => "string", + "code" => "string", + ]; +} diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentEmailAddress.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentEmailAddress.php similarity index 79% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentEmailAddress.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentEmailAddress.php index 162dc7a7..332b4640 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentEmailAddress.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentEmailAddress.php @@ -5,9 +5,9 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateConstituentEmailAddress + * EditConstituentEmailAddress * - * @property string $email_address_type The type. This codetable can be + * @property string $email_address_type The type. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/emailaddresstypecode/entries * @property string $email_address The email address. @@ -25,10 +25,10 @@ * Read-only in the SOAP API. * @property bool $update_matching_household_email_address Indicates whether * update matching email addresses in household. - * @property \Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentEmailAddressMatchinghouseholdmembers[] - * $matching_household_members matching\_household\_members - * @property string $info_source The information source. This codetable can be - * queried at + * @property \Blackbaud\SKY\Altru\Constituent\Components\EditConstituentEmailAddressMatchingHouseholdMembers[] + * $matching_household_members Matching household members. + * @property string $info_source The information source. This code table can + * be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/infosourcecode/entries * @property string $info_source_comments The comments. * @property string $constituent_data_review_rollback_reason The reason. This @@ -42,18 +42,19 @@ * API. * @property string $origin The origin. Read-only in the SOAP API. Available * values are *user*, *web forms* - * @property string $start_date The start date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $end_date The end date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $end_date The end date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property bool $invalid_email Indicates whether invalid email. Read-only in * the SOAP API. * @property string $email_bounced_date The email bounced date. Read-only in - * the SOAP API.Uses the format YYYY-MM-DD. An example date: *2019-11-21*. + * the SOAP API. Uses the format YYYY-MM-DDThh:mm:ss. An example date: + * *1955-11-05T22:04:00*. * * @api */ -class UpdateConstituentEmailAddress extends BaseComponent +class EditConstituentEmailAddress extends BaseComponent { /** * @var string[] $fields @@ -69,7 +70,7 @@ class UpdateConstituentEmailAddress extends BaseComponent "household" => "bool", "household_member" => "bool", "update_matching_household_email_address" => "bool", - "matching_household_members" => "\Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentEmailAddressMatchinghouseholdmembers[]", + "matching_household_members" => "\Blackbaud\SKY\Altru\Constituent\Components\EditConstituentEmailAddressMatchingHouseholdMembers[]", "info_source" => "string", "info_source_comments" => "string", "constituent_data_review_rollback_reason" => "string", diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentEmailAddressMatchinghouseholdmembers.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentEmailAddressMatchingHouseholdMembers.php similarity index 78% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentEmailAddressMatchinghouseholdmembers.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentEmailAddressMatchingHouseholdMembers.php index b413e3f3..d3670c8b 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentEmailAddressMatchinghouseholdmembers.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentEmailAddressMatchingHouseholdMembers.php @@ -5,7 +5,7 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateConstituentEmailAddressMatchinghouseholdmembers + * EditConstituentEmailAddressMatchingHouseholdMembers * * @property string $constituent_id constituent id * @property string $name household member @@ -13,7 +13,7 @@ * * @api */ -class UpdateConstituentEmailAddressMatchinghouseholdmembers extends BaseComponent +class EditConstituentEmailAddressMatchingHouseholdMembers extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentFundraiser.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentFundraiser.php new file mode 100644 index 00000000..9866905c --- /dev/null +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentFundraiser.php @@ -0,0 +1,26 @@ + "string", + "date_to" => "string", + ]; +} diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentInteraction.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentInteraction.php similarity index 77% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentInteraction.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentInteraction.php index 1d222c77..ab856560 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentInteraction.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentInteraction.php @@ -5,25 +5,25 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateConstituentInteraction + * EditConstituentInteraction * - * @property string $interaction_type The contact method. This codetable can + * @property string $interaction_type The contact method. This code table can * be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/interactiontypecode/entries * @property string $objective The summary. * @property string $fundraiser_id The owner. - * @property string $expected_date The expected date.Uses the format - * YYYY-MM-DD. An example date: *2019-11-21*. - * @property string $actual_date The actual date.Uses the format YYYY-MM-DD. - * An example date: *2019-11-21*. + * @property string $expected_date The expected date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $actual_date The actual date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $status The status. Available values are *pending*, * *completed*, *canceled*, *declined* * @property string $comment The comment. * @property bool $step Indicates whether is step. Read-only in the SOAP API. * @property string $event_id The event. - * @property \Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentInteractionParticipants[] - * $participants participants - * @property string $constituent_id The constituent id. Read-only in the SOAP + * @property \Blackbaud\SKY\Altru\Constituent\Components\EditConstituentInteractionParticipants[] + * $participants Participants. + * @property string $constituent_id The constituent ID. Read-only in the SOAP * API. * @property string $constituent_name The constituent name. Read-only in the * SOAP API. @@ -32,9 +32,9 @@ * https://api.sky.blackbaud.com/alt-adnmg/simplelists/cbba7545-b66f-44ac-aa24-d9c2f8cbc4ec. * @property string $interaction_subcategory The subcategory. This simple list * can be queried at - * https://api.sky.blackbaud.com/alt-adnmg/simplelists/0eacc39b-07d1-4641-8774-e319559535a7?parameters=interaction\_category\_id,{interaction\_category\_id}. - * @property \Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentInteractionSites[] - * $sites sites + * https://api.sky.blackbaud.com/alt-adnmg/simplelists/0eacc39b-07d1-4641-8774-e319559535a7?parameters=interactioncategoryid,{interactioncategoryid}. + * @property \Blackbaud\SKY\Altru\Constituent\Components\EditConstituentInteractionSites[] + * $sites Sites. * @property \Blackbaud\SKY\Altru\Constituent\Components\HourMinute * $expected_start_time HourMinute * @property \Blackbaud\SKY\Altru\Constituent\Components\HourMinute @@ -50,7 +50,7 @@ * * @api */ -class UpdateConstituentInteraction extends BaseComponent +class EditConstituentInteraction extends BaseComponent { /** * @var string[] $fields @@ -65,12 +65,12 @@ class UpdateConstituentInteraction extends BaseComponent "comment" => "string", "step" => "bool", "event_id" => "string", - "participants" => "\Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentInteractionParticipants[]", + "participants" => "\Blackbaud\SKY\Altru\Constituent\Components\EditConstituentInteractionParticipants[]", "constituent_id" => "string", "constituent_name" => "string", "interaction_category" => "string", "interaction_subcategory" => "string", - "sites" => "\Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentInteractionSites[]", + "sites" => "\Blackbaud\SKY\Altru\Constituent\Components\EditConstituentInteractionSites[]", "expected_start_time" => "\Blackbaud\SKY\Altru\Constituent\Components\HourMinute", "expected_end_time" => "\Blackbaud\SKY\Altru\Constituent\Components\HourMinute", "all_day_event" => "bool", diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentInteractionParticipants.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentInteractionParticipants.php similarity index 76% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentInteractionParticipants.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentInteractionParticipants.php index f97d8bcf..e6960a62 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentInteractionParticipants.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentInteractionParticipants.php @@ -5,14 +5,14 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateConstituentInteractionParticipants + * EditConstituentInteractionParticipants * * @property string $id id * @property string $constituent_id participant * * @api */ -class UpdateConstituentInteractionParticipants extends BaseComponent +class EditConstituentInteractionParticipants extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentInteractionSites.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentInteractionSites.php similarity index 77% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentInteractionSites.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentInteractionSites.php index 0b55319f..f26b6651 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentInteractionSites.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentInteractionSites.php @@ -5,14 +5,14 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateConstituentInteractionSites + * EditConstituentInteractionSites * * @property string $id id * @property string $siteid site * * @api */ -class UpdateConstituentInteractionSites extends BaseComponent +class EditConstituentInteractionSites extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentNote.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentNote.php similarity index 84% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentNote.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentNote.php index 1093b83e..8d2d0247 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentNote.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentNote.php @@ -5,22 +5,22 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateConstituentNote + * EditConstituentNote * * @property int $context_type The context type. Read-only in the SOAP API. * @property string $title The the title of this note. - * @property string $date_entered The the date this note was entered.Uses the - * format YYYY-MM-DD. An example date: *2019-11-21*. + * @property string $date_entered The the date this note was entered. Uses the + * format YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $author_id The the author of this note. * @property string $note_type The the user-defined type of this note. This - * codetable can be queried at + * code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/constituentnotetypecode/entries * @property string $text_note The the plain text that comprises this note. * @property string $html_note The the html that comprises this note. * * @api */ -class UpdateConstituentNote extends BaseComponent +class EditConstituentNote extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentPhone.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentPhone.php similarity index 81% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentPhone.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentPhone.php index 19b647ed..34ed3786 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentPhone.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentPhone.php @@ -5,9 +5,9 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateConstituentPhone + * EditConstituentPhone * - * @property string $phone_type The type. This codetable can be queried at + * @property string $phone_type The type. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/phonetypecode/entries * @property string $number The number. * @property bool $primary Indicates whether set as primary phone number. @@ -24,14 +24,14 @@ * Read-only in the SOAP API. * @property bool $update_matching_household_phone Indicates whether update * matching phone numbers in household. - * @property \Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentPhoneMatchinghouseholdmembers[] - * $matching_household_members matching\_household\_members + * @property \Blackbaud\SKY\Altru\Constituent\Components\EditConstituentPhoneMatchingHouseholdMembers[] + * $matching_household_members Matching household members. * @property \Blackbaud\SKY\Altru\Constituent\Components\HourMinute * $start_time HourMinute * @property \Blackbaud\SKY\Altru\Constituent\Components\HourMinute $end_time * HourMinute - * @property string $info_source The information source. This codetable can be - * queried at + * @property string $info_source The information source. This code table can + * be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/infosourcecode/entries * @property string $info_source_comments The comments. * @property string $country The country. This simple list can be queried at @@ -40,17 +40,17 @@ * $seasonal_start_date MonthDay * @property \Blackbaud\SKY\Altru\Constituent\Components\MonthDay * $seasonal_end_date MonthDay - * @property string $start_date The start date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $end_date The end date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $do_not_call_reason The reason. This codetable can be + * @property string $start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $end_date The end date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $do_not_call_reason The reason. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/donotcallreasoncode/entries * @property bool $confidential Indicates whether this phone number is * confidential. - * @property \Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentPhoneCountrycodes[] - * $country_codes country\_codes + * @property \Blackbaud\SKY\Altru\Constituent\Components\EditConstituentPhoneCountryCodes[] + * $country_codes Country codes. * @property string $constituent_data_review_rollback_reason The reason. This * simple list can be queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/484441bc-f0e6-4f5f-a6bf-49f02881dd13. @@ -65,7 +65,7 @@ * * @api */ -class UpdateConstituentPhone extends BaseComponent +class EditConstituentPhone extends BaseComponent { /** * @var string[] $fields @@ -81,7 +81,7 @@ class UpdateConstituentPhone extends BaseComponent "household" => "bool", "household_member" => "bool", "update_matching_household_phone" => "bool", - "matching_household_members" => "\Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentPhoneMatchinghouseholdmembers[]", + "matching_household_members" => "\Blackbaud\SKY\Altru\Constituent\Components\EditConstituentPhoneMatchingHouseholdMembers[]", "start_time" => "\Blackbaud\SKY\Altru\Constituent\Components\HourMinute", "end_time" => "\Blackbaud\SKY\Altru\Constituent\Components\HourMinute", "info_source" => "string", @@ -93,7 +93,7 @@ class UpdateConstituentPhone extends BaseComponent "end_date" => "string", "do_not_call_reason" => "string", "confidential" => "bool", - "country_codes" => "\Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentPhoneCountrycodes[]", + "country_codes" => "\Blackbaud\SKY\Altru\Constituent\Components\EditConstituentPhoneCountryCodes[]", "constituent_data_review_rollback_reason" => "string", "forced_primary" => "bool", "can_edit_primary" => "bool", diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentPhoneCountrycodes.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentPhoneCountryCodes.php similarity index 79% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentPhoneCountrycodes.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentPhoneCountryCodes.php index 37d94fe2..80eb3ed2 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentPhoneCountrycodes.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentPhoneCountryCodes.php @@ -5,14 +5,14 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateConstituentPhoneCountrycodes + * EditConstituentPhoneCountryCodes * * @property string $country_id countryid * @property string $country_code country code * * @api */ -class UpdateConstituentPhoneCountrycodes extends BaseComponent +class EditConstituentPhoneCountryCodes extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAddressMatchinghouseholdmembers.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentPhoneMatchingHouseholdMembers.php similarity index 79% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAddressMatchinghouseholdmembers.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentPhoneMatchingHouseholdMembers.php index 951fc384..b96b761e 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentAddressMatchinghouseholdmembers.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentPhoneMatchingHouseholdMembers.php @@ -5,7 +5,7 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateConstituentAddressMatchinghouseholdmembers + * EditConstituentPhoneMatchingHouseholdMembers * * @property string $constituent_id constituent id * @property string $name household member @@ -13,7 +13,7 @@ * * @api */ -class UpdateConstituentAddressMatchinghouseholdmembers extends BaseComponent +class EditConstituentPhoneMatchingHouseholdMembers extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentSolicitCode.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentSolicitCode.php similarity index 66% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentSolicitCode.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentSolicitCode.php index 69f939f9..d5ad0f97 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentSolicitCode.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditConstituentSolicitCode.php @@ -5,20 +5,20 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateConstituentSolicitCode + * EditConstituentSolicitCode * * @property string $solicit_code The solicit code. This simple list can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/ea7286bd-d27b-4028-b507-4bdb92580499?parameters=feature\_id,{c5b90f15-b76b-48e3-bf4f-b55c8717d36e}&parameters=feature\_type,{1}. - * @property string $start_date The start date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $end_date The end date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $end_date The end date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $comments The comments. * * @api */ -class UpdateConstituentSolicitCode extends BaseComponent +class EditConstituentSolicitCode extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateEducation.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditEducation.php similarity index 83% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateEducation.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditEducation.php index d257ae0f..e910c2a9 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateEducation.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditEducation.php @@ -5,7 +5,7 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateEducation + * EditEducation * * @property bool $primary_record Indicates whether primary education * information. @@ -13,7 +13,7 @@ * @property string $academic_catalog_program The program. This simple list * can be queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/d411c16b-8bcf-4fc8-a747-754e1e89e9bc?parameters=educational\_institution\_id,{educational\_institution\_id}. - * @property string $educational_program The program. This codetable can be + * @property string $educational_program The program. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationalprogramcode/entries * @property string $constituency_status The status. Available values are @@ -25,33 +25,32 @@ * @property string $academic_catalog_degree The degree. This simple list can * be queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/73c67942-07ad-412e-8596-a042e5e68002?parameters=academiccatalogprogramid,{academiccatalogprogramid}. - * @property string $educational_degree The degree. This codetable can be + * @property string $educational_degree The degree. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationaldegreecode/entries - * @property string $educational_award The honor awarded. This codetable can + * @property string $educational_award The honor awarded. This code table can * be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationalawardcode/entries * @property \Blackbaud\SKY\Altru\Constituent\Components\FuzzyDate $start_date * FuzzyDate * @property int $class_year The class of. * @property int $preferred_class_year The preferred class of. - * @property string $educational_source The information source. This codetable - * can be queried at + * @property string $educational_source The information source. This code + * table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationalsourcecode/entries * @property \Blackbaud\SKY\Altru\Constituent\Components\FuzzyDate * $educational_source_date FuzzyDate * @property string $comment The comments. - * @property \Blackbaud\SKY\Altru\Constituent\Components\UpdateEducationAffiliatedadditionalinformation[] - * $affiliated_additional_information affiliated\_additional\_information - * @property \Blackbaud\SKY\Altru\Constituent\Components\UpdateEducationUnaffiliatedadditionalinformation[] - * $unaffiliated_additional_information unaffiliated\_additional\_information - + * @property \Blackbaud\SKY\Altru\Constituent\Components\EditEducationAffiliatedAdditionalInformation[] + * $affiliated_additional_information Affiliated additional information. + * @property \Blackbaud\SKY\Altru\Constituent\Components\EditEducationUnaffiliatedAdditionalInformation[] + * $unaffiliated_additional_information Unaffiliated additional information. * @property bool $affiliated Indicates whether affiliated. - * @property string $educational_history_level The level. This codetable can + * @property string $educational_history_level The level. This code table can * be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationalhistorylevelcode/entries - * @property string $educational_history_reason The reason. This codetable can - * be queried at + * @property string $educational_history_reason The reason. This code table + * can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationalhistoryreasoncode/entries * @property bool $use_academic_catalog Indicates whether use academic * catalog. Read-only in the SOAP API. @@ -61,7 +60,7 @@ * * @api */ -class UpdateEducation extends BaseComponent +class EditEducation extends BaseComponent { /** * @var string[] $fields @@ -83,8 +82,8 @@ class UpdateEducation extends BaseComponent "educational_source" => "string", "educational_source_date" => "\Blackbaud\SKY\Altru\Constituent\Components\FuzzyDate", "comment" => "string", - "affiliated_additional_information" => "\Blackbaud\SKY\Altru\Constituent\Components\UpdateEducationAffiliatedadditionalinformation[]", - "unaffiliated_additional_information" => "\Blackbaud\SKY\Altru\Constituent\Components\UpdateEducationUnaffiliatedadditionalinformation[]", + "affiliated_additional_information" => "\Blackbaud\SKY\Altru\Constituent\Components\EditEducationAffiliatedAdditionalInformation[]", + "unaffiliated_additional_information" => "\Blackbaud\SKY\Altru\Constituent\Components\EditEducationUnaffiliatedAdditionalInformation[]", "affiliated" => "bool", "educational_history_level" => "string", "educational_history_reason" => "string", diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateEducationAffiliatedadditionalinformation.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditEducationAffiliatedAdditionalInformation.php similarity index 94% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateEducationAffiliatedadditionalinformation.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditEducationAffiliatedAdditionalInformation.php index 7a3adf1b..743625cf 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateEducationAffiliatedadditionalinformation.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditEducationAffiliatedAdditionalInformation.php @@ -5,7 +5,7 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateEducationAffiliatedadditionalinformation + * EditEducationAffiliatedAdditionalInformation * * @property string $id id * @property string $academiccatalogcollege The college/school. This simple @@ -26,7 +26,7 @@ * * @api */ -class UpdateEducationAffiliatedadditionalinformation extends BaseComponent +class EditEducationAffiliatedAdditionalInformation extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateEducationUnaffiliatedadditionalinformation.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditEducationUnaffiliatedAdditionalInformation.php similarity index 84% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateEducationUnaffiliatedadditionalinformation.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditEducationUnaffiliatedAdditionalInformation.php index 79b89304..a0589fb6 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateEducationUnaffiliatedadditionalinformation.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditEducationUnaffiliatedAdditionalInformation.php @@ -5,28 +5,28 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateEducationUnaffiliatedadditionalinformation + * EditEducationUnaffiliatedAdditionalInformation * * @property string $id id - * @property string $educational_college The college/school. This codetable + * @property string $educational_college The college/school. This code table * can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationalcollegecode/entries - * @property string $educational_division The division. This codetable can be + * @property string $educational_division The division. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationaldivisioncode/entries - * @property string $educational_department The department. This codetable can - * be queried at + * @property string $educational_department The department. This code table + * can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationaldepartmentcode/entries - * @property string $educational_sub_department The sub department. This - * codetable can be queried at + * @property string $educational_sub_department The sub department. This code + * table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationalsubdepartmentcode/entries - * @property string $educational_degree_type The degree type. This codetable + * @property string $educational_degree_type The degree type. This code table * can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationaldegreetypecode/entries * * @api */ -class UpdateEducationUnaffiliatedadditionalinformation extends BaseComponent +class EditEducationUnaffiliatedAdditionalInformation extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateIndividual.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditIndividual.php similarity index 86% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateIndividual.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditIndividual.php index 311395a8..14a93698 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateIndividual.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditIndividual.php @@ -5,16 +5,16 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateIndividual + * EditIndividual * * @property string $last_name The last name. * @property string $first_name The first name. * @property string $middle_name The middle name. * @property string $maiden_name The maiden name. * @property string $nickname The nickname. - * @property string $title The title. This codetable can be queried at + * @property string $title The title. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/titlecode/entries - * @property string $suffix The suffix. This codetable can be queried at + * @property string $suffix The suffix. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/suffixcode/entries * @property string $gender The gender. Available values are *unknown*, * *male*, *female*, *other* @@ -26,12 +26,12 @@ * @property string $picture_thumbnail The image. * @property bool $picture_changed Indicates whether picture changed. * @property string $web_address The website. - * @property string $marital_status The marital status. This codetable can be + * @property string $marital_status The marital status. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/maritalstatuscode/entries - * @property string $title_2 The title 2. This codetable can be queried at + * @property string $title_2 The title 2. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/titlecode/entries - * @property string $suffix_2 The suffix 2. This codetable can be queried at + * @property string $suffix_2 The suffix 2. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/suffixcode/entries * @property bool $deceased Indicates whether is deceased. Read-only in the * SOAP API. @@ -41,7 +41,7 @@ * * @api */ -class UpdateIndividual extends BaseComponent +class EditIndividual extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateOrganization.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditOrganization.php similarity index 86% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateOrganization.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditOrganization.php index 9f46993f..0139c574 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateOrganization.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditOrganization.php @@ -5,10 +5,10 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateOrganization + * EditOrganization * * @property string $organization_name The name. - * @property string $industry The industry. This codetable can be queried at + * @property string $industry The industry. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/industrycode/entries * @property int $num_employees The no. of employees. * @property int $num_subsidiaries The no. of subsidiary orgs. @@ -19,8 +19,8 @@ * @property string $web_address The website. * @property bool $is_primary Indicates whether this is a primary * organization. - * @property string $primary_address_id The primary address id. - * @property string $address_type The address type. This codetable can be + * @property string $primary_address_id The primary address ID. + * @property string $address_type The address type. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/addresstypecode/entries @@ -31,27 +31,27 @@ * @property string $address_city The city. * @property string $address_state The state. This simple list can be queried * at - * https://api.sky.blackbaud.com/alt-adnmg/simplelists/7fa91401-596c-4f7c-936d-6e41683121d7?parameters=country\_id,{address\_country\_id}. + * https://api.sky.blackbaud.com/alt-adnmg/simplelists/7fa91401-596c-4f7c-936d-6e41683121d7?parameters=country\_id,{address\_countryid}. * @property string $address_postcode The zip. * @property bool $address_do_not_mail Indicates whether do not send mail to * this address. - * @property string $address_do_not_mail_reason The reason. This codetable can - * be queried at + * @property string $address_do_not_mail_reason The reason. This code table + * can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/donotmailreasoncode/entries - * @property string $primary_phone_id The primary phone id. - * @property string $phone_type The phone type. This codetable can be queried + * @property string $primary_phone_id The primary phone ID. + * @property string $phone_type The phone type. This code table can be queried * at https://api.sky.blackbaud.com/alt-adnmg/codetables/phonetypecode/entries * @property string $phone_number The phone number. - * @property string $primary_email_address_id The primary email address id. - * @property string $email_address_type The email type. This codetable can be + * @property string $primary_email_address_id The primary email address ID. + * @property string $email_address_type The email type. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/emailaddresstypecode/entries * @property string $email_address The email address. * * @api */ -class UpdateOrganization extends BaseComponent +class EditOrganization extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateRelationshipJobInfo.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditRelationshipJobInfo.php similarity index 66% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateRelationshipJobInfo.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditRelationshipJobInfo.php index 43600ddf..d731f63d 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateRelationshipJobInfo.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditRelationshipJobInfo.php @@ -5,24 +5,24 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateRelationshipJobInfo + * EditRelationshipJobInfo * * @property string $job_title The job title. - * @property string $career_level The career level. This codetable can be + * @property string $career_level The career level. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/careerlevelcode/entries - * @property string $job_category The category. This codetable can be queried + * @property string $job_category The category. This code table can be queried * at * https://api.sky.blackbaud.com/alt-adnmg/codetables/jobcategorycode/entries - * @property string $start_date The start date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $end_date The end date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $end_date The end date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $job_department The department. * @property string $job_division The division. - * @property string $job_schedule The schedule. This codetable can be queried + * @property string $job_schedule The schedule. This code table can be queried * at * https://api.sky.blackbaud.com/alt-adnmg/codetables/jobschedulecode/entries @@ -31,7 +31,7 @@ * * @api */ -class UpdateRelationshipJobInfo extends BaseComponent +class EditRelationshipJobInfo extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateTribute.php b/packages/altru-constituent/src/Altru/Constituent/Components/EditTribute.php similarity index 94% rename from packages/altru-constituent/src/Altru/Constituent/Components/UpdateTribute.php rename to packages/altru-constituent/src/Altru/Constituent/Components/EditTribute.php index ba3a997a..f8fbec6d 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateTribute.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EditTribute.php @@ -5,7 +5,7 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * UpdateTribute + * EditTribute * * @property string $tribute_id The tribute. Read-only in the SOAP API. * @property float $amount The amount. @@ -20,7 +20,7 @@ * * @api */ -class UpdateTribute extends BaseComponent +class EditTribute extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/Education.php b/packages/altru-constituent/src/Altru/Constituent/Components/Education.php index d63b0129..ec19c0ee 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/Education.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/Education.php @@ -13,7 +13,7 @@ * @property string $academic_catalog_program The program. This simple list * can be queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/d411c16b-8bcf-4fc8-a747-754e1e89e9bc?parameters=educational\_institution\_id,{educational\_institution\_id}. - * @property string $educational_program The program. This codetable can be + * @property string $educational_program The program. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationalprogramcode/entries * @property string $constituency_status The status. Available values are @@ -25,33 +25,32 @@ * @property string $academic_catalog_degree The degree. This simple list can * be queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/73c67942-07ad-412e-8596-a042e5e68002?parameters=academiccatalogprogramid,{academiccatalogprogramid}. - * @property string $educational_degree The degree. This codetable can be + * @property string $educational_degree The degree. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationaldegreecode/entries - * @property string $educational_award The honor awarded. This codetable can + * @property string $educational_award The honor awarded. This code table can * be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationalawardcode/entries * @property \Blackbaud\SKY\Altru\Constituent\Components\FuzzyDate $start_date * FuzzyDate * @property int $class_year The class of. * @property int $preferred_class_year The preferred class of. - * @property string $educational_source The information source. This codetable - * can be queried at + * @property string $educational_source The information source. This code + * table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationalsourcecode/entries * @property \Blackbaud\SKY\Altru\Constituent\Components\FuzzyDate * $educational_source_date FuzzyDate * @property string $comment The comments. - * @property \Blackbaud\SKY\Altru\Constituent\Components\EducationAffiliatedadditionalinformation[] - * $affiliated_additional_information affiliated\_additional\_information - * @property \Blackbaud\SKY\Altru\Constituent\Components\EducationUnaffiliatedadditionalinformation[] - * $unaffiliated_additional_information unaffiliated\_additional\_information - + * @property \Blackbaud\SKY\Altru\Constituent\Components\EducationAffiliatedAdditionalInformation[] + * $affiliated_additional_information Affiliated additional information. + * @property \Blackbaud\SKY\Altru\Constituent\Components\EducationUnaffiliatedAdditionalInformation[] + * $unaffiliated_additional_information Unaffiliated additional information. * @property bool $affiliated Indicates whether affiliated. - * @property string $educational_history_level The level. This codetable can + * @property string $educational_history_level The level. This code table can * be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationalhistorylevelcode/entries - * @property string $educational_history_reason The reason. This codetable can - * be queried at + * @property string $educational_history_reason The reason. This code table + * can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationalhistoryreasoncode/entries * @property bool $use_academic_catalog Indicates whether use academic * catalog. Read-only in the SOAP API. @@ -83,8 +82,8 @@ class Education extends BaseComponent "educational_source" => "string", "educational_source_date" => "\Blackbaud\SKY\Altru\Constituent\Components\FuzzyDate", "comment" => "string", - "affiliated_additional_information" => "\Blackbaud\SKY\Altru\Constituent\Components\EducationAffiliatedadditionalinformation[]", - "unaffiliated_additional_information" => "\Blackbaud\SKY\Altru\Constituent\Components\EducationUnaffiliatedadditionalinformation[]", + "affiliated_additional_information" => "\Blackbaud\SKY\Altru\Constituent\Components\EducationAffiliatedAdditionalInformation[]", + "unaffiliated_additional_information" => "\Blackbaud\SKY\Altru\Constituent\Components\EducationUnaffiliatedAdditionalInformation[]", "affiliated" => "bool", "educational_history_level" => "string", "educational_history_reason" => "string", diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/EducationAffiliatedadditionalinformation.php b/packages/altru-constituent/src/Altru/Constituent/Components/EducationAffiliatedadditionalinformation.php index f983f424..b2d87058 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/EducationAffiliatedadditionalinformation.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EducationAffiliatedadditionalinformation.php @@ -5,7 +5,7 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * EducationAffiliatedadditionalinformation + * EducationAffiliatedAdditionalInformation * * @property string $id id * @property string $academiccatalogcollege The college/school. This simple @@ -26,7 +26,7 @@ * * @api */ -class EducationAffiliatedadditionalinformation extends BaseComponent +class EducationAffiliatedAdditionalInformation extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/EducationListCollection.php b/packages/altru-constituent/src/Altru/Constituent/Components/EducationListCollection.php index 2d06eee5..79064a1c 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/EducationListCollection.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EducationListCollection.php @@ -5,16 +5,22 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. * @property \Blackbaud\SKY\Altru\Constituent\Components\EducationListSummary[] * $value The set of items included in the response. This may be a subset of * the items in the collection. + * @property string $infinity_session Values for cookies related to the + * Infinity load balancer session. + * @property string $session_key Session key for paging provided by user in + * request query parameter. + * @property int $total_available_rows The number of total rows available. + * @property string $more_rows_range_key Key for accessing cached results on + * subsequent calls to this data list. + * @property bool $data_no_longer_available Indicates data is no longer + * available in the context of this session. * * @api */ @@ -26,5 +32,10 @@ class EducationListCollection extends BaseComponent protected static array $fields = [ "count" => "int", "value" => "\Blackbaud\SKY\Altru\Constituent\Components\EducationListSummary[]", + "infinity_session" => "string", + "session_key" => "string", + "total_available_rows" => "int", + "more_rows_range_key" => "string", + "data_no_longer_available" => "bool", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/EducationListSummary.php b/packages/altru-constituent/src/Altru/Constituent/Components/EducationListSummary.php index 3a9bc2fc..91e74699 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/EducationListSummary.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EducationListSummary.php @@ -5,9 +5,9 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ListEducation + * ListEducations * - * @property string $id The id. + * @property string $id The ID. * @property string $program The program. * @property string $name The educational institution. * @property string $degree The degree. diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/EducationSearchCollection.php b/packages/altru-constituent/src/Altru/Constituent/Components/EducationSearchCollection.php new file mode 100644 index 00000000..7b755688 --- /dev/null +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EducationSearchCollection.php @@ -0,0 +1,27 @@ + "int", + "value" => "\Blackbaud\SKY\Altru\Constituent\Components\EducationSearchSummary[]", + ]; +} diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/EducationSearchSummary.php b/packages/altru-constituent/src/Altru/Constituent/Components/EducationSearchSummary.php new file mode 100644 index 00000000..d721aba4 --- /dev/null +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EducationSearchSummary.php @@ -0,0 +1,49 @@ + "string", + "full_name_educational_institution" => "string", + "constituent_name" => "string", + "constituent_lookup_id" => "string", + "constituent_address" => "string", + "constituent_city" => "string", + "constituent_state" => "string", + "constituent_post_code" => "string", + "educational_institution" => "string", + "program" => "string", + "degree" => "string", + "status" => "string", + "class_year" => "string", + "educational_history_status" => "string", + ]; +} diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/EducationUnaffiliatedadditionalinformation.php b/packages/altru-constituent/src/Altru/Constituent/Components/EducationUnaffiliatedadditionalinformation.php index 40e663c9..4769e7ef 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/EducationUnaffiliatedadditionalinformation.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/EducationUnaffiliatedadditionalinformation.php @@ -5,28 +5,28 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * EducationUnaffiliatedadditionalinformation + * EducationUnaffiliatedAdditionalInformation * * @property string $id id - * @property string $educational_college The college/school. This codetable + * @property string $educational_college The college/school. This code table * can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationalcollegecode/entries - * @property string $educational_division The division. This codetable can be + * @property string $educational_division The division. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationaldivisioncode/entries - * @property string $educational_department The department. This codetable can - * be queried at + * @property string $educational_department The department. This code table + * can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationaldepartmentcode/entries - * @property string $educational_sub_department The sub department. This - * codetable can be queried at + * @property string $educational_sub_department The sub department. This code + * table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationalsubdepartmentcode/entries - * @property string $educational_degree_type The degree type. This codetable + * @property string $educational_degree_type The degree type. This code table * can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationaldegreetypecode/entries * * @api */ -class EducationUnaffiliatedadditionalinformation extends BaseComponent +class EducationUnaffiliatedAdditionalInformation extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/Individual.php b/packages/altru-constituent/src/Altru/Constituent/Components/Individual.php index 8e4ee67a..32ba8d36 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/Individual.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/Individual.php @@ -12,9 +12,9 @@ * @property string $middle_name The middle name. * @property string $maiden_name The maiden name. * @property string $nickname The nickname. - * @property string $title The title. This codetable can be queried at + * @property string $title The title. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/titlecode/entries - * @property string $suffix The suffix. This codetable can be queried at + * @property string $suffix The suffix. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/suffixcode/entries * @property string $gender The gender. Available values are *unknown*, * *male*, *female*, *other* @@ -26,12 +26,12 @@ * @property string $picture_thumbnail The image. * @property bool $picture_changed Indicates whether picture changed. * @property string $web_address The website. - * @property string $marital_status The marital status. This codetable can be + * @property string $marital_status The marital status. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/maritalstatuscode/entries - * @property string $title_2 The title 2. This codetable can be queried at + * @property string $title_2 The title 2. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/titlecode/entries - * @property string $suffix_2 The suffix 2. This codetable can be queried at + * @property string $suffix_2 The suffix 2. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/suffixcode/entries * @property bool $deceased Indicates whether is deceased. Read-only in the * SOAP API. diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/IndividualRecentRevenueView.php b/packages/altru-constituent/src/Altru/Constituent/Components/IndividualRecentRevenueView.php index 86af84e2..26681a28 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/IndividualRecentRevenueView.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/IndividualRecentRevenueView.php @@ -8,7 +8,7 @@ * ViewIndividualRecentRevenue * * @property \Blackbaud\SKY\Altru\Constituent\Components\ConstituentRevenueConstituentrevenuerecent[] - * $constituentrevenuerecent constituentrevenuerecent + * $constituentrevenuerecent Constituentrevenuerecent. * * @api */ diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/IndividualRevenueSummaryView.php b/packages/altru-constituent/src/Altru/Constituent/Components/IndividualRevenueSummaryView.php index 45b36504..86e1089c 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/IndividualRevenueSummaryView.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/IndividualRevenueSummaryView.php @@ -7,7 +7,7 @@ /** * ViewIndividualRevenueSummary * - * @property string $household_id The household id. + * @property string $household_id The household ID. * @property float $total_giving The total revenue. * @property float $total_house_hold_and_member_giving The total household * revenue. @@ -15,11 +15,11 @@ * @property float $event_revenue The event revenue. * @property bool $is_registrant Indicates whether is registrant. * @property bool $is_volunteer Indicates whether is volunteer. - * @property string $revenue_id The revenue id. + * @property string $revenue_id The revenue ID. * @property float $ticket_revenue The ticket revenue. * @property float $facility_revenue The facility revenue. * @property float $merchandise_revenue The merchandise revenue. - * @property string $currency_id The currency id. + * @property string $currency_id The currency ID. * * @api */ diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituent.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituent.php index 66ac55b8..53c757bd 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituent.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituent.php @@ -14,9 +14,9 @@ * @property string $middle_name The the constituent's middle name. character * limit: 50.. * @property string $title The the constituent's primary title. for - * individuals only.. This codetable can be queried at + * individuals only.. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/titlecode/entries - * @property string $suffix The the constituent's suffix.. This codetable can + * @property string $suffix The the constituent's suffix.. This code table can * be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/suffixcode/entries * @property string $nick_name The the constituent's nickname. character @@ -28,10 +28,10 @@ * @property string $gender The the constituent's gender.. Available values * are *unknown*, *male*, *female*, *other* * @property string $marital_status The the constituent's marital status.. - * This codetable can be queried at + * This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/maritalstatuscode/entries * @property string $address_type The the address type of the constituent's - * address.. This codetable can be queried at + * address.. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/addresstypecode/entries * @property string $address_country The the country of the constituent's @@ -49,15 +49,15 @@ * @property bool $address_do_not_mail Indicates whether indicates whether the * constituent should not be contacted at this address.. * @property string $address_do_not_mail_reason The indicates the reason the - * constituent should not be contacted at this address.. This codetable can be - * queried at + * constituent should not be contacted at this address.. This code table can + * be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/donotmailreasoncode/entries * @property string $phone_type The the phone type of the constituent's - * phone.. This codetable can be queried at + * phone.. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/phonetypecode/entries * @property string $phone_number The the constituent's phone number.. * @property string $email_address_type The the email address type of the - * constituent's email.. This codetable can be queried at + * constituent's email.. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/emailaddresstypecode/entries * @property string $email_address The the constituent's email address.. * @property bool $skip_adding_security_groups Indicates whether skip adding @@ -73,10 +73,10 @@ * @property string $spouse_middle_name The the related individual's middle * name. character limit: 50.. * @property string $spouse_title The the related individual's title. This - * codetable can be queried at + * code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/titlecode/entries * @property string $spouse_suffix The the related individual's suffix. This - * codetable can be queried at + * code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/suffixcode/entries * @property string $spouse_nick_name The the related individual's nickname. * character limit: 50.. @@ -86,18 +86,19 @@ * $spouse_birth_date FuzzyDate * @property string $spouse_gender The the related individual's gender.. * Available values are *unknown*, *male*, *female*, *other* - * @property string $spouse_relationshiptypecode The the type of relationship - * between the constituent and related individual. can be expressed as, "the - * individual is the constituent's \_\_\_\_\_\_\_".. This simple list can be - * queried at + * @property string $spouse_relationship_type_code The the type of + * relationship between the constituent and related individual. can be + * expressed as, "the individual is the constituent's \_\_\_\_\_\_\_".. This + * simple list can be queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/4e869c5a-9b9d-4e84-b6e0-1fc66bafbafc?parameters=gender,{gendercode}&parameters=appliestoconstituenttype,{constituent\_type}. - * @property string $spouse_reciprocaltypecode The the type of relationship + * @property string $spouse_reciprocal_type_code The the type of relationship * between the related individual and the constituent. can be expressed as, * "the constituent is the individual's \_\_\_\_\_\_\_".. This simple list can * be queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/c3018803-2ea5-4f62-91cf-412e88d15f9b?parameters=appliestoconstituenttype,{constituent\_type}&parameters=constituentid,{spouse\_id}&parameters=appliestorelationshiptypeid,{spouse\_relationshiptypecodeid}&parameters=gender,{spouse\_gendercode}&parameters=relatestoconstituenttype,{0}. * @property string $spouse_start_date The the start date of the - * relationship..Uses the format YYYY-MM-DD. An example date: *2019-11-21*. + * relationship.. Uses the format YYYY-MM-DDThh:mm:ss. An example date: + * *1955-11-05T22:04:00*. * @property bool $copy_primary_information Indicates whether indicates * whether to copy the constituent's primary information to the related * constituent's record.. @@ -115,7 +116,7 @@ * @property string $organization_name The the related organization's name. * character limit: 100.. * @property string $organization_address_type The the address type of the - * related organization's address.. This codetable can be queried at + * related organization's address.. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/addresstypecode/entries * @property string $organization_country The the country of the related @@ -133,31 +134,33 @@ * @property bool $organization_do_not_mail Indicates whether indicates * whether the organization should not be contacted at this address.. * @property string $organization_do_not_mail_reason The indicates the reason - * the organization should not be contacted at this address.. This codetable + * the organization should not be contacted at this address.. This code table * can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/donotmailreasoncode/entries * @property string $organization_phone_type The the phone type of the related - * organization's phone.. This codetable can be queried at + * organization's phone.. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/phonetypecode/entries * @property string $organization_number The the related organization's phone * number. character limit: 100.. - * @property string $organization_relationshiptypecode The the type of + * @property string $organization_relationship_type_code The the type of * relationship between the constituent and related organization. can be * expressed as, "the organization is the constituent's \_\_\_\_\_\_\_".. This * simple list can be queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/4e869c5a-9b9d-4e84-b6e0-1fc66bafbafc?parameters=gender,{gendercode}&parameters=appliestoconstituenttype,{constituent\_type}. - * @property string $organization_reciprocaltypecode The the type of + * @property string $organization_reciprocal_type_code The the type of * relationship between the related organization and the constituent. can be * expressed as, "the constituent is the organization's \_\_\_\_\_\_\_".. This * simple list can be queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/c3018803-2ea5-4f62-91cf-412e88d15f9b?parameters=appliestoconstituenttype,{constituent\_type}&parameters=constituentid,{organization\_id}&parameters=appliestorelationshiptypeid,{organization\_relationshiptypecodeid}&parameters=relatestoconstituenttype,{1}. * @property string $organization_start_date The the related organization's - * start date..Uses the format YYYY-MM-DD. An example date: *2019-11-21*. + * start date.. Uses the format YYYY-MM-DDThh:mm:ss. An example date: + * *1955-11-05T22:04:00*. * @property string $organization_end_date The the related organization's end - * date..Uses the format YYYY-MM-DD. An example date: *2019-11-21*. + * date.. Uses the format YYYY-MM-DDThh:mm:ss. An example date: + * *1955-11-05T22:04:00*. * @property bool $contact Indicates whether contact. * @property string $contact_type The the related organization's contact - * type.. This codetable can be queried at + * type.. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/contacttypecode/entries * @property bool $primary_contact Indicates whether indicates whether this is @@ -167,25 +170,25 @@ * @property bool $matching_gift_relationship Indicates whether indicates * whether this organization will match an individual's contributions.. * @property string $reciprocal_recognition_type The recognition credit type. - * This codetable can be queried at + * This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/revenuerecognitiontypecode/entries * @property string $primary_recognition_type The recognition credit type. - * This codetable can be queried at + * This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/revenuerecognitiontypecode/entries * @property bool $address_omit_from_validation Indicates whether indicates * the constituent's address is omitted from validation.. * @property string $address_dpc The address dpc. * @property string $address_cart The address cart. * @property string $address_lot The address lot. - * @property string $address_county The address county. This codetable can be + * @property string $address_county The address county. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/countycode/entries * @property string $address_congressional_district The address congressional - * district. This codetable can be queried at + * district. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/congressionaldistrictcode/entries * @property string $address_last_validation_attempt_date The address last - * validation attempt date.Uses the format YYYY-MM-DD. An example date: - * *2019-11-21*. + * validation attempt date. Uses the format YYYY-MM-DDThh:mm:ss. An example + * date: *1955-11-05T22:04:00*. * @property string $address_validation_message The address validation * message. * @property int $address_certification_data The address certification data. @@ -194,53 +197,53 @@ * @property string $organization_dpc The organization dpc. * @property string $organization_cart The organization cart. * @property string $organization_lot The organization lot. - * @property string $organization_county The organization county. This - * codetable can be queried at + * @property string $organization_county The organization county. This code + * table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/countycode/entries * @property string $organization_congressional_district The organization - * congressional district. This codetable can be queried at + * congressional district. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/congressionaldistrictcode/entries * @property string $organization_last_validation_attempt_date The - * organization last validation attempt date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * organization last validation attempt date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $organization_validation_message The organization * validation message. * @property int $organization_certification_data The organization * certification data. - * @property \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentValidationcountries[] - * $validation_countries validation\_countries - * @property \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentZiplookupcountries[] - * $zip_lookup_countries zip\_lookup\_countries + * @property \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentValidationCountries[] + * $validation_countries Validation countries. + * @property \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentZipLookupCountries[] + * $zip_lookup_countries Zip lookup countries. * @property bool $spouse_relationship Indicates whether indicates whether * this is a spouse relationship with the constituent.. * @property bool $house_hold_copy_primary_contact_info Indicates whether * indicates whether to copy the individual's primary contact information to * the household.. * @property string $job_category The the constituent's job category.. This - * codetable can be queried at + * code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/jobcategorycode/entries * @property string $career_level The the constituent's career level.. This - * codetable can be queried at + * code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/careerlevelcode/entries * @property string $address_info_source The the infomation source of the - * constituent's address .. This codetable can be queried at + * constituent's address .. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/infosourcecode/entries * @property string $organization_info_source The the infomation source of the - * related organization.. This codetable can be queried at + * related organization.. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/infosourcecode/entries - * @property string $title_2 The the constituent's second title.. This - * codetable can be queried at + * @property string $title_2 The the constituent's second title.. This code + * table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/titlecode/entries * @property string $suffix_2 The the related individual's second suffix.. - * This codetable can be queried at + * This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/suffixcode/entries * @property string $spouse_title_2 The the related individual's second - * title.. This codetable can be queried at + * title.. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/titlecode/entries * @property string $spouse_suffix_2 The the constituent's second suffix.. - * This codetable can be queried at + * This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/suffixcode/entries * @property bool $skip_adding_sites Indicates whether skip adding sites. * @property int $constituent_type The the constituent's type.. Read-only in @@ -258,16 +261,16 @@ * match percentage for recognition credits applied to the organization from * gifts made by the individual.. * @property string $organization_primary_recognition_type The the recognition - * type of credits applied to the individual from the organization.. This - * codetable can be queried at + * type of credits applied to the individual from the organization.. This code + * table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/revenuerecognitiontypecode/entries * @property string $organization_reciprocal_recognition_type The the * recognition type of credits applied to the organization from the - * individual.. This codetable can be queried at + * individual.. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/revenuerecognitiontypecode/entries - * @property bool $optoutads Indicates whether individual opted out of + * @property bool $opt_out_ads Indicates whether individual opted out of * targeted advertising.. - * @property bool $optoutsale Indicates whether individual opted out of sale + * @property bool $opt_out_sale Indicates whether individual opted out of sale * of personal data.. * @property bool $gpc Indicates whether gpc. * @@ -313,8 +316,8 @@ class NewConstituent extends BaseComponent "spouse_maiden_name" => "string", "spouse_birth_date" => "\Blackbaud\SKY\Altru\Constituent\Components\FuzzyDate", "spouse_gender" => "string", - "spouse_relationshiptypecode" => "string", - "spouse_reciprocaltypecode" => "string", + "spouse_relationship_type_code" => "string", + "spouse_reciprocal_type_code" => "string", "spouse_start_date" => "string", "copy_primary_information" => "bool", "primary_soft_credit_relationship_exists" => "bool", @@ -334,8 +337,8 @@ class NewConstituent extends BaseComponent "organization_do_not_mail_reason" => "string", "organization_phone_type" => "string", "organization_number" => "string", - "organization_relationshiptypecode" => "string", - "organization_reciprocaltypecode" => "string", + "organization_relationship_type_code" => "string", + "organization_reciprocal_type_code" => "string", "organization_start_date" => "string", "organization_end_date" => "string", "contact" => "bool", @@ -363,8 +366,8 @@ class NewConstituent extends BaseComponent "organization_last_validation_attempt_date" => "string", "organization_validation_message" => "string", "organization_certification_data" => "int", - "validation_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\NewConstituentValidationcountries[]", - "zip_lookup_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\NewConstituentZiplookupcountries[]", + "validation_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\NewConstituentValidationCountries[]", + "zip_lookup_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\NewConstituentZipLookupCountries[]", "spouse_relationship" => "bool", "house_hold_copy_primary_contact_info" => "bool", "job_category" => "string", @@ -383,8 +386,8 @@ class NewConstituent extends BaseComponent "organization_reciprocal_soft_credit_match_factor" => "float", "organization_primary_recognition_type" => "string", "organization_reciprocal_recognition_type" => "string", - "optoutads" => "bool", - "optoutsale" => "bool", + "opt_out_ads" => "bool", + "opt_out_sale" => "bool", "gpc" => "bool", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAddress.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAddress.php index e4bc6c36..f06b35af 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAddress.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAddress.php @@ -7,14 +7,14 @@ /** * CreateConstituentAddress * - * @property string $constituent_id The constituent id. - * @property string $address_type The type. This codetable can be queried at + * @property string $constituent_id The constituent ID. + * @property string $address_type The type. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/addresstypecode/entries * @property string $address_block The address. * @property string $city The city. * @property string $state The state. This simple list can be queried at - * https://api.sky.blackbaud.com/alt-adnmg/simplelists/7fa91401-596c-4f7c-936d-6e41683121d7?parameters=country\_id,{country\_id}. + * https://api.sky.blackbaud.com/alt-adnmg/simplelists/7fa91401-596c-4f7c-936d-6e41683121d7?parameters=countryid,{countryid}. * @property string $postcode The zip. * @property string $country The country. This simple list can be queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/c9649672-353d-42e8-8c25-4d34bbabfbba. @@ -28,8 +28,8 @@ * @property \Blackbaud\SKY\Altru\Constituent\Components\MonthDay $end_date * MonthDay * @property bool $primary Indicates whether set as primary address. - * @property string $historical_start_date The start date.Uses the format - * YYYY-MM-DD. An example date: *2019-11-21*. + * @property string $historical_start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property bool $recent_move Indicates whether recently moved/changed from * this address?. * @property string $old_address The old address. This simple list can be @@ -40,40 +40,40 @@ * matching address information for spouse. * @property bool $omit_from_validation Indicates whether omit this address * from validation. - * @property string $county The county. This codetable can be queried at + * @property string $county The county. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/countycode/entries * @property string $congressional_district The congressional district. This - * codetable can be queried at + * code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/congressionaldistrictcode/entries - * @property string $state_house_district The state house district. This - * codetable can be queried at + * @property string $state_house_district The state house district. This code + * table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/statehousedistrictcode/entries * @property string $state_senate_district The state senate district. This - * codetable can be queried at + * code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/statesenatedistrictcode/entries - * @property string $local_precinct The local precinct. This codetable can be + * @property string $local_precinct The local precinct. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/localprecinctcode/entries - * @property string $info_source The information source. This codetable can be - * queried at + * @property string $info_source The information source. This code table can + * be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/infosourcecode/entries - * @property string $region The region. This codetable can be queried at + * @property string $region The region. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/regioncode/entries - * @property string $last_validation_attempt_date The last attempt.Uses the - * format YYYY-MM-DD. An example date: *2019-11-21*. + * @property string $last_validation_attempt_date The last attempt. Uses the + * format YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $validation_message The validation message. * @property int $certification_data The certification data. - * @property \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentAddressZiplookupcountries[] - * $zip_lookup_countries zip\_lookup\_countries + * @property \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentAddressZipLookupCountries[] + * $zip_lookup_countries Zip lookup countries. * @property bool $household Indicates whether household. Read-only in the * SOAP API. * @property bool $household_member Indicates whether household member. * Read-only in the SOAP API. * @property bool $update_matching_household_addresses Indicates whether copy * address information to household members. - * @property \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentAddressValidationcountries[] - * $validation_countries validation\_countries - * @property string $do_not_mail_reason The reason. This codetable can be + * @property \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentAddressValidationCountries[] + * $validation_countries Validation countries. + * @property string $do_not_mail_reason The reason. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/donotmailreasoncode/entries * @property string $info_source_comments The comments. @@ -129,11 +129,11 @@ class NewConstituentAddress extends BaseComponent "last_validation_attempt_date" => "string", "validation_message" => "string", "certification_data" => "int", - "zip_lookup_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\NewConstituentAddressZiplookupcountries[]", + "zip_lookup_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\NewConstituentAddressZipLookupCountries[]", "household" => "bool", "household_member" => "bool", "update_matching_household_addresses" => "bool", - "validation_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\NewConstituentAddressValidationcountries[]", + "validation_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\NewConstituentAddressValidationCountries[]", "do_not_mail_reason" => "string", "info_source_comments" => "string", "confidential" => "bool", diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAddressValidationcountries.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAddressValidationcountries.php index c4030b0a..eba2f3fc 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAddressValidationcountries.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAddressValidationcountries.php @@ -5,14 +5,14 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * NewConstituentAddressValidationcountries + * NewConstituentAddressValidationCountries * * @property string $country_id countryid * @property bool $browsable browsable * * @api */ -class NewConstituentAddressValidationcountries extends BaseComponent +class NewConstituentAddressValidationCountries extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAddressZiplookupcountries.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAddressZiplookupcountries.php index 09f5ed8b..8bb63f41 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAddressZiplookupcountries.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAddressZiplookupcountries.php @@ -5,14 +5,14 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * NewConstituentAddressZiplookupcountries + * NewConstituentAddressZipLookupCountries * * @property string $country_id countryid * @property string $country_name name * * @api */ -class NewConstituentAddressZiplookupcountries extends BaseComponent +class NewConstituentAddressZipLookupCountries extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAlternateLookupId.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAlternateLookupId.php index 6ec7cb4d..23e5c1ff 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAlternateLookupId.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAlternateLookupId.php @@ -7,11 +7,11 @@ /** * CreateConstituentAlternateLookupId * - * @property string $constituent_id The constituent id. - * @property string $alternate_lookup_id_type The type. This codetable can be + * @property string $constituent_id The constituent ID. + * @property string $alternate_lookup_id_type The type. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/alternatelookupidtypecode/entries - * @property string $alternate_lookup_id The lookup id. + * @property string $alternate_lookup_id The lookup ID. * * @api */ diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAppeal.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAppeal.php index 137db07e..2e9d4063 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAppeal.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAppeal.php @@ -7,13 +7,13 @@ /** * CreateConstituentAppeal * - * @property string $constituent_id The constituent id. + * @property string $constituent_id The constituent ID. * @property string $appeal_id The appeal. * @property string $mkt_segmentation The mailing. This simple list can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/664c0aa7-9f88-46f6-ba84-7b412e1131b5?parameters=appeal\_id,{appeal\_id}. - * @property string $date_sent The date sent.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $date_sent The date sent. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $mkt_package_id The package. * @property string $source_code The source code. * @property string $comments The comments. diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAppealResponse.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAppealResponse.php index 014550d8..8e1ff85c 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAppealResponse.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAppealResponse.php @@ -8,8 +8,8 @@ * CreateConstituentAppealResponse * * @property string $constituent_appeal_id The constituent appeal id. - * @property string $date The the date of the response.Uses the format - * YYYY-MM-DD. An example date: *2019-11-21*. + * @property string $date The the date of the response. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $response_category The the response category. This simple * list can be queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/fa5c3e42-aea6-450c-a66f-e79919df98d8. Read-only in the SOAP API. diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAttribute.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAttribute.php index fd6e53e8..c4e97e8f 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAttribute.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAttribute.php @@ -7,7 +7,7 @@ /** * CreateConstituentAttribute * - * @property string $attribute_context_id The attribute context id. + * @property string $attribute_context_id The attribute context ID. * @property string $header_caption The headercaption. Read-only in the SOAP * API. * @property string $attribute_category The category. This simple list can be @@ -16,11 +16,11 @@ * @property string $string_value The value. * @property int $number_value The value. * @property float $money_value The value. - * @property string $date_value The value.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $date_value The value. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $boolean_value The value. Available values are *no*, *yes* - * @property string $code_table_value The value. This codetable can be queried - * at + * @property string $code_table_value The value. This code table can be + * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/addresstypecode/entries * @property \Blackbaud\SKY\Altru\Constituent\Components\FuzzyDate @@ -29,13 +29,13 @@ * @property \Blackbaud\SKY\Altru\Constituent\Components\HourMinute * $hour_minute_value HourMinute * @property string $memo_value The value. - * @property \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentAttributeAttributecategories[] - * $attribute_categories attribute\_categories + * @property \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentAttributeAttributeCategories[] + * $attribute_categories Attribute categories. * @property string $comment The comment. - * @property string $start_date The start date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $end_date The end date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $end_date The end date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $record_type_string The record type. Read-only in the SOAP * API. * @property string $currency The currency. This simple list can be queried at @@ -66,7 +66,7 @@ class NewConstituentAttribute extends BaseComponent "constituent_id_value" => "string", "hour_minute_value" => "\Blackbaud\SKY\Altru\Constituent\Components\HourMinute", "memo_value" => "string", - "attribute_categories" => "\Blackbaud\SKY\Altru\Constituent\Components\NewConstituentAttributeAttributecategories[]", + "attribute_categories" => "\Blackbaud\SKY\Altru\Constituent\Components\NewConstituentAttributeAttributeCategories[]", "comment" => "string", "start_date" => "string", "end_date" => "string", diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAttributeAttributecategories.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAttributeAttributecategories.php index 5b7cc973..85adfa31 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAttributeAttributecategories.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentAttributeAttributecategories.php @@ -5,7 +5,7 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * NewConstituentAttributeAttributecategories + * NewConstituentAttributeAttributeCategories * * @property string $id id * @property int $data_type_code datatypecode @@ -15,7 +15,7 @@ * * @api */ -class NewConstituentAttributeAttributecategories extends BaseComponent +class NewConstituentAttributeAttributeCategories extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentCorrespondenceCode.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentCorrespondenceCode.php index 9ce6e027..804f4b73 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentCorrespondenceCode.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentCorrespondenceCode.php @@ -7,12 +7,13 @@ /** * CreateConstituentCorrespondenceCode * - * @property string $constituent_id The constituent id. + * @property string $constituent_id The constituent ID. * @property string $correspondence_code The the code associated with this * correspondence.. This simple list can be queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/63305295-220e-43a1-b744-359c7ffb77f5. - * @property string $date_sent The date when this correspondence was - * sent..Uses the format YYYY-MM-DD. An example date: *2019-11-21*. + * @property string $date_sent The date when this correspondence was sent.. + * Uses the format YYYY-MM-DDThh:mm:ss. An example date: + * *1955-11-05T22:04:00*. * @property string $comments The comments regarding this correspondence.. * * @api diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentEmailAddress.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentEmailAddress.php index d37b589b..1dc6e7fe 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentEmailAddress.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentEmailAddress.php @@ -7,8 +7,8 @@ /** * CreateConstituentEmailAddress * - * @property string $constituent_id The constituent id. - * @property string $email_address_type The type. This codetable can be + * @property string $constituent_id The constituent ID. + * @property string $email_address_type The type. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/emailaddresstypecode/entries * @property string $email_address The email address. @@ -24,8 +24,8 @@ * copy email address information to household members. * @property bool $do_not_email Indicates whether do not send email to this * address. - * @property string $info_source The information source. This codetable can be - * queried at + * @property string $info_source The information source. This code table can + * be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/infosourcecode/entries * @property string $info_source_comments The comments. * @property string $constituent_data_review_rollback_reason The reason. This @@ -39,8 +39,8 @@ * API. * @property string $origin The origin. Available values are *user*, *web * forms* - * @property string $start_date The start date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * * @api */ diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentFundraiser.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentFundraiser.php index c79364f5..6ce53feb 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentFundraiser.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentFundraiser.php @@ -7,11 +7,11 @@ /** * CreateConstituentFundraiser * - * @property string $constituent_id The constituent id. - * @property string $date_from The date from.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $date_to The date to.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $constituent_id The constituent ID. + * @property string $date_from The date from. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $date_to The date to. Uses the format YYYY-MM-DDThh:mm:ss. + * An example date: *1955-11-05T22:04:00*. * * @api */ diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentInteraction.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentInteraction.php index ee08f8f8..8a270f24 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentInteraction.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentInteraction.php @@ -7,16 +7,16 @@ /** * CreateConstituentInteraction * - * @property string $constituent_id The constituent id. - * @property string $interaction_type The contact method. This codetable can + * @property string $constituent_id The constituent ID. + * @property string $interaction_type The contact method. This code table can * be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/interactiontypecode/entries * @property string $objective The summary. * @property string $fundraiser_id The owner. - * @property string $expected_date The expected date.Uses the format - * YYYY-MM-DD. An example date: *2019-11-21*. - * @property string $actual_date The actual date.Uses the format YYYY-MM-DD. - * An example date: *2019-11-21*. + * @property string $expected_date The expected date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $actual_date The actual date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $status The status. Available values are *pending*, * *completed*, *canceled*, *declined* * @property string $comment The comment. @@ -24,15 +24,15 @@ * @property string $constituent_name The constituent name. Read-only in the * SOAP API. * @property \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentInteractionParticipants[] - * $participants participants + * $participants Participants. * @property string $interaction_category The category. This simple list can * be queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/cbba7545-b66f-44ac-aa24-d9c2f8cbc4ec. * @property string $interaction_subcategory The subcategory. This simple list * can be queried at - * https://api.sky.blackbaud.com/alt-adnmg/simplelists/0eacc39b-07d1-4641-8774-e319559535a7?parameters=interaction\_category\_id,{interaction\_category\_id}. + * https://api.sky.blackbaud.com/alt-adnmg/simplelists/0eacc39b-07d1-4641-8774-e319559535a7?parameters=interactioncategoryid,{interactioncategoryid}. * @property \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentInteractionSites[] - * $sites sites + * $sites Sites. * @property bool $site_required Indicates whether site required. Read-only in * the SOAP API. * @property string $selected_constituent_id The constituent. diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentMerge.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentMerge.php index ad2b93bb..2cc57901 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentMerge.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentMerge.php @@ -9,7 +9,7 @@ * * @property string $source_id The the constituent whose data will be merged * into the target constituent.. - * @property string $targetid The the constituent record that will represent + * @property string $target_id The the constituent record that will represent * the consolidated view of the constituent's data after the merge has * completed.. * @property string $config The the merge configuration that will be used to @@ -34,7 +34,7 @@ class NewConstituentMerge extends BaseComponent */ protected static array $fields = [ "source_id" => "string", - "targetid" => "string", + "target_id" => "string", "config" => "string", "delete_source" => "bool", "constituent_inactivity_reason_code" => "string", diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentNote.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentNote.php index 7ae8ea50..cbb96b26 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentNote.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentNote.php @@ -7,14 +7,14 @@ /** * CreateConstituentNote * - * @property string $constituent_id The constituent id. + * @property string $constituent_id The constituent ID. * @property int $context_type The context type. Read-only in the SOAP API. * @property string $title The the title of this note. - * @property string $date_entered The the date this note was entered.Uses the - * format YYYY-MM-DD. An example date: *2019-11-21*. + * @property string $date_entered The the date this note was entered. Uses the + * format YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $author_id The the author of this note. * @property string $note_type The the user-defined type of this note. This - * codetable can be queried at + * code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/constituentnotetypecode/entries * @property string $text_note The the plain text that comprises this note. * @property string $html_note The the html that comprises this note. diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentPhone.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentPhone.php index 9d45a6fc..a16b462d 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentPhone.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentPhone.php @@ -7,8 +7,8 @@ /** * CreateConstituentPhone * - * @property string $constituent_id The constituent id. - * @property string $phone_type The type. This codetable can be queried at + * @property string $constituent_id The constituent ID. + * @property string $phone_type The type. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/phonetypecode/entries * @property string $number The number. * @property bool $primary Indicates whether set as primary phone number. @@ -27,8 +27,8 @@ * $start_time HourMinute * @property \Blackbaud\SKY\Altru\Constituent\Components\HourMinute $end_time * HourMinute - * @property string $info_source The information source. This codetable can be - * queried at + * @property string $info_source The information source. This code table can + * be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/infosourcecode/entries * @property string $info_source_comments The comments. * @property string $country The country. This simple list can be queried at @@ -37,15 +37,15 @@ * $seasonal_start_date MonthDay * @property \Blackbaud\SKY\Altru\Constituent\Components\MonthDay * $seasonal_end_date MonthDay - * @property string $start_date The start date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $do_not_call_reason The reason. This codetable can be + * @property string $start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $do_not_call_reason The reason. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/donotcallreasoncode/entries * @property bool $confidential Indicates whether this phone number is * confidential. - * @property \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentPhoneCountrycodes[] - * $country_codes country\_codes + * @property \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentPhoneCountryCodes[] + * $country_codes Country codes. * @property string $constituent_data_review_rollback_reason The reason. This * simple list can be queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/484441bc-f0e6-4f5f-a6bf-49f02881dd13. @@ -86,7 +86,7 @@ class NewConstituentPhone extends BaseComponent "start_date" => "string", "do_not_call_reason" => "string", "confidential" => "bool", - "country_codes" => "\Blackbaud\SKY\Altru\Constituent\Components\NewConstituentPhoneCountrycodes[]", + "country_codes" => "\Blackbaud\SKY\Altru\Constituent\Components\NewConstituentPhoneCountryCodes[]", "constituent_data_review_rollback_reason" => "string", "forced_primary" => "bool", "can_edit_primary" => "bool", diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentPhoneCountrycodes.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentPhoneCountrycodes.php index 89b40b90..6e4e68c9 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentPhoneCountrycodes.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentPhoneCountrycodes.php @@ -5,14 +5,14 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * NewConstituentPhoneCountrycodes + * NewConstituentPhoneCountryCodes * * @property string $country_id countryid * @property string $country_code country code * * @api */ -class NewConstituentPhoneCountrycodes extends BaseComponent +class NewConstituentPhoneCountryCodes extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentSolicitCode.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentSolicitCode.php index e140be60..d5f0a933 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentSolicitCode.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentSolicitCode.php @@ -7,14 +7,14 @@ /** * CreateConstituentSolicitCode * - * @property string $constituent_id The constituent id. + * @property string $constituent_id The constituent ID. * @property string $solicit_code The solicit code. This simple list can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/ea7286bd-d27b-4028-b507-4bdb92580499?parameters=feature\_id,{b6a5f4eb-adf7-4fa4-a3e0-8cd96e58d8c2}&parameters=feature\_type,{1}. - * @property string $start_date The start date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $end_date The end date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $end_date The end date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $comments The comments. * * @api diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentValidationcountries.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentValidationcountries.php index 584657d6..1e714e1d 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentValidationcountries.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentValidationcountries.php @@ -5,14 +5,14 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * NewConstituentValidationcountries + * NewConstituentValidationCountries * * @property string $country_id countryid * @property bool $browsable browsable * * @api */ -class NewConstituentValidationcountries extends BaseComponent +class NewConstituentValidationCountries extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentZiplookupcountries.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentZiplookupcountries.php index 7d329bbe..fbc9dbc6 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentZiplookupcountries.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewConstituentZiplookupcountries.php @@ -5,14 +5,14 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * NewConstituentZiplookupcountries + * NewConstituentZipLookupCountries * * @property string $country_id countryid * @property string $country_name name * * @api */ -class NewConstituentZiplookupcountries extends BaseComponent +class NewConstituentZipLookupCountries extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewEducation.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewEducation.php index 67b2012f..0b0d83ca 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewEducation.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewEducation.php @@ -7,14 +7,14 @@ /** * CreateEducation * - * @property string $constituent_id The constituent id. + * @property string $constituent_id The constituent ID. * @property bool $primary_record Indicates whether primary education * information. * @property string $educational_institution_id The educational institution. * @property string $academic_catalog_program The program. This simple list * can be queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/d411c16b-8bcf-4fc8-a747-754e1e89e9bc?parameters=educational\_institution\_id,{educational\_institution\_id}. - * @property string $educational_program The program. This codetable can be + * @property string $educational_program The program. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationalprogramcode/entries * @property string $constituency_status The status. Available values are @@ -23,36 +23,35 @@ * $date_graduated FuzzyDate * @property \Blackbaud\SKY\Altru\Constituent\Components\FuzzyDate $date_left * FuzzyDate - * @property string $educational_history_level The level. This codetable can + * @property string $educational_history_level The level. This code table can * be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationalhistorylevelcode/entries - * @property string $educational_history_reason The reason. This codetable can - * be queried at + * @property string $educational_history_reason The reason. This code table + * can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationalhistoryreasoncode/entries * @property string $academic_catalog_degree The degree. This simple list can * be queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/73c67942-07ad-412e-8596-a042e5e68002?parameters=academiccatalogprogramid,{academiccatalogprogramid}. - * @property string $educational_degree The degree. This codetable can be + * @property string $educational_degree The degree. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationaldegreecode/entries - * @property string $educational_award The honor awarded. This codetable can + * @property string $educational_award The honor awarded. This code table can * be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationalawardcode/entries * @property \Blackbaud\SKY\Altru\Constituent\Components\FuzzyDate $start_date * FuzzyDate * @property int $class_year The class of. * @property int $preferred_class_year The preferred class of. - * @property string $educational_source The information source. This codetable - * can be queried at + * @property string $educational_source The information source. This code + * table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationalsourcecode/entries * @property \Blackbaud\SKY\Altru\Constituent\Components\FuzzyDate * $educational_source_date FuzzyDate * @property string $comment The comments. - * @property \Blackbaud\SKY\Altru\Constituent\Components\NewEducationAffiliatedadditionalinformation[] - * $affiliate_dadditional_information affiliate\_dadditional\_information - * @property \Blackbaud\SKY\Altru\Constituent\Components\NewEducationUnaffiliatedadditionalinformation[] - * $unaffiliated_additional_information unaffiliated\_additional\_information - + * @property \Blackbaud\SKY\Altru\Constituent\Components\NewEducationAffiliateDadditionalInformation[] + * $affiliate_dadditional_information Affiliate dadditional information. + * @property \Blackbaud\SKY\Altru\Constituent\Components\NewEducationUnaffiliatedAdditionalInformation[] + * $unaffiliated_additional_information Unaffiliated additional information. * @property bool $affiliated Indicates whether affiliated. * @property bool $use_academic_catalog Indicates whether use academic * catalog. Read-only in the SOAP API. @@ -87,8 +86,8 @@ class NewEducation extends BaseComponent "educational_source" => "string", "educational_source_date" => "\Blackbaud\SKY\Altru\Constituent\Components\FuzzyDate", "comment" => "string", - "affiliate_dadditional_information" => "\Blackbaud\SKY\Altru\Constituent\Components\NewEducationAffiliatedadditionalinformation[]", - "unaffiliated_additional_information" => "\Blackbaud\SKY\Altru\Constituent\Components\NewEducationUnaffiliatedadditionalinformation[]", + "affiliate_dadditional_information" => "\Blackbaud\SKY\Altru\Constituent\Components\NewEducationAffiliateDadditionalInformation[]", + "unaffiliated_additional_information" => "\Blackbaud\SKY\Altru\Constituent\Components\NewEducationUnaffiliatedAdditionalInformation[]", "affiliated" => "bool", "use_academic_catalog" => "bool", "educational_history_status" => "string", diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewEducationAffiliatedadditionalinformation.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewEducationAffiliatedadditionalinformation.php index 421f8651..8448c1d2 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewEducationAffiliatedadditionalinformation.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewEducationAffiliatedadditionalinformation.php @@ -5,7 +5,7 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * NewEducationAffiliatedadditionalinformation + * NewEducationAffiliateDadditionalInformation * * @property string $id id * @property string $academiccatalogcollege The college/school. This simple @@ -26,7 +26,7 @@ * * @api */ -class NewEducationAffiliatedadditionalinformation extends BaseComponent +class NewEducationAffiliateDadditionalInformation extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewEducationUnaffiliatedadditionalinformation.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewEducationUnaffiliatedadditionalinformation.php index 90252969..f99a9210 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewEducationUnaffiliatedadditionalinformation.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewEducationUnaffiliatedadditionalinformation.php @@ -5,28 +5,28 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * NewEducationUnaffiliatedadditionalinformation + * NewEducationUnaffiliatedAdditionalInformation * * @property string $id id - * @property string $educational_college The college/school. This codetable + * @property string $educational_college The college/school. This code table * can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationalcollegecode/entries - * @property string $educational_division The division. This codetable can be + * @property string $educational_division The division. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationaldivisioncode/entries - * @property string $educational_department The department. This codetable can - * be queried at + * @property string $educational_department The department. This code table + * can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationaldepartmentcode/entries - * @property string $educational_sub_department The sub department. This - * codetable can be queried at + * @property string $educational_sub_department The sub department. This code + * table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationalsubdepartmentcode/entries - * @property string $educational_degree_type The degree type. This codetable + * @property string $educational_degree_type The degree type. This code table * can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/educationaldegreetypecode/entries * * @api */ -class NewEducationUnaffiliatedadditionalinformation extends BaseComponent +class NewEducationUnaffiliatedAdditionalInformation extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewIndividual.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewIndividual.php index 65b578a6..721dd9aa 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewIndividual.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewIndividual.php @@ -7,82 +7,271 @@ /** * CreateIndividual * - * @property string $last_name The last name. - * @property string $first_name The first name. - * @property string $middle_name The middle name. - * @property string $maiden_name The maiden name. - * @property string $nickname The nickname. - * @property string $marital_status The marital status. This codetable can be - * queried at - * https://api.sky.blackbaud.com/alt-adnmg/codetables/maritalstatuscode/entries - * @property string $title The title. This codetable can be queried at - * https://api.sky.blackbaud.com/alt-adnmg/codetables/titlecode/entries - * @property string $title_2 The title 2. This codetable can be queried at + * @property string $last_name The the constituent's last name. character + * limit: 100.. + * @property string $first_name The the constituent's first name. character + * limit: 50.. + * @property string $middle_name The the constituent's middle name. character + * limit: 50.. + * @property string $title The the constituent's primary title. for + * individuals only.. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/titlecode/entries - * @property string $suffix The suffix. This codetable can be queried at - * https://api.sky.blackbaud.com/alt-adnmg/codetables/suffixcode/entries - * @property string $suffix_2 The suffix 2. This codetable can be queried at + * @property string $suffix The the constituent's suffix.. This code table can + * be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/suffixcode/entries - * @property string $gender The gender. Available values are *unknown*, - * *male*, *female*, *other* + * @property string $nickname The the constituent's nickname. character limit: + * 50.. + * @property string $maiden_name The the constituent's maiden name. character + * limit: 100.. * @property \Blackbaud\SKY\Altru\Constituent\Components\FuzzyDate $birth_date * FuzzyDate - * @property string $picture The image. - * @property string $picture_thumbnail The picture thumbnail. - * @property string $web_address The website. - * @property string $address_type The address type. This codetable can be - * queried at + * @property string $gender The the constituent's gender.. Available values + * are *unknown*, *male*, *female*, *other* + * @property string $marital_status The the constituent's marital status.. + * This code table can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/codetables/maritalstatuscode/entries + * @property string $address_type The the address type of the constituent's + * address.. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/addresstypecode/entries - * @property string $address_country The country. This simple list can be - * queried at + * @property string $address_country The the country of the constituent's + * address.. This simple list can be queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/c9649672-353d-42e8-8c25-4d34bbabfbba. - * @property string $address_block The address. - * @property string $address_city The city. - * @property string $address_state The state. This simple list can be queried - * at - * https://api.sky.blackbaud.com/alt-adnmg/simplelists/7fa91401-596c-4f7c-936d-6e41683121d7?parameters=country\_id,{address\_country\_id}. - * @property string $address_postcode The zip. - * @property bool $address_do_not_mail Indicates whether do not send mail to - * this address. - * @property string $address_do_not_mail_reason The reason. This codetable can + * @property string $address_block The the constituent's address. character + * limit: 150.. + * @property string $address_city The the city of the constituent's address. + * character limit: 50.. + * @property string $address_state The the state of the constituent's + * address.. This simple list can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/simplelists/7fa91401-596c-4f7c-936d-6e41683121d7?parameters=country\_id,{address\_countryid}. + * @property string $address_post_code The the postal code of the + * constituent's address. character limit: 12.. + * @property bool $address_do_not_mail Indicates whether indicates whether the + * constituent should not be contacted at this address.. + * @property string $address_do_not_mail_reason The indicates the reason the + * constituent should not be contacted at this address.. This code table can * be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/donotmailreasoncode/entries - * @property string $phone_type The phone type. This codetable can be queried - * at https://api.sky.blackbaud.com/alt-adnmg/codetables/phonetypecode/entries - - * @property string $phone_number The phone number. - * @property string $email_address_type The email type. This codetable can be - * queried at + * @property string $phone_type The the phone type of the constituent's + * phone.. This code table can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/codetables/phonetypecode/entries + * @property string $phone_number The the constituent's phone number.. + * @property string $email_address_type The the email address type of the + * constituent's email.. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/emailaddresstypecode/entries - * @property string $email_address The email address. + * @property string $email_address The the constituent's email address.. * @property bool $skip_adding_security_groups Indicates whether skip adding * security groups. - * @property \Blackbaud\SKY\Altru\Constituent\Components\NewIndividualZiplookupcountries[] - * $zip_lookup_countries zip\_lookup\_countries - * @property string $job_title The job title. - * @property bool $omit_from_validation Indicates whether omit from - * validation. - * @property string $dpc The dpc. - * @property string $cart The cart. - * @property string $lot The lot. - * @property string $county The county. This codetable can be queried at + * @property bool $existing_spouse Indicates whether search existing + * individuals. + * @property string $spouse_id The an individual related to the constituent. + * this individual will be added to the same household as the constituent.. + * @property string $spouse_last_name The the related individual's last name. + * character limit: 100.. + * @property string $spouse_first_name The the related individual's first + * name. character limit: 50.. + * @property string $spouse_middle_name The the related individual's middle + * name. character limit: 50.. + * @property string $spouse_title The the related individual's title. This + * code table can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/codetables/titlecode/entries + * @property string $spouse_suffix The the related individual's suffix. This + * code table can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/codetables/suffixcode/entries + * @property string $spouse_nick_name The the related individual's nickname. + * character limit: 50.. + * @property string $spouse_maiden_name The the related individual's maiden + * name. character limit: 100.. + * @property \Blackbaud\SKY\Altru\Constituent\Components\FuzzyDate + * $spouse_birth_date FuzzyDate + * @property string $spouse_gender The the related individual's gender.. + * Available values are *unknown*, *male*, *female*, *other* + * @property string $spouse_relationship_type_code The the type of + * relationship between the constituent and related individual. can be + * expressed as, "the individual is the constituent's \_\_\_\_\_\_\_".. This + * simple list can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/simplelists/4e869c5a-9b9d-4e84-b6e0-1fc66bafbafc?parameters=gender,{gendercode}&parameters=appliestoconstituenttype,{constituent\_type}. + * @property string $spouse_reciprocal_type_code The the type of relationship + * between the related individual and the constituent. can be expressed as, + * "the constituent is the individual's \_\_\_\_\_\_\_".. This simple list can + * be queried at + * https://api.sky.blackbaud.com/alt-adnmg/simplelists/c3018803-2ea5-4f62-91cf-412e88d15f9b?parameters=appliestoconstituenttype,{constituent\_type}&parameters=constituentid,{spouse\_id}&parameters=appliestorelationshiptypeid,{spouse\_relationshiptypecodeid}&parameters=gender,{spouse\_gendercode}&parameters=relatestoconstituenttype,{0}. + * @property string $spouse_start_date The the start date of the + * relationship.. Uses the format YYYY-MM-DDThh:mm:ss. An example date: + * *1955-11-05T22:04:00*. + * @property bool $copy_primary_information Indicates whether indicates + * whether to copy the constituent's primary information to the related + * constituent's record.. + * @property bool $primary_soft_credit_relationship_exists Indicates whether + * soft credit individual for constituent's payments. + * @property float $primary_soft_credit_match_factor The recognition match + * percent. + * @property bool $reciprocal_soft_credit_relationship_exists Indicates + * whether soft credit constituent for individual's payments. + * @property float $reciprocal_soft_credit_match_factor The recognition match + * percent. + * @property bool $existing_organization Indicates whether search existing + * organizations. + * @property string $organization_id The the related organization's id.. + * @property string $organization_name The the related organization's name. + * character limit: 100.. + * @property string $organization_address_type The the address type of the + * related organization's address.. This code table can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/codetables/addresstypecode/entries + + * @property string $organization_country The the country of the related + * organization's address.. This simple list can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/simplelists/c9649672-353d-42e8-8c25-4d34bbabfbba. + * @property string $organization_address_block The the related organization's + * address. character limit: 150.. + * @property string $organization_city The the city of the related + * organization's address. character limit: 50.. + * @property string $organization_state The the state of the related + * organization's address.. This simple list can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/simplelists/7fa91401-596c-4f7c-936d-6e41683121d7?parameters=country\_id,{organization\_countryid}. + * @property string $organization_post_code The the postal code of the related + * organization's address. character limit: 50.. + * @property bool $organization_do_not_mail Indicates whether indicates + * whether the organization should not be contacted at this address.. + * @property string $organization_do_not_mail_reason The indicates the reason + * the organization should not be contacted at this address.. This code table + * can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/codetables/donotmailreasoncode/entries + * @property string $organization_phone_type The the phone type of the related + * organization's phone.. This code table can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/codetables/phonetypecode/entries + * @property string $organization_number The the related organization's phone + * number. character limit: 100.. + * @property string $organization_relationship_type_code The the type of + * relationship between the constituent and related organization. can be + * expressed as, "the organization is the constituent's \_\_\_\_\_\_\_".. This + * simple list can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/simplelists/4e869c5a-9b9d-4e84-b6e0-1fc66bafbafc?parameters=gender,{gendercode}&parameters=appliestoconstituenttype,{constituent\_type}. + * @property string $organization_reciprocal_type_code The the type of + * relationship between the related organization and the constituent. can be + * expressed as, "the constituent is the organization's \_\_\_\_\_\_\_".. This + * simple list can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/simplelists/c3018803-2ea5-4f62-91cf-412e88d15f9b?parameters=appliestoconstituenttype,{constituent\_type}&parameters=constituentid,{organization\_id}&parameters=appliestorelationshiptypeid,{organization\_relationshiptypecodeid}&parameters=relatestoconstituenttype,{1}. + * @property string $organization_start_date The the related organization's + * start date.. Uses the format YYYY-MM-DDThh:mm:ss. An example date: + * *1955-11-05T22:04:00*. + * @property string $organization_end_date The the related organization's end + * date.. Uses the format YYYY-MM-DDThh:mm:ss. An example date: + * *1955-11-05T22:04:00*. + * @property bool $contact Indicates whether contact. + * @property string $contact_type The the related organization's contact + * type.. This code table can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/codetables/contacttypecode/entries + + * @property bool $primary_contact Indicates whether indicates whether this is + * the constituent's primary contact.. + * @property string $position The the constituent's job title. character + * limit: 100.. + * @property bool $matching_gift_relationship Indicates whether indicates + * whether this organization will match an individual's contributions.. + * @property string $reciprocal_recognition_type The recognition credit type. + * This code table can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/codetables/revenuerecognitiontypecode/entries + * @property string $primary_recognition_type The recognition credit type. + * This code table can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/codetables/revenuerecognitiontypecode/entries + * @property bool $address_omit_from_validation Indicates whether indicates + * the constituent's address is omitted from validation.. + * @property string $address_dpc The address dpc. + * @property string $address_cart The address cart. + * @property string $address_lot The address lot. + * @property string $address_county The address county. This code table can be + * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/countycode/entries - * @property string $congressional_district The congressional district. This - * codetable can be queried at + * @property string $address_congressional_district The address congressional + * district. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/congressionaldistrictcode/entries - * @property string $last_validation_attempt_date The last validation attempt - * date.Uses the format YYYY-MM-DD. An example date: *2019-11-21*. - * @property string $validation_message The validation message. - * @property int $certification_data The certification data. - * @property \Blackbaud\SKY\Altru\Constituent\Components\NewIndividualValidationcountries[] - * $validation_countries validation\_countries - * @property bool $skip_adding_sites Indicates whether skip adding sites. - * @property string $info_source The information source. This codetable can be - * queried at + * @property string $address_last_validation_attempt_date The address last + * validation attempt date. Uses the format YYYY-MM-DDThh:mm:ss. An example + * date: *1955-11-05T22:04:00*. + * @property string $address_validation_message The address validation + * message. + * @property int $address_certification_data The address certification data. + * @property bool $organization_omit_from_validation Indicates whether + * indicates the organization is omitted from validation.. + * @property string $organization_dpc The organization dpc. + * @property string $organization_cart The organization cart. + * @property string $organization_lot The organization lot. + * @property string $organization_county The organization county. This code + * table can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/codetables/countycode/entries + * @property string $organization_congressional_district The organization + * congressional district. This code table can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/codetables/congressionaldistrictcode/entries + * @property string $organization_last_validation_attempt_date The + * organization last validation attempt date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $organization_validation_message The organization + * validation message. + * @property int $organization_certification_data The organization + * certification data. + * @property \Blackbaud\SKY\Altru\Constituent\Components\NewIndividualValidationCountries[] + * $validation_countries Validation countries. + * @property \Blackbaud\SKY\Altru\Constituent\Components\NewIndividualZipLookupCountries[] + * $zip_lookup_countries Zip lookup countries. + * @property bool $spouse_relationship Indicates whether indicates whether + * this is a spouse relationship with the constituent.. + * @property bool $house_hold_copy_primary_contact_info Indicates whether + * indicates whether to copy the individual's primary contact information to + * the household.. + * @property string $job_category The the constituent's job category.. This + * code table can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/codetables/jobcategorycode/entries + + * @property string $career_level The the constituent's career level.. This + * code table can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/codetables/careerlevelcode/entries + + * @property string $address_info_source The the infomation source of the + * constituent's address .. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/infosourcecode/entries - * @property string $origin The origin. Available values are *user*, *web - * forms* + * @property string $organization_info_source The the infomation source of the + * related organization.. This code table can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/codetables/infosourcecode/entries + * @property string $title_2 The the constituent's second title.. This code + * table can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/codetables/titlecode/entries + * @property string $suffix_2 The the related individual's second suffix.. + * This code table can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/codetables/suffixcode/entries + * @property string $spouse_title_2 The the related individual's second + * title.. This code table can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/codetables/titlecode/entries + * @property string $spouse_suffix_2 The the constituent's second suffix.. + * This code table can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/codetables/suffixcode/entries + * @property bool $skip_adding_sites Indicates whether skip adding sites. + * @property int $constituent_type The the constituent's type.. Read-only in + * the SOAP API. + * @property bool $organization_primary_soft_credit_relationship_exists + * Indicates whether indicates whether to apply recognition credits from gifts + * made by the organization to the individual.. + * @property float $organization_primary_soft_credit_match_factor The the + * match percentage for recognition credits applied to the individual from + * gifts made by the organization.. + * @property bool $organization_reciprocal_soft_credit_relationship_exists + * Indicates whether apply recognition credits from gifts by the individual to + * the organization.. + * @property float $organization_reciprocal_soft_credit_match_factor The the + * match percentage for recognition credits applied to the organization from + * gifts made by the individual.. + * @property string $organization_primary_recognition_type The the recognition + * type of credits applied to the individual from the organization.. This code + * table can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/codetables/revenuerecognitiontypecode/entries + * @property string $organization_reciprocal_recognition_type The the + * recognition type of credits applied to the organization from the + * individual.. This code table can be queried at + * https://api.sky.blackbaud.com/alt-adnmg/codetables/revenuerecognitiontypecode/entries + * @property bool $opt_out_ads Indicates whether individual opted out of + * targeted advertising.. + * @property bool $opt_out_sale Indicates whether individual opted out of sale + * of personal data.. * @property bool $gpc Indicates whether gpc. * * @api @@ -96,24 +285,19 @@ class NewIndividual extends BaseComponent "last_name" => "string", "first_name" => "string", "middle_name" => "string", - "maiden_name" => "string", - "nickname" => "string", - "marital_status" => "string", "title" => "string", - "title_2" => "string", "suffix" => "string", - "suffix_2" => "string", - "gender" => "string", + "nickname" => "string", + "maiden_name" => "string", "birth_date" => "\Blackbaud\SKY\Altru\Constituent\Components\FuzzyDate", - "picture" => "string", - "picture_thumbnail" => "string", - "web_address" => "string", + "gender" => "string", + "marital_status" => "string", "address_type" => "string", "address_country" => "string", "address_block" => "string", "address_city" => "string", "address_state" => "string", - "address_postcode" => "string", + "address_post_code" => "string", "address_do_not_mail" => "bool", "address_do_not_mail_reason" => "string", "phone_type" => "string", @@ -121,21 +305,89 @@ class NewIndividual extends BaseComponent "email_address_type" => "string", "email_address" => "string", "skip_adding_security_groups" => "bool", - "zip_lookup_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\NewIndividualZiplookupcountries[]", - "job_title" => "string", - "omit_from_validation" => "bool", - "dpc" => "string", - "cart" => "string", - "lot" => "string", - "county" => "string", - "congressional_district" => "string", - "last_validation_attempt_date" => "string", - "validation_message" => "string", - "certification_data" => "int", - "validation_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\NewIndividualValidationcountries[]", + "existing_spouse" => "bool", + "spouse_id" => "string", + "spouse_last_name" => "string", + "spouse_first_name" => "string", + "spouse_middle_name" => "string", + "spouse_title" => "string", + "spouse_suffix" => "string", + "spouse_nick_name" => "string", + "spouse_maiden_name" => "string", + "spouse_birth_date" => "\Blackbaud\SKY\Altru\Constituent\Components\FuzzyDate", + "spouse_gender" => "string", + "spouse_relationship_type_code" => "string", + "spouse_reciprocal_type_code" => "string", + "spouse_start_date" => "string", + "copy_primary_information" => "bool", + "primary_soft_credit_relationship_exists" => "bool", + "primary_soft_credit_match_factor" => "float", + "reciprocal_soft_credit_relationship_exists" => "bool", + "reciprocal_soft_credit_match_factor" => "float", + "existing_organization" => "bool", + "organization_id" => "string", + "organization_name" => "string", + "organization_address_type" => "string", + "organization_country" => "string", + "organization_address_block" => "string", + "organization_city" => "string", + "organization_state" => "string", + "organization_post_code" => "string", + "organization_do_not_mail" => "bool", + "organization_do_not_mail_reason" => "string", + "organization_phone_type" => "string", + "organization_number" => "string", + "organization_relationship_type_code" => "string", + "organization_reciprocal_type_code" => "string", + "organization_start_date" => "string", + "organization_end_date" => "string", + "contact" => "bool", + "contact_type" => "string", + "primary_contact" => "bool", + "position" => "string", + "matching_gift_relationship" => "bool", + "reciprocal_recognition_type" => "string", + "primary_recognition_type" => "string", + "address_omit_from_validation" => "bool", + "address_dpc" => "string", + "address_cart" => "string", + "address_lot" => "string", + "address_county" => "string", + "address_congressional_district" => "string", + "address_last_validation_attempt_date" => "string", + "address_validation_message" => "string", + "address_certification_data" => "int", + "organization_omit_from_validation" => "bool", + "organization_dpc" => "string", + "organization_cart" => "string", + "organization_lot" => "string", + "organization_county" => "string", + "organization_congressional_district" => "string", + "organization_last_validation_attempt_date" => "string", + "organization_validation_message" => "string", + "organization_certification_data" => "int", + "validation_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\NewIndividualValidationCountries[]", + "zip_lookup_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\NewIndividualZipLookupCountries[]", + "spouse_relationship" => "bool", + "house_hold_copy_primary_contact_info" => "bool", + "job_category" => "string", + "career_level" => "string", + "address_info_source" => "string", + "organization_info_source" => "string", + "title_2" => "string", + "suffix_2" => "string", + "spouse_title_2" => "string", + "spouse_suffix_2" => "string", "skip_adding_sites" => "bool", - "info_source" => "string", - "origin" => "string", + "constituent_type" => "int", + "organization_primary_soft_credit_relationship_exists" => "bool", + "organization_primary_soft_credit_match_factor" => "float", + "organization_reciprocal_soft_credit_relationship_exists" => "bool", + "organization_reciprocal_soft_credit_match_factor" => "float", + "organization_primary_recognition_type" => "string", + "organization_reciprocal_recognition_type" => "string", + "opt_out_ads" => "bool", + "opt_out_sale" => "bool", "gpc" => "bool", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewIndividualValidationcountries.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewIndividualValidationcountries.php index 6d638f7d..1dd74aff 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewIndividualValidationcountries.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewIndividualValidationcountries.php @@ -5,14 +5,14 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * NewIndividualValidationcountries + * NewIndividualValidationCountries * * @property string $country_id countryid * @property bool $browsable browsable * * @api */ -class NewIndividualValidationcountries extends BaseComponent +class NewIndividualValidationCountries extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewIndividualZiplookupcountries.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewIndividualZiplookupcountries.php index 819ebac7..3d8dcd08 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewIndividualZiplookupcountries.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewIndividualZiplookupcountries.php @@ -5,14 +5,14 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * NewIndividualZiplookupcountries + * NewIndividualZipLookupCountries * * @property string $country_id countryid * @property string $country_name name * * @api */ -class NewIndividualZiplookupcountries extends BaseComponent +class NewIndividualZipLookupCountries extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewOrganization.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewOrganization.php index e8a9265a..50e5e7ee 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewOrganization.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewOrganization.php @@ -11,12 +11,12 @@ * @property string $web_address The website. * @property string $picture The image. * @property string $picture_thumbnail The picture thumbnail. - * @property string $industry The industry. This codetable can be queried at + * @property string $industry The industry. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/industrycode/entries * @property int $num_employees The no. of employees. * @property int $num_subsidiaries The no. of subsidiary orgs. * @property string $parent_corp_id The parent org. - * @property string $address_type The address type. This codetable can be + * @property string $address_type The address type. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/addresstypecode/entries @@ -24,49 +24,50 @@ * @property string $address_city The city. * @property string $address_state The state. This simple list can be queried * at - * https://api.sky.blackbaud.com/alt-adnmg/simplelists/7fa91401-596c-4f7c-936d-6e41683121d7?parameters=country\_id,{address\_country\_id}. + * https://api.sky.blackbaud.com/alt-adnmg/simplelists/7fa91401-596c-4f7c-936d-6e41683121d7?parameters=country\_id,{address\_countryid}. * @property string $address_postcode The zip. * @property string $address_country The country. This simple list can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/c9649672-353d-42e8-8c25-4d34bbabfbba. * @property bool $address_do_not_mail Indicates whether do not send mail to * this address. - * @property string $address_do_not_mail_reason The reason. This codetable can - * be queried at + * @property string $address_do_not_mail_reason The reason. This code table + * can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/donotmailreasoncode/entries - * @property string $phone_type The phone type. This codetable can be queried + * @property string $phone_type The phone type. This code table can be queried * at https://api.sky.blackbaud.com/alt-adnmg/codetables/phonetypecode/entries * @property string $phone_number The phone number. - * @property string $email_address_type The email type. This codetable can be + * @property string $email_address_type The email type. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/emailaddresstypecode/entries * @property string $email_address The email address. * @property bool $skip_adding_security_groups Indicates whether skip adding * security groups. - * @property \Blackbaud\SKY\Altru\Constituent\Components\NewOrganizationZiplookupcountries[] - * $zip_lookup_countries zip\_lookup\_countries + * @property \Blackbaud\SKY\Altru\Constituent\Components\NewOrganizationZipLookupCountries[] + * $zip_lookup_countries Zip lookup countries. * @property bool $omit_from_validation Indicates whether omit from * validation. * @property string $dpc The dpc. * @property string $cart The cart. * @property string $lot The lot. - * @property string $county The county. This codetable can be queried at + * @property string $county The county. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/countycode/entries * @property string $congressional_district The congressional district. This - * codetable can be queried at + * code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/congressionaldistrictcode/entries * @property string $last_validation_attempt_date The last validation attempt - * date.Uses the format YYYY-MM-DD. An example date: *2019-11-21*. + * date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: + * *1955-11-05T22:04:00*. * @property string $validation_message The validation message. * @property int $certification_data The certification data. - * @property \Blackbaud\SKY\Altru\Constituent\Components\NewOrganizationValidationcountries[] - * $validation_countries validation\_countries + * @property \Blackbaud\SKY\Altru\Constituent\Components\NewOrganizationValidationCountries[] + * $validation_countries Validation countries. * @property bool $is_primary Indicates whether this is a primary * organization. * @property bool $skip_adding_sites Indicates whether skip adding sites. - * @property string $info_source The information source. This codetable can be - * queried at + * @property string $info_source The information source. This code table can + * be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/infosourcecode/entries * * @api @@ -98,7 +99,7 @@ class NewOrganization extends BaseComponent "email_address_type" => "string", "email_address" => "string", "skip_adding_security_groups" => "bool", - "zip_lookup_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\NewOrganizationZiplookupcountries[]", + "zip_lookup_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\NewOrganizationZipLookupCountries[]", "omit_from_validation" => "bool", "dpc" => "string", "cart" => "string", @@ -108,7 +109,7 @@ class NewOrganization extends BaseComponent "last_validation_attempt_date" => "string", "validation_message" => "string", "certification_data" => "int", - "validation_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\NewOrganizationValidationcountries[]", + "validation_countries" => "\Blackbaud\SKY\Altru\Constituent\Components\NewOrganizationValidationCountries[]", "is_primary" => "bool", "skip_adding_sites" => "bool", "info_source" => "string", diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewOrganizationValidationcountries.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewOrganizationValidationcountries.php index b797287e..43ed35b5 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewOrganizationValidationcountries.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewOrganizationValidationcountries.php @@ -5,14 +5,14 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * NewOrganizationValidationcountries + * NewOrganizationValidationCountries * * @property string $country_id countryid * @property bool $browsable browsable * * @api */ -class NewOrganizationValidationcountries extends BaseComponent +class NewOrganizationValidationCountries extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewOrganizationZiplookupcountries.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewOrganizationZiplookupcountries.php index 8e66931f..c56a5808 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewOrganizationZiplookupcountries.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewOrganizationZiplookupcountries.php @@ -5,14 +5,14 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * NewOrganizationZiplookupcountries + * NewOrganizationZipLookupCountries * * @property string $country_id countryid * @property string $country_name name * * @api */ -class NewOrganizationZiplookupcountries extends BaseComponent +class NewOrganizationZipLookupCountries extends BaseComponent { /** * @var string[] $fields diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewRelationshipJobInfo.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewRelationshipJobInfo.php index 8db5af15..96eb1015 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewRelationshipJobInfo.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewRelationshipJobInfo.php @@ -7,26 +7,26 @@ /** * CreateRelationshipJobInfo * - * @property string $context_id The context id. + * @property string $context_id The context ID. * @property string $relationship The relationship. This simple list can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/simplelists/62083cb6-2a32-4d1d-aace-0ad288292ab7?parameters=constituentid,{context\_id}. * @property string $job_title The job title. - * @property string $career_level The career level. This codetable can be + * @property string $career_level The career level. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/careerlevelcode/entries - * @property string $job_category The category. This codetable can be queried + * @property string $job_category The category. This code table can be queried * at * https://api.sky.blackbaud.com/alt-adnmg/codetables/jobcategorycode/entries - * @property string $start_date The start date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $end_date The end date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $end_date The end date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $job_department The department. * @property string $job_division The division. - * @property string $job_schedule The schedule. This codetable can be queried + * @property string $job_schedule The schedule. This code table can be queried * at * https://api.sky.blackbaud.com/alt-adnmg/codetables/jobschedulecode/entries diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/NewTribute.php b/packages/altru-constituent/src/Altru/Constituent/Components/NewTribute.php index 4cfbfeba..9ec5ec59 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/NewTribute.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/NewTribute.php @@ -7,12 +7,12 @@ /** * CreateTribute * - * @property string $revenue_id The revenue id. + * @property string $revenue_id The revenue ID. * @property string $tribute_id The tribute. * @property float $amount The amount. * @property string $designation_id The default designation. * @property \Blackbaud\SKY\Altru\Constituent\Components\NewTributeSplits[] - * $splits splits + * $splits Splits. * @property bool $apply_default_designation Indicates whether apply default * designation to revenue. * @property bool $revenue_posted Indicates whether isrevenueposted. Read-only diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/Organization.php b/packages/altru-constituent/src/Altru/Constituent/Components/Organization.php index 602b4108..661784a9 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/Organization.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/Organization.php @@ -8,7 +8,7 @@ * GetOrganization * * @property string $organization_name The name. - * @property string $industry The industry. This codetable can be queried at + * @property string $industry The industry. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/industrycode/entries * @property int $num_employees The no. of employees. * @property int $num_subsidiaries The no. of subsidiary orgs. @@ -19,8 +19,8 @@ * @property string $web_address The website. * @property bool $is_primary Indicates whether this is a primary * organization. - * @property string $primary_address_id The primary address id. - * @property string $address_type The address type. This codetable can be + * @property string $primary_address_id The primary address ID. + * @property string $address_type The address type. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/addresstypecode/entries @@ -31,20 +31,20 @@ * @property string $address_city The city. * @property string $address_state The state. This simple list can be queried * at - * https://api.sky.blackbaud.com/alt-adnmg/simplelists/7fa91401-596c-4f7c-936d-6e41683121d7?parameters=country\_id,{address\_country\_id}. + * https://api.sky.blackbaud.com/alt-adnmg/simplelists/7fa91401-596c-4f7c-936d-6e41683121d7?parameters=country\_id,{address\_countryid}. * @property string $address_postcode The zip. * @property bool $address_do_not_mail Indicates whether do not send mail to * this address. - * @property string $address_do_not_mail_reason The reason. This codetable can - * be queried at + * @property string $address_do_not_mail_reason The reason. This code table + * can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/donotmailreasoncode/entries - * @property string $primary_phone_id The primary phone id. - * @property string $phone_type The phone type. This codetable can be queried + * @property string $primary_phone_id The primary phone ID. + * @property string $phone_type The phone type. This code table can be queried * at https://api.sky.blackbaud.com/alt-adnmg/codetables/phonetypecode/entries * @property string $phone_number The phone number. - * @property string $primary_email_address_id The primary email address id. - * @property string $email_address_type The email type. This codetable can be + * @property string $primary_email_address_id The primary email address ID. + * @property string $email_address_type The email type. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/emailaddresstypecode/entries * @property string $email_address The email address. diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/RelationshipJobInfo.php b/packages/altru-constituent/src/Altru/Constituent/Components/RelationshipJobInfo.php index a4d1ed87..74725dc4 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/RelationshipJobInfo.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/RelationshipJobInfo.php @@ -8,21 +8,21 @@ * GetRelationshipJobInfo * * @property string $job_title The job title. - * @property string $career_level The career level. This codetable can be + * @property string $career_level The career level. This code table can be * queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/careerlevelcode/entries - * @property string $job_category The category. This codetable can be queried + * @property string $job_category The category. This code table can be queried * at * https://api.sky.blackbaud.com/alt-adnmg/codetables/jobcategorycode/entries - * @property string $start_date The start date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $end_date The end date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $end_date The end date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $job_department The department. * @property string $job_division The division. - * @property string $job_schedule The schedule. This codetable can be queried + * @property string $job_schedule The schedule. This code table can be queried * at * https://api.sky.blackbaud.com/alt-adnmg/codetables/jobschedulecode/entries diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/RelationshipJobInfoListCollection.php b/packages/altru-constituent/src/Altru/Constituent/Components/RelationshipJobInfoListCollection.php index 8c798798..8253cac8 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/RelationshipJobInfoListCollection.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/RelationshipJobInfoListCollection.php @@ -5,16 +5,22 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. * @property \Blackbaud\SKY\Altru\Constituent\Components\RelationshipJobInfoListSummary[] * $value The set of items included in the response. This may be a subset of * the items in the collection. + * @property string $infinity_session Values for cookies related to the + * Infinity load balancer session. + * @property string $session_key Session key for paging provided by user in + * request query parameter. + * @property int $total_available_rows The number of total rows available. + * @property string $more_rows_range_key Key for accessing cached results on + * subsequent calls to this data list. + * @property bool $data_no_longer_available Indicates data is no longer + * available in the context of this session. * * @api */ @@ -26,5 +32,10 @@ class RelationshipJobInfoListCollection extends BaseComponent protected static array $fields = [ "count" => "int", "value" => "\Blackbaud\SKY\Altru\Constituent\Components\RelationshipJobInfoListSummary[]", + "infinity_session" => "string", + "session_key" => "string", + "total_available_rows" => "int", + "more_rows_range_key" => "string", + "data_no_longer_available" => "bool", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/RelationshipJobInfoListSummary.php b/packages/altru-constituent/src/Altru/Constituent/Components/RelationshipJobInfoListSummary.php index c145e24d..95146887 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/RelationshipJobInfoListSummary.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/RelationshipJobInfoListSummary.php @@ -5,19 +5,19 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ListRelationshipJobInfo + * ListRelationshipJobInfos * * @property string $relationship_set_id The relationshipsetid. - * @property string $id The id. + * @property string $id The ID. * @property string $reciprocal_id The reciprocalid. * @property string $name The name. * @property string $job_title The job title. * @property string $job_category The job category. * @property string $career_level The career level. - * @property string $start_date The start date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. - * @property string $end_date The end date.Uses the format YYYY-MM-DD. An - * example date: *2019-11-21*. + * @property string $start_date The start date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. + * @property string $end_date The end date. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property string $job_schedule The schedule. * @property string $job_department The department. * @property string $job_division The division. diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/StateListCollection.php b/packages/altru-constituent/src/Altru/Constituent/Components/StateListCollection.php index 58e199c9..4dc51323 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/StateListCollection.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/StateListCollection.php @@ -5,16 +5,22 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. * @property \Blackbaud\SKY\Altru\Constituent\Components\StateListSummary[] * $value The set of items included in the response. This may be a subset of * the items in the collection. + * @property string $infinity_session Values for cookies related to the + * Infinity load balancer session. + * @property string $session_key Session key for paging provided by user in + * request query parameter. + * @property int $total_available_rows The number of total rows available. + * @property string $more_rows_range_key Key for accessing cached results on + * subsequent calls to this data list. + * @property bool $data_no_longer_available Indicates data is no longer + * available in the context of this session. * * @api */ @@ -26,5 +32,10 @@ class StateListCollection extends BaseComponent protected static array $fields = [ "count" => "int", "value" => "\Blackbaud\SKY\Altru\Constituent\Components\StateListSummary[]", + "infinity_session" => "string", + "session_key" => "string", + "total_available_rows" => "int", + "more_rows_range_key" => "string", + "data_no_longer_available" => "bool", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/StateListSummary.php b/packages/altru-constituent/src/Altru/Constituent/Components/StateListSummary.php index 0e88ab80..c97e778c 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/StateListSummary.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/StateListSummary.php @@ -5,9 +5,9 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ListState + * ListStates * - * @property string $id The id. + * @property string $id The ID. * @property string $state The state. * @property string $abbreviation The abbreviation. * @property bool $active Indicates whether active. diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/TributeListCollection.php b/packages/altru-constituent/src/Altru/Constituent/Components/TributeListCollection.php index 65b1650c..30042fb5 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/TributeListCollection.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/TributeListCollection.php @@ -5,16 +5,22 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. * @property \Blackbaud\SKY\Altru\Constituent\Components\TributeListSummary[] * $value The set of items included in the response. This may be a subset of * the items in the collection. + * @property string $infinity_session Values for cookies related to the + * Infinity load balancer session. + * @property string $session_key Session key for paging provided by user in + * request query parameter. + * @property int $total_available_rows The number of total rows available. + * @property string $more_rows_range_key Key for accessing cached results on + * subsequent calls to this data list. + * @property bool $data_no_longer_available Indicates data is no longer + * available in the context of this session. * * @api */ @@ -26,5 +32,10 @@ class TributeListCollection extends BaseComponent protected static array $fields = [ "count" => "int", "value" => "\Blackbaud\SKY\Altru\Constituent\Components\TributeListSummary[]", + "infinity_session" => "string", + "session_key" => "string", + "total_available_rows" => "int", + "more_rows_range_key" => "string", + "data_no_longer_available" => "bool", ]; } diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/TributeListSummary.php b/packages/altru-constituent/src/Altru/Constituent/Components/TributeListSummary.php index 5b73f462..28b9abe0 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/TributeListSummary.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/TributeListSummary.php @@ -5,14 +5,14 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * ListTribute + * ListTributes * - * @property string $id The id. + * @property string $id The ID. * @property string $tribute_text The tribute text. * @property string $tribute_type The tribute type. * @property bool $active Indicates whether is active. - * @property string $date_created The date created.Uses the format YYYY-MM-DD. - * An example date: *2019-11-21*. + * @property string $date_created The date created. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property bool $tributee Indicates whether is tributee. * @property bool $acknowledgee Indicates whether is acknowledgee. * @property string $sites The sites. diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/TributeSearchCollection.php b/packages/altru-constituent/src/Altru/Constituent/Components/TributeSearchCollection.php index 45c3d11f..93e8afb5 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/TributeSearchCollection.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/TributeSearchCollection.php @@ -5,10 +5,7 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * Fetching data all at once quickly becomes unmanageable. The collection - * entity helps by returning paginated chunks of large data sets. This entity - * includes helpful metadata and properties to paginate and iterate through - * the data. + * A collection of items. Data lists can contain paginated results. * * @property int $count The number of items available for retrieval into the * collection after applying any request parameters. diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/TributeSearchSummary.php b/packages/altru-constituent/src/Altru/Constituent/Components/TributeSearchSummary.php index b2e748c0..e5ae6c17 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Components/TributeSearchSummary.php +++ b/packages/altru-constituent/src/Altru/Constituent/Components/TributeSearchSummary.php @@ -5,16 +5,16 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * SearchTribute + * SearchTributes * - * @property string $id The id. + * @property string $id The ID. * @property string $tribute_text The tribute text. * @property string $tributee_name The tributee. * @property string $tribute_type The tribute type. - * @property string $date_created The date created.Uses the format YYYY-MM-DD. - * An example date: *2019-11-21*. + * @property string $date_created The date created. Uses the format + * YYYY-MM-DDThh:mm:ss. An example date: *1955-11-05T22:04:00*. * @property bool $active Indicates whether is active. - * @property string $designation_id The default designation id. + * @property string $designation_id The default designation ID. * @property string $designation The default designation. * @property string $site_id The site. * diff --git a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentFundraiser.php b/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentFundraiser.php deleted file mode 100644 index f824ac8c..00000000 --- a/packages/altru-constituent/src/Altru/Constituent/Components/UpdateConstituentFundraiser.php +++ /dev/null @@ -1,26 +0,0 @@ - "string", - "date_to" => "string", - ]; -} diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Addresses.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Addresses.php index a92a5ce2..2e96dd28 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Addresses.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Addresses.php @@ -5,18 +5,18 @@ use Battis\OpenAPI\Client\BaseEndpoint; use Battis\OpenAPI\Client\Exceptions\ArgumentException; use Blackbaud\SKY\Altru\Constituent\Components\ConstituentAddress; +use Blackbaud\SKY\Altru\Constituent\Components\EditConstituentAddress; use Blackbaud\SKY\Altru\Constituent\Components\NewConstituentAddress; use Blackbaud\SKY\Altru\Constituent\Components\PostResponse; -use Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentAddress; use Blackbaud\SKY\Altru\Constituent\Endpoints\Addresses\Search; use Blackbaud\SKY\Altru\Constituent\Endpoints\Addresses\View; /** * Routing class for the subnamespace `Addresses` * + * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Addresses\View $view * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Addresses\Search * $search - * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Addresses\View $view * * @api */ @@ -32,23 +32,23 @@ class Addresses extends BaseEndpoint * $endpoints Routing subpaths */ protected array $endpoints = [ - "search" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Addresses\Search", "view" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Addresses\View", + "search" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Addresses\Search", ]; /** - * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Addresses\Search - * $_search + * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Addresses\View $_view */ - protected ?Search $_search = null; + protected ?View $_view = null; /** - * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Addresses\View $_view + * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Addresses\Search + * $_search */ - protected ?View $_view = null; + protected ?Search $_search = null; /** - * This dataform template is used to add an address. + * This operation is used to add an address. * * @param \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentAddress * $requestBody ConfigurationMessage object representing operation @@ -64,11 +64,11 @@ public function post(NewConstituentAddress $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } /** - * This dataform template is used to edit an address. + * This operation is used to edit an address. * * @param array{address_id: string} $params An associative array * - address_id: The address id. @@ -84,7 +84,7 @@ public function getByAddressId(array $params): ConstituentAddress { assert(isset($params['address_id']), new ArgumentException("Parameter `address_id` is required")); - return new ConstituentAddress($this->send("get", ["address_id" => $params['address_id']], [])); + return new ConstituentAddress($this->send("get", array_filter($params, fn($key) => in_array($key, ['address_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -104,15 +104,15 @@ public function deleteByAddressId(array $params): mixed { assert(isset($params['address_id']), new ArgumentException("Parameter `address_id` is required")); - return $this->send("delete", ["address_id" => $params['address_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['address_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** - * This dataform template is used to edit an address. + * This operation is used to edit an address. * * @param array{address_id: string} $params An associative array * - address_id: The address id. - * @param \Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentAddress + * @param \Blackbaud\SKY\Altru\Constituent\Components\EditConstituentAddress * $requestBody ConfigurationMessage object representing operation * intended to be created * @@ -122,11 +122,11 @@ public function deleteByAddressId(array $params): mixed * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required * parameters are not defined */ - public function patchOnAddressId(array $params, UpdateConstituentAddress $requestBody): mixed + public function patchOnAddressId(array $params, EditConstituentAddress $requestBody): mixed { assert(isset($params['address_id']), new ArgumentException("Parameter `address_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["address_id" => $params['address_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['address_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Addresses/Search.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Addresses/Search.php index d90ac540..214b55da 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Addresses/Search.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Addresses/Search.php @@ -58,16 +58,6 @@ public function list_(array $params): ConstituentAddressSearchCollection assert(isset($params['exact_match_only']), new ArgumentException("Parameter `exact_match_only` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); - return new ConstituentAddressSearchCollection($this->send("get", [], ["key_name" => $params['key_name'], - "first_name" => $params['first_name'], - "lookup_id" => $params['lookup_id'], - "address_block" => $params['address_block'], - "city" => $params['city'], - "state" => $params['state'], - "post_code" => $params['post_code'], - "country" => $params['country'], - "only_primary_address" => $params['only_primary_address'], - "exact_match_only" => $params['exact_match_only'], - "limit" => $params['limit']])); + return new ConstituentAddressSearchCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['key_name','first_name','lookup_id','address_block','city','state','post_code','country','only_primary_address','exact_match_only','limit']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Addresses/View.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Addresses/View.php index 80a04c11..198e6745 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Addresses/View.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Addresses/View.php @@ -17,7 +17,7 @@ class View extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/addresses/{address_id}/view"; /** - * This dataform template is used for viewing basic address information. + * This operation is used for viewing basic address inoperationation. * * @param array{address_id: string} $params An associative array * - address_id: The address id. @@ -33,6 +33,6 @@ public function getByAddressId(array $params): ConstituentAddressView { assert(isset($params['address_id']), new ArgumentException("Parameter `address_id` is required")); - return new ConstituentAddressView($this->send("get", ["address_id" => $params['address_id']], [])); + return new ConstituentAddressView($this->send("get", array_filter($params, fn($key) => in_array($key, ['address_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Alternatelookupids.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Alternatelookupids.php index 0874e46d..6e7afeac 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Alternatelookupids.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Alternatelookupids.php @@ -5,9 +5,9 @@ use Battis\OpenAPI\Client\BaseEndpoint; use Battis\OpenAPI\Client\Exceptions\ArgumentException; use Blackbaud\SKY\Altru\Constituent\Components\ConstituentAlternateLookupId; +use Blackbaud\SKY\Altru\Constituent\Components\EditConstituentAlternateLookupId; use Blackbaud\SKY\Altru\Constituent\Components\NewConstituentAlternateLookupId; use Blackbaud\SKY\Altru\Constituent\Components\PostResponse; -use Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentAlternateLookupId; /** * @api @@ -20,8 +20,7 @@ class Alternatelookupids extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/alternatelookupids/{alternate_lookup_id_id}"; /** - * This dataform template is used to add an alternate lookup ID for a - * constituent. + * This operation is used to add an alternate lookup id for a constituent. * * @param \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentAlternateLookupId * $requestBody ConfigurationMessage object representing operation @@ -37,12 +36,11 @@ public function post(NewConstituentAlternateLookupId $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } /** - * This dataform template is used to edit a constituent's alternate lookup - * ID. + * This operation is used to edit a constituent's alternate lookup id. * * @param array{alternate_lookup_id_id: string} $params An associative * array @@ -59,12 +57,12 @@ public function getByAlternateLookupIdId(array $params): ConstituentAlternateLoo { assert(isset($params['alternate_lookup_id_id']), new ArgumentException("Parameter `alternate_lookup_id_id` is required")); - return new ConstituentAlternateLookupId($this->send("get", ["alternate_lookup_id_id" => $params['alternate_lookup_id_id']], [])); + return new ConstituentAlternateLookupId($this->send("get", array_filter($params, fn($key) => in_array($key, ['alternate_lookup_id_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** * This record operation deletes the specified constituent alternate - * lookup ID record. + * lookup id record. * * @param array{alternate_lookup_id_id: string} $params An associative * array @@ -80,17 +78,16 @@ public function deleteByAlternateLookupIdId(array $params): mixed { assert(isset($params['alternate_lookup_id_id']), new ArgumentException("Parameter `alternate_lookup_id_id` is required")); - return $this->send("delete", ["alternate_lookup_id_id" => $params['alternate_lookup_id_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['alternate_lookup_id_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** - * This dataform template is used to edit a constituent's alternate lookup - * ID. + * This operation is used to edit a constituent's alternate lookup id. * * @param array{alternate_lookup_id_id: string} $params An associative * array * - alternate_lookup_id_id: The alternate lookup id id. - * @param \Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentAlternateLookupId + * @param \Blackbaud\SKY\Altru\Constituent\Components\EditConstituentAlternateLookupId * $requestBody ConfigurationMessage object representing operation * intended to be created * @@ -100,11 +97,11 @@ public function deleteByAlternateLookupIdId(array $params): mixed * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required * parameters are not defined */ - public function patchOnAlternateLookupIdId(array $params, UpdateConstituentAlternateLookupId $requestBody): mixed + public function patchOnAlternateLookupIdId(array $params, EditConstituentAlternateLookupId $requestBody): mixed { assert(isset($params['alternate_lookup_id_id']), new ArgumentException("Parameter `alternate_lookup_id_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["alternate_lookup_id_id" => $params['alternate_lookup_id_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['alternate_lookup_id_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituent/Constituentmemberships.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituent/Constituentmemberships.php index 9cb0bdce..908f4fa6 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituent/Constituentmemberships.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituent/Constituentmemberships.php @@ -19,10 +19,19 @@ class Constituentmemberships extends BaseEndpoint /** * Displays a list of memberships for a given constituent. * - * @param array{constituent_id: string, limit: int} $params An associative - * array + * @param array{constituent_id: string, limit: int, session_key: string, + * infinity_session: string, more_rows_range_key: string, start_row_index: + * int} $params An associative array * - constituent_id: The constituent id. * - limit: Limits the number of records to return. + * - session_key: A unique key provided by user for paging results. + * The same key will be returned in a successful response. + * - infinity_session: Values for cookies related to the Infinity load + * balancer session. + * - more_rows_range_key: Key for accessing cached results on + * subsequent calls to this data list. + * - start_row_index: Number of rows to skip,get result after these + * rows. * * @return \Blackbaud\SKY\Altru\Constituent\Components\ConstituentMembershipsListCollection * Returned when the operation succeeds. The response body contains a @@ -35,7 +44,11 @@ public function searchByConstituentId(array $params): ConstituentMembershipsList { assert(isset($params['constituent_id']), new ArgumentException("Parameter `constituent_id` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); + assert(isset($params['session_key']), new ArgumentException("Parameter `session_key` is required")); + assert(isset($params['infinity_session']), new ArgumentException("Parameter `infinity_session` is required")); + assert(isset($params['more_rows_range_key']), new ArgumentException("Parameter `more_rows_range_key` is required")); + assert(isset($params['start_row_index']), new ArgumentException("Parameter `start_row_index` is required")); - return new ConstituentMembershipsListCollection($this->send("get", ["constituent_id" => $params['constituent_id']], ["limit" => $params['limit']])); + return new ConstituentMembershipsListCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['limit','session_key','infinity_session','more_rows_range_key','start_row_index']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentappealresponses.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentappealresponses.php index cf36216f..e8f3adc9 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentappealresponses.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentappealresponses.php @@ -5,9 +5,9 @@ use Battis\OpenAPI\Client\BaseEndpoint; use Battis\OpenAPI\Client\Exceptions\ArgumentException; use Blackbaud\SKY\Altru\Constituent\Components\ConstituentAppealResponse; +use Blackbaud\SKY\Altru\Constituent\Components\EditConstituentAppealResponse; use Blackbaud\SKY\Altru\Constituent\Components\NewConstituentAppealResponse; use Blackbaud\SKY\Altru\Constituent\Components\PostResponse; -use Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentAppealResponse; /** * @api @@ -20,7 +20,7 @@ class Constituentappealresponses extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/constituentappealresponses/{constituent_appeal_id}"; /** - * This form is used to add and edit constituent appeal responses. + * This operation is used to add and edit constituent appeal responses. * * @param array{constituent_appeal_id: string} $params An associative * array @@ -37,16 +37,16 @@ public function getByConstituentAppealId(array $params): ConstituentAppealRespon { assert(isset($params['constituent_appeal_id']), new ArgumentException("Parameter `constituent_appeal_id` is required")); - return new ConstituentAppealResponse($this->send("get", ["constituent_appeal_id" => $params['constituent_appeal_id']], [])); + return new ConstituentAppealResponse($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_appeal_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** - * This form is used to add and edit constituent appeal responses. + * This operation is used to add and edit constituent appeal responses. * * @param array{constituent_appeal_id: string} $params An associative * array * - constituent_appeal_id: The constituent appeal id. - * @param \Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentAppealResponse + * @param \Blackbaud\SKY\Altru\Constituent\Components\EditConstituentAppealResponse * $requestBody ConfigurationMessage object representing operation * intended to be created * @@ -56,12 +56,12 @@ public function getByConstituentAppealId(array $params): ConstituentAppealRespon * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required * parameters are not defined */ - public function patchOnConstituentAppealId(array $params, UpdateConstituentAppealResponse $requestBody): mixed + public function patchOnConstituentAppealId(array $params, EditConstituentAppealResponse $requestBody): mixed { assert(isset($params['constituent_appeal_id']), new ArgumentException("Parameter `constituent_appeal_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["constituent_appeal_id" => $params['constituent_appeal_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['constituent_appeal_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -81,6 +81,6 @@ public function post(NewConstituentAppealResponse $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentappeals.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentappeals.php index cb772ec0..66609661 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentappeals.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentappeals.php @@ -5,9 +5,9 @@ use Battis\OpenAPI\Client\BaseEndpoint; use Battis\OpenAPI\Client\Exceptions\ArgumentException; use Blackbaud\SKY\Altru\Constituent\Components\ConstituentAppeal; +use Blackbaud\SKY\Altru\Constituent\Components\EditConstituentAppeal; use Blackbaud\SKY\Altru\Constituent\Components\NewConstituentAppeal; use Blackbaud\SKY\Altru\Constituent\Components\PostResponse; -use Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentAppeal; use Blackbaud\SKY\Altru\Constituent\Endpoints\Constituentappeals\Appeals; /** @@ -40,7 +40,7 @@ class Constituentappeals extends BaseEndpoint protected ?Appeals $_appeals = null; /** - * Data form for adding a Constituent Appeal record. + * Operation for adding a constituent appeal record. * * @param \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentAppeal * $requestBody ConfigurationMessage object representing operation @@ -56,11 +56,11 @@ public function post(NewConstituentAppeal $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } /** - * Data form for editing a Constituent Appeal record. + * Operation for editing a constituent appeal record. * * @param array{constituent_appeal_id: string} $params An associative * array @@ -77,12 +77,12 @@ public function getByConstituentAppealId(array $params): ConstituentAppeal { assert(isset($params['constituent_appeal_id']), new ArgumentException("Parameter `constituent_appeal_id` is required")); - return new ConstituentAppeal($this->send("get", ["constituent_appeal_id" => $params['constituent_appeal_id']], [])); + return new ConstituentAppeal($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_appeal_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** - * This delete method handles the basic deletion rules for a Constituent - * Appeal. + * This delete method handles the basic deletion rules for a constituent + * appeal. * * @param array{constituent_appeal_id: string} $params An associative * array @@ -98,16 +98,16 @@ public function deleteByConstituentAppealId(array $params): mixed { assert(isset($params['constituent_appeal_id']), new ArgumentException("Parameter `constituent_appeal_id` is required")); - return $this->send("delete", ["constituent_appeal_id" => $params['constituent_appeal_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['constituent_appeal_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** - * Data form for editing a Constituent Appeal record. + * Operation for editing a constituent appeal record. * * @param array{constituent_appeal_id: string} $params An associative * array * - constituent_appeal_id: The constituent appeal id. - * @param \Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentAppeal + * @param \Blackbaud\SKY\Altru\Constituent\Components\EditConstituentAppeal * $requestBody ConfigurationMessage object representing operation * intended to be created * @@ -117,11 +117,11 @@ public function deleteByConstituentAppealId(array $params): mixed * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required * parameters are not defined */ - public function patchOnConstituentAppealId(array $params, UpdateConstituentAppeal $requestBody): mixed + public function patchOnConstituentAppealId(array $params, EditConstituentAppeal $requestBody): mixed { assert(isset($params['constituent_appeal_id']), new ArgumentException("Parameter `constituent_appeal_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["constituent_appeal_id" => $params['constituent_appeal_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['constituent_appeal_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentappeals/Appeals.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentappeals/Appeals.php index 599791af..164bbfae 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentappeals/Appeals.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentappeals/Appeals.php @@ -19,10 +19,19 @@ class Appeals extends BaseEndpoint /** * Returns a list of appeals sent to this constituent. * - * @param array{constituent_id: string, limit: int} $params An associative - * array + * @param array{constituent_id: string, limit: int, session_key: string, + * infinity_session: string, more_rows_range_key: string, start_row_index: + * int} $params An associative array * - constituent_id: The constituent id. * - limit: Limits the number of records to return. + * - session_key: A unique key provided by user for paging results. + * The same key will be returned in a successful response. + * - infinity_session: Values for cookies related to the Infinity load + * balancer session. + * - more_rows_range_key: Key for accessing cached results on + * subsequent calls to this data list. + * - start_row_index: Number of rows to skip,get result after these + * rows. * * @return \Blackbaud\SKY\Altru\Constituent\Components\ConstituentAppealListCollection * Returned when the operation succeeds. The response body contains a @@ -35,7 +44,11 @@ public function searchByConstituentId(array $params): ConstituentAppealListColle { assert(isset($params['constituent_id']), new ArgumentException("Parameter `constituent_id` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); + assert(isset($params['session_key']), new ArgumentException("Parameter `session_key` is required")); + assert(isset($params['infinity_session']), new ArgumentException("Parameter `infinity_session` is required")); + assert(isset($params['more_rows_range_key']), new ArgumentException("Parameter `more_rows_range_key` is required")); + assert(isset($params['start_row_index']), new ArgumentException("Parameter `start_row_index` is required")); - return new ConstituentAppealListCollection($this->send("get", ["constituent_id" => $params['constituent_id']], ["limit" => $params['limit']])); + return new ConstituentAppealListCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['limit','session_key','infinity_session','more_rows_range_key','start_row_index']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentattributes.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentattributes.php index c9f475b2..d1c9eb4f 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentattributes.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentattributes.php @@ -5,9 +5,9 @@ use Battis\OpenAPI\Client\BaseEndpoint; use Battis\OpenAPI\Client\Exceptions\ArgumentException; use Blackbaud\SKY\Altru\Constituent\Components\ConstituentAttribute; +use Blackbaud\SKY\Altru\Constituent\Components\EditConstituentAttribute; use Blackbaud\SKY\Altru\Constituent\Components\NewConstituentAttribute; use Blackbaud\SKY\Altru\Constituent\Components\PostResponse; -use Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentAttribute; /** * @api @@ -36,7 +36,7 @@ public function post(NewConstituentAttribute $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } /** @@ -57,7 +57,7 @@ public function getByConstituentAttributeId(array $params): ConstituentAttribute { assert(isset($params['constituent_attribute_id']), new ArgumentException("Parameter `constituent_attribute_id` is required")); - return new ConstituentAttribute($this->send("get", ["constituent_attribute_id" => $params['constituent_attribute_id']], [])); + return new ConstituentAttribute($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_attribute_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -77,7 +77,7 @@ public function deleteByConstituentAttributeId(array $params): mixed { assert(isset($params['constituent_attribute_id']), new ArgumentException("Parameter `constituent_attribute_id` is required")); - return $this->send("delete", ["constituent_attribute_id" => $params['constituent_attribute_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['constituent_attribute_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** @@ -86,7 +86,7 @@ public function deleteByConstituentAttributeId(array $params): mixed * @param array{constituent_attribute_id: string} $params An associative * array * - constituent_attribute_id: The constituent attribute id. - * @param \Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentAttribute + * @param \Blackbaud\SKY\Altru\Constituent\Components\EditConstituentAttribute * $requestBody ConfigurationMessage object representing operation * intended to be created * @@ -96,11 +96,11 @@ public function deleteByConstituentAttributeId(array $params): mixed * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required * parameters are not defined */ - public function patchOnConstituentAttributeId(array $params, UpdateConstituentAttribute $requestBody): mixed + public function patchOnConstituentAttributeId(array $params, EditConstituentAttribute $requestBody): mixed { assert(isset($params['constituent_attribute_id']), new ArgumentException("Parameter `constituent_attribute_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["constituent_attribute_id" => $params['constituent_attribute_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['constituent_attribute_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentcorrespondencecodes.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentcorrespondencecodes.php index e9f399b5..ac1bdb28 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentcorrespondencecodes.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentcorrespondencecodes.php @@ -5,9 +5,9 @@ use Battis\OpenAPI\Client\BaseEndpoint; use Battis\OpenAPI\Client\Exceptions\ArgumentException; use Blackbaud\SKY\Altru\Constituent\Components\ConstituentCorrespondenceCode; +use Blackbaud\SKY\Altru\Constituent\Components\EditConstituentCorrespondenceCode; use Blackbaud\SKY\Altru\Constituent\Components\NewConstituentCorrespondenceCode; use Blackbaud\SKY\Altru\Constituent\Components\PostResponse; -use Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentCorrespondenceCode; use Blackbaud\SKY\Altru\Constituent\Endpoints\Constituentcorrespondencecodes\Response; /** @@ -40,8 +40,7 @@ class Constituentcorrespondencecodes extends BaseEndpoint protected ?Response $_response = null; /** - * This dataform template is used to add correspondence record for a - * constituent. + * This operation is used to add correspondence record for a constituent. * * @param \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentCorrespondenceCode * $requestBody ConfigurationMessage object representing operation @@ -57,11 +56,11 @@ public function post(NewConstituentCorrespondenceCode $requestBody): PostRespons { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } /** - * This form is for editing constituent correspondence. + * This operation is for editing constituent correspondence. * * @param array{constituent_correspondence_id: string} $params An * associative array @@ -78,7 +77,7 @@ public function getByConstituentCorrespondenceId(array $params): ConstituentCorr { assert(isset($params['constituent_correspondence_id']), new ArgumentException("Parameter `constituent_correspondence_id` is required")); - return new ConstituentCorrespondenceCode($this->send("get", ["constituent_correspondence_id" => $params['constituent_correspondence_id']], [])); + return new ConstituentCorrespondenceCode($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_correspondence_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -98,16 +97,16 @@ public function deleteByConstituentCorrespondenceId(array $params): mixed { assert(isset($params['constituent_correspondence_id']), new ArgumentException("Parameter `constituent_correspondence_id` is required")); - return $this->send("delete", ["constituent_correspondence_id" => $params['constituent_correspondence_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['constituent_correspondence_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** - * This form is for editing constituent correspondence. + * This operation is for editing constituent correspondence. * * @param array{constituent_correspondence_id: string} $params An * associative array * - constituent_correspondence_id: The constituent correspondence id. - * @param \Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentCorrespondenceCode + * @param \Blackbaud\SKY\Altru\Constituent\Components\EditConstituentCorrespondenceCode * $requestBody ConfigurationMessage object representing operation * intended to be created * @@ -117,11 +116,11 @@ public function deleteByConstituentCorrespondenceId(array $params): mixed * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required * parameters are not defined */ - public function patchOnConstituentCorrespondenceId(array $params, UpdateConstituentCorrespondenceCode $requestBody): mixed + public function patchOnConstituentCorrespondenceId(array $params, EditConstituentCorrespondenceCode $requestBody): mixed { assert(isset($params['constituent_correspondence_id']), new ArgumentException("Parameter `constituent_correspondence_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["constituent_correspondence_id" => $params['constituent_correspondence_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['constituent_correspondence_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentcorrespondencecodes/Response.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentcorrespondencecodes/Response.php index 26cd171f..76674f9f 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentcorrespondencecodes/Response.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentcorrespondencecodes/Response.php @@ -4,8 +4,8 @@ use Battis\OpenAPI\Client\BaseEndpoint; use Battis\OpenAPI\Client\Exceptions\ArgumentException; -use Blackbaud\SKY\Altru\Constituent\Components\ConstituentCorrespondenceCode; -use Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentCorrespondenceCode; +use Blackbaud\SKY\Altru\Constituent\Components\ConstituentCorrespondenceCodeResponse; +use Blackbaud\SKY\Altru\Constituent\Components\EditConstituentCorrespondenceCodeResponse; /** * @api @@ -18,33 +18,35 @@ class Response extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/constituentcorrespondencecodes/{constituent_correspondence_id}/response"; /** - * This form is used to add and edit constituent correspondence responses. + * This operation is used to add and edit constituent correspondence + * responses. * * @param array{constituent_correspondence_id: string} $params An * associative array * - constituent_correspondence_id: The constituent correspondence id. * - * @return \Blackbaud\SKY\Altru\Constituent\Components\ConstituentCorrespondenceCode + * @return \Blackbaud\SKY\Altru\Constituent\Components\ConstituentCorrespondenceCodeResponse * Returned when the operation succeeds. The response body contains the * specified resource. * * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required * parameters are not defined */ - public function getByConstituentCorrespondenceId(array $params): ConstituentCorrespondenceCode + public function getByConstituentCorrespondenceId(array $params): ConstituentCorrespondenceCodeResponse { assert(isset($params['constituent_correspondence_id']), new ArgumentException("Parameter `constituent_correspondence_id` is required")); - return new ConstituentCorrespondenceCode($this->send("get", ["constituent_correspondence_id" => $params['constituent_correspondence_id']], [])); + return new ConstituentCorrespondenceCodeResponse($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_correspondence_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** - * This form is used to add and edit constituent correspondence responses. + * This operation is used to add and edit constituent correspondence + * responses. * * @param array{constituent_correspondence_id: string} $params An * associative array * - constituent_correspondence_id: The constituent correspondence id. - * @param \Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentCorrespondenceCode + * @param \Blackbaud\SKY\Altru\Constituent\Components\EditConstituentCorrespondenceCodeResponse * $requestBody ConfigurationMessage object representing operation * intended to be created * @@ -54,11 +56,11 @@ public function getByConstituentCorrespondenceId(array $params): ConstituentCorr * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required * parameters are not defined */ - public function patchOnConstituentCorrespondenceId(array $params, UpdateConstituentCorrespondenceCode $requestBody): mixed + public function patchOnConstituentCorrespondenceId(array $params, EditConstituentCorrespondenceCodeResponse $requestBody): mixed { assert(isset($params['constituent_correspondence_id']), new ArgumentException("Parameter `constituent_correspondence_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["constituent_correspondence_id" => $params['constituent_correspondence_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['constituent_correspondence_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentinactivityreasoncodes.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentinactivityreasoncodes.php index c0e761dc..28408440 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentinactivityreasoncodes.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentinactivityreasoncodes.php @@ -19,10 +19,19 @@ class Constituentinactivityreasoncodes extends BaseEndpoint /** * Returns a list of reason codes. * - * @param array{include_inactive: bool, limit: int} $params An associative - * array + * @param array{include_inactive: bool, limit: int, session_key: string, + * infinity_session: string, more_rows_range_key: string, start_row_index: + * int} $params An associative array * - include_inactive: include inactive * - limit: Limits the number of records to return. + * - session_key: A unique key provided by user for paging results. + * The same key will be returned in a successful response. + * - infinity_session: Values for cookies related to the Infinity load + * balancer session. + * - more_rows_range_key: Key for accessing cached results on + * subsequent calls to this data list. + * - start_row_index: Number of rows to skip,get result after these + * rows. * * @return \Blackbaud\SKY\Altru\Constituent\Components\ConstituentInactivityReasonCodesListCollection * Returned when the operation succeeds. The response body contains a @@ -35,8 +44,11 @@ public function list_(array $params): ConstituentInactivityReasonCodesListCollec { assert(isset($params['include_inactive']), new ArgumentException("Parameter `include_inactive` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); + assert(isset($params['session_key']), new ArgumentException("Parameter `session_key` is required")); + assert(isset($params['infinity_session']), new ArgumentException("Parameter `infinity_session` is required")); + assert(isset($params['more_rows_range_key']), new ArgumentException("Parameter `more_rows_range_key` is required")); + assert(isset($params['start_row_index']), new ArgumentException("Parameter `start_row_index` is required")); - return new ConstituentInactivityReasonCodesListCollection($this->send("get", [], ["include_inactive" => $params['include_inactive'], - "limit" => $params['limit']])); + return new ConstituentInactivityReasonCodesListCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['include_inactive','limit','session_key','infinity_session','more_rows_range_key','start_row_index']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentmergeconfiguration.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentmergeconfiguration.php index 86cd0aa5..53dc6cc8 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentmergeconfiguration.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentmergeconfiguration.php @@ -20,8 +20,18 @@ class Constituentmergeconfiguration extends BaseEndpoint * List of available merge configurations that can be used with the * constituent merge process * - * @param array{limit: int} $params An associative array + * @param array{limit: int, session_key: string, infinity_session: string, + * more_rows_range_key: string, start_row_index: int} $params An + * associative array * - limit: Limits the number of records to return. + * - session_key: A unique key provided by user for paging results. + * The same key will be returned in a successful response. + * - infinity_session: Values for cookies related to the Infinity load + * balancer session. + * - more_rows_range_key: Key for accessing cached results on + * subsequent calls to this data list. + * - start_row_index: Number of rows to skip,get result after these + * rows. * * @return \Blackbaud\SKY\Altru\Constituent\Components\ConstituentMergeListCollection * Returned when the operation succeeds. The response body contains a @@ -33,7 +43,11 @@ class Constituentmergeconfiguration extends BaseEndpoint public function list_(array $params): ConstituentMergeListCollection { assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); + assert(isset($params['session_key']), new ArgumentException("Parameter `session_key` is required")); + assert(isset($params['infinity_session']), new ArgumentException("Parameter `infinity_session` is required")); + assert(isset($params['more_rows_range_key']), new ArgumentException("Parameter `more_rows_range_key` is required")); + assert(isset($params['start_row_index']), new ArgumentException("Parameter `start_row_index` is required")); - return new ConstituentMergeListCollection($this->send("get", [], ["limit" => $params['limit']])); + return new ConstituentMergeListCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['limit','session_key','infinity_session','more_rows_range_key','start_row_index']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentnotes.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentnotes.php index 5a0a3764..d45e2f59 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentnotes.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentnotes.php @@ -4,9 +4,9 @@ use Battis\OpenAPI\Client\BaseEndpoint; use Battis\OpenAPI\Client\Exceptions\ArgumentException; +use Blackbaud\SKY\Altru\Constituent\Components\EditConstituentNote; use Blackbaud\SKY\Altru\Constituent\Components\NewConstituentNote; use Blackbaud\SKY\Altru\Constituent\Components\PostResponse; -use Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentNote; use Blackbaud\SKY\Altru\Constituent\Endpoints\Constituentnotes\View; /** @@ -39,7 +39,7 @@ class Constituentnotes extends BaseEndpoint protected ?View $_view = null; /** - * This dataform template is used to add a constituent note. + * This operation is used to add a constituent note. * * @param \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentNote * $requestBody ConfigurationMessage object representing operation @@ -55,7 +55,7 @@ public function post(NewConstituentNote $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } /** @@ -75,15 +75,15 @@ public function deleteByConstituentNoteId(array $params): mixed { assert(isset($params['constituent_note_id']), new ArgumentException("Parameter `constituent_note_id` is required")); - return $this->send("delete", ["constituent_note_id" => $params['constituent_note_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['constituent_note_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** - * This form is for editing a given constituent's note. + * This operation is for editing a given constituent's note. * * @param array{constituent_note_id: string} $params An associative array * - constituent_note_id: The constituent note id. - * @param \Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentNote + * @param \Blackbaud\SKY\Altru\Constituent\Components\EditConstituentNote * $requestBody ConfigurationMessage object representing operation * intended to be created * @@ -93,11 +93,11 @@ public function deleteByConstituentNoteId(array $params): mixed * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required * parameters are not defined */ - public function patchOnConstituentNoteId(array $params, UpdateConstituentNote $requestBody): mixed + public function patchOnConstituentNoteId(array $params, EditConstituentNote $requestBody): mixed { assert(isset($params['constituent_note_id']), new ArgumentException("Parameter `constituent_note_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["constituent_note_id" => $params['constituent_note_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['constituent_note_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentnotes/View.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentnotes/View.php index 8f83d3de..d184941d 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentnotes/View.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituentnotes/View.php @@ -17,7 +17,7 @@ class View extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/constituentnotes/{constituent_note_id}/view"; /** - * This dataform template displays a constituent note. + * This operation displays a constituent note. * * @param array{constituent_note_id: string} $params An associative array * - constituent_note_id: The constituent note id. @@ -33,6 +33,6 @@ public function getByConstituentNoteId(array $params): ConstituentNoteView { assert(isset($params['constituent_note_id']), new ArgumentException("Parameter `constituent_note_id` is required")); - return new ConstituentNoteView($this->send("get", ["constituent_note_id" => $params['constituent_note_id']], [])); + return new ConstituentNoteView($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_note_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents.php index eeda7a04..23ed53f4 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents.php @@ -29,44 +29,44 @@ /** * Routing class for the subnamespace `Constituents` * - * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Addresses - * $addresses - * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Alternatelookupids - * $alternatelookupids - * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Emailaddresses - * $emailaddresses - * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Phones - * $phones - * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Solicitcodes - * $solicitcodes * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\View * $view - * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Constituentattributelist - * $constituentattributelist - * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Contactinformationemailaddress - * $contactinformationemailaddress - * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Contactinformationphone - * $contactinformationphone * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Patrondata * $patrondata * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Patronorders * $patronorders - * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Search - * $search * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Contactview * $contactview - * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Tributes - * $tributes - * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Fundraisersearch - * $fundraisersearch * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Profilepicture * $profilepicture + * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Addresses + * $addresses + * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Alternatelookupids + * $alternatelookupids + * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Constituentattributelist + * $constituentattributelist * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Constituentduplicatematch * $constituentduplicatematch + * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Emailaddresses + * $emailaddresses + * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Phones + * $phones + * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Solicitcodes + * $solicitcodes * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Educationalhistories * $educationalhistories * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Relationshipjobsinfo * $relationshipjobsinfo + * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Tributes + * $tributes + * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Fundraisersearch + * $fundraisersearch + * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Search + * $search + * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Contactinformationemailaddress + * $contactinformationemailaddress + * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Contactinformationphone + * $contactinformationphone * * @api */ @@ -82,62 +82,68 @@ class Constituents extends BaseEndpoint * $endpoints Routing subpaths */ protected array $endpoints = [ - "addresses" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Addresses", - "alternatelookupids" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Alternatelookupids", - "emailaddresses" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Emailaddresses", - "phones" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Phones", - "solicitcodes" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Solicitcodes", "view" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\View", - "constituentattributelist" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Constituentattributelist", - "contactinformationemailaddress" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Contactinformationemailaddress", - "contactinformationphone" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Contactinformationphone", "patrondata" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Patrondata", "patronorders" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Patronorders", - "search" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Search", "contactview" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Contactview", - "tributes" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Tributes", - "fundraisersearch" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Fundraisersearch", "profilepicture" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Profilepicture", + "addresses" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Addresses", + "alternatelookupids" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Alternatelookupids", + "constituentattributelist" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Constituentattributelist", "constituentduplicatematch" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Constituentduplicatematch", + "emailaddresses" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Emailaddresses", + "phones" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Phones", + "solicitcodes" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Solicitcodes", "educationalhistories" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Educationalhistories", "relationshipjobsinfo" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Relationshipjobsinfo", + "tributes" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Tributes", + "fundraisersearch" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Fundraisersearch", + "search" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Search", + "contactinformationemailaddress" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Contactinformationemailaddress", + "contactinformationphone" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Contactinformationphone", ]; /** - * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Addresses - * $_addresses + * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\View + * $_view */ - protected ?Addresses $_addresses = null; + protected ?View $_view = null; /** - * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Alternatelookupids - * $_alternatelookupids + * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Patrondata + * $_patrondata */ - protected ?Alternatelookupids $_alternatelookupids = null; + protected ?Patrondata $_patrondata = null; /** - * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Emailaddresses - * $_emailaddresses + * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Patronorders + * $_patronorders */ - protected ?Emailaddresses $_emailaddresses = null; + protected ?Patronorders $_patronorders = null; /** - * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Phones - * $_phones + * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Contactview + * $_contactview */ - protected ?Phones $_phones = null; + protected ?Contactview $_contactview = null; /** - * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Solicitcodes - * $_solicitcodes + * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Profilepicture + * $_profilepicture */ - protected ?Solicitcodes $_solicitcodes = null; + protected ?Profilepicture $_profilepicture = null; /** - * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\View - * $_view + * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Addresses + * $_addresses */ - protected ?View $_view = null; + protected ?Addresses $_addresses = null; + + /** + * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Alternatelookupids + * $_alternatelookupids + */ + protected ?Alternatelookupids $_alternatelookupids = null; /** * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Constituentattributelist @@ -146,40 +152,40 @@ class Constituents extends BaseEndpoint protected ?Constituentattributelist $_constituentattributelist = null; /** - * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Contactinformationemailaddress - * $_contactinformationemailaddress + * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Constituentduplicatematch + * $_constituentduplicatematch */ - protected ?Contactinformationemailaddress $_contactinformationemailaddress = null; + protected ?Constituentduplicatematch $_constituentduplicatematch = null; /** - * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Contactinformationphone - * $_contactinformationphone + * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Emailaddresses + * $_emailaddresses */ - protected ?Contactinformationphone $_contactinformationphone = null; + protected ?Emailaddresses $_emailaddresses = null; /** - * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Patrondata - * $_patrondata + * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Phones + * $_phones */ - protected ?Patrondata $_patrondata = null; + protected ?Phones $_phones = null; /** - * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Patronorders - * $_patronorders + * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Solicitcodes + * $_solicitcodes */ - protected ?Patronorders $_patronorders = null; + protected ?Solicitcodes $_solicitcodes = null; /** - * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Search - * $_search + * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Educationalhistories + * $_educationalhistories */ - protected ?Search $_search = null; + protected ?Educationalhistories $_educationalhistories = null; /** - * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Contactview - * $_contactview + * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Relationshipjobsinfo + * $_relationshipjobsinfo */ - protected ?Contactview $_contactview = null; + protected ?Relationshipjobsinfo $_relationshipjobsinfo = null; /** * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Tributes @@ -194,28 +200,22 @@ class Constituents extends BaseEndpoint protected ?Fundraisersearch $_fundraisersearch = null; /** - * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Profilepicture - * $_profilepicture - */ - protected ?Profilepicture $_profilepicture = null; - - /** - * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Constituentduplicatematch - * $_constituentduplicatematch + * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Search + * $_search */ - protected ?Constituentduplicatematch $_constituentduplicatematch = null; + protected ?Search $_search = null; /** - * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Educationalhistories - * $_educationalhistories + * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Contactinformationemailaddress + * $_contactinformationemailaddress */ - protected ?Educationalhistories $_educationalhistories = null; + protected ?Contactinformationemailaddress $_contactinformationemailaddress = null; /** - * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Relationshipjobsinfo - * $_relationshipjobsinfo + * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Constituents\Contactinformationphone + * $_contactinformationphone */ - protected ?Relationshipjobsinfo $_relationshipjobsinfo = null; + protected ?Contactinformationphone $_contactinformationphone = null; /** * This deletion handles only the basic deletion rules for a constituent. @@ -233,11 +233,11 @@ public function deleteByConstituentId(array $params): mixed { assert(isset($params['constituent_id']), new ArgumentException("Parameter `constituent_id` is required")); - return $this->send("delete", ["constituent_id" => $params['constituent_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** - * This dataform template is used to add an individual constituent, + * This operation is used to add an individual constituent, * spouse(optional), and business(optional). * * @param \Blackbaud\SKY\Altru\Constituent\Components\NewConstituent @@ -254,6 +254,6 @@ public function post(NewConstituent $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Addresses.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Addresses.php index 0a2fbbf0..c62b18be 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Addresses.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Addresses.php @@ -17,14 +17,23 @@ class Addresses extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/constituents/{constituent_id}/addresses"; /** - * This datalist returns all address contact information for a + * This operation returns all address contact inoperationation for a * constituent. * - * @param array{constituent_id: string, include_former: bool, limit: int} - * $params An associative array + * @param array{constituent_id: string, include_former: bool, limit: int, + * session_key: string, infinity_session: string, more_rows_range_key: + * string, start_row_index: int} $params An associative array * - constituent_id: The constituent id. * - include_former: show former contact information * - limit: Limits the number of records to return. + * - session_key: A unique key provided by user for paging results. + * The same key will be returned in a successful response. + * - infinity_session: Values for cookies related to the Infinity load + * balancer session. + * - more_rows_range_key: Key for accessing cached results on + * subsequent calls to this data list. + * - start_row_index: Number of rows to skip,get result after these + * rows. * * @return \Blackbaud\SKY\Altru\Constituent\Components\ConstituentAddressListCollection * Returned when the operation succeeds. The response body contains a @@ -38,8 +47,11 @@ public function searchByConstituentId(array $params): ConstituentAddressListColl assert(isset($params['constituent_id']), new ArgumentException("Parameter `constituent_id` is required")); assert(isset($params['include_former']), new ArgumentException("Parameter `include_former` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); + assert(isset($params['session_key']), new ArgumentException("Parameter `session_key` is required")); + assert(isset($params['infinity_session']), new ArgumentException("Parameter `infinity_session` is required")); + assert(isset($params['more_rows_range_key']), new ArgumentException("Parameter `more_rows_range_key` is required")); + assert(isset($params['start_row_index']), new ArgumentException("Parameter `start_row_index` is required")); - return new ConstituentAddressListCollection($this->send("get", ["constituent_id" => $params['constituent_id']], ["include_former" => $params['include_former'], - "limit" => $params['limit']])); + return new ConstituentAddressListCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['include_former','limit','session_key','infinity_session','more_rows_range_key','start_row_index']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Alternatelookupids.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Alternatelookupids.php index 8b64f4d3..21869e27 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Alternatelookupids.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Alternatelookupids.php @@ -17,12 +17,21 @@ class Alternatelookupids extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/constituents/{constituent_id}/alternatelookupids"; /** - * This datalist returns all alternate lookup IDs for a constituent. + * This operation returns all alternate lookup ids for a constituent. * - * @param array{constituent_id: string, limit: int} $params An associative - * array + * @param array{constituent_id: string, limit: int, session_key: string, + * infinity_session: string, more_rows_range_key: string, start_row_index: + * int} $params An associative array * - constituent_id: The constituent id. * - limit: Limits the number of records to return. + * - session_key: A unique key provided by user for paging results. + * The same key will be returned in a successful response. + * - infinity_session: Values for cookies related to the Infinity load + * balancer session. + * - more_rows_range_key: Key for accessing cached results on + * subsequent calls to this data list. + * - start_row_index: Number of rows to skip,get result after these + * rows. * * @return \Blackbaud\SKY\Altru\Constituent\Components\ConstituentAlternateLookupIdListCollection * Returned when the operation succeeds. The response body contains a @@ -35,7 +44,11 @@ public function searchByConstituentId(array $params): ConstituentAlternateLookup { assert(isset($params['constituent_id']), new ArgumentException("Parameter `constituent_id` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); + assert(isset($params['session_key']), new ArgumentException("Parameter `session_key` is required")); + assert(isset($params['infinity_session']), new ArgumentException("Parameter `infinity_session` is required")); + assert(isset($params['more_rows_range_key']), new ArgumentException("Parameter `more_rows_range_key` is required")); + assert(isset($params['start_row_index']), new ArgumentException("Parameter `start_row_index` is required")); - return new ConstituentAlternateLookupIdListCollection($this->send("get", ["constituent_id" => $params['constituent_id']], ["limit" => $params['limit']])); + return new ConstituentAlternateLookupIdListCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['limit','session_key','infinity_session','more_rows_range_key','start_row_index']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Constituentattributelist.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Constituentattributelist.php index c252292c..a0bb323f 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Constituentattributelist.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Constituentattributelist.php @@ -19,10 +19,19 @@ class Constituentattributelist extends BaseEndpoint /** * Returns a list for all attribute values for a constituent. * - * @param array{constituent_id: string, limit: int} $params An associative - * array + * @param array{constituent_id: string, limit: int, session_key: string, + * infinity_session: string, more_rows_range_key: string, start_row_index: + * int} $params An associative array * - constituent_id: The constituent id. * - limit: Limits the number of records to return. + * - session_key: A unique key provided by user for paging results. + * The same key will be returned in a successful response. + * - infinity_session: Values for cookies related to the Infinity load + * balancer session. + * - more_rows_range_key: Key for accessing cached results on + * subsequent calls to this data list. + * - start_row_index: Number of rows to skip,get result after these + * rows. * * @return \Blackbaud\SKY\Altru\Constituent\Components\ConstituentAttributeListCollection * Returned when the operation succeeds. The response body contains a @@ -35,7 +44,11 @@ public function searchByConstituentId(array $params): ConstituentAttributeListCo { assert(isset($params['constituent_id']), new ArgumentException("Parameter `constituent_id` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); + assert(isset($params['session_key']), new ArgumentException("Parameter `session_key` is required")); + assert(isset($params['infinity_session']), new ArgumentException("Parameter `infinity_session` is required")); + assert(isset($params['more_rows_range_key']), new ArgumentException("Parameter `more_rows_range_key` is required")); + assert(isset($params['start_row_index']), new ArgumentException("Parameter `start_row_index` is required")); - return new ConstituentAttributeListCollection($this->send("get", ["constituent_id" => $params['constituent_id']], ["limit" => $params['limit']])); + return new ConstituentAttributeListCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['limit','session_key','infinity_session','more_rows_range_key','start_row_index']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Constituentduplicatematch.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Constituentduplicatematch.php index 9ffddb44..10af1e11 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Constituentduplicatematch.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Constituentduplicatematch.php @@ -17,12 +17,13 @@ class Constituentduplicatematch extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/constituents/constituentduplicatematch"; /** - * List of constituents matching web forms automatch threshold. + * List of constituents matching web operations automatch threshold. * * @param array{max_results: int, email_address: string, first_name: * string, key_name: string, address_block: string, country: string, - * post_code: string, phone_number: string, title: string, limit: int} - * $params An associative array + * post_code: string, phone_number: string, title: string, limit: int, + * session_key: string, infinity_session: string, more_rows_range_key: + * string, start_row_index: int} $params An associative array * - max_results: max number of rows * - email_address: email address * - first_name: first name @@ -32,9 +33,17 @@ class Constituentduplicatematch extends BaseEndpoint * SimpleDataListID=c9649672-353d-42e8-8c25-4d34bbabfbba. * - post_code: address zip code * - phone_number: phone number - * - title: title This codetable can be queried at + * - title: title This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/TITLECODE/entries * - limit: Limits the number of records to return. + * - session_key: A unique key provided by user for paging results. + * The same key will be returned in a successful response. + * - infinity_session: Values for cookies related to the Infinity load + * balancer session. + * - more_rows_range_key: Key for accessing cached results on + * subsequent calls to this data list. + * - start_row_index: Number of rows to skip,get result after these + * rows. * * @return \Blackbaud\SKY\Altru\Constituent\Components\ConstituentDuplicateMatchListCollection * Returned when the operation succeeds. The response body contains a @@ -55,16 +64,11 @@ public function list_(array $params): ConstituentDuplicateMatchListCollection assert(isset($params['phone_number']), new ArgumentException("Parameter `phone_number` is required")); assert(isset($params['title']), new ArgumentException("Parameter `title` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); + assert(isset($params['session_key']), new ArgumentException("Parameter `session_key` is required")); + assert(isset($params['infinity_session']), new ArgumentException("Parameter `infinity_session` is required")); + assert(isset($params['more_rows_range_key']), new ArgumentException("Parameter `more_rows_range_key` is required")); + assert(isset($params['start_row_index']), new ArgumentException("Parameter `start_row_index` is required")); - return new ConstituentDuplicateMatchListCollection($this->send("get", [], ["max_results" => $params['max_results'], - "email_address" => $params['email_address'], - "first_name" => $params['first_name'], - "key_name" => $params['key_name'], - "address_block" => $params['address_block'], - "country" => $params['country'], - "post_code" => $params['post_code'], - "phone_number" => $params['phone_number'], - "title" => $params['title'], - "limit" => $params['limit']])); + return new ConstituentDuplicateMatchListCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['max_results','email_address','first_name','key_name','address_block','country','post_code','phone_number','title','limit','session_key','infinity_session','more_rows_range_key','start_row_index']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Contactinformationemailaddress.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Contactinformationemailaddress.php index fb10f70e..26cd5c4e 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Contactinformationemailaddress.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Contactinformationemailaddress.php @@ -17,14 +17,23 @@ class Contactinformationemailaddress extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/constituents/{constituent_id}/contactinformationemailaddress"; /** - * This datalist returns all email address contact information for a + * This operation returns all email address contact inoperationation for a * constituent. * - * @param array{constituent_id: string, include_former: bool, limit: int} - * $params An associative array + * @param array{constituent_id: string, include_former: bool, limit: int, + * session_key: string, infinity_session: string, more_rows_range_key: + * string, start_row_index: int} $params An associative array * - constituent_id: The constituent id. * - include_former: show former contact information * - limit: Limits the number of records to return. + * - session_key: A unique key provided by user for paging results. + * The same key will be returned in a successful response. + * - infinity_session: Values for cookies related to the Infinity load + * balancer session. + * - more_rows_range_key: Key for accessing cached results on + * subsequent calls to this data list. + * - start_row_index: Number of rows to skip,get result after these + * rows. * * @return \Blackbaud\SKY\Altru\Constituent\Components\ConstituentContactListCollection * Returned when the operation succeeds. The response body contains a @@ -38,8 +47,11 @@ public function searchByConstituentId(array $params): ConstituentContactListColl assert(isset($params['constituent_id']), new ArgumentException("Parameter `constituent_id` is required")); assert(isset($params['include_former']), new ArgumentException("Parameter `include_former` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); + assert(isset($params['session_key']), new ArgumentException("Parameter `session_key` is required")); + assert(isset($params['infinity_session']), new ArgumentException("Parameter `infinity_session` is required")); + assert(isset($params['more_rows_range_key']), new ArgumentException("Parameter `more_rows_range_key` is required")); + assert(isset($params['start_row_index']), new ArgumentException("Parameter `start_row_index` is required")); - return new ConstituentContactListCollection($this->send("get", ["constituent_id" => $params['constituent_id']], ["include_former" => $params['include_former'], - "limit" => $params['limit']])); + return new ConstituentContactListCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['include_former','limit','session_key','infinity_session','more_rows_range_key','start_row_index']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Contactinformationphone.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Contactinformationphone.php index f72869b9..6962760d 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Contactinformationphone.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Contactinformationphone.php @@ -17,13 +17,23 @@ class Contactinformationphone extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/constituents/{constituent_id}/contactinformationphone"; /** - * This datalist returns all phone contact information for a constituent. + * This operation returns all phone contact inoperationation for a + * constituent. * - * @param array{constituent_id: string, include_former: bool, limit: int} - * $params An associative array + * @param array{constituent_id: string, include_former: bool, limit: int, + * session_key: string, infinity_session: string, more_rows_range_key: + * string, start_row_index: int} $params An associative array * - constituent_id: The constituent id. * - include_former: show former contact information * - limit: Limits the number of records to return. + * - session_key: A unique key provided by user for paging results. + * The same key will be returned in a successful response. + * - infinity_session: Values for cookies related to the Infinity load + * balancer session. + * - more_rows_range_key: Key for accessing cached results on + * subsequent calls to this data list. + * - start_row_index: Number of rows to skip,get result after these + * rows. * * @return \Blackbaud\SKY\Altru\Constituent\Components\ConstituentContactListCollection * Returned when the operation succeeds. The response body contains a @@ -37,8 +47,11 @@ public function searchByConstituentId(array $params): ConstituentContactListColl assert(isset($params['constituent_id']), new ArgumentException("Parameter `constituent_id` is required")); assert(isset($params['include_former']), new ArgumentException("Parameter `include_former` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); + assert(isset($params['session_key']), new ArgumentException("Parameter `session_key` is required")); + assert(isset($params['infinity_session']), new ArgumentException("Parameter `infinity_session` is required")); + assert(isset($params['more_rows_range_key']), new ArgumentException("Parameter `more_rows_range_key` is required")); + assert(isset($params['start_row_index']), new ArgumentException("Parameter `start_row_index` is required")); - return new ConstituentContactListCollection($this->send("get", ["constituent_id" => $params['constituent_id']], ["include_former" => $params['include_former'], - "limit" => $params['limit']])); + return new ConstituentContactListCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['include_former','limit','session_key','infinity_session','more_rows_range_key','start_row_index']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Contactview.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Contactview.php index 718728ae..b893e21a 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Contactview.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Contactview.php @@ -17,8 +17,8 @@ class Contactview extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/constituents/{constituent_id}/contactview"; /** - * This view form displays the preferred address, phone, and email - * information for a given constituent + * This view operation displays the preferred address, phone, and email + * inoperationation for a given constituent * * @param array{constituent_id: string} $params An associative array * - constituent_id: The constituent id. @@ -34,6 +34,6 @@ public function getByConstituentId(array $params): ConstituentPrimaryContactInfo { assert(isset($params['constituent_id']), new ArgumentException("Parameter `constituent_id` is required")); - return new ConstituentPrimaryContactInformationView($this->send("get", ["constituent_id" => $params['constituent_id']], [])); + return new ConstituentPrimaryContactInformationView($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Educationalhistories.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Educationalhistories.php index 73d66610..7868a8bb 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Educationalhistories.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Educationalhistories.php @@ -17,12 +17,21 @@ class Educationalhistories extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/constituents/{constituent_id}/educationalhistories"; /** - * This datalist returns the education history for a constituent. + * This operation returns the education history for a constituent. * - * @param array{constituent_id: string, limit: int} $params An associative - * array + * @param array{constituent_id: string, limit: int, session_key: string, + * infinity_session: string, more_rows_range_key: string, start_row_index: + * int} $params An associative array * - constituent_id: The constituent id. * - limit: Limits the number of records to return. + * - session_key: A unique key provided by user for paging results. + * The same key will be returned in a successful response. + * - infinity_session: Values for cookies related to the Infinity load + * balancer session. + * - more_rows_range_key: Key for accessing cached results on + * subsequent calls to this data list. + * - start_row_index: Number of rows to skip,get result after these + * rows. * * @return \Blackbaud\SKY\Altru\Constituent\Components\EducationListCollection * Returned when the operation succeeds. The response body contains a @@ -35,7 +44,11 @@ public function searchByConstituentId(array $params): EducationListCollection { assert(isset($params['constituent_id']), new ArgumentException("Parameter `constituent_id` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); + assert(isset($params['session_key']), new ArgumentException("Parameter `session_key` is required")); + assert(isset($params['infinity_session']), new ArgumentException("Parameter `infinity_session` is required")); + assert(isset($params['more_rows_range_key']), new ArgumentException("Parameter `more_rows_range_key` is required")); + assert(isset($params['start_row_index']), new ArgumentException("Parameter `start_row_index` is required")); - return new EducationListCollection($this->send("get", ["constituent_id" => $params['constituent_id']], ["limit" => $params['limit']])); + return new EducationListCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['limit','session_key','infinity_session','more_rows_range_key','start_row_index']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Emailaddresses.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Emailaddresses.php index 8c672c49..0f991a50 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Emailaddresses.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Emailaddresses.php @@ -17,12 +17,21 @@ class Emailaddresses extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/constituents/{constituent_id}/emailaddresses"; /** - * This datalist returns all email addresses for a constituent. + * This operation returns all email addresses for a constituent. * - * @param array{constituent_id: string, limit: int} $params An associative - * array + * @param array{constituent_id: string, limit: int, session_key: string, + * infinity_session: string, more_rows_range_key: string, start_row_index: + * int} $params An associative array * - constituent_id: The constituent id. * - limit: Limits the number of records to return. + * - session_key: A unique key provided by user for paging results. + * The same key will be returned in a successful response. + * - infinity_session: Values for cookies related to the Infinity load + * balancer session. + * - more_rows_range_key: Key for accessing cached results on + * subsequent calls to this data list. + * - start_row_index: Number of rows to skip,get result after these + * rows. * * @return \Blackbaud\SKY\Altru\Constituent\Components\ConstituentEmailAddressListCollection * Returned when the operation succeeds. The response body contains a @@ -35,7 +44,11 @@ public function searchByConstituentId(array $params): ConstituentEmailAddressLis { assert(isset($params['constituent_id']), new ArgumentException("Parameter `constituent_id` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); + assert(isset($params['session_key']), new ArgumentException("Parameter `session_key` is required")); + assert(isset($params['infinity_session']), new ArgumentException("Parameter `infinity_session` is required")); + assert(isset($params['more_rows_range_key']), new ArgumentException("Parameter `more_rows_range_key` is required")); + assert(isset($params['start_row_index']), new ArgumentException("Parameter `start_row_index` is required")); - return new ConstituentEmailAddressListCollection($this->send("get", ["constituent_id" => $params['constituent_id']], ["limit" => $params['limit']])); + return new ConstituentEmailAddressListCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['limit','session_key','infinity_session','more_rows_range_key','start_row_index']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Fundraisersearch.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Fundraisersearch.php index ebb98a36..9d1ec606 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Fundraisersearch.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Fundraisersearch.php @@ -17,7 +17,7 @@ class Fundraisersearch extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/constituents/fundraisersearch"; /** - * Search for Fundraisers. + * Search for fundraisers. * * @param array{constituent_type: int, full_name: string, key_name: * string, first_name: string, lookup_id: string, address_block: string, @@ -108,36 +108,6 @@ public function list_(array $params): ConstituentFundraiserSearchCollection assert(isset($params['sites_selected']), new ArgumentException("Parameter `sites_selected` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); - return new ConstituentFundraiserSearchCollection($this->send("get", [], ["constituent_type" => $params['constituent_type'], - "full_name" => $params['full_name'], - "key_name" => $params['key_name'], - "first_name" => $params['first_name'], - "lookup_id" => $params['lookup_id'], - "address_block" => $params['address_block'], - "city" => $params['city'], - "state" => $params['state'], - "post_code" => $params['post_code'], - "country" => $params['country'], - "include_inactive" => $params['include_inactive'], - "include_deceased" => $params['include_deceased'], - "only_primary_address" => $params['only_primary_address'], - "exact_match_only" => $params['exact_match_only'], - "only_prospects" => $params['only_prospects'], - "only_fundraisers" => $params['only_fundraisers'], - "only_staff" => $params['only_staff'], - "only_volunteers" => $params['only_volunteers'], - "ssn" => $params['ssn'], - "check_nick_name" => $params['check_nick_name'], - "check_aliases" => $params['check_aliases'], - "check_merged_constituents" => $params['check_merged_constituents'], - "minimum_date" => $params['minimum_date'], - "include_individuals" => $params['include_individuals'], - "include_organizations" => $params['include_organizations'], - "include_groups" => $params['include_groups'], - "check_alternate_lookup_ids" => $params['check_alternate_lookup_ids'], - "fuzzy_search_on_name" => $params['fuzzy_search_on_name'], - "site_filter_mode" => $params['site_filter_mode'], - "sites_selected" => $params['sites_selected'], - "limit" => $params['limit']])); + return new ConstituentFundraiserSearchCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['constituent_type','full_name','key_name','first_name','lookup_id','address_block','city','state','post_code','country','include_inactive','include_deceased','only_primary_address','exact_match_only','only_prospects','only_fundraisers','only_staff','only_volunteers','ssn','check_nick_name','check_aliases','check_merged_constituents','minimum_date','include_individuals','include_organizations','include_groups','check_alternate_lookup_ids','fuzzy_search_on_name','site_filter_mode','sites_selected','limit']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Patrondata.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Patrondata.php index c85d28fa..ff4a4247 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Patrondata.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Patrondata.php @@ -20,11 +20,20 @@ class Patrondata extends BaseEndpoint * Returns all refunds for a patron. * * @param array{constituent_id: string, show_date_range: "All"|"Last 30 - * days"|"Last 90 days"|"Last 12 months", limit: int} $params An - * associative array + * days"|"Last 90 days"|"Last 12 months", limit: int, session_key: string, + * infinity_session: string, more_rows_range_key: string, start_row_index: + * int} $params An associative array * - constituent_id: The constituent id. * - show_date_range: show * - limit: Limits the number of records to return. + * - session_key: A unique key provided by user for paging results. + * The same key will be returned in a successful response. + * - infinity_session: Values for cookies related to the Infinity load + * balancer session. + * - more_rows_range_key: Key for accessing cached results on + * subsequent calls to this data list. + * - start_row_index: Number of rows to skip,get result after these + * rows. * * @return \Blackbaud\SKY\Altru\Constituent\Components\ConstituentListCollection * Returned when the operation succeeds. The response body contains a @@ -38,8 +47,11 @@ public function searchByConstituentId(array $params): ConstituentListCollection assert(isset($params['constituent_id']), new ArgumentException("Parameter `constituent_id` is required")); assert(isset($params['show_date_range']), new ArgumentException("Parameter `show_date_range` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); + assert(isset($params['session_key']), new ArgumentException("Parameter `session_key` is required")); + assert(isset($params['infinity_session']), new ArgumentException("Parameter `infinity_session` is required")); + assert(isset($params['more_rows_range_key']), new ArgumentException("Parameter `more_rows_range_key` is required")); + assert(isset($params['start_row_index']), new ArgumentException("Parameter `start_row_index` is required")); - return new ConstituentListCollection($this->send("get", ["constituent_id" => $params['constituent_id']], ["show_date_range" => $params['show_date_range'], - "limit" => $params['limit']])); + return new ConstituentListCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['show_date_range','limit','session_key','infinity_session','more_rows_range_key','start_row_index']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Patronorders.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Patronorders.php index 5fcea37b..333ef4ed 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Patronorders.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Patronorders.php @@ -17,16 +17,26 @@ class Patronorders extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/constituents/{constituent_id}/patronorders"; /** - * This datalist returns orders for a patron. + * This operation returns orders for a patron. * * @param array{constituent_id: string, show_date_range: "All"|"Last 30 * days"|"Last 90 days"|"Last 12 months", sales_method: string, limit: - * int} $params An associative array + * int, session_key: string, infinity_session: string, + * more_rows_range_key: string, start_row_index: int} $params An + * associative array * - constituent_id: The constituent id. * - show_date_range: show * - sales_method: sales method * SimpleDataListID=f92f307a-adc7-4720-9283-8512ecc64b51. * - limit: Limits the number of records to return. + * - session_key: A unique key provided by user for paging results. + * The same key will be returned in a successful response. + * - infinity_session: Values for cookies related to the Infinity load + * balancer session. + * - more_rows_range_key: Key for accessing cached results on + * subsequent calls to this data list. + * - start_row_index: Number of rows to skip,get result after these + * rows. * * @return \Blackbaud\SKY\Altru\Constituent\Components\ConstituentListCollection * Returned when the operation succeeds. The response body contains a @@ -41,9 +51,11 @@ public function searchByConstituentId(array $params): ConstituentListCollection assert(isset($params['show_date_range']), new ArgumentException("Parameter `show_date_range` is required")); assert(isset($params['sales_method']), new ArgumentException("Parameter `sales_method` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); + assert(isset($params['session_key']), new ArgumentException("Parameter `session_key` is required")); + assert(isset($params['infinity_session']), new ArgumentException("Parameter `infinity_session` is required")); + assert(isset($params['more_rows_range_key']), new ArgumentException("Parameter `more_rows_range_key` is required")); + assert(isset($params['start_row_index']), new ArgumentException("Parameter `start_row_index` is required")); - return new ConstituentListCollection($this->send("get", ["constituent_id" => $params['constituent_id']], ["show_date_range" => $params['show_date_range'], - "sales_method" => $params['sales_method'], - "limit" => $params['limit']])); + return new ConstituentListCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['show_date_range','sales_method','limit','session_key','infinity_session','more_rows_range_key','start_row_index']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Phones.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Phones.php index 7c02a30f..e123926d 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Phones.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Phones.php @@ -17,12 +17,21 @@ class Phones extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/constituents/{constituent_id}/phones"; /** - * This datalist returns all phone numbers for a constituent. + * This operation returns all phone numbers for a constituent. * - * @param array{constituent_id: string, limit: int} $params An associative - * array + * @param array{constituent_id: string, limit: int, session_key: string, + * infinity_session: string, more_rows_range_key: string, start_row_index: + * int} $params An associative array * - constituent_id: The constituent id. * - limit: Limits the number of records to return. + * - session_key: A unique key provided by user for paging results. + * The same key will be returned in a successful response. + * - infinity_session: Values for cookies related to the Infinity load + * balancer session. + * - more_rows_range_key: Key for accessing cached results on + * subsequent calls to this data list. + * - start_row_index: Number of rows to skip,get result after these + * rows. * * @return \Blackbaud\SKY\Altru\Constituent\Components\ConstituentPhoneListCollection * Returned when the operation succeeds. The response body contains a @@ -35,7 +44,11 @@ public function searchByConstituentId(array $params): ConstituentPhoneListCollec { assert(isset($params['constituent_id']), new ArgumentException("Parameter `constituent_id` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); + assert(isset($params['session_key']), new ArgumentException("Parameter `session_key` is required")); + assert(isset($params['infinity_session']), new ArgumentException("Parameter `infinity_session` is required")); + assert(isset($params['more_rows_range_key']), new ArgumentException("Parameter `more_rows_range_key` is required")); + assert(isset($params['start_row_index']), new ArgumentException("Parameter `start_row_index` is required")); - return new ConstituentPhoneListCollection($this->send("get", ["constituent_id" => $params['constituent_id']], ["limit" => $params['limit']])); + return new ConstituentPhoneListCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['limit','session_key','infinity_session','more_rows_range_key','start_row_index']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Profilepicture.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Profilepicture.php index 264b9d3d..376e3569 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Profilepicture.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Profilepicture.php @@ -17,7 +17,7 @@ class Profilepicture extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/constituents/{constituent_id}/profilepicture"; /** - * Defines the fields for the individual Personal Information tile. + * Defines the fields for the individual personal inoperationation tile. * * @param array{constituent_id: string} $params An associative array * - constituent_id: The constituent id. @@ -33,6 +33,6 @@ public function getByConstituentId(array $params): ConstituentProfilePictureView { assert(isset($params['constituent_id']), new ArgumentException("Parameter `constituent_id` is required")); - return new ConstituentProfilePictureView($this->send("get", ["constituent_id" => $params['constituent_id']], [])); + return new ConstituentProfilePictureView($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Relationshipjobsinfo.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Relationshipjobsinfo.php index c1b07ce5..8619368f 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Relationshipjobsinfo.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Relationshipjobsinfo.php @@ -17,14 +17,24 @@ class Relationshipjobsinfo extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/constituents/{constituent_id}/relationshipjobsinfo"; /** - * This datalist returns a list of all employment history for a + * This operation returns a list of all employment history for a * constituent. * * @param array{constituent_id: string, include_inactive: bool, limit: - * int} $params An associative array + * int, session_key: string, infinity_session: string, + * more_rows_range_key: string, start_row_index: int} $params An + * associative array * - constituent_id: The constituent id. * - include_inactive: include inactive * - limit: Limits the number of records to return. + * - session_key: A unique key provided by user for paging results. + * The same key will be returned in a successful response. + * - infinity_session: Values for cookies related to the Infinity load + * balancer session. + * - more_rows_range_key: Key for accessing cached results on + * subsequent calls to this data list. + * - start_row_index: Number of rows to skip,get result after these + * rows. * * @return \Blackbaud\SKY\Altru\Constituent\Components\RelationshipJobInfoListCollection * Returned when the operation succeeds. The response body contains a @@ -38,8 +48,11 @@ public function searchByConstituentId(array $params): RelationshipJobInfoListCol assert(isset($params['constituent_id']), new ArgumentException("Parameter `constituent_id` is required")); assert(isset($params['include_inactive']), new ArgumentException("Parameter `include_inactive` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); + assert(isset($params['session_key']), new ArgumentException("Parameter `session_key` is required")); + assert(isset($params['infinity_session']), new ArgumentException("Parameter `infinity_session` is required")); + assert(isset($params['more_rows_range_key']), new ArgumentException("Parameter `more_rows_range_key` is required")); + assert(isset($params['start_row_index']), new ArgumentException("Parameter `start_row_index` is required")); - return new RelationshipJobInfoListCollection($this->send("get", ["constituent_id" => $params['constituent_id']], ["include_inactive" => $params['include_inactive'], - "limit" => $params['limit']])); + return new RelationshipJobInfoListCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['include_inactive','limit','session_key','infinity_session','more_rows_range_key','start_row_index']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Search.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Search.php index 5a4a6db8..5f3e96e8 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Search.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Search.php @@ -85,7 +85,7 @@ class Search extends BaseEndpoint * - middle_name: represents a filter on the middle name of the * constituent. * - suffix: represents a filter on the suffix code of the constituent - * name. This codetable can be queried at + * name. This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/SUFFIXCODE/entries * - constituency: represents a filter on the constituency of the * constituent. SimpleDataListID=7821c1ab-3001-485b-aec7-f55749f959e6. @@ -134,36 +134,6 @@ public function list_(array $params): ConstituentSearchCollection assert(isset($params['sourcecode']), new ArgumentException("Parameter `sourcecode` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); - return new ConstituentSearchCollection($this->send("get", [], ["constituent_quick_find" => $params['constituent_quick_find'], - "full_name" => $params['full_name'], - "key_name" => $params['key_name'], - "first_name" => $params['first_name'], - "lookup_id" => $params['lookup_id'], - "address_block" => $params['address_block'], - "city" => $params['city'], - "state" => $params['state'], - "post_code" => $params['post_code'], - "country" => $params['country'], - "include_inactive" => $params['include_inactive'], - "include_deceased" => $params['include_deceased'], - "only_primary_address" => $params['only_primary_address'], - "exact_match_only" => $params['exact_match_only'], - "check_nickname" => $params['check_nickname'], - "check_aliases" => $params['check_aliases'], - "classof" => $params['classof'], - "minimum_date" => $params['minimum_date'], - "exclude_households" => $params['exclude_households'], - "email_address" => $params['email_address'], - "include_individuals" => $params['include_individuals'], - "include_organizations" => $params['include_organizations'], - "include_groups" => $params['include_groups'], - "check_alternate_lookup_ids" => $params['check_alternate_lookup_ids'], - "fuzzy_search_on_name" => $params['fuzzy_search_on_name'], - "phone_number" => $params['phone_number'], - "middle_name" => $params['middle_name'], - "suffix" => $params['suffix'], - "constituency" => $params['constituency'], - "sourcecode" => $params['sourcecode'], - "limit" => $params['limit']])); + return new ConstituentSearchCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['constituent_quick_find','full_name','key_name','first_name','lookup_id','address_block','city','state','post_code','country','include_inactive','include_deceased','only_primary_address','exact_match_only','check_nickname','check_aliases','classof','minimum_date','exclude_households','email_address','include_individuals','include_organizations','include_groups','check_alternate_lookup_ids','fuzzy_search_on_name','phone_number','middle_name','suffix','constituency','sourcecode','limit']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Solicitcodes.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Solicitcodes.php index a50f0ea4..c6a98d5b 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Solicitcodes.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Solicitcodes.php @@ -23,8 +23,9 @@ class Solicitcodes extends BaseEndpoint * "All sites"|"My site"|"My site's branch"|"Selected sites", * sites_selected: string, show_expired: bool, date_range: "All * dates"|"Last 30 days"|"Last 60 days"|"Last 90 days"|"Last 6 - * months"|"Last year"|"Last 2 years", limit: int} $params An associative - * array + * months"|"Last year"|"Last 2 years", limit: int, session_key: string, + * infinity_session: string, more_rows_range_key: string, start_row_index: + * int} $params An associative array * - constituent_id: The constituent id. * - site_id: site * - site_filter_mode: sites @@ -32,6 +33,14 @@ class Solicitcodes extends BaseEndpoint * - show_expired: show expired codes for * - date_range: date range * - limit: Limits the number of records to return. + * - session_key: A unique key provided by user for paging results. + * The same key will be returned in a successful response. + * - infinity_session: Values for cookies related to the Infinity load + * balancer session. + * - more_rows_range_key: Key for accessing cached results on + * subsequent calls to this data list. + * - start_row_index: Number of rows to skip,get result after these + * rows. * * @return \Blackbaud\SKY\Altru\Constituent\Components\ConstituentSolicitCodeListCollection * Returned when the operation succeeds. The response body contains a @@ -49,12 +58,11 @@ public function searchByConstituentId(array $params): ConstituentSolicitCodeList assert(isset($params['show_expired']), new ArgumentException("Parameter `show_expired` is required")); assert(isset($params['date_range']), new ArgumentException("Parameter `date_range` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); + assert(isset($params['session_key']), new ArgumentException("Parameter `session_key` is required")); + assert(isset($params['infinity_session']), new ArgumentException("Parameter `infinity_session` is required")); + assert(isset($params['more_rows_range_key']), new ArgumentException("Parameter `more_rows_range_key` is required")); + assert(isset($params['start_row_index']), new ArgumentException("Parameter `start_row_index` is required")); - return new ConstituentSolicitCodeListCollection($this->send("get", ["constituent_id" => $params['constituent_id']], ["site_id" => $params['site_id'], - "site_filter_mode" => $params['site_filter_mode'], - "sites_selected" => $params['sites_selected'], - "show_expired" => $params['show_expired'], - "date_range" => $params['date_range'], - "limit" => $params['limit']])); + return new ConstituentSolicitCodeListCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['site_id','site_filter_mode','sites_selected','show_expired','date_range','limit','session_key','infinity_session','more_rows_range_key','start_row_index']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Tributes.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Tributes.php index 71cb05ae..b21f1417 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Tributes.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/Tributes.php @@ -20,10 +20,19 @@ class Tributes extends BaseEndpoint * Returns a list of tributes where the current constituent is the * tributee or the acknowledgee. * - * @param array{constituent_id: string, limit: int} $params An associative - * array + * @param array{constituent_id: string, limit: int, session_key: string, + * infinity_session: string, more_rows_range_key: string, start_row_index: + * int} $params An associative array * - constituent_id: The constituent id. * - limit: Limits the number of records to return. + * - session_key: A unique key provided by user for paging results. + * The same key will be returned in a successful response. + * - infinity_session: Values for cookies related to the Infinity load + * balancer session. + * - more_rows_range_key: Key for accessing cached results on + * subsequent calls to this data list. + * - start_row_index: Number of rows to skip,get result after these + * rows. * * @return \Blackbaud\SKY\Altru\Constituent\Components\TributeListCollection * Returned when the operation succeeds. The response body contains a @@ -36,7 +45,11 @@ public function searchByConstituentId(array $params): TributeListCollection { assert(isset($params['constituent_id']), new ArgumentException("Parameter `constituent_id` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); + assert(isset($params['session_key']), new ArgumentException("Parameter `session_key` is required")); + assert(isset($params['infinity_session']), new ArgumentException("Parameter `infinity_session` is required")); + assert(isset($params['more_rows_range_key']), new ArgumentException("Parameter `more_rows_range_key` is required")); + assert(isset($params['start_row_index']), new ArgumentException("Parameter `start_row_index` is required")); - return new TributeListCollection($this->send("get", ["constituent_id" => $params['constituent_id']], ["limit" => $params['limit']])); + return new TributeListCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['limit','session_key','infinity_session','more_rows_range_key','start_row_index']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/View.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/View.php index dfd36df8..2fb7af4f 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/View.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Constituents/View.php @@ -17,7 +17,7 @@ class View extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/constituents/{constituent_id}/view"; /** - * This view dataform template provides a constituent summary profile. + * This view operation provides a constituent summary profile. * * @param array{constituent_id: string} $params An associative array * - constituent_id: The constituent id. @@ -33,6 +33,6 @@ public function getByConstituentId(array $params): ConstituentSummaryProfileView { assert(isset($params['constituent_id']), new ArgumentException("Parameter `constituent_id` is required")); - return new ConstituentSummaryProfileView($this->send("get", ["constituent_id" => $params['constituent_id']], [])); + return new ConstituentSummaryProfileView($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Educationalhistories.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Educationalhistories.php index 9e74643c..959ed592 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Educationalhistories.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Educationalhistories.php @@ -4,12 +4,18 @@ use Battis\OpenAPI\Client\BaseEndpoint; use Battis\OpenAPI\Client\Exceptions\ArgumentException; +use Blackbaud\SKY\Altru\Constituent\Components\EditEducation; use Blackbaud\SKY\Altru\Constituent\Components\Education; use Blackbaud\SKY\Altru\Constituent\Components\NewEducation; use Blackbaud\SKY\Altru\Constituent\Components\PostResponse; -use Blackbaud\SKY\Altru\Constituent\Components\UpdateEducation; +use Blackbaud\SKY\Altru\Constituent\Endpoints\Educationalhistories\Search; /** + * Routing class for the subnamespace `Educationalhistories` + * + * @property \Blackbaud\SKY\Altru\Constituent\Endpoints\Educationalhistories\Search + * $search + * * @api */ class Educationalhistories extends BaseEndpoint @@ -19,6 +25,20 @@ class Educationalhistories extends BaseEndpoint */ protected string $url = "https://api.sky.blackbaud.com/alt-conmg/educationalhistories/{educational_history_id}"; + /** + * @var array> + * $endpoints Routing subpaths + */ + protected array $endpoints = [ + "search" => "\Blackbaud\SKY\Altru\Constituent\Endpoints\Educationalhistories\Search", + ]; + + /** + * @var ?\Blackbaud\SKY\Altru\Constituent\Endpoints\Educationalhistories\Search + * $_search + */ + protected ?Search $_search = null; + /** * Adds a new educational history record to an existing constituent. * @@ -36,7 +56,7 @@ public function post(NewEducation $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } /** @@ -57,7 +77,7 @@ public function getByEducationalHistoryId(array $params): Education { assert(isset($params['educational_history_id']), new ArgumentException("Parameter `educational_history_id` is required")); - return new Education($this->send("get", ["educational_history_id" => $params['educational_history_id']], [])); + return new Education($this->send("get", array_filter($params, fn($key) => in_array($key, ['educational_history_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -78,7 +98,7 @@ public function deleteByEducationalHistoryId(array $params): mixed { assert(isset($params['educational_history_id']), new ArgumentException("Parameter `educational_history_id` is required")); - return $this->send("delete", ["educational_history_id" => $params['educational_history_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['educational_history_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** @@ -87,7 +107,7 @@ public function deleteByEducationalHistoryId(array $params): mixed * @param array{educational_history_id: string} $params An associative * array * - educational_history_id: The educational history id. - * @param \Blackbaud\SKY\Altru\Constituent\Components\UpdateEducation + * @param \Blackbaud\SKY\Altru\Constituent\Components\EditEducation * $requestBody ConfigurationMessage object representing operation * intended to be created * @@ -97,11 +117,11 @@ public function deleteByEducationalHistoryId(array $params): mixed * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required * parameters are not defined */ - public function patchOnEducationalHistoryId(array $params, UpdateEducation $requestBody): mixed + public function patchOnEducationalHistoryId(array $params, EditEducation $requestBody): mixed { assert(isset($params['educational_history_id']), new ArgumentException("Parameter `educational_history_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["educational_history_id" => $params['educational_history_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['educational_history_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Educationalhistories/Search.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Educationalhistories/Search.php new file mode 100644 index 00000000..40f3c214 --- /dev/null +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Educationalhistories/Search.php @@ -0,0 +1,90 @@ +send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['full_name_educational_institution','key_name','first_name','lookup_id','exact_match_only','check_nick_name','check_aliases','check_alternate_lookup_ids','educational_institution','academic_catalog_program','educational_program','constituency_status','educational_history_status','academic_catalog_degree','educational_degree','class_of','primary_only','limit']), ARRAY_FILTER_USE_KEY))); + } +} diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Emailaddresses.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Emailaddresses.php index fc3403d7..7f766c46 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Emailaddresses.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Emailaddresses.php @@ -5,9 +5,9 @@ use Battis\OpenAPI\Client\BaseEndpoint; use Battis\OpenAPI\Client\Exceptions\ArgumentException; use Blackbaud\SKY\Altru\Constituent\Components\ConstituentEmailAddress; +use Blackbaud\SKY\Altru\Constituent\Components\EditConstituentEmailAddress; use Blackbaud\SKY\Altru\Constituent\Components\NewConstituentEmailAddress; use Blackbaud\SKY\Altru\Constituent\Components\PostResponse; -use Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentEmailAddress; /** * @api @@ -20,7 +20,7 @@ class Emailaddresses extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/emailaddresses/{email_address_id}"; /** - * This dataform template is used to add email addresses. + * This operation is used to add email addresses. * * @param \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentEmailAddress * $requestBody ConfigurationMessage object representing operation @@ -36,11 +36,11 @@ public function post(NewConstituentEmailAddress $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } /** - * This dataform template is used to edit email addresses. + * This operation is used to edit email addresses. * * @param array{email_address_id: string} $params An associative array * - email_address_id: The email address id. @@ -56,7 +56,7 @@ public function getByEmailAddressId(array $params): ConstituentEmailAddress { assert(isset($params['email_address_id']), new ArgumentException("Parameter `email_address_id` is required")); - return new ConstituentEmailAddress($this->send("get", ["email_address_id" => $params['email_address_id']], [])); + return new ConstituentEmailAddress($this->send("get", array_filter($params, fn($key) => in_array($key, ['email_address_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -76,15 +76,15 @@ public function deleteByEmailAddressId(array $params): mixed { assert(isset($params['email_address_id']), new ArgumentException("Parameter `email_address_id` is required")); - return $this->send("delete", ["email_address_id" => $params['email_address_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['email_address_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** - * This dataform template is used to edit email addresses. + * This operation is used to edit email addresses. * * @param array{email_address_id: string} $params An associative array * - email_address_id: The email address id. - * @param \Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentEmailAddress + * @param \Blackbaud\SKY\Altru\Constituent\Components\EditConstituentEmailAddress * $requestBody ConfigurationMessage object representing operation * intended to be created * @@ -94,11 +94,11 @@ public function deleteByEmailAddressId(array $params): mixed * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required * parameters are not defined */ - public function patchOnEmailAddressId(array $params, UpdateConstituentEmailAddress $requestBody): mixed + public function patchOnEmailAddressId(array $params, EditConstituentEmailAddress $requestBody): mixed { assert(isset($params['email_address_id']), new ArgumentException("Parameter `email_address_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["email_address_id" => $params['email_address_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['email_address_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Fundraisers.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Fundraisers.php index 3f2b8429..e446e204 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Fundraisers.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Fundraisers.php @@ -5,9 +5,9 @@ use Battis\OpenAPI\Client\BaseEndpoint; use Battis\OpenAPI\Client\Exceptions\ArgumentException; use Blackbaud\SKY\Altru\Constituent\Components\ConstituentFundraiser; +use Blackbaud\SKY\Altru\Constituent\Components\EditConstituentFundraiser; use Blackbaud\SKY\Altru\Constituent\Components\NewConstituentFundraiser; use Blackbaud\SKY\Altru\Constituent\Components\PostResponse; -use Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentFundraiser; use Blackbaud\SKY\Altru\Constituent\Endpoints\Fundraisers\List_; use Blackbaud\SKY\Altru\Constituent\Endpoints\Fundraisers\Prospectplanlist; @@ -50,7 +50,7 @@ class Fundraisers extends BaseEndpoint protected ?Prospectplanlist $_prospectplanlist = null; /** - * This dataform template is used to add a fundraiser constituency to a + * This operation is used to add a fundraiser constituency to a * constituent. * * @param \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentFundraiser @@ -67,11 +67,11 @@ public function post(NewConstituentFundraiser $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } /** - * This dataform template is used to edit a fundraiser constituency of a + * This operation is used to edit a fundraiser constituency of a * constituent. * * @param array{fundraiser_date_range_id: string} $params An associative @@ -89,7 +89,7 @@ public function getByFundraiserDateRangeId(array $params): ConstituentFundraiser { assert(isset($params['fundraiser_date_range_id']), new ArgumentException("Parameter `fundraiser_date_range_id` is required")); - return new ConstituentFundraiser($this->send("get", ["fundraiser_date_range_id" => $params['fundraiser_date_range_id']], [])); + return new ConstituentFundraiser($this->send("get", array_filter($params, fn($key) => in_array($key, ['fundraiser_date_range_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -110,17 +110,17 @@ public function deleteByFundraiserDateRangeId(array $params): mixed { assert(isset($params['fundraiser_date_range_id']), new ArgumentException("Parameter `fundraiser_date_range_id` is required")); - return $this->send("delete", ["fundraiser_date_range_id" => $params['fundraiser_date_range_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['fundraiser_date_range_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** - * This dataform template is used to edit a fundraiser constituency of a + * This operation is used to edit a fundraiser constituency of a * constituent. * * @param array{fundraiser_date_range_id: string} $params An associative * array * - fundraiser_date_range_id: The fundraiser date range id. - * @param \Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentFundraiser + * @param \Blackbaud\SKY\Altru\Constituent\Components\EditConstituentFundraiser * $requestBody ConfigurationMessage object representing operation * intended to be created * @@ -130,11 +130,11 @@ public function deleteByFundraiserDateRangeId(array $params): mixed * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required * parameters are not defined */ - public function patchOnFundraiserDateRangeId(array $params, UpdateConstituentFundraiser $requestBody): mixed + public function patchOnFundraiserDateRangeId(array $params, EditConstituentFundraiser $requestBody): mixed { assert(isset($params['fundraiser_date_range_id']), new ArgumentException("Parameter `fundraiser_date_range_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["fundraiser_date_range_id" => $params['fundraiser_date_range_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['fundraiser_date_range_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Fundraisers/List.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Fundraisers/List.php index 3d9c6f9d..65dabcf4 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Fundraisers/List.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Fundraisers/List.php @@ -20,13 +20,22 @@ class List_ extends BaseEndpoint * Returns a list of all fundraisers * * @param array{org_positions_selection_id: string, include_stewardship: - * bool, show_inactive: bool, only_owned_interactions: bool, limit: int} - * $params An associative array + * bool, show_inactive: bool, only_owned_interactions: bool, limit: int, + * session_key: string, infinity_session: string, more_rows_range_key: + * string, start_row_index: int} $params An associative array * - org_positions_selection_id: show for * - include_stewardship: include stewardship steps * - show_inactive: show inactive * - only_owned_interactions: only show steps owned by this fundraiser * - limit: Limits the number of records to return. + * - session_key: A unique key provided by user for paging results. + * The same key will be returned in a successful response. + * - infinity_session: Values for cookies related to the Infinity load + * balancer session. + * - more_rows_range_key: Key for accessing cached results on + * subsequent calls to this data list. + * - start_row_index: Number of rows to skip,get result after these + * rows. * * @return \Blackbaud\SKY\Altru\Constituent\Components\ConstituentFundraiserListCollection * Returned when the operation succeeds. The response body contains a @@ -42,11 +51,11 @@ public function list_(array $params): ConstituentFundraiserListCollection assert(isset($params['show_inactive']), new ArgumentException("Parameter `show_inactive` is required")); assert(isset($params['only_owned_interactions']), new ArgumentException("Parameter `only_owned_interactions` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); + assert(isset($params['session_key']), new ArgumentException("Parameter `session_key` is required")); + assert(isset($params['infinity_session']), new ArgumentException("Parameter `infinity_session` is required")); + assert(isset($params['more_rows_range_key']), new ArgumentException("Parameter `more_rows_range_key` is required")); + assert(isset($params['start_row_index']), new ArgumentException("Parameter `start_row_index` is required")); - return new ConstituentFundraiserListCollection($this->send("get", [], ["org_positions_selection_id" => $params['org_positions_selection_id'], - "include_stewardship" => $params['include_stewardship'], - "show_inactive" => $params['show_inactive'], - "only_owned_interactions" => $params['only_owned_interactions'], - "limit" => $params['limit']])); + return new ConstituentFundraiserListCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['org_positions_selection_id','include_stewardship','show_inactive','only_owned_interactions','limit','session_key','infinity_session','more_rows_range_key','start_row_index']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Fundraisers/Prospectplanlist.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Fundraisers/Prospectplanlist.php index 817be012..80327c76 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Fundraisers/Prospectplanlist.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Fundraisers/Prospectplanlist.php @@ -17,17 +17,26 @@ class Prospectplanlist extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/fundraisers/{constituent_id}/prospectplanlist"; /** - * A datalist of prospects and their plans for a given fundraiser. + * A operation of prospects and their plans for a given fundraiser. * * @param array{constituent_id: string, site_filter_mode: "All sites"|"My * site"|"My site's branch"|"Selected sites", sites_selected: string, - * include_historical_plans: bool, limit: int} $params An associative - * array + * include_historical_plans: bool, limit: int, session_key: string, + * infinity_session: string, more_rows_range_key: string, start_row_index: + * int} $params An associative array * - constituent_id: The constituent id. * - site_filter_mode: sites * - sites_selected: Format - XML. sites selected * - include_historical_plans: include historical plans * - limit: Limits the number of records to return. + * - session_key: A unique key provided by user for paging results. + * The same key will be returned in a successful response. + * - infinity_session: Values for cookies related to the Infinity load + * balancer session. + * - more_rows_range_key: Key for accessing cached results on + * subsequent calls to this data list. + * - start_row_index: Number of rows to skip,get result after these + * rows. * * @return \Blackbaud\SKY\Altru\Constituent\Components\ConstituentFundraiserListCollection * Returned when the operation succeeds. The response body contains a @@ -43,10 +52,11 @@ public function searchByConstituentId(array $params): ConstituentFundraiserListC assert(isset($params['sites_selected']), new ArgumentException("Parameter `sites_selected` is required")); assert(isset($params['include_historical_plans']), new ArgumentException("Parameter `include_historical_plans` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); + assert(isset($params['session_key']), new ArgumentException("Parameter `session_key` is required")); + assert(isset($params['infinity_session']), new ArgumentException("Parameter `infinity_session` is required")); + assert(isset($params['more_rows_range_key']), new ArgumentException("Parameter `more_rows_range_key` is required")); + assert(isset($params['start_row_index']), new ArgumentException("Parameter `start_row_index` is required")); - return new ConstituentFundraiserListCollection($this->send("get", ["constituent_id" => $params['constituent_id']], ["site_filter_mode" => $params['site_filter_mode'], - "sites_selected" => $params['sites_selected'], - "include_historical_plans" => $params['include_historical_plans'], - "limit" => $params['limit']])); + return new ConstituentFundraiserListCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['site_filter_mode','sites_selected','include_historical_plans','limit','session_key','infinity_session','more_rows_range_key','start_row_index']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Individuals.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Individuals.php index 6af61163..339c1e14 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Individuals.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Individuals.php @@ -4,10 +4,10 @@ use Battis\OpenAPI\Client\BaseEndpoint; use Battis\OpenAPI\Client\Exceptions\ArgumentException; +use Blackbaud\SKY\Altru\Constituent\Components\EditIndividual; use Blackbaud\SKY\Altru\Constituent\Components\Individual; use Blackbaud\SKY\Altru\Constituent\Components\NewIndividual; use Blackbaud\SKY\Altru\Constituent\Components\PostResponse; -use Blackbaud\SKY\Altru\Constituent\Components\UpdateIndividual; use Blackbaud\SKY\Altru\Constituent\Endpoints\Individuals\Recentrevenueview; use Blackbaud\SKY\Altru\Constituent\Endpoints\Individuals\Revenuesummaryview; @@ -50,8 +50,8 @@ class Individuals extends BaseEndpoint protected ?Revenuesummaryview $_revenuesummaryview = null; /** - * This dataform template is used to add individuals, including - * biographical and contact information. + * This operation is used to add an individual constituent, + * spouse(optional), and business(optional). * * @param \Blackbaud\SKY\Altru\Constituent\Components\NewIndividual * $requestBody ConfigurationMessage object representing operation @@ -67,11 +67,11 @@ public function post(NewIndividual $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } /** - * This dataform template is used to edit biographical information for an + * This operation is used to edit biographical inoperationation for an * individual. * * @param array{constituent_id: string} $params An associative array @@ -88,16 +88,16 @@ public function getByConstituentId(array $params): Individual { assert(isset($params['constituent_id']), new ArgumentException("Parameter `constituent_id` is required")); - return new Individual($this->send("get", ["constituent_id" => $params['constituent_id']], [])); + return new Individual($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** - * This dataform template is used to edit biographical information for an + * This operation is used to edit biographical inoperationation for an * individual. * * @param array{constituent_id: string} $params An associative array * - constituent_id: The constituent id. - * @param \Blackbaud\SKY\Altru\Constituent\Components\UpdateIndividual + * @param \Blackbaud\SKY\Altru\Constituent\Components\EditIndividual * $requestBody ConfigurationMessage object representing operation * intended to be created * @@ -107,11 +107,11 @@ public function getByConstituentId(array $params): Individual * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required * parameters are not defined */ - public function patchOnConstituentId(array $params, UpdateIndividual $requestBody): mixed + public function patchOnConstituentId(array $params, EditIndividual $requestBody): mixed { assert(isset($params['constituent_id']), new ArgumentException("Parameter `constituent_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["constituent_id" => $params['constituent_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Individuals/Recentrevenueview.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Individuals/Recentrevenueview.php index ec11b771..b3b6e71f 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Individuals/Recentrevenueview.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Individuals/Recentrevenueview.php @@ -17,7 +17,7 @@ class Recentrevenueview extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/individuals/{constituent_id}/recentrevenueview"; /** - * Displays recent revenue information for an individual. + * Displays recent revenue inoperationation for an individual. * * @param array{constituent_id: string} $params An associative array * - constituent_id: The constituent id. @@ -33,6 +33,6 @@ public function getByConstituentId(array $params): IndividualRecentRevenueView { assert(isset($params['constituent_id']), new ArgumentException("Parameter `constituent_id` is required")); - return new IndividualRecentRevenueView($this->send("get", ["constituent_id" => $params['constituent_id']], [])); + return new IndividualRecentRevenueView($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Individuals/Revenuesummaryview.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Individuals/Revenuesummaryview.php index 1e02546a..d6af5da1 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Individuals/Revenuesummaryview.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Individuals/Revenuesummaryview.php @@ -17,7 +17,7 @@ class Revenuesummaryview extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/individuals/{constituent_id}/revenuesummaryview"; /** - * Displays revenue summary information about an individual. + * Displays revenue summary inoperationation about an individual. * * @param array{constituent_id: string} $params An associative array * - constituent_id: The constituent id. @@ -33,6 +33,6 @@ public function getByConstituentId(array $params): IndividualRevenueSummaryView { assert(isset($params['constituent_id']), new ArgumentException("Parameter `constituent_id` is required")); - return new IndividualRevenueSummaryView($this->send("get", ["constituent_id" => $params['constituent_id']], [])); + return new IndividualRevenueSummaryView($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Interactions.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Interactions.php index f749f34b..33d912f0 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Interactions.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Interactions.php @@ -5,9 +5,9 @@ use Battis\OpenAPI\Client\BaseEndpoint; use Battis\OpenAPI\Client\Exceptions\ArgumentException; use Blackbaud\SKY\Altru\Constituent\Components\ConstituentInteraction; +use Blackbaud\SKY\Altru\Constituent\Components\EditConstituentInteraction; use Blackbaud\SKY\Altru\Constituent\Components\NewConstituentInteraction; use Blackbaud\SKY\Altru\Constituent\Components\PostResponse; -use Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentInteraction; /** * @api @@ -20,7 +20,7 @@ class Interactions extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/interactions/{constituent_interaction_id}"; /** - * Add dataform for interaction records. + * Add dataoperation for interaction records. * * @param \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentInteraction * $requestBody ConfigurationMessage object representing operation @@ -36,11 +36,11 @@ public function post(NewConstituentInteraction $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } /** - * Edit form for a non-move interaction. + * Edit operation for a non-move interaction. * * @param array{constituent_interaction_id: string} $params An associative * array @@ -57,7 +57,7 @@ public function getByConstituentInteractionId(array $params): ConstituentInterac { assert(isset($params['constituent_interaction_id']), new ArgumentException("Parameter `constituent_interaction_id` is required")); - return new ConstituentInteraction($this->send("get", ["constituent_interaction_id" => $params['constituent_interaction_id']], [])); + return new ConstituentInteraction($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_interaction_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -78,16 +78,16 @@ public function deleteByConstituentInteractionId(array $params): mixed { assert(isset($params['constituent_interaction_id']), new ArgumentException("Parameter `constituent_interaction_id` is required")); - return $this->send("delete", ["constituent_interaction_id" => $params['constituent_interaction_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['constituent_interaction_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** - * Edit form for a non-move interaction. + * Edit operation for a non-move interaction. * * @param array{constituent_interaction_id: string} $params An associative * array * - constituent_interaction_id: The constituent interaction id. - * @param \Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentInteraction + * @param \Blackbaud\SKY\Altru\Constituent\Components\EditConstituentInteraction * $requestBody ConfigurationMessage object representing operation * intended to be created * @@ -97,11 +97,11 @@ public function deleteByConstituentInteractionId(array $params): mixed * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required * parameters are not defined */ - public function patchOnConstituentInteractionId(array $params, UpdateConstituentInteraction $requestBody): mixed + public function patchOnConstituentInteractionId(array $params, EditConstituentInteraction $requestBody): mixed { assert(isset($params['constituent_interaction_id']), new ArgumentException("Parameter `constituent_interaction_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["constituent_interaction_id" => $params['constituent_interaction_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['constituent_interaction_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Mergetwoconstituents.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Mergetwoconstituents.php index ddc48502..1ef10da0 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Mergetwoconstituents.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Mergetwoconstituents.php @@ -18,7 +18,7 @@ class Mergetwoconstituents extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/mergetwoconstituents"; /** - * This form lets the user merge two selected constituent records. + * This operation lets the user merge two selected constituent records. * * @param \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentMerge * $requestBody ConfigurationMessage object representing operation @@ -34,6 +34,6 @@ public function post(NewConstituentMerge $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Organizations.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Organizations.php index e7c6e969..fd5dcd09 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Organizations.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Organizations.php @@ -4,10 +4,10 @@ use Battis\OpenAPI\Client\BaseEndpoint; use Battis\OpenAPI\Client\Exceptions\ArgumentException; +use Blackbaud\SKY\Altru\Constituent\Components\EditOrganization; use Blackbaud\SKY\Altru\Constituent\Components\NewOrganization; use Blackbaud\SKY\Altru\Constituent\Components\Organization; use Blackbaud\SKY\Altru\Constituent\Components\PostResponse; -use Blackbaud\SKY\Altru\Constituent\Components\UpdateOrganization; /** * @api @@ -20,8 +20,8 @@ class Organizations extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/organizations/{constituent_id}"; /** - * This dataform template is used to add organizations, including - * biographical, constituency and contact information. + * This operation is used to add organizations, including biographical, + * constituency and contact inoperationation. * * @param \Blackbaud\SKY\Altru\Constituent\Components\NewOrganization * $requestBody ConfigurationMessage object representing operation @@ -37,11 +37,11 @@ public function post(NewOrganization $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } /** - * Organization Constituent Edit form for Gift Data Entry + * Organization constituent edit operation for gift data entry * * @param array{constituent_id: string} $params An associative array * - constituent_id: The constituent id. @@ -57,15 +57,15 @@ public function getByConstituentId(array $params): Organization { assert(isset($params['constituent_id']), new ArgumentException("Parameter `constituent_id` is required")); - return new Organization($this->send("get", ["constituent_id" => $params['constituent_id']], [])); + return new Organization($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** - * Organization Constituent Edit form for Gift Data Entry + * Organization constituent edit operation for gift data entry * * @param array{constituent_id: string} $params An associative array * - constituent_id: The constituent id. - * @param \Blackbaud\SKY\Altru\Constituent\Components\UpdateOrganization + * @param \Blackbaud\SKY\Altru\Constituent\Components\EditOrganization * $requestBody ConfigurationMessage object representing operation * intended to be created * @@ -75,11 +75,11 @@ public function getByConstituentId(array $params): Organization * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required * parameters are not defined */ - public function patchOnConstituentId(array $params, UpdateOrganization $requestBody): mixed + public function patchOnConstituentId(array $params, EditOrganization $requestBody): mixed { assert(isset($params['constituent_id']), new ArgumentException("Parameter `constituent_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["constituent_id" => $params['constituent_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['constituent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Phones.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Phones.php index 342bde08..30380271 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Phones.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Phones.php @@ -5,9 +5,9 @@ use Battis\OpenAPI\Client\BaseEndpoint; use Battis\OpenAPI\Client\Exceptions\ArgumentException; use Blackbaud\SKY\Altru\Constituent\Components\ConstituentPhone; +use Blackbaud\SKY\Altru\Constituent\Components\EditConstituentPhone; use Blackbaud\SKY\Altru\Constituent\Components\NewConstituentPhone; use Blackbaud\SKY\Altru\Constituent\Components\PostResponse; -use Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentPhone; /** * @api @@ -20,7 +20,7 @@ class Phones extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/phones/{phone_id}"; /** - * This dataform template is used to add phone records. + * This operation is used to add phone records. * * @param \Blackbaud\SKY\Altru\Constituent\Components\NewConstituentPhone * $requestBody ConfigurationMessage object representing operation @@ -36,11 +36,11 @@ public function post(NewConstituentPhone $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } /** - * This dataform template is used to edit phone records. + * This operation is used to edit phone records. * * @param array{phone_id: string} $params An associative array * - phone_id: The phone id. @@ -56,7 +56,7 @@ public function getByPhoneId(array $params): ConstituentPhone { assert(isset($params['phone_id']), new ArgumentException("Parameter `phone_id` is required")); - return new ConstituentPhone($this->send("get", ["phone_id" => $params['phone_id']], [])); + return new ConstituentPhone($this->send("get", array_filter($params, fn($key) => in_array($key, ['phone_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -76,15 +76,15 @@ public function deleteByPhoneId(array $params): mixed { assert(isset($params['phone_id']), new ArgumentException("Parameter `phone_id` is required")); - return $this->send("delete", ["phone_id" => $params['phone_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['phone_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** - * This dataform template is used to edit phone records. + * This operation is used to edit phone records. * * @param array{phone_id: string} $params An associative array * - phone_id: The phone id. - * @param \Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentPhone + * @param \Blackbaud\SKY\Altru\Constituent\Components\EditConstituentPhone * $requestBody ConfigurationMessage object representing operation * intended to be created * @@ -94,11 +94,11 @@ public function deleteByPhoneId(array $params): mixed * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required * parameters are not defined */ - public function patchOnPhoneId(array $params, UpdateConstituentPhone $requestBody): mixed + public function patchOnPhoneId(array $params, EditConstituentPhone $requestBody): mixed { assert(isset($params['phone_id']), new ArgumentException("Parameter `phone_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["phone_id" => $params['phone_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['phone_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Relationshipjobsinfo.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Relationshipjobsinfo.php index 2a5b3c15..269b6a14 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Relationshipjobsinfo.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Relationshipjobsinfo.php @@ -4,10 +4,10 @@ use Battis\OpenAPI\Client\BaseEndpoint; use Battis\OpenAPI\Client\Exceptions\ArgumentException; +use Blackbaud\SKY\Altru\Constituent\Components\EditRelationshipJobInfo; use Blackbaud\SKY\Altru\Constituent\Components\NewRelationshipJobInfo; use Blackbaud\SKY\Altru\Constituent\Components\PostResponse; use Blackbaud\SKY\Altru\Constituent\Components\RelationshipJobInfo; -use Blackbaud\SKY\Altru\Constituent\Components\UpdateRelationshipJobInfo; /** * @api @@ -20,7 +20,7 @@ class Relationshipjobsinfo extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/relationshipjobsinfo/{relationship_job_information_id}"; /** - * This form is used to add relationship job information. + * This operation is used to add relationship job inoperationation. * * @param \Blackbaud\SKY\Altru\Constituent\Components\NewRelationshipJobInfo * $requestBody ConfigurationMessage object representing operation @@ -36,11 +36,11 @@ public function post(NewRelationshipJobInfo $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } /** - * This form is used to edit relationship job information. + * This operation is used to edit relationship job inoperationation. * * @param array{relationship_job_information_id: string} $params An * associative array @@ -58,11 +58,11 @@ public function getByRelationshipJobInformationId(array $params): RelationshipJo { assert(isset($params['relationship_job_information_id']), new ArgumentException("Parameter `relationship_job_information_id` is required")); - return new RelationshipJobInfo($this->send("get", ["relationship_job_information_id" => $params['relationship_job_information_id']], [])); + return new RelationshipJobInfo($this->send("get", array_filter($params, fn($key) => in_array($key, ['relationship_job_information_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** - * Delete relationship job information + * Delete relationship job inoperationation * * @param array{relationship_job_information_id: string} $params An * associative array @@ -79,17 +79,17 @@ public function deleteByRelationshipJobInformationId(array $params): mixed { assert(isset($params['relationship_job_information_id']), new ArgumentException("Parameter `relationship_job_information_id` is required")); - return $this->send("delete", ["relationship_job_information_id" => $params['relationship_job_information_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['relationship_job_information_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** - * This form is used to edit relationship job information. + * This operation is used to edit relationship job inoperationation. * * @param array{relationship_job_information_id: string} $params An * associative array * - relationship_job_information_id: The relationship job information * id. - * @param \Blackbaud\SKY\Altru\Constituent\Components\UpdateRelationshipJobInfo + * @param \Blackbaud\SKY\Altru\Constituent\Components\EditRelationshipJobInfo * $requestBody ConfigurationMessage object representing operation * intended to be created * @@ -99,11 +99,11 @@ public function deleteByRelationshipJobInformationId(array $params): mixed * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required * parameters are not defined */ - public function patchOnRelationshipJobInformationId(array $params, UpdateRelationshipJobInfo $requestBody): mixed + public function patchOnRelationshipJobInformationId(array $params, EditRelationshipJobInfo $requestBody): mixed { assert(isset($params['relationship_job_information_id']), new ArgumentException("Parameter `relationship_job_information_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["relationship_job_information_id" => $params['relationship_job_information_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['relationship_job_information_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Solicitcodes.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Solicitcodes.php index c5c1bbae..f665ad51 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Solicitcodes.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Solicitcodes.php @@ -5,9 +5,9 @@ use Battis\OpenAPI\Client\BaseEndpoint; use Battis\OpenAPI\Client\Exceptions\ArgumentException; use Blackbaud\SKY\Altru\Constituent\Components\ConstituentSolicitCode; +use Blackbaud\SKY\Altru\Constituent\Components\EditConstituentSolicitCode; use Blackbaud\SKY\Altru\Constituent\Components\NewConstituentSolicitCode; use Blackbaud\SKY\Altru\Constituent\Components\PostResponse; -use Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentSolicitCode; /** * @api @@ -36,7 +36,7 @@ public function post(NewConstituentSolicitCode $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } /** @@ -57,7 +57,7 @@ public function getByConstituentSolicitCodeId(array $params): ConstituentSolicit { assert(isset($params['constituent_solicit_code_id']), new ArgumentException("Parameter `constituent_solicit_code_id` is required")); - return new ConstituentSolicitCode($this->send("get", ["constituent_solicit_code_id" => $params['constituent_solicit_code_id']], [])); + return new ConstituentSolicitCode($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituent_solicit_code_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -77,7 +77,7 @@ public function deleteByConstituentSolicitCodeId(array $params): mixed { assert(isset($params['constituent_solicit_code_id']), new ArgumentException("Parameter `constituent_solicit_code_id` is required")); - return $this->send("delete", ["constituent_solicit_code_id" => $params['constituent_solicit_code_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['constituent_solicit_code_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** @@ -86,7 +86,7 @@ public function deleteByConstituentSolicitCodeId(array $params): mixed * @param array{constituent_solicit_code_id: string} $params An * associative array * - constituent_solicit_code_id: The constituent solicit code id. - * @param \Blackbaud\SKY\Altru\Constituent\Components\UpdateConstituentSolicitCode + * @param \Blackbaud\SKY\Altru\Constituent\Components\EditConstituentSolicitCode * $requestBody ConfigurationMessage object representing operation * intended to be created * @@ -96,11 +96,11 @@ public function deleteByConstituentSolicitCodeId(array $params): mixed * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required * parameters are not defined */ - public function patchOnConstituentSolicitCodeId(array $params, UpdateConstituentSolicitCode $requestBody): mixed + public function patchOnConstituentSolicitCodeId(array $params, EditConstituentSolicitCode $requestBody): mixed { assert(isset($params['constituent_solicit_code_id']), new ArgumentException("Parameter `constituent_solicit_code_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["constituent_solicit_code_id" => $params['constituent_solicit_code_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['constituent_solicit_code_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/States.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/States.php index c7e5ab60..6ca42229 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/States.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/States.php @@ -19,11 +19,20 @@ class States extends BaseEndpoint /** * Lists all states for a given country. * - * @param array{country_id: string, include_inactive: bool, limit: int} - * $params An associative array + * @param array{country_id: string, include_inactive: bool, limit: int, + * session_key: string, infinity_session: string, more_rows_range_key: + * string, start_row_index: int} $params An associative array * - country_id: The country id. * - include_inactive: include inactive * - limit: Limits the number of records to return. + * - session_key: A unique key provided by user for paging results. + * The same key will be returned in a successful response. + * - infinity_session: Values for cookies related to the Infinity load + * balancer session. + * - more_rows_range_key: Key for accessing cached results on + * subsequent calls to this data list. + * - start_row_index: Number of rows to skip,get result after these + * rows. * * @return \Blackbaud\SKY\Altru\Constituent\Components\StateListCollection * Returned when the operation succeeds. The response body contains a @@ -37,8 +46,11 @@ public function searchByCountryId(array $params): StateListCollection assert(isset($params['country_id']), new ArgumentException("Parameter `country_id` is required")); assert(isset($params['include_inactive']), new ArgumentException("Parameter `include_inactive` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); + assert(isset($params['session_key']), new ArgumentException("Parameter `session_key` is required")); + assert(isset($params['infinity_session']), new ArgumentException("Parameter `infinity_session` is required")); + assert(isset($params['more_rows_range_key']), new ArgumentException("Parameter `more_rows_range_key` is required")); + assert(isset($params['start_row_index']), new ArgumentException("Parameter `start_row_index` is required")); - return new StateListCollection($this->send("get", ["country_id" => $params['country_id']], ["include_inactive" => $params['include_inactive'], - "limit" => $params['limit']])); + return new StateListCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['country_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['include_inactive','limit','session_key','infinity_session','more_rows_range_key','start_row_index']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Tribute.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Tribute.php index a613523f..114ec8a6 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Tribute.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Tribute.php @@ -4,10 +4,10 @@ use Battis\OpenAPI\Client\BaseEndpoint; use Battis\OpenAPI\Client\Exceptions\ArgumentException; +use Blackbaud\SKY\Altru\Constituent\Components\EditTribute; use Blackbaud\SKY\Altru\Constituent\Components\NewTribute; use Blackbaud\SKY\Altru\Constituent\Components\PostResponse; use Blackbaud\SKY\Altru\Constituent\Components\Tribute as Components_Tribute; -use Blackbaud\SKY\Altru\Constituent\Components\UpdateTribute; /** * @api @@ -20,7 +20,7 @@ class Tribute extends BaseEndpoint protected string $url = "https://api.sky.blackbaud.com/alt-conmg/tribute/{revenue_tribute_id}"; /** - * This form is used for adding a new tribute to a revenue record. + * This operation is used for adding a new tribute to a revenue record. * * @param \Blackbaud\SKY\Altru\Constituent\Components\NewTribute * $requestBody ConfigurationMessage object representing operation @@ -36,11 +36,12 @@ public function post(NewTribute $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } /** - * This form is used for editing a tribute for a given revenue record. + * This operation is used for editing a tribute for a given revenue + * record. * * @param array{revenue_tribute_id: string} $params An associative array * - revenue_tribute_id: The revenue tribute id. @@ -56,15 +57,16 @@ public function getByRevenueTributeId(array $params): Components_Tribute { assert(isset($params['revenue_tribute_id']), new ArgumentException("Parameter `revenue_tribute_id` is required")); - return new Components_Tribute($this->send("get", ["revenue_tribute_id" => $params['revenue_tribute_id']], [])); + return new Components_Tribute($this->send("get", array_filter($params, fn($key) => in_array($key, ['revenue_tribute_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** - * This form is used for editing a tribute for a given revenue record. + * This operation is used for editing a tribute for a given revenue + * record. * * @param array{revenue_tribute_id: string} $params An associative array * - revenue_tribute_id: The revenue tribute id. - * @param \Blackbaud\SKY\Altru\Constituent\Components\UpdateTribute + * @param \Blackbaud\SKY\Altru\Constituent\Components\EditTribute * $requestBody ConfigurationMessage object representing operation * intended to be created * @@ -74,11 +76,11 @@ public function getByRevenueTributeId(array $params): Components_Tribute * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required * parameters are not defined */ - public function patchOnRevenueTributeId(array $params, UpdateTribute $requestBody): mixed + public function patchOnRevenueTributeId(array $params, EditTribute $requestBody): mixed { assert(isset($params['revenue_tribute_id']), new ArgumentException("Parameter `revenue_tribute_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["revenue_tribute_id" => $params['revenue_tribute_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['revenue_tribute_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Tributes.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Tributes.php index 85e31ba0..2001beb0 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Tributes.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Tributes.php @@ -51,6 +51,6 @@ public function deleteByRevenueTributeId(array $params): mixed { assert(isset($params['revenue_tribute_id']), new ArgumentException("Parameter `revenue_tribute_id` is required")); - return $this->send("delete", ["revenue_tribute_id" => $params['revenue_tribute_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['revenue_tribute_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } } diff --git a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Tributes/Search.php b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Tributes/Search.php index 6cf16f08..bcfa7c20 100644 --- a/packages/altru-constituent/src/Altru/Constituent/Endpoints/Tributes/Search.php +++ b/packages/altru-constituent/src/Altru/Constituent/Endpoints/Tributes/Search.php @@ -24,12 +24,12 @@ class Search extends BaseEndpoint * string, acknowledgee_key_name: string, acknowledgee_first_name: string, * date_filter: "This week"|"This month"|"This quarter"|"This year", * designation: string, site_id: string, include_inactive: bool, - * exact__matchonly: bool, limit: int} $params An associative array + * exact_match_only: bool, limit: int} $params An associative array * - tribute_text: tribute text * - tributee_key_name: tributee last/org name * - tributee_first_name: tributee first name * - tributee_lookup_id: tributee lookup id - * - tribute_type: tribute type This codetable can be queried at + * - tribute_type: tribute type This code table can be queried at * https://api.sky.blackbaud.com/alt-adnmg/codetables/TRIBUTETYPECODE/entries * - acknowledgee_key_name: acknowledgee last/org name * - acknowledgee_first_name: acknowledgee first name @@ -37,7 +37,7 @@ class Search extends BaseEndpoint * - designation: default designation * - site_id: site * - include_inactive: include inactive tributes - * - exact__matchonly: match all criteria exactly + * - exact_match_only: match all criteria exactly * - limit: Limits the number of records to return. * * @return \Blackbaud\SKY\Altru\Constituent\Components\TributeSearchCollection @@ -60,21 +60,9 @@ public function list_(array $params): TributeSearchCollection assert(isset($params['designation']), new ArgumentException("Parameter `designation` is required")); assert(isset($params['site_id']), new ArgumentException("Parameter `site_id` is required")); assert(isset($params['include_inactive']), new ArgumentException("Parameter `include_inactive` is required")); - assert(isset($params['exact__matchonly']), new ArgumentException("Parameter `exact__matchonly` is required")); + assert(isset($params['exact_match_only']), new ArgumentException("Parameter `exact_match_only` is required")); assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); - return new TributeSearchCollection($this->send("get", [], ["tribute_text" => $params['tribute_text'], - "tributee_key_name" => $params['tributee_key_name'], - "tributee_first_name" => $params['tributee_first_name'], - "tributee_lookup_id" => $params['tributee_lookup_id'], - "tribute_type" => $params['tribute_type'], - "acknowledgee_key_name" => $params['acknowledgee_key_name'], - "acknowledgee_first_name" => $params['acknowledgee_first_name'], - "date_filter" => $params['date_filter'], - "designation" => $params['designation'], - "site_id" => $params['site_id'], - "include_inactive" => $params['include_inactive'], - "exact__matchonly" => $params['exact__matchonly'], - "limit" => $params['limit']])); + return new TributeSearchCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['tribute_text','tributee_key_name','tributee_first_name','tributee_lookup_id','tribute_type','acknowledgee_key_name','acknowledgee_first_name','date_filter','designation','site_id','include_inactive','exact_match_only','limit']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Appeals.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Appeals.php index 101fa7d0..d0cb36d4 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Appeals.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Appeals.php @@ -37,7 +37,7 @@ public function getById(array $params): Appeal { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new Appeal($this->send("get", ["id" => $params['id']], [])); + return new Appeal($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -56,7 +56,7 @@ public function deleteById(array $params): mixed { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return $this->send("delete", ["id" => $params['id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** @@ -77,7 +77,7 @@ public function patchOnId(array $params, AppealEdit $requestBody): mixed assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["id" => $params['id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -106,11 +106,7 @@ public function list_(array $params): AppealCollection assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); assert(isset($params['offset']), new ArgumentException("Parameter `offset` is required")); - return new AppealCollection($this->send("get", [], ["appeal_id" => $params['appeal_id'], - "description" => $params['description'], - "include_inactive" => $params['include_inactive'], - "limit" => $params['limit'], - "offset" => $params['offset']])); + return new AppealCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['appeal_id','description','include_inactive','limit','offset']), ARRAY_FILTER_USE_KEY))); } /** @@ -130,6 +126,6 @@ public function post(AppealCreate $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Campaigns.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Campaigns.php index 53eab24c..ef62a034 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Campaigns.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Campaigns.php @@ -37,7 +37,7 @@ public function getById(array $params): Campaign { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new Campaign($this->send("get", ["id" => $params['id']], [])); + return new Campaign($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -56,7 +56,7 @@ public function deleteById(array $params): mixed { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return $this->send("delete", ["id" => $params['id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** @@ -77,7 +77,7 @@ public function patchOnId(array $params, CampaignEdit $requestBody): mixed assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["id" => $params['id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -108,11 +108,7 @@ public function list_(array $params): CampaignCollection assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); assert(isset($params['offset']), new ArgumentException("Parameter `offset` is required")); - return new CampaignCollection($this->send("get", [], ["campaign_id" => $params['campaign_id'], - "description" => $params['description'], - "include_inactive" => $params['include_inactive'], - "limit" => $params['limit'], - "offset" => $params['offset']])); + return new CampaignCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['campaign_id','description','include_inactive','limit','offset']), ARRAY_FILTER_USE_KEY))); } /** @@ -132,6 +128,6 @@ public function post(CampaignCreate $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Codetables.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Codetables.php index e5d09fb8..69051f3c 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Codetables.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Codetables.php @@ -65,10 +65,7 @@ public function list_(array $params): CodeTableCollection assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); assert(isset($params['offset']), new ArgumentException("Parameter `offset` is required")); - return new CodeTableCollection($this->send("get", [], ["name" => $params['name'], - "include_hidden_system" => $params['include_hidden_system'], - "limit" => $params['limit'], - "offset" => $params['offset']])); + return new CodeTableCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['name','include_hidden_system','limit','offset']), ARRAY_FILTER_USE_KEY))); } /** @@ -88,7 +85,7 @@ public function post(CodeTableCreate $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } /** @@ -108,7 +105,7 @@ public function getById(array $params): CodeTable { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new CodeTable($this->send("get", ["id" => $params['id']], [])); + return new CodeTable($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -127,7 +124,7 @@ public function deleteById(array $params): mixed { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return $this->send("delete", ["id" => $params['id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** @@ -148,6 +145,6 @@ public function patchOnId(array $params, CodeTableEdit $requestBody): mixed assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["id" => $params['id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Codetables/Tableentries.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Codetables/Tableentries.php index 90439aff..4b14ae9b 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Codetables/Tableentries.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Codetables/Tableentries.php @@ -39,8 +39,7 @@ public function getByCodeTableIdAndId(array $params): TableEntry assert(isset($params['code_table_id']), new ArgumentException("Parameter `code_table_id` is required")); assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new TableEntry($this->send("get", ["code_table_id" => $params['code_table_id'], - "id" => $params['id']], [])); + return new TableEntry($this->send("get", array_filter($params, fn($key) => in_array($key, ['code_table_id','id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -61,8 +60,7 @@ public function deleteByCodeTableIdAndId(array $params): mixed assert(isset($params['code_table_id']), new ArgumentException("Parameter `code_table_id` is required")); assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return $this->send("delete", ["code_table_id" => $params['code_table_id'], - "id" => $params['id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['code_table_id','id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** @@ -85,8 +83,7 @@ public function patchOnCodeTableIdAndId(array $params, TableEntryEdit $requestBo assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["code_table_id" => $params['code_table_id'], - "id" => $params['id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['code_table_id','id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -122,12 +119,7 @@ public function searchByCodeTableId(array $params): TableEntryCollection assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); assert(isset($params['offset']), new ArgumentException("Parameter `offset` is required")); - return new TableEntryCollection($this->send("get", ["code_table_id" => $params['code_table_id']], ["long_description" => $params['long_description'], - "short_description" => $params['short_description'], - "numeric_value" => $params['numeric_value'], - "include_inactive" => $params['include_inactive'], - "limit" => $params['limit'], - "offset" => $params['offset']])); + return new TableEntryCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['code_table_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['long_description','short_description','numeric_value','include_inactive','limit','offset']), ARRAY_FILTER_USE_KEY))); } /** @@ -150,6 +142,6 @@ public function postToCodeTableId(array $params, TableEntryCreate $requestBody): assert(isset($params['code_table_id']), new ArgumentException("Parameter `code_table_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", ["code_table_id" => $params['code_table_id']], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['code_table_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Constitappeals.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Constitappeals.php index 7ed70d0f..1e2091c2 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Constitappeals.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Constitappeals.php @@ -35,7 +35,7 @@ public function post(ConstituentAppealCreate $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } /** @@ -54,7 +54,7 @@ public function deleteById(array $params): mixed { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return $this->send("delete", ["id" => $params['id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** @@ -75,6 +75,6 @@ public function patchOnId(array $params, ConstituentAppealEdit $requestBody): mi assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["id" => $params['id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Constituentidmap.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Constituentidmap.php index 1df92f8b..964c6377 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Constituentidmap.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Constituentidmap.php @@ -34,6 +34,6 @@ public function getByConstituentid(array $params): Components_ConstituentIdMap { assert(isset($params['constituentid']), new ArgumentException("Parameter `constituentid` is required")); - return new Components_ConstituentIdMap($this->send("get", ["constituentid" => $params['constituentid']], [])); + return new Components_ConstituentIdMap($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituentid']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Constituents.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Constituents.php index be4ea45a..d36f7d7c 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Constituents.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Constituents.php @@ -62,6 +62,6 @@ public function deleteById(array $params): mixed { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return $this->send("delete", ["id" => $params['id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Constituents/Customsearch.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Constituents/Customsearch.php index bc138aae..a25db4a7 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Constituents/Customsearch.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Constituents/Customsearch.php @@ -65,19 +65,6 @@ public function list_(array $params): ConstituentCollection assert(isset($params['include_alias']), new ArgumentException("Parameter `include_alias` is required")); assert(isset($params['record_ids']), new ArgumentException("Parameter `record_ids` is required")); - return new ConstituentCollection($this->send("get", [], ["limit" => $params['limit'], - "first_name" => $params['first_name'], - "last_name" => $params['last_name'], - "alias_type" => $params['alias_type'], - "lookup_id" => $params['lookup_id'], - "address_lines" => $params['address_lines'], - "city" => $params['city'], - "state" => $params['state'], - "post_code" => $params['post_code'], - "email" => $params['email'], - "phone_number" => $params['phone_number'], - "include_maiden_name" => $params['include_maiden_name'], - "include_alias" => $params['include_alias'], - "record_ids" => $params['record_ids']])); + return new ConstituentCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['limit','first_name','last_name','alias_type','lookup_id','address_lines','city','state','post_code','email','phone_number','include_maiden_name','include_alias','record_ids']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Constituents/Fund.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Constituents/Fund.php index acd7ca35..ce1fb21f 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Constituents/Fund.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Constituents/Fund.php @@ -40,7 +40,6 @@ public function searchByFundId(array $params): ConstituentByFundCollection assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); assert(isset($params['offset']), new ArgumentException("Parameter `offset` is required")); - return new ConstituentByFundCollection($this->send("get", ["fundId" => $params['fundId']], ["limit" => $params['limit'], - "offset" => $params['offset']])); + return new ConstituentByFundCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['fundId']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['limit','offset']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Countries.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Countries.php index 7ef89fbe..43c48921 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Countries.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Countries.php @@ -36,7 +36,7 @@ public function getById(array $params): Country { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new Country($this->send("get", ["id" => $params['id']], [])); + return new Country($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -55,7 +55,7 @@ public function deleteById(array $params): mixed { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return $this->send("delete", ["id" => $params['id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** @@ -76,7 +76,7 @@ public function patchOnId(array $params, CountryEdit $requestBody): mixed assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["id" => $params['id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -98,8 +98,7 @@ public function list_(array $params): CountryCollection assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); assert(isset($params['offset']), new ArgumentException("Parameter `offset` is required")); - return new CountryCollection($this->send("get", [], ["limit" => $params['limit'], - "offset" => $params['offset']])); + return new CountryCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['limit','offset']), ARRAY_FILTER_USE_KEY))); } /** @@ -119,6 +118,6 @@ public function post(CountryCreate $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Customfieldcategories.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Customfieldcategories.php index ee7142cc..a73cb89a 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Customfieldcategories.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Customfieldcategories.php @@ -37,7 +37,7 @@ public function getById(array $params): CustomFieldCategory { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new CustomFieldCategory($this->send("get", ["id" => $params['id']], [])); + return new CustomFieldCategory($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -56,7 +56,7 @@ public function deleteById(array $params): mixed { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return $this->send("delete", ["id" => $params['id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** @@ -77,7 +77,7 @@ public function patchOnId(array $params, CustomFieldCategoryEdit $requestBody): assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["id" => $params['id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -106,10 +106,7 @@ public function list_(array $params): CustomFieldCategoryCollection assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); assert(isset($params['offset']), new ArgumentException("Parameter `offset` is required")); - return new CustomFieldCategoryCollection($this->send("get", [], ["record_type" => $params['record_type'], - "include_inactive" => $params['include_inactive'], - "limit" => $params['limit'], - "offset" => $params['offset']])); + return new CustomFieldCategoryCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['record_type','include_inactive','limit','offset']), ARRAY_FILTER_USE_KEY))); } /** @@ -129,6 +126,6 @@ public function post(CustomFieldCategoryCreate $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Funds.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Funds.php index 63575449..754170c9 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Funds.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Funds.php @@ -57,7 +57,7 @@ public function getById(array $params): Fund { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new Fund($this->send("get", ["id" => $params['id']], [])); + return new Fund($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -76,7 +76,7 @@ public function deleteById(array $params): mixed { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return $this->send("delete", ["id" => $params['id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** @@ -97,7 +97,7 @@ public function patchOnId(array $params, FundEdit $requestBody): mixed assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["id" => $params['id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -126,11 +126,7 @@ public function list_(array $params): FundCollection assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); assert(isset($params['offset']), new ArgumentException("Parameter `offset` is required")); - return new FundCollection($this->send("get", [], ["fund_id" => $params['fund_id'], - "description" => $params['description'], - "include_inactive" => $params['include_inactive'], - "limit" => $params['limit'], - "offset" => $params['offset']])); + return new FundCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['fund_id','description','include_inactive','limit','offset']), ARRAY_FILTER_USE_KEY))); } /** @@ -150,6 +146,6 @@ public function post(FundCreate $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Funds/Constituent.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Funds/Constituent.php index 81c46d1c..0e8dbdbb 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Funds/Constituent.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Funds/Constituent.php @@ -40,7 +40,6 @@ public function searchByConstituentId(array $params): FundCollection assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); assert(isset($params['offset']), new ArgumentException("Parameter `offset` is required")); - return new FundCollection($this->send("get", ["constituentId" => $params['constituentId']], ["limit" => $params['limit'], - "offset" => $params['offset']])); + return new FundCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituentId']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['limit','offset']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Giftaid/Constituents/Taxdeclarations.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Giftaid/Constituents/Taxdeclarations.php index 56a8829b..b80942ee 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Giftaid/Constituents/Taxdeclarations.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Giftaid/Constituents/Taxdeclarations.php @@ -38,7 +38,6 @@ public function searchById(array $params): GiftAidTaxDeclarationCollection assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); assert(isset($params['offset']), new ArgumentException("Parameter `offset` is required")); - return new GiftAidTaxDeclarationCollection($this->send("get", ["id" => $params['id']], ["limit" => $params['limit'], - "offset" => $params['offset']])); + return new GiftAidTaxDeclarationCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['limit','offset']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Giftaid/Taxdeclarations.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Giftaid/Taxdeclarations.php index de13ccaf..3c6500d1 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Giftaid/Taxdeclarations.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Giftaid/Taxdeclarations.php @@ -36,7 +36,7 @@ public function getById(array $params): GiftAidTaxDeclaration { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new GiftAidTaxDeclaration($this->send("get", ["id" => $params['id']], [])); + return new GiftAidTaxDeclaration($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -55,7 +55,7 @@ public function deleteById(array $params): GiftAidTaxDeclaration { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new GiftAidTaxDeclaration($this->send("delete", ["id" => $params['id']], [])); + return new GiftAidTaxDeclaration($this->send("delete", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -76,7 +76,7 @@ public function patchOnId(array $params, GiftAidTaxDeclarationEdit $requestBody) assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["id" => $params['id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -96,6 +96,6 @@ public function post(GiftAidTaxDeclarationCreate $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Giftidmap.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Giftidmap.php index 02d9f10b..7182f244 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Giftidmap.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Giftidmap.php @@ -33,6 +33,6 @@ public function getByGiftlookupid(array $params): Components_GiftIdMap { assert(isset($params['giftlookupid']), new ArgumentException("Parameter `giftlookupid` is required")); - return new Components_GiftIdMap($this->send("get", ["giftlookupid" => $params['giftlookupid']], [])); + return new Components_GiftIdMap($this->send("get", array_filter($params, fn($key) => in_array($key, ['giftlookupid']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Gifts/Notes.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Gifts/Notes.php index 6fa2ac6f..cb5df3ce 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Gifts/Notes.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Gifts/Notes.php @@ -37,7 +37,7 @@ public function post(GiftNoteCreate $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } /** @@ -57,7 +57,7 @@ public function getById(array $params): GiftNote { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new GiftNote($this->send("get", ["id" => $params['id']], [])); + return new GiftNote($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -76,7 +76,7 @@ public function deleteById(array $params): mixed { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return $this->send("delete", ["id" => $params['id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** @@ -97,7 +97,7 @@ public function patchOnId(array $params, GiftNoteEdit $requestBody): mixed assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["id" => $params['id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -122,7 +122,6 @@ public function searchByGiftId(array $params): GiftNoteCollection assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); assert(isset($params['offset']), new ArgumentException("Parameter `offset` is required")); - return new GiftNoteCollection($this->send("get", ["gift_id" => $params['gift_id']], ["limit" => $params['limit'], - "offset" => $params['offset']])); + return new GiftNoteCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['gift_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['limit','offset']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Gifttribute.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Gifttribute.php index b57fb3ac..8783fd4d 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Gifttribute.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Gifttribute.php @@ -77,7 +77,7 @@ public function getByGiftTributeId(array $params): Components_GiftTribute { assert(isset($params['giftTributeId']), new ArgumentException("Parameter `giftTributeId` is required")); - return new Components_GiftTribute($this->send("get", ["giftTributeId" => $params['giftTributeId']], [])); + return new Components_GiftTribute($this->send("get", array_filter($params, fn($key) => in_array($key, ['giftTributeId']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -97,7 +97,7 @@ public function deleteByGiftTributeId(array $params): mixed { assert(isset($params['giftTributeId']), new ArgumentException("Parameter `giftTributeId` is required")); - return $this->send("delete", ["giftTributeId" => $params['giftTributeId']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['giftTributeId']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** @@ -119,7 +119,7 @@ public function patchOnGiftTributeId(array $params, GiftTributeEdit $requestBody assert(isset($params['giftTributeId']), new ArgumentException("Parameter `giftTributeId` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["giftTributeId" => $params['giftTributeId']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['giftTributeId']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -141,8 +141,7 @@ public function list_(array $params): GiftTributeCollection assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); assert(isset($params['offset']), new ArgumentException("Parameter `offset` is required")); - return new GiftTributeCollection($this->send("get", [], ["limit" => $params['limit'], - "offset" => $params['offset']])); + return new GiftTributeCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['limit','offset']), ARRAY_FILTER_USE_KEY))); } /** @@ -162,6 +161,6 @@ public function post(GiftTributeCreate $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Gifttribute/Acknowledgees.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Gifttribute/Acknowledgees.php index e2b28cf9..a9c31b65 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Gifttribute/Acknowledgees.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Gifttribute/Acknowledgees.php @@ -35,7 +35,7 @@ public function searchByGiftTributeId(array $params): GiftTributeAcknowledgeeCol { assert(isset($params['giftTributeId']), new ArgumentException("Parameter `giftTributeId` is required")); - return new GiftTributeAcknowledgeeCollection($this->send("get", ["giftTributeId" => $params['giftTributeId']], [])); + return new GiftTributeAcknowledgeeCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['giftTributeId']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -59,6 +59,6 @@ public function patchOnGiftTributeAcknowledgeeId(array $params, GiftTributeAckno assert(isset($params['giftTributeAcknowledgeeId']), new ArgumentException("Parameter `giftTributeAcknowledgeeId` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["giftTributeAcknowledgeeId" => $params['giftTributeAcknowledgeeId']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['giftTributeAcknowledgeeId']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Gifttribute/Gift.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Gifttribute/Gift.php index 4e4d99cf..151fbf3f 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Gifttribute/Gift.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Gifttribute/Gift.php @@ -33,6 +33,6 @@ public function searchByGiftId(array $params): GiftTributeCollection { assert(isset($params['giftId']), new ArgumentException("Parameter `giftId` is required")); - return new GiftTributeCollection($this->send("get", ["giftId" => $params['giftId']], [])); + return new GiftTributeCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['giftId']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Gifttribute/Importid.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Gifttribute/Importid.php index f3cf83c9..049fab80 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Gifttribute/Importid.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Gifttribute/Importid.php @@ -33,6 +33,6 @@ public function getByImportId(array $params): GiftTribute { assert(isset($params['importId']), new ArgumentException("Parameter `importId` is required")); - return new GiftTribute($this->send("get", ["importId" => $params['importId']], [])); + return new GiftTribute($this->send("get", array_filter($params, fn($key) => in_array($key, ['importId']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Importidmap/Constituent.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Importidmap/Constituent.php index 013cc42a..4ab577c6 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Importidmap/Constituent.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Importidmap/Constituent.php @@ -33,6 +33,6 @@ public function getByImportid(array $params): ImportIdMap { assert(isset($params['importid']), new ArgumentException("Parameter `importid` is required")); - return new ImportIdMap($this->send("get", ["importid" => $params['importid']], [])); + return new ImportIdMap($this->send("get", array_filter($params, fn($key) => in_array($key, ['importid']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Importidmap/Gift.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Importidmap/Gift.php index e401e392..63373bcd 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Importidmap/Gift.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Importidmap/Gift.php @@ -33,6 +33,6 @@ public function getByImportid(array $params): ImportIdMap { assert(isset($params['importid']), new ArgumentException("Parameter `importid` is required")); - return new ImportIdMap($this->send("get", ["importid" => $params['importid']], [])); + return new ImportIdMap($this->send("get", array_filter($params, fn($key) => in_array($key, ['importid']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Installedcountry.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Installedcountry.php index a3a70b1d..0770e2bf 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Installedcountry.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Installedcountry.php @@ -23,6 +23,6 @@ class Installedcountry extends BaseEndpoint */ public function get(): string { - return $this->send("get", [], []); + return $this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Nameformatconfigurations.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Nameformatconfigurations.php index a8df7962..2dd8e9ab 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Nameformatconfigurations.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Nameformatconfigurations.php @@ -58,7 +58,7 @@ public function getById(array $params): NameFormatConfiguration { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new NameFormatConfiguration($this->send("get", ["id" => $params['id']], [])); + return new NameFormatConfiguration($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -77,7 +77,7 @@ public function deleteById(array $params): mixed { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return $this->send("delete", ["id" => $params['id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** @@ -99,7 +99,7 @@ public function patchOnId(array $params, NameFormatConfigurationEdit $requestBod assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["id" => $params['id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -111,7 +111,7 @@ public function patchOnId(array $params, NameFormatConfigurationEdit $requestBod */ public function list_(): NameFormatConfigurationCollection { - return new NameFormatConfigurationCollection($this->send("get", [], [])); + return new NameFormatConfigurationCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -131,6 +131,6 @@ public function post(NameFormatConfigurationCreate $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Nameformatconfigurations/Fields.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Nameformatconfigurations/Fields.php index 99e9b619..5c49ad5b 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Nameformatconfigurations/Fields.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Nameformatconfigurations/Fields.php @@ -38,7 +38,7 @@ public function getById(array $params): NameFormatConfigurationField { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new NameFormatConfigurationField($this->send("get", ["id" => $params['id']], [])); + return new NameFormatConfigurationField($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -58,7 +58,7 @@ public function deleteById(array $params): mixed { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return $this->send("delete", ["id" => $params['id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** @@ -81,7 +81,7 @@ public function patchOnId(array $params, NameFormatConfigurationFieldEdit $reque assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["id" => $params['id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -93,7 +93,7 @@ public function patchOnId(array $params, NameFormatConfigurationFieldEdit $reque */ public function list_(): NameFormatConfigurationFieldCollection { - return new NameFormatConfigurationFieldCollection($this->send("get", [], [])); + return new NameFormatConfigurationFieldCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -113,6 +113,6 @@ public function post(NameFormatConfigurationFieldCreate $requestBody): PostRespo { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Phonetypes.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Phonetypes.php index 350480aa..bd0e590d 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Phonetypes.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Phonetypes.php @@ -37,7 +37,7 @@ public function getById(array $params): PhoneType { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new PhoneType($this->send("get", ["id" => $params['id']], [])); + return new PhoneType($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -56,7 +56,7 @@ public function deleteById(array $params): mixed { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return $this->send("delete", ["id" => $params['id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** @@ -77,7 +77,7 @@ public function patchOnId(array $params, PhoneTypeEdit $requestBody): mixed assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["id" => $params['id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -111,12 +111,7 @@ public function list_(array $params): PhoneTypeCollection assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); assert(isset($params['offset']), new ArgumentException("Parameter `offset` is required")); - return new PhoneTypeCollection($this->send("get", [], ["description" => $params['description'], - "type" => $params['type'], - "format" => $params['format'], - "include_inactive" => $params['include_inactive'], - "limit" => $params['limit'], - "offset" => $params['offset']])); + return new PhoneTypeCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['description','type','format','include_inactive','limit','offset']), ARRAY_FILTER_USE_KEY))); } /** @@ -136,6 +131,6 @@ public function post(PhoneTypeCreate $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Proposals.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Proposals.php index 3f4fe76f..03559333 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Proposals.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Proposals.php @@ -31,6 +31,6 @@ public function deleteById(array $params): mixed { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return $this->send("delete", ["id" => $params['id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Relationships/Constituents/Fund.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Relationships/Constituents/Fund.php index 4b7e320d..66e7c974 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Relationships/Constituents/Fund.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Relationships/Constituents/Fund.php @@ -40,7 +40,6 @@ public function searchByFundId(array $params): RelationshipCollection assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); assert(isset($params['offset']), new ArgumentException("Parameter `offset` is required")); - return new RelationshipCollection($this->send("get", ["fundId" => $params['fundId']], ["limit" => $params['limit'], - "offset" => $params['offset']])); + return new RelationshipCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['fundId']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['limit','offset']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Relationships/Funds/Constituent.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Relationships/Funds/Constituent.php index a6c9e0ba..9e2fb6d2 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Relationships/Funds/Constituent.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Relationships/Funds/Constituent.php @@ -40,7 +40,6 @@ public function searchByConstituentId(array $params): RelationshipCollection assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); assert(isset($params['offset']), new ArgumentException("Parameter `offset` is required")); - return new RelationshipCollection($this->send("get", ["constituentId" => $params['constituentId']], ["limit" => $params['limit'], - "offset" => $params['offset']])); + return new RelationshipCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituentId']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['limit','offset']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Serialnumber.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Serialnumber.php index 5a0491dc..b52f968a 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Serialnumber.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Serialnumber.php @@ -22,6 +22,6 @@ class Serialnumber extends BaseEndpoint */ public function get(): string { - return $this->send("get", [], []); + return $this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Tribute.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Tribute.php index 7f601f55..aaec656d 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Tribute.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Tribute.php @@ -86,7 +86,7 @@ public function getById(array $params): Components_Tribute { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new Components_Tribute($this->send("get", ["id" => $params['id']], [])); + return new Components_Tribute($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -105,7 +105,7 @@ public function deleteById(array $params): mixed { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return $this->send("delete", ["id" => $params['id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** @@ -127,8 +127,7 @@ public function list_(array $params): TributeCollection assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); assert(isset($params['offset']), new ArgumentException("Parameter `offset` is required")); - return new TributeCollection($this->send("get", [], ["limit" => $params['limit'], - "offset" => $params['offset']])); + return new TributeCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['limit','offset']), ARRAY_FILTER_USE_KEY))); } /** @@ -148,6 +147,6 @@ public function post(TributeCreate $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Tribute/Acknowledgee.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Tribute/Acknowledgee.php index 2922aea0..a1fc62cc 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Tribute/Acknowledgee.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Tribute/Acknowledgee.php @@ -35,6 +35,6 @@ public function post(TributeAcknowledgeeCreate $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Tribute/Acknowledgees.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Tribute/Acknowledgees.php index 24810af7..df78d55e 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Tribute/Acknowledgees.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Tribute/Acknowledgees.php @@ -34,6 +34,6 @@ public function searchByTributeId(array $params): TributeAcknowledgeeCollection { assert(isset($params['tributeId']), new ArgumentException("Parameter `tributeId` is required")); - return new TributeAcknowledgeeCollection($this->send("get", ["tributeId" => $params['tributeId']], [])); + return new TributeAcknowledgeeCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['tributeId']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Tribute/Constituent.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Tribute/Constituent.php index 9c8d59b0..b67a85d4 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Tribute/Constituent.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Tribute/Constituent.php @@ -34,6 +34,6 @@ public function searchByConstituentId(array $params): TributeCollection { assert(isset($params['constituentId']), new ArgumentException("Parameter `constituentId` is required")); - return new TributeCollection($this->send("get", ["constituentId" => $params['constituentId']], [])); + return new TributeCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['constituentId']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Tribute/Importid.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Tribute/Importid.php index fbf7bd9d..b4d402d0 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Tribute/Importid.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Tribute/Importid.php @@ -33,6 +33,6 @@ public function getByImportid(array $params): Tribute { assert(isset($params['importid']), new ArgumentException("Parameter `importid` is required")); - return new Tribute($this->send("get", ["importid" => $params['importid']], [])); + return new Tribute($this->send("get", array_filter($params, fn($key) => in_array($key, ['importid']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Users.php b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Users.php index c89a6ef0..afedf4e7 100644 --- a/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Users.php +++ b/packages/nxt-data-integration/src/NXT/Data/Integration/Endpoints/V1/Re/Users.php @@ -33,6 +33,6 @@ public function getById(array $params): User { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new User($this->send("get", ["id" => $params['id']], [])); + return new User($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/AcademicSessions.php b/packages/oneroster/src/OneRoster/Endpoints/AcademicSessions.php index 53c23c6c..909ce0a6 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/AcademicSessions.php +++ b/packages/oneroster/src/OneRoster/Endpoints/AcademicSessions.php @@ -25,7 +25,7 @@ class AcademicSessions extends BaseEndpoint */ public function get(): AcademicSessionsOutputModel { - return new AcademicSessionsOutputModel($this->send("get", [], [])); + return new AcademicSessionsOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -44,6 +44,6 @@ public function getById(array $params): AcademicSessionOutputModel { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new AcademicSessionOutputModel($this->send("get", ["id" => $params['id']], [])); + return new AcademicSessionOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Categories.php b/packages/oneroster/src/OneRoster/Endpoints/Categories.php index 44a12c25..1db6650e 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Categories.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Categories.php @@ -26,7 +26,7 @@ class Categories extends BaseEndpoint */ public function get(): CategoriesOutputModel { - return new CategoriesOutputModel($this->send("get", [], [])); + return new CategoriesOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -45,7 +45,7 @@ public function getById(array $params): CategoryOutputModel { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new CategoryOutputModel($this->send("get", ["id" => $params['id']], [])); + return new CategoryOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -67,6 +67,6 @@ public function putById(array $params, CategoryInputModel $requestBody): Categor assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new CategoryOutputModel($this->send("put", ["id" => $params['id']], [], $requestBody)); + return new CategoryOutputModel($this->send("put", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Classes.php b/packages/oneroster/src/OneRoster/Endpoints/Classes.php index 23252611..aab7198b 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Classes.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Classes.php @@ -80,7 +80,7 @@ class Classes extends BaseEndpoint */ public function get(): ClassesOutputModel { - return new ClassesOutputModel($this->send("get", [], [])); + return new ClassesOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -99,6 +99,6 @@ public function getById(array $params): ClassOutputModel { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new ClassOutputModel($this->send("get", ["id" => $params['id']], [])); + return new ClassOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Classes/Categories.php b/packages/oneroster/src/OneRoster/Endpoints/Classes/Categories.php index f18c6a01..fa4ef2e2 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Classes/Categories.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Classes/Categories.php @@ -32,6 +32,6 @@ public function getByClassId(array $params): CategoriesOutputModel { assert(isset($params['class_id']), new ArgumentException("Parameter `class_id` is required")); - return new CategoriesOutputModel($this->send("get", ["class_id" => $params['class_id']], [])); + return new CategoriesOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['class_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Classes/LineItems.php b/packages/oneroster/src/OneRoster/Endpoints/Classes/LineItems.php index 0dc4d0bb..0ba69b9d 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Classes/LineItems.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Classes/LineItems.php @@ -52,6 +52,6 @@ public function getByClassId(array $params): LineItemsOutputModel { assert(isset($params['class_id']), new ArgumentException("Parameter `class_id` is required")); - return new LineItemsOutputModel($this->send("get", ["class_id" => $params['class_id']], [])); + return new LineItemsOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['class_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Classes/LineItems/Results.php b/packages/oneroster/src/OneRoster/Endpoints/Classes/LineItems/Results.php index abde955f..8b2c0668 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Classes/LineItems/Results.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Classes/LineItems/Results.php @@ -36,7 +36,6 @@ public function getByClassIdAndLiId(array $params): ResultsOutputModelSvc assert(isset($params['class_id']), new ArgumentException("Parameter `class_id` is required")); assert(isset($params['li_id']), new ArgumentException("Parameter `li_id` is required")); - return new ResultsOutputModelSvc($this->send("get", ["class_id" => $params['class_id'], - "li_id" => $params['li_id']], [])); + return new ResultsOutputModelSvc($this->send("get", array_filter($params, fn($key) => in_array($key, ['class_id','li_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Classes/Results.php b/packages/oneroster/src/OneRoster/Endpoints/Classes/Results.php index 11196307..e3b7dfe4 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Classes/Results.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Classes/Results.php @@ -32,6 +32,6 @@ public function getByClassId(array $params): ResultsOutputModelSvc { assert(isset($params['class_id']), new ArgumentException("Parameter `class_id` is required")); - return new ResultsOutputModelSvc($this->send("get", ["class_id" => $params['class_id']], [])); + return new ResultsOutputModelSvc($this->send("get", array_filter($params, fn($key) => in_array($key, ['class_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Classes/Students.php b/packages/oneroster/src/OneRoster/Endpoints/Classes/Students.php index d90e79b5..fd5e1944 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Classes/Students.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Classes/Students.php @@ -51,6 +51,6 @@ public function getByClassId(array $params): UsersOutputModel { assert(isset($params['class_id']), new ArgumentException("Parameter `class_id` is required")); - return new UsersOutputModel($this->send("get", ["class_id" => $params['class_id']], [])); + return new UsersOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['class_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Classes/Students/Results.php b/packages/oneroster/src/OneRoster/Endpoints/Classes/Students/Results.php index 20ebd445..72b895ed 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Classes/Students/Results.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Classes/Students/Results.php @@ -36,7 +36,6 @@ public function getByClassIdAndStudentId(array $params): ResultsOutputModelSvc assert(isset($params['class_id']), new ArgumentException("Parameter `class_id` is required")); assert(isset($params['student_id']), new ArgumentException("Parameter `student_id` is required")); - return new ResultsOutputModelSvc($this->send("get", ["class_id" => $params['class_id'], - "student_id" => $params['student_id']], [])); + return new ResultsOutputModelSvc($this->send("get", array_filter($params, fn($key) => in_array($key, ['class_id','student_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Classes/Teachers.php b/packages/oneroster/src/OneRoster/Endpoints/Classes/Teachers.php index 72ba52c2..44c2cdb6 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Classes/Teachers.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Classes/Teachers.php @@ -38,6 +38,6 @@ public function getByClassId(array $params): UsersOutputModel { assert(isset($params['class_id']), new ArgumentException("Parameter `class_id` is required")); - return new UsersOutputModel($this->send("get", ["class_id" => $params['class_id']], [])); + return new UsersOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['class_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Courses.php b/packages/oneroster/src/OneRoster/Endpoints/Courses.php index 20534757..5b65f79d 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Courses.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Courses.php @@ -25,7 +25,7 @@ class Courses extends BaseEndpoint */ public function get(): CoursesOutputModel { - return new CoursesOutputModel($this->send("get", [], [])); + return new CoursesOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -44,6 +44,6 @@ public function getById(array $params): CourseOutputModel { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new CourseOutputModel($this->send("get", ["id" => $params['id']], [])); + return new CourseOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Demographics.php b/packages/oneroster/src/OneRoster/Endpoints/Demographics.php index 5414b8c6..f771ea00 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Demographics.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Demographics.php @@ -25,7 +25,7 @@ class Demographics extends BaseEndpoint */ public function get(): DemographicsOutputModel { - return new DemographicsOutputModel($this->send("get", [], [])); + return new DemographicsOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -44,6 +44,6 @@ public function getById(array $params): DemographicOutputModel { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new DemographicOutputModel($this->send("get", ["id" => $params['id']], [])); + return new DemographicOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Enrollments.php b/packages/oneroster/src/OneRoster/Endpoints/Enrollments.php index 294c45e8..cc26ac05 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Enrollments.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Enrollments.php @@ -25,7 +25,7 @@ class Enrollments extends BaseEndpoint */ public function get(): EnrollmentsOutputModel { - return new EnrollmentsOutputModel($this->send("get", [], [])); + return new EnrollmentsOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -44,6 +44,6 @@ public function getById(array $params): EnrollmentOutputModel { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new EnrollmentOutputModel($this->send("get", ["id" => $params['id']], [])); + return new EnrollmentOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/GradingPeriods.php b/packages/oneroster/src/OneRoster/Endpoints/GradingPeriods.php index aaff9132..79484f70 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/GradingPeriods.php +++ b/packages/oneroster/src/OneRoster/Endpoints/GradingPeriods.php @@ -25,7 +25,7 @@ class GradingPeriods extends BaseEndpoint */ public function get(): AcademicSessionsOutputModel { - return new AcademicSessionsOutputModel($this->send("get", [], [])); + return new AcademicSessionsOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -44,6 +44,6 @@ public function getById(array $params): AcademicSessionOutputModel { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new AcademicSessionOutputModel($this->send("get", ["id" => $params['id']], [])); + return new AcademicSessionOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/LineItems.php b/packages/oneroster/src/OneRoster/Endpoints/LineItems.php index 17de8324..7195b0da 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/LineItems.php +++ b/packages/oneroster/src/OneRoster/Endpoints/LineItems.php @@ -26,7 +26,7 @@ class LineItems extends BaseEndpoint */ public function get(): LineItemsOutputModel { - return new LineItemsOutputModel($this->send("get", [], [])); + return new LineItemsOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -45,7 +45,7 @@ public function getById(array $params): LineItemOutputModel { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new LineItemOutputModel($this->send("get", ["id" => $params['id']], [])); + return new LineItemOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -67,6 +67,6 @@ public function putById(array $params, LineItemInputModel $requestBody): LineIte assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new LineItemOutputModel($this->send("put", ["id" => $params['id']], [], $requestBody)); + return new LineItemOutputModel($this->send("put", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Orgs.php b/packages/oneroster/src/OneRoster/Endpoints/Orgs.php index d6e42323..4182d025 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Orgs.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Orgs.php @@ -25,7 +25,7 @@ class Orgs extends BaseEndpoint */ public function get(): OrgsOutputModel { - return new OrgsOutputModel($this->send("get", [], [])); + return new OrgsOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -44,6 +44,6 @@ public function getById(array $params): OrgOutputModel { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new OrgOutputModel($this->send("get", ["id" => $params['id']], [])); + return new OrgOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Results.php b/packages/oneroster/src/OneRoster/Endpoints/Results.php index 1c2b72b7..72aad204 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Results.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Results.php @@ -26,7 +26,7 @@ class Results extends BaseEndpoint */ public function get(): ResultsOutputModelSvc { - return new ResultsOutputModelSvc($this->send("get", [], [])); + return new ResultsOutputModelSvc($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -45,7 +45,7 @@ public function getById(array $params): ResultOutputModelSvc { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new ResultOutputModelSvc($this->send("get", ["id" => $params['id']], [])); + return new ResultOutputModelSvc($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -67,7 +67,7 @@ public function putById(array $params, ResultInputModelSvc $requestBody): Result assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new ResultOutputModelSvc($this->send("put", ["id" => $params['id']], [], $requestBody)); + return new ResultOutputModelSvc($this->send("put", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } /** @@ -86,6 +86,6 @@ public function deleteById(array $params): ResultsOutputModelSvc { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new ResultsOutputModelSvc($this->send("delete", ["id" => $params['id']], [])); + return new ResultsOutputModelSvc($this->send("delete", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Schools.php b/packages/oneroster/src/OneRoster/Endpoints/Schools.php index ea0e404b..9384db02 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Schools.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Schools.php @@ -87,7 +87,7 @@ class Schools extends BaseEndpoint */ public function get(): OrgsOutputModel { - return new OrgsOutputModel($this->send("get", [], [])); + return new OrgsOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -106,6 +106,6 @@ public function getById(array $params): OrgOutputModel { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new OrgOutputModel($this->send("get", ["id" => $params['id']], [])); + return new OrgOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Schools/Classes.php b/packages/oneroster/src/OneRoster/Endpoints/Schools/Classes.php index f9b7f414..202a03e9 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Schools/Classes.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Schools/Classes.php @@ -52,6 +52,6 @@ public function getBySchoolId(array $params): ClassOutputModel { assert(isset($params['school_id']), new ArgumentException("Parameter `school_id` is required")); - return new ClassOutputModel($this->send("get", ["school_id" => $params['school_id']], [])); + return new ClassOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['school_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Schools/Classes/Enrollments.php b/packages/oneroster/src/OneRoster/Endpoints/Schools/Classes/Enrollments.php index 93268c80..c8f2f8bc 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Schools/Classes/Enrollments.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Schools/Classes/Enrollments.php @@ -36,7 +36,6 @@ public function getBySchoolIdAndClassId(array $params): EnrollmentsOutputModel assert(isset($params['school_id']), new ArgumentException("Parameter `school_id` is required")); assert(isset($params['class_id']), new ArgumentException("Parameter `class_id` is required")); - return new EnrollmentsOutputModel($this->send("get", ["school_id" => $params['school_id'], - "class_id" => $params['class_id']], [])); + return new EnrollmentsOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['school_id','class_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Schools/Courses.php b/packages/oneroster/src/OneRoster/Endpoints/Schools/Courses.php index 8a873ffb..2c958eb0 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Schools/Courses.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Schools/Courses.php @@ -32,6 +32,6 @@ public function getBySchoolId(array $params): CoursesOutputModel { assert(isset($params['school_id']), new ArgumentException("Parameter `school_id` is required")); - return new CoursesOutputModel($this->send("get", ["school_id" => $params['school_id']], [])); + return new CoursesOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['school_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Schools/Enrollments.php b/packages/oneroster/src/OneRoster/Endpoints/Schools/Enrollments.php index 57ab7c62..191bd485 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Schools/Enrollments.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Schools/Enrollments.php @@ -32,6 +32,6 @@ public function getBySchoolId(array $params): EnrollmentsOutputModel { assert(isset($params['school_id']), new ArgumentException("Parameter `school_id` is required")); - return new EnrollmentsOutputModel($this->send("get", ["school_id" => $params['school_id']], [])); + return new EnrollmentsOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['school_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Schools/Students.php b/packages/oneroster/src/OneRoster/Endpoints/Schools/Students.php index b3faa9b6..c3cd1344 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Schools/Students.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Schools/Students.php @@ -32,6 +32,6 @@ public function getBySchoolId(array $params): UsersOutputModel { assert(isset($params['school_id']), new ArgumentException("Parameter `school_id` is required")); - return new UsersOutputModel($this->send("get", ["school_id" => $params['school_id']], [])); + return new UsersOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['school_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Schools/Teachers.php b/packages/oneroster/src/OneRoster/Endpoints/Schools/Teachers.php index 4ae2bff1..b654c1dc 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Schools/Teachers.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Schools/Teachers.php @@ -38,6 +38,6 @@ public function getBySchoolId(array $params): UsersOutputModel { assert(isset($params['school_id']), new ArgumentException("Parameter `school_id` is required")); - return new UsersOutputModel($this->send("get", ["school_id" => $params['school_id']], [])); + return new UsersOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['school_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Schools/Terms.php b/packages/oneroster/src/OneRoster/Endpoints/Schools/Terms.php index 5629d432..1a8c5d9c 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Schools/Terms.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Schools/Terms.php @@ -32,6 +32,6 @@ public function getBySchoolId(array $params): AcademicSessionsOutputModel { assert(isset($params['school_id']), new ArgumentException("Parameter `school_id` is required")); - return new AcademicSessionsOutputModel($this->send("get", ["school_id" => $params['school_id']], [])); + return new AcademicSessionsOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['school_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Students.php b/packages/oneroster/src/OneRoster/Endpoints/Students.php index 27c446d9..96fcb958 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Students.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Students.php @@ -24,7 +24,7 @@ class Students extends BaseEndpoint */ public function get(): UsersOutputModel { - return new UsersOutputModel($this->send("get", [], [])); + return new UsersOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -42,6 +42,6 @@ public function getById(array $params): UserOutputModel { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new UserOutputModel($this->send("get", ["id" => $params['id']], [])); + return new UserOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Teachers.php b/packages/oneroster/src/OneRoster/Endpoints/Teachers.php index 820325a1..ae042bcb 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Teachers.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Teachers.php @@ -48,7 +48,7 @@ class Teachers extends BaseEndpoint */ public function get(): UsersOutputModel { - return new UsersOutputModel($this->send("get", [], [])); + return new UsersOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -72,6 +72,6 @@ public function getById(array $params): UserOutputModel { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new UserOutputModel($this->send("get", ["id" => $params['id']], [])); + return new UserOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Teachers/Classes.php b/packages/oneroster/src/OneRoster/Endpoints/Teachers/Classes.php index e67573a5..a3138cd0 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Teachers/Classes.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Teachers/Classes.php @@ -32,6 +32,6 @@ public function getByTeacherId(array $params): ClassOutputModel { assert(isset($params['teacher_id']), new ArgumentException("Parameter `teacher_id` is required")); - return new ClassOutputModel($this->send("get", ["teacher_id" => $params['teacher_id']], [])); + return new ClassOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['teacher_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Terms.php b/packages/oneroster/src/OneRoster/Endpoints/Terms.php index 42900bca..391dedd7 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Terms.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Terms.php @@ -45,7 +45,7 @@ class Terms extends BaseEndpoint */ public function get(): AcademicSessionsOutputModel { - return new AcademicSessionsOutputModel($this->send("get", [], [])); + return new AcademicSessionsOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -64,6 +64,6 @@ public function getById(array $params): AcademicSessionOutputModel { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new AcademicSessionOutputModel($this->send("get", ["id" => $params['id']], [])); + return new AcademicSessionOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Terms/GradingPeriods.php b/packages/oneroster/src/OneRoster/Endpoints/Terms/GradingPeriods.php index c5c52cee..2873e4ae 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Terms/GradingPeriods.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Terms/GradingPeriods.php @@ -32,6 +32,6 @@ public function getByTermId(array $params): AcademicSessionsOutputModel { assert(isset($params['term_id']), new ArgumentException("Parameter `term_id` is required")); - return new AcademicSessionsOutputModel($this->send("get", ["term_id" => $params['term_id']], [])); + return new AcademicSessionsOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['term_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/oneroster/src/OneRoster/Endpoints/Users.php b/packages/oneroster/src/OneRoster/Endpoints/Users.php index 0a7f2114..52d2920e 100644 --- a/packages/oneroster/src/OneRoster/Endpoints/Users.php +++ b/packages/oneroster/src/OneRoster/Endpoints/Users.php @@ -24,7 +24,7 @@ class Users extends BaseEndpoint */ public function get(): UsersOutputModel { - return new UsersOutputModel($this->send("get", [], [])); + return new UsersOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -42,6 +42,6 @@ public function getById(array $params): UserOutputModel { assert(isset($params['id']), new ArgumentException("Parameter `id` is required")); - return new UserOutputModel($this->send("get", ["id" => $params['id']], [])); + return new UserOutputModel($this->send("get", array_filter($params, fn($key) => in_array($key, ['id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Components/AddTableValuesRequest.php b/packages/school/src/School/Components/AddTableValuesRequest.php new file mode 100644 index 00000000..4cd9a0e1 --- /dev/null +++ b/packages/school/src/School/Components/AddTableValuesRequest.php @@ -0,0 +1,25 @@ + "string", + "table_values" => "\Blackbaud\SKY\School\Components\TableValueAdd[]", + ]; +} diff --git a/packages/school/src/School/Components/AddTableValuesResponse.php b/packages/school/src/School/Components/AddTableValuesResponse.php new file mode 100644 index 00000000..da592c00 --- /dev/null +++ b/packages/school/src/School/Components/AddTableValuesResponse.php @@ -0,0 +1,22 @@ + "int[]", + ]; +} diff --git a/packages/school/src/School/Components/Category.php b/packages/school/src/School/Components/Category.php index 5dd33af7..2def294f 100644 --- a/packages/school/src/School/Components/Category.php +++ b/packages/school/src/School/Components/Category.php @@ -13,6 +13,8 @@ * from * @property ?bool $primary Set to true if the new category is the primary * source of the news item + * @property ?string $publish_date The publish date + * @property ?string $expire_date The date of expiration * * @api */ @@ -26,5 +28,7 @@ class Category extends BaseComponent "name" => "string", "content_type" => "string", "primary" => "bool", + "publish_date" => "string", + "expire_date" => "string", ]; } diff --git a/packages/school/src/School/Components/EmployeeInfoModel.php b/packages/school/src/School/Components/EmployeeInfoModel.php new file mode 100644 index 00000000..4de753df --- /dev/null +++ b/packages/school/src/School/Components/EmployeeInfoModel.php @@ -0,0 +1,30 @@ + "int", + "first_name" => "string", + "last_name" => "string", + "preferred_name" => "string", + "email" => "string", + ]; +} diff --git a/packages/school/src/School/Components/EmployeeRolesInfoModel.php b/packages/school/src/School/Components/EmployeeRolesInfoModel.php new file mode 100644 index 00000000..37b14518 --- /dev/null +++ b/packages/school/src/School/Components/EmployeeRolesInfoModel.php @@ -0,0 +1,26 @@ + "int", + "description" => "string", + "base_role" => "\Blackbaud\SKY\School\Components\IdDescriptorField", + ]; +} diff --git a/packages/school/src/School/Components/EnrollmentChangeAudit.php b/packages/school/src/School/Components/EnrollmentChangeAudit.php index 104d3a64..5320de73 100644 --- a/packages/school/src/School/Components/EnrollmentChangeAudit.php +++ b/packages/school/src/School/Components/EnrollmentChangeAudit.php @@ -5,12 +5,14 @@ use Battis\OpenAPI\Client\BaseComponent; /** - * @property ?int $section_id - * @property ?string $course_code - * @property ?string $section_name - * @property ?string $modified_date_time - * @property ?int $modified_by - * @property ?string $action + * @property ?int $section_id The Id of the section + * @property ?string $course_code The course code + * @property ?string $section_name The name of the section + * @property ?string $modified_date_time The date/tim the change was made + * @property ?int $modified_by the Id of the user who modified the enrollment + * record + * @property ?string $action The action that was taken. Values can ve either + * Inserted, Updated, or Deleted * * @api */ diff --git a/packages/school/src/School/Components/NewsItem.php b/packages/school/src/School/Components/NewsItem.php index 304587bb..c676ef9e 100644 --- a/packages/school/src/School/Components/NewsItem.php +++ b/packages/school/src/School/Components/NewsItem.php @@ -16,6 +16,7 @@ * item * @property ?bool $featured Returns true if the news item is featured * @property ?\Blackbaud\SKY\School\Components\MediaItem[] $media_item + * @property ?string $date_created The date the news item was created. * @property ?\Blackbaud\SKY\School\Components\Category[] $categories The list * of categories the news item is published to * @@ -34,6 +35,7 @@ class NewsItem extends BaseComponent "long_description" => "string", "featured" => "bool", "media_item" => "\Blackbaud\SKY\School\Components\MediaItem[]", + "date_created" => "string", "categories" => "\Blackbaud\SKY\School\Components\Category[]", ]; } diff --git a/packages/school/src/School/Components/RelationshipCreate.php b/packages/school/src/School/Components/RelationshipCreate.php index fb4cd0ba..f549e29a 100644 --- a/packages/school/src/School/Components/RelationshipCreate.php +++ b/packages/school/src/School/Components/RelationshipCreate.php @@ -15,6 +15,13 @@ * Signing Contract' option. * @property int $left_user ID of the other individual in the relationship * with this person + * @property bool $resides_with Set to true if the child user resides with the + * parent user. + * @property bool $do_not_contact Set to true to indicate the relationship + * user (specified by left\_user) should not be contacted. + * @property bool $primary Set to true if the relationship user (specified by + * left\_user) is the primary contact. + * @property ?string $comments Comment for the relationship * * @api */ @@ -29,5 +36,9 @@ class RelationshipCreate extends BaseComponent "list_as_parent" => "bool", "tuition_responsible_signer" => "bool", "left_user" => "int", + "resides_with" => "bool", + "do_not_contact" => "bool", + "primary" => "bool", + "comments" => "string", ]; } diff --git a/packages/school/src/School/Components/RelationshipUpdate.php b/packages/school/src/School/Components/RelationshipUpdate.php new file mode 100644 index 00000000..7c7889fb --- /dev/null +++ b/packages/school/src/School/Components/RelationshipUpdate.php @@ -0,0 +1,44 @@ + "bool", + "list_as_parent" => "bool", + "tuition_responsible_signer" => "bool", + "resides_with" => "bool", + "do_not_contact" => "bool", + "primary" => "bool", + "comments" => "string", + ]; +} diff --git a/packages/school/src/School/Components/TableValueAdd.php b/packages/school/src/School/Components/TableValueAdd.php new file mode 100644 index 00000000..77140d44 --- /dev/null +++ b/packages/school/src/School/Components/TableValueAdd.php @@ -0,0 +1,25 @@ + "string", + "abbreviation" => "string", + ]; +} diff --git a/packages/school/src/School/Components/UserAdd.php b/packages/school/src/School/Components/UserAdd.php index 9e9a7c05..985ce4ef 100644 --- a/packages/school/src/School/Components/UserAdd.php +++ b/packages/school/src/School/Components/UserAdd.php @@ -59,10 +59,6 @@ * This will return: Yes, No, or No answer. * @property ?bool $is_abroad Set to true if user is currently abroad. Allowed * value: true, false. Defaults to false. - * @property ?bool $is_international Set to true if user is international - * (will be deprecated 02/15/2024) - * @property ?bool $is_latino_hispanic Set to true if user is latino or - * hispanic (will be deprecated 02/15/2024). * @property ?string $latino_hispanic Whether the user is Latino/Hispanic. * Allowed values: Yes, No, or No answer. * @property bool $is_responsible_signer Set to true if user is a responsible @@ -141,8 +137,6 @@ class UserAdd extends BaseComponent "host_id" => "string", "international" => "string", "is_abroad" => "bool", - "is_international" => "bool", - "is_latino_hispanic" => "bool", "latino_hispanic" => "string", "is_responsible_signer" => "bool", "in_state" => "\Blackbaud\SKY\School\Components\UserInState", diff --git a/packages/school/src/School/Components/UserEdit.php b/packages/school/src/School/Components/UserEdit.php index 2b8752f8..82b545e7 100644 --- a/packages/school/src/School/Components/UserEdit.php +++ b/packages/school/src/School/Components/UserEdit.php @@ -60,10 +60,6 @@ * This will return: Yes, No, or No answer. * @property ?bool $is_abroad Set to true if user is currently abroad. Allowed * value: true, false. Defaults to false. - * @property bool $is_international Set to true if user is international (will - * be deprecated 02/15/2024) - * @property ?bool $is_latino_hispanic Set to true if user is latino or - * hispanic (will be deprecated 02/15/2024). * @property ?string $latino_hispanic Whether the user is Latino/Hispanic. * Allowed values: Yes, No, or No answer. * @property bool $is_responsible_signer Set to true if user is a responsible @@ -157,8 +153,6 @@ class UserEdit extends BaseComponent "id" => "int", "international" => "string", "is_abroad" => "bool", - "is_international" => "bool", - "is_latino_hispanic" => "bool", "latino_hispanic" => "string", "is_responsible_signer" => "bool", "in_state" => "\Blackbaud\SKY\School\Components\UserInState", diff --git a/packages/school/src/School/Components/UserEmployment.php b/packages/school/src/School/Components/UserEmployment.php new file mode 100644 index 00000000..6906f9ec --- /dev/null +++ b/packages/school/src/School/Components/UserEmployment.php @@ -0,0 +1,45 @@ + "\Blackbaud\SKY\School\Components\EmployeeInfoModel", + "appointed_date" => "string", + "withdraw_date" => "string", + "is_account_disabled" => "bool", + "roles" => "\Blackbaud\SKY\School\Components\EmployeeRolesInfoModel[]", + "school_levels" => "\Blackbaud\SKY\School\Components\IdDescriptorField[]", + "departments" => "\Blackbaud\SKY\School\Components\IdDescriptorField[]", + "grade_levels" => "\Blackbaud\SKY\School\Components\IdDescriptorField[]", + "sports" => "\Blackbaud\SKY\School\Components\IdDescriptorField[]", + ]; +} diff --git a/packages/school/src/School/Components/UserEmploymentCollection.php b/packages/school/src/School/Components/UserEmploymentCollection.php new file mode 100644 index 00000000..53dfff10 --- /dev/null +++ b/packages/school/src/School/Components/UserEmploymentCollection.php @@ -0,0 +1,29 @@ + "int", + "next_link" => "string", + "value" => "\Blackbaud\SKY\School\Components\UserEmployment[]", + ]; +} diff --git a/packages/school/src/School/Components/UserExtended.php b/packages/school/src/School/Components/UserExtended.php index aeaa2529..8bfabd13 100644 --- a/packages/school/src/School/Components/UserExtended.php +++ b/packages/school/src/School/Components/UserExtended.php @@ -75,10 +75,6 @@ * @property ?string $host_id The hostId in the user profile * @property ?\Blackbaud\SKY\School\Components\HomeLanguageRead[] * $home_languages List of user home languages - * @property bool $is_latino_hispanic **Deprecated**: The islatinohispanic in - * the user profile - * @property bool $is_international The isinternational in the user profile - * (will be deprecated 02/15/2024) * @property bool $is_responsible_signer The isresponsiblesigner in the user * profile * @property \Blackbaud\SKY\School\Components\UserInState $in_state An object @@ -193,8 +189,6 @@ class UserExtended extends BaseComponent "greeting" => "string", "host_id" => "string", "home_languages" => "\Blackbaud\SKY\School\Components\HomeLanguageRead[]", - "is_latino_hispanic" => "bool", - "is_international" => "bool", "is_responsible_signer" => "bool", "in_state" => "\Blackbaud\SKY\School\Components\UserInState", "international" => "string", diff --git a/packages/school/src/School/Endpoints/V1/Academics/Assignments.php b/packages/school/src/School/Endpoints/V1/Academics/Assignments.php index b8eaf91c..c57646ce 100644 --- a/packages/school/src/School/Endpoints/V1/Academics/Assignments.php +++ b/packages/school/src/School/Endpoints/V1/Academics/Assignments.php @@ -48,8 +48,6 @@ public function searchByStudentId(array $params): StudentAssignmentCollection assert(isset($params['end_date']), new ArgumentException("Parameter `end_date` is required")); assert(isset($params['section_ids']), new ArgumentException("Parameter `section_ids` is required")); - return new StudentAssignmentCollection($this->send("get", ["student_id" => $params['student_id']], ["start_date" => $params['start_date'], - "end_date" => $params['end_date'], - "section_ids" => $params['section_ids']])); + return new StudentAssignmentCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['student_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['start_date','end_date','section_ids']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Academics/Courses.php b/packages/school/src/School/Endpoints/V1/Academics/Courses.php index 556162f0..3e603119 100644 --- a/packages/school/src/School/Endpoints/V1/Academics/Courses.php +++ b/packages/school/src/School/Endpoints/V1/Academics/Courses.php @@ -43,7 +43,6 @@ public function list_(array $params): CourseCollection assert(isset($params['department_id']), new ArgumentException("Parameter `department_id` is required")); assert(isset($params['level_id']), new ArgumentException("Parameter `level_id` is required")); - return new CourseCollection($this->send("get", [], ["department_id" => $params['department_id'], - "level_id" => $params['level_id']])); + return new CourseCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['department_id','level_id']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Academics/Departments.php b/packages/school/src/School/Endpoints/V1/Academics/Departments.php index 20715cc5..14e9ff5e 100644 --- a/packages/school/src/School/Endpoints/V1/Academics/Departments.php +++ b/packages/school/src/School/Endpoints/V1/Academics/Departments.php @@ -40,6 +40,6 @@ public function list_(array $params): DepartmentCollection { assert(isset($params['level_id']), new ArgumentException("Parameter `level_id` is required")); - return new DepartmentCollection($this->send("get", [], ["level_id" => $params['level_id']])); + return new DepartmentCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['level_id']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Academics/Enrollments.php b/packages/school/src/School/Endpoints/V1/Academics/Enrollments.php index 1d3b7839..9bf419f7 100644 --- a/packages/school/src/School/Endpoints/V1/Academics/Enrollments.php +++ b/packages/school/src/School/Endpoints/V1/Academics/Enrollments.php @@ -64,6 +64,6 @@ public function searchByUserId(array $params): EnrollmentCollection assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); assert(isset($params['school_year']), new ArgumentException("Parameter `school_year` is required")); - return new EnrollmentCollection($this->send("get", ["user_id" => $params['user_id']], ["school_year" => $params['school_year']])); + return new EnrollmentCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['school_year']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Academics/Enrollments/Changes.php b/packages/school/src/School/Endpoints/V1/Academics/Enrollments/Changes.php index 37a140b9..ad0aee9f 100644 --- a/packages/school/src/School/Endpoints/V1/Academics/Enrollments/Changes.php +++ b/packages/school/src/School/Endpoints/V1/Academics/Enrollments/Changes.php @@ -49,7 +49,6 @@ public function list_(array $params): EnrollmentChangesCollection assert(isset($params['start_date']), new ArgumentException("Parameter `start_date` is required")); assert(isset($params['end_date']), new ArgumentException("Parameter `end_date` is required")); - return new EnrollmentChangesCollection($this->send("get", [], ["start_date" => $params['start_date'], - "end_date" => $params['end_date']])); + return new EnrollmentChangesCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['start_date','end_date']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Academics/Gradedassignments.php b/packages/school/src/School/Endpoints/V1/Academics/Gradedassignments.php index 0817d509..76d06e63 100644 --- a/packages/school/src/School/Endpoints/V1/Academics/Gradedassignments.php +++ b/packages/school/src/School/Endpoints/V1/Academics/Gradedassignments.php @@ -48,7 +48,6 @@ public function searchByStudentIdAndSectionId(array $params): StudentGradedAssig assert(isset($params['section_id']), new ArgumentException("Parameter `section_id` is required")); assert(isset($params['marking_period_id']), new ArgumentException("Parameter `marking_period_id` is required")); - return new StudentGradedAssignmentCollection($this->send("get", ["student_id" => $params['student_id'], - "section_id" => $params['section_id']], ["marking_period_id" => $params['marking_period_id']])); + return new StudentGradedAssignmentCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['student_id','section_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['marking_period_id']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Academics/Schedules/Master.php b/packages/school/src/School/Endpoints/V1/Academics/Schedules/Master.php index ede96b7b..5e89b4ae 100644 --- a/packages/school/src/School/Endpoints/V1/Academics/Schedules/Master.php +++ b/packages/school/src/School/Endpoints/V1/Academics/Schedules/Master.php @@ -55,9 +55,6 @@ public function list_(array $params): MasterScheduleDayCollection assert(isset($params['end_date']), new ArgumentException("Parameter `end_date` is required")); assert(isset($params['offering_type']), new ArgumentException("Parameter `offering_type` is required")); - return new MasterScheduleDayCollection($this->send("get", [], ["level_num" => $params['level_num'], - "start_date" => $params['start_date'], - "end_date" => $params['end_date'], - "offering_type" => $params['offering_type']])); + return new MasterScheduleDayCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['level_num','start_date','end_date','offering_type']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Academics/Schedules/Sets.php b/packages/school/src/School/Endpoints/V1/Academics/Schedules/Sets.php index 37e68058..27a8fc9b 100644 --- a/packages/school/src/School/Endpoints/V1/Academics/Schedules/Sets.php +++ b/packages/school/src/School/Endpoints/V1/Academics/Schedules/Sets.php @@ -28,7 +28,7 @@ class Sets extends BaseEndpoint * * - Schedule Manager * - * @param array{level_num: int, school_year: string, group_type: int} + * @param array{level_num: int, school_year: string, group_type?: int} * $params An associative array * - level_num: Format - int32. Level Number indicates which school * you are working with. @@ -47,11 +47,8 @@ public function list_(array $params): ScheduleSetCollection { assert(isset($params['level_num']), new ArgumentException("Parameter `level_num` is required")); assert(isset($params['school_year']), new ArgumentException("Parameter `school_year` is required")); - assert(isset($params['group_type']), new ArgumentException("Parameter `group_type` is required")); - return new ScheduleSetCollection($this->send("get", [], ["level_num" => $params['level_num'], - "school_year" => $params['school_year'], - "group_type" => $params['group_type']])); + return new ScheduleSetCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['level_num','school_year','group_type']), ARRAY_FILTER_USE_KEY))); } /** @@ -76,6 +73,6 @@ public function getByScheduleSetId(array $params): ScheduleSetDetails { assert(isset($params['schedule_set_id']), new ArgumentException("Parameter `schedule_set_id` is required")); - return new ScheduleSetDetails($this->send("get", ["schedule_set_id" => $params['schedule_set_id']], [])); + return new ScheduleSetDetails($this->send("get", array_filter($params, fn($key) => in_array($key, ['schedule_set_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Academics/Sections.php b/packages/school/src/School/Endpoints/V1/Academics/Sections.php index 6777e133..b0bb0861 100644 --- a/packages/school/src/School/Endpoints/V1/Academics/Sections.php +++ b/packages/school/src/School/Endpoints/V1/Academics/Sections.php @@ -82,7 +82,6 @@ public function list_(array $params): AcademicsSectionCollection assert(isset($params['level_num']), new ArgumentException("Parameter `level_num` is required")); assert(isset($params['school_year']), new ArgumentException("Parameter `school_year` is required")); - return new AcademicsSectionCollection($this->send("get", [], ["level_num" => $params['level_num'], - "school_year" => $params['school_year']])); + return new AcademicsSectionCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['level_num','school_year']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Academics/Sections/Assignments.php b/packages/school/src/School/Endpoints/V1/Academics/Sections/Assignments.php index a66757e6..b1327278 100644 --- a/packages/school/src/School/Endpoints/V1/Academics/Sections/Assignments.php +++ b/packages/school/src/School/Endpoints/V1/Academics/Sections/Assignments.php @@ -62,10 +62,6 @@ public function searchBySectionId(array $params): AssignmentCollection assert(isset($params['filter']), new ArgumentException("Parameter `filter` is required")); assert(isset($params['search']), new ArgumentException("Parameter `search` is required")); - return new AssignmentCollection($this->send("get", ["section_id" => $params['section_id']], ["types" => $params['types'], - "status" => $params['status'], - "persona_id" => $params['persona_id'], - "filter" => $params['filter'], - "search" => $params['search']])); + return new AssignmentCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['section_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['types','status','persona_id','filter','search']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Academics/Sections/Cycles.php b/packages/school/src/School/Endpoints/V1/Academics/Sections/Cycles.php index cdd9521a..6618c896 100644 --- a/packages/school/src/School/Endpoints/V1/Academics/Sections/Cycles.php +++ b/packages/school/src/School/Endpoints/V1/Academics/Sections/Cycles.php @@ -23,7 +23,7 @@ class Cycles extends BaseEndpoint * * - Academic Group Manager * - * @param array{section_id: int, duration_id: int, group_type: int} + * @param array{section_id: int, duration_id: int, group_type?: int} * $params An associative array * - section_id: Format - int32. The ID of the section. * - duration_id: Format - int32. The ID of the term for which you @@ -41,9 +41,7 @@ public function getBySectionId(array $params): SectionCycles { assert(isset($params['section_id']), new ArgumentException("Parameter `section_id` is required")); assert(isset($params['duration_id']), new ArgumentException("Parameter `duration_id` is required")); - assert(isset($params['group_type']), new ArgumentException("Parameter `group_type` is required")); - return new SectionCycles($this->send("get", ["section_id" => $params['section_id']], ["duration_id" => $params['duration_id'], - "group_type" => $params['group_type']])); + return new SectionCycles($this->send("get", array_filter($params, fn($key) => in_array($key, ['section_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['duration_id','group_type']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Academics/Sections/Students.php b/packages/school/src/School/Endpoints/V1/Academics/Sections/Students.php index 1b4a0158..22658f42 100644 --- a/packages/school/src/School/Endpoints/V1/Academics/Sections/Students.php +++ b/packages/school/src/School/Endpoints/V1/Academics/Sections/Students.php @@ -42,7 +42,7 @@ public function searchBySectionId(array $params): StudentCollection { assert(isset($params['section_id']), new ArgumentException("Parameter `section_id` is required")); - return new StudentCollection($this->send("get", ["section_id" => $params['section_id']], [])); + return new StudentCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['section_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -71,6 +71,6 @@ public function post(BulkEnrollment $requestBody): PostResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new PostResponse($this->send("post", [], [], $requestBody)); + return new PostResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } } diff --git a/packages/school/src/School/Endpoints/V1/Academics/Specialdays.php b/packages/school/src/School/Endpoints/V1/Academics/Specialdays.php index 9f537c18..19babc5f 100644 --- a/packages/school/src/School/Endpoints/V1/Academics/Specialdays.php +++ b/packages/school/src/School/Endpoints/V1/Academics/Specialdays.php @@ -38,6 +38,6 @@ public function list_(array $params): SpecialDayCollection { assert(isset($params['level_id']), new ArgumentException("Parameter `level_id` is required")); - return new SpecialDayCollection($this->send("get", [], ["level_id" => $params['level_id']])); + return new SpecialDayCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['level_id']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Academics/Student/Sections.php b/packages/school/src/School/Endpoints/V1/Academics/Student/Sections.php index 07baefdc..1059e2cb 100644 --- a/packages/school/src/School/Endpoints/V1/Academics/Student/Sections.php +++ b/packages/school/src/School/Endpoints/V1/Academics/Student/Sections.php @@ -48,6 +48,6 @@ public function searchByStudentId(array $params): AcademicsSectionStudentCollect { assert(isset($params['student_id']), new ArgumentException("Parameter `student_id` is required")); - return new AcademicsSectionStudentCollection($this->send("get", ["student_id" => $params['student_id']], [])); + return new AcademicsSectionStudentCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['student_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Academics/Teachers/Sections.php b/packages/school/src/School/Endpoints/V1/Academics/Teachers/Sections.php index 8758fbc1..0ea9b416 100644 --- a/packages/school/src/School/Endpoints/V1/Academics/Teachers/Sections.php +++ b/packages/school/src/School/Endpoints/V1/Academics/Teachers/Sections.php @@ -45,6 +45,6 @@ public function searchByTeacherId(array $params): AcademicsSectionCollection assert(isset($params['teacher_id']), new ArgumentException("Parameter `teacher_id` is required")); assert(isset($params['school_year']), new ArgumentException("Parameter `school_year` is required")); - return new AcademicsSectionCollection($this->send("get", ["teacher_id" => $params['teacher_id']], ["school_year" => $params['school_year']])); + return new AcademicsSectionCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['teacher_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['school_year']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Activities/Sections.php b/packages/school/src/School/Endpoints/V1/Activities/Sections.php index c908dbd3..5d788cdc 100644 --- a/packages/school/src/School/Endpoints/V1/Activities/Sections.php +++ b/packages/school/src/School/Endpoints/V1/Activities/Sections.php @@ -41,7 +41,6 @@ public function list_(array $params): ActivitiesSectionCollection assert(isset($params['level_num']), new ArgumentException("Parameter `level_num` is required")); assert(isset($params['school_year']), new ArgumentException("Parameter `school_year` is required")); - return new ActivitiesSectionCollection($this->send("get", [], ["level_num" => $params['level_num'], - "school_year" => $params['school_year']])); + return new ActivitiesSectionCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['level_num','school_year']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Admissions/Candidates.php b/packages/school/src/School/Endpoints/V1/Admissions/Candidates.php index 614bea5d..e4e711e1 100644 --- a/packages/school/src/School/Endpoints/V1/Admissions/Candidates.php +++ b/packages/school/src/School/Endpoints/V1/Admissions/Candidates.php @@ -71,9 +71,7 @@ public function list_(array $params): CandidateReadCollection assert(isset($params['status_ids']), new ArgumentException("Parameter `status_ids` is required")); assert(isset($params['modified_date']), new ArgumentException("Parameter `modified_date` is required")); - return new CandidateReadCollection($this->send("get", [], ["school_year" => $params['school_year'], - "status_ids" => $params['status_ids'], - "modified_date" => $params['modified_date']])); + return new CandidateReadCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['school_year','status_ids','modified_date']), ARRAY_FILTER_USE_KEY))); } /** @@ -99,6 +97,6 @@ public function post(CandidateCreate $requestBody): int { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", [], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/school/src/School/Endpoints/V1/Admissions/Checklists.php b/packages/school/src/School/Endpoints/V1/Admissions/Checklists.php index b7d2c686..5f91beec 100644 --- a/packages/school/src/School/Endpoints/V1/Admissions/Checklists.php +++ b/packages/school/src/School/Endpoints/V1/Admissions/Checklists.php @@ -47,7 +47,6 @@ public function list_(array $params): AdmissionsCheckListCollection assert(isset($params['search_text']), new ArgumentException("Parameter `search_text` is required")); assert(isset($params['inactive']), new ArgumentException("Parameter `inactive` is required")); - return new AdmissionsCheckListCollection($this->send("get", [], ["search_text" => $params['search_text'], - "inactive" => $params['inactive']])); + return new AdmissionsCheckListCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['search_text','inactive']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Admissions/Checkliststatus.php b/packages/school/src/School/Endpoints/V1/Admissions/Checkliststatus.php index eb4a2ac1..83061c1e 100644 --- a/packages/school/src/School/Endpoints/V1/Admissions/Checkliststatus.php +++ b/packages/school/src/School/Endpoints/V1/Admissions/Checkliststatus.php @@ -27,6 +27,6 @@ class Checkliststatus extends BaseEndpoint */ public function list_(): AdmissionsChecklistStatusCollection { - return new AdmissionsChecklistStatusCollection($this->send("get", [], [])); + return new AdmissionsChecklistStatusCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Admissions/Status.php b/packages/school/src/School/Endpoints/V1/Admissions/Status.php index 06a834b6..d6207861 100644 --- a/packages/school/src/School/Endpoints/V1/Admissions/Status.php +++ b/packages/school/src/School/Endpoints/V1/Admissions/Status.php @@ -32,6 +32,6 @@ class Status extends BaseEndpoint */ public function list_(): AdmissionsStatusesCollection { - return new AdmissionsStatusesCollection($this->send("get", [], [])); + return new AdmissionsStatusesCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Advisories/Sections.php b/packages/school/src/School/Endpoints/V1/Advisories/Sections.php index 08d4bd50..94adc2d0 100644 --- a/packages/school/src/School/Endpoints/V1/Advisories/Sections.php +++ b/packages/school/src/School/Endpoints/V1/Advisories/Sections.php @@ -41,7 +41,6 @@ public function list_(array $params): AdvisoriesSectionCollection assert(isset($params['level_num']), new ArgumentException("Parameter `level_num` is required")); assert(isset($params['school_year']), new ArgumentException("Parameter `school_year` is required")); - return new AdvisoriesSectionCollection($this->send("get", [], ["level_num" => $params['level_num'], - "school_year" => $params['school_year']])); + return new AdvisoriesSectionCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['level_num','school_year']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Athletics/Highlights.php b/packages/school/src/School/Endpoints/V1/Athletics/Highlights.php index 8150c4f3..da2a7e51 100644 --- a/packages/school/src/School/Endpoints/V1/Athletics/Highlights.php +++ b/packages/school/src/School/Endpoints/V1/Athletics/Highlights.php @@ -50,6 +50,6 @@ public function getByHighlightId(array $params): Highlight { assert(isset($params['highlight_id']), new ArgumentException("Parameter `highlight_id` is required")); - return new Highlight($this->send("get", ["highlight_id" => $params['highlight_id']], [])); + return new Highlight($this->send("get", array_filter($params, fn($key) => in_array($key, ['highlight_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Athletics/Locations.php b/packages/school/src/School/Endpoints/V1/Athletics/Locations.php index 46a11510..92b2d622 100644 --- a/packages/school/src/School/Endpoints/V1/Athletics/Locations.php +++ b/packages/school/src/School/Endpoints/V1/Athletics/Locations.php @@ -37,7 +37,7 @@ class Locations extends BaseEndpoint */ public function list_(): LocationCollection { - return new LocationCollection($this->send("get", [], [])); + return new LocationCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -71,6 +71,6 @@ public function post(LocationCreateModel $requestBody): int { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", [], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/school/src/School/Endpoints/V1/Athletics/Opponents.php b/packages/school/src/School/Endpoints/V1/Athletics/Opponents.php index d8581baa..b52064f4 100644 --- a/packages/school/src/School/Endpoints/V1/Athletics/Opponents.php +++ b/packages/school/src/School/Endpoints/V1/Athletics/Opponents.php @@ -38,7 +38,7 @@ class Opponents extends BaseEndpoint */ public function list_(): OpponentFlyweightCollection { - return new OpponentFlyweightCollection($this->send("get", [], [])); + return new OpponentFlyweightCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -71,6 +71,6 @@ public function post(OpponentUpdateModel $requestBody): int { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", [], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/school/src/School/Endpoints/V1/Athletics/Result.php b/packages/school/src/School/Endpoints/V1/Athletics/Result.php index 6d5b1382..6409a0df 100644 --- a/packages/school/src/School/Endpoints/V1/Athletics/Result.php +++ b/packages/school/src/School/Endpoints/V1/Athletics/Result.php @@ -45,6 +45,6 @@ public function post(ResultCreate $requestBody): mixed { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", [], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/school/src/School/Endpoints/V1/Athletics/Schedules.php b/packages/school/src/School/Endpoints/V1/Athletics/Schedules.php index 7bce37e3..c8910ff6 100644 --- a/packages/school/src/School/Endpoints/V1/Athletics/Schedules.php +++ b/packages/school/src/School/Endpoints/V1/Athletics/Schedules.php @@ -42,8 +42,8 @@ class Schedules extends BaseEndpoint * - Pending Coach * * @param array{start_date: string, end_date: string, school_year: string, - * include_practice: bool, team_id: int, last_modified: string} $params An - * associative array + * include_practice?: bool, team_id?: int, last_modified: string} $params + * An associative array * - start_date: Format - date-time (as date-time in RFC3339). Filter * games/practices after this date * - end_date: Format - date-time (as date-time in RFC3339). Filter @@ -68,15 +68,8 @@ public function list_(array $params): ScheduleItemCollection assert(isset($params['start_date']), new ArgumentException("Parameter `start_date` is required")); assert(isset($params['end_date']), new ArgumentException("Parameter `end_date` is required")); assert(isset($params['school_year']), new ArgumentException("Parameter `school_year` is required")); - assert(isset($params['include_practice']), new ArgumentException("Parameter `include_practice` is required")); - assert(isset($params['team_id']), new ArgumentException("Parameter `team_id` is required")); assert(isset($params['last_modified']), new ArgumentException("Parameter `last_modified` is required")); - return new ScheduleItemCollection($this->send("get", [], ["start_date" => $params['start_date'], - "end_date" => $params['end_date'], - "school_year" => $params['school_year'], - "include_practice" => $params['include_practice'], - "team_id" => $params['team_id'], - "last_modified" => $params['last_modified']])); + return new ScheduleItemCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['start_date','end_date','school_year','include_practice','team_id','last_modified']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Athletics/Sports.php b/packages/school/src/School/Endpoints/V1/Athletics/Sports.php index d727fb43..212387cd 100644 --- a/packages/school/src/School/Endpoints/V1/Athletics/Sports.php +++ b/packages/school/src/School/Endpoints/V1/Athletics/Sports.php @@ -46,6 +46,6 @@ public function list_(array $params): SportCollection { assert(isset($params['season_id']), new ArgumentException("Parameter `season_id` is required")); - return new SportCollection($this->send("get", [], ["season_id" => $params['season_id']])); + return new SportCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['season_id']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Athletics/Sportslevels.php b/packages/school/src/School/Endpoints/V1/Athletics/Sportslevels.php index 8678d87f..a523a1b3 100644 --- a/packages/school/src/School/Endpoints/V1/Athletics/Sportslevels.php +++ b/packages/school/src/School/Endpoints/V1/Athletics/Sportslevels.php @@ -33,6 +33,6 @@ class Sportslevels extends BaseEndpoint */ public function list_(): SportsLevelCollection { - return new SportsLevelCollection($this->send("get", [], [])); + return new SportsLevelCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Athletics/Teams.php b/packages/school/src/School/Endpoints/V1/Athletics/Teams.php index b7ad0b27..688fd508 100644 --- a/packages/school/src/School/Endpoints/V1/Athletics/Teams.php +++ b/packages/school/src/School/Endpoints/V1/Athletics/Teams.php @@ -74,6 +74,6 @@ public function list_(array $params): TeamCollection { assert(isset($params['school_year']), new ArgumentException("Parameter `school_year` is required")); - return new TeamCollection($this->send("get", [], ["school_year" => $params['school_year']])); + return new TeamCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['school_year']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Athletics/Teams/Roster.php b/packages/school/src/School/Endpoints/V1/Athletics/Teams/Roster.php index d47ee713..9aedacd2 100644 --- a/packages/school/src/School/Endpoints/V1/Athletics/Teams/Roster.php +++ b/packages/school/src/School/Endpoints/V1/Athletics/Teams/Roster.php @@ -47,6 +47,6 @@ public function getByTeamId(array $params): Components_Roster { assert(isset($params['team_id']), new ArgumentException("Parameter `team_id` is required")); - return new Components_Roster($this->send("get", ["team_id" => $params['team_id']], [])); + return new Components_Roster($this->send("get", array_filter($params, fn($key) => in_array($key, ['team_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Athletics/Teams/Schedule.php b/packages/school/src/School/Endpoints/V1/Athletics/Teams/Schedule.php index 844b2827..36fabc41 100644 --- a/packages/school/src/School/Endpoints/V1/Athletics/Teams/Schedule.php +++ b/packages/school/src/School/Endpoints/V1/Athletics/Teams/Schedule.php @@ -69,7 +69,7 @@ public function postToTeamId(array $params, GameCreate $requestBody): int assert(isset($params['team_id']), new ArgumentException("Parameter `team_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", ["team_id" => $params['team_id']], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['team_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -105,7 +105,7 @@ public function patchOnTeamId(array $params, GameUpdate $requestBody): mixed assert(isset($params['team_id']), new ArgumentException("Parameter `team_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["team_id" => $params['team_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['team_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -133,7 +133,6 @@ public function deleteByTeamIdAndGameId(array $params): mixed assert(isset($params['team_id']), new ArgumentException("Parameter `team_id` is required")); assert(isset($params['game_id']), new ArgumentException("Parameter `game_id` is required")); - return $this->send("delete", ["team_id" => $params['team_id'], - "game_id" => $params['game_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['team_id','game_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } } diff --git a/packages/school/src/School/Endpoints/V1/Athletics/Teams/Schedule/Practice.php b/packages/school/src/School/Endpoints/V1/Athletics/Teams/Schedule/Practice.php index 00ce11e1..b45c5233 100644 --- a/packages/school/src/School/Endpoints/V1/Athletics/Teams/Schedule/Practice.php +++ b/packages/school/src/School/Endpoints/V1/Athletics/Teams/Schedule/Practice.php @@ -43,7 +43,7 @@ public function postToTeamId(array $params, PracticeCreate $requestBody): int assert(isset($params['team_id']), new ArgumentException("Parameter `team_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", ["team_id" => $params['team_id']], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['team_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -71,7 +71,7 @@ public function patchOnTeamId(array $params, PracticeUpdate $requestBody): mixed assert(isset($params['team_id']), new ArgumentException("Parameter `team_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["team_id" => $params['team_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['team_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -101,7 +101,6 @@ public function deleteByTeamIdAndPracticeId(array $params): mixed assert(isset($params['team_id']), new ArgumentException("Parameter `team_id` is required")); assert(isset($params['practice_id']), new ArgumentException("Parameter `practice_id` is required")); - return $this->send("delete", ["team_id" => $params['team_id'], - "practice_id" => $params['practice_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['team_id','practice_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } } diff --git a/packages/school/src/School/Endpoints/V1/Athletics/Transportationtypes.php b/packages/school/src/School/Endpoints/V1/Athletics/Transportationtypes.php index 4735c62d..6b0c4740 100644 --- a/packages/school/src/School/Endpoints/V1/Athletics/Transportationtypes.php +++ b/packages/school/src/School/Endpoints/V1/Athletics/Transportationtypes.php @@ -38,6 +38,6 @@ class Transportationtypes extends BaseEndpoint */ public function list_(): TransportationCollection { - return new TransportationCollection($this->send("get", [], [])); + return new TransportationCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Athletics/Venues.php b/packages/school/src/School/Endpoints/V1/Athletics/Venues.php index 0a56b1dc..19e59e0e 100644 --- a/packages/school/src/School/Endpoints/V1/Athletics/Venues.php +++ b/packages/school/src/School/Endpoints/V1/Athletics/Venues.php @@ -34,6 +34,6 @@ class Venues extends BaseEndpoint */ public function list_(): AthleticVenueCollection { - return new AthleticVenueCollection($this->send("get", [], [])); + return new AthleticVenueCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Attendance.php b/packages/school/src/School/Endpoints/V1/Attendance.php index 5d823a3a..1f38b87d 100644 --- a/packages/school/src/School/Endpoints/V1/Attendance.php +++ b/packages/school/src/School/Endpoints/V1/Attendance.php @@ -52,10 +52,7 @@ public function list_(array $params): AttendanceGetCollection assert(isset($params['offering_type']), new ArgumentException("Parameter `offering_type` is required")); assert(isset($params['excuse_type']), new ArgumentException("Parameter `excuse_type` is required")); - return new AttendanceGetCollection($this->send("get", [], ["level_id" => $params['level_id'], - "day" => $params['day'], - "offering_type" => $params['offering_type'], - "excuse_type" => $params['excuse_type']])); + return new AttendanceGetCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['level_id','day','offering_type','excuse_type']), ARRAY_FILTER_USE_KEY))); } /** @@ -80,6 +77,6 @@ public function post(AttendanceCreate $requestBody): mixed { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", [], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/school/src/School/Endpoints/V1/Content/Events/Categories.php b/packages/school/src/School/Endpoints/V1/Content/Events/Categories.php index e238ff9b..c03fb4db 100644 --- a/packages/school/src/School/Endpoints/V1/Content/Events/Categories.php +++ b/packages/school/src/School/Endpoints/V1/Content/Events/Categories.php @@ -33,6 +33,6 @@ class Categories extends BaseEndpoint */ public function list_(): EventsCategoryCollection { - return new EventsCategoryCollection($this->send("get", [], [])); + return new EventsCategoryCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Content/News/Categories.php b/packages/school/src/School/Endpoints/V1/Content/News/Categories.php index afbe6c81..728406b2 100644 --- a/packages/school/src/School/Endpoints/V1/Content/News/Categories.php +++ b/packages/school/src/School/Endpoints/V1/Content/News/Categories.php @@ -29,6 +29,6 @@ class Categories extends BaseEndpoint */ public function list_(): NewsCategoryCollection { - return new NewsCategoryCollection($this->send("get", [], [])); + return new NewsCategoryCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Content/News/Items.php b/packages/school/src/School/Endpoints/V1/Content/News/Items.php index abb8358a..9eef84aa 100644 --- a/packages/school/src/School/Endpoints/V1/Content/News/Items.php +++ b/packages/school/src/School/Endpoints/V1/Content/News/Items.php @@ -38,6 +38,6 @@ public function list_(array $params): NewsItemCollection { assert(isset($params['categories']), new ArgumentException("Parameter `categories` is required")); - return new NewsItemCollection($this->send("get", [], ["categories" => $params['categories']])); + return new NewsItemCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['categories']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Content/Resources.php b/packages/school/src/School/Endpoints/V1/Content/Resources.php index 7f423ec2..350eb079 100644 --- a/packages/school/src/School/Endpoints/V1/Content/Resources.php +++ b/packages/school/src/School/Endpoints/V1/Content/Resources.php @@ -32,6 +32,6 @@ class Resources extends BaseEndpoint */ public function list_(): ResourceCollection { - return new ResourceCollection($this->send("get", [], [])); + return new ResourceCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Customfields.php b/packages/school/src/School/Endpoints/V1/Customfields.php index cb055d0f..45381c25 100644 --- a/packages/school/src/School/Endpoints/V1/Customfields.php +++ b/packages/school/src/School/Endpoints/V1/Customfields.php @@ -28,6 +28,6 @@ class Customfields extends BaseEndpoint */ public function list_(): AdminCustomFieldsCollection { - return new AdminCustomFieldsCollection($this->send("get", [], [])); + return new AdminCustomFieldsCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Degrees/Studentdegrees.php b/packages/school/src/School/Endpoints/V1/Degrees/Studentdegrees.php index 3ca4c7f9..5ca25b17 100644 --- a/packages/school/src/School/Endpoints/V1/Degrees/Studentdegrees.php +++ b/packages/school/src/School/Endpoints/V1/Degrees/Studentdegrees.php @@ -45,6 +45,6 @@ public function searchByStudentId(array $params): UserDegreeOutputModelCollectio { assert(isset($params['student_id']), new ArgumentException("Parameter `student_id` is required")); - return new UserDegreeOutputModelCollection($this->send("get", ["student_id" => $params['student_id']], [])); + return new UserDegreeOutputModelCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['student_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Directories.php b/packages/school/src/School/Endpoints/V1/Directories.php index e123fa9d..f41638f8 100644 --- a/packages/school/src/School/Endpoints/V1/Directories.php +++ b/packages/school/src/School/Endpoints/V1/Directories.php @@ -33,7 +33,7 @@ class Directories extends BaseEndpoint */ public function list_(): DirectoryModelCollection { - return new DirectoryModelCollection($this->send("get", [], [])); + return new DirectoryModelCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -56,7 +56,7 @@ public function list_(): DirectoryModelCollection * * - Student * - * @param array{directory_id: int, search: string, search_all: bool} + * @param array{directory_id: int, search: string, search_all?: bool} * $params An associative array * - directory_id: Format - int32. * - search: @@ -72,9 +72,7 @@ public function searchByDirectoryId(array $params): DirectoryResultCollection { assert(isset($params['directory_id']), new ArgumentException("Parameter `directory_id` is required")); assert(isset($params['search']), new ArgumentException("Parameter `search` is required")); - assert(isset($params['search_all']), new ArgumentException("Parameter `search_all` is required")); - return new DirectoryResultCollection($this->send("get", ["directory_id" => $params['directory_id']], ["search" => $params['search'], - "search_all" => $params['search_all']])); + return new DirectoryResultCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['directory_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['search','search_all']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Dorms/All.php b/packages/school/src/School/Endpoints/V1/Dorms/All.php index 79031827..3a34c04e 100644 --- a/packages/school/src/School/Endpoints/V1/Dorms/All.php +++ b/packages/school/src/School/Endpoints/V1/Dorms/All.php @@ -41,7 +41,6 @@ public function list_(array $params): DormCollection assert(isset($params['level_number']), new ArgumentException("Parameter `level_number` is required")); assert(isset($params['school_year']), new ArgumentException("Parameter `school_year` is required")); - return new DormCollection($this->send("get", [], ["level_number" => $params['level_number'], - "school_year" => $params['school_year']])); + return new DormCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['level_number','school_year']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Events/Calendar.php b/packages/school/src/School/Endpoints/V1/Events/Calendar.php index 8d3b9bd1..865ebee2 100644 --- a/packages/school/src/School/Endpoints/V1/Events/Calendar.php +++ b/packages/school/src/School/Endpoints/V1/Events/Calendar.php @@ -44,7 +44,6 @@ public function list_(array $params): CalendarItemCollection assert(isset($params['start_date']), new ArgumentException("Parameter `start_date` is required")); assert(isset($params['end_date']), new ArgumentException("Parameter `end_date` is required")); - return new CalendarItemCollection($this->send("get", [], ["start_date" => $params['start_date'], - "end_date" => $params['end_date']])); + return new CalendarItemCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['start_date','end_date']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Events/Categories.php b/packages/school/src/School/Endpoints/V1/Events/Categories.php index 106ac563..32d31ef2 100644 --- a/packages/school/src/School/Endpoints/V1/Events/Categories.php +++ b/packages/school/src/School/Endpoints/V1/Events/Categories.php @@ -41,7 +41,7 @@ public function list_(array $params): EventCategoryCollection { assert(isset($params['page']), new ArgumentException("Parameter `page` is required")); - return new EventCategoryCollection($this->send("get", [], ["page" => $params['page']])); + return new EventCategoryCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['page']), ARRAY_FILTER_USE_KEY))); } /** @@ -69,6 +69,6 @@ public function post(EventCategory $requestBody): EventCategoryCreateResponseExa { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new EventCategoryCreateResponseExample($this->send("post", [], [], $requestBody)); + return new EventCategoryCreateResponseExample($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } } diff --git a/packages/school/src/School/Endpoints/V1/Gradelevels.php b/packages/school/src/School/Endpoints/V1/Gradelevels.php index 316c11b7..3db0804c 100644 --- a/packages/school/src/School/Endpoints/V1/Gradelevels.php +++ b/packages/school/src/School/Endpoints/V1/Gradelevels.php @@ -33,6 +33,6 @@ class Gradelevels extends BaseEndpoint */ public function list_(): GradeLevelCollection { - return new GradeLevelCollection($this->send("get", [], [])); + return new GradeLevelCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Levels.php b/packages/school/src/School/Endpoints/V1/Levels.php index 3bd63cf9..a922da2a 100644 --- a/packages/school/src/School/Endpoints/V1/Levels.php +++ b/packages/school/src/School/Endpoints/V1/Levels.php @@ -29,6 +29,6 @@ class Levels extends BaseEndpoint */ public function list_(): LevelCollection { - return new LevelCollection($this->send("get", [], [])); + return new LevelCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Lists.php b/packages/school/src/School/Endpoints/V1/Lists.php index c1ef3321..0337188f 100644 --- a/packages/school/src/School/Endpoints/V1/Lists.php +++ b/packages/school/src/School/Endpoints/V1/Lists.php @@ -91,6 +91,6 @@ class Lists extends BaseEndpoint */ public function list_(): ListReadCollection { - return new ListReadCollection($this->send("get", [], [])); + return new ListReadCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Lists/Advanced.php b/packages/school/src/School/Endpoints/V1/Lists/Advanced.php index 28c5524c..4a572181 100644 --- a/packages/school/src/School/Endpoints/V1/Lists/Advanced.php +++ b/packages/school/src/School/Endpoints/V1/Lists/Advanced.php @@ -74,7 +74,19 @@ class Advanced extends BaseEndpoint * * - SkyApi Data Sync * - * @param array{list_id: int, page: int, page_size: int} $params An + * **Rate Limiting:**- Any successful calls made to the GET List Single + * endpoint will have no restrictions + * + * - Any call resulting in an error to the GET List Single endpoint will + * trigger a temporary time-out on the Environment and BBID of the calls + * origin. This time-out/hold will be for 60 seconds. After that calls may + * resume. + * + * - If calls are made to the endpoint while the time-out is in place the + * response back will be Status 429 too many requests and an error of + * "Limited by error rate" will appear. + * + * @param array{list_id: int, page?: int, page_size?: int} $params An * associative array * - list_id: Format - int32. The ID of the list. To learn how to find * the list ID, see [KB article @@ -92,10 +104,7 @@ class Advanced extends BaseEndpoint public function getByListId(array $params): ListResult { assert(isset($params['list_id']), new ArgumentException("Parameter `list_id` is required")); - assert(isset($params['page']), new ArgumentException("Parameter `page` is required")); - assert(isset($params['page_size']), new ArgumentException("Parameter `page_size` is required")); - return new ListResult($this->send("get", ["list_id" => $params['list_id']], ["page" => $params['page'], - "page_size" => $params['page_size']])); + return new ListResult($this->send("get", array_filter($params, fn($key) => in_array($key, ['list_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['page','page_size']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Medical/Allergies.php b/packages/school/src/School/Endpoints/V1/Medical/Allergies.php index ff2f4310..a083f753 100644 --- a/packages/school/src/School/Endpoints/V1/Medical/Allergies.php +++ b/packages/school/src/School/Endpoints/V1/Medical/Allergies.php @@ -40,7 +40,7 @@ public function deleteByAllergyId(array $params): int { assert(isset($params['allergy_id']), new ArgumentException("Parameter `allergy_id` is required")); - return $this->send("delete", ["allergy_id" => $params['allergy_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['allergy_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** @@ -69,7 +69,7 @@ public function patchOnAllergyId(array $params, StudentAllergyUpdate $requestBod assert(isset($params['allergy_id']), new ArgumentException("Parameter `allergy_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["allergy_id" => $params['allergy_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['allergy_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -97,6 +97,6 @@ public function post(StudentMedicalAllergy $requestBody): int { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", [], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/school/src/School/Endpoints/V1/Medical/Allergiesconditions.php b/packages/school/src/School/Endpoints/V1/Medical/Allergiesconditions.php index 8e650949..19808e1a 100644 --- a/packages/school/src/School/Endpoints/V1/Medical/Allergiesconditions.php +++ b/packages/school/src/School/Endpoints/V1/Medical/Allergiesconditions.php @@ -41,6 +41,6 @@ public function post(StudentMedicalAllergyCondition $requestBody): int { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", [], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/school/src/School/Endpoints/V1/Medical/Athleticclearance.php b/packages/school/src/School/Endpoints/V1/Medical/Athleticclearance.php index 1378b663..0c88fe64 100644 --- a/packages/school/src/School/Endpoints/V1/Medical/Athleticclearance.php +++ b/packages/school/src/School/Endpoints/V1/Medical/Athleticclearance.php @@ -5,7 +5,6 @@ use Battis\OpenAPI\Client\BaseEndpoint; use Battis\OpenAPI\Client\Exceptions\ArgumentException; use Blackbaud\SKY\School\Components\StudentAthleticRequirementUpdate; -use string; /** * @api @@ -40,6 +39,6 @@ public function post(StudentAthleticRequirementUpdate $requestBody): array { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return array_map(fn($a) => new string($a), $this->send("post", [], [], $requestBody)); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/school/src/School/Endpoints/V1/Medical/Conditions.php b/packages/school/src/School/Endpoints/V1/Medical/Conditions.php index 7180ab96..2f43f099 100644 --- a/packages/school/src/School/Endpoints/V1/Medical/Conditions.php +++ b/packages/school/src/School/Endpoints/V1/Medical/Conditions.php @@ -40,7 +40,7 @@ public function deleteByConditionId(array $params): int { assert(isset($params['condition_id']), new ArgumentException("Parameter `condition_id` is required")); - return $this->send("delete", ["condition_id" => $params['condition_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['condition_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** @@ -69,7 +69,7 @@ public function patchOnConditionId(array $params, StudentConditionUpdate $reques assert(isset($params['condition_id']), new ArgumentException("Parameter `condition_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["condition_id" => $params['condition_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['condition_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -97,6 +97,6 @@ public function post(StudentMedicalCondition $requestBody): int { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", [], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/school/src/School/Endpoints/V1/Medical/Immunizations.php b/packages/school/src/School/Endpoints/V1/Medical/Immunizations.php index f4b40c16..aa3e5222 100644 --- a/packages/school/src/School/Endpoints/V1/Medical/Immunizations.php +++ b/packages/school/src/School/Endpoints/V1/Medical/Immunizations.php @@ -39,6 +39,6 @@ public function post(StudentImmunizationUpdate $requestBody): mixed { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", [], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/school/src/School/Endpoints/V1/Medical/Medications.php b/packages/school/src/School/Endpoints/V1/Medical/Medications.php index a489915c..ee9ea038 100644 --- a/packages/school/src/School/Endpoints/V1/Medical/Medications.php +++ b/packages/school/src/School/Endpoints/V1/Medical/Medications.php @@ -42,7 +42,7 @@ public function post(StudentMedicationCreate $requestBody): int { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", [], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -69,7 +69,7 @@ public function deleteByMedicationId(array $params): int { assert(isset($params['medication_id']), new ArgumentException("Parameter `medication_id` is required")); - return $this->send("delete", ["medication_id" => $params['medication_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['medication_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** @@ -98,6 +98,6 @@ public function patchOnMedicationId(array $params, StudentMedicationUpdate $requ assert(isset($params['medication_id']), new ArgumentException("Parameter `medication_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["medication_id" => $params['medication_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['medication_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/school/src/School/Endpoints/V1/Medical/Securityroles.php b/packages/school/src/School/Endpoints/V1/Medical/Securityroles.php index d860bc24..06708fa4 100644 --- a/packages/school/src/School/Endpoints/V1/Medical/Securityroles.php +++ b/packages/school/src/School/Endpoints/V1/Medical/Securityroles.php @@ -27,6 +27,6 @@ class Securityroles extends BaseEndpoint */ public function list_(): SecurityRoleCollection { - return new SecurityRoleCollection($this->send("get", [], [])); + return new SecurityRoleCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Medical/Users/Allergies.php b/packages/school/src/School/Endpoints/V1/Medical/Users/Allergies.php index 5148403b..afc3b567 100644 --- a/packages/school/src/School/Endpoints/V1/Medical/Users/Allergies.php +++ b/packages/school/src/School/Endpoints/V1/Medical/Users/Allergies.php @@ -39,6 +39,6 @@ public function getByUserId(array $params): array { assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); - return array_map(fn($a) => new StudentAllergiesView($a), $this->send("get", ["user_id" => $params['user_id']], [])); + return array_map(fn($a) => new StudentAllergiesView($a), $this->send("get", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Medical/Users/Allergiesconditions.php b/packages/school/src/School/Endpoints/V1/Medical/Users/Allergiesconditions.php index af3ebd52..94222572 100644 --- a/packages/school/src/School/Endpoints/V1/Medical/Users/Allergiesconditions.php +++ b/packages/school/src/School/Endpoints/V1/Medical/Users/Allergiesconditions.php @@ -41,6 +41,6 @@ public function getByUserId(array $params): array { assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); - return array_map(fn($a) => new AllergiesAndConditionsView($a), $this->send("get", ["user_id" => $params['user_id']], [])); + return array_map(fn($a) => new AllergiesAndConditionsView($a), $this->send("get", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Medical/Users/Athleticrequirements.php b/packages/school/src/School/Endpoints/V1/Medical/Users/Athleticrequirements.php index 2641e80f..148be6c4 100644 --- a/packages/school/src/School/Endpoints/V1/Medical/Users/Athleticrequirements.php +++ b/packages/school/src/School/Endpoints/V1/Medical/Users/Athleticrequirements.php @@ -51,8 +51,6 @@ public function getByUserId(array $params): array assert(isset($params['season']), new ArgumentException("Parameter `season` is required")); assert(isset($params['include_']), new ArgumentException("Parameter `include_` is required")); - return array_map(fn($a) => new StudentAthleticRequirementRead($a), $this->send("get", ["user_id" => $params['user_id']], ["schoolYear" => $params['schoolYear'], - "season" => $params['season'], - "include_" => $params['include_']])); + return array_map(fn($a) => new StudentAthleticRequirementRead($a), $this->send("get", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['schoolYear','season','include_']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Medical/Users/Conditions.php b/packages/school/src/School/Endpoints/V1/Medical/Users/Conditions.php index 718406c7..91a0e328 100644 --- a/packages/school/src/School/Endpoints/V1/Medical/Users/Conditions.php +++ b/packages/school/src/School/Endpoints/V1/Medical/Users/Conditions.php @@ -39,6 +39,6 @@ public function getByUserId(array $params): array { assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); - return array_map(fn($a) => new StudentConditionView($a), $this->send("get", ["user_id" => $params['user_id']], [])); + return array_map(fn($a) => new StudentConditionView($a), $this->send("get", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Medical/Users/Immunizations.php b/packages/school/src/School/Endpoints/V1/Medical/Users/Immunizations.php index f8e57a27..ae941ae6 100644 --- a/packages/school/src/School/Endpoints/V1/Medical/Users/Immunizations.php +++ b/packages/school/src/School/Endpoints/V1/Medical/Users/Immunizations.php @@ -45,6 +45,6 @@ public function getByUserId(array $params): array assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); assert(isset($params['include_']), new ArgumentException("Parameter `include_` is required")); - return array_map(fn($a) => new StudentImmunizationRead($a), $this->send("get", ["user_id" => $params['user_id']], ["include_" => $params['include_']])); + return array_map(fn($a) => new StudentImmunizationRead($a), $this->send("get", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['include_']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Medical/Users/Medications.php b/packages/school/src/School/Endpoints/V1/Medical/Users/Medications.php index 0999c607..9ad6ba6c 100644 --- a/packages/school/src/School/Endpoints/V1/Medical/Users/Medications.php +++ b/packages/school/src/School/Endpoints/V1/Medical/Users/Medications.php @@ -40,6 +40,6 @@ public function getByUserId(array $params): array { assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); - return array_map(fn($a) => new StudentMedicationRead($a), $this->send("get", ["user_id" => $params['user_id']], [])); + return array_map(fn($a) => new StudentMedicationRead($a), $this->send("get", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Offeringtypes.php b/packages/school/src/School/Endpoints/V1/Offeringtypes.php index 174564b7..8d22cdeb 100644 --- a/packages/school/src/School/Endpoints/V1/Offeringtypes.php +++ b/packages/school/src/School/Endpoints/V1/Offeringtypes.php @@ -31,6 +31,6 @@ class Offeringtypes extends BaseEndpoint */ public function list_(): OfferingTypeCollection { - return new OfferingTypeCollection($this->send("get", [], [])); + return new OfferingTypeCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Roles.php b/packages/school/src/School/Endpoints/V1/Roles.php index 54c73d6a..47a3226d 100644 --- a/packages/school/src/School/Endpoints/V1/Roles.php +++ b/packages/school/src/School/Endpoints/V1/Roles.php @@ -29,6 +29,6 @@ class Roles extends BaseEndpoint */ public function list_(): RoleCollection { - return new RoleCollection($this->send("get", [], [])); + return new RoleCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Schedules/Meetings.php b/packages/school/src/School/Endpoints/V1/Schedules/Meetings.php index 2236c324..15199ddd 100644 --- a/packages/school/src/School/Endpoints/V1/Schedules/Meetings.php +++ b/packages/school/src/School/Endpoints/V1/Schedules/Meetings.php @@ -49,9 +49,9 @@ class Meetings extends BaseEndpoint * * - Scheduling Manager * - * @param array{start_date: string, end_date: string, offering_types: + * @param array{start_date: string, end_date: string, offering_types?: * string, section_ids: string, last_modified: string, - * show_time_for_current_date: bool} $params An associative array + * show_time_for_current_date?: bool} $params An associative array * - start_date: Format - date-time (as date-time in RFC3339). Use * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) date format: * 2022-04-01. @@ -81,17 +81,10 @@ public function list_(array $params): MeetingCollection { assert(isset($params['start_date']), new ArgumentException("Parameter `start_date` is required")); assert(isset($params['end_date']), new ArgumentException("Parameter `end_date` is required")); - assert(isset($params['offering_types']), new ArgumentException("Parameter `offering_types` is required")); assert(isset($params['section_ids']), new ArgumentException("Parameter `section_ids` is required")); assert(isset($params['last_modified']), new ArgumentException("Parameter `last_modified` is required")); - assert(isset($params['show_time_for_current_date']), new ArgumentException("Parameter `show_time_for_current_date` is required")); - return new MeetingCollection($this->send("get", [], ["start_date" => $params['start_date'], - "end_date" => $params['end_date'], - "offering_types" => $params['offering_types'], - "section_ids" => $params['section_ids'], - "last_modified" => $params['last_modified'], - "show_time_for_current_date" => $params['show_time_for_current_date']])); + return new MeetingCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['start_date','end_date','offering_types','section_ids','last_modified','show_time_for_current_date']), ARRAY_FILTER_USE_KEY))); } /** @@ -103,14 +96,13 @@ public function list_(array $params): MeetingCollection * Default date range is 30 days. * * Requires at least one of the following roles in the Education - * Management system: + * Management system and group page access should be set for one of the + * roles: * * - Student * * - Parent * - * - Platform Manager - * * - Attendance Manager * * - Schedule Manager @@ -133,7 +125,6 @@ public function searchByStudentId(array $params): StudentScheduleCollection assert(isset($params['start_date']), new ArgumentException("Parameter `start_date` is required")); assert(isset($params['end_date']), new ArgumentException("Parameter `end_date` is required")); - return new StudentScheduleCollection($this->send("get", ["student_id" => $params['student_id']], ["start_date" => $params['start_date'], - "end_date" => $params['end_date']])); + return new StudentScheduleCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['student_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['start_date','end_date']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Sessions.php b/packages/school/src/School/Endpoints/V1/Sessions.php index 7d3a16b9..3e6def23 100644 --- a/packages/school/src/School/Endpoints/V1/Sessions.php +++ b/packages/school/src/School/Endpoints/V1/Sessions.php @@ -44,7 +44,6 @@ public function list_(array $params): SchoolSessionCollection assert(isset($params['level_num']), new ArgumentException("Parameter `level_num` is required")); assert(isset($params['school_year']), new ArgumentException("Parameter `school_year` is required")); - return new SchoolSessionCollection($this->send("get", [], ["level_num" => $params['level_num'], - "school_year" => $params['school_year']])); + return new SchoolSessionCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['level_num','school_year']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Terms.php b/packages/school/src/School/Endpoints/V1/Terms.php index 90b0d3cd..fccfba15 100644 --- a/packages/school/src/School/Endpoints/V1/Terms.php +++ b/packages/school/src/School/Endpoints/V1/Terms.php @@ -47,7 +47,6 @@ public function list_(array $params): TermCollection assert(isset($params['school_year']), new ArgumentException("Parameter `school_year` is required")); assert(isset($params['offering_type']), new ArgumentException("Parameter `offering_type` is required")); - return new TermCollection($this->send("get", [], ["school_year" => $params['school_year'], - "offering_type" => $params['offering_type']])); + return new TermCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['school_year','offering_type']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Testscores.php b/packages/school/src/School/Endpoints/V1/Testscores.php index d32c0a51..7ad933cf 100644 --- a/packages/school/src/School/Endpoints/V1/Testscores.php +++ b/packages/school/src/School/Endpoints/V1/Testscores.php @@ -56,7 +56,7 @@ public function list_(array $params): TestScoreCollection { assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); - return new TestScoreCollection($this->send("get", [], ["user_id" => $params['user_id']])); + return new TestScoreCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY))); } /** @@ -80,6 +80,6 @@ public function postToUserId(array $params, TestScoreAdd $requestBody): int assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", ["user_id" => $params['user_id']], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/school/src/School/Endpoints/V1/Testscores/Testtypes.php b/packages/school/src/School/Endpoints/V1/Testscores/Testtypes.php index 1ebb2649..cd72d0f1 100644 --- a/packages/school/src/School/Endpoints/V1/Testscores/Testtypes.php +++ b/packages/school/src/School/Endpoints/V1/Testscores/Testtypes.php @@ -28,6 +28,6 @@ class Testtypes extends BaseEndpoint */ public function list_(): TestTypeCollection { - return new TestTypeCollection($this->send("get", [], [])); + return new TestTypeCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Timezone.php b/packages/school/src/School/Endpoints/V1/Timezone.php index d42f2366..8f9dd59d 100644 --- a/packages/school/src/School/Endpoints/V1/Timezone.php +++ b/packages/school/src/School/Endpoints/V1/Timezone.php @@ -31,6 +31,6 @@ class Timezone extends BaseEndpoint */ public function get(): Components_Timezone { - return new Components_Timezone($this->send("get", [], [])); + return new Components_Timezone($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Types/Attendancetypes.php b/packages/school/src/School/Endpoints/V1/Types/Attendancetypes.php index d97e62e0..1dbf3c02 100644 --- a/packages/school/src/School/Endpoints/V1/Types/Attendancetypes.php +++ b/packages/school/src/School/Endpoints/V1/Types/Attendancetypes.php @@ -26,6 +26,6 @@ class Attendancetypes extends BaseEndpoint */ public function get(): Components_AttendanceTypes { - return new Components_AttendanceTypes($this->send("get", [], [])); + return new Components_AttendanceTypes($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Types/Excusedtypes.php b/packages/school/src/School/Endpoints/V1/Types/Excusedtypes.php index 9959d5b9..40ba2f29 100644 --- a/packages/school/src/School/Endpoints/V1/Types/Excusedtypes.php +++ b/packages/school/src/School/Endpoints/V1/Types/Excusedtypes.php @@ -28,6 +28,6 @@ class Excusedtypes extends BaseEndpoint */ public function list_(): ExcusedTypesCollection { - return new ExcusedTypesCollection($this->send("get", [], [])); + return new ExcusedTypesCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Types/Excusedurationtypes.php b/packages/school/src/School/Endpoints/V1/Types/Excusedurationtypes.php index 891d0ecb..08b3b359 100644 --- a/packages/school/src/School/Endpoints/V1/Types/Excusedurationtypes.php +++ b/packages/school/src/School/Endpoints/V1/Types/Excusedurationtypes.php @@ -26,6 +26,6 @@ class Excusedurationtypes extends BaseEndpoint */ public function get(): Components_ExcuseDurationTypes { - return new Components_ExcuseDurationTypes($this->send("get", [], [])); + return new Components_ExcuseDurationTypes($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Types/Tables.php b/packages/school/src/School/Endpoints/V1/Types/Tables.php index c0ab2b86..c1316c79 100644 --- a/packages/school/src/School/Endpoints/V1/Types/Tables.php +++ b/packages/school/src/School/Endpoints/V1/Types/Tables.php @@ -27,6 +27,6 @@ class Tables extends BaseEndpoint */ public function list_(): TableCollection { - return new TableCollection($this->send("get", [], [])); + return new TableCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Types/Tablevalues.php b/packages/school/src/School/Endpoints/V1/Types/Tablevalues.php index e74ad1cf..1bdfd98e 100644 --- a/packages/school/src/School/Endpoints/V1/Types/Tablevalues.php +++ b/packages/school/src/School/Endpoints/V1/Types/Tablevalues.php @@ -4,6 +4,8 @@ use Battis\OpenAPI\Client\BaseEndpoint; use Battis\OpenAPI\Client\Exceptions\ArgumentException; +use Blackbaud\SKY\School\Components\AddTableValuesRequest; +use Blackbaud\SKY\School\Components\AddTableValuesResponse; use Blackbaud\SKY\School\Components\TableValueCollection; /** @@ -26,7 +28,7 @@ class Tablevalues extends BaseEndpoint * no results will be returned. \*\*\*This endpoint is in BETA. It may be * removed or replaced with a 90 day deprecation period.\*\*\* * - * @param array{tableId: int, tableName: string, includeInactive: bool} + * @param array{tableId?: int, tableName: string, includeInactive?: bool} * $params An associative array * - tableId: Format - int32. The ID of the table type. The tableId is * returned by [Types table @@ -44,12 +46,30 @@ class Tablevalues extends BaseEndpoint */ public function list_(array $params): TableValueCollection { - assert(isset($params['tableId']), new ArgumentException("Parameter `tableId` is required")); assert(isset($params['tableName']), new ArgumentException("Parameter `tableName` is required")); - assert(isset($params['includeInactive']), new ArgumentException("Parameter `includeInactive` is required")); - return new TableValueCollection($this->send("get", [], ["tableId" => $params['tableId'], - "tableName" => $params['tableName'], - "includeInactive" => $params['includeInactive']])); + return new TableValueCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['tableId','tableName','includeInactive']), ARRAY_FILTER_USE_KEY))); + } + + /** + * Add a new table value to a table type. + * + * Allowed table types: Allergy, Condition \*\*\*This endpoint is in + * BETA. It may be removed or replaced with a 90 day deprecation + * period.\*\*\* + * + * @param \Blackbaud\SKY\School\Components\AddTableValuesRequest + * $requestBody + * + * @return \Blackbaud\SKY\School\Components\AddTableValuesResponse Success + * + * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required + * parameters are not defined + */ + public function post(AddTableValuesRequest $requestBody): AddTableValuesResponse + { + assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); + + return new AddTableValuesResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } } diff --git a/packages/school/src/School/Endpoints/V1/Users.php b/packages/school/src/School/Endpoints/V1/Users.php index 71ecdc2d..01083c10 100644 --- a/packages/school/src/School/Endpoints/V1/Users.php +++ b/packages/school/src/School/Endpoints/V1/Users.php @@ -205,7 +205,7 @@ class Users extends BaseEndpoint * of results. For example: ```marker=101``` will return the second set of * results. * - * Results dependant on the directory settings of each user. + * Results are dependent on the directory settings of each user. * * Requires at least one of the following roles in the Education * Management system: @@ -249,14 +249,7 @@ public function list_(array $params): UserReadCollection assert(isset($params['end_grad_year']), new ArgumentException("Parameter `end_grad_year` is required")); assert(isset($params['marker']), new ArgumentException("Parameter `marker` is required")); - return new UserReadCollection($this->send("get", [], ["roles" => $params['roles'], - "first_name" => $params['first_name'], - "last_name" => $params['last_name'], - "email" => $params['email'], - "maiden_name" => $params['maiden_name'], - "grad_year" => $params['grad_year'], - "end_grad_year" => $params['end_grad_year'], - "marker" => $params['marker']])); + return new UserReadCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['roles','first_name','last_name','email','maiden_name','grad_year','end_grad_year','marker']), ARRAY_FILTER_USE_KEY))); } /** @@ -283,7 +276,7 @@ public function post(UserAdd $requestBody): int { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", [], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -310,7 +303,7 @@ public function patch(UserEdit $requestBody): int { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", [], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -333,6 +326,6 @@ public function getByUserId(array $params): UserRead { assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); - return new UserRead($this->send("get", ["user_id" => $params['user_id']], [])); + return new UserRead($this->send("get", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Addresses.php b/packages/school/src/School/Endpoints/V1/Users/Addresses.php index 079bacec..c933958f 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Addresses.php +++ b/packages/school/src/School/Endpoints/V1/Users/Addresses.php @@ -56,7 +56,7 @@ public function searchByUserId(array $params): AddressReadCollection { assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); - return new AddressReadCollection($this->send("get", ["user_id" => $params['user_id']], [])); + return new AddressReadCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -86,7 +86,7 @@ public function postToUserId(array $params, AddressAdd $requestBody): int assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", ["user_id" => $params['user_id']], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -119,8 +119,7 @@ public function patchOnUserIdAndAddressId(array $params, AddressEdit $requestBod assert(isset($params['address_id']), new ArgumentException("Parameter `address_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["user_id" => $params['user_id'], - "address_id" => $params['address_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['user_id','address_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -160,8 +159,6 @@ public function deleteByUserIdAndAddressIdAndAddressTypeId(array $params): mixed assert(isset($params['address_id']), new ArgumentException("Parameter `address_id` is required")); assert(isset($params['address_type_id']), new ArgumentException("Parameter `address_type_id` is required")); - return $this->send("delete", ["user_id" => $params['user_id'], - "address_id" => $params['address_id'], - "address_type_id" => $params['address_type_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['user_id','address_id','address_type_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Addresses/Share.php b/packages/school/src/School/Endpoints/V1/Users/Addresses/Share.php index 60ea5aac..17e36e3c 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Addresses/Share.php +++ b/packages/school/src/School/Endpoints/V1/Users/Addresses/Share.php @@ -49,6 +49,6 @@ public function postToUserId(array $params, AddressShare $requestBody): int assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", ["user_id" => $params['user_id']], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Addresstypes.php b/packages/school/src/School/Endpoints/V1/Users/Addresstypes.php index 28fc0a77..7a0b9351 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Addresstypes.php +++ b/packages/school/src/School/Endpoints/V1/Users/Addresstypes.php @@ -29,6 +29,6 @@ class Addresstypes extends BaseEndpoint */ public function list_(): AddressTypeCollection { - return new AddressTypeCollection($this->send("get", [], [])); + return new AddressTypeCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Audit.php b/packages/school/src/School/Endpoints/V1/Users/Audit.php index 3ab02871..8f1e73f0 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Audit.php +++ b/packages/school/src/School/Endpoints/V1/Users/Audit.php @@ -46,8 +46,6 @@ public function list_(array $params): UserAuditReadCollection assert(isset($params['start_date']), new ArgumentException("Parameter `start_date` is required")); assert(isset($params['end_date']), new ArgumentException("Parameter `end_date` is required")); - return new UserAuditReadCollection($this->send("get", [], ["role_id" => $params['role_id'], - "start_date" => $params['start_date'], - "end_date" => $params['end_date']])); + return new UserAuditReadCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['role_id','start_date','end_date']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Bbidstatus.php b/packages/school/src/School/Endpoints/V1/Users/Bbidstatus.php index f363f629..8f5c260a 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Bbidstatus.php +++ b/packages/school/src/School/Endpoints/V1/Users/Bbidstatus.php @@ -49,7 +49,6 @@ public function list_(array $params): SchoolBbidStatusCollection assert(isset($params['base_role_ids']), new ArgumentException("Parameter `base_role_ids` is required")); assert(isset($params['marker']), new ArgumentException("Parameter `marker` is required")); - return new SchoolBbidStatusCollection($this->send("get", [], ["base_role_ids" => $params['base_role_ids'], - "marker" => $params['marker']])); + return new SchoolBbidStatusCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['base_role_ids','marker']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Changed.php b/packages/school/src/School/Endpoints/V1/Users/Changed.php index bf60fb89..eeadb255 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Changed.php +++ b/packages/school/src/School/Endpoints/V1/Users/Changed.php @@ -44,7 +44,6 @@ public function list_(array $params): UserExtendedCollection assert(isset($params['base_role_ids']), new ArgumentException("Parameter `base_role_ids` is required")); assert(isset($params['start_date']), new ArgumentException("Parameter `start_date` is required")); - return new UserExtendedCollection($this->send("get", [], ["base_role_ids" => $params['base_role_ids'], - "start_date" => $params['start_date']])); + return new UserExtendedCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['base_role_ids','start_date']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Customfields.php b/packages/school/src/School/Endpoints/V1/Users/Customfields.php index d6ec3246..dace9d32 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Customfields.php +++ b/packages/school/src/School/Endpoints/V1/Users/Customfields.php @@ -79,9 +79,7 @@ public function list_(array $params): UserAdminCustomFieldCollection assert(isset($params['marker']), new ArgumentException("Parameter `marker` is required")); assert(isset($params['field_ids']), new ArgumentException("Parameter `field_ids` is required")); - return new UserAdminCustomFieldCollection($this->send("get", [], ["base_role_ids" => $params['base_role_ids'], - "marker" => $params['marker'], - "field_ids" => $params['field_ids']])); + return new UserAdminCustomFieldCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['base_role_ids','marker','field_ids']), ARRAY_FILTER_USE_KEY))); } /** @@ -107,7 +105,7 @@ public function getByUserId(array $params): UserAdminCustomField { assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); - return new UserAdminCustomField($this->send("get", ["user_id" => $params['user_id']], [])); + return new UserAdminCustomField($this->send("get", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -139,7 +137,7 @@ public function postToUserId(array $params, UserAdminCustomFieldCreate $requestB assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", ["user_id" => $params['user_id']], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -167,6 +165,6 @@ public function patchOnUserId(array $params, UserAdminCustomFieldUpdate $request assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["user_id" => $params['user_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Customfields/List.php b/packages/school/src/School/Endpoints/V1/Users/Customfields/List.php index 269d9934..592016e9 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Customfields/List.php +++ b/packages/school/src/School/Endpoints/V1/Users/Customfields/List.php @@ -47,7 +47,7 @@ public function postToUserId(array $params, array $requestBody): bool assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", ["user_id" => $params['user_id']], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -75,6 +75,6 @@ public function patchOnUserId(array $params, array $requestBody): bool assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["user_id" => $params['user_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Education.php b/packages/school/src/School/Endpoints/V1/Users/Education.php index e8bcd7ba..889ae19f 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Education.php +++ b/packages/school/src/School/Endpoints/V1/Users/Education.php @@ -40,7 +40,7 @@ public function searchByUserId(array $params): EducationReadCollection { assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); - return new EducationReadCollection($this->send("get", ["user_id" => $params['user_id']], [])); + return new EducationReadCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -73,7 +73,7 @@ public function postToUserId(array $params, EducationAdd $requestBody): int assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", ["user_id" => $params['user_id']], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -106,8 +106,7 @@ public function deleteByUserIdAndEducationId(array $params): mixed assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); assert(isset($params['education_id']), new ArgumentException("Parameter `education_id` is required")); - return $this->send("delete", ["user_id" => $params['user_id'], - "education_id" => $params['education_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['user_id','education_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** @@ -143,7 +142,6 @@ public function patchOnUserIdAndEducationId(array $params, EducationUpdate $requ assert(isset($params['education_id']), new ArgumentException("Parameter `education_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["user_id" => $params['user_id'], - "education_id" => $params['education_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['user_id','education_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Emergencycontacts.php b/packages/school/src/School/Endpoints/V1/Users/Emergencycontacts.php index c1e01561..b6e852f5 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Emergencycontacts.php +++ b/packages/school/src/School/Endpoints/V1/Users/Emergencycontacts.php @@ -75,6 +75,6 @@ public function getByUserId(array $params): EmergencyContactList { assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); - return new EmergencyContactList($this->send("get", ["user_id" => $params['user_id']], [])); + return new EmergencyContactList($this->send("get", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Emergencycontacts/Changed.php b/packages/school/src/School/Endpoints/V1/Users/Emergencycontacts/Changed.php index a81986e1..95c1b509 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Emergencycontacts/Changed.php +++ b/packages/school/src/School/Endpoints/V1/Users/Emergencycontacts/Changed.php @@ -31,7 +31,7 @@ class Changed extends BaseEndpoint * * - SKY API Data Sync * - * @param array{start_date: string, marker: int} $params An associative + * @param array{start_date: string, marker?: int} $params An associative * array * - start_date: Format - date-time (as date-time in RFC3339). The * date to begin looking for changes. Use @@ -50,9 +50,7 @@ class Changed extends BaseEndpoint public function list_(array $params): EmergencyContactChangeCollection { assert(isset($params['start_date']), new ArgumentException("Parameter `start_date` is required")); - assert(isset($params['marker']), new ArgumentException("Parameter `marker` is required")); - return new EmergencyContactChangeCollection($this->send("get", [], ["start_date" => $params['start_date'], - "marker" => $params['marker']])); + return new EmergencyContactChangeCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['start_date','marker']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Emergencycontacts/Nonuser.php b/packages/school/src/School/Endpoints/V1/Users/Emergencycontacts/Nonuser.php index 27d6982f..d2113302 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Emergencycontacts/Nonuser.php +++ b/packages/school/src/School/Endpoints/V1/Users/Emergencycontacts/Nonuser.php @@ -39,6 +39,6 @@ public function postToUserId(array $params, EmergencyContactNonUserCreate $reque assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", ["user_id" => $params['user_id']], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Emergencycontacts/User.php b/packages/school/src/School/Endpoints/V1/Users/Emergencycontacts/User.php index e864d5b2..358e5051 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Emergencycontacts/User.php +++ b/packages/school/src/School/Endpoints/V1/Users/Emergencycontacts/User.php @@ -44,6 +44,6 @@ public function postToUserId(array $params, EmergencyContactUserCreate $requestB assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", ["user_id" => $params['user_id']], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Employment.php b/packages/school/src/School/Endpoints/V1/Users/Employment.php index 288a767f..b48769a2 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Employment.php +++ b/packages/school/src/School/Endpoints/V1/Users/Employment.php @@ -5,6 +5,7 @@ use Battis\OpenAPI\Client\BaseEndpoint; use Battis\OpenAPI\Client\Exceptions\ArgumentException; use Blackbaud\SKY\School\Components\FacultyEmploymentRead; +use Blackbaud\SKY\School\Components\UserEmploymentCollection; /** * @api @@ -12,7 +13,7 @@ class Employment extends BaseEndpoint { /** - * @var string $url Endpoint URL pattern + * @var string $url */ protected string $url = "https://api.sky.blackbaud.com/school/v1/users/{user_id}/employment"; @@ -36,6 +37,44 @@ public function getByUserId(array $params): FacultyEmploymentRead { assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); - return new FacultyEmploymentRead($this->send("get", ["user_id" => $params['user_id']], [])); + return new FacultyEmploymentRead($this->send("get", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); + } + + /** + * Returns a paginated collection of users employment details based on + * base roles, limited to 1000 users per page. + * + * Use the last user's ID as the ```marker``` value to return the next + * set of results. + * + * Requires the following role in the Education Management system: + * + * - SKY API Data Sync + * + * - SKY API Platform Manager + * + * \*\*\*This endpoint is in BETA. It may be removed or replaced with a 90 + * day deprecation period.\*\*\* + * + * @param array{base_role_ids: string, marker: int} $params An associative + * array + * - base_role_ids: Comma delimited list of base role IDs to get users + * for. + * - marker: Format - int32. The user's ID to start at to return the + * next batch of data. Results will start with the next user in the result + * set. + * + * @return \Blackbaud\SKY\School\Components\UserEmploymentCollection + * Success + * + * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required + * parameters are not defined + */ + public function list_(array $params): UserEmploymentCollection + { + assert(isset($params['base_role_ids']), new ArgumentException("Parameter `base_role_ids` is required")); + assert(isset($params['marker']), new ArgumentException("Parameter `marker` is required")); + + return new UserEmploymentCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['base_role_ids','marker']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Enroll.php b/packages/school/src/School/Endpoints/V1/Users/Enroll.php index 740b2800..fd6e7469 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Enroll.php +++ b/packages/school/src/School/Endpoints/V1/Users/Enroll.php @@ -37,6 +37,6 @@ public function post(UserEnrollmentCreate $requestBody): UserEnrollmentResponse { assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return new UserEnrollmentResponse($this->send("post", [], [], $requestBody)); + return new UserEnrollmentResponse($this->send("post", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody)); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Enrollments.php b/packages/school/src/School/Endpoints/V1/Users/Enrollments.php index 88c3b4b4..e0a67d6c 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Enrollments.php +++ b/packages/school/src/School/Endpoints/V1/Users/Enrollments.php @@ -30,7 +30,7 @@ class Enrollments extends BaseEndpoint * - SKY API Data Sync * * @param array{school_year: string, school_level_id: int, grade_level_id: - * int, limit: int, offset: int} $params An associative array + * int, limit?: int, offset?: int} $params An associative array * - school_year: The school year label to get enrollments for. The * school year should be formatted like ```2022-2023``` * - school_level_id: Format - int32. The school level Id to return @@ -53,13 +53,7 @@ public function list_(array $params): UserEnrollmentCollection assert(isset($params['school_year']), new ArgumentException("Parameter `school_year` is required")); assert(isset($params['school_level_id']), new ArgumentException("Parameter `school_level_id` is required")); assert(isset($params['grade_level_id']), new ArgumentException("Parameter `grade_level_id` is required")); - assert(isset($params['limit']), new ArgumentException("Parameter `limit` is required")); - assert(isset($params['offset']), new ArgumentException("Parameter `offset` is required")); - return new UserEnrollmentCollection($this->send("get", [], ["school_year" => $params['school_year'], - "school_level_id" => $params['school_level_id'], - "grade_level_id" => $params['grade_level_id'], - "limit" => $params['limit'], - "offset" => $params['offset']])); + return new UserEnrollmentCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['school_year','school_level_id','grade_level_id','limit','offset']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Extended.php b/packages/school/src/School/Endpoints/V1/Users/Extended.php index a88ec46d..befaa245 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Extended.php +++ b/packages/school/src/School/Endpoints/V1/Users/Extended.php @@ -46,8 +46,7 @@ public function list_(array $params): UserExtendedCollection assert(isset($params['base_role_ids']), new ArgumentException("Parameter `base_role_ids` is required")); assert(isset($params['marker']), new ArgumentException("Parameter `marker` is required")); - return new UserExtendedCollection($this->send("get", [], ["base_role_ids" => $params['base_role_ids'], - "marker" => $params['marker']])); + return new UserExtendedCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['base_role_ids','marker']), ARRAY_FILTER_USE_KEY))); } /** @@ -69,6 +68,6 @@ public function getByUserId(array $params): UserExtended { assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); - return new UserExtended($this->send("get", ["user_id" => $params['user_id']], [])); + return new UserExtended($this->send("get", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Gendertypes.php b/packages/school/src/School/Endpoints/V1/Users/Gendertypes.php index cd11b4de..c98f84ad 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Gendertypes.php +++ b/packages/school/src/School/Endpoints/V1/Users/Gendertypes.php @@ -29,6 +29,6 @@ class Gendertypes extends BaseEndpoint */ public function list_(): GenderTypeCollection { - return new GenderTypeCollection($this->send("get", [], [])); + return new GenderTypeCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Me.php b/packages/school/src/School/Endpoints/V1/Users/Me.php index 2cdeb224..c546613d 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Me.php +++ b/packages/school/src/School/Endpoints/V1/Users/Me.php @@ -22,6 +22,6 @@ class Me extends BaseEndpoint */ public function get(): UserMe { - return new UserMe($this->send("get", [], [])); + return new UserMe($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Occupations.php b/packages/school/src/School/Endpoints/V1/Users/Occupations.php index 7e986a40..03d348b3 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Occupations.php +++ b/packages/school/src/School/Endpoints/V1/Users/Occupations.php @@ -39,7 +39,7 @@ public function searchByUserId(array $params): OccupationReadCollection { assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); - return new OccupationReadCollection($this->send("get", ["user_id" => $params['user_id']], [])); + return new OccupationReadCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -71,7 +71,7 @@ public function postToUserId(array $params, OccupationCreate $requestBody): int assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", ["user_id" => $params['user_id']], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -106,8 +106,7 @@ public function deleteByUserIdAndOccupationId(array $params): int assert(isset($params['occupation_id']), new ArgumentException("Parameter `occupation_id` is required")); assert(isset($params['current']), new ArgumentException("Parameter `current` is required")); - return $this->send("delete", ["user_id" => $params['user_id'], - "occupation_id" => $params['occupation_id']], ["current" => $params['current']]); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['user_id','occupation_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['current']), ARRAY_FILTER_USE_KEY)); } /** @@ -142,7 +141,6 @@ public function patchOnUserIdAndOccupationId(array $params, OccupationUpdate $re assert(isset($params['occupation_id']), new ArgumentException("Parameter `occupation_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["user_id" => $params['user_id'], - "occupation_id" => $params['occupation_id']], [], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['user_id','occupation_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Phones.php b/packages/school/src/School/Endpoints/V1/Users/Phones.php index 30eb9346..4d6c77b7 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Phones.php +++ b/packages/school/src/School/Endpoints/V1/Users/Phones.php @@ -51,7 +51,7 @@ public function searchByUserId(array $params): PhoneReadCollection { assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); - return new PhoneReadCollection($this->send("get", ["user_id" => $params['user_id']], [])); + return new PhoneReadCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -81,7 +81,7 @@ public function postToUserId(array $params, PhoneAdd $requestBody): int assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", ["user_id" => $params['user_id']], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -119,9 +119,7 @@ public function deleteByUserIdAndPhoneIdAndPhoneTypeId(array $params): mixed assert(isset($params['phone_id']), new ArgumentException("Parameter `phone_id` is required")); assert(isset($params['phone_type_id']), new ArgumentException("Parameter `phone_type_id` is required")); - return $this->send("delete", ["user_id" => $params['user_id'], - "phone_id" => $params['phone_id'], - "phone_type_id" => $params['phone_type_id']], []); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['user_id','phone_id','phone_type_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY)); } /** @@ -129,7 +127,7 @@ public function deleteByUserIdAndPhoneIdAndPhoneTypeId(array $params): mixed * * Returns the ID of the phone number updated. * - * @param array{user_id: int, phone_id: int, split_phone_if_shared: bool} + * @param array{user_id: int, phone_id: int, split_phone_if_shared?: bool} * $params An associative array * - user_id: Format - int32. The ID of the user. * - phone_id: Format - int32. The phone id to be updated. @@ -146,10 +144,8 @@ public function patchOnUserIdAndPhoneId(array $params, PhoneUpdate $requestBody) { assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); assert(isset($params['phone_id']), new ArgumentException("Parameter `phone_id` is required")); - assert(isset($params['split_phone_if_shared']), new ArgumentException("Parameter `split_phone_if_shared` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("patch", ["user_id" => $params['user_id'], - "phone_id" => $params['phone_id']], ["split_phone_if_shared" => $params['split_phone_if_shared']], $requestBody); + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['user_id','phone_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['split_phone_if_shared']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Phones/Share.php b/packages/school/src/School/Endpoints/V1/Users/Phones/Share.php index 21362cf3..ff5d1b38 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Phones/Share.php +++ b/packages/school/src/School/Endpoints/V1/Users/Phones/Share.php @@ -49,6 +49,6 @@ public function postToUserId(array $params, PhoneShare $requestBody): int assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", ["user_id" => $params['user_id']], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Phonetypes.php b/packages/school/src/School/Endpoints/V1/Users/Phonetypes.php index 4077b72e..96c8cb66 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Phonetypes.php +++ b/packages/school/src/School/Endpoints/V1/Users/Phonetypes.php @@ -27,6 +27,6 @@ class Phonetypes extends BaseEndpoint */ public function list_(): PhoneTypeCollection { - return new PhoneTypeCollection($this->send("get", [], [])); + return new PhoneTypeCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Relationships.php b/packages/school/src/School/Endpoints/V1/Users/Relationships.php index f3377d54..368f85b7 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Relationships.php +++ b/packages/school/src/School/Endpoints/V1/Users/Relationships.php @@ -6,6 +6,7 @@ use Battis\OpenAPI\Client\Exceptions\ArgumentException; use Blackbaud\SKY\School\Components\RelationshipCreate; use Blackbaud\SKY\School\Components\RelationshipReadCollection; +use Blackbaud\SKY\School\Components\RelationshipUpdate; /** * @api @@ -13,9 +14,9 @@ class Relationships extends BaseEndpoint { /** - * @var string $url Endpoint URL pattern + * @var string $url */ - protected string $url = "https://api.sky.blackbaud.com/school/v1/users/{user_id}/relationships"; + protected string $url = "https://api.sky.blackbaud.com/school/v1/users/{user_id}/relationships/{left_user_id}"; /** * Returns a collection of a relationships for the specified @@ -43,7 +44,7 @@ public function searchByUserId(array $params): RelationshipReadCollection { assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); - return new RelationshipReadCollection($this->send("get", ["user_id" => $params['user_id']], [])); + return new RelationshipReadCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } /** @@ -77,7 +78,7 @@ public function postToUserId(array $params, RelationshipCreate $requestBody): mi assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); - return $this->send("post", ["user_id" => $params['user_id']], [], $requestBody); + return $this->send("post", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } /** @@ -116,7 +117,41 @@ public function deleteByUserId(array $params): mixed assert(isset($params['left_user']), new ArgumentException("Parameter `left_user` is required")); assert(isset($params['relationship_type']), new ArgumentException("Parameter `relationship_type` is required")); - return $this->send("delete", ["user_id" => $params['user_id']], ["left_user" => $params['left_user'], - "relationship_type" => $params['relationship_type']]); + return $this->send("delete", array_filter($params, fn($key) => in_array($key, ['user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['left_user','relationship_type']), ARRAY_FILTER_USE_KEY)); + } + + /** + * Updates a relationship record for the specified ```user\_id```. + * + * Returns 200 OK Requires at least one of the following roles in the + * Education Management system: + * + * - Contact Card Manager + * + * - Platform Manager + * + * \*\*\*This endpoint is in BETA. It may be removed or replaced with a 90 + * day deprecation period.\*\*\* + * + * @param array{user_id: int, left_user_id: int} $params An associative + * array + * - user_id: Format - int32. The ID of the user. + * - left_user_id: Format - int32. The user ID of the relationship to + * the user + * @param \Blackbaud\SKY\School\Components\RelationshipUpdate $requestBody + * Defines the relationship to be updated. + * + * @return mixed Success + * + * @throws \Battis\OpenAPI\Client\Exceptions\ArgumentException if required + * parameters are not defined + */ + public function patchOnUserIdAndLeftUserId(array $params, RelationshipUpdate $requestBody): mixed + { + assert(isset($params['user_id']), new ArgumentException("Parameter `user_id` is required")); + assert(isset($params['left_user_id']), new ArgumentException("Parameter `left_user_id` is required")); + assert(isset($params['requestBody']), new ArgumentException("Parameter `requestBody` is required")); + + return $this->send("patch", array_filter($params, fn($key) => in_array($key, ['user_id','left_user_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), $requestBody); } } diff --git a/packages/school/src/School/Endpoints/V1/Users/Students.php b/packages/school/src/School/Endpoints/V1/Users/Students.php index c209883b..922aac03 100644 --- a/packages/school/src/School/Endpoints/V1/Users/Students.php +++ b/packages/school/src/School/Endpoints/V1/Users/Students.php @@ -38,6 +38,6 @@ public function searchByParentId(array $params): ChildOfParentCollection { assert(isset($params['parent_id']), new ArgumentException("Parameter `parent_id` is required")); - return new ChildOfParentCollection($this->send("get", ["parent_id" => $params['parent_id']], [])); + return new ChildOfParentCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['parent_id']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Venues/Buildings.php b/packages/school/src/School/Endpoints/V1/Venues/Buildings.php index 16f47579..95f14067 100644 --- a/packages/school/src/School/Endpoints/V1/Venues/Buildings.php +++ b/packages/school/src/School/Endpoints/V1/Venues/Buildings.php @@ -25,6 +25,6 @@ class Buildings extends BaseEndpoint */ public function list_(): BuildingReadCollection { - return new BuildingReadCollection($this->send("get", [], [])); + return new BuildingReadCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } } diff --git a/packages/school/src/School/Endpoints/V1/Years.php b/packages/school/src/School/Endpoints/V1/Years.php index 9a2604cb..afcd4537 100644 --- a/packages/school/src/School/Endpoints/V1/Years.php +++ b/packages/school/src/School/Endpoints/V1/Years.php @@ -33,6 +33,6 @@ class Years extends BaseEndpoint */ public function list_(): YearCollection { - return new YearCollection($this->send("get", [], [])); + return new YearCollection($this->send("get", array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY), array_filter($params, fn($key) => in_array($key, ['']), ARRAY_FILTER_USE_KEY))); } }