@paciolan/cybersource-sdk
Version:
CyberSource REST API Typescript SDK
81 lines (80 loc) • 2.86 kB
TypeScript
/**
* CyberSource Merged Spec
* All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
*
* OpenAPI spec version: 0.0.1
*
*
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the class manually.
*/
import { Notificationsubscriptionsv1webhooksRetryPolicy } from './notificationsubscriptionsv1webhooks-retry-policy';
import { Notificationsubscriptionsv1webhooksSecurityPolicy1 } from './notificationsubscriptionsv1webhooks-security-policy1';
/**
*
* @export
* @interface V1WebhooksBody
*/
export interface V1WebhooksBody {
/**
* Client friendly webhook name.
* @type {string}
* @memberof V1WebhooksBody
*/
name?: string;
/**
* Client friendly webhook description.
* @type {string}
* @memberof V1WebhooksBody
*/
description?: string;
/**
* Organization Identifier (OrgId) or Merchant Identifier (MID).
* @type {string}
* @memberof V1WebhooksBody
*/
organizationId?: string;
/**
* To see the valid productId and eventTypes, call the \"Create and Manage Webhooks - Retrieve a list of event types\" endpoint.
* @type {string}
* @memberof V1WebhooksBody
*/
productId?: string;
/**
* Array of the different events for a given product id.
* @type {Array<string>}
* @memberof V1WebhooksBody
*/
eventTypes?: Array<string>;
/**
* The client's endpoint (URL) to receive webhooks.
* @type {string}
* @memberof V1WebhooksBody
*/
webhookUrl?: string;
/**
* The client's health check endpoint (URL). This should be as close as possible to the actual webhookUrl. If the user does not provide the health check URL, it is the user's responsibility to re-activate the webhook if it is deactivated by calling the test endpoint.
* @type {string}
* @memberof V1WebhooksBody
*/
healthCheckUrl?: string;
/**
* The webhook scope. 1. SELF The Webhook is used to deliver webhooks for only this Organization (or Merchant). 2. DESCENDANTS The Webhook is used to deliver webhooks for this Organization and its children. 3. CUSTOM The Webhook is used to deliver webhooks for the OrgIds (or MiDs) explicitly listed in scopeData field.
* @type {string}
* @memberof V1WebhooksBody
*/
notificationScope?: string;
/**
*
* @type {Notificationsubscriptionsv1webhooksRetryPolicy}
* @memberof V1WebhooksBody
*/
retryPolicy?: Notificationsubscriptionsv1webhooksRetryPolicy;
/**
*
* @type {Notificationsubscriptionsv1webhooksSecurityPolicy1}
* @memberof V1WebhooksBody
*/
securityPolicy?: Notificationsubscriptionsv1webhooksSecurityPolicy1;
}