give / vendor / vendor-prefixed / stellarwp / licensing-api-client / src / Requests / Credit / Refund.php

Refund.php in GiveWP – Donation Plugin and Fundraising Platform 4.17.0, at vendor/vendor-prefixed/stellarwp/licensing-api-client/src/Requests/Credit/Refund.php

100 lines 1.9 KB

Raw Download Zip

1	<?php declare(strict_types=1);
2
3	namespace Give\Vendors\LiquidWeb\LicensingApiClient\Requests\Credit;
4
5	/**
6	* Represents a credit refund write request payload.
7	*
8	* @phpstan-type RefundPayload array{
9	* license_key: string,
10	* domain: string,
11	* product_slug: string,
12	* credit_type: string,
13	* pool_id: int,
14	* credits_refunded: int
15	* }
16	*/
17	final class Refund
18	{
19	/**
20	* License key to refund credits against.
21	*
22	* @example LWSW-8H9F-5UKA-VR3B-D7SQ-BP9N
23	*/
24	public string $licenseKey;
25
26	/**
27	* Site domain receiving the refund.
28	*
29	* @example example.com
30	*/
31	public string $domain;
32
33	/**
34	* Product identifier responsible for the refund.
35	*
36	* @example plugin-pro
37	*/
38	public string $productSlug;
39
40	/**
41	* Credit type being refunded.
42	*
43	* @example ai
44	*/
45	public string $creditType;
46
47	/**
48	* Pool ID the refund should be applied to.
49	*
50	* @example 42
51	*/
52	public int $poolId;
53
54	/**
55	* Number of credits to refund.
56	*
57	* @example 5
58	*/
59	public int $creditsRefunded;
60
61	/**
62	* Idempotency key forwarded as the X-Idempotency-Key header.
63	*
64	* @example request_456
65	*/
66	public string $idempotencyKey;
67
68	public function __construct(
69	string $licenseKey,
70	string $domain,
71	string $productSlug,
72	string $creditType,
73	int $poolId,
74	int $creditsRefunded,
75	string $idempotencyKey
76	) {
77	$this->licenseKey = $licenseKey;
78	$this->domain = $domain;
79	$this->productSlug = $productSlug;
80	$this->creditType = $creditType;
81	$this->poolId = $poolId;
82	$this->creditsRefunded = $creditsRefunded;
83	$this->idempotencyKey = $idempotencyKey;
84	}
85
86	/**
87	* @return RefundPayload
88	*/
89	public function toArray(): array {
90	return [
91	'license_key' => $this->licenseKey,
92	'domain' => $this->domain,
93	'product_slug' => $this->productSlug,
94	'credit_type' => $this->creditType,
95	'pool_id' => $this->poolId,
96	'credits_refunded' => $this->creditsRefunded,
97	];
98	}
99	}
100