@paciolan/cybersource-sdk
Version:
CyberSource REST API Typescript SDK
69 lines (68 loc) • 4.21 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.
*/
/**
* Retry policy for the individual webhooks that are a part of your subscription. If a message fails to deliver, it will execute through this retry policy. Automatic suspend and resume: If you experience downtime and have `deactivateFlag = true` any new messages will be held in a \"SUSPENDED\" status. When your healthCheckUrl returns healthy again, the subscription will automatically be re-enabled and your messages will be sent. We will ping your healthCheckUrl routinely using a POST call with an empty payload to check availability. If your endpoint returns an unhealthy status of != 200, we will check the healthCheckUrl at a more frequent rate until it is healthy again. If you experience downtime and have `deactivateFlag = false` and your message exhausts all retry attempts the message will go to a \"FAILED\" status. Support will be notified and will reach out to suggest you execute the \"REPLAY\" endpoint at a later date when your server is healthy. Reference the below values for formulas and calculations related to the frequency of retries depending on algorithm and configuration.
* @export
* @interface Notificationsubscriptionsv1webhooksRetryPolicy
*/
export interface Notificationsubscriptionsv1webhooksRetryPolicy {
/**
* This is used to calculate the Retry Sequence. Sample calculations using firstRetry=10, interval=30, maxNumberOfRetries=3 Arithmetic = a+r(n-1) Retry 1 - 10 minutes Retry 2 - 10+30x1 = 40 minutes Retry 3 - 10+30x2 = 70 minutes Geometric = ar^(n-1) Retry 1 - 10 minutes Retry 2 - 10x30^1 = 300 minutes Retry 3 - 10x30^2 = 9,000 minutes
* @type {string}
* @memberof Notificationsubscriptionsv1webhooksRetryPolicy
*/
algorithm?: string;
/**
* When to initiate first retry, after the initial call failed. (in mins).
* @type {number}
* @memberof Notificationsubscriptionsv1webhooksRetryPolicy
*/
firstRetry?: number;
/**
* The interval between retries (in mins).
* @type {number}
* @memberof Notificationsubscriptionsv1webhooksRetryPolicy
*/
interval?: number;
/**
* The number of retries per sequence.
* @type {number}
* @memberof Notificationsubscriptionsv1webhooksRetryPolicy
*/
numberOfRetries?: number;
/**
* Deactivate the subscription if your retries fail to deliver. If this is set to `true`, the automatic suspend and resume feature will occur. This would prevent new webhooks from attempting to deliver and to queue up until your healthCheckUrl returns 200 again, then all messages will be sent. If this is set to `false`, new individual messages will continue to retry and exhaust all failures, but the subscription will stay active.
* @type {string}
* @memberof Notificationsubscriptionsv1webhooksRetryPolicy
*/
deactivateFlag?: string;
/**
* The number of times to repeat the complete retry sequence. 0 => don't repeat the retry sequence 1 => repeat the retry sequence once (R1, R2, R3)+ (R1, R2, R3) 2 => repeat the retry sequence twice (R1, R2, R3) + (R1, R2, R3) + (R1, R2, R3)
* @type {number}
* @memberof Notificationsubscriptionsv1webhooksRetryPolicy
*/
repeatSequenceCount?: number;
/**
* The time to wait to before repeating the complete retry sequence. Amount of time to wait between each sequence. Sample calculation using repeatSequenceWaitTime=10 (R1, R2, R3) + (10) + (R1, R2, R3) + (10) + (R1, R2, R3)
* @type {number}
* @memberof Notificationsubscriptionsv1webhooksRetryPolicy
*/
repeatSequenceWaitTime?: number;
/**
* Additional data, if any.
* @type {Array<{ [key: string]: string; }>}
* @memberof Notificationsubscriptionsv1webhooksRetryPolicy
*/
additionalAttributes?: Array<{
[key: string]: string;
}>;
}