CreditCards.php 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114
  1. <?php
  2. namespace OntraportAPI;
  3. /**
  4. * Class CreditCards
  5. *
  6. * @author ONTRAPORT
  7. *
  8. * @package OntraportAPI
  9. */
  10. class CreditCards extends BaseApi
  11. {
  12. /**
  13. * $var string endpoint for single credit card
  14. */
  15. protected $_endpoint = "CreditCard";
  16. /**
  17. * $var string endpoint for plural forms
  18. */
  19. protected $_endpointPlural = "CreditCards";
  20. // Credit card-specific function endpoints
  21. const DEFAULT_CARD = "default";
  22. /**
  23. * @param Ontraport $client
  24. */
  25. public function __construct(Ontraport $client)
  26. {
  27. parent::__construct($client);
  28. }
  29. /**
  30. * @brief Retrieve a single specified credit card.
  31. *
  32. * @param mixed[] $requestParams The parameters to submit with GET request.
  33. * Possible array keys: "id" (required)
  34. *
  35. * @return string JSON formatted response
  36. */
  37. public function retrieveSingle($requestParams)
  38. {
  39. return parent::_retrieveSingle($requestParams);
  40. }
  41. /**
  42. * @brief Retrieve multiple credit cards according to specific criteria, handle pagination
  43. *
  44. * @param mixed[] $requestParams Array of parameters to submit with GET request. All parameters are optional but if "ids"
  45. * are not specified, all will be selected.
  46. * Possible array keys: "ids","start","range","sort","sortDir","condition","search",
  47. * "searchNotes","group_ids","performAll","externs","listFields"
  48. *
  49. * @return string JSON formatted array of response data: each page of data will be an element in that array
  50. */
  51. public function retrieveMultiplePaginated($requestParams)
  52. {
  53. return parent::_retrieveMultiplePaginated($requestParams);
  54. }
  55. /**
  56. * @brief Retrieve multiple credit cards according to specific criteria
  57. *
  58. * @param mixed[] $requestParams Array of parameters to submit with GET request. All parameters are optional but if "ids"
  59. * are not specified, all will be selected.
  60. * Possible array keys: "ids","start","range","sort","sortDir","condition","search",
  61. * "searchNotes","group_ids","performAll","externs","listFields"
  62. *
  63. * @return string JSON formatted response
  64. */
  65. public function retrieveMultiple($requestParams)
  66. {
  67. return parent::_retrieveMultiple($requestParams);
  68. }
  69. /**
  70. * @brief Retrieve information (such as number of credit cards) about credit card collection
  71. *
  72. * @param mixed[] $requestParams Array of parameters to submit with GET request. All parameters are optional.
  73. * Possible array keys: "condition","search","searchNotes","group_ids","performAll"
  74. *
  75. * @return string JSON formatted response
  76. */
  77. public function retrieveCollectionInfo($requestParams)
  78. {
  79. return parent::_retrieveCollectionInfo($requestParams);
  80. }
  81. /**
  82. * @brief Retrieve meta for a credit card object
  83. *
  84. * @return string JSON formatted response
  85. */
  86. public function retrieveMeta()
  87. {
  88. return parent::_retrieveMeta();
  89. }
  90. /**
  91. * @brief Set a specifed credit card as the default.
  92. *
  93. * @param mixed[] $requestParams The parameters to submit with PUT request.
  94. * Possible array keys: "id" (required)
  95. *
  96. * @return string JSON formatted response
  97. */
  98. public function setDefault($requestParams)
  99. {
  100. $requiredParams = array("id");
  101. return $this->client->request($requestParams, $this->_endpoint . "/" . self::DEFAULT_CARD, "put", $requiredParams, $options = NULL);
  102. }
  103. }