GetSubscriptionCollectionParams.php
9 months ago
GetSubscriptionItemSchema.php
8 months ago
GetSubscriptionSharedParamsForGetMethods.php
9 months ago
GetSubscriptionItemSchema.php
209 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\API\REST\V3\Routes\Subscriptions\Actions; |
| 4 | |
| 5 | use Give\Subscriptions\ValueObjects\SubscriptionPeriod; |
| 6 | use Give\Subscriptions\ValueObjects\SubscriptionStatus; |
| 7 | |
| 8 | /** |
| 9 | * @since 4.8.0 |
| 10 | */ |
| 11 | class GetSubscriptionItemSchema |
| 12 | { |
| 13 | /** |
| 14 | * @since 4.10.0 added campaignId |
| 15 | * @since 4.8.0 |
| 16 | */ |
| 17 | public function __invoke(): array |
| 18 | { |
| 19 | return [ |
| 20 | '$schema' => 'http://json-schema.org/draft-04/schema#', |
| 21 | 'title' => 'givewp/subscription', |
| 22 | 'description' => esc_html__('Subscription routes for CRUD operations', 'give'), |
| 23 | 'type' => 'object', |
| 24 | 'properties' => [ |
| 25 | 'id' => [ |
| 26 | 'type' => 'integer', |
| 27 | 'description' => esc_html__('Subscription ID', 'give'), |
| 28 | ], |
| 29 | 'mode' => [ |
| 30 | 'type' => 'string', |
| 31 | 'description' => esc_html__('Subscription mode (live or test)', 'give'), |
| 32 | 'default' => 'live', |
| 33 | 'enum' => ['live', 'test'], |
| 34 | ], |
| 35 | 'campaignId' => [ |
| 36 | 'type' => 'integer', |
| 37 | 'description' => esc_html__('Campaign ID', 'give'), |
| 38 | 'nullable' => true, |
| 39 | ], |
| 40 | 'donationFormId' => [ |
| 41 | 'type' => 'integer', |
| 42 | 'description' => esc_html__('Donation form ID', 'give'), |
| 43 | 'required' => true, |
| 44 | ], |
| 45 | 'donorId' => [ |
| 46 | 'type' => 'integer', |
| 47 | 'description' => esc_html__('Donor ID. Returns 0 for anonymous donors when data is redacted.', 'give'), |
| 48 | 'required' => true, |
| 49 | ], |
| 50 | 'firstName' => [ |
| 51 | 'type' => 'string', |
| 52 | 'description' => esc_html__('Donor first name. Returns "anonymous" for anonymous donors when data is redacted.', 'give'), |
| 53 | 'format' => 'text-field', |
| 54 | ], |
| 55 | 'lastName' => [ |
| 56 | 'type' => 'string', |
| 57 | 'description' => esc_html__('Donor last name. Returns "anonymous" for anonymous donors when data is redacted.', 'give'), |
| 58 | 'format' => 'text-field', |
| 59 | ], |
| 60 | 'amount' => [ |
| 61 | 'type' => 'object', |
| 62 | 'properties' => [ |
| 63 | 'value' => [ |
| 64 | 'type' => 'number', |
| 65 | 'description' => esc_html__('Amount in decimal format', 'give'), |
| 66 | ], |
| 67 | 'valueInMinorUnits' => [ |
| 68 | 'type' => 'integer', |
| 69 | 'description' => esc_html__('Amount in minor units (cents)', 'give'), |
| 70 | ], |
| 71 | 'currency' => [ |
| 72 | 'type' => 'string', |
| 73 | 'format' => 'text-field', |
| 74 | 'description' => esc_html__('Currency code (e.g., USD, EUR)', 'give'), |
| 75 | ], |
| 76 | ], |
| 77 | 'description' => esc_html__('Subscription amount', 'give'), |
| 78 | 'required' => true, |
| 79 | ], |
| 80 | 'feeAmountRecovered' => [ |
| 81 | 'type' => ['object', 'null'], |
| 82 | 'properties' => [ |
| 83 | 'value' => [ |
| 84 | 'type' => 'number', |
| 85 | 'description' => esc_html__('Fee amount in decimal format', 'give'), |
| 86 | ], |
| 87 | 'valueInMinorUnits' => [ |
| 88 | 'type' => 'integer', |
| 89 | 'description' => esc_html__('Fee amount in minor units (cents)', 'give'), |
| 90 | ], |
| 91 | 'currency' => [ |
| 92 | 'type' => 'string', |
| 93 | 'format' => 'text-field', |
| 94 | 'description' => esc_html__('Currency code (e.g., USD, EUR)', 'give'), |
| 95 | ], |
| 96 | ], |
| 97 | 'description' => esc_html__('Fee amount recovered', 'give'), |
| 98 | ], |
| 99 | 'status' => [ |
| 100 | 'type' => 'string', |
| 101 | 'description' => esc_html__('Subscription status', 'give'), |
| 102 | 'enum' => ['any', ...array_values(SubscriptionStatus::toArray())], |
| 103 | 'required' => true, |
| 104 | ], |
| 105 | 'period' => [ |
| 106 | 'type' => 'string', |
| 107 | 'description' => esc_html__('Subscription billing period', 'give'), |
| 108 | 'enum' => array_values(SubscriptionPeriod::toArray()), |
| 109 | 'required' => true, |
| 110 | ], |
| 111 | 'frequency' => [ |
| 112 | 'type' => 'integer', |
| 113 | 'description' => esc_html__('Billing frequency', 'give'), |
| 114 | 'required' => true, |
| 115 | ], |
| 116 | 'installments' => [ |
| 117 | 'type' => 'integer', |
| 118 | 'description' => esc_html__('Number of installments (0 for unlimited)', 'give'), |
| 119 | 'default' => 0, |
| 120 | ], |
| 121 | 'transactionId' => [ |
| 122 | 'type' => ['string', 'null'], |
| 123 | 'description' => esc_html__('Transaction ID. Returns empty string when sensitive data is excluded.', 'give'), |
| 124 | 'format' => 'text-field', |
| 125 | ], |
| 126 | 'gatewaySubscriptionId' => [ |
| 127 | 'type' => ['string', 'null'], |
| 128 | 'description' => esc_html__('Gateway subscription ID. Returns empty string when sensitive data is excluded.', 'give'), |
| 129 | 'format' => 'text-field', |
| 130 | ], |
| 131 | 'gatewayId' => [ |
| 132 | 'type' => 'string', |
| 133 | 'description' => esc_html__('Payment gateway ID', 'give'), |
| 134 | 'format' => 'text-field', |
| 135 | 'required' => true, |
| 136 | ], |
| 137 | 'gateway' => [ |
| 138 | 'type' => ['object', 'null'], |
| 139 | 'properties' => [ |
| 140 | 'id' => [ |
| 141 | 'type' => 'string', |
| 142 | 'description' => esc_html__('Gateway ID', 'give'), |
| 143 | ], |
| 144 | 'name' => [ |
| 145 | 'type' => 'string', |
| 146 | 'description' => esc_html__('Gateway name', 'give'), |
| 147 | ], |
| 148 | 'label' => [ |
| 149 | 'type' => 'string', |
| 150 | 'description' => esc_html__('Payment method label', 'give'), |
| 151 | ], |
| 152 | 'subscriptionUrl' => [ |
| 153 | 'type' => 'string', |
| 154 | 'format' => 'uri', |
| 155 | 'description' => esc_html__('Gateway dashboard subscription URL', 'give'), |
| 156 | ], |
| 157 | 'canSync' => [ |
| 158 | 'type' => 'boolean', |
| 159 | 'description' => esc_html__('Whether the gateway supports transaction synchronization', 'give'), |
| 160 | ], |
| 161 | ], |
| 162 | 'description' => esc_html__('Payment gateway details. Returns null when gateway is not available or not registered.', 'give'), |
| 163 | 'readonly' => true, |
| 164 | ], |
| 165 | 'createdAt' => [ |
| 166 | 'type' => ['string', 'null'], |
| 167 | 'description' => sprintf( |
| 168 | /* translators: %s: WordPress documentation URL */ |
| 169 | esc_html__('Subscription creation date in ISO 8601 format. Follows WordPress REST API date format standards. See %s for more information.', 'give'), |
| 170 | '<a href="https://developer.wordpress.org/rest-api/extending-the-rest-api/schema/#format" target="_blank">WordPress REST API Date and Time</a>' |
| 171 | ), |
| 172 | 'format' => 'date-time', |
| 173 | 'example' => '2025-09-02T20:27:02', |
| 174 | ], |
| 175 | 'renewsAt' => [ |
| 176 | 'type' => ['string', 'null'], |
| 177 | 'description' => sprintf( |
| 178 | /* translators: %s: WordPress documentation URL */ |
| 179 | esc_html__('Next renewal date in ISO 8601 format. Follows WordPress REST API date format standards. See %s for more information.', 'give'), |
| 180 | '<a href="https://developer.wordpress.org/rest-api/extending-the-rest-api/schema/#format" target="_blank">WordPress REST API Date and Time</a>' |
| 181 | ), |
| 182 | 'format' => 'date-time', |
| 183 | 'example' => '2025-09-02T20:27:02', |
| 184 | ], |
| 185 | 'projectedAnnualRevenue' => [ |
| 186 | 'type' => 'object', |
| 187 | 'properties' => [ |
| 188 | 'value' => [ |
| 189 | 'type' => 'number', |
| 190 | 'description' => esc_html__('Projected annual revenue in decimal format', 'give'), |
| 191 | ], |
| 192 | 'valueInMinorUnits' => [ |
| 193 | 'type' => 'integer', |
| 194 | 'description' => esc_html__('Projected annual revenue in minor units (cents)', 'give'), |
| 195 | ], |
| 196 | 'currency' => [ |
| 197 | 'type' => 'string', |
| 198 | 'format' => 'text-field', |
| 199 | 'description' => esc_html__('Currency code (e.g., USD, EUR)', 'give'), |
| 200 | ], |
| 201 | ], |
| 202 | 'description' => esc_html__('Projected annual revenue for this subscription', 'give'), |
| 203 | 'readonly' => true, |
| 204 | ], |
| 205 | ], |
| 206 | ]; |
| 207 | } |
| 208 | } |
| 209 |