BokaMera.API.Host

<back to all web services

GetStripeWebhooks

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin
The following routes are available for this service:
GET/payment/stripe/v1/webhookGet stripe api webhooksReturns webhooks for bokamera
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class StripeWebhookResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Id=null,
        /** @var array<string>|null */
        public ?array $Events=null,
        /** @var string|null */
        public ?string $Url=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['Events'])) $this->Events = JsonConverters::fromArray('string', $o['Events']);
        if (isset($o['Url'])) $this->Url = $o['Url'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->Events)) $o['Events'] = JsonConverters::toArray('string', $this->Events);
        if (isset($this->Url)) $o['Url'] = $this->Url;
        return empty($o) ? new class(){} : $o;
    }
}

class StripeWebhooksResponse implements JsonSerializable
{
    public function __construct(
        /** @var array<StripeWebhookResponse>|null */
        public ?array $StripeWebhooks=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['StripeWebhooks'])) $this->StripeWebhooks = JsonConverters::fromArray('StripeWebhookResponse', $o['StripeWebhooks']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->StripeWebhooks)) $o['StripeWebhooks'] = JsonConverters::toArray('StripeWebhookResponse', $this->StripeWebhooks);
        return empty($o) ? new class(){} : $o;
    }
}

// @ValidateRequest(Validator="IsAuthenticated")
class GetStripeWebhooks implements ICompany, JsonSerializable
{
    public function __construct(
        /** @description The company id, if empty will use the company id for the user you are logged in with. */
        // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
        /** @var string|null */
        public ?string $CompanyId=null,

        /** @description Webhook Id to update events */
        // @ApiMember(Description="Webhook Id to update events")
        /** @var string|null */
        public ?string $WebhookId=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
        if (isset($o['WebhookId'])) $this->WebhookId = $o['WebhookId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
        if (isset($this->WebhookId)) $o['WebhookId'] = $this->WebhookId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetStripeWebhooks DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /payment/stripe/v1/webhook HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"StripeWebhooks":[{"Id":"String","Events":["String"],"Url":"String"}]}