/** * API Endpoints * Deliver monetary rewards and incentives to employees, customers, survey participants, and more through the Tremendous API. For organizational tasks, like managing your organization and its members within Tremendous, please see the Tremendous Organizational API. * * The version of the OpenAPI document: 2 * Contact: developers@tremendous.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from './configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import globalAxios from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * Ignore flagging rules for rewards redeemed by an email or domain matching this list. * @export * @interface AllowEmail */ export interface AllowEmail { /** * The list of emails. * @type {Array} * @memberof AllowEmail */ 'emails': Array; } /** * The list of emails and domains where a matching redemption will ignore other flagging rules and automatically go through. * @export * @interface AllowEmail1 */ export interface AllowEmail1 { /** * The list of emails. * @type {Array} * @memberof AllowEmail1 */ 'emails': Array; } /** * Ignore flagging rules for rewards redeemed by an IP matching this list. * @export * @interface AllowIp */ export interface AllowIp { /** * The list of IP addresses to flag or allow. Accepts both IPv4 and IPv6 addresses using CIDR notation. * @type {Array} * @memberof AllowIp */ 'ips': Array; } /** * The list of IP addresses and/or IP ranges where a matching redemption will ignore other flagging rules and automatically go through. * @export * @interface AllowIp1 */ export interface AllowIp1 { /** * The list of IP addresses to flag or allow. Accepts both IPv4 and IPv6 addresses using CIDR notation. * @type {Array} * @memberof AllowIp1 */ 'ips': Array; } /** * A balance transaction represents a specific movement or change in an account\'s balance. * @export * @interface BalanceTransaction */ export interface BalanceTransaction { /** * Date that the transaction was created * @type {string} * @memberof BalanceTransaction */ 'created_at': string; /** * Amount of the transaction, denominated in `currency_code`. * @type {number} * @memberof BalanceTransaction */ 'amount': number; /** * Currency of the transaction amount and running balance. Always matches the organization\'s currency. * @type {string} * @memberof BalanceTransaction */ 'currency_code': string; /** * The updated total after the transaction, denominated in `currency_code`. Note that this running balance may be delayed and contain `null`. * @type {number} * @memberof BalanceTransaction */ 'balance': number; /** * The action that was performed * @type {string} * @memberof BalanceTransaction */ 'action': string; /** * A brief description of the transaction * @type {string} * @memberof BalanceTransaction */ 'description': string; /** * * @type {BalanceTransactionOrder} * @memberof BalanceTransaction */ 'order'?: BalanceTransactionOrder; } /** * Order details * @export * @interface BalanceTransactionOrder */ export interface BalanceTransactionOrder { /** * * @type {string} * @memberof BalanceTransactionOrder */ 'id'?: string; /** * Reference for this order, supplied by the customer. When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders. It also allows for retrieving by `external_id` instead of `id` only. * @type {string} * @memberof BalanceTransactionOrder */ 'external_id'?: string | null; /** * * @type {BalanceTransactionOrderPayment} * @memberof BalanceTransactionOrder */ 'payment'?: BalanceTransactionOrderPayment; } /** * * @export * @interface BalanceTransactionOrderPayment */ export interface BalanceTransactionOrderPayment { /** * Total price of the order before fees, denominated in `currency_code`. * @type {number} * @memberof BalanceTransactionOrderPayment */ 'subtotal': number; /** * Total price of the order including fees, denominated in `currency_code`. * @type {number} * @memberof BalanceTransactionOrderPayment */ 'total': number; /** * Fees for the order, denominated in `currency_code`. * @type {number} * @memberof BalanceTransactionOrderPayment */ 'fees': number; /** * Discount for the order, denominated in `currency_code`. * @type {number} * @memberof BalanceTransactionOrderPayment */ 'discount': number; /** * Currency in which the payment amounts (subtotal, total, fees, discount, refund) are denominated. This always matches the organization\'s currency. * @type {string} * @memberof BalanceTransactionOrderPayment */ 'currency_code': string; /** * * @type {PaymentDetailsRefund} * @memberof BalanceTransactionOrderPayment */ 'refund'?: PaymentDetailsRefund; } /** * * @export * @interface BaseOrderForCreate */ export interface BaseOrderForCreate { /** * Reference for this order, supplied by the customer. When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders. It also allows for retrieving by `external_id` instead of `id` only. * @type {string} * @memberof BaseOrderForCreate */ 'external_id'?: string | null; /** * * @type {SingleRewardOrderPayment} * @memberof BaseOrderForCreate */ 'payment': SingleRewardOrderPayment; } /** * With a campaign you can define the look & feel of how rewards are sent out. It also lets you set the available products (different gift cards, charity, etc.) recipients can choose from. * @export * @interface Campaign */ export interface Campaign { /** * * @type {string} * @memberof Campaign */ 'id'?: string; /** * Name of the campaign * @type {string} * @memberof Campaign */ 'name': string; /** * Description of the campaign * @type {string} * @memberof Campaign */ 'description': string | null; /** * List of IDs of products (different gift cards, charity, etc.) that are available in this campaign. * @type {Array} * @memberof Campaign */ 'products': Array; /** * Determines whether fees for premium products are added to the order total (`SENDER`) or deducted from the recipient\'s reward amount (`RECIPIENT`). Campaigns with `RECIPIENT` must include at least one fee-free product. * @type {string} * @memberof Campaign */ 'fee_charged_to'?: CampaignFeeChargedToEnum | null; /** * * @type {ListCampaigns200ResponseCampaignsInnerAutoAddProductRule} * @memberof Campaign */ 'auto_add_product_rule'?: ListCampaigns200ResponseCampaignsInnerAutoAddProductRule | null; /** * * @type {ListCampaigns200ResponseCampaignsInnerWebpageStyle} * @memberof Campaign */ 'webpage_style'?: ListCampaigns200ResponseCampaignsInnerWebpageStyle; /** * * @type {ListCampaigns200ResponseCampaignsInnerEmailStyle} * @memberof Campaign */ 'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle; } export declare const CampaignFeeChargedToEnum: { readonly Sender: "SENDER"; readonly Recipient: "RECIPIENT"; }; export type CampaignFeeChargedToEnum = typeof CampaignFeeChargedToEnum[keyof typeof CampaignFeeChargedToEnum]; /** * With a campaign you can define the look & feel of how rewards are sent out. It also lets you set the available products (different gift cards, charity, etc.) recipients can choose from. * @export * @interface CampaignBase */ export interface CampaignBase { /** * * @type {string} * @memberof CampaignBase */ 'id'?: string; /** * Name of the campaign * @type {string} * @memberof CampaignBase */ 'name'?: string; /** * Description of the campaign * @type {string} * @memberof CampaignBase */ 'description'?: string | null; /** * List of IDs of products (different gift cards, charity, etc.) that are available in this campaign. * @type {Array} * @memberof CampaignBase */ 'products'?: Array; /** * Determines whether fees for premium products are added to the order total (`SENDER`) or deducted from the recipient\'s reward amount (`RECIPIENT`). Campaigns with `RECIPIENT` must include at least one fee-free product. * @type {string} * @memberof CampaignBase */ 'fee_charged_to'?: CampaignBaseFeeChargedToEnum | null; /** * * @type {ListCampaigns200ResponseCampaignsInnerAutoAddProductRule} * @memberof CampaignBase */ 'auto_add_product_rule'?: ListCampaigns200ResponseCampaignsInnerAutoAddProductRule | null; /** * * @type {ListCampaigns200ResponseCampaignsInnerWebpageStyle} * @memberof CampaignBase */ 'webpage_style'?: ListCampaigns200ResponseCampaignsInnerWebpageStyle; /** * * @type {ListCampaigns200ResponseCampaignsInnerEmailStyle} * @memberof CampaignBase */ 'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle; } export declare const CampaignBaseFeeChargedToEnum: { readonly Sender: "SENDER"; readonly Recipient: "RECIPIENT"; }; export type CampaignBaseFeeChargedToEnum = typeof CampaignBaseFeeChargedToEnum[keyof typeof CampaignBaseFeeChargedToEnum]; /** * Name of the channel in which the order was created * @export * @enum {string} */ export declare const Channel: { readonly Ui: "UI"; readonly Api: "API"; readonly Embed: "EMBED"; readonly Decipher: "DECIPHER"; readonly Qualtrics: "QUALTRICS"; readonly Typeform: "TYPEFORM"; readonly SurveyMonkey: "SURVEY MONKEY"; readonly Yotpo: "YOTPO"; }; export type Channel = typeof Channel[keyof typeof Channel]; /** * * @export * @interface ConnectedOrganization */ export interface ConnectedOrganization { /** * Tremendous\' identifier for the connected organization. * @type {string} * @memberof ConnectedOrganization */ 'id': string; /** * Client ID of the OAuth app that is to be used by the platform once the integration is complete. * @type {string} * @memberof ConnectedOrganization */ 'client_id': string; /** * Timestamp of when the connected organization was created. * @type {string} * @memberof ConnectedOrganization */ 'created_at': string; /** * * @type {ConnectedOrganizationOrganization} * @memberof ConnectedOrganization */ 'organization'?: ConnectedOrganizationOrganization | null; /** * * @type {ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails} * @memberof ConnectedOrganization */ 'prefilled_kyb_details'?: ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails | null; } /** * * @export * @interface ConnectedOrganizationMember */ export interface ConnectedOrganizationMember { /** * Tremendous\' identifier for the connected organization member. * @type {string} * @memberof ConnectedOrganizationMember */ 'id': string; /** * The name associated with the user in your systems. * @type {string} * @memberof ConnectedOrganizationMember */ 'external_name'?: string | null; /** * The email associated with the user in your systems. * @type {string} * @memberof ConnectedOrganizationMember */ 'external_email'?: string | null; /** * Timestamp of when the connected organization member was created. * @type {string} * @memberof ConnectedOrganizationMember */ 'created_at': string; /** * Tremendous\' identifier for the connected organization. * @type {string} * @memberof ConnectedOrganizationMember */ 'connected_organization_id': string; /** * * @type {ConnectedOrganizationMemberMember} * @memberof ConnectedOrganizationMember */ 'member'?: ConnectedOrganizationMemberMember | null; } /** * Associated `member`. `null` until the registration flow for the connected organization has been completed. * @export * @interface ConnectedOrganizationMemberMember */ export interface ConnectedOrganizationMemberMember { /** * * @type {string} * @memberof ConnectedOrganizationMemberMember */ 'id': string; /** * Email address of the member * @type {string} * @memberof ConnectedOrganizationMemberMember */ 'email': string; /** * Full name of the member * @type {string} * @memberof ConnectedOrganizationMemberMember */ 'name': string | null; /** * Is this member currently active in the organization. If `false`, the member will not be able to access the organization. * @type {boolean} * @memberof ConnectedOrganizationMemberMember */ 'active'?: boolean; /** * The role ID associated with the member within the organization. * @type {string} * @memberof ConnectedOrganizationMemberMember */ 'role'?: string | null; /** * Current status of the member\'s account. When creating a member it starts out in the status `INVITED`. As soon as that member open the invitation link and registers an account, the status switches to `REGISTERED`. * @type {string} * @memberof ConnectedOrganizationMemberMember */ 'status': ConnectedOrganizationMemberMemberStatusEnum; /** * Timestamp when this member was created. The `created_at` timestamp is **NOT** returned when retrieving a member (but is part of the response when listing or creating members). * @type {string} * @memberof ConnectedOrganizationMemberMember */ 'created_at'?: string; /** * Timestamp when this member most recently logged into the dashboard of the organization associated with this API key. * @type {string} * @memberof ConnectedOrganizationMemberMember */ 'last_login_at'?: string | null; } export declare const ConnectedOrganizationMemberMemberStatusEnum: { readonly Registered: "REGISTERED"; readonly Invited: "INVITED"; }; export type ConnectedOrganizationMemberMemberStatusEnum = typeof ConnectedOrganizationMemberMemberStatusEnum[keyof typeof ConnectedOrganizationMemberMemberStatusEnum]; /** * * @export * @interface ConnectedOrganizationMemberSession */ export interface ConnectedOrganizationMemberSession { /** * Tremendous\' identifier for the connected organization member. * @type {string} * @memberof ConnectedOrganizationMemberSession */ 'connected_organization_member_id': string; /** * The URL to start the \"Tremendous for Platforms\" flow. * @type {string} * @memberof ConnectedOrganizationMemberSession */ 'url': string; /** * The URL used for links that redirect the user back to your site when they\'ve completed their actions on Tremendous. * @type {string} * @memberof ConnectedOrganizationMemberSession */ 'return_url': string; /** * Timestamp of when the session will expire. * @type {string} * @memberof ConnectedOrganizationMemberSession */ 'expires_at': string; /** * Timestamp of when the session was created. * @type {string} * @memberof ConnectedOrganizationMemberSession */ 'created_at': string; } /** * Associated `organization` resource. `null` until the registration flow for the connected organization has been completed. * @export * @interface ConnectedOrganizationOrganization */ export interface ConnectedOrganizationOrganization { /** * * @type {string} * @memberof ConnectedOrganizationOrganization */ 'id'?: string; /** * Name of the organization * @type {string} * @memberof ConnectedOrganizationOrganization */ 'name': string; /** * URL of the website of that organization * @type {string} * @memberof ConnectedOrganizationOrganization */ 'website': string; /** * Currency used for this organization\'s balances, orders, and transactions. * @type {string} * @memberof ConnectedOrganizationOrganization */ 'currency_code'?: string; /** * Status of the organization. Organizations need to be approved to be able to use them to send out rewards. * @type {string} * @memberof ConnectedOrganizationOrganization */ 'status'?: ConnectedOrganizationOrganizationStatusEnum; /** * Timestamp of when the organization has been created. *This field is only returned when creating an organization.* It is not returned anymore when retrieving or listing organizations. * @type {string} * @memberof ConnectedOrganizationOrganization */ 'created_at'?: string; } export declare const ConnectedOrganizationOrganizationStatusEnum: { readonly Pending: "PENDING"; readonly Approved: "APPROVED"; readonly Rejected: "REJECTED"; }; export type ConnectedOrganizationOrganizationStatusEnum = typeof ConnectedOrganizationOrganizationStatusEnum[keyof typeof ConnectedOrganizationOrganizationStatusEnum]; /** * * @export * @interface CreateApiKey200Response */ export interface CreateApiKey200Response { /** * The new API key * @type {string} * @memberof CreateApiKey200Response */ 'api_key'?: string; } /** * * @export * @interface CreateCampaign200Response */ export interface CreateCampaign200Response { /** * * @type {ListCampaigns200ResponseCampaignsInner} * @memberof CreateCampaign200Response */ 'campaign': ListCampaigns200ResponseCampaignsInner; } /** * With a campaign you can define the look & feel of how rewards are sent out. It also lets you set the available products (different gift cards, charity, etc.) recipients can choose from. * @export * @interface CreateCampaignRequest */ export interface CreateCampaignRequest { /** * Name of the campaign * @type {string} * @memberof CreateCampaignRequest */ 'name': string; /** * Description of the campaign * @type {string} * @memberof CreateCampaignRequest */ 'description': string | null; /** * List of IDs of products (different gift cards, charity, etc.) that are available in this campaign. * @type {Array} * @memberof CreateCampaignRequest */ 'products': Array; /** * Determines whether fees for premium products are added to the order total (`SENDER`) or deducted from the recipient\'s reward amount (`RECIPIENT`). Campaigns with `RECIPIENT` must include at least one fee-free product. * @type {string} * @memberof CreateCampaignRequest */ 'fee_charged_to'?: CreateCampaignRequestFeeChargedToEnum | null; /** * * @type {ListCampaigns200ResponseCampaignsInnerAutoAddProductRule} * @memberof CreateCampaignRequest */ 'auto_add_product_rule'?: ListCampaigns200ResponseCampaignsInnerAutoAddProductRule | null; /** * * @type {ListCampaigns200ResponseCampaignsInnerWebpageStyle} * @memberof CreateCampaignRequest */ 'webpage_style'?: ListCampaigns200ResponseCampaignsInnerWebpageStyle; /** * * @type {ListCampaigns200ResponseCampaignsInnerEmailStyle} * @memberof CreateCampaignRequest */ 'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle; } export declare const CreateCampaignRequestFeeChargedToEnum: { readonly Sender: "SENDER"; readonly Recipient: "RECIPIENT"; }; export type CreateCampaignRequestFeeChargedToEnum = typeof CreateCampaignRequestFeeChargedToEnum[keyof typeof CreateCampaignRequestFeeChargedToEnum]; /** * * @export * @interface CreateConnectedOrganization200Response */ export interface CreateConnectedOrganization200Response { /** * * @type {ListConnectedOrganizations200ResponseConnectedOrganizationsInner} * @memberof CreateConnectedOrganization200Response */ 'connected_organization': ListConnectedOrganizations200ResponseConnectedOrganizationsInner; } /** * * @export * @interface CreateConnectedOrganizationMember200Response */ export interface CreateConnectedOrganizationMember200Response { /** * * @type {ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInner} * @memberof CreateConnectedOrganizationMember200Response */ 'connected_organization_member': ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInner; } /** * * @export * @interface CreateConnectedOrganizationMemberRequest */ export interface CreateConnectedOrganizationMemberRequest { /** * The ID of the connected organization. * @type {string} * @memberof CreateConnectedOrganizationMemberRequest */ 'connected_organization_id': string; /** * The name associated with the user in your systems. * @type {string} * @memberof CreateConnectedOrganizationMemberRequest */ 'external_name'?: string; /** * The email associated with the user in your systems. * @type {string} * @memberof CreateConnectedOrganizationMemberRequest */ 'external_email'?: string; /** * The role ID to assign to the member within the organization. Only applicable when the connected organization is already linked to an existing Tremendous organization. * @type {string} * @memberof CreateConnectedOrganizationMemberRequest */ 'role'?: string; } /** * * @export * @interface CreateConnectedOrganizationMemberSession200Response */ export interface CreateConnectedOrganizationMemberSession200Response { /** * * @type {CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession} * @memberof CreateConnectedOrganizationMemberSession200Response */ 'connected_organization_member_session': CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession; } /** * * @export * @interface CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession */ export interface CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession { /** * Tremendous\' identifier for the connected organization member. * @type {string} * @memberof CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession */ 'connected_organization_member_id': string; /** * The URL to start the \"Tremendous for Platforms\" flow. * @type {string} * @memberof CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession */ 'url': string; /** * The URL used for links that redirect the user back to your site when they\'ve completed their actions on Tremendous. * @type {string} * @memberof CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession */ 'return_url': string; /** * Timestamp of when the session will expire. * @type {string} * @memberof CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession */ 'expires_at': string; /** * Timestamp of when the session was created. * @type {string} * @memberof CreateConnectedOrganizationMemberSession200ResponseConnectedOrganizationMemberSession */ 'created_at': string; } /** * * @export * @interface CreateConnectedOrganizationMemberSessionRequest */ export interface CreateConnectedOrganizationMemberSessionRequest { /** * The URL used for links that redirect the user back to your site when they\'ve completed their actions on Tremendous. * @type {string} * @memberof CreateConnectedOrganizationMemberSessionRequest */ 'return_url': string; } /** * * @export * @interface CreateConnectedOrganizationRequest */ export interface CreateConnectedOrganizationRequest { /** * The client ID of the OAuth application. * @type {string} * @memberof CreateConnectedOrganizationRequest */ 'client_id': string; /** * * @type {CreateConnectedOrganizationRequestKyb} * @memberof CreateConnectedOrganizationRequest */ 'kyb'?: CreateConnectedOrganizationRequestKyb; } /** * Optional KYB details to forward for the end client. When provided, these values pre-fill the end client\'s onboarding form and remain fully editable; the end client still reviews and submits. Every field is optional. * @export * @interface CreateConnectedOrganizationRequestKyb */ export interface CreateConnectedOrganizationRequestKyb { /** * The registered legal name of the company. * @type {string} * @memberof CreateConnectedOrganizationRequestKyb */ 'company_name'?: string; /** * The trade name (DBA) the company operates under, if different from its legal name. * @type {string} * @memberof CreateConnectedOrganizationRequestKyb */ 'doing_business_as'?: string; /** * The company\'s legal entity type. Free-form text — any value is accepted to support entity types outside the common presets. Common values are `Sole proprietorship`, `Corporation (Inc)`, `Limited liability company (LLC)`, `Limited liability partnership (LLP)`, `Public limited company (PLC)`, and `Private limited company (LTD)`. * @type {string} * @memberof CreateConnectedOrganizationRequestKyb */ 'company_structure'?: string; /** * The company\'s tax ID or registration number. * @type {string} * @memberof CreateConnectedOrganizationRequestKyb */ 'company_registration_number'?: string; /** * The ISO 3166-1 alpha-2 country code of the company. Must be a supported country. * @type {string} * @memberof CreateConnectedOrganizationRequestKyb */ 'country_code'?: string; /** * The company\'s website URL. Must be a well-formed URL. * @type {string} * @memberof CreateConnectedOrganizationRequestKyb */ 'website_url'?: string; /** * * @type {ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress} * @memberof CreateConnectedOrganizationRequestKyb */ 'address'?: ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress; } /** * * @export * @interface CreateField */ export interface CreateField { /** * A human-readable name for the field. Can contain letters, numbers, spaces, and underscores. The field\'s `label` (a reference name used in API requests) will be automatically derived from this value. * @type {string} * @memberof CreateField */ 'display_name': string; /** * Type of the values of the field
Type Description
Checkbox A boolean value (true/false)
Currency A monetary value
Date A date value
Dropdown A single selection from predefined options (see data.options)
Email An email address
List Multiple selections from predefined options (see data.options)
Number A numeric value
Phone A phone number
Text A single-line text value
TextArea A multi-line text value
* @type {string} * @memberof CreateField */ 'data_type': CreateFieldDataTypeEnum; /** * * @type {CreateFieldRequestData} * @memberof CreateField */ 'data'?: CreateFieldRequestData; /** * Is this field required (true) or optional (false). Defaults to false. * @type {boolean} * @memberof CreateField */ 'required'?: boolean; /** * A description of the field\'s purpose * @type {string} * @memberof CreateField */ 'description'?: string; } export declare const CreateFieldDataTypeEnum: { readonly Checkbox: "Checkbox"; readonly Currency: "Currency"; readonly Date: "Date"; readonly Dropdown: "Dropdown"; readonly Email: "Email"; readonly List: "List"; readonly Number: "Number"; readonly Phone: "Phone"; readonly Text: "Text"; readonly TextArea: "TextArea"; }; export type CreateFieldDataTypeEnum = typeof CreateFieldDataTypeEnum[keyof typeof CreateFieldDataTypeEnum]; /** * * @export * @interface CreateField200Response */ export interface CreateField200Response { /** * * @type {ListFields200ResponseFieldsInner} * @memberof CreateField200Response */ 'field': ListFields200ResponseFieldsInner; } /** * * @export * @interface CreateFieldRequest */ export interface CreateFieldRequest { /** * A human-readable name for the field. Can contain letters, numbers, spaces, and underscores. The field\'s `label` (a reference name used in API requests) will be automatically derived from this value. * @type {string} * @memberof CreateFieldRequest */ 'display_name': string; /** * Type of the values of the field
Type Description
Checkbox A boolean value (true/false)
Currency A monetary value
Date A date value
Dropdown A single selection from predefined options (see data.options)
Email An email address
List Multiple selections from predefined options (see data.options)
Number A numeric value
Phone A phone number
Text A single-line text value
TextArea A multi-line text value
* @type {string} * @memberof CreateFieldRequest */ 'data_type': CreateFieldRequestDataTypeEnum; /** * * @type {CreateFieldRequestData} * @memberof CreateFieldRequest */ 'data'?: CreateFieldRequestData; /** * Is this field required (true) or optional (false). Defaults to false. * @type {boolean} * @memberof CreateFieldRequest */ 'required'?: boolean; /** * A description of the field\'s purpose * @type {string} * @memberof CreateFieldRequest */ 'description'?: string; } export declare const CreateFieldRequestDataTypeEnum: { readonly Checkbox: "Checkbox"; readonly Currency: "Currency"; readonly Date: "Date"; readonly Dropdown: "Dropdown"; readonly Email: "Email"; readonly List: "List"; readonly Number: "Number"; readonly Phone: "Phone"; readonly Text: "Text"; readonly TextArea: "TextArea"; }; export type CreateFieldRequestDataTypeEnum = typeof CreateFieldRequestDataTypeEnum[keyof typeof CreateFieldRequestDataTypeEnum]; /** * Additional configuration for the field. Required for `Dropdown` and `List` data types. * @export * @interface CreateFieldRequestData */ export interface CreateFieldRequestData { /** * List of valid options for `Dropdown` and `List` field types. * @type {Array} * @memberof CreateFieldRequestData */ 'options'?: Array; } /** * * @export * @interface CreateInvoice200Response */ export interface CreateInvoice200Response { /** * * @type {ListInvoices200ResponseInvoicesInner} * @memberof CreateInvoice200Response */ 'invoice': ListInvoices200ResponseInvoicesInner; } /** * * @export * @interface CreateInvoiceRequest */ export interface CreateInvoiceRequest { /** * Reference to the purchase order number within your organization * @type {string} * @memberof CreateInvoiceRequest */ 'po_number'?: string | null; /** * Amount of the invoice * @type {number} * @memberof CreateInvoiceRequest */ 'amount': number; /** * Currency of the invoice. Defaults to the organization\'s currency if not provided. * @type {string} * @memberof CreateInvoiceRequest */ 'currency_code'?: CreateInvoiceRequestCurrencyCodeEnum; /** * Deprecated: Use `currency_code` instead. * @type {string} * @memberof CreateInvoiceRequest * @deprecated */ 'currency'?: CreateInvoiceRequestCurrencyEnum; /** * A note to be included in the invoice. This is for your internal use and will not be visible to the recipient. * @type {string} * @memberof CreateInvoiceRequest */ 'memo'?: string | null; } export declare const CreateInvoiceRequestCurrencyCodeEnum: { readonly Usd: "USD"; readonly Eur: "EUR"; readonly Gbp: "GBP"; }; export type CreateInvoiceRequestCurrencyCodeEnum = typeof CreateInvoiceRequestCurrencyCodeEnum[keyof typeof CreateInvoiceRequestCurrencyCodeEnum]; export declare const CreateInvoiceRequestCurrencyEnum: { readonly Usd: "USD"; readonly Eur: "EUR"; readonly Gbp: "GBP"; }; export type CreateInvoiceRequestCurrencyEnum = typeof CreateInvoiceRequestCurrencyEnum[keyof typeof CreateInvoiceRequestCurrencyEnum]; /** * * @export * @interface CreateMember */ export interface CreateMember { /** * Email address of the member * @type {string} * @memberof CreateMember */ 'email': string; /** * The role ID of the member within the organization. * @type {string} * @memberof CreateMember */ 'role': string; } /** * * @export * @interface CreateMember200Response */ export interface CreateMember200Response { /** * * @type {ListMembers200ResponseMembersInner} * @memberof CreateMember200Response */ 'member': ListMembers200ResponseMembersInner; } /** * * @export * @interface CreateMemberRequest */ export interface CreateMemberRequest { /** * Email address of the member * @type {string} * @memberof CreateMemberRequest */ 'email': string; /** * The role ID of the member within the organization. * @type {string} * @memberof CreateMemberRequest */ 'role': string; } /** * * @export * @interface CreateOrder200Response */ export interface CreateOrder200Response { /** * * @type {CreateOrder200ResponseOrder} * @memberof CreateOrder200Response */ 'order': CreateOrder200ResponseOrder; } /** * An order wraps around the fulfilment of one or more rewards. * @export * @interface CreateOrder200ResponseOrder */ export interface CreateOrder200ResponseOrder { /** * Tremendous ID of the order * @type {string} * @memberof CreateOrder200ResponseOrder */ 'id': string; /** * Reference for this order, supplied by the customer. When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders. It also allows for retrieving by `external_id` instead of `id` only. * @type {string} * @memberof CreateOrder200ResponseOrder */ 'external_id'?: string | null; /** * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from. * @type {string} * @memberof CreateOrder200ResponseOrder */ 'campaign_id'?: string | null; /** * Date the order was created * @type {string} * @memberof CreateOrder200ResponseOrder */ 'created_at': string; /** * Execution status of a given order
Status Description
CANCELED The order and all of its rewards were canceled.
OPEN The order has been created, but hasn\'t yet been processed.
EXECUTED The order has been executed. Payment has been handled and rewards are being delivered (if applicable).
FAILED The order could not be processed due to an error. E.g. due to insufficient funds in the account.
PENDING APPROVAL The order has been created but needs approval to be executed.
PENDING INTERNAL PAYMENT APPROVAL The order has been created but it is under review and requires approval from our team.
PENDING SETTLEMENT The order has been created but the funds are being held until the settlement window clears.
* @type {string} * @memberof CreateOrder200ResponseOrder */ 'status': CreateOrder200ResponseOrderStatusEnum; /** * Name of the channel in which the order was created * @type {string} * @memberof CreateOrder200ResponseOrder */ 'channel'?: CreateOrder200ResponseOrderChannelEnum; /** * * @type {ListOrders200ResponseOrdersInnerPayment} * @memberof CreateOrder200ResponseOrder */ 'payment'?: ListOrders200ResponseOrdersInnerPayment; /** * The ID for the invoice associated with this order * @type {string} * @memberof CreateOrder200ResponseOrder */ 'invoice_id'?: string; /** * * @type {Array} * @memberof CreateOrder200ResponseOrder */ 'rewards'?: Array; } export declare const CreateOrder200ResponseOrderStatusEnum: { readonly Canceled: "CANCELED"; readonly Open: "OPEN"; readonly Executed: "EXECUTED"; readonly Failed: "FAILED"; readonly PendingApproval: "PENDING APPROVAL"; readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL"; readonly PendingSettlement: "PENDING SETTLEMENT"; }; export type CreateOrder200ResponseOrderStatusEnum = typeof CreateOrder200ResponseOrderStatusEnum[keyof typeof CreateOrder200ResponseOrderStatusEnum]; export declare const CreateOrder200ResponseOrderChannelEnum: { readonly Ui: "UI"; readonly Api: "API"; readonly Embed: "EMBED"; readonly Decipher: "DECIPHER"; readonly Qualtrics: "QUALTRICS"; readonly Typeform: "TYPEFORM"; readonly SurveyMonkey: "SURVEY MONKEY"; readonly Yotpo: "YOTPO"; }; export type CreateOrder200ResponseOrderChannelEnum = typeof CreateOrder200ResponseOrderChannelEnum[keyof typeof CreateOrder200ResponseOrderChannelEnum]; /** * A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified. * @export * @interface CreateOrder200ResponseOrderRewardsInner */ export interface CreateOrder200ResponseOrderRewardsInner { /** * Tremendous ID of the reward * @type {string} * @memberof CreateOrder200ResponseOrderRewardsInner */ 'id'?: string; /** * Tremendous ID of the order this reward is part of. * @type {string} * @memberof CreateOrder200ResponseOrderRewardsInner */ 'order_id'?: string; /** * Date the reward was created * @type {string} * @memberof CreateOrder200ResponseOrderRewardsInner */ 'created_at'?: string; /** * Expiration date of the reward. If null, the reward does not expire. * @type {string} * @memberof CreateOrder200ResponseOrderRewardsInner */ 'expires_at'?: string | null; /** * * @type {ListRewards200ResponseRewardsInnerValue} * @memberof CreateOrder200ResponseOrderRewardsInner */ 'value'?: ListRewards200ResponseRewardsInnerValue; /** * * @type {ListRewards200ResponseRewardsInnerRecipient} * @memberof CreateOrder200ResponseOrderRewardsInner */ 'recipient'?: ListRewards200ResponseRewardsInnerRecipient; /** * Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored. * @type {string} * @memberof CreateOrder200ResponseOrderRewardsInner */ 'deliver_at'?: string; /** * * @type {Array} * @memberof CreateOrder200ResponseOrderRewardsInner */ 'custom_fields'?: Array; /** * * @type {CreateOrder200ResponseOrderRewardsInnerDelivery} * @memberof CreateOrder200ResponseOrderRewardsInner */ 'delivery'?: CreateOrder200ResponseOrderRewardsInnerDelivery; } /** * Details on how the reward is delivered to the recipient. * @export * @interface CreateOrder200ResponseOrderRewardsInnerDelivery */ export interface CreateOrder200ResponseOrderRewardsInnerDelivery { /** * How to deliver the reward to the recipient.
Delivery Method Description
EMAIL Deliver the reward to the recipient by email
LINK

Deliver the reward to the recipient via a link.

The initial POST /orders response for a link reward includes the link in delivery.link.

The link must then be delivered to the recipient out-of-band.

To obtain a new link for an existing reward, call POST /rewards/{id}/generate_link.

PHONE Deliver the reward to the recipient by SMS
* @type {string} * @memberof CreateOrder200ResponseOrderRewardsInnerDelivery */ 'method': CreateOrder200ResponseOrderRewardsInnerDeliveryMethodEnum; /** * Current status of the delivery of the reward: * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link active). * `PENDING` - Delivery is pending but not yet scheduled. * @type {string} * @memberof CreateOrder200ResponseOrderRewardsInnerDelivery */ 'status': CreateOrder200ResponseOrderRewardsInnerDeliveryStatusEnum; /** * Link to redeem the reward at. You need to deliver this link to the recipient. * @type {string} * @memberof CreateOrder200ResponseOrderRewardsInnerDelivery */ 'link'?: string; } export declare const CreateOrder200ResponseOrderRewardsInnerDeliveryMethodEnum: { readonly Email: "EMAIL"; readonly Link: "LINK"; readonly Phone: "PHONE"; }; export type CreateOrder200ResponseOrderRewardsInnerDeliveryMethodEnum = typeof CreateOrder200ResponseOrderRewardsInnerDeliveryMethodEnum[keyof typeof CreateOrder200ResponseOrderRewardsInnerDeliveryMethodEnum]; export declare const CreateOrder200ResponseOrderRewardsInnerDeliveryStatusEnum: { readonly Scheduled: "SCHEDULED"; readonly Failed: "FAILED"; readonly Succeeded: "SUCCEEDED"; readonly Pending: "PENDING"; }; export type CreateOrder200ResponseOrderRewardsInnerDeliveryStatusEnum = typeof CreateOrder200ResponseOrderRewardsInnerDeliveryStatusEnum[keyof typeof CreateOrder200ResponseOrderRewardsInnerDeliveryStatusEnum]; /** * @type CreateOrderRequest * @export */ export type CreateOrderRequest = SingleRewardOrder; /** * * @export * @interface CreateOrganization */ export interface CreateOrganization { /** * * @type {string} * @memberof CreateOrganization */ 'id'?: string; /** * Name of the organization * @type {string} * @memberof CreateOrganization */ 'name': string; /** * URL of the website of that organization * @type {string} * @memberof CreateOrganization */ 'website': string; /** * Default value is `false`. Set to true to also generate an API key associated to the new organization. * @type {boolean} * @memberof CreateOrganization */ 'with_api_key': boolean; /** * * @type {CreateOrganizationRequestCopySettings} * @memberof CreateOrganization */ 'copy_settings'?: CreateOrganizationRequestCopySettings; /** * Phone number of the organization. For non-US phone numbers, specify the country code (prefixed with +). * @type {string} * @memberof CreateOrganization */ 'phone'?: string; /** * Currency code for the new organization. Defaults to the current organization\'s currency if not provided. * @type {string} * @memberof CreateOrganization */ 'currency_code'?: string; /** * Timestamp of when the organization has been created. * @type {string} * @memberof CreateOrganization */ 'created_at'?: string; } /** * * @export * @interface CreateOrganization200Response */ export interface CreateOrganization200Response { /** * * @type {CreateOrganization200ResponseOrganization} * @memberof CreateOrganization200Response */ 'organization'?: CreateOrganization200ResponseOrganization; } /** * * @export * @interface CreateOrganization200ResponseOrganization */ export interface CreateOrganization200ResponseOrganization { /** * * @type {string} * @memberof CreateOrganization200ResponseOrganization */ 'id'?: string; /** * Name of the organization * @type {string} * @memberof CreateOrganization200ResponseOrganization */ 'name': string; /** * URL of the website of that organization * @type {string} * @memberof CreateOrganization200ResponseOrganization */ 'website': string; /** * * @type {CreateOrganizationRequestCopySettings} * @memberof CreateOrganization200ResponseOrganization */ 'copy_settings'?: CreateOrganizationRequestCopySettings; /** * Phone number of the organization. For non-US phone numbers, specify the country code (prefixed with +). * @type {string} * @memberof CreateOrganization200ResponseOrganization */ 'phone'?: string | null; /** * Currency code for the new organization. Defaults to the current organization\'s currency if not provided. * @type {string} * @memberof CreateOrganization200ResponseOrganization */ 'currency_code'?: string; /** * Timestamp of when the organization has been created. * @type {string} * @memberof CreateOrganization200ResponseOrganization */ 'created_at'?: string; /** * The API key for the created organization. This property is only returned when `api_key` is set to `true`. * @type {string} * @memberof CreateOrganization200ResponseOrganization */ 'api_key'?: string; } /** * * @export * @interface CreateOrganizationForResponse */ export interface CreateOrganizationForResponse { /** * * @type {string} * @memberof CreateOrganizationForResponse */ 'id'?: string; /** * Name of the organization * @type {string} * @memberof CreateOrganizationForResponse */ 'name': string; /** * URL of the website of that organization * @type {string} * @memberof CreateOrganizationForResponse */ 'website': string; /** * Default value is `false`. Set to true to also generate an API key associated to the new organization. * @type {boolean} * @memberof CreateOrganizationForResponse */ 'with_api_key'?: boolean; /** * * @type {CreateOrganizationRequestCopySettings} * @memberof CreateOrganizationForResponse */ 'copy_settings'?: CreateOrganizationRequestCopySettings; /** * Phone number of the organization. For non-US phone numbers, specify the country code (prefixed with +). * @type {string} * @memberof CreateOrganizationForResponse */ 'phone'?: string | null; /** * Currency code for the new organization. Defaults to the current organization\'s currency if not provided. * @type {string} * @memberof CreateOrganizationForResponse */ 'currency_code'?: string; /** * Timestamp of when the organization has been created. * @type {string} * @memberof CreateOrganizationForResponse */ 'created_at'?: string; } /** * * @export * @interface CreateOrganizationProperties */ export interface CreateOrganizationProperties { /** * * @type {string} * @memberof CreateOrganizationProperties */ 'id'?: string; /** * Name of the organization * @type {string} * @memberof CreateOrganizationProperties */ 'name'?: string; /** * URL of the website of that organization * @type {string} * @memberof CreateOrganizationProperties */ 'website'?: string; /** * Default value is `false`. Set to true to also generate an API key associated to the new organization. * @type {boolean} * @memberof CreateOrganizationProperties */ 'with_api_key'?: boolean; /** * * @type {CreateOrganizationRequestCopySettings} * @memberof CreateOrganizationProperties */ 'copy_settings'?: CreateOrganizationRequestCopySettings; /** * Phone number of the organization. For non-US phone numbers, specify the country code (prefixed with +). * @type {string} * @memberof CreateOrganizationProperties */ 'phone'?: string; /** * Currency code for the new organization. Defaults to the current organization\'s currency if not provided. * @type {string} * @memberof CreateOrganizationProperties */ 'currency_code'?: string; /** * Timestamp of when the organization has been created. * @type {string} * @memberof CreateOrganizationProperties */ 'created_at'?: string; } /** * * @export * @interface CreateOrganizationRequest */ export interface CreateOrganizationRequest { /** * Name of the organization * @type {string} * @memberof CreateOrganizationRequest */ 'name': string; /** * URL of the website of that organization * @type {string} * @memberof CreateOrganizationRequest */ 'website': string; /** * Default value is `false`. Set to true to also generate an API key associated to the new organization. * @type {boolean} * @memberof CreateOrganizationRequest */ 'with_api_key': boolean; /** * * @type {CreateOrganizationRequestCopySettings} * @memberof CreateOrganizationRequest */ 'copy_settings'?: CreateOrganizationRequestCopySettings; /** * Phone number of the organization. For non-US phone numbers, specify the country code (prefixed with +). * @type {string} * @memberof CreateOrganizationRequest */ 'phone'?: string; /** * Currency code for the new organization. Defaults to the current organization\'s currency if not provided. * @type {string} * @memberof CreateOrganizationRequest */ 'currency_code'?: string; } /** * A list of the settings that you wish to copy over to the new organization. * @export * @interface CreateOrganizationRequestCopySettings */ export interface CreateOrganizationRequestCopySettings { /** * Copy over the campaigns from the current organization to the new organization. Defaults to `false`. * @type {boolean} * @memberof CreateOrganizationRequestCopySettings */ 'campaigns'?: boolean; /** * Copy over the custom fields from the current organization to the new organization. Defaults to `false`. * @type {boolean} * @memberof CreateOrganizationRequestCopySettings */ 'custom_fields'?: boolean; /** * Copy over the order approvals settings from the current organization to the new organization. Defaults to `false`. * @type {boolean} * @memberof CreateOrganizationRequestCopySettings */ 'order_approvals'?: boolean; /** * Copy over the payment methods from the current organization to the new organization. Defaults to `false`. * @type {boolean} * @memberof CreateOrganizationRequestCopySettings */ 'payment_methods'?: boolean; /** * Copy over the security settings from the current organization to the new organization. Defaults to `true`. * @type {boolean} * @memberof CreateOrganizationRequestCopySettings */ 'security_settings'?: boolean; /** * Copy over the users and custom roles from the current organization to the new organization. Defaults to `false`. * @type {boolean} * @memberof CreateOrganizationRequestCopySettings */ 'users'?: boolean; /** * Copy over the custom roles from the current organization to the new organization. Custom roles are always copied if `users` is `true`. Defaults to `false`. * @type {boolean} * @memberof CreateOrganizationRequestCopySettings */ 'custom_roles'?: boolean; /** * Copy over the fraud prevention settings and rules from the current organization to the new organization. Defaults to `false`. * @type {boolean} * @memberof CreateOrganizationRequestCopySettings */ 'fraud_prevention'?: boolean; /** * Copy over the tax management settings, including the association with the parent tax entity, from the current organization to the new organization. Defaults to `false`. * @type {boolean} * @memberof CreateOrganizationRequestCopySettings */ 'tax_management'?: boolean; } /** * * @export * @interface CreateReport200Response */ export interface CreateReport200Response { /** * * @type {CreateReport200ResponseReport} * @memberof CreateReport200Response */ 'report': CreateReport200ResponseReport; /** * Report status message * @type {string} * @memberof CreateReport200Response */ 'message'?: string; } /** * Reports represent a collection of your Tremendous data that can be filtered and downloaded. The report object that is returned has a unique ID, a status, and an predicted time of report generation completion. When the report generation is complete, it will also contain an expiring url where you can retrieve your report. * @export * @interface CreateReport200ResponseReport */ export interface CreateReport200ResponseReport { /** * Tremendous ID of the report, used to retrieve your report * @type {string} * @memberof CreateReport200ResponseReport */ 'id'?: string; /** * Status of this report
Status Description
CREATED Report has been created
PROCESSING Report is currently being generated
READY_FOR_DOWNLOAD Report generation is complete and ready for download
FAILED Report failed to generate
* @type {string} * @memberof CreateReport200ResponseReport */ 'status'?: CreateReport200ResponseReportStatusEnum; /** * Timestamp of when the report was created * @type {string} * @memberof CreateReport200ResponseReport */ 'created_at'?: string; /** * Timestamp of when the report is expected to finish generating. If the report is complete, this will return the time the report completed generating at. * @type {string} * @memberof CreateReport200ResponseReport */ 'expected_completion_at'?: string; /** * URL to download the report. Only returned when the report generation is complete and report is ready for download. URL is valid for 7 days from generation completion * @type {string} * @memberof CreateReport200ResponseReport */ 'url'?: string | null; } export declare const CreateReport200ResponseReportStatusEnum: { readonly Created: "CREATED"; readonly Processing: "PROCESSING"; readonly ReadyForDownload: "READY_FOR_DOWNLOAD"; readonly Failed: "FAILED"; }; export type CreateReport200ResponseReportStatusEnum = typeof CreateReport200ResponseReportStatusEnum[keyof typeof CreateReport200ResponseReportStatusEnum]; /** * * @export * @interface CreateReportRequest */ export interface CreateReportRequest { /** * Type of report for retrieval.
Report type Description
digital_rewards Report for Tremendous digital reward history
* @type {string} * @memberof CreateReportRequest */ 'report_type': CreateReportRequestReportTypeEnum; /** * Format the report will be generated in.
Format Description
csv CSV format for report
* @type {string} * @memberof CreateReportRequest */ 'format': CreateReportRequestFormatEnum; /** * * @type {CreateReportRequestFilters} * @memberof CreateReportRequest */ 'filters'?: CreateReportRequestFilters | null; } export declare const CreateReportRequestReportTypeEnum: { readonly DigitalRewards: "digital_rewards"; }; export type CreateReportRequestReportTypeEnum = typeof CreateReportRequestReportTypeEnum[keyof typeof CreateReportRequestReportTypeEnum]; export declare const CreateReportRequestFormatEnum: { readonly Csv: "csv"; }; export type CreateReportRequestFormatEnum = typeof CreateReportRequestFormatEnum[keyof typeof CreateReportRequestFormatEnum]; /** * Filters to apply to the report. Corresponds to the filters provided in the dashboard * @export * @interface CreateReportRequestFilters */ export interface CreateReportRequestFilters { /** * * @type {CreateReportRequestFiltersDigitalRewards} * @memberof CreateReportRequestFilters */ 'digital_rewards'?: CreateReportRequestFiltersDigitalRewards | null; } /** * Filters object for a `report_type: digital_rewards` report * @export * @interface CreateReportRequestFiltersDigitalRewards */ export interface CreateReportRequestFiltersDigitalRewards { /** * * @type {CreateReportRequestFiltersDigitalRewardsAmount} * @memberof CreateReportRequestFiltersDigitalRewards */ 'amount'?: CreateReportRequestFiltersDigitalRewardsAmount | null; /** * ID of the Tremendous campaign that this report should be limited to * @type {string} * @memberof CreateReportRequestFiltersDigitalRewards */ 'campaign_id'?: string | null; /** * * @type {CreateReportRequestFiltersDigitalRewardsCreatedAt} * @memberof CreateReportRequestFiltersDigitalRewards */ 'created_at'?: CreateReportRequestFiltersDigitalRewardsCreatedAt | null; /** * Delivery date for gifts that should be returned in the report * @type {string} * @memberof CreateReportRequestFiltersDigitalRewards */ 'delivered_at'?: string | null; /** * Delivery method for rewards returned in the report * @type {string} * @memberof CreateReportRequestFiltersDigitalRewards */ 'delivery_method'?: CreateReportRequestFiltersDigitalRewardsDeliveryMethodEnum | null; /** * ID of the Tremendous order that this report should be limited to * @type {string} * @memberof CreateReportRequestFiltersDigitalRewards */ 'order_id'?: string | null; /** * Order status for rewards returned in the report * @type {string} * @memberof CreateReportRequestFiltersDigitalRewards */ 'order_status'?: CreateReportRequestFiltersDigitalRewardsOrderStatusEnum | null; /** * Status for rewards returned in the report * @type {Array} * @memberof CreateReportRequestFiltersDigitalRewards */ 'status'?: Array | null; } export declare const CreateReportRequestFiltersDigitalRewardsDeliveryMethodEnum: { readonly Phone: "phone"; readonly Email: "email"; readonly Link: "link"; readonly Mail: "mail"; readonly Direct: "direct"; }; export type CreateReportRequestFiltersDigitalRewardsDeliveryMethodEnum = typeof CreateReportRequestFiltersDigitalRewardsDeliveryMethodEnum[keyof typeof CreateReportRequestFiltersDigitalRewardsDeliveryMethodEnum]; export declare const CreateReportRequestFiltersDigitalRewardsOrderStatusEnum: { readonly Executed: "executed"; readonly Canceled: "canceled"; readonly Failed: "failed"; readonly PendingApproval: "pending_approval"; }; export type CreateReportRequestFiltersDigitalRewardsOrderStatusEnum = typeof CreateReportRequestFiltersDigitalRewardsOrderStatusEnum[keyof typeof CreateReportRequestFiltersDigitalRewardsOrderStatusEnum]; export declare const CreateReportRequestFiltersDigitalRewardsStatusEnum: { readonly Delivered: "delivered"; readonly Canceled: "canceled"; readonly DeliveryFailed: "delivery_failed"; readonly PendingReview: "pending_review"; }; export type CreateReportRequestFiltersDigitalRewardsStatusEnum = typeof CreateReportRequestFiltersDigitalRewardsStatusEnum[keyof typeof CreateReportRequestFiltersDigitalRewardsStatusEnum]; /** * Amount of the rewards returned in the report * @export * @interface CreateReportRequestFiltersDigitalRewardsAmount */ export interface CreateReportRequestFiltersDigitalRewardsAmount { /** * Minimum amount of the rewards that should be returned in the report * @type {number} * @memberof CreateReportRequestFiltersDigitalRewardsAmount */ 'gte'?: number; /** * Maximum amount of the rewards that should be returned in the report * @type {number} * @memberof CreateReportRequestFiltersDigitalRewardsAmount */ 'lte'?: number; } /** * Creation dates of rewards returned in the report * @export * @interface CreateReportRequestFiltersDigitalRewardsCreatedAt */ export interface CreateReportRequestFiltersDigitalRewardsCreatedAt { /** * Minimum date the reward was created * @type {string} * @memberof CreateReportRequestFiltersDigitalRewardsCreatedAt */ 'gte'?: string; /** * Maximum date the reward was created * @type {string} * @memberof CreateReportRequestFiltersDigitalRewardsCreatedAt */ 'lte'?: string; } /** * * @export * @interface CreateTopup200Response */ export interface CreateTopup200Response { /** * * @type {ListTopups200ResponseTopupsInner} * @memberof CreateTopup200Response */ 'topup'?: ListTopups200ResponseTopupsInner; } /** * * @export * @interface CreateTopupRequest */ export interface CreateTopupRequest { /** * The ID of the funding source to top up. * @type {string} * @memberof CreateTopupRequest */ 'funding_source_id': string; /** * Unique key that ensures this request is only processed once. * @type {string} * @memberof CreateTopupRequest */ 'idempotency_key': string; /** * Amount to add to your organization\'s balance, denominated in `currency_code`. * @type {number} * @memberof CreateTopupRequest */ 'amount': number; } /** * * @export * @interface CreateWebhook200Response */ export interface CreateWebhook200Response { /** * * @type {ListWebhooks200ResponseWebhooksInner} * @memberof CreateWebhook200Response */ 'webhook'?: ListWebhooks200ResponseWebhooksInner; } /** * * @export * @interface CreateWebhookRequest */ export interface CreateWebhookRequest { /** * URL the webhook will make requests to * @type {string} * @memberof CreateWebhookRequest */ 'url': string; } /** * * @export * @enum {string} */ export declare const CurrencyCodes: { readonly Usd: "USD"; readonly Cad: "CAD"; readonly Eur: "EUR"; readonly Aed: "AED"; readonly Afn: "AFN"; readonly All: "ALL"; readonly Amd: "AMD"; readonly Ars: "ARS"; readonly Aud: "AUD"; readonly Azn: "AZN"; readonly Bam: "BAM"; readonly Bdt: "BDT"; readonly Bhd: "BHD"; readonly Bif: "BIF"; readonly Bnd: "BND"; readonly Bob: "BOB"; readonly Brl: "BRL"; readonly Bwp: "BWP"; readonly Byn: "BYN"; readonly Bzd: "BZD"; readonly Cdf: "CDF"; readonly Chf: "CHF"; readonly Clp: "CLP"; readonly Cny: "CNY"; readonly Cop: "COP"; readonly Crc: "CRC"; readonly Cve: "CVE"; readonly Czk: "CZK"; readonly Djf: "DJF"; readonly Dkk: "DKK"; readonly Dop: "DOP"; readonly Dzd: "DZD"; readonly Egp: "EGP"; readonly Ern: "ERN"; readonly Etb: "ETB"; readonly Gbp: "GBP"; readonly Gel: "GEL"; readonly Ghs: "GHS"; readonly Gnf: "GNF"; readonly Gtq: "GTQ"; readonly Hkd: "HKD"; readonly Hnl: "HNL"; readonly Hrk: "HRK"; readonly Huf: "HUF"; readonly Idr: "IDR"; readonly Ils: "ILS"; readonly Inr: "INR"; readonly Iqd: "IQD"; readonly Irr: "IRR"; readonly Isk: "ISK"; readonly Jmd: "JMD"; readonly Jod: "JOD"; readonly Jpy: "JPY"; readonly Kes: "KES"; readonly Khr: "KHR"; readonly Krw: "KRW"; readonly Kwd: "KWD"; readonly Kzt: "KZT"; readonly Lbp: "LBP"; readonly Lkr: "LKR"; readonly Mad: "MAD"; readonly Mdl: "MDL"; readonly Mga: "MGA"; readonly Mkd: "MKD"; readonly Mmk: "MMK"; readonly Mop: "MOP"; readonly Mur: "MUR"; readonly Mxn: "MXN"; readonly Myr: "MYR"; readonly Mzn: "MZN"; readonly Nad: "NAD"; readonly Ngn: "NGN"; readonly Nio: "NIO"; readonly Nok: "NOK"; readonly Npr: "NPR"; readonly Nzd: "NZD"; readonly Omr: "OMR"; readonly Pab: "PAB"; readonly Pen: "PEN"; readonly Php: "PHP"; readonly Pkr: "PKR"; readonly Pln: "PLN"; readonly Pyg: "PYG"; readonly Qar: "QAR"; readonly Ron: "RON"; readonly Rsd: "RSD"; readonly Rub: "RUB"; readonly Rwf: "RWF"; readonly Sar: "SAR"; readonly Sdg: "SDG"; readonly Sek: "SEK"; readonly Sgd: "SGD"; readonly Sos: "SOS"; readonly Syp: "SYP"; readonly Thb: "THB"; readonly Tnd: "TND"; readonly Top: "TOP"; readonly Try: "TRY"; readonly Ttd: "TTD"; readonly Twd: "TWD"; readonly Tzs: "TZS"; readonly Uah: "UAH"; readonly Ugx: "UGX"; readonly Uyu: "UYU"; readonly Uzs: "UZS"; readonly Vef: "VEF"; readonly Vnd: "VND"; readonly Xaf: "XAF"; readonly Xof: "XOF"; readonly Yer: "YER"; readonly Zar: "ZAR"; }; export type CurrencyCodes = typeof CurrencyCodes[keyof typeof CurrencyCodes]; /** * Reward custom data for searching, tracking or copy (see [Adding custom fields to orders](https://developers.tremendous.com/docs/using-custom-fields-to-add-custom-data-to-rewards).) * @export * @interface CustomField */ export interface CustomField { /** * Tremendous ID of the custom field * @type {string} * @memberof CustomField */ 'id'?: string; /** * Value of the custom field * @type {string} * @memberof CustomField */ 'value'?: string | null; /** * Label of the custom field * @type {string} * @memberof CustomField */ 'label'?: string; } /** * * @export * @interface DeleteFraudRule200Response */ export interface DeleteFraudRule200Response { /** * A description of the result * @type {string} * @memberof DeleteFraudRule200Response */ 'message': string; } /** * Details on how the reward is delivered to the recipient. * @export * @interface DeliveryDetails */ export interface DeliveryDetails { /** * How to deliver the reward to the recipient.
Delivery Method Description
EMAIL Deliver the reward to the recipient by email
LINK

Deliver the reward to the recipient via a link.

The initial POST /orders response for a link reward includes the link in delivery.link.

The link must then be delivered to the recipient out-of-band.

To obtain a new link for an existing reward, call POST /rewards/{id}/generate_link.

PHONE Deliver the reward to the recipient by SMS
* @type {string} * @memberof DeliveryDetails */ 'method'?: DeliveryDetailsMethodEnum; /** * Current status of the delivery of the reward: * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link active). * `PENDING` - Delivery is pending but not yet scheduled. * @type {string} * @memberof DeliveryDetails */ 'status'?: DeliveryDetailsStatusEnum; } export declare const DeliveryDetailsMethodEnum: { readonly Email: "EMAIL"; readonly Link: "LINK"; readonly Phone: "PHONE"; }; export type DeliveryDetailsMethodEnum = typeof DeliveryDetailsMethodEnum[keyof typeof DeliveryDetailsMethodEnum]; export declare const DeliveryDetailsStatusEnum: { readonly Scheduled: "SCHEDULED"; readonly Failed: "FAILED"; readonly Succeeded: "SUCCEEDED"; readonly Pending: "PENDING"; }; export type DeliveryDetailsStatusEnum = typeof DeliveryDetailsStatusEnum[keyof typeof DeliveryDetailsStatusEnum]; /** * Details on how the reward is delivered to the recipient. * @export * @interface DeliveryDetailsWithLink */ export interface DeliveryDetailsWithLink { /** * How to deliver the reward to the recipient.
Delivery Method Description
EMAIL Deliver the reward to the recipient by email
LINK

Deliver the reward to the recipient via a link.

The initial POST /orders response for a link reward includes the link in delivery.link.

The link must then be delivered to the recipient out-of-band.

To obtain a new link for an existing reward, call POST /rewards/{id}/generate_link.

PHONE Deliver the reward to the recipient by SMS
* @type {string} * @memberof DeliveryDetailsWithLink */ 'method': DeliveryDetailsWithLinkMethodEnum; /** * Current status of the delivery of the reward: * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link active). * `PENDING` - Delivery is pending but not yet scheduled. * @type {string} * @memberof DeliveryDetailsWithLink */ 'status': DeliveryDetailsWithLinkStatusEnum; /** * Link to redeem the reward at. You need to deliver this link to the recipient. * @type {string} * @memberof DeliveryDetailsWithLink */ 'link'?: string; } export declare const DeliveryDetailsWithLinkMethodEnum: { readonly Email: "EMAIL"; readonly Link: "LINK"; readonly Phone: "PHONE"; }; export type DeliveryDetailsWithLinkMethodEnum = typeof DeliveryDetailsWithLinkMethodEnum[keyof typeof DeliveryDetailsWithLinkMethodEnum]; export declare const DeliveryDetailsWithLinkStatusEnum: { readonly Scheduled: "SCHEDULED"; readonly Failed: "FAILED"; readonly Succeeded: "SUCCEEDED"; readonly Pending: "PENDING"; }; export type DeliveryDetailsWithLinkStatusEnum = typeof DeliveryDetailsWithLinkStatusEnum[keyof typeof DeliveryDetailsWithLinkStatusEnum]; /** * Customizable reward delivery metadata, taking precedence over the related campaign settings. * @export * @interface DeliveryMetadata */ export interface DeliveryMetadata { /** * The \"sender name\" used in the delivery. If it\'s an email reward, \"via Tremendous\" will be appended to the value. Please note that you cannot customize the sender email. * @type {string} * @memberof DeliveryMetadata */ 'sender_name'?: string; /** * The subject line used in the delivery. * @type {string} * @memberof DeliveryMetadata */ 'subject_line'?: string; /** * The content of the message of the reward, shown in the email / SMS and on the landing page. * @type {string} * @memberof DeliveryMetadata */ 'message'?: string; } /** * How to deliver the reward to the recipient.
Delivery Method Description
EMAIL Deliver the reward to the recipient by email
LINK

Deliver the reward to the recipient via a link.

The initial POST /orders response for a link reward includes the link in delivery.link.

The link must then be delivered to the recipient out-of-band.

To obtain a new link for an existing reward, call POST /rewards/{id}/generate_link.

PHONE Deliver the reward to the recipient by SMS
* @export * @enum {string} */ export declare const DeliveryMethod: { readonly Email: "EMAIL"; readonly Link: "LINK"; readonly Phone: "PHONE"; }; export type DeliveryMethod = typeof DeliveryMethod[keyof typeof DeliveryMethod]; /** * Current status of the delivery of the reward: * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link active). * `PENDING` - Delivery is pending but not yet scheduled. * @export * @enum {string} */ export declare const DeliveryStatus: { readonly Scheduled: "SCHEDULED"; readonly Failed: "FAILED"; readonly Succeeded: "SUCCEEDED"; readonly Pending: "PENDING"; }; export type DeliveryStatus = typeof DeliveryStatus[keyof typeof DeliveryStatus]; /** * * @export * @interface ErrorModel */ export interface ErrorModel { /** * HTTP status code of the response * @type {number} * @memberof ErrorModel */ 'status'?: number; /** * * @type {ListRewards401ResponseErrors} * @memberof ErrorModel */ 'errors': ListRewards401ResponseErrors; } /** * * @export * @interface Field */ export interface Field { /** * * @type {string} * @memberof Field */ 'id'?: string; /** * Label of the field * @type {string} * @memberof Field */ 'label'?: string; /** * Type of the values of the field
Type Description
Checkbox A boolean value (true/false)
Currency A monetary value
Date A date value
Dropdown A single selection from predefined options (see data.options)
Email An email address
List Multiple selections from predefined options (see data.options)
Number A numeric value
Phone A phone number
Text A single-line text value
TextArea A multi-line text value
* @type {string} * @memberof Field */ 'data_type'?: FieldDataTypeEnum; /** * * @type {ListFields200ResponseFieldsInnerData} * @memberof Field */ 'data'?: ListFields200ResponseFieldsInnerData; /** * Is this field required (true) or optional (false) * @type {boolean} * @memberof Field */ 'required'?: boolean; /** * Type of objects this field gets associated with * @type {string} * @memberof Field */ 'scope'?: string; } export declare const FieldDataTypeEnum: { readonly Checkbox: "Checkbox"; readonly Currency: "Currency"; readonly Date: "Date"; readonly Dropdown: "Dropdown"; readonly Email: "Email"; readonly List: "List"; readonly Number: "Number"; readonly Phone: "Phone"; readonly Text: "Text"; readonly TextArea: "TextArea"; }; export type FieldDataTypeEnum = typeof FieldDataTypeEnum[keyof typeof FieldDataTypeEnum]; /** * * @export * @interface FraudConfigAllowEmail */ export interface FraudConfigAllowEmail { /** * The list of emails. * @type {Array} * @memberof FraudConfigAllowEmail */ 'emails': Array; } /** * * @export * @interface FraudConfigCountry */ export interface FraudConfigCountry { /** * When type is `whitelist`, it flags any countries that *are not* present in the list. When type is `blacklist`, it flags any countries that *are* present in the list. * @type {string} * @memberof FraudConfigCountry */ 'type': FraudConfigCountryTypeEnum; /** * An array of country codes (ISO-3166 alpha-2 character code) * @type {Array} * @memberof FraudConfigCountry */ 'countries': Array; } export declare const FraudConfigCountryTypeEnum: { readonly Whitelist: "whitelist"; readonly Blacklist: "blacklist"; }; export type FraudConfigCountryTypeEnum = typeof FraudConfigCountryTypeEnum[keyof typeof FraudConfigCountryTypeEnum]; /** * * @export * @interface FraudConfigCountryUpdateList */ export interface FraudConfigCountryUpdateList { /** * An array of country codes (ISO-3166 alpha-2 character code) * @type {Array} * @memberof FraudConfigCountryUpdateList */ 'countries': Array; } /** * * @export * @interface FraudConfigIP */ export interface FraudConfigIP { /** * The list of IP addresses to flag or allow. Accepts both IPv4 and IPv6 addresses using CIDR notation. * @type {Array} * @memberof FraudConfigIP */ 'ips': Array; } /** * * @export * @interface FraudConfigRedeemedRewardsAmount */ export interface FraudConfigRedeemedRewardsAmount { /** * The total amount of redeemed rewards to use as a threshold. The amount is denominated in the organization\'s currency. * @type {number} * @memberof FraudConfigRedeemedRewardsAmount */ 'amount': number; /** * The period, in days, to consider for the count. Use `all_time` to consider any redeemed rewards. * @type {string} * @memberof FraudConfigRedeemedRewardsAmount */ 'period': FraudConfigRedeemedRewardsAmountPeriodEnum; } export declare const FraudConfigRedeemedRewardsAmountPeriodEnum: { readonly _7: "7"; readonly _30: "30"; readonly _90: "90"; readonly _120: "120"; readonly _365: "365"; readonly AllTime: "all_time"; }; export type FraudConfigRedeemedRewardsAmountPeriodEnum = typeof FraudConfigRedeemedRewardsAmountPeriodEnum[keyof typeof FraudConfigRedeemedRewardsAmountPeriodEnum]; /** * * @export * @interface FraudConfigRedeemedRewardsCount */ export interface FraudConfigRedeemedRewardsCount { /** * The number of redeemed rewards to use as a threshold. * @type {number} * @memberof FraudConfigRedeemedRewardsCount */ 'amount': number; /** * The period, in days, to consider for the count. Use `all_time` to consider any redeemed rewards. * @type {string} * @memberof FraudConfigRedeemedRewardsCount */ 'period': FraudConfigRedeemedRewardsCountPeriodEnum; } export declare const FraudConfigRedeemedRewardsCountPeriodEnum: { readonly _7: "7"; readonly _30: "30"; readonly _90: "90"; readonly _120: "120"; readonly _365: "365"; readonly AllTime: "all_time"; }; export type FraudConfigRedeemedRewardsCountPeriodEnum = typeof FraudConfigRedeemedRewardsCountPeriodEnum[keyof typeof FraudConfigRedeemedRewardsCountPeriodEnum]; /** * * @export * @interface FraudConfigReviewEmail */ export interface FraudConfigReviewEmail { /** * The list of emails. * @type {Array} * @memberof FraudConfigReviewEmail */ 'emails'?: Array; /** * The list of domains. Any subdomains will also be matched against each entry in the list. * @type {Array} * @memberof FraudConfigReviewEmail */ 'domains'?: Array; } /** * * @export * @interface FraudConfigReviewVpn */ export interface FraudConfigReviewVpn { /** * Whether Apple Private Relay traffic should be excluded from VPN fraud review. When omitted or false, Apple Private Relay traffic is flagged with other VPN and proxy traffic. * @type {boolean} * @memberof FraudConfigReviewVpn */ 'skip_apple_private_relay'?: boolean; } /** * * @export * @interface FraudGenericResponse */ export interface FraudGenericResponse { /** * A description of the result * @type {string} * @memberof FraudGenericResponse */ 'message': string; } /** * The fraud review associated with a reward. * @export * @interface FraudReview */ export interface FraudReview { /** * The current status of the fraud review: * `flagged` - The reward has been flagged for and waiting manual review. * `blocked` - The reward was reviewed and blocked. * `released` - The reward was reviewed and released. * @type {string} * @memberof FraudReview */ 'status'?: FraudReviewStatusEnum; /** * The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Apple Private Relay` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country` * @type {Array} * @memberof FraudReview */ 'reasons'?: Array; /** * The device fingerprint, if known. * @type {string} * @memberof FraudReview */ 'device_id'?: string; /** * The product selected to claim the reward * @type {string} * @memberof FraudReview */ 'redemption_method'?: FraudReviewRedemptionMethodEnum; /** * Date the reward was redeemed * @type {string} * @memberof FraudReview */ 'redeemed_at'?: string; /** * * @type {ListFraudReviews200ResponseFraudReviewsInnerGeo} * @memberof FraudReview */ 'geo'?: ListFraudReviews200ResponseFraudReviewsInnerGeo; /** * * @type {OrderWithoutLinkRewardsInner} * @memberof FraudReview */ 'reward'?: OrderWithoutLinkRewardsInner; /** * The name of the person who reviewed the reward, or `Automatic Review` if the reward was blocked automatically. Rewards can be automatically blocked if they remain in the flagged fraud queue for more than 30 days. This field is only present if the status is not `flagged`. * @type {string} * @memberof FraudReview */ 'reviewed_by'?: string; /** * When the reward was blocked or released following fraud review. This field is only present if the status is not `flagged`. * @type {string} * @memberof FraudReview */ 'reviewed_at'?: string; /** * A hash of the destination account for redemption methods that require providing 3rd party account details (e.g., PayPal, Venmo, ACH/CashApp, international bank transfers, etc.). The hash is globally unique by redemption method + account combination. This field is omitted for redemption methods that don\'t have a destination account (e.g., merchant cards, charities, etc.). * @type {string} * @memberof FraudReview */ 'redemption_method_account_hash'?: string; /** * The fraud risk associated with the reward. * @type {string} * @memberof FraudReview */ 'risk'?: FraudReviewRiskEnum; /** * * @type {FraudReviewRelatedRewards} * @memberof FraudReview */ 'related_rewards'?: FraudReviewRelatedRewards; } export declare const FraudReviewStatusEnum: { readonly Flagged: "flagged"; readonly Blocked: "blocked"; readonly Released: "released"; }; export type FraudReviewStatusEnum = typeof FraudReviewStatusEnum[keyof typeof FraudReviewStatusEnum]; export declare const FraudReviewReasonsEnum: { readonly DisallowedIp: "Disallowed IP"; readonly DisallowedEmail: "Disallowed email"; readonly DisallowedCountry: "Disallowed country"; readonly OverRewardAmountLimit: "Over reward amount limit"; readonly OverRewardCountLimit: "Over reward count limit"; readonly VpnDetected: "VPN detected"; readonly ApplePrivateRelay: "Apple Private Relay"; readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails"; readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails"; readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list"; readonly BankAccountOnATremendousFraudList: "Bank account on a Tremendous fraud list"; readonly FingerprintOnATremendousFraudList: "Fingerprint on a Tremendous fraud list"; readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list"; readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list"; readonly DeviceOnATremendousFraudList: "Device on a Tremendous fraud list"; readonly IpRelatedToABlockedReward: "IP related to a blocked reward"; readonly DeviceRelatedToABlockedReward: "Device related to a blocked reward"; readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward"; readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward"; readonly EmailRelatedToABlockedReward: "Email related to a blocked reward"; readonly PhoneRelatedToABlockedReward: "Phone related to a blocked reward"; readonly AllowedIp: "Allowed IP"; readonly AllowedEmail: "Allowed email"; readonly AllowedCountry: "Allowed country"; }; export type FraudReviewReasonsEnum = typeof FraudReviewReasonsEnum[keyof typeof FraudReviewReasonsEnum]; export declare const FraudReviewRedemptionMethodEnum: { readonly BankTransfer: "bank transfer"; readonly Charity: "charity"; readonly InstantDebitTransfer: "instant debit transfer"; readonly InternationalBankTransfer: "international bank transfer"; readonly MerchantCard: "merchant card"; readonly Paypal: "paypal"; readonly Venmo: "venmo"; readonly VisaCard: "visa card"; }; export type FraudReviewRedemptionMethodEnum = typeof FraudReviewRedemptionMethodEnum[keyof typeof FraudReviewRedemptionMethodEnum]; export declare const FraudReviewRiskEnum: { readonly High: "high"; readonly Medium: "medium"; readonly Low: "low"; }; export type FraudReviewRiskEnum = typeof FraudReviewRiskEnum[keyof typeof FraudReviewRiskEnum]; /** * The fraud review associated with a reward. * @export * @interface FraudReviewBase */ export interface FraudReviewBase { /** * The current status of the fraud review: * `flagged` - The reward has been flagged for and waiting manual review. * `blocked` - The reward was reviewed and blocked. * `released` - The reward was reviewed and released. * @type {string} * @memberof FraudReviewBase */ 'status'?: FraudReviewBaseStatusEnum; /** * The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Apple Private Relay` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country` * @type {Array} * @memberof FraudReviewBase */ 'reasons'?: Array; /** * The device fingerprint, if known. * @type {string} * @memberof FraudReviewBase */ 'device_id'?: string; /** * The product selected to claim the reward * @type {string} * @memberof FraudReviewBase */ 'redemption_method'?: FraudReviewBaseRedemptionMethodEnum; /** * Date the reward was redeemed * @type {string} * @memberof FraudReviewBase */ 'redeemed_at'?: string; /** * * @type {ListFraudReviews200ResponseFraudReviewsInnerGeo} * @memberof FraudReviewBase */ 'geo'?: ListFraudReviews200ResponseFraudReviewsInnerGeo; /** * * @type {OrderWithoutLinkRewardsInner} * @memberof FraudReviewBase */ 'reward'?: OrderWithoutLinkRewardsInner; /** * The name of the person who reviewed the reward, or `Automatic Review` if the reward was blocked automatically. Rewards can be automatically blocked if they remain in the flagged fraud queue for more than 30 days. This field is only present if the status is not `flagged`. * @type {string} * @memberof FraudReviewBase */ 'reviewed_by'?: string; /** * When the reward was blocked or released following fraud review. This field is only present if the status is not `flagged`. * @type {string} * @memberof FraudReviewBase */ 'reviewed_at'?: string; /** * A hash of the destination account for redemption methods that require providing 3rd party account details (e.g., PayPal, Venmo, ACH/CashApp, international bank transfers, etc.). The hash is globally unique by redemption method + account combination. This field is omitted for redemption methods that don\'t have a destination account (e.g., merchant cards, charities, etc.). * @type {string} * @memberof FraudReviewBase */ 'redemption_method_account_hash'?: string; } export declare const FraudReviewBaseStatusEnum: { readonly Flagged: "flagged"; readonly Blocked: "blocked"; readonly Released: "released"; }; export type FraudReviewBaseStatusEnum = typeof FraudReviewBaseStatusEnum[keyof typeof FraudReviewBaseStatusEnum]; export declare const FraudReviewBaseReasonsEnum: { readonly DisallowedIp: "Disallowed IP"; readonly DisallowedEmail: "Disallowed email"; readonly DisallowedCountry: "Disallowed country"; readonly OverRewardAmountLimit: "Over reward amount limit"; readonly OverRewardCountLimit: "Over reward count limit"; readonly VpnDetected: "VPN detected"; readonly ApplePrivateRelay: "Apple Private Relay"; readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails"; readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails"; readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list"; readonly BankAccountOnATremendousFraudList: "Bank account on a Tremendous fraud list"; readonly FingerprintOnATremendousFraudList: "Fingerprint on a Tremendous fraud list"; readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list"; readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list"; readonly DeviceOnATremendousFraudList: "Device on a Tremendous fraud list"; readonly IpRelatedToABlockedReward: "IP related to a blocked reward"; readonly DeviceRelatedToABlockedReward: "Device related to a blocked reward"; readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward"; readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward"; readonly EmailRelatedToABlockedReward: "Email related to a blocked reward"; readonly PhoneRelatedToABlockedReward: "Phone related to a blocked reward"; readonly AllowedIp: "Allowed IP"; readonly AllowedEmail: "Allowed email"; readonly AllowedCountry: "Allowed country"; }; export type FraudReviewBaseReasonsEnum = typeof FraudReviewBaseReasonsEnum[keyof typeof FraudReviewBaseReasonsEnum]; export declare const FraudReviewBaseRedemptionMethodEnum: { readonly BankTransfer: "bank transfer"; readonly Charity: "charity"; readonly InstantDebitTransfer: "instant debit transfer"; readonly InternationalBankTransfer: "international bank transfer"; readonly MerchantCard: "merchant card"; readonly Paypal: "paypal"; readonly Venmo: "venmo"; readonly VisaCard: "visa card"; }; export type FraudReviewBaseRedemptionMethodEnum = typeof FraudReviewBaseRedemptionMethodEnum[keyof typeof FraudReviewBaseRedemptionMethodEnum]; /** * * @export * @interface FraudReviewGeo */ export interface FraudReviewGeo { /** * The recipient\'s IP. * @type {string} * @memberof FraudReviewGeo */ 'ip'?: string; /** * The country code (ISO-3166 alpha-2 character code) linked to the recipient\'s IP. * @type {string} * @memberof FraudReviewGeo */ 'country'?: string; /** * The city associated with the recipient\'s IP. * @type {string} * @memberof FraudReviewGeo */ 'city'?: string; } /** * The fraud review associated with a reward. * @export * @interface FraudReviewListItem */ export interface FraudReviewListItem { /** * The current status of the fraud review: * `flagged` - The reward has been flagged for and waiting manual review. * `blocked` - The reward was reviewed and blocked. * `released` - The reward was reviewed and released. * @type {string} * @memberof FraudReviewListItem */ 'status'?: FraudReviewListItemStatusEnum; /** * The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Apple Private Relay` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country` * @type {Array} * @memberof FraudReviewListItem */ 'reasons'?: Array; /** * The device fingerprint, if known. * @type {string} * @memberof FraudReviewListItem */ 'device_id'?: string; /** * The product selected to claim the reward * @type {string} * @memberof FraudReviewListItem */ 'redemption_method'?: FraudReviewListItemRedemptionMethodEnum; /** * Date the reward was redeemed * @type {string} * @memberof FraudReviewListItem */ 'redeemed_at'?: string; /** * * @type {ListFraudReviews200ResponseFraudReviewsInnerGeo} * @memberof FraudReviewListItem */ 'geo'?: ListFraudReviews200ResponseFraudReviewsInnerGeo; /** * * @type {OrderWithoutLinkRewardsInner} * @memberof FraudReviewListItem */ 'reward'?: OrderWithoutLinkRewardsInner; /** * The name of the person who reviewed the reward, or `Automatic Review` if the reward was blocked automatically. Rewards can be automatically blocked if they remain in the flagged fraud queue for more than 30 days. This field is only present if the status is not `flagged`. * @type {string} * @memberof FraudReviewListItem */ 'reviewed_by'?: string; /** * When the reward was blocked or released following fraud review. This field is only present if the status is not `flagged`. * @type {string} * @memberof FraudReviewListItem */ 'reviewed_at'?: string; /** * A hash of the destination account for redemption methods that require providing 3rd party account details (e.g., PayPal, Venmo, ACH/CashApp, international bank transfers, etc.). The hash is globally unique by redemption method + account combination. This field is omitted for redemption methods that don\'t have a destination account (e.g., merchant cards, charities, etc.). * @type {string} * @memberof FraudReviewListItem */ 'redemption_method_account_hash'?: string; } export declare const FraudReviewListItemStatusEnum: { readonly Flagged: "flagged"; readonly Blocked: "blocked"; readonly Released: "released"; }; export type FraudReviewListItemStatusEnum = typeof FraudReviewListItemStatusEnum[keyof typeof FraudReviewListItemStatusEnum]; export declare const FraudReviewListItemReasonsEnum: { readonly DisallowedIp: "Disallowed IP"; readonly DisallowedEmail: "Disallowed email"; readonly DisallowedCountry: "Disallowed country"; readonly OverRewardAmountLimit: "Over reward amount limit"; readonly OverRewardCountLimit: "Over reward count limit"; readonly VpnDetected: "VPN detected"; readonly ApplePrivateRelay: "Apple Private Relay"; readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails"; readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails"; readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list"; readonly BankAccountOnATremendousFraudList: "Bank account on a Tremendous fraud list"; readonly FingerprintOnATremendousFraudList: "Fingerprint on a Tremendous fraud list"; readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list"; readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list"; readonly DeviceOnATremendousFraudList: "Device on a Tremendous fraud list"; readonly IpRelatedToABlockedReward: "IP related to a blocked reward"; readonly DeviceRelatedToABlockedReward: "Device related to a blocked reward"; readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward"; readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward"; readonly EmailRelatedToABlockedReward: "Email related to a blocked reward"; readonly PhoneRelatedToABlockedReward: "Phone related to a blocked reward"; readonly AllowedIp: "Allowed IP"; readonly AllowedEmail: "Allowed email"; readonly AllowedCountry: "Allowed country"; }; export type FraudReviewListItemReasonsEnum = typeof FraudReviewListItemReasonsEnum[keyof typeof FraudReviewListItemReasonsEnum]; export declare const FraudReviewListItemRedemptionMethodEnum: { readonly BankTransfer: "bank transfer"; readonly Charity: "charity"; readonly InstantDebitTransfer: "instant debit transfer"; readonly InternationalBankTransfer: "international bank transfer"; readonly MerchantCard: "merchant card"; readonly Paypal: "paypal"; readonly Venmo: "venmo"; readonly VisaCard: "visa card"; }; export type FraudReviewListItemRedemptionMethodEnum = typeof FraudReviewListItemRedemptionMethodEnum[keyof typeof FraudReviewListItemRedemptionMethodEnum]; /** * * @export * @enum {string} */ export declare const FraudReviewReason: { readonly DisallowedIp: "Disallowed IP"; readonly DisallowedEmail: "Disallowed email"; readonly DisallowedCountry: "Disallowed country"; readonly OverRewardAmountLimit: "Over reward amount limit"; readonly OverRewardCountLimit: "Over reward count limit"; readonly VpnDetected: "VPN detected"; readonly ApplePrivateRelay: "Apple Private Relay"; readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails"; readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails"; readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list"; readonly BankAccountOnATremendousFraudList: "Bank account on a Tremendous fraud list"; readonly FingerprintOnATremendousFraudList: "Fingerprint on a Tremendous fraud list"; readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list"; readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list"; readonly DeviceOnATremendousFraudList: "Device on a Tremendous fraud list"; readonly IpRelatedToABlockedReward: "IP related to a blocked reward"; readonly DeviceRelatedToABlockedReward: "Device related to a blocked reward"; readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward"; readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward"; readonly EmailRelatedToABlockedReward: "Email related to a blocked reward"; readonly PhoneRelatedToABlockedReward: "Phone related to a blocked reward"; readonly AllowedIp: "Allowed IP"; readonly AllowedEmail: "Allowed email"; readonly AllowedCountry: "Allowed country"; }; export type FraudReviewReason = typeof FraudReviewReason[keyof typeof FraudReviewReason]; /** * * @export * @enum {string} */ export declare const FraudReviewRedemptionMethod: { readonly BankTransfer: "bank transfer"; readonly Charity: "charity"; readonly InstantDebitTransfer: "instant debit transfer"; readonly InternationalBankTransfer: "international bank transfer"; readonly MerchantCard: "merchant card"; readonly Paypal: "paypal"; readonly Venmo: "venmo"; readonly VisaCard: "visa card"; }; export type FraudReviewRedemptionMethod = typeof FraudReviewRedemptionMethod[keyof typeof FraudReviewRedemptionMethod]; /** * The related rewards associated with the fraud review. * @export * @interface FraudReviewRelatedRewards */ export interface FraudReviewRelatedRewards { /** * The IDs of rewards that have similar attributes to the fraud reward. A maximum of 100 IDs is returned. * @type {Array} * @memberof FraudReviewRelatedRewards */ 'ids'?: Array; /** * How many related rewards were found in total. * @type {number} * @memberof FraudReviewRelatedRewards */ 'count'?: number; /** * How many related rewards have been blocked. * @type {number} * @memberof FraudReviewRelatedRewards */ 'blocked_count'?: number; /** * Total amount claimed by the related rewards, denominated in `currency_code`. * @type {number} * @memberof FraudReviewRelatedRewards */ 'aggregated_value'?: number; /** * Currency of the aggregated value. Always matches the organization\'s currency. * @type {string} * @memberof FraudReviewRelatedRewards */ 'currency_code'?: string; } /** * The fraud risk associated with the reward. * @export * @enum {string} */ export declare const FraudReviewRisk: { readonly High: "high"; readonly Medium: "medium"; readonly Low: "low"; }; export type FraudReviewRisk = typeof FraudReviewRisk[keyof typeof FraudReviewRisk]; /** * The current status of the fraud review: * `flagged` - The reward has been flagged for and waiting manual review. * `blocked` - The reward was reviewed and blocked. * `released` - The reward was reviewed and released. * @export * @enum {string} */ export declare const FraudReviewStatus: { readonly Flagged: "flagged"; readonly Blocked: "blocked"; readonly Released: "released"; }; export type FraudReviewStatus = typeof FraudReviewStatus[keyof typeof FraudReviewStatus]; /** * * @export * @interface FraudRule200Response */ export interface FraudRule200Response { /** * A description of the result * @type {string} * @memberof FraudRule200Response */ 'message': string; } /** * * @export * @interface FraudRule400Response */ export interface FraudRule400Response { /** * HTTP status code of the response * @type {number} * @memberof FraudRule400Response */ 'status'?: number; /** * * @type {ListRewards401ResponseErrors} * @memberof FraudRule400Response */ 'errors': ListRewards401ResponseErrors; } /** * * @export * @interface FraudRule422Response */ export interface FraudRule422Response { /** * HTTP status code of the response * @type {number} * @memberof FraudRule422Response */ 'status'?: number; /** * * @type {ListRewards401ResponseErrors} * @memberof FraudRule422Response */ 'errors': ListRewards401ResponseErrors; } /** * * @export * @interface FraudRuleRequest */ export interface FraudRuleRequest { /** * * @type {FraudRuleRequestConfig} * @memberof FraudRuleRequest */ 'config'?: FraudRuleRequestConfig; } /** * The configuration associated with the rule. The properties allowed depend on the type of rule. * @export * @interface FraudRuleRequestConfig */ export interface FraudRuleRequestConfig { /** * When type is `whitelist`, it flags any countries that *are not* present in the list. When type is `blacklist`, it flags any countries that *are* present in the list. * @type {string} * @memberof FraudRuleRequestConfig */ 'type': FraudRuleRequestConfigTypeEnum; /** * An array of country codes (ISO-3166 alpha-2 character code) * @type {Array} * @memberof FraudRuleRequestConfig */ 'countries': Array; /** * The list of IP addresses to flag or allow. Accepts both IPv4 and IPv6 addresses using CIDR notation. * @type {Array} * @memberof FraudRuleRequestConfig */ 'ips': Array; /** * The list of emails. * @type {Array} * @memberof FraudRuleRequestConfig */ 'emails': Array; /** * The list of domains. Any subdomains will also be matched against each entry in the list. * @type {Array} * @memberof FraudRuleRequestConfig */ 'domains'?: Array; /** * The total amount of redeemed rewards to use as a threshold. The amount is denominated in the organization\'s currency. * @type {number} * @memberof FraudRuleRequestConfig */ 'amount': number; /** * The period, in days, to consider for the count. Use `all_time` to consider any redeemed rewards. * @type {string} * @memberof FraudRuleRequestConfig */ 'period': FraudRuleRequestConfigPeriodEnum; /** * Whether Apple Private Relay traffic should be excluded from VPN fraud review. When omitted or false, Apple Private Relay traffic is flagged with other VPN and proxy traffic. * @type {boolean} * @memberof FraudRuleRequestConfig */ 'skip_apple_private_relay'?: boolean; } export declare const FraudRuleRequestConfigTypeEnum: { readonly Whitelist: "whitelist"; readonly Blacklist: "blacklist"; }; export type FraudRuleRequestConfigTypeEnum = typeof FraudRuleRequestConfigTypeEnum[keyof typeof FraudRuleRequestConfigTypeEnum]; export declare const FraudRuleRequestConfigPeriodEnum: { readonly _7: "7"; readonly _30: "30"; readonly _90: "90"; readonly _120: "120"; readonly _365: "365"; readonly AllTime: "all_time"; }; export type FraudRuleRequestConfigPeriodEnum = typeof FraudRuleRequestConfigPeriodEnum[keyof typeof FraudRuleRequestConfigPeriodEnum]; /** * * `review_country` - Flags when the recipient\'s IP country matches the criteria in the rule * `review_ip` - Flags when recipient\'s IP matches one in the list * `review_email` - Flags when the recipient\'s email matches one in the list * `review_redeemed_rewards_count` - Flags when the recipient redeemed more than the number of rewards specified in the config * `review_redeemed_rewards_amount` - Flags when the recipient redeemed more than the total amount specified in the config. The amount is denominated in the organization\'s currency. * `review_multiple_emails` - Flags when recipient\'s device or account has multiple emails associated * `review_vpn` - Flags when VPN or proxy use is suspected. Can be configured to exclude Apple Private Relay. * `review_tremendous_flag_list` - Flags rewards when redemption attributes match at least one criteria defined by the Tremendous flag list * `review_previously_blocked_recipients` - Flags rewards when the recipient has been blocked before * `allow_ip` - Releases a reward when a recipient\'s IP matches one in the list * `allow_email` - Releases a reward when the recipient\'s email matches one in the list * @export * @enum {string} */ export declare const FraudRuleType: { readonly ReviewCountry: "review_country"; readonly ReviewIp: "review_ip"; readonly ReviewEmail: "review_email"; readonly ReviewRedeemedRewardsCount: "review_redeemed_rewards_count"; readonly ReviewRedeemedRewardsAmount: "review_redeemed_rewards_amount"; readonly ReviewMultipleEmails: "review_multiple_emails"; readonly ReviewVpn: "review_vpn"; readonly ReviewTremendousFlagList: "review_tremendous_flag_list"; readonly ReviewPreviouslyBlockedRecipients: "review_previously_blocked_recipients"; readonly AllowIp: "allow_ip"; readonly AllowEmail: "allow_email"; }; export type FraudRuleType = typeof FraudRuleType[keyof typeof FraudRuleType]; /** * An active fraud rule * @export * @interface FraudRulesListItem */ export interface FraudRulesListItem { /** * * `review_country` - Flags when the recipient\'s IP country matches the criteria in the rule * `review_ip` - Flags when recipient\'s IP matches one in the list * `review_email` - Flags when the recipient\'s email matches one in the list * `review_redeemed_rewards_count` - Flags when the recipient redeemed more than the number of rewards specified in the config * `review_redeemed_rewards_amount` - Flags when the recipient redeemed more than the total amount specified in the config. The amount is denominated in the organization\'s currency. * `review_multiple_emails` - Flags when recipient\'s device or account has multiple emails associated * `review_vpn` - Flags when VPN or proxy use is suspected. Can be configured to exclude Apple Private Relay. * `review_tremendous_flag_list` - Flags rewards when redemption attributes match at least one criteria defined by the Tremendous flag list * `review_previously_blocked_recipients` - Flags rewards when the recipient has been blocked before * `allow_ip` - Releases a reward when a recipient\'s IP matches one in the list * `allow_email` - Releases a reward when the recipient\'s email matches one in the list * @type {string} * @memberof FraudRulesListItem */ 'rule_type'?: FraudRulesListItemRuleTypeEnum; /** * The configuration associated with the rule. The properties allowed depend on the type of rule. This property is only present for rules that require configuration. * @type {{ [key: string]: any; }} * @memberof FraudRulesListItem */ 'config'?: { [key: string]: any; } | null; } export declare const FraudRulesListItemRuleTypeEnum: { readonly ReviewCountry: "review_country"; readonly ReviewIp: "review_ip"; readonly ReviewEmail: "review_email"; readonly ReviewRedeemedRewardsCount: "review_redeemed_rewards_count"; readonly ReviewRedeemedRewardsAmount: "review_redeemed_rewards_amount"; readonly ReviewMultipleEmails: "review_multiple_emails"; readonly ReviewVpn: "review_vpn"; readonly ReviewTremendousFlagList: "review_tremendous_flag_list"; readonly ReviewPreviouslyBlockedRecipients: "review_previously_blocked_recipients"; readonly AllowIp: "allow_ip"; readonly AllowEmail: "allow_email"; }; export type FraudRulesListItemRuleTypeEnum = typeof FraudRulesListItemRuleTypeEnum[keyof typeof FraudRulesListItemRuleTypeEnum]; /** * * @export * @interface FundingSource */ export interface FundingSource { /** * * @type {string} * @memberof FundingSource */ 'id': string; /** * You can pay for rewards using different payment methods on Tremendous:
Payment Method Description
balance Pre-funded balance in your Tremendous account to draw funds from to send rewards to recipients.
bank_account Bank account to draw funds from to send rewards to recipients.
credit_card Credit card to draw funds from to send rewards to recipients.
invoice Send rewards to recipients and pay by invoice.
* @type {string} * @memberof FundingSource */ 'method': FundingSourceMethodEnum; /** * Indicates which actions this funding source can perform.
Permission Description
api_orders Usable for orders via API.
dashboard_orders Usable for orders via Tremendous dashboard.
balance_funding Usable to add funds to a balance (via dashboard or API).
* @type {Array} * @memberof FundingSource */ 'usage_permissions'?: Array; /** * Status of the funding_source
Status Description
active Ready for use.
deleted Manually removed, and not usable.
failed Last payment attempt failed, and not usable (contact Tremendous support to reinstate).
* @type {string} * @memberof FundingSource */ 'status'?: FundingSourceStatusEnum; /** * **Only available when `method` is set to `invoice`.** * @type {string} * @memberof FundingSource */ 'type'?: FundingSourceTypeEnum; /** * * @type {ListFundingSources200ResponseFundingSourcesInnerMeta} * @memberof FundingSource */ 'meta': ListFundingSources200ResponseFundingSourcesInnerMeta; } export declare const FundingSourceMethodEnum: { readonly Balance: "balance"; readonly BankAccount: "bank_account"; readonly CreditCard: "credit_card"; readonly Invoice: "invoice"; }; export type FundingSourceMethodEnum = typeof FundingSourceMethodEnum[keyof typeof FundingSourceMethodEnum]; export declare const FundingSourceUsagePermissionsEnum: { readonly ApiOrders: "api_orders"; readonly DashboardOrders: "dashboard_orders"; readonly BalanceFunding: "balance_funding"; }; export type FundingSourceUsagePermissionsEnum = typeof FundingSourceUsagePermissionsEnum[keyof typeof FundingSourceUsagePermissionsEnum]; export declare const FundingSourceStatusEnum: { readonly Active: "active"; readonly Deleted: "deleted"; readonly Failed: "failed"; }; export type FundingSourceStatusEnum = typeof FundingSourceStatusEnum[keyof typeof FundingSourceStatusEnum]; export declare const FundingSourceTypeEnum: { readonly Commercial: "COMMERCIAL"; readonly ProForma: "PRO_FORMA"; readonly PrefundingOnly: "PREFUNDING_ONLY"; }; export type FundingSourceTypeEnum = typeof FundingSourceTypeEnum[keyof typeof FundingSourceTypeEnum]; /** * * @export * @interface GenerateRewardLink200Response */ export interface GenerateRewardLink200Response { /** * * @type {GenerateRewardLink200ResponseReward} * @memberof GenerateRewardLink200Response */ 'reward': GenerateRewardLink200ResponseReward; } /** * The redemption link for a reward. * @export * @interface GenerateRewardLink200ResponseReward */ export interface GenerateRewardLink200ResponseReward { /** * Tremendous ID of the reward * @type {string} * @memberof GenerateRewardLink200ResponseReward */ 'id'?: string; /** * Link to redeem the reward at. You need to deliver this link to the recipient. * @type {string} * @memberof GenerateRewardLink200ResponseReward */ 'link'?: string; } /** * * @export * @interface GenerateRewardLink403Response */ export interface GenerateRewardLink403Response { /** * HTTP status code of the response * @type {number} * @memberof GenerateRewardLink403Response */ 'status'?: number; /** * * @type {ListRewards401ResponseErrors} * @memberof GenerateRewardLink403Response */ 'errors': ListRewards401ResponseErrors; } /** * * @export * @interface GetFraudReview200Response */ export interface GetFraudReview200Response { /** * * @type {GetFraudReview200ResponseFraudReview} * @memberof GetFraudReview200Response */ 'fraud_review': GetFraudReview200ResponseFraudReview; } /** * The fraud review associated with a reward. * @export * @interface GetFraudReview200ResponseFraudReview */ export interface GetFraudReview200ResponseFraudReview { /** * The current status of the fraud review: * `flagged` - The reward has been flagged for and waiting manual review. * `blocked` - The reward was reviewed and blocked. * `released` - The reward was reviewed and released. * @type {string} * @memberof GetFraudReview200ResponseFraudReview */ 'status'?: GetFraudReview200ResponseFraudReviewStatusEnum; /** * The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Apple Private Relay` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country` * @type {Array} * @memberof GetFraudReview200ResponseFraudReview */ 'reasons'?: Array; /** * The device fingerprint, if known. * @type {string} * @memberof GetFraudReview200ResponseFraudReview */ 'device_id'?: string; /** * The product selected to claim the reward * @type {string} * @memberof GetFraudReview200ResponseFraudReview */ 'redemption_method'?: GetFraudReview200ResponseFraudReviewRedemptionMethodEnum; /** * Date the reward was redeemed * @type {string} * @memberof GetFraudReview200ResponseFraudReview */ 'redeemed_at'?: string; /** * * @type {ListFraudReviews200ResponseFraudReviewsInnerGeo} * @memberof GetFraudReview200ResponseFraudReview */ 'geo'?: ListFraudReviews200ResponseFraudReviewsInnerGeo; /** * * @type {ListRewards200ResponseRewardsInner} * @memberof GetFraudReview200ResponseFraudReview */ 'reward'?: ListRewards200ResponseRewardsInner; /** * The name of the person who reviewed the reward, or `Automatic Review` if the reward was blocked automatically. Rewards can be automatically blocked if they remain in the flagged fraud queue for more than 30 days. This field is only present if the status is not `flagged`. * @type {string} * @memberof GetFraudReview200ResponseFraudReview */ 'reviewed_by'?: string; /** * When the reward was blocked or released following fraud review. This field is only present if the status is not `flagged`. * @type {string} * @memberof GetFraudReview200ResponseFraudReview */ 'reviewed_at'?: string; /** * A hash of the destination account for redemption methods that require providing 3rd party account details (e.g., PayPal, Venmo, ACH/CashApp, international bank transfers, etc.). The hash is globally unique by redemption method + account combination. This field is omitted for redemption methods that don\'t have a destination account (e.g., merchant cards, charities, etc.). * @type {string} * @memberof GetFraudReview200ResponseFraudReview */ 'redemption_method_account_hash'?: string; /** * The fraud risk associated with the reward. * @type {string} * @memberof GetFraudReview200ResponseFraudReview */ 'risk'?: GetFraudReview200ResponseFraudReviewRiskEnum; /** * * @type {GetFraudReview200ResponseFraudReviewRelatedRewards} * @memberof GetFraudReview200ResponseFraudReview */ 'related_rewards'?: GetFraudReview200ResponseFraudReviewRelatedRewards; } export declare const GetFraudReview200ResponseFraudReviewStatusEnum: { readonly Flagged: "flagged"; readonly Blocked: "blocked"; readonly Released: "released"; }; export type GetFraudReview200ResponseFraudReviewStatusEnum = typeof GetFraudReview200ResponseFraudReviewStatusEnum[keyof typeof GetFraudReview200ResponseFraudReviewStatusEnum]; export declare const GetFraudReview200ResponseFraudReviewReasonsEnum: { readonly DisallowedIp: "Disallowed IP"; readonly DisallowedEmail: "Disallowed email"; readonly DisallowedCountry: "Disallowed country"; readonly OverRewardAmountLimit: "Over reward amount limit"; readonly OverRewardCountLimit: "Over reward count limit"; readonly VpnDetected: "VPN detected"; readonly ApplePrivateRelay: "Apple Private Relay"; readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails"; readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails"; readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list"; readonly BankAccountOnATremendousFraudList: "Bank account on a Tremendous fraud list"; readonly FingerprintOnATremendousFraudList: "Fingerprint on a Tremendous fraud list"; readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list"; readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list"; readonly DeviceOnATremendousFraudList: "Device on a Tremendous fraud list"; readonly IpRelatedToABlockedReward: "IP related to a blocked reward"; readonly DeviceRelatedToABlockedReward: "Device related to a blocked reward"; readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward"; readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward"; readonly EmailRelatedToABlockedReward: "Email related to a blocked reward"; readonly PhoneRelatedToABlockedReward: "Phone related to a blocked reward"; readonly AllowedIp: "Allowed IP"; readonly AllowedEmail: "Allowed email"; readonly AllowedCountry: "Allowed country"; }; export type GetFraudReview200ResponseFraudReviewReasonsEnum = typeof GetFraudReview200ResponseFraudReviewReasonsEnum[keyof typeof GetFraudReview200ResponseFraudReviewReasonsEnum]; export declare const GetFraudReview200ResponseFraudReviewRedemptionMethodEnum: { readonly BankTransfer: "bank transfer"; readonly Charity: "charity"; readonly InstantDebitTransfer: "instant debit transfer"; readonly InternationalBankTransfer: "international bank transfer"; readonly MerchantCard: "merchant card"; readonly Paypal: "paypal"; readonly Venmo: "venmo"; readonly VisaCard: "visa card"; }; export type GetFraudReview200ResponseFraudReviewRedemptionMethodEnum = typeof GetFraudReview200ResponseFraudReviewRedemptionMethodEnum[keyof typeof GetFraudReview200ResponseFraudReviewRedemptionMethodEnum]; export declare const GetFraudReview200ResponseFraudReviewRiskEnum: { readonly High: "high"; readonly Medium: "medium"; readonly Low: "low"; }; export type GetFraudReview200ResponseFraudReviewRiskEnum = typeof GetFraudReview200ResponseFraudReviewRiskEnum[keyof typeof GetFraudReview200ResponseFraudReviewRiskEnum]; /** * The related rewards associated with the fraud review. * @export * @interface GetFraudReview200ResponseFraudReviewRelatedRewards */ export interface GetFraudReview200ResponseFraudReviewRelatedRewards { /** * The IDs of rewards that have similar attributes to the fraud reward. A maximum of 100 IDs is returned. * @type {Array} * @memberof GetFraudReview200ResponseFraudReviewRelatedRewards */ 'ids'?: Array; /** * How many related rewards were found in total. * @type {number} * @memberof GetFraudReview200ResponseFraudReviewRelatedRewards */ 'count'?: number; /** * How many related rewards have been blocked. * @type {number} * @memberof GetFraudReview200ResponseFraudReviewRelatedRewards */ 'blocked_count'?: number; /** * Total amount claimed by the related rewards, denominated in `currency_code`. * @type {number} * @memberof GetFraudReview200ResponseFraudReviewRelatedRewards */ 'aggregated_value'?: number; /** * Currency of the aggregated value. Always matches the organization\'s currency. * @type {string} * @memberof GetFraudReview200ResponseFraudReviewRelatedRewards */ 'currency_code'?: string; } /** * * @export * @interface GetFundingSource200Response */ export interface GetFundingSource200Response { /** * * @type {ListFundingSources200ResponseFundingSourcesInner} * @memberof GetFundingSource200Response */ 'funding_source': ListFundingSources200ResponseFundingSourcesInner; } /** * * @export * @interface GetMember200Response */ export interface GetMember200Response { /** * * @type {GetMember200ResponseMember} * @memberof GetMember200Response */ 'member': GetMember200ResponseMember; } /** * Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. * @export * @interface GetMember200ResponseMember */ export interface GetMember200ResponseMember { /** * * @type {string} * @memberof GetMember200ResponseMember */ 'id': string; /** * Email address of the member * @type {string} * @memberof GetMember200ResponseMember */ 'email': string; /** * Full name of the member * @type {string} * @memberof GetMember200ResponseMember */ 'name': string | null; /** * Is this member currently active in the organization. If `false`, the member will not be able to access the organization. * @type {boolean} * @memberof GetMember200ResponseMember */ 'active'?: boolean; /** * The role ID associated with the member within the organization. * @type {string} * @memberof GetMember200ResponseMember */ 'role'?: string | null; /** * Current status of the member\'s account. When creating a member it starts out in the status `INVITED`. As soon as that member open the invitation link and registers an account, the status switches to `REGISTERED`. * @type {string} * @memberof GetMember200ResponseMember */ 'status': GetMember200ResponseMemberStatusEnum; /** * List of events related to the member. * @type {Array} * @memberof GetMember200ResponseMember */ 'events'?: Array; } export declare const GetMember200ResponseMemberStatusEnum: { readonly Registered: "REGISTERED"; readonly Invited: "INVITED"; }; export type GetMember200ResponseMemberStatusEnum = typeof GetMember200ResponseMemberStatusEnum[keyof typeof GetMember200ResponseMemberStatusEnum]; /** * * @export * @interface GetMember200ResponseMemberEventsInner */ export interface GetMember200ResponseMemberEventsInner { /** * Event type * @type {string} * @memberof GetMember200ResponseMemberEventsInner */ 'type'?: GetMember200ResponseMemberEventsInnerTypeEnum; /** * Timestamp when the event happened * @type {string} * @memberof GetMember200ResponseMemberEventsInner */ 'date_utc'?: string | null; } export declare const GetMember200ResponseMemberEventsInnerTypeEnum: { readonly Created: "created"; readonly LastLogin: "last_login"; }; export type GetMember200ResponseMemberEventsInnerTypeEnum = typeof GetMember200ResponseMemberEventsInnerTypeEnum[keyof typeof GetMember200ResponseMemberEventsInnerTypeEnum]; /** * * @export * @interface GetOrder200Response */ export interface GetOrder200Response { /** * * @type {ListOrders200ResponseOrdersInner} * @memberof GetOrder200Response */ 'order': ListOrders200ResponseOrdersInner; } /** * * @export * @interface GetOrganization200Response */ export interface GetOrganization200Response { /** * * @type {ListOrganizations200ResponseOrganizationsInner} * @memberof GetOrganization200Response */ 'organization'?: ListOrganizations200ResponseOrganizationsInner; } /** * * @export * @interface GetProductResponse */ export interface GetProductResponse { /** * * @type {ListProductsResponseProductsInner} * @memberof GetProductResponse */ 'product': ListProductsResponseProductsInner; } /** * * @export * @interface GetReward200Response */ export interface GetReward200Response { /** * * @type {ListRewards200ResponseRewardsInner} * @memberof GetReward200Response */ 'reward': ListRewards200ResponseRewardsInner; } /** * * @export * @interface InlineObject */ export interface InlineObject { /** * HTTP status code of the response * @type {number} * @memberof InlineObject */ 'status'?: number; /** * Error message * @type {string} * @memberof InlineObject */ 'error'?: string; } /** * * @export * @interface InlineObject1 */ export interface InlineObject1 { /** * * @type {InlineObject1Reward} * @memberof InlineObject1 */ 'reward': InlineObject1Reward; } /** * The redemption token for a reward. * @export * @interface InlineObject1Reward */ export interface InlineObject1Reward { /** * Tremendous ID of the reward * @type {string} * @memberof InlineObject1Reward */ 'id'?: string; /** * The token to redeem the reward. * @type {string} * @memberof InlineObject1Reward */ 'token'?: string; /** * Date the token expires * @type {string} * @memberof InlineObject1Reward */ 'expires_at'?: string; } /** * Invoices are instruments to fund your Tremendous account\'s balance. Invoices can be created by your organization programatically. Once we receive your payment, the invoice is marked as `PAID` and we add the respective funds to your account\'s balance. * @export * @interface Invoice */ export interface Invoice { /** * The invoice number * @type {string} * @memberof Invoice */ 'id': string; /** * Reference to the purchase order number within your organization * @type {string} * @memberof Invoice */ 'po_number'?: string | null; /** * Amount of the invoice * @type {number} * @memberof Invoice */ 'amount': number; /** * Currency of the invoice * @type {string} * @memberof Invoice */ 'currency_code'?: InvoiceCurrencyCodeEnum; /** * Deprecated: Use `currency_code` instead. * @type {string} * @memberof Invoice * @deprecated */ 'currency'?: InvoiceCurrencyEnum; /** * * @type {boolean} * @memberof Invoice */ 'international'?: boolean; /** * Status of this invoice
Status Description
DELETED Invoice has been deleted by your organization
PAID Invoice has been paid by your organization
OPEN Invoice has been created by your organization but has not been paid, yet
* @type {string} * @memberof Invoice */ 'status': InvoiceStatusEnum; /** * List of orders related to the invoice (it doesn\'t apply to prefunding) * @type {Array} * @memberof Invoice */ 'orders'?: Array; /** * List of rewards related to the invoice (it doesn\'t apply to prefunding) * @type {Array} * @memberof Invoice */ 'rewards'?: Array; /** * Timestamp of when the invoice has been created. * @type {string} * @memberof Invoice */ 'created_at': string; /** * Timestamp of when the invoice has been paid. * @type {string} * @memberof Invoice */ 'paid_at': string | null; } export declare const InvoiceCurrencyCodeEnum: { readonly Usd: "USD"; readonly Eur: "EUR"; readonly Gbp: "GBP"; }; export type InvoiceCurrencyCodeEnum = typeof InvoiceCurrencyCodeEnum[keyof typeof InvoiceCurrencyCodeEnum]; export declare const InvoiceCurrencyEnum: { readonly Usd: "USD"; readonly Eur: "EUR"; readonly Gbp: "GBP"; }; export type InvoiceCurrencyEnum = typeof InvoiceCurrencyEnum[keyof typeof InvoiceCurrencyEnum]; export declare const InvoiceStatusEnum: { readonly Deleted: "DELETED"; readonly Paid: "PAID"; readonly Open: "OPEN"; readonly MarkedAsPaid: "MARKED_AS_PAID"; }; export type InvoiceStatusEnum = typeof InvoiceStatusEnum[keyof typeof InvoiceStatusEnum]; /** * * @export * @interface ListBalanceTransactions200Response */ export interface ListBalanceTransactions200Response { /** * * @type {Array} * @memberof ListBalanceTransactions200Response */ 'transactions': Array; } /** * A balance transaction represents a specific movement or change in an account\'s balance. * @export * @interface ListBalanceTransactions200ResponseTransactionsInner */ export interface ListBalanceTransactions200ResponseTransactionsInner { /** * Date that the transaction was created * @type {string} * @memberof ListBalanceTransactions200ResponseTransactionsInner */ 'created_at': string; /** * Amount of the transaction, denominated in `currency_code`. * @type {number} * @memberof ListBalanceTransactions200ResponseTransactionsInner */ 'amount': number; /** * Currency of the transaction amount and running balance. Always matches the organization\'s currency. * @type {string} * @memberof ListBalanceTransactions200ResponseTransactionsInner */ 'currency_code': string; /** * The updated total after the transaction, denominated in `currency_code`. Note that this running balance may be delayed and contain `null`. * @type {number} * @memberof ListBalanceTransactions200ResponseTransactionsInner */ 'balance': number; /** * The action that was performed * @type {string} * @memberof ListBalanceTransactions200ResponseTransactionsInner */ 'action': string; /** * A brief description of the transaction * @type {string} * @memberof ListBalanceTransactions200ResponseTransactionsInner */ 'description': string; /** * * @type {ListBalanceTransactions200ResponseTransactionsInnerOrder} * @memberof ListBalanceTransactions200ResponseTransactionsInner */ 'order'?: ListBalanceTransactions200ResponseTransactionsInnerOrder; } /** * Order details * @export * @interface ListBalanceTransactions200ResponseTransactionsInnerOrder */ export interface ListBalanceTransactions200ResponseTransactionsInnerOrder { /** * * @type {string} * @memberof ListBalanceTransactions200ResponseTransactionsInnerOrder */ 'id'?: string; /** * Reference for this order, supplied by the customer. When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders. It also allows for retrieving by `external_id` instead of `id` only. * @type {string} * @memberof ListBalanceTransactions200ResponseTransactionsInnerOrder */ 'external_id'?: string | null; /** * * @type {ListBalanceTransactions200ResponseTransactionsInnerOrderPayment} * @memberof ListBalanceTransactions200ResponseTransactionsInnerOrder */ 'payment'?: ListBalanceTransactions200ResponseTransactionsInnerOrderPayment; } /** * * @export * @interface ListBalanceTransactions200ResponseTransactionsInnerOrderPayment */ export interface ListBalanceTransactions200ResponseTransactionsInnerOrderPayment { /** * Total price of the order before fees, denominated in `currency_code`. * @type {number} * @memberof ListBalanceTransactions200ResponseTransactionsInnerOrderPayment */ 'subtotal': number; /** * Total price of the order including fees, denominated in `currency_code`. * @type {number} * @memberof ListBalanceTransactions200ResponseTransactionsInnerOrderPayment */ 'total': number; /** * Fees for the order, denominated in `currency_code`. * @type {number} * @memberof ListBalanceTransactions200ResponseTransactionsInnerOrderPayment */ 'fees': number; /** * Discount for the order, denominated in `currency_code`. * @type {number} * @memberof ListBalanceTransactions200ResponseTransactionsInnerOrderPayment */ 'discount': number; /** * Currency in which the payment amounts (subtotal, total, fees, discount, refund) are denominated. This always matches the organization\'s currency. * @type {string} * @memberof ListBalanceTransactions200ResponseTransactionsInnerOrderPayment */ 'currency_code': string; /** * * @type {ListOrders200ResponseOrdersInnerPaymentRefund} * @memberof ListBalanceTransactions200ResponseTransactionsInnerOrderPayment */ 'refund'?: ListOrders200ResponseOrdersInnerPaymentRefund; } /** * * @export * @interface ListCampaigns200Response */ export interface ListCampaigns200Response { /** * * @type {Array} * @memberof ListCampaigns200Response */ 'campaigns': Array; } /** * With a campaign you can define the look & feel of how rewards are sent out. It also lets you set the available products (different gift cards, charity, etc.) recipients can choose from. * @export * @interface ListCampaigns200ResponseCampaignsInner */ export interface ListCampaigns200ResponseCampaignsInner { /** * * @type {string} * @memberof ListCampaigns200ResponseCampaignsInner */ 'id'?: string; /** * Name of the campaign * @type {string} * @memberof ListCampaigns200ResponseCampaignsInner */ 'name': string; /** * Description of the campaign * @type {string} * @memberof ListCampaigns200ResponseCampaignsInner */ 'description': string | null; /** * List of IDs of products (different gift cards, charity, etc.) that are available in this campaign. * @type {Array} * @memberof ListCampaigns200ResponseCampaignsInner */ 'products': Array; /** * Determines whether fees for premium products are added to the order total (`SENDER`) or deducted from the recipient\'s reward amount (`RECIPIENT`). Campaigns with `RECIPIENT` must include at least one fee-free product. * @type {string} * @memberof ListCampaigns200ResponseCampaignsInner */ 'fee_charged_to'?: ListCampaigns200ResponseCampaignsInnerFeeChargedToEnum | null; /** * * @type {ListCampaigns200ResponseCampaignsInnerAutoAddProductRule} * @memberof ListCampaigns200ResponseCampaignsInner */ 'auto_add_product_rule'?: ListCampaigns200ResponseCampaignsInnerAutoAddProductRule | null; /** * * @type {ListCampaigns200ResponseCampaignsInnerWebpageStyle} * @memberof ListCampaigns200ResponseCampaignsInner */ 'webpage_style'?: ListCampaigns200ResponseCampaignsInnerWebpageStyle; /** * * @type {ListCampaigns200ResponseCampaignsInnerEmailStyle} * @memberof ListCampaigns200ResponseCampaignsInner */ 'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle; } export declare const ListCampaigns200ResponseCampaignsInnerFeeChargedToEnum: { readonly Sender: "SENDER"; readonly Recipient: "RECIPIENT"; }; export type ListCampaigns200ResponseCampaignsInnerFeeChargedToEnum = typeof ListCampaigns200ResponseCampaignsInnerFeeChargedToEnum[keyof typeof ListCampaigns200ResponseCampaignsInnerFeeChargedToEnum]; /** * When enabled, newly activated gift card products that match the optional country and currency filters are added to this campaign automatically. Applies to gift cards only — premium options, prepaid cards, and merchant cards with vendor fees are excluded. Affects future rewards only and does not retroactively add products to unredeemed rewards. On read, `enabled` is `true` whenever a rule is configured; `countries` and `currencies` are only present when the rule actually filters on them — an absent filter matches all values. On write: * Omit the field on `PUT` to leave the existing rule unchanged. * Send `null` or `{ \"enabled\": false }` to clear any existing rule. * Send `{ \"enabled\": true, ... }` to upsert. `countries` and `currencies` are optional; when present they must contain at least one entry. To match all countries (or all currencies), simply omit the key. * An empty object (`{}`) is rejected because `enabled` is required — use `{ \"enabled\": false }` or `null` to clear the rule. * @export * @interface ListCampaigns200ResponseCampaignsInnerAutoAddProductRule */ export interface ListCampaigns200ResponseCampaignsInnerAutoAddProductRule { /** * Whether the auto-add rule is active. * @type {boolean} * @memberof ListCampaigns200ResponseCampaignsInnerAutoAddProductRule */ 'enabled': boolean; /** * ISO 3166-1 alpha-2 country codes (uppercase). When omitted, the rule matches all countries; when present, must contain at least one entry. Each code must be covered by at least one active Tremendous product — requests filtering on a country we don\'t currently sell into are rejected with a 422. * @type {Array} * @memberof ListCampaigns200ResponseCampaignsInnerAutoAddProductRule */ 'countries'?: Array; /** * ISO 4217 currency codes (uppercase). When omitted, the rule matches all currencies; when present, must contain at least one entry. Each code must be covered by at least one active Tremendous product — requests filtering on a currency we don\'t currently sell are rejected with a 422. * @type {Array} * @memberof ListCampaigns200ResponseCampaignsInnerAutoAddProductRule */ 'currencies'?: Array; } /** * Definition of the email style * @export * @interface ListCampaigns200ResponseCampaignsInnerEmailStyle */ export interface ListCampaigns200ResponseCampaignsInnerEmailStyle { /** * If sending via email, this is how the email will appear to be sent from * @type {string} * @memberof ListCampaigns200ResponseCampaignsInnerEmailStyle */ 'sender_name'?: string | null; /** * Email subject line * @type {string} * @memberof ListCampaigns200ResponseCampaignsInnerEmailStyle */ 'subject_line'?: string | null; /** * URL of a publicly-accessible image (png, jpeg, jpg, gif, or svg). This image will be copied to our storage location. * @type {string} * @memberof ListCampaigns200ResponseCampaignsInnerEmailStyle */ 'logo_image_url'?: string | null; /** * Image height in pixels * @type {number} * @memberof ListCampaigns200ResponseCampaignsInnerEmailStyle */ 'logo_image_height_px'?: number | null; /** * Logo background color code (hex, rgb, or rgba) * @type {string} * @memberof ListCampaigns200ResponseCampaignsInnerEmailStyle */ 'logo_background_color'?: string | null; /** * Button color code (hex, rgb, or rgba) * @type {string} * @memberof ListCampaigns200ResponseCampaignsInnerEmailStyle */ 'button_color'?: string | null; } /** * Definition of the webpage style * @export * @interface ListCampaigns200ResponseCampaignsInnerWebpageStyle */ export interface ListCampaigns200ResponseCampaignsInnerWebpageStyle { /** * Headline for the reward page * @type {string} * @memberof ListCampaigns200ResponseCampaignsInnerWebpageStyle */ 'headline'?: string | null; /** * Message for the reward page * @type {string} * @memberof ListCampaigns200ResponseCampaignsInnerWebpageStyle */ 'message'?: string | null; /** * URL of a publicly-accessible image (png, jpeg, jpg, gif, or svg). This image will be copied to our storage location. * @type {string} * @memberof ListCampaigns200ResponseCampaignsInnerWebpageStyle */ 'logo_image_url'?: string | null; /** * Image height in pixels * @type {number} * @memberof ListCampaigns200ResponseCampaignsInnerWebpageStyle */ 'logo_image_height_px'?: number | null; /** * Logo background color code (hex, rgb, or rgba) * @type {string} * @memberof ListCampaigns200ResponseCampaignsInnerWebpageStyle */ 'logo_background_color'?: string | null; /** * Background color code (hex, rgb, or rgba) * @type {string} * @memberof ListCampaigns200ResponseCampaignsInnerWebpageStyle */ 'background_color'?: string | null; } /** * * @export * @interface ListConnectedOrganizationMembers200Response */ export interface ListConnectedOrganizationMembers200Response { /** * * @type {Array} * @memberof ListConnectedOrganizationMembers200Response */ 'connected_organization_members': Array; /** * The total number of connected organizations across all pages * @type {number} * @memberof ListConnectedOrganizationMembers200Response */ 'total_count': number; } /** * * @export * @interface ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInner */ export interface ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInner { /** * Tremendous\' identifier for the connected organization member. * @type {string} * @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInner */ 'id': string; /** * The name associated with the user in your systems. * @type {string} * @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInner */ 'external_name'?: string | null; /** * The email associated with the user in your systems. * @type {string} * @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInner */ 'external_email'?: string | null; /** * Timestamp of when the connected organization member was created. * @type {string} * @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInner */ 'created_at': string; /** * Tremendous\' identifier for the connected organization. * @type {string} * @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInner */ 'connected_organization_id': string; /** * * @type {ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember} * @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInner */ 'member'?: ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember | null; } /** * Associated `member`. `null` until the registration flow for the connected organization has been completed. * @export * @interface ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember */ export interface ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember { /** * * @type {string} * @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember */ 'id': string; /** * Email address of the member * @type {string} * @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember */ 'email': string; /** * Full name of the member * @type {string} * @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember */ 'name': string | null; /** * Is this member currently active in the organization. If `false`, the member will not be able to access the organization. * @type {boolean} * @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember */ 'active'?: boolean; /** * The role ID associated with the member within the organization. * @type {string} * @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember */ 'role'?: string | null; /** * Current status of the member\'s account. When creating a member it starts out in the status `INVITED`. As soon as that member open the invitation link and registers an account, the status switches to `REGISTERED`. * @type {string} * @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember */ 'status': ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMemberStatusEnum; /** * Timestamp when this member was created. The `created_at` timestamp is **NOT** returned when retrieving a member (but is part of the response when listing or creating members). * @type {string} * @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember */ 'created_at'?: string; /** * Timestamp when this member most recently logged into the dashboard of the organization associated with this API key. * @type {string} * @memberof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMember */ 'last_login_at'?: string | null; } export declare const ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMemberStatusEnum: { readonly Registered: "REGISTERED"; readonly Invited: "INVITED"; }; export type ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMemberStatusEnum = typeof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMemberStatusEnum[keyof typeof ListConnectedOrganizationMembers200ResponseConnectedOrganizationMembersInnerMemberStatusEnum]; /** * * @export * @interface ListConnectedOrganizations200Response */ export interface ListConnectedOrganizations200Response { /** * * @type {Array} * @memberof ListConnectedOrganizations200Response */ 'connected_organizations': Array; /** * The total number of connected organizations across all pages * @type {number} * @memberof ListConnectedOrganizations200Response */ 'total_count': number; } /** * * @export * @interface ListConnectedOrganizations200ResponseConnectedOrganizationsInner */ export interface ListConnectedOrganizations200ResponseConnectedOrganizationsInner { /** * Tremendous\' identifier for the connected organization. * @type {string} * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInner */ 'id': string; /** * Client ID of the OAuth app that is to be used by the platform once the integration is complete. * @type {string} * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInner */ 'client_id': string; /** * Timestamp of when the connected organization was created. * @type {string} * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInner */ 'created_at': string; /** * * @type {ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization} * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInner */ 'organization'?: ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization | null; /** * * @type {ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails} * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInner */ 'prefilled_kyb_details'?: ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails | null; } /** * Associated `organization` resource. `null` until the registration flow for the connected organization has been completed. * @export * @interface ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization */ export interface ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization { /** * * @type {string} * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization */ 'id'?: string; /** * Name of the organization * @type {string} * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization */ 'name': string; /** * URL of the website of that organization * @type {string} * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization */ 'website': string; /** * Currency used for this organization\'s balances, orders, and transactions. * @type {string} * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization */ 'currency_code'?: string; /** * Status of the organization. Organizations need to be approved to be able to use them to send out rewards. * @type {string} * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization */ 'status'?: ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganizationStatusEnum; /** * Timestamp of when the organization has been created. *This field is only returned when creating an organization.* It is not returned anymore when retrieving or listing organizations. * @type {string} * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganization */ 'created_at'?: string; } export declare const ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganizationStatusEnum: { readonly Pending: "PENDING"; readonly Approved: "APPROVED"; readonly Rejected: "REJECTED"; }; export type ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganizationStatusEnum = typeof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganizationStatusEnum[keyof typeof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerOrganizationStatusEnum]; /** * The optional KYB details forwarded when the connected organization was created (see the `kyb` request object), stored to pre-fill the end client\'s onboarding form. Only returned on the create response — it is omitted from the list, retrieve, and delete responses and from webhook payloads. `null` when no KYB details were provided. * @export * @interface ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails */ export interface ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails { /** * The registered legal name of the company. * @type {string} * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails */ 'company_name'?: string; /** * The trade name (DBA) the company operates under, if different from its legal name. * @type {string} * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails */ 'doing_business_as'?: string; /** * The company\'s legal entity type. Free-form text — any value is accepted to support entity types outside the common presets. Common values are `Sole proprietorship`, `Corporation (Inc)`, `Limited liability company (LLC)`, `Limited liability partnership (LLP)`, `Public limited company (PLC)`, and `Private limited company (LTD)`. * @type {string} * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails */ 'company_structure'?: string; /** * The company\'s tax ID or registration number. * @type {string} * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails */ 'company_registration_number'?: string; /** * The ISO 3166-1 alpha-2 country code of the company. * @type {string} * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails */ 'country_code'?: string; /** * The company\'s website URL. * @type {string} * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails */ 'website_url'?: string; /** * * @type {ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress} * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetails */ 'address'?: ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress; } /** * The company\'s address. * @export * @interface ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress */ export interface ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress { /** * Street address. * @type {string} * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress */ 'line1'?: string; /** * City. * @type {string} * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress */ 'city'?: string; /** * State, province, or region. * @type {string} * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress */ 'state'?: string; /** * ZIP or postal code. * @type {string} * @memberof ListConnectedOrganizations200ResponseConnectedOrganizationsInnerPrefilledKybDetailsAddress */ 'zip'?: string; } /** * * @export * @interface ListFields200Response */ export interface ListFields200Response { /** * * @type {Array} * @memberof ListFields200Response */ 'fields'?: Array; } /** * * @export * @interface ListFields200ResponseFieldsInner */ export interface ListFields200ResponseFieldsInner { /** * * @type {string} * @memberof ListFields200ResponseFieldsInner */ 'id'?: string; /** * Label of the field * @type {string} * @memberof ListFields200ResponseFieldsInner */ 'label'?: string; /** * Type of the values of the field
Type Description
Checkbox A boolean value (true/false)
Currency A monetary value
Date A date value
Dropdown A single selection from predefined options (see data.options)
Email An email address
List Multiple selections from predefined options (see data.options)
Number A numeric value
Phone A phone number
Text A single-line text value
TextArea A multi-line text value
* @type {string} * @memberof ListFields200ResponseFieldsInner */ 'data_type'?: ListFields200ResponseFieldsInnerDataTypeEnum; /** * * @type {ListFields200ResponseFieldsInnerData} * @memberof ListFields200ResponseFieldsInner */ 'data'?: ListFields200ResponseFieldsInnerData; /** * Is this field required (true) or optional (false) * @type {boolean} * @memberof ListFields200ResponseFieldsInner */ 'required'?: boolean; /** * Type of objects this field gets associated with * @type {string} * @memberof ListFields200ResponseFieldsInner */ 'scope'?: string; } export declare const ListFields200ResponseFieldsInnerDataTypeEnum: { readonly Checkbox: "Checkbox"; readonly Currency: "Currency"; readonly Date: "Date"; readonly Dropdown: "Dropdown"; readonly Email: "Email"; readonly List: "List"; readonly Number: "Number"; readonly Phone: "Phone"; readonly Text: "Text"; readonly TextArea: "TextArea"; }; export type ListFields200ResponseFieldsInnerDataTypeEnum = typeof ListFields200ResponseFieldsInnerDataTypeEnum[keyof typeof ListFields200ResponseFieldsInnerDataTypeEnum]; /** * Additional configuration for the field. Only used for `Dropdown` and `List` data types. * @export * @interface ListFields200ResponseFieldsInnerData */ export interface ListFields200ResponseFieldsInnerData { /** * List of valid options for `Dropdown` and `List` field types. For `Dropdown`, the user selects one option. For `List`, the user can select multiple options. * @type {Array} * @memberof ListFields200ResponseFieldsInnerData */ 'options'?: Array; /** * Optional human-readable labels for each option. Keys are the option values, values are the display labels. If not provided, the option values are used as labels. * @type {{ [key: string]: string; }} * @memberof ListFields200ResponseFieldsInnerData */ 'labels'?: { [key: string]: string; }; } /** * * @export * @interface ListForexResponse */ export interface ListForexResponse { /** * * @type {{ [key: string]: number; }} * @memberof ListForexResponse */ 'forex': { [key: string]: number; }; } /** * * @export * @interface ListFraudReviews200Response */ export interface ListFraudReviews200Response { /** * * @type {Array} * @memberof ListFraudReviews200Response */ 'fraud_reviews': Array; /** * The total number of fraud reviews * @type {number} * @memberof ListFraudReviews200Response */ 'total_count': number; } /** * The fraud review associated with a reward. * @export * @interface ListFraudReviews200ResponseFraudReviewsInner */ export interface ListFraudReviews200ResponseFraudReviewsInner { /** * The current status of the fraud review: * `flagged` - The reward has been flagged for and waiting manual review. * `blocked` - The reward was reviewed and blocked. * `released` - The reward was reviewed and released. * @type {string} * @memberof ListFraudReviews200ResponseFraudReviewsInner */ 'status'?: ListFraudReviews200ResponseFraudReviewsInnerStatusEnum; /** * The array may contain multiple reasons, depending on which rule(s) flagged the reward for review. Reasons can be any of the following: * `Disallowed IP` * `Disallowed email` * `Disallowed country` * `Over reward amount limit` * `Over reward count limit` * `VPN detected` * `Apple Private Relay` * `Device related to multiple emails` * `Device or account related to multiple emails` * `IP on a Tremendous fraud list` * `Bank account on a Tremendous fraud list` * `Fingerprint on a Tremendous fraud list` * `Email on a Tremendous fraud list` * `Phone on a Tremendous fraud list` * `Device on a Tremendous fraud list` * `IP related to a blocked reward` * `Device related to a blocked reward` * `Bank account related to a blocked reward` * `Fingerprint related to a blocked reward` * `Email related to a blocked reward` * `Phone related to a blocked reward` * `Allowed IP` * `Allowed email` * `Allowed country` * @type {Array} * @memberof ListFraudReviews200ResponseFraudReviewsInner */ 'reasons'?: Array; /** * The device fingerprint, if known. * @type {string} * @memberof ListFraudReviews200ResponseFraudReviewsInner */ 'device_id'?: string; /** * The product selected to claim the reward * @type {string} * @memberof ListFraudReviews200ResponseFraudReviewsInner */ 'redemption_method'?: ListFraudReviews200ResponseFraudReviewsInnerRedemptionMethodEnum; /** * Date the reward was redeemed * @type {string} * @memberof ListFraudReviews200ResponseFraudReviewsInner */ 'redeemed_at'?: string; /** * * @type {ListFraudReviews200ResponseFraudReviewsInnerGeo} * @memberof ListFraudReviews200ResponseFraudReviewsInner */ 'geo'?: ListFraudReviews200ResponseFraudReviewsInnerGeo; /** * * @type {ListRewards200ResponseRewardsInner} * @memberof ListFraudReviews200ResponseFraudReviewsInner */ 'reward'?: ListRewards200ResponseRewardsInner; /** * The name of the person who reviewed the reward, or `Automatic Review` if the reward was blocked automatically. Rewards can be automatically blocked if they remain in the flagged fraud queue for more than 30 days. This field is only present if the status is not `flagged`. * @type {string} * @memberof ListFraudReviews200ResponseFraudReviewsInner */ 'reviewed_by'?: string; /** * When the reward was blocked or released following fraud review. This field is only present if the status is not `flagged`. * @type {string} * @memberof ListFraudReviews200ResponseFraudReviewsInner */ 'reviewed_at'?: string; /** * A hash of the destination account for redemption methods that require providing 3rd party account details (e.g., PayPal, Venmo, ACH/CashApp, international bank transfers, etc.). The hash is globally unique by redemption method + account combination. This field is omitted for redemption methods that don\'t have a destination account (e.g., merchant cards, charities, etc.). * @type {string} * @memberof ListFraudReviews200ResponseFraudReviewsInner */ 'redemption_method_account_hash'?: string; } export declare const ListFraudReviews200ResponseFraudReviewsInnerStatusEnum: { readonly Flagged: "flagged"; readonly Blocked: "blocked"; readonly Released: "released"; }; export type ListFraudReviews200ResponseFraudReviewsInnerStatusEnum = typeof ListFraudReviews200ResponseFraudReviewsInnerStatusEnum[keyof typeof ListFraudReviews200ResponseFraudReviewsInnerStatusEnum]; export declare const ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum: { readonly DisallowedIp: "Disallowed IP"; readonly DisallowedEmail: "Disallowed email"; readonly DisallowedCountry: "Disallowed country"; readonly OverRewardAmountLimit: "Over reward amount limit"; readonly OverRewardCountLimit: "Over reward count limit"; readonly VpnDetected: "VPN detected"; readonly ApplePrivateRelay: "Apple Private Relay"; readonly DeviceRelatedToMultipleEmails: "Device related to multiple emails"; readonly DeviceOrAccountRelatedToMultipleEmails: "Device or account related to multiple emails"; readonly IpOnATremendousFraudList: "IP on a Tremendous fraud list"; readonly BankAccountOnATremendousFraudList: "Bank account on a Tremendous fraud list"; readonly FingerprintOnATremendousFraudList: "Fingerprint on a Tremendous fraud list"; readonly EmailOnATremendousFraudList: "Email on a Tremendous fraud list"; readonly PhoneOnATremendousFraudList: "Phone on a Tremendous fraud list"; readonly DeviceOnATremendousFraudList: "Device on a Tremendous fraud list"; readonly IpRelatedToABlockedReward: "IP related to a blocked reward"; readonly DeviceRelatedToABlockedReward: "Device related to a blocked reward"; readonly BankAccountRelatedToABlockedReward: "Bank account related to a blocked reward"; readonly FingerprintRelatedToABlockedReward: "Fingerprint related to a blocked reward"; readonly EmailRelatedToABlockedReward: "Email related to a blocked reward"; readonly PhoneRelatedToABlockedReward: "Phone related to a blocked reward"; readonly AllowedIp: "Allowed IP"; readonly AllowedEmail: "Allowed email"; readonly AllowedCountry: "Allowed country"; }; export type ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum = typeof ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum[keyof typeof ListFraudReviews200ResponseFraudReviewsInnerReasonsEnum]; export declare const ListFraudReviews200ResponseFraudReviewsInnerRedemptionMethodEnum: { readonly BankTransfer: "bank transfer"; readonly Charity: "charity"; readonly InstantDebitTransfer: "instant debit transfer"; readonly InternationalBankTransfer: "international bank transfer"; readonly MerchantCard: "merchant card"; readonly Paypal: "paypal"; readonly Venmo: "venmo"; readonly VisaCard: "visa card"; }; export type ListFraudReviews200ResponseFraudReviewsInnerRedemptionMethodEnum = typeof ListFraudReviews200ResponseFraudReviewsInnerRedemptionMethodEnum[keyof typeof ListFraudReviews200ResponseFraudReviewsInnerRedemptionMethodEnum]; /** * The Geo location, based on the recipient\'s IP. * @export * @interface ListFraudReviews200ResponseFraudReviewsInnerGeo */ export interface ListFraudReviews200ResponseFraudReviewsInnerGeo { /** * The recipient\'s IP. * @type {string} * @memberof ListFraudReviews200ResponseFraudReviewsInnerGeo */ 'ip'?: string; /** * The country code (ISO-3166 alpha-2 character code) linked to the recipient\'s IP. * @type {string} * @memberof ListFraudReviews200ResponseFraudReviewsInnerGeo */ 'country'?: string; /** * The city associated with the recipient\'s IP. * @type {string} * @memberof ListFraudReviews200ResponseFraudReviewsInnerGeo */ 'city'?: string; } /** * * @export * @interface ListFraudRules200Response */ export interface ListFraudRules200Response { /** * * @type {Array} * @memberof ListFraudRules200Response */ 'fraud_rules': Array; } /** * An active fraud rule * @export * @interface ListFraudRules200ResponseFraudRulesInner */ export interface ListFraudRules200ResponseFraudRulesInner { /** * * `review_country` - Flags when the recipient\'s IP country matches the criteria in the rule * `review_ip` - Flags when recipient\'s IP matches one in the list * `review_email` - Flags when the recipient\'s email matches one in the list * `review_redeemed_rewards_count` - Flags when the recipient redeemed more than the number of rewards specified in the config * `review_redeemed_rewards_amount` - Flags when the recipient redeemed more than the total amount specified in the config. The amount is denominated in the organization\'s currency. * `review_multiple_emails` - Flags when recipient\'s device or account has multiple emails associated * `review_vpn` - Flags when VPN or proxy use is suspected. Can be configured to exclude Apple Private Relay. * `review_tremendous_flag_list` - Flags rewards when redemption attributes match at least one criteria defined by the Tremendous flag list * `review_previously_blocked_recipients` - Flags rewards when the recipient has been blocked before * `allow_ip` - Releases a reward when a recipient\'s IP matches one in the list * `allow_email` - Releases a reward when the recipient\'s email matches one in the list * @type {string} * @memberof ListFraudRules200ResponseFraudRulesInner */ 'rule_type'?: ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum; /** * The configuration associated with the rule. The properties allowed depend on the type of rule. This property is only present for rules that require configuration. * @type {{ [key: string]: any; }} * @memberof ListFraudRules200ResponseFraudRulesInner */ 'config'?: { [key: string]: any; } | null; } export declare const ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum: { readonly ReviewCountry: "review_country"; readonly ReviewIp: "review_ip"; readonly ReviewEmail: "review_email"; readonly ReviewRedeemedRewardsCount: "review_redeemed_rewards_count"; readonly ReviewRedeemedRewardsAmount: "review_redeemed_rewards_amount"; readonly ReviewMultipleEmails: "review_multiple_emails"; readonly ReviewVpn: "review_vpn"; readonly ReviewTremendousFlagList: "review_tremendous_flag_list"; readonly ReviewPreviouslyBlockedRecipients: "review_previously_blocked_recipients"; readonly AllowIp: "allow_ip"; readonly AllowEmail: "allow_email"; }; export type ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum = typeof ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum[keyof typeof ListFraudRules200ResponseFraudRulesInnerRuleTypeEnum]; /** * * @export * @interface ListFundingSources200Response */ export interface ListFundingSources200Response { /** * * @type {Array} * @memberof ListFundingSources200Response */ 'funding_sources': Array; } /** * * @export * @interface ListFundingSources200ResponseFundingSourcesInner */ export interface ListFundingSources200ResponseFundingSourcesInner { /** * * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInner */ 'id': string; /** * You can pay for rewards using different payment methods on Tremendous:
Payment Method Description
balance Pre-funded balance in your Tremendous account to draw funds from to send rewards to recipients.
bank_account Bank account to draw funds from to send rewards to recipients.
credit_card Credit card to draw funds from to send rewards to recipients.
invoice Send rewards to recipients and pay by invoice.
* @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInner */ 'method': ListFundingSources200ResponseFundingSourcesInnerMethodEnum; /** * Indicates which actions this funding source can perform.
Permission Description
api_orders Usable for orders via API.
dashboard_orders Usable for orders via Tremendous dashboard.
balance_funding Usable to add funds to a balance (via dashboard or API).
* @type {Array} * @memberof ListFundingSources200ResponseFundingSourcesInner */ 'usage_permissions'?: Array; /** * Status of the funding_source
Status Description
active Ready for use.
deleted Manually removed, and not usable.
failed Last payment attempt failed, and not usable (contact Tremendous support to reinstate).
* @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInner */ 'status'?: ListFundingSources200ResponseFundingSourcesInnerStatusEnum; /** * **Only available when `method` is set to `invoice`.** * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInner */ 'type'?: ListFundingSources200ResponseFundingSourcesInnerTypeEnum; /** * * @type {ListFundingSources200ResponseFundingSourcesInnerMeta} * @memberof ListFundingSources200ResponseFundingSourcesInner */ 'meta': ListFundingSources200ResponseFundingSourcesInnerMeta; } export declare const ListFundingSources200ResponseFundingSourcesInnerMethodEnum: { readonly Balance: "balance"; readonly BankAccount: "bank_account"; readonly CreditCard: "credit_card"; readonly Invoice: "invoice"; }; export type ListFundingSources200ResponseFundingSourcesInnerMethodEnum = typeof ListFundingSources200ResponseFundingSourcesInnerMethodEnum[keyof typeof ListFundingSources200ResponseFundingSourcesInnerMethodEnum]; export declare const ListFundingSources200ResponseFundingSourcesInnerUsagePermissionsEnum: { readonly ApiOrders: "api_orders"; readonly DashboardOrders: "dashboard_orders"; readonly BalanceFunding: "balance_funding"; }; export type ListFundingSources200ResponseFundingSourcesInnerUsagePermissionsEnum = typeof ListFundingSources200ResponseFundingSourcesInnerUsagePermissionsEnum[keyof typeof ListFundingSources200ResponseFundingSourcesInnerUsagePermissionsEnum]; export declare const ListFundingSources200ResponseFundingSourcesInnerStatusEnum: { readonly Active: "active"; readonly Deleted: "deleted"; readonly Failed: "failed"; }; export type ListFundingSources200ResponseFundingSourcesInnerStatusEnum = typeof ListFundingSources200ResponseFundingSourcesInnerStatusEnum[keyof typeof ListFundingSources200ResponseFundingSourcesInnerStatusEnum]; export declare const ListFundingSources200ResponseFundingSourcesInnerTypeEnum: { readonly Commercial: "COMMERCIAL"; readonly ProForma: "PRO_FORMA"; readonly PrefundingOnly: "PREFUNDING_ONLY"; }; export type ListFundingSources200ResponseFundingSourcesInnerTypeEnum = typeof ListFundingSources200ResponseFundingSourcesInnerTypeEnum[keyof typeof ListFundingSources200ResponseFundingSourcesInnerTypeEnum]; /** * * @export * @interface ListFundingSources200ResponseFundingSourcesInnerMeta */ export interface ListFundingSources200ResponseFundingSourcesInnerMeta { /** * **Only exists for balance and commercial invoicing.** For balance: available amount denominated in `currency_code`. For commercial invoicing: available credit amount denominated in `currency_code`, calculated as (credit limit - outstanding balance). *Caution: In the \"list funding sources\" endpoint this value is cached and may not be up to date. Use the \"get funding source\" endpoint to get the most up to date value.* * @type {number} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'available_amount'?: number; /** * Same as `available_amount`, but in cents. * @type {number} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta * @deprecated */ 'available_cents'?: number; /** * **Only exists for balance and commercial invoicing.** The currency of the balance or credit amounts (e.g. `available_amount`, `pending_amount`, `credit_limit_amount`). Always matches the organization\'s currency. * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'currency_code'?: string; /** * **Only available when `method` is set to `balance`.** Funds registered on your Tremendous account but not yet deposited in your account (e.g. payments that need to be manually reviewed by our ops team). Denominated in `currency_code`. * @type {number} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'pending_amount'?: number; /** * Same as `pending_amount`, but in cents. * @type {number} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta * @deprecated */ 'pending_cents'?: number; /** * **Only exists for commercial invoicing.** Available credit limit denominated in `currency_code`. * @type {number} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'credit_limit_amount'?: number; /** * Same as `credit_limit_amount`, but in cents. * @type {number} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta * @deprecated */ 'credit_limit_cents'?: number; /** * **Only available when `method` is set to `bank_account` or `credit_card`.** Name of the holder of the bank account or credit_card * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'accountholder_name'?: string; /** * **Only available when `method` is set to `bank_account`.** Is this a checking or savings account * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'account_type'?: ListFundingSources200ResponseFundingSourcesInnerMetaAccountTypeEnum; /** * **Only available when `method` is set to `bank_account`.** Name of the bank * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'bank_name'?: string | null; /** * **Only available when `method` is set to `bank_account`.** Last 4 digits of the account number * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'account_number_mask'?: string; /** * **Only available when `method` is set to `bank_account`.** Last 4 digits of the routing number * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'account_routing_mask'?: string; /** * **Only available when `method` is set to `bank_account`.** Can refunds be deposited to this bank account * @type {boolean} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'refundable'?: boolean; /** * **Only available when `method` is set to `credit_card`.** Network of the credit card * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'network'?: ListFundingSources200ResponseFundingSourcesInnerMetaNetworkEnum; /** * **Only available when `method` is set to `credit_card`.** Last 4 digits of the credit card number * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'last4'?: string; /** * **Only available when `method` is set to `credit_card`.** Is this credit card expired * @type {boolean} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'expired'?: boolean; /** * **Only available when `method` is set to `credit_card`.** Year part of card\'s expiration date * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'year'?: string; /** * **Only available when `method` is set to `credit_card`.** Month part of card\'s expiration date * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'month'?: string; /** * **Only available when `method` is set to `bank_account` or `credit_card`.** Point in time when the last order failed using this bank account or credit card as a funding source. * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'last_payment_failed_at'?: string | null; /** * **Only available when `method` is set to `invoice`.** Type of invoice account (e.g., commercial, pro_forma, prefunding_only) * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'invoice_type'?: string; /** * **Only available when `method` is set to `invoice` and `invoice_type` is `commercial`.** Billing interval for commercial invoice generation (e.g., daily, weekly, monthly, twice_monthly). Returns `null` for pro forma invoices. * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'interval'?: string | null; /** * **Only available when `method` is set to `invoice` and `invoice_type` is `commercial`.** Day of the week when commercial invoices are generated (\"0\"=Sunday, \"1\"=Monday, etc.). Returns `null` for pro forma invoices. * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'day_of_week'?: string | null; /** * **Only available when `method` is set to `invoice`.** Net payment terms in days (e.g., \"30\" for Net 30) * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'net'?: string; /** * **Only available when `method` is set to `invoice`.** Company name for invoice billing * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'company_name'?: string; /** * **Only available when `method` is set to `invoice`.** Primary billing address line * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'address_1'?: string | null; /** * **Only available when `method` is set to `invoice`.** Secondary billing address line * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'address_2'?: string | null; /** * **Only available when `method` is set to `invoice`.** Billing address city * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'city'?: string | null; /** * **Only available when `method` is set to `invoice`.** Billing address state or province * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'state'?: string | null; /** * **Only available when `method` is set to `invoice`.** Billing address postal code * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'zip'?: string | null; /** * **Only available when `method` is set to `invoice`.** Contact phone number for billing * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'phone'?: string | null; /** * **Only available when `method` is set to `invoice`.** Email addresses for invoice delivery (comma-separated) * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'emails'?: string | null; /** * * @type {ListFundingSources200ResponseFundingSourcesInnerMetaFailureDetails} * @memberof ListFundingSources200ResponseFundingSourcesInnerMeta */ 'failure_details'?: ListFundingSources200ResponseFundingSourcesInnerMetaFailureDetails | null; } export declare const ListFundingSources200ResponseFundingSourcesInnerMetaAccountTypeEnum: { readonly Checking: "checking"; readonly Savings: "savings"; }; export type ListFundingSources200ResponseFundingSourcesInnerMetaAccountTypeEnum = typeof ListFundingSources200ResponseFundingSourcesInnerMetaAccountTypeEnum[keyof typeof ListFundingSources200ResponseFundingSourcesInnerMetaAccountTypeEnum]; export declare const ListFundingSources200ResponseFundingSourcesInnerMetaNetworkEnum: { readonly MasterCard: "MasterCard"; readonly Amex: "Amex"; readonly Jcb: "JCB"; readonly DinersClub: "Diner's Club"; readonly Visa: "Visa"; readonly Discover: "Discover"; readonly Laser: "Laser"; readonly Elo: "Elo"; readonly Maestro: "Maestro"; readonly Solo: "Solo"; }; export type ListFundingSources200ResponseFundingSourcesInnerMetaNetworkEnum = typeof ListFundingSources200ResponseFundingSourcesInnerMetaNetworkEnum[keyof typeof ListFundingSources200ResponseFundingSourcesInnerMetaNetworkEnum]; /** * * @export * @interface ListFundingSources200ResponseFundingSourcesInnerMetaFailureDetails */ export interface ListFundingSources200ResponseFundingSourcesInnerMetaFailureDetails { /** * Payment error code * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMetaFailureDetails */ 'return_code'?: string; /** * Explanation of the payment error * @type {string} * @memberof ListFundingSources200ResponseFundingSourcesInnerMetaFailureDetails */ 'description'?: string; } /** * * @export * @interface ListInvoices200Response */ export interface ListInvoices200Response { /** * * @type {Array} * @memberof ListInvoices200Response */ 'invoices': Array; /** * The total number of invoices across all pages * @type {number} * @memberof ListInvoices200Response */ 'total_count': number; } /** * Invoices are instruments to fund your Tremendous account\'s balance. Invoices can be created by your organization programatically. Once we receive your payment, the invoice is marked as `PAID` and we add the respective funds to your account\'s balance. * @export * @interface ListInvoices200ResponseInvoicesInner */ export interface ListInvoices200ResponseInvoicesInner { /** * The invoice number * @type {string} * @memberof ListInvoices200ResponseInvoicesInner */ 'id': string; /** * Reference to the purchase order number within your organization * @type {string} * @memberof ListInvoices200ResponseInvoicesInner */ 'po_number'?: string | null; /** * Amount of the invoice * @type {number} * @memberof ListInvoices200ResponseInvoicesInner */ 'amount': number; /** * Currency of the invoice * @type {string} * @memberof ListInvoices200ResponseInvoicesInner */ 'currency_code'?: ListInvoices200ResponseInvoicesInnerCurrencyCodeEnum; /** * Deprecated: Use `currency_code` instead. * @type {string} * @memberof ListInvoices200ResponseInvoicesInner * @deprecated */ 'currency'?: ListInvoices200ResponseInvoicesInnerCurrencyEnum; /** * * @type {boolean} * @memberof ListInvoices200ResponseInvoicesInner */ 'international'?: boolean; /** * Status of this invoice
Status Description
DELETED Invoice has been deleted by your organization
PAID Invoice has been paid by your organization
OPEN Invoice has been created by your organization but has not been paid, yet
* @type {string} * @memberof ListInvoices200ResponseInvoicesInner */ 'status': ListInvoices200ResponseInvoicesInnerStatusEnum; /** * List of orders related to the invoice (it doesn\'t apply to prefunding) * @type {Array} * @memberof ListInvoices200ResponseInvoicesInner */ 'orders'?: Array; /** * List of rewards related to the invoice (it doesn\'t apply to prefunding) * @type {Array} * @memberof ListInvoices200ResponseInvoicesInner */ 'rewards'?: Array; /** * Timestamp of when the invoice has been created. * @type {string} * @memberof ListInvoices200ResponseInvoicesInner */ 'created_at': string; /** * Timestamp of when the invoice has been paid. * @type {string} * @memberof ListInvoices200ResponseInvoicesInner */ 'paid_at': string | null; } export declare const ListInvoices200ResponseInvoicesInnerCurrencyCodeEnum: { readonly Usd: "USD"; readonly Eur: "EUR"; readonly Gbp: "GBP"; }; export type ListInvoices200ResponseInvoicesInnerCurrencyCodeEnum = typeof ListInvoices200ResponseInvoicesInnerCurrencyCodeEnum[keyof typeof ListInvoices200ResponseInvoicesInnerCurrencyCodeEnum]; export declare const ListInvoices200ResponseInvoicesInnerCurrencyEnum: { readonly Usd: "USD"; readonly Eur: "EUR"; readonly Gbp: "GBP"; }; export type ListInvoices200ResponseInvoicesInnerCurrencyEnum = typeof ListInvoices200ResponseInvoicesInnerCurrencyEnum[keyof typeof ListInvoices200ResponseInvoicesInnerCurrencyEnum]; export declare const ListInvoices200ResponseInvoicesInnerStatusEnum: { readonly Deleted: "DELETED"; readonly Paid: "PAID"; readonly Open: "OPEN"; readonly MarkedAsPaid: "MARKED_AS_PAID"; }; export type ListInvoices200ResponseInvoicesInnerStatusEnum = typeof ListInvoices200ResponseInvoicesInnerStatusEnum[keyof typeof ListInvoices200ResponseInvoicesInnerStatusEnum]; /** * * @export * @interface ListMembers200Response */ export interface ListMembers200Response { /** * * @type {Array} * @memberof ListMembers200Response */ 'members': Array; } /** * Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. * @export * @interface ListMembers200ResponseMembersInner */ export interface ListMembers200ResponseMembersInner { /** * * @type {string} * @memberof ListMembers200ResponseMembersInner */ 'id': string; /** * Email address of the member * @type {string} * @memberof ListMembers200ResponseMembersInner */ 'email': string; /** * Full name of the member * @type {string} * @memberof ListMembers200ResponseMembersInner */ 'name': string | null; /** * Is this member currently active in the organization. If `false`, the member will not be able to access the organization. * @type {boolean} * @memberof ListMembers200ResponseMembersInner */ 'active'?: boolean; /** * The role ID associated with the member within the organization. * @type {string} * @memberof ListMembers200ResponseMembersInner */ 'role'?: string | null; /** * Current status of the member\'s account. When creating a member it starts out in the status `INVITED`. As soon as that member open the invitation link and registers an account, the status switches to `REGISTERED`. * @type {string} * @memberof ListMembers200ResponseMembersInner */ 'status': ListMembers200ResponseMembersInnerStatusEnum; /** * Timestamp when this member was created. The `created_at` timestamp is **NOT** returned when retrieving a member (but is part of the response when listing or creating members). * @type {string} * @memberof ListMembers200ResponseMembersInner */ 'created_at'?: string; /** * Timestamp when this member most recently logged into the dashboard of the organization associated with this API key. * @type {string} * @memberof ListMembers200ResponseMembersInner */ 'last_login_at'?: string | null; } export declare const ListMembers200ResponseMembersInnerStatusEnum: { readonly Registered: "REGISTERED"; readonly Invited: "INVITED"; }; export type ListMembers200ResponseMembersInnerStatusEnum = typeof ListMembers200ResponseMembersInnerStatusEnum[keyof typeof ListMembers200ResponseMembersInnerStatusEnum]; /** * * @export * @interface ListOrders200Response */ export interface ListOrders200Response { /** * * @type {Array} * @memberof ListOrders200Response */ 'orders': Array; /** * The total number of orders across all pages * @type {number} * @memberof ListOrders200Response */ 'total_count': number; } /** * An order wraps around the fulfilment of one or more rewards. * @export * @interface ListOrders200ResponseOrdersInner */ export interface ListOrders200ResponseOrdersInner { /** * Tremendous ID of the order * @type {string} * @memberof ListOrders200ResponseOrdersInner */ 'id': string; /** * Reference for this order, supplied by the customer. When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders. It also allows for retrieving by `external_id` instead of `id` only. * @type {string} * @memberof ListOrders200ResponseOrdersInner */ 'external_id'?: string | null; /** * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from. * @type {string} * @memberof ListOrders200ResponseOrdersInner */ 'campaign_id'?: string | null; /** * Date the order was created * @type {string} * @memberof ListOrders200ResponseOrdersInner */ 'created_at': string; /** * Execution status of a given order
Status Description
CANCELED The order and all of its rewards were canceled.
OPEN The order has been created, but hasn\'t yet been processed.
EXECUTED The order has been executed. Payment has been handled and rewards are being delivered (if applicable).
FAILED The order could not be processed due to an error. E.g. due to insufficient funds in the account.
PENDING APPROVAL The order has been created but needs approval to be executed.
PENDING INTERNAL PAYMENT APPROVAL The order has been created but it is under review and requires approval from our team.
PENDING SETTLEMENT The order has been created but the funds are being held until the settlement window clears.
* @type {string} * @memberof ListOrders200ResponseOrdersInner */ 'status': ListOrders200ResponseOrdersInnerStatusEnum; /** * Name of the channel in which the order was created * @type {string} * @memberof ListOrders200ResponseOrdersInner */ 'channel'?: ListOrders200ResponseOrdersInnerChannelEnum; /** * * @type {ListOrders200ResponseOrdersInnerPayment} * @memberof ListOrders200ResponseOrdersInner */ 'payment'?: ListOrders200ResponseOrdersInnerPayment; /** * The ID for the invoice associated with this order * @type {string} * @memberof ListOrders200ResponseOrdersInner */ 'invoice_id'?: string; /** * * @type {Array} * @memberof ListOrders200ResponseOrdersInner */ 'rewards'?: Array; } export declare const ListOrders200ResponseOrdersInnerStatusEnum: { readonly Canceled: "CANCELED"; readonly Open: "OPEN"; readonly Executed: "EXECUTED"; readonly Failed: "FAILED"; readonly PendingApproval: "PENDING APPROVAL"; readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL"; readonly PendingSettlement: "PENDING SETTLEMENT"; }; export type ListOrders200ResponseOrdersInnerStatusEnum = typeof ListOrders200ResponseOrdersInnerStatusEnum[keyof typeof ListOrders200ResponseOrdersInnerStatusEnum]; export declare const ListOrders200ResponseOrdersInnerChannelEnum: { readonly Ui: "UI"; readonly Api: "API"; readonly Embed: "EMBED"; readonly Decipher: "DECIPHER"; readonly Qualtrics: "QUALTRICS"; readonly Typeform: "TYPEFORM"; readonly SurveyMonkey: "SURVEY MONKEY"; readonly Yotpo: "YOTPO"; }; export type ListOrders200ResponseOrdersInnerChannelEnum = typeof ListOrders200ResponseOrdersInnerChannelEnum[keyof typeof ListOrders200ResponseOrdersInnerChannelEnum]; /** * Cost breakdown of the order (cost of rewards + fees). Cost and fees are denominated in the organization\'s currency (see payment `currency_code`), independent of the ordered rewards\' currency. Note that this property will only appear for processed orders (`status` is `EXECUTED`). * @export * @interface ListOrders200ResponseOrdersInnerPayment */ export interface ListOrders200ResponseOrdersInnerPayment { /** * Total price of the order before fees, denominated in `currency_code`. * @type {number} * @memberof ListOrders200ResponseOrdersInnerPayment */ 'subtotal': number; /** * Total price of the order including fees, denominated in `currency_code`. * @type {number} * @memberof ListOrders200ResponseOrdersInnerPayment */ 'total': number; /** * Fees for the order, denominated in `currency_code`. * @type {number} * @memberof ListOrders200ResponseOrdersInnerPayment */ 'fees': number; /** * Discount for the order, denominated in `currency_code`. * @type {number} * @memberof ListOrders200ResponseOrdersInnerPayment */ 'discount': number; /** * Currency in which the payment amounts (subtotal, total, fees, discount, refund) are denominated. This always matches the organization\'s currency. * @type {string} * @memberof ListOrders200ResponseOrdersInnerPayment */ 'currency_code': string; /** * * @type {ListOrders200ResponseOrdersInnerPaymentRefund} * @memberof ListOrders200ResponseOrdersInnerPayment */ 'refund'?: ListOrders200ResponseOrdersInnerPaymentRefund; } /** * Breakdown of the order refunds (total denominated in `currency_code`, independent of the ordered rewards\' currency). Note that this property will only appear for canceled orders or orders with canceled rewards. * @export * @interface ListOrders200ResponseOrdersInnerPaymentRefund */ export interface ListOrders200ResponseOrdersInnerPaymentRefund { /** * Total amount of the order refunds, denominated in `currency_code`. * @type {number} * @memberof ListOrders200ResponseOrdersInnerPaymentRefund */ 'total': number; /** * Currency of the refund. Always matches the organization\'s currency. * @type {string} * @memberof ListOrders200ResponseOrdersInnerPaymentRefund */ 'currency_code': string; } /** * * @export * @interface ListOrganizations200Response */ export interface ListOrganizations200Response { /** * * @type {Array} * @memberof ListOrganizations200Response */ 'organizations'?: Array; } /** * Organizations are a way to separate different parts of your business within the same Tremendous account. Your root Tremendous account is an organization itself and can have multiple sub-organizations. You can assign users in your Tremendous team as members to any organization. Users can be members of multiple organizations at once. Each organizations can have it\'s own API key. * @export * @interface ListOrganizations200ResponseOrganizationsInner */ export interface ListOrganizations200ResponseOrganizationsInner { /** * * @type {string} * @memberof ListOrganizations200ResponseOrganizationsInner */ 'id'?: string; /** * Name of the organization * @type {string} * @memberof ListOrganizations200ResponseOrganizationsInner */ 'name': string; /** * URL of the website of that organization * @type {string} * @memberof ListOrganizations200ResponseOrganizationsInner */ 'website': string; /** * Currency used for this organization\'s balances, orders, and transactions. * @type {string} * @memberof ListOrganizations200ResponseOrganizationsInner */ 'currency_code'?: string; /** * Status of the organization. Organizations need to be approved to be able to use them to send out rewards. * @type {string} * @memberof ListOrganizations200ResponseOrganizationsInner */ 'status'?: ListOrganizations200ResponseOrganizationsInnerStatusEnum; /** * Timestamp of when the organization has been created. *This field is only returned when creating an organization.* It is not returned anymore when retrieving or listing organizations. * @type {string} * @memberof ListOrganizations200ResponseOrganizationsInner */ 'created_at'?: string; } export declare const ListOrganizations200ResponseOrganizationsInnerStatusEnum: { readonly Pending: "PENDING"; readonly Approved: "APPROVED"; readonly Rejected: "REJECTED"; }; export type ListOrganizations200ResponseOrganizationsInnerStatusEnum = typeof ListOrganizations200ResponseOrganizationsInnerStatusEnum[keyof typeof ListOrganizations200ResponseOrganizationsInnerStatusEnum]; /** * * @export * @interface ListProductsResponse */ export interface ListProductsResponse { /** * * @type {Array} * @memberof ListProductsResponse */ 'products': Array; } /** * A product represents one way to payout a reward to its recipient. Think: * Amazon.com gift card (ID: `OKMHM2X2OHYV`) * Donations to Save the Children (ID: `ESRNAD533W5A`) * Virtual Visa debit card (ID: `Q24BD9EZ332JT`) each of which is one specific product on Tremendous. > 📘 All available products > > See this [list](https://www.tremendous.com/catalog) Products can be limited in their availability to recipients by * geography (field `countries`) * currency (field `currencies`) * amount of the reward (field `skus`) * e.g. adidas gift cards accept any amount between 5 and 200 USD. See the description of each respective parameter for further details. * @export * @interface ListProductsResponseProductsInner */ export interface ListProductsResponseProductsInner { /** * * @type {string} * @memberof ListProductsResponseProductsInner */ 'id': string; /** * Name of the product * @type {string} * @memberof ListProductsResponseProductsInner */ 'name': string; /** * Detailed description of the product. * @type {string} * @memberof ListProductsResponseProductsInner */ 'description': string; /** * The category of the product
Category Description
ach Bank transfer to the recipient
charity Donations to a charity
instant_debit_transfer Instant debit transfer to the recipient
merchant_card A gift card for a certain merchant (e.g. Amazon)
paypal Payout via PayPal
venmo Payout via Venmo
visa_card Payout in form of a Visa debit card
cash_app Payout via Cash App
international_bank Bank transfer to recipients outside of the US
wallet Payout to a digital wallet (e.g. GCash, MoMo)
* @type {string} * @memberof ListProductsResponseProductsInner */ 'category': ListProductsResponseProductsInnerCategoryEnum; /** * Additional classification for the product. Only applicable to products with a `category` of `merchant_card`. Possible subcategories: * `beauty_and_health` * `digital_financial_services` * `electronics` * `entertainment` * `fashion` * `food_and_drink` * `general_merchandise` * `grocery_and_supermarkets` * `home_and_living` * `mobility_and_fuel` * `sports_and_outdoor_gear` * `travel_and_hospitality` * @type {string} * @memberof ListProductsResponseProductsInner */ 'subcategory'?: ListProductsResponseProductsInnerSubcategoryEnum; /** * Legal disclosures for this product. Can be in HTML format. * @type {string} * @memberof ListProductsResponseProductsInner */ 'disclosure': string; /** * Products are restricted in their usage based on the amount of the reward. The `skus` array defines bands of denominations in which this product may be used for payouts. * @type {Array} * @memberof ListProductsResponseProductsInner */ 'skus'?: Array; /** * Available currencies for this product * @type {Array} * @memberof ListProductsResponseProductsInner */ 'currency_codes': Array; /** * List of countries in which this product is available to recipients. * @type {Array} * @memberof ListProductsResponseProductsInner */ 'countries': Array; /** * List of product images associated with this product (e.g. logos or images of the gift cards) * @type {Array} * @memberof ListProductsResponseProductsInner */ 'images': Array; /** * Instructions for how to use the product, if applicable. Mostly used for products with a `category` of `merchant_card`. * @type {string} * @memberof ListProductsResponseProductsInner */ 'usage_instructions'?: string; /** * * @type {ListProductsResponseProductsInnerDocuments} * @memberof ListProductsResponseProductsInner */ 'documents'?: ListProductsResponseProductsInnerDocuments | null; } export declare const ListProductsResponseProductsInnerCategoryEnum: { readonly Ach: "ach"; readonly Charity: "charity"; readonly InstantDebitTransfer: "instant_debit_transfer"; readonly MerchantCard: "merchant_card"; readonly Paypal: "paypal"; readonly Venmo: "venmo"; readonly VisaCard: "visa_card"; readonly CashApp: "cash_app"; readonly InternationalBank: "international_bank"; readonly Wallet: "wallet"; }; export type ListProductsResponseProductsInnerCategoryEnum = typeof ListProductsResponseProductsInnerCategoryEnum[keyof typeof ListProductsResponseProductsInnerCategoryEnum]; export declare const ListProductsResponseProductsInnerSubcategoryEnum: { readonly BeautyAndHealth: "beauty_and_health"; readonly DigitalFinancialServices: "digital_financial_services"; readonly Electronics: "electronics"; readonly Entertainment: "entertainment"; readonly Fashion: "fashion"; readonly FoodAndDrink: "food_and_drink"; readonly GeneralMerchandise: "general_merchandise"; readonly GroceryAndSupermarkets: "grocery_and_supermarkets"; readonly HomeAndLiving: "home_and_living"; readonly MobilityAndFuel: "mobility_and_fuel"; readonly SportsAndOutdoorGear: "sports_and_outdoor_gear"; readonly TravelAndHospitality: "travel_and_hospitality"; }; export type ListProductsResponseProductsInnerSubcategoryEnum = typeof ListProductsResponseProductsInnerSubcategoryEnum[keyof typeof ListProductsResponseProductsInnerSubcategoryEnum]; export declare const ListProductsResponseProductsInnerCurrencyCodesEnum: { readonly Usd: "USD"; readonly Cad: "CAD"; readonly Eur: "EUR"; readonly Aed: "AED"; readonly Afn: "AFN"; readonly All: "ALL"; readonly Amd: "AMD"; readonly Ars: "ARS"; readonly Aud: "AUD"; readonly Azn: "AZN"; readonly Bam: "BAM"; readonly Bdt: "BDT"; readonly Bhd: "BHD"; readonly Bif: "BIF"; readonly Bnd: "BND"; readonly Bob: "BOB"; readonly Brl: "BRL"; readonly Bwp: "BWP"; readonly Byn: "BYN"; readonly Bzd: "BZD"; readonly Cdf: "CDF"; readonly Chf: "CHF"; readonly Clp: "CLP"; readonly Cny: "CNY"; readonly Cop: "COP"; readonly Crc: "CRC"; readonly Cve: "CVE"; readonly Czk: "CZK"; readonly Djf: "DJF"; readonly Dkk: "DKK"; readonly Dop: "DOP"; readonly Dzd: "DZD"; readonly Egp: "EGP"; readonly Ern: "ERN"; readonly Etb: "ETB"; readonly Gbp: "GBP"; readonly Gel: "GEL"; readonly Ghs: "GHS"; readonly Gnf: "GNF"; readonly Gtq: "GTQ"; readonly Hkd: "HKD"; readonly Hnl: "HNL"; readonly Hrk: "HRK"; readonly Huf: "HUF"; readonly Idr: "IDR"; readonly Ils: "ILS"; readonly Inr: "INR"; readonly Iqd: "IQD"; readonly Irr: "IRR"; readonly Isk: "ISK"; readonly Jmd: "JMD"; readonly Jod: "JOD"; readonly Jpy: "JPY"; readonly Kes: "KES"; readonly Khr: "KHR"; readonly Krw: "KRW"; readonly Kwd: "KWD"; readonly Kzt: "KZT"; readonly Lbp: "LBP"; readonly Lkr: "LKR"; readonly Mad: "MAD"; readonly Mdl: "MDL"; readonly Mga: "MGA"; readonly Mkd: "MKD"; readonly Mmk: "MMK"; readonly Mop: "MOP"; readonly Mur: "MUR"; readonly Mxn: "MXN"; readonly Myr: "MYR"; readonly Mzn: "MZN"; readonly Nad: "NAD"; readonly Ngn: "NGN"; readonly Nio: "NIO"; readonly Nok: "NOK"; readonly Npr: "NPR"; readonly Nzd: "NZD"; readonly Omr: "OMR"; readonly Pab: "PAB"; readonly Pen: "PEN"; readonly Php: "PHP"; readonly Pkr: "PKR"; readonly Pln: "PLN"; readonly Pyg: "PYG"; readonly Qar: "QAR"; readonly Ron: "RON"; readonly Rsd: "RSD"; readonly Rub: "RUB"; readonly Rwf: "RWF"; readonly Sar: "SAR"; readonly Sdg: "SDG"; readonly Sek: "SEK"; readonly Sgd: "SGD"; readonly Sos: "SOS"; readonly Syp: "SYP"; readonly Thb: "THB"; readonly Tnd: "TND"; readonly Top: "TOP"; readonly Try: "TRY"; readonly Ttd: "TTD"; readonly Twd: "TWD"; readonly Tzs: "TZS"; readonly Uah: "UAH"; readonly Ugx: "UGX"; readonly Uyu: "UYU"; readonly Uzs: "UZS"; readonly Vef: "VEF"; readonly Vnd: "VND"; readonly Xaf: "XAF"; readonly Xof: "XOF"; readonly Yer: "YER"; readonly Zar: "ZAR"; }; export type ListProductsResponseProductsInnerCurrencyCodesEnum = typeof ListProductsResponseProductsInnerCurrencyCodesEnum[keyof typeof ListProductsResponseProductsInnerCurrencyCodesEnum]; /** * * @export * @interface ListProductsResponseProductsInnerCountriesInner */ export interface ListProductsResponseProductsInnerCountriesInner { /** * ISO 3166 country code * @type {string} * @memberof ListProductsResponseProductsInnerCountriesInner */ 'abbr': string; } /** * URLs and files related to product documentation. * @export * @interface ListProductsResponseProductsInnerDocuments */ export interface ListProductsResponseProductsInnerDocuments { /** * URL to the cardholder agreement PDF file. * @type {string} * @memberof ListProductsResponseProductsInnerDocuments */ 'cardholder_agreement_pdf'?: string; /** * URL to the cardholder agreement web page. * @type {string} * @memberof ListProductsResponseProductsInnerDocuments */ 'cardholder_agreement_url'?: string; /** * URL to the privacy policy web page. * @type {string} * @memberof ListProductsResponseProductsInnerDocuments */ 'privacy_policy_url'?: string; } /** * * @export * @interface ListProductsResponseProductsInnerImagesInner */ export interface ListProductsResponseProductsInnerImagesInner { /** * URL to this image * @type {string} * @memberof ListProductsResponseProductsInnerImagesInner */ 'src': string; /** * Type of image * @type {string} * @memberof ListProductsResponseProductsInnerImagesInner */ 'type': ListProductsResponseProductsInnerImagesInnerTypeEnum; /** * The MIME content type of this image * @type {string} * @memberof ListProductsResponseProductsInnerImagesInner */ 'content_type'?: string | null; } export declare const ListProductsResponseProductsInnerImagesInnerTypeEnum: { readonly Card: "card"; readonly Logo: "logo"; }; export type ListProductsResponseProductsInnerImagesInnerTypeEnum = typeof ListProductsResponseProductsInnerImagesInnerTypeEnum[keyof typeof ListProductsResponseProductsInnerImagesInnerTypeEnum]; /** * * @export * @interface ListProductsResponseProductsInnerSkusInner */ export interface ListProductsResponseProductsInnerSkusInner { /** * Minimal denomination that this product supports (in the product\'s currency) * @type {number} * @memberof ListProductsResponseProductsInnerSkusInner */ 'min': number; /** * Maximum denomination that this product supports (in the product\'s currency) * @type {number} * @memberof ListProductsResponseProductsInnerSkusInner */ 'max': number; } /** * * @export * @interface ListRewards200Response */ export interface ListRewards200Response { /** * * @type {Array} * @memberof ListRewards200Response */ 'rewards'?: Array; /** * The total number of rewards across all pages * @type {number} * @memberof ListRewards200Response */ 'total_count'?: number; } /** * A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified. * @export * @interface ListRewards200ResponseRewardsInner */ export interface ListRewards200ResponseRewardsInner { /** * Tremendous ID of the reward * @type {string} * @memberof ListRewards200ResponseRewardsInner */ 'id'?: string; /** * Tremendous ID of the order this reward is part of. * @type {string} * @memberof ListRewards200ResponseRewardsInner */ 'order_id'?: string; /** * Date the reward was created * @type {string} * @memberof ListRewards200ResponseRewardsInner */ 'created_at'?: string; /** * Expiration date of the reward. If null, the reward does not expire. * @type {string} * @memberof ListRewards200ResponseRewardsInner */ 'expires_at'?: string | null; /** * * @type {ListRewards200ResponseRewardsInnerValue} * @memberof ListRewards200ResponseRewardsInner */ 'value'?: ListRewards200ResponseRewardsInnerValue; /** * * @type {ListRewards200ResponseRewardsInnerRecipient} * @memberof ListRewards200ResponseRewardsInner */ 'recipient'?: ListRewards200ResponseRewardsInnerRecipient; /** * Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored. * @type {string} * @memberof ListRewards200ResponseRewardsInner */ 'deliver_at'?: string; /** * * @type {Array} * @memberof ListRewards200ResponseRewardsInner */ 'custom_fields'?: Array; /** * * @type {ListRewards200ResponseRewardsInnerDelivery} * @memberof ListRewards200ResponseRewardsInner */ 'delivery'?: ListRewards200ResponseRewardsInnerDelivery; } /** * Reward custom data for searching, tracking or copy (see [Adding custom fields to orders](https://developers.tremendous.com/docs/using-custom-fields-to-add-custom-data-to-rewards).) * @export * @interface ListRewards200ResponseRewardsInnerCustomFieldsInner */ export interface ListRewards200ResponseRewardsInnerCustomFieldsInner { /** * Tremendous ID of the custom field * @type {string} * @memberof ListRewards200ResponseRewardsInnerCustomFieldsInner */ 'id'?: string; /** * Value of the custom field * @type {string} * @memberof ListRewards200ResponseRewardsInnerCustomFieldsInner */ 'value'?: string | null; /** * Label of the custom field * @type {string} * @memberof ListRewards200ResponseRewardsInnerCustomFieldsInner */ 'label'?: string; } /** * Details on how the reward is delivered to the recipient. * @export * @interface ListRewards200ResponseRewardsInnerDelivery */ export interface ListRewards200ResponseRewardsInnerDelivery { /** * How to deliver the reward to the recipient.
Delivery Method Description
EMAIL Deliver the reward to the recipient by email
LINK

Deliver the reward to the recipient via a link.

The initial POST /orders response for a link reward includes the link in delivery.link.

The link must then be delivered to the recipient out-of-band.

To obtain a new link for an existing reward, call POST /rewards/{id}/generate_link.

PHONE Deliver the reward to the recipient by SMS
* @type {string} * @memberof ListRewards200ResponseRewardsInnerDelivery */ 'method'?: ListRewards200ResponseRewardsInnerDeliveryMethodEnum; /** * Current status of the delivery of the reward: * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link active). * `PENDING` - Delivery is pending but not yet scheduled. * @type {string} * @memberof ListRewards200ResponseRewardsInnerDelivery */ 'status'?: ListRewards200ResponseRewardsInnerDeliveryStatusEnum; } export declare const ListRewards200ResponseRewardsInnerDeliveryMethodEnum: { readonly Email: "EMAIL"; readonly Link: "LINK"; readonly Phone: "PHONE"; }; export type ListRewards200ResponseRewardsInnerDeliveryMethodEnum = typeof ListRewards200ResponseRewardsInnerDeliveryMethodEnum[keyof typeof ListRewards200ResponseRewardsInnerDeliveryMethodEnum]; export declare const ListRewards200ResponseRewardsInnerDeliveryStatusEnum: { readonly Scheduled: "SCHEDULED"; readonly Failed: "FAILED"; readonly Succeeded: "SUCCEEDED"; readonly Pending: "PENDING"; }; export type ListRewards200ResponseRewardsInnerDeliveryStatusEnum = typeof ListRewards200ResponseRewardsInnerDeliveryStatusEnum[keyof typeof ListRewards200ResponseRewardsInnerDeliveryStatusEnum]; /** * Details of the recipient of the reward * @export * @interface ListRewards200ResponseRewardsInnerRecipient */ export interface ListRewards200ResponseRewardsInnerRecipient { /** * Name of the recipient * @type {string} * @memberof ListRewards200ResponseRewardsInnerRecipient */ 'name'?: string | null; /** * Email address of the recipient * @type {string} * @memberof ListRewards200ResponseRewardsInnerRecipient */ 'email'?: string; /** * Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +). * @type {string} * @memberof ListRewards200ResponseRewardsInnerRecipient */ 'phone'?: string; } /** * * @export * @interface ListRewards200ResponseRewardsInnerValue */ export interface ListRewards200ResponseRewardsInnerValue { /** * Amount of the reward * @type {number} * @memberof ListRewards200ResponseRewardsInnerValue */ 'denomination': number; /** * Currency of the reward. Defaults to the organization\'s currency if not provided. * @type {string} * @memberof ListRewards200ResponseRewardsInnerValue */ 'currency_code'?: ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum; } export declare const ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum: { readonly Usd: "USD"; readonly Cad: "CAD"; readonly Eur: "EUR"; readonly Aed: "AED"; readonly Afn: "AFN"; readonly All: "ALL"; readonly Amd: "AMD"; readonly Ars: "ARS"; readonly Aud: "AUD"; readonly Azn: "AZN"; readonly Bam: "BAM"; readonly Bdt: "BDT"; readonly Bhd: "BHD"; readonly Bif: "BIF"; readonly Bnd: "BND"; readonly Bob: "BOB"; readonly Brl: "BRL"; readonly Bwp: "BWP"; readonly Byn: "BYN"; readonly Bzd: "BZD"; readonly Cdf: "CDF"; readonly Chf: "CHF"; readonly Clp: "CLP"; readonly Cny: "CNY"; readonly Cop: "COP"; readonly Crc: "CRC"; readonly Cve: "CVE"; readonly Czk: "CZK"; readonly Djf: "DJF"; readonly Dkk: "DKK"; readonly Dop: "DOP"; readonly Dzd: "DZD"; readonly Egp: "EGP"; readonly Ern: "ERN"; readonly Etb: "ETB"; readonly Gbp: "GBP"; readonly Gel: "GEL"; readonly Ghs: "GHS"; readonly Gnf: "GNF"; readonly Gtq: "GTQ"; readonly Hkd: "HKD"; readonly Hnl: "HNL"; readonly Hrk: "HRK"; readonly Huf: "HUF"; readonly Idr: "IDR"; readonly Ils: "ILS"; readonly Inr: "INR"; readonly Iqd: "IQD"; readonly Irr: "IRR"; readonly Isk: "ISK"; readonly Jmd: "JMD"; readonly Jod: "JOD"; readonly Jpy: "JPY"; readonly Kes: "KES"; readonly Khr: "KHR"; readonly Krw: "KRW"; readonly Kwd: "KWD"; readonly Kzt: "KZT"; readonly Lbp: "LBP"; readonly Lkr: "LKR"; readonly Mad: "MAD"; readonly Mdl: "MDL"; readonly Mga: "MGA"; readonly Mkd: "MKD"; readonly Mmk: "MMK"; readonly Mop: "MOP"; readonly Mur: "MUR"; readonly Mxn: "MXN"; readonly Myr: "MYR"; readonly Mzn: "MZN"; readonly Nad: "NAD"; readonly Ngn: "NGN"; readonly Nio: "NIO"; readonly Nok: "NOK"; readonly Npr: "NPR"; readonly Nzd: "NZD"; readonly Omr: "OMR"; readonly Pab: "PAB"; readonly Pen: "PEN"; readonly Php: "PHP"; readonly Pkr: "PKR"; readonly Pln: "PLN"; readonly Pyg: "PYG"; readonly Qar: "QAR"; readonly Ron: "RON"; readonly Rsd: "RSD"; readonly Rub: "RUB"; readonly Rwf: "RWF"; readonly Sar: "SAR"; readonly Sdg: "SDG"; readonly Sek: "SEK"; readonly Sgd: "SGD"; readonly Sos: "SOS"; readonly Syp: "SYP"; readonly Thb: "THB"; readonly Tnd: "TND"; readonly Top: "TOP"; readonly Try: "TRY"; readonly Ttd: "TTD"; readonly Twd: "TWD"; readonly Tzs: "TZS"; readonly Uah: "UAH"; readonly Ugx: "UGX"; readonly Uyu: "UYU"; readonly Uzs: "UZS"; readonly Vef: "VEF"; readonly Vnd: "VND"; readonly Xaf: "XAF"; readonly Xof: "XOF"; readonly Yer: "YER"; readonly Zar: "ZAR"; }; export type ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum = typeof ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum[keyof typeof ListRewards200ResponseRewardsInnerValueCurrencyCodeEnum]; /** * * @export * @interface ListRewards401Response */ export interface ListRewards401Response { /** * HTTP status code of the response * @type {number} * @memberof ListRewards401Response */ 'status'?: number; /** * * @type {ListRewards401ResponseErrors} * @memberof ListRewards401Response */ 'errors': ListRewards401ResponseErrors; } /** * * @export * @interface ListRewards401ResponseErrors */ export interface ListRewards401ResponseErrors { /** * Error message * @type {string} * @memberof ListRewards401ResponseErrors */ 'message'?: string; /** * Mirrors the request parameters structure, filled only with the (nested) properties that caused an error. * @type {{ [key: string]: any; }} * @memberof ListRewards401ResponseErrors */ 'payload'?: { [key: string]: any; }; } /** * * @export * @interface ListRewards429Response */ export interface ListRewards429Response { /** * HTTP status code of the response * @type {number} * @memberof ListRewards429Response */ 'status'?: number; /** * * @type {ListRewards401ResponseErrors} * @memberof ListRewards429Response */ 'errors': ListRewards401ResponseErrors; } /** * * @export * @interface ListRoles200Response */ export interface ListRoles200Response { /** * * @type {Array} * @memberof ListRoles200Response */ 'roles': Array; } /** * Each organization member is assigned a role that defines the permissions they have within the organization. * @export * @interface ListRoles200ResponseRolesInner */ export interface ListRoles200ResponseRolesInner { /** * * @type {string} * @memberof ListRoles200ResponseRolesInner */ 'id': string; /** * * @type {string} * @memberof ListRoles200ResponseRolesInner */ 'title': string; /** * * @type {string} * @memberof ListRoles200ResponseRolesInner */ 'description': string; } /** * * @export * @interface ListTopups200Response */ export interface ListTopups200Response { /** * * @type {Array} * @memberof ListTopups200Response */ 'topups'?: Array; /** * The total number of topups across all pages * @type {number} * @memberof ListTopups200Response */ 'total_count'?: number; } /** * * @export * @interface ListTopups200ResponseTopupsInner */ export interface ListTopups200ResponseTopupsInner { /** * Unique identifier for the topup request. * @type {string} * @memberof ListTopups200ResponseTopupsInner */ 'id'?: string; /** * Amount to add to your organization\'s balance, denominated in `currency_code`. * @type {number} * @memberof ListTopups200ResponseTopupsInner */ 'amount'?: number; /** * Currency of the topup amount. Always matches the organization\'s currency. * @type {string} * @memberof ListTopups200ResponseTopupsInner */ 'currency_code'?: string; /** * Amount of the processing fee for the topup (typically reserved for credit card topups). * @type {number} * @memberof ListTopups200ResponseTopupsInner */ 'processing_fee'?: number; /** * ID of the funding_source object used for this topup. * @type {string} * @memberof ListTopups200ResponseTopupsInner */ 'funding_source_id'?: string; /** * Status of the topup
Status Description
created The topup is processing (and may be under review).
partially_credited Some funds have been credited to the balance. The remainder will be credited by expected_settlement_at.
fully_credited All funds have been added to the balance.
reversed The topup was credited, but then reversed due to a chargeback or ACH return.
rejected The topup was rejected by an admin.
* @type {string} * @memberof ListTopups200ResponseTopupsInner */ 'status'?: string; /** * Timestamp indicating when the topup object was created (when the request was made). * @type {string} * @memberof ListTopups200ResponseTopupsInner */ 'created_at'?: string; /** * Timestamp indicating when the topup amount was fully credited to the balance. * @type {string} * @memberof ListTopups200ResponseTopupsInner */ 'fully_credited_at'?: string | null; /** * Timestamp indicating when the topup was rejected. * @type {string} * @memberof ListTopups200ResponseTopupsInner */ 'rejected_at'?: string | null; /** * Timestamp indicating when the topup was reversed. * @type {string} * @memberof ListTopups200ResponseTopupsInner */ 'reversed_at'?: string | null; /** * A sentence explaining why the topup was reversed. * @type {string} * @memberof ListTopups200ResponseTopupsInner */ 'reversed_reason'?: string | null; /** * Idempotency key to prevent duplicate requests. * @type {string} * @memberof ListTopups200ResponseTopupsInner */ 'idempotency_key'?: string | null; /** * Amount credited to the balance immediately. Equals `amount` for non-ACH topups or ACH debits fully within instant funding limits. Can be 0 if nothing was credited instantly. * @type {number} * @memberof ListTopups200ResponseTopupsInner */ 'instant_credit_amount'?: number; /** * Amount that will be available once the settlement period elapses. 0 if nothing is settling. * @type {number} * @memberof ListTopups200ResponseTopupsInner */ 'settled_amount'?: number; /** * Timestamp indicating when the pending amount will be credited to the balance. Null if the topup was fully credited immediately. * @type {string} * @memberof ListTopups200ResponseTopupsInner */ 'expected_settlement_at'?: string | null; } /** * * @export * @interface ListWebhookEvents200Response */ export interface ListWebhookEvents200Response { /** * * @type {Array} * @memberof ListWebhookEvents200Response */ 'events'?: Array; } /** * * @export * @interface ListWebhooks200Response */ export interface ListWebhooks200Response { /** * * @type {Array} * @memberof ListWebhooks200Response */ 'webhooks'?: Array; } /** * * @export * @interface ListWebhooks200ResponseWebhooksInner */ export interface ListWebhooks200ResponseWebhooksInner { /** * * @type {string} * @memberof ListWebhooks200ResponseWebhooksInner */ 'id'?: string; /** * URL the webhook will make requests to * @type {string} * @memberof ListWebhooks200ResponseWebhooksInner */ 'url': string | null; /** * Private key for the webhook * @type {string} * @memberof ListWebhooks200ResponseWebhooksInner */ 'private_key'?: string; } /** * Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. * @export * @interface Member */ export interface Member { /** * * @type {string} * @memberof Member */ 'id': string; /** * Email address of the member * @type {string} * @memberof Member */ 'email': string; /** * Full name of the member * @type {string} * @memberof Member */ 'name': string | null; /** * Is this member currently active in the organization. If `false`, the member will not be able to access the organization. * @type {boolean} * @memberof Member */ 'active'?: boolean; /** * The role ID associated with the member within the organization. * @type {string} * @memberof Member */ 'role'?: string | null; /** * Current status of the member\'s account. When creating a member it starts out in the status `INVITED`. As soon as that member open the invitation link and registers an account, the status switches to `REGISTERED`. * @type {string} * @memberof Member */ 'status': MemberStatusEnum; /** * Timestamp when this member was created. The `created_at` timestamp is **NOT** returned when retrieving a member (but is part of the response when listing or creating members). * @type {string} * @memberof Member */ 'created_at'?: string; /** * Timestamp when this member most recently logged into the dashboard of the organization associated with this API key. * @type {string} * @memberof Member */ 'last_login_at'?: string | null; } export declare const MemberStatusEnum: { readonly Registered: "REGISTERED"; readonly Invited: "INVITED"; }; export type MemberStatusEnum = typeof MemberStatusEnum[keyof typeof MemberStatusEnum]; /** * Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. * @export * @interface MemberBase */ export interface MemberBase { /** * * @type {string} * @memberof MemberBase */ 'id': string; /** * Email address of the member * @type {string} * @memberof MemberBase */ 'email': string; /** * Full name of the member * @type {string} * @memberof MemberBase */ 'name': string | null; /** * Is this member currently active in the organization. If `false`, the member will not be able to access the organization. * @type {boolean} * @memberof MemberBase */ 'active'?: boolean; /** * The role ID associated with the member within the organization. * @type {string} * @memberof MemberBase */ 'role'?: string | null; /** * Current status of the member\'s account. When creating a member it starts out in the status `INVITED`. As soon as that member open the invitation link and registers an account, the status switches to `REGISTERED`. * @type {string} * @memberof MemberBase */ 'status': MemberBaseStatusEnum; } export declare const MemberBaseStatusEnum: { readonly Registered: "REGISTERED"; readonly Invited: "INVITED"; }; export type MemberBaseStatusEnum = typeof MemberBaseStatusEnum[keyof typeof MemberBaseStatusEnum]; /** * Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. * @export * @interface MemberWithEvents */ export interface MemberWithEvents { /** * * @type {string} * @memberof MemberWithEvents */ 'id': string; /** * Email address of the member * @type {string} * @memberof MemberWithEvents */ 'email': string; /** * Full name of the member * @type {string} * @memberof MemberWithEvents */ 'name': string | null; /** * Is this member currently active in the organization. If `false`, the member will not be able to access the organization. * @type {boolean} * @memberof MemberWithEvents */ 'active'?: boolean; /** * The role ID associated with the member within the organization. * @type {string} * @memberof MemberWithEvents */ 'role'?: string | null; /** * Current status of the member\'s account. When creating a member it starts out in the status `INVITED`. As soon as that member open the invitation link and registers an account, the status switches to `REGISTERED`. * @type {string} * @memberof MemberWithEvents */ 'status': MemberWithEventsStatusEnum; /** * List of events related to the member. * @type {Array} * @memberof MemberWithEvents */ 'events'?: Array; } export declare const MemberWithEventsStatusEnum: { readonly Registered: "REGISTERED"; readonly Invited: "INVITED"; }; export type MemberWithEventsStatusEnum = typeof MemberWithEventsStatusEnum[keyof typeof MemberWithEventsStatusEnum]; /** * Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. * @export * @interface MemberWithoutEvents */ export interface MemberWithoutEvents { /** * * @type {string} * @memberof MemberWithoutEvents */ 'id': string; /** * Email address of the member * @type {string} * @memberof MemberWithoutEvents */ 'email': string; /** * Full name of the member * @type {string} * @memberof MemberWithoutEvents */ 'name': string | null; /** * Is this member currently active in the organization. If `false`, the member will not be able to access the organization. * @type {boolean} * @memberof MemberWithoutEvents */ 'active'?: boolean; /** * The role ID associated with the member within the organization. * @type {string} * @memberof MemberWithoutEvents */ 'role'?: string | null; /** * Current status of the member\'s account. When creating a member it starts out in the status `INVITED`. As soon as that member open the invitation link and registers an account, the status switches to `REGISTERED`. * @type {string} * @memberof MemberWithoutEvents */ 'status': MemberWithoutEventsStatusEnum; /** * Timestamp when this member was created. The `created_at` timestamp is **NOT** returned when retrieving a member (but is part of the response when listing or creating members). * @type {string} * @memberof MemberWithoutEvents */ 'created_at'?: string; /** * Timestamp when this member most recently logged into the dashboard of the organization associated with this API key. * @type {string} * @memberof MemberWithoutEvents */ 'last_login_at'?: string | null; } export declare const MemberWithoutEventsStatusEnum: { readonly Registered: "REGISTERED"; readonly Invited: "INVITED"; }; export type MemberWithoutEventsStatusEnum = typeof MemberWithoutEventsStatusEnum[keyof typeof MemberWithoutEventsStatusEnum]; /** * An order wraps around the fulfilment of one or more rewards. * @export * @interface Order */ export interface Order { /** * Tremendous ID of the order * @type {string} * @memberof Order */ 'id': string; /** * Reference for this order, supplied by the customer. When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders. It also allows for retrieving by `external_id` instead of `id` only. * @type {string} * @memberof Order */ 'external_id'?: string | null; /** * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from. * @type {string} * @memberof Order */ 'campaign_id'?: string | null; /** * Date the order was created * @type {string} * @memberof Order */ 'created_at': string; /** * Execution status of a given order
Status Description
CANCELED The order and all of its rewards were canceled.
OPEN The order has been created, but hasn\'t yet been processed.
EXECUTED The order has been executed. Payment has been handled and rewards are being delivered (if applicable).
FAILED The order could not be processed due to an error. E.g. due to insufficient funds in the account.
PENDING APPROVAL The order has been created but needs approval to be executed.
PENDING INTERNAL PAYMENT APPROVAL The order has been created but it is under review and requires approval from our team.
PENDING SETTLEMENT The order has been created but the funds are being held until the settlement window clears.
* @type {string} * @memberof Order */ 'status': OrderStatusEnum; /** * Name of the channel in which the order was created * @type {string} * @memberof Order */ 'channel'?: OrderChannelEnum; /** * * @type {OrderBasePayment} * @memberof Order */ 'payment'?: OrderBasePayment; /** * The ID for the invoice associated with this order * @type {string} * @memberof Order */ 'invoice_id'?: string; /** * * @type {Array} * @memberof Order */ 'rewards'?: Array; } export declare const OrderStatusEnum: { readonly Canceled: "CANCELED"; readonly Open: "OPEN"; readonly Executed: "EXECUTED"; readonly Failed: "FAILED"; readonly PendingApproval: "PENDING APPROVAL"; readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL"; readonly PendingSettlement: "PENDING SETTLEMENT"; }; export type OrderStatusEnum = typeof OrderStatusEnum[keyof typeof OrderStatusEnum]; export declare const OrderChannelEnum: { readonly Ui: "UI"; readonly Api: "API"; readonly Embed: "EMBED"; readonly Decipher: "DECIPHER"; readonly Qualtrics: "QUALTRICS"; readonly Typeform: "TYPEFORM"; readonly SurveyMonkey: "SURVEY MONKEY"; readonly Yotpo: "YOTPO"; }; export type OrderChannelEnum = typeof OrderChannelEnum[keyof typeof OrderChannelEnum]; /** * An order wraps around the fulfilment of one or more rewards. * @export * @interface OrderBase */ export interface OrderBase { /** * Tremendous ID of the order * @type {string} * @memberof OrderBase */ 'id': string; /** * Reference for this order, supplied by the customer. When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders. It also allows for retrieving by `external_id` instead of `id` only. * @type {string} * @memberof OrderBase */ 'external_id'?: string | null; /** * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from. * @type {string} * @memberof OrderBase */ 'campaign_id'?: string | null; /** * Date the order was created * @type {string} * @memberof OrderBase */ 'created_at': string; /** * Execution status of a given order
Status Description
CANCELED The order and all of its rewards were canceled.
OPEN The order has been created, but hasn\'t yet been processed.
EXECUTED The order has been executed. Payment has been handled and rewards are being delivered (if applicable).
FAILED The order could not be processed due to an error. E.g. due to insufficient funds in the account.
PENDING APPROVAL The order has been created but needs approval to be executed.
PENDING INTERNAL PAYMENT APPROVAL The order has been created but it is under review and requires approval from our team.
PENDING SETTLEMENT The order has been created but the funds are being held until the settlement window clears.
* @type {string} * @memberof OrderBase */ 'status': OrderBaseStatusEnum; /** * Name of the channel in which the order was created * @type {string} * @memberof OrderBase */ 'channel'?: OrderBaseChannelEnum; /** * * @type {OrderBasePayment} * @memberof OrderBase */ 'payment'?: OrderBasePayment; /** * The ID for the invoice associated with this order * @type {string} * @memberof OrderBase */ 'invoice_id'?: string; } export declare const OrderBaseStatusEnum: { readonly Canceled: "CANCELED"; readonly Open: "OPEN"; readonly Executed: "EXECUTED"; readonly Failed: "FAILED"; readonly PendingApproval: "PENDING APPROVAL"; readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL"; readonly PendingSettlement: "PENDING SETTLEMENT"; }; export type OrderBaseStatusEnum = typeof OrderBaseStatusEnum[keyof typeof OrderBaseStatusEnum]; export declare const OrderBaseChannelEnum: { readonly Ui: "UI"; readonly Api: "API"; readonly Embed: "EMBED"; readonly Decipher: "DECIPHER"; readonly Qualtrics: "QUALTRICS"; readonly Typeform: "TYPEFORM"; readonly SurveyMonkey: "SURVEY MONKEY"; readonly Yotpo: "YOTPO"; }; export type OrderBaseChannelEnum = typeof OrderBaseChannelEnum[keyof typeof OrderBaseChannelEnum]; /** * Cost breakdown of the order (cost of rewards + fees). Cost and fees are denominated in the organization\'s currency (see payment `currency_code`), independent of the ordered rewards\' currency. Note that this property will only appear for processed orders (`status` is `EXECUTED`). * @export * @interface OrderBasePayment */ export interface OrderBasePayment { /** * Total price of the order before fees, denominated in `currency_code`. * @type {number} * @memberof OrderBasePayment */ 'subtotal': number; /** * Total price of the order including fees, denominated in `currency_code`. * @type {number} * @memberof OrderBasePayment */ 'total': number; /** * Fees for the order, denominated in `currency_code`. * @type {number} * @memberof OrderBasePayment */ 'fees': number; /** * Discount for the order, denominated in `currency_code`. * @type {number} * @memberof OrderBasePayment */ 'discount': number; /** * Currency in which the payment amounts (subtotal, total, fees, discount, refund) are denominated. This always matches the organization\'s currency. * @type {string} * @memberof OrderBasePayment */ 'currency_code': string; /** * * @type {PaymentDetailsRefund} * @memberof OrderBasePayment */ 'refund'?: PaymentDetailsRefund; } /** * Execution status of a given order
Status Description
CANCELED The order and all of its rewards were canceled.
OPEN The order has been created, but hasn\'t yet been processed.
EXECUTED The order has been executed. Payment has been handled and rewards are being delivered (if applicable).
FAILED The order could not be processed due to an error. E.g. due to insufficient funds in the account.
PENDING APPROVAL The order has been created but needs approval to be executed.
PENDING INTERNAL PAYMENT APPROVAL The order has been created but it is under review and requires approval from our team.
PENDING SETTLEMENT The order has been created but the funds are being held until the settlement window clears.
* @export * @enum {string} */ export declare const OrderStatus: { readonly Canceled: "CANCELED"; readonly Open: "OPEN"; readonly Executed: "EXECUTED"; readonly Failed: "FAILED"; readonly PendingApproval: "PENDING APPROVAL"; readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL"; readonly PendingSettlement: "PENDING SETTLEMENT"; }; export type OrderStatus = typeof OrderStatus[keyof typeof OrderStatus]; /** * An order wraps around the fulfilment of one or more rewards. * @export * @interface OrderWithLink */ export interface OrderWithLink { /** * Tremendous ID of the order * @type {string} * @memberof OrderWithLink */ 'id': string; /** * Reference for this order, supplied by the customer. When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders. It also allows for retrieving by `external_id` instead of `id` only. * @type {string} * @memberof OrderWithLink */ 'external_id'?: string | null; /** * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from. * @type {string} * @memberof OrderWithLink */ 'campaign_id'?: string | null; /** * Date the order was created * @type {string} * @memberof OrderWithLink */ 'created_at': string; /** * Execution status of a given order
Status Description
CANCELED The order and all of its rewards were canceled.
OPEN The order has been created, but hasn\'t yet been processed.
EXECUTED The order has been executed. Payment has been handled and rewards are being delivered (if applicable).
FAILED The order could not be processed due to an error. E.g. due to insufficient funds in the account.
PENDING APPROVAL The order has been created but needs approval to be executed.
PENDING INTERNAL PAYMENT APPROVAL The order has been created but it is under review and requires approval from our team.
PENDING SETTLEMENT The order has been created but the funds are being held until the settlement window clears.
* @type {string} * @memberof OrderWithLink */ 'status': OrderWithLinkStatusEnum; /** * Name of the channel in which the order was created * @type {string} * @memberof OrderWithLink */ 'channel'?: OrderWithLinkChannelEnum; /** * * @type {OrderBasePayment} * @memberof OrderWithLink */ 'payment'?: OrderBasePayment; /** * The ID for the invoice associated with this order * @type {string} * @memberof OrderWithLink */ 'invoice_id'?: string; /** * * @type {Array} * @memberof OrderWithLink */ 'rewards'?: Array; } export declare const OrderWithLinkStatusEnum: { readonly Canceled: "CANCELED"; readonly Open: "OPEN"; readonly Executed: "EXECUTED"; readonly Failed: "FAILED"; readonly PendingApproval: "PENDING APPROVAL"; readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL"; readonly PendingSettlement: "PENDING SETTLEMENT"; }; export type OrderWithLinkStatusEnum = typeof OrderWithLinkStatusEnum[keyof typeof OrderWithLinkStatusEnum]; export declare const OrderWithLinkChannelEnum: { readonly Ui: "UI"; readonly Api: "API"; readonly Embed: "EMBED"; readonly Decipher: "DECIPHER"; readonly Qualtrics: "QUALTRICS"; readonly Typeform: "TYPEFORM"; readonly SurveyMonkey: "SURVEY MONKEY"; readonly Yotpo: "YOTPO"; }; export type OrderWithLinkChannelEnum = typeof OrderWithLinkChannelEnum[keyof typeof OrderWithLinkChannelEnum]; /** * A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified. * @export * @interface OrderWithLinkRewardsInner */ export interface OrderWithLinkRewardsInner { /** * Tremendous ID of the reward * @type {string} * @memberof OrderWithLinkRewardsInner */ 'id'?: string; /** * Tremendous ID of the order this reward is part of. * @type {string} * @memberof OrderWithLinkRewardsInner */ 'order_id'?: string; /** * Date the reward was created * @type {string} * @memberof OrderWithLinkRewardsInner */ 'created_at'?: string; /** * Expiration date of the reward. If null, the reward does not expire. * @type {string} * @memberof OrderWithLinkRewardsInner */ 'expires_at'?: string | null; /** * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from. * @type {string} * @memberof OrderWithLinkRewardsInner */ 'campaign_id'?: string | null; /** * List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from. Providing a `products` array will override the products made available by the campaign specified using the `campaign_id` property unless the `products` array is empty. It will _not_ override other campaign attributes, like the message and customization of the look and feel. * @type {Array} * @memberof OrderWithLinkRewardsInner */ 'products'?: Array; /** * * @type {ListRewards200ResponseRewardsInnerValue} * @memberof OrderWithLinkRewardsInner */ 'value'?: ListRewards200ResponseRewardsInnerValue; /** * * @type {ListRewards200ResponseRewardsInnerRecipient} * @memberof OrderWithLinkRewardsInner */ 'recipient'?: ListRewards200ResponseRewardsInnerRecipient; /** * Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored. * @type {string} * @memberof OrderWithLinkRewardsInner */ 'deliver_at'?: string; /** * * @type {Array} * @memberof OrderWithLinkRewardsInner */ 'custom_fields'?: Array; /** * * @type {RewardWithLinkDelivery} * @memberof OrderWithLinkRewardsInner */ 'delivery'?: RewardWithLinkDelivery; } /** * An order wraps around the fulfilment of one or more rewards. * @export * @interface OrderWithoutLink */ export interface OrderWithoutLink { /** * Tremendous ID of the order * @type {string} * @memberof OrderWithoutLink */ 'id': string; /** * Reference for this order, supplied by the customer. When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders. It also allows for retrieving by `external_id` instead of `id` only. * @type {string} * @memberof OrderWithoutLink */ 'external_id'?: string | null; /** * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from. * @type {string} * @memberof OrderWithoutLink */ 'campaign_id'?: string | null; /** * Date the order was created * @type {string} * @memberof OrderWithoutLink */ 'created_at': string; /** * Execution status of a given order
Status Description
CANCELED The order and all of its rewards were canceled.
OPEN The order has been created, but hasn\'t yet been processed.
EXECUTED The order has been executed. Payment has been handled and rewards are being delivered (if applicable).
FAILED The order could not be processed due to an error. E.g. due to insufficient funds in the account.
PENDING APPROVAL The order has been created but needs approval to be executed.
PENDING INTERNAL PAYMENT APPROVAL The order has been created but it is under review and requires approval from our team.
PENDING SETTLEMENT The order has been created but the funds are being held until the settlement window clears.
* @type {string} * @memberof OrderWithoutLink */ 'status': OrderWithoutLinkStatusEnum; /** * Name of the channel in which the order was created * @type {string} * @memberof OrderWithoutLink */ 'channel'?: OrderWithoutLinkChannelEnum; /** * * @type {OrderBasePayment} * @memberof OrderWithoutLink */ 'payment'?: OrderBasePayment; /** * The ID for the invoice associated with this order * @type {string} * @memberof OrderWithoutLink */ 'invoice_id'?: string; /** * * @type {Array} * @memberof OrderWithoutLink */ 'rewards'?: Array; } export declare const OrderWithoutLinkStatusEnum: { readonly Canceled: "CANCELED"; readonly Open: "OPEN"; readonly Executed: "EXECUTED"; readonly Failed: "FAILED"; readonly PendingApproval: "PENDING APPROVAL"; readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL"; readonly PendingSettlement: "PENDING SETTLEMENT"; }; export type OrderWithoutLinkStatusEnum = typeof OrderWithoutLinkStatusEnum[keyof typeof OrderWithoutLinkStatusEnum]; export declare const OrderWithoutLinkChannelEnum: { readonly Ui: "UI"; readonly Api: "API"; readonly Embed: "EMBED"; readonly Decipher: "DECIPHER"; readonly Qualtrics: "QUALTRICS"; readonly Typeform: "TYPEFORM"; readonly SurveyMonkey: "SURVEY MONKEY"; readonly Yotpo: "YOTPO"; }; export type OrderWithoutLinkChannelEnum = typeof OrderWithoutLinkChannelEnum[keyof typeof OrderWithoutLinkChannelEnum]; /** * A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified. * @export * @interface OrderWithoutLinkRewardsInner */ export interface OrderWithoutLinkRewardsInner { /** * Tremendous ID of the reward * @type {string} * @memberof OrderWithoutLinkRewardsInner */ 'id'?: string; /** * Tremendous ID of the order this reward is part of. * @type {string} * @memberof OrderWithoutLinkRewardsInner */ 'order_id'?: string; /** * Date the reward was created * @type {string} * @memberof OrderWithoutLinkRewardsInner */ 'created_at'?: string; /** * Expiration date of the reward. If null, the reward does not expire. * @type {string} * @memberof OrderWithoutLinkRewardsInner */ 'expires_at'?: string | null; /** * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from. * @type {string} * @memberof OrderWithoutLinkRewardsInner */ 'campaign_id'?: string | null; /** * List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from. Providing a `products` array will override the products made available by the campaign specified using the `campaign_id` property unless the `products` array is empty. It will _not_ override other campaign attributes, like the message and customization of the look and feel. * @type {Array} * @memberof OrderWithoutLinkRewardsInner */ 'products'?: Array; /** * * @type {ListRewards200ResponseRewardsInnerValue} * @memberof OrderWithoutLinkRewardsInner */ 'value'?: ListRewards200ResponseRewardsInnerValue; /** * * @type {ListRewards200ResponseRewardsInnerRecipient} * @memberof OrderWithoutLinkRewardsInner */ 'recipient'?: ListRewards200ResponseRewardsInnerRecipient; /** * Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored. * @type {string} * @memberof OrderWithoutLinkRewardsInner */ 'deliver_at'?: string; /** * * @type {Array} * @memberof OrderWithoutLinkRewardsInner */ 'custom_fields'?: Array; /** * * @type {RewardWithoutLinkDelivery} * @memberof OrderWithoutLinkRewardsInner */ 'delivery'?: RewardWithoutLinkDelivery; } /** * Organizations are a way to separate different parts of your business within the same Tremendous account. Your root Tremendous account is an organization itself and can have multiple sub-organizations. You can assign users in your Tremendous team as members to any organization. Users can be members of multiple organizations at once. Each organizations can have it\'s own API key. * @export * @interface Organization */ export interface Organization { /** * * @type {string} * @memberof Organization */ 'id'?: string; /** * Name of the organization * @type {string} * @memberof Organization */ 'name': string; /** * URL of the website of that organization * @type {string} * @memberof Organization */ 'website': string; /** * Currency used for this organization\'s balances, orders, and transactions. * @type {string} * @memberof Organization */ 'currency_code'?: string; /** * Status of the organization. Organizations need to be approved to be able to use them to send out rewards. * @type {string} * @memberof Organization */ 'status'?: OrganizationStatusEnum; /** * Timestamp of when the organization has been created. *This field is only returned when creating an organization.* It is not returned anymore when retrieving or listing organizations. * @type {string} * @memberof Organization */ 'created_at'?: string; } export declare const OrganizationStatusEnum: { readonly Pending: "PENDING"; readonly Approved: "APPROVED"; readonly Rejected: "REJECTED"; }; export type OrganizationStatusEnum = typeof OrganizationStatusEnum[keyof typeof OrganizationStatusEnum]; /** * * @export * @interface PaymentDetails */ export interface PaymentDetails { /** * Total price of the order before fees, denominated in `currency_code`. * @type {number} * @memberof PaymentDetails */ 'subtotal': number; /** * Total price of the order including fees, denominated in `currency_code`. * @type {number} * @memberof PaymentDetails */ 'total': number; /** * Fees for the order, denominated in `currency_code`. * @type {number} * @memberof PaymentDetails */ 'fees': number; /** * Discount for the order, denominated in `currency_code`. * @type {number} * @memberof PaymentDetails */ 'discount': number; /** * Currency in which the payment amounts (subtotal, total, fees, discount, refund) are denominated. This always matches the organization\'s currency. * @type {string} * @memberof PaymentDetails */ 'currency_code': string; /** * * @type {PaymentDetailsRefund} * @memberof PaymentDetails */ 'refund'?: PaymentDetailsRefund; } /** * Breakdown of the order refunds (total denominated in `currency_code`, independent of the ordered rewards\' currency). Note that this property will only appear for canceled orders or orders with canceled rewards. * @export * @interface PaymentDetailsRefund */ export interface PaymentDetailsRefund { /** * Total amount of the order refunds, denominated in `currency_code`. * @type {number} * @memberof PaymentDetailsRefund */ 'total': number; /** * Currency of the refund. Always matches the organization\'s currency. * @type {string} * @memberof PaymentDetailsRefund */ 'currency_code': string; } /** * * @export * @interface Payout */ export interface Payout { /** * Tremendous ID of the payout * @type {string} * @memberof Payout */ 'id'?: string; /** * * @type {string} * @memberof Payout */ 'status'?: PayoutStatusEnum; /** * Tremendous ID of the paid out product * @type {string} * @memberof Payout */ 'product_id'?: string; /** * Name of the paid out Product * @type {string} * @memberof Payout */ 'product_name'?: string; /** * Date the payout was created * @type {string} * @memberof Payout */ 'created_at'?: string; /** * Date the payout was executed * @type {string} * @memberof Payout */ 'executed_at'?: string | null; /** * Date when a delayed payout will be executed in the future * @type {string} * @memberof Payout */ 'defer_execution_until'?: string | null; } export declare const PayoutStatusEnum: { readonly Unexecuted: "UNEXECUTED"; readonly Completed: "COMPLETED"; readonly Failed: "FAILED"; readonly Canceled: "CANCELED"; readonly OrganizationReview: "ORGANIZATION_REVIEW"; readonly AdminHeld: "ADMIN_HELD"; }; export type PayoutStatusEnum = typeof PayoutStatusEnum[keyof typeof PayoutStatusEnum]; /** * A product represents one way to payout a reward to its recipient. Think: * Amazon.com gift card (ID: `OKMHM2X2OHYV`) * Donations to Save the Children (ID: `ESRNAD533W5A`) * Virtual Visa debit card (ID: `Q24BD9EZ332JT`) each of which is one specific product on Tremendous. > 📘 All available products > > See this [list](https://www.tremendous.com/catalog) Products can be limited in their availability to recipients by * geography (field `countries`) * currency (field `currencies`) * amount of the reward (field `skus`) * e.g. adidas gift cards accept any amount between 5 and 200 USD. See the description of each respective parameter for further details. * @export * @interface Product */ export interface Product { /** * * @type {string} * @memberof Product */ 'id': string; /** * Name of the product * @type {string} * @memberof Product */ 'name': string; /** * Detailed description of the product. * @type {string} * @memberof Product */ 'description': string; /** * The category of the product
Category Description
ach Bank transfer to the recipient
charity Donations to a charity
instant_debit_transfer Instant debit transfer to the recipient
merchant_card A gift card for a certain merchant (e.g. Amazon)
paypal Payout via PayPal
venmo Payout via Venmo
visa_card Payout in form of a Visa debit card
cash_app Payout via Cash App
international_bank Bank transfer to recipients outside of the US
wallet Payout to a digital wallet (e.g. GCash, MoMo)
* @type {string} * @memberof Product */ 'category': ProductCategoryEnum; /** * Additional classification for the product. Only applicable to products with a `category` of `merchant_card`. Possible subcategories: * `beauty_and_health` * `digital_financial_services` * `electronics` * `entertainment` * `fashion` * `food_and_drink` * `general_merchandise` * `grocery_and_supermarkets` * `home_and_living` * `mobility_and_fuel` * `sports_and_outdoor_gear` * `travel_and_hospitality` * @type {string} * @memberof Product */ 'subcategory'?: ProductSubcategoryEnum; /** * Legal disclosures for this product. Can be in HTML format. * @type {string} * @memberof Product */ 'disclosure': string; /** * Products are restricted in their usage based on the amount of the reward. The `skus` array defines bands of denominations in which this product may be used for payouts. * @type {Array} * @memberof Product */ 'skus'?: Array; /** * Available currencies for this product * @type {Array} * @memberof Product */ 'currency_codes': Array; /** * List of countries in which this product is available to recipients. * @type {Array} * @memberof Product */ 'countries': Array; /** * List of product images associated with this product (e.g. logos or images of the gift cards) * @type {Array} * @memberof Product */ 'images': Array; /** * Instructions for how to use the product, if applicable. Mostly used for products with a `category` of `merchant_card`. * @type {string} * @memberof Product */ 'usage_instructions'?: string; /** * * @type {ListProductsResponseProductsInnerDocuments} * @memberof Product */ 'documents'?: ListProductsResponseProductsInnerDocuments | null; } export declare const ProductCategoryEnum: { readonly Ach: "ach"; readonly Charity: "charity"; readonly InstantDebitTransfer: "instant_debit_transfer"; readonly MerchantCard: "merchant_card"; readonly Paypal: "paypal"; readonly Venmo: "venmo"; readonly VisaCard: "visa_card"; readonly CashApp: "cash_app"; readonly InternationalBank: "international_bank"; readonly Wallet: "wallet"; }; export type ProductCategoryEnum = typeof ProductCategoryEnum[keyof typeof ProductCategoryEnum]; export declare const ProductSubcategoryEnum: { readonly BeautyAndHealth: "beauty_and_health"; readonly DigitalFinancialServices: "digital_financial_services"; readonly Electronics: "electronics"; readonly Entertainment: "entertainment"; readonly Fashion: "fashion"; readonly FoodAndDrink: "food_and_drink"; readonly GeneralMerchandise: "general_merchandise"; readonly GroceryAndSupermarkets: "grocery_and_supermarkets"; readonly HomeAndLiving: "home_and_living"; readonly MobilityAndFuel: "mobility_and_fuel"; readonly SportsAndOutdoorGear: "sports_and_outdoor_gear"; readonly TravelAndHospitality: "travel_and_hospitality"; }; export type ProductSubcategoryEnum = typeof ProductSubcategoryEnum[keyof typeof ProductSubcategoryEnum]; export declare const ProductCurrencyCodesEnum: { readonly Usd: "USD"; readonly Cad: "CAD"; readonly Eur: "EUR"; readonly Aed: "AED"; readonly Afn: "AFN"; readonly All: "ALL"; readonly Amd: "AMD"; readonly Ars: "ARS"; readonly Aud: "AUD"; readonly Azn: "AZN"; readonly Bam: "BAM"; readonly Bdt: "BDT"; readonly Bhd: "BHD"; readonly Bif: "BIF"; readonly Bnd: "BND"; readonly Bob: "BOB"; readonly Brl: "BRL"; readonly Bwp: "BWP"; readonly Byn: "BYN"; readonly Bzd: "BZD"; readonly Cdf: "CDF"; readonly Chf: "CHF"; readonly Clp: "CLP"; readonly Cny: "CNY"; readonly Cop: "COP"; readonly Crc: "CRC"; readonly Cve: "CVE"; readonly Czk: "CZK"; readonly Djf: "DJF"; readonly Dkk: "DKK"; readonly Dop: "DOP"; readonly Dzd: "DZD"; readonly Egp: "EGP"; readonly Ern: "ERN"; readonly Etb: "ETB"; readonly Gbp: "GBP"; readonly Gel: "GEL"; readonly Ghs: "GHS"; readonly Gnf: "GNF"; readonly Gtq: "GTQ"; readonly Hkd: "HKD"; readonly Hnl: "HNL"; readonly Hrk: "HRK"; readonly Huf: "HUF"; readonly Idr: "IDR"; readonly Ils: "ILS"; readonly Inr: "INR"; readonly Iqd: "IQD"; readonly Irr: "IRR"; readonly Isk: "ISK"; readonly Jmd: "JMD"; readonly Jod: "JOD"; readonly Jpy: "JPY"; readonly Kes: "KES"; readonly Khr: "KHR"; readonly Krw: "KRW"; readonly Kwd: "KWD"; readonly Kzt: "KZT"; readonly Lbp: "LBP"; readonly Lkr: "LKR"; readonly Mad: "MAD"; readonly Mdl: "MDL"; readonly Mga: "MGA"; readonly Mkd: "MKD"; readonly Mmk: "MMK"; readonly Mop: "MOP"; readonly Mur: "MUR"; readonly Mxn: "MXN"; readonly Myr: "MYR"; readonly Mzn: "MZN"; readonly Nad: "NAD"; readonly Ngn: "NGN"; readonly Nio: "NIO"; readonly Nok: "NOK"; readonly Npr: "NPR"; readonly Nzd: "NZD"; readonly Omr: "OMR"; readonly Pab: "PAB"; readonly Pen: "PEN"; readonly Php: "PHP"; readonly Pkr: "PKR"; readonly Pln: "PLN"; readonly Pyg: "PYG"; readonly Qar: "QAR"; readonly Ron: "RON"; readonly Rsd: "RSD"; readonly Rub: "RUB"; readonly Rwf: "RWF"; readonly Sar: "SAR"; readonly Sdg: "SDG"; readonly Sek: "SEK"; readonly Sgd: "SGD"; readonly Sos: "SOS"; readonly Syp: "SYP"; readonly Thb: "THB"; readonly Tnd: "TND"; readonly Top: "TOP"; readonly Try: "TRY"; readonly Ttd: "TTD"; readonly Twd: "TWD"; readonly Tzs: "TZS"; readonly Uah: "UAH"; readonly Ugx: "UGX"; readonly Uyu: "UYU"; readonly Uzs: "UZS"; readonly Vef: "VEF"; readonly Vnd: "VND"; readonly Xaf: "XAF"; readonly Xof: "XOF"; readonly Yer: "YER"; readonly Zar: "ZAR"; }; export type ProductCurrencyCodesEnum = typeof ProductCurrencyCodesEnum[keyof typeof ProductCurrencyCodesEnum]; /** * URLs and files related to product documentation. * @export * @interface ProductDocuments */ export interface ProductDocuments { /** * URL to the cardholder agreement PDF file. * @type {string} * @memberof ProductDocuments */ 'cardholder_agreement_pdf'?: string; /** * URL to the cardholder agreement web page. * @type {string} * @memberof ProductDocuments */ 'cardholder_agreement_url'?: string; /** * URL to the privacy policy web page. * @type {string} * @memberof ProductDocuments */ 'privacy_policy_url'?: string; } /** * Details of the recipient of the reward * @export * @interface Recipient */ export interface Recipient { /** * Name of the recipient * @type {string} * @memberof Recipient */ 'name'?: string | null; /** * Email address of the recipient * @type {string} * @memberof Recipient */ 'email'?: string; /** * Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +). * @type {string} * @memberof Recipient */ 'phone'?: string; } /** * * @export * @interface RefundDetails */ export interface RefundDetails { /** * Total amount of the order refunds, denominated in `currency_code`. * @type {number} * @memberof RefundDetails */ 'total': number; /** * Currency of the refund. Always matches the organization\'s currency. * @type {string} * @memberof RefundDetails */ 'currency_code': string; } /** * Reports represent a collection of your Tremendous data that can be filtered and downloaded. The report object that is returned has a unique ID, a status, and an predicted time of report generation completion. When the report generation is complete, it will also contain an expiring url where you can retrieve your report. * @export * @interface Report */ export interface Report { /** * Tremendous ID of the report, used to retrieve your report * @type {string} * @memberof Report */ 'id'?: string; /** * Status of this report
Status Description
CREATED Report has been created
PROCESSING Report is currently being generated
READY_FOR_DOWNLOAD Report generation is complete and ready for download
FAILED Report failed to generate
* @type {string} * @memberof Report */ 'status'?: ReportStatusEnum; /** * Timestamp of when the report was created * @type {string} * @memberof Report */ 'created_at'?: string; /** * Timestamp of when the report is expected to finish generating. If the report is complete, this will return the time the report completed generating at. * @type {string} * @memberof Report */ 'expected_completion_at'?: string; /** * URL to download the report. Only returned when the report generation is complete and report is ready for download. URL is valid for 7 days from generation completion * @type {string} * @memberof Report */ 'url'?: string | null; } export declare const ReportStatusEnum: { readonly Created: "CREATED"; readonly Processing: "PROCESSING"; readonly ReadyForDownload: "READY_FOR_DOWNLOAD"; readonly Failed: "FAILED"; }; export type ReportStatusEnum = typeof ReportStatusEnum[keyof typeof ReportStatusEnum]; /** * * @export * @interface ResendReward422Response */ export interface ResendReward422Response { /** * HTTP status code of the response * @type {number} * @memberof ResendReward422Response */ 'status'?: number; /** * * @type {ListRewards401ResponseErrors} * @memberof ResendReward422Response */ 'errors': ListRewards401ResponseErrors; } /** * * @export * @interface ResendRewardRequest */ export interface ResendRewardRequest { /** * The new email address of the recipient (only for rewards delivered via email) * @type {string} * @memberof ResendRewardRequest */ 'updated_email'?: string; /** * The new phone number of the recipient (only for rewards delivered via SMS) * @type {string} * @memberof ResendRewardRequest */ 'updated_phone'?: string; } /** * Flag rewards redeemed in these countries. * @export * @interface ReviewCountry */ export interface ReviewCountry { /** * When type is `whitelist`, it flags any countries that *are not* present in the list. When type is `blacklist`, it flags any countries that *are* present in the list. * @type {string} * @memberof ReviewCountry */ 'type': ReviewCountryTypeEnum; /** * An array of country codes (ISO-3166 alpha-2 character code) * @type {Array} * @memberof ReviewCountry */ 'countries': Array; } export declare const ReviewCountryTypeEnum: { readonly Whitelist: "whitelist"; readonly Blacklist: "blacklist"; }; export type ReviewCountryTypeEnum = typeof ReviewCountryTypeEnum[keyof typeof ReviewCountryTypeEnum]; /** * List of countries where a matching redemption will trigger a review. * @export * @interface ReviewCountry1 */ export interface ReviewCountry1 { /** * An array of country codes (ISO-3166 alpha-2 character code) * @type {Array} * @memberof ReviewCountry1 */ 'countries': Array; } /** * Flag rewards with an email or domain matching this list. * @export * @interface ReviewEmail */ export interface ReviewEmail { /** * The list of emails. * @type {Array} * @memberof ReviewEmail */ 'emails'?: Array; /** * The list of domains. Any subdomains will also be matched against each entry in the list. * @type {Array} * @memberof ReviewEmail */ 'domains'?: Array; } /** * The list of emails and/or domains where a matching redemption will trigger a review. At least one email or domain is required. * @export * @interface ReviewEmail1 */ export interface ReviewEmail1 { /** * The list of emails. * @type {Array} * @memberof ReviewEmail1 */ 'emails'?: Array; /** * The list of domains. Any subdomains will also be matched against each entry in the list. * @type {Array} * @memberof ReviewEmail1 */ 'domains'?: Array; } /** * Flag rewards redeemed by an IP matching this list. * @export * @interface ReviewIp */ export interface ReviewIp { /** * The list of IP addresses to flag or allow. Accepts both IPv4 and IPv6 addresses using CIDR notation. * @type {Array} * @memberof ReviewIp */ 'ips': Array; } /** * List of IP addresses and/or IP ranges where a matching redemption will trigger a review. * @export * @interface ReviewIp1 */ export interface ReviewIp1 { /** * The list of IP addresses to flag or allow. Accepts both IPv4 and IPv6 addresses using CIDR notation. * @type {Array} * @memberof ReviewIp1 */ 'ips': Array; } /** * If a recipient, device, or IP redeems more than this dollar value of rewards, flag for review. * @export * @interface ReviewRedeemedRewardsAmount */ export interface ReviewRedeemedRewardsAmount { /** * The total amount of redeemed rewards to use as a threshold. The amount is denominated in the organization\'s currency. * @type {number} * @memberof ReviewRedeemedRewardsAmount */ 'amount': number; /** * The period, in days, to consider for the count. Use `all_time` to consider any redeemed rewards. * @type {string} * @memberof ReviewRedeemedRewardsAmount */ 'period': ReviewRedeemedRewardsAmountPeriodEnum; } export declare const ReviewRedeemedRewardsAmountPeriodEnum: { readonly _7: "7"; readonly _30: "30"; readonly _90: "90"; readonly _120: "120"; readonly _365: "365"; readonly AllTime: "all_time"; }; export type ReviewRedeemedRewardsAmountPeriodEnum = typeof ReviewRedeemedRewardsAmountPeriodEnum[keyof typeof ReviewRedeemedRewardsAmountPeriodEnum]; /** * If a recipient, device, or IP redeems more than this number of rewards, flag for review. * @export * @interface ReviewRedeemedRewardsCount */ export interface ReviewRedeemedRewardsCount { /** * The number of redeemed rewards to use as a threshold. * @type {number} * @memberof ReviewRedeemedRewardsCount */ 'amount': number; /** * The period, in days, to consider for the count. Use `all_time` to consider any redeemed rewards. * @type {string} * @memberof ReviewRedeemedRewardsCount */ 'period': ReviewRedeemedRewardsCountPeriodEnum; } export declare const ReviewRedeemedRewardsCountPeriodEnum: { readonly _7: "7"; readonly _30: "30"; readonly _90: "90"; readonly _120: "120"; readonly _365: "365"; readonly AllTime: "all_time"; }; export type ReviewRedeemedRewardsCountPeriodEnum = typeof ReviewRedeemedRewardsCountPeriodEnum[keyof typeof ReviewRedeemedRewardsCountPeriodEnum]; /** * Flag rewards redeemed through VPN or proxy traffic. By default, Apple Private Relay traffic is flagged; set `skip_apple_private_relay` to true to exclude it. * @export * @interface ReviewVpn */ export interface ReviewVpn { /** * Whether Apple Private Relay traffic should be excluded from VPN fraud review. When omitted or false, Apple Private Relay traffic is flagged with other VPN and proxy traffic. * @type {boolean} * @memberof ReviewVpn */ 'skip_apple_private_relay'?: boolean; } /** * A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified. * @export * @interface Reward */ export interface Reward { /** * Tremendous ID of the reward * @type {string} * @memberof Reward */ 'id'?: string; /** * Tremendous ID of the order this reward is part of. * @type {string} * @memberof Reward */ 'order_id'?: string; /** * Date the reward was created * @type {string} * @memberof Reward */ 'created_at'?: string; /** * Expiration date of the reward. If null, the reward does not expire. * @type {string} * @memberof Reward */ 'expires_at'?: string | null; /** * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from. * @type {string} * @memberof Reward */ 'campaign_id'?: string | null; /** * List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from. Providing a `products` array will override the products made available by the campaign specified using the `campaign_id` property unless the `products` array is empty. It will _not_ override other campaign attributes, like the message and customization of the look and feel. * @type {Array} * @memberof Reward */ 'products'?: Array; /** * * @type {ListRewards200ResponseRewardsInnerValue} * @memberof Reward */ 'value'?: ListRewards200ResponseRewardsInnerValue; /** * * @type {ListRewards200ResponseRewardsInnerRecipient} * @memberof Reward */ 'recipient'?: ListRewards200ResponseRewardsInnerRecipient; /** * Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored. * @type {string} * @memberof Reward */ 'deliver_at'?: string; /** * * @type {Array} * @memberof Reward */ 'custom_fields'?: Array; /** * * @type {RewardWithoutLinkDelivery} * @memberof Reward */ 'delivery'?: RewardWithoutLinkDelivery; } /** * A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified. * @export * @interface RewardBase */ export interface RewardBase { /** * Tremendous ID of the reward * @type {string} * @memberof RewardBase */ 'id'?: string; /** * Tremendous ID of the order this reward is part of. * @type {string} * @memberof RewardBase */ 'order_id'?: string; /** * Date the reward was created * @type {string} * @memberof RewardBase */ 'created_at'?: string; /** * Expiration date of the reward. If null, the reward does not expire. * @type {string} * @memberof RewardBase */ 'expires_at'?: string | null; /** * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from. * @type {string} * @memberof RewardBase */ 'campaign_id'?: string | null; /** * List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from. Providing a `products` array will override the products made available by the campaign specified using the `campaign_id` property unless the `products` array is empty. It will _not_ override other campaign attributes, like the message and customization of the look and feel. * @type {Array} * @memberof RewardBase */ 'products'?: Array; /** * * @type {ListRewards200ResponseRewardsInnerValue} * @memberof RewardBase */ 'value'?: ListRewards200ResponseRewardsInnerValue; /** * * @type {ListRewards200ResponseRewardsInnerRecipient} * @memberof RewardBase */ 'recipient'?: ListRewards200ResponseRewardsInnerRecipient; /** * Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored. * @type {string} * @memberof RewardBase */ 'deliver_at'?: string; /** * * @type {Array} * @memberof RewardBase */ 'custom_fields'?: Array; } /** * Reward custom data for searching, tracking or copy (see [Adding custom fields to orders](https://developers.tremendous.com/docs/using-custom-fields-to-add-custom-data-to-rewards).) * @export * @interface RewardBaseCustomFieldsInner */ export interface RewardBaseCustomFieldsInner { /** * Tremendous ID of the custom field * @type {string} * @memberof RewardBaseCustomFieldsInner */ 'id'?: string; /** * Value of the custom field * @type {string} * @memberof RewardBaseCustomFieldsInner */ 'value'?: string | null; /** * Label of the custom field * @type {string} * @memberof RewardBaseCustomFieldsInner */ 'label'?: string; } /** * A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified. * @export * @interface RewardForOrderCreate */ export interface RewardForOrderCreate { /** * Tremendous ID of the reward * @type {string} * @memberof RewardForOrderCreate */ 'id'?: string; /** * Tremendous ID of the order this reward is part of. * @type {string} * @memberof RewardForOrderCreate */ 'order_id'?: string; /** * Date the reward was created * @type {string} * @memberof RewardForOrderCreate */ 'created_at'?: string; /** * Expiration date of the reward. If null, the reward does not expire. * @type {string} * @memberof RewardForOrderCreate */ 'expires_at'?: string | null; /** * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from. * @type {string} * @memberof RewardForOrderCreate */ 'campaign_id'?: string | null; /** * List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from. Providing a `products` array will override the products made available by the campaign specified using the `campaign_id` property unless the `products` array is empty. It will _not_ override other campaign attributes, like the message and customization of the look and feel. * @type {Array} * @memberof RewardForOrderCreate */ 'products'?: Array; /** * * @type {ListRewards200ResponseRewardsInnerValue} * @memberof RewardForOrderCreate */ 'value'?: ListRewards200ResponseRewardsInnerValue; /** * * @type {ListRewards200ResponseRewardsInnerRecipient} * @memberof RewardForOrderCreate */ 'recipient'?: ListRewards200ResponseRewardsInnerRecipient; /** * Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored. * @type {string} * @memberof RewardForOrderCreate */ 'deliver_at'?: string; /** * * @type {Array} * @memberof RewardForOrderCreate */ 'custom_fields'?: Array; /** * Set this to translate the redemption experience for this reward. Pass a 2-letter [ISO-639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the desired language. Defaults to `en`. * @type {string} * @memberof RewardForOrderCreate */ 'language'?: string; /** * * @type {SingleRewardOrderRewardDelivery} * @memberof RewardForOrderCreate */ 'delivery'?: SingleRewardOrderRewardDelivery; } /** * The redemption link for a reward. * @export * @interface RewardLink */ export interface RewardLink { /** * Tremendous ID of the reward * @type {string} * @memberof RewardLink */ 'id'?: string; /** * Link to redeem the reward at. You need to deliver this link to the recipient. * @type {string} * @memberof RewardLink */ 'link'?: string; } /** * The redemption token for a reward. * @export * @interface RewardToken */ export interface RewardToken { /** * Tremendous ID of the reward * @type {string} * @memberof RewardToken */ 'id'?: string; /** * The token to redeem the reward. * @type {string} * @memberof RewardToken */ 'token'?: string; /** * Date the token expires * @type {string} * @memberof RewardToken */ 'expires_at'?: string; } /** * * @export * @interface RewardValue */ export interface RewardValue { /** * Amount of the reward * @type {number} * @memberof RewardValue */ 'denomination': number; /** * Currency of the reward. Defaults to the organization\'s currency if not provided. * @type {string} * @memberof RewardValue */ 'currency_code'?: RewardValueCurrencyCodeEnum; } export declare const RewardValueCurrencyCodeEnum: { readonly Usd: "USD"; readonly Cad: "CAD"; readonly Eur: "EUR"; readonly Aed: "AED"; readonly Afn: "AFN"; readonly All: "ALL"; readonly Amd: "AMD"; readonly Ars: "ARS"; readonly Aud: "AUD"; readonly Azn: "AZN"; readonly Bam: "BAM"; readonly Bdt: "BDT"; readonly Bhd: "BHD"; readonly Bif: "BIF"; readonly Bnd: "BND"; readonly Bob: "BOB"; readonly Brl: "BRL"; readonly Bwp: "BWP"; readonly Byn: "BYN"; readonly Bzd: "BZD"; readonly Cdf: "CDF"; readonly Chf: "CHF"; readonly Clp: "CLP"; readonly Cny: "CNY"; readonly Cop: "COP"; readonly Crc: "CRC"; readonly Cve: "CVE"; readonly Czk: "CZK"; readonly Djf: "DJF"; readonly Dkk: "DKK"; readonly Dop: "DOP"; readonly Dzd: "DZD"; readonly Egp: "EGP"; readonly Ern: "ERN"; readonly Etb: "ETB"; readonly Gbp: "GBP"; readonly Gel: "GEL"; readonly Ghs: "GHS"; readonly Gnf: "GNF"; readonly Gtq: "GTQ"; readonly Hkd: "HKD"; readonly Hnl: "HNL"; readonly Hrk: "HRK"; readonly Huf: "HUF"; readonly Idr: "IDR"; readonly Ils: "ILS"; readonly Inr: "INR"; readonly Iqd: "IQD"; readonly Irr: "IRR"; readonly Isk: "ISK"; readonly Jmd: "JMD"; readonly Jod: "JOD"; readonly Jpy: "JPY"; readonly Kes: "KES"; readonly Khr: "KHR"; readonly Krw: "KRW"; readonly Kwd: "KWD"; readonly Kzt: "KZT"; readonly Lbp: "LBP"; readonly Lkr: "LKR"; readonly Mad: "MAD"; readonly Mdl: "MDL"; readonly Mga: "MGA"; readonly Mkd: "MKD"; readonly Mmk: "MMK"; readonly Mop: "MOP"; readonly Mur: "MUR"; readonly Mxn: "MXN"; readonly Myr: "MYR"; readonly Mzn: "MZN"; readonly Nad: "NAD"; readonly Ngn: "NGN"; readonly Nio: "NIO"; readonly Nok: "NOK"; readonly Npr: "NPR"; readonly Nzd: "NZD"; readonly Omr: "OMR"; readonly Pab: "PAB"; readonly Pen: "PEN"; readonly Php: "PHP"; readonly Pkr: "PKR"; readonly Pln: "PLN"; readonly Pyg: "PYG"; readonly Qar: "QAR"; readonly Ron: "RON"; readonly Rsd: "RSD"; readonly Rub: "RUB"; readonly Rwf: "RWF"; readonly Sar: "SAR"; readonly Sdg: "SDG"; readonly Sek: "SEK"; readonly Sgd: "SGD"; readonly Sos: "SOS"; readonly Syp: "SYP"; readonly Thb: "THB"; readonly Tnd: "TND"; readonly Top: "TOP"; readonly Try: "TRY"; readonly Ttd: "TTD"; readonly Twd: "TWD"; readonly Tzs: "TZS"; readonly Uah: "UAH"; readonly Ugx: "UGX"; readonly Uyu: "UYU"; readonly Uzs: "UZS"; readonly Vef: "VEF"; readonly Vnd: "VND"; readonly Xaf: "XAF"; readonly Xof: "XOF"; readonly Yer: "YER"; readonly Zar: "ZAR"; }; export type RewardValueCurrencyCodeEnum = typeof RewardValueCurrencyCodeEnum[keyof typeof RewardValueCurrencyCodeEnum]; /** * A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified. * @export * @interface RewardWithLink */ export interface RewardWithLink { /** * Tremendous ID of the reward * @type {string} * @memberof RewardWithLink */ 'id'?: string; /** * Tremendous ID of the order this reward is part of. * @type {string} * @memberof RewardWithLink */ 'order_id'?: string; /** * Date the reward was created * @type {string} * @memberof RewardWithLink */ 'created_at'?: string; /** * Expiration date of the reward. If null, the reward does not expire. * @type {string} * @memberof RewardWithLink */ 'expires_at'?: string | null; /** * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from. * @type {string} * @memberof RewardWithLink */ 'campaign_id'?: string | null; /** * List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from. Providing a `products` array will override the products made available by the campaign specified using the `campaign_id` property unless the `products` array is empty. It will _not_ override other campaign attributes, like the message and customization of the look and feel. * @type {Array} * @memberof RewardWithLink */ 'products'?: Array; /** * * @type {ListRewards200ResponseRewardsInnerValue} * @memberof RewardWithLink */ 'value'?: ListRewards200ResponseRewardsInnerValue; /** * * @type {ListRewards200ResponseRewardsInnerRecipient} * @memberof RewardWithLink */ 'recipient'?: ListRewards200ResponseRewardsInnerRecipient; /** * Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored. * @type {string} * @memberof RewardWithLink */ 'deliver_at'?: string; /** * * @type {Array} * @memberof RewardWithLink */ 'custom_fields'?: Array; /** * * @type {RewardWithLinkDelivery} * @memberof RewardWithLink */ 'delivery'?: RewardWithLinkDelivery; } /** * Details on how the reward is delivered to the recipient. * @export * @interface RewardWithLinkDelivery */ export interface RewardWithLinkDelivery { /** * How to deliver the reward to the recipient.
Delivery Method Description
EMAIL Deliver the reward to the recipient by email
LINK

Deliver the reward to the recipient via a link.

The initial POST /orders response for a link reward includes the link in delivery.link.

The link must then be delivered to the recipient out-of-band.

To obtain a new link for an existing reward, call POST /rewards/{id}/generate_link.

PHONE Deliver the reward to the recipient by SMS
* @type {string} * @memberof RewardWithLinkDelivery */ 'method': RewardWithLinkDeliveryMethodEnum; /** * Current status of the delivery of the reward: * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link active). * `PENDING` - Delivery is pending but not yet scheduled. * @type {string} * @memberof RewardWithLinkDelivery */ 'status': RewardWithLinkDeliveryStatusEnum; /** * Link to redeem the reward at. You need to deliver this link to the recipient. * @type {string} * @memberof RewardWithLinkDelivery */ 'link'?: string; } export declare const RewardWithLinkDeliveryMethodEnum: { readonly Email: "EMAIL"; readonly Link: "LINK"; readonly Phone: "PHONE"; }; export type RewardWithLinkDeliveryMethodEnum = typeof RewardWithLinkDeliveryMethodEnum[keyof typeof RewardWithLinkDeliveryMethodEnum]; export declare const RewardWithLinkDeliveryStatusEnum: { readonly Scheduled: "SCHEDULED"; readonly Failed: "FAILED"; readonly Succeeded: "SUCCEEDED"; readonly Pending: "PENDING"; }; export type RewardWithLinkDeliveryStatusEnum = typeof RewardWithLinkDeliveryStatusEnum[keyof typeof RewardWithLinkDeliveryStatusEnum]; /** * A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified. * @export * @interface RewardWithoutLink */ export interface RewardWithoutLink { /** * Tremendous ID of the reward * @type {string} * @memberof RewardWithoutLink */ 'id'?: string; /** * Tremendous ID of the order this reward is part of. * @type {string} * @memberof RewardWithoutLink */ 'order_id'?: string; /** * Date the reward was created * @type {string} * @memberof RewardWithoutLink */ 'created_at'?: string; /** * Expiration date of the reward. If null, the reward does not expire. * @type {string} * @memberof RewardWithoutLink */ 'expires_at'?: string | null; /** * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from. * @type {string} * @memberof RewardWithoutLink */ 'campaign_id'?: string | null; /** * List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from. Providing a `products` array will override the products made available by the campaign specified using the `campaign_id` property unless the `products` array is empty. It will _not_ override other campaign attributes, like the message and customization of the look and feel. * @type {Array} * @memberof RewardWithoutLink */ 'products'?: Array; /** * * @type {ListRewards200ResponseRewardsInnerValue} * @memberof RewardWithoutLink */ 'value'?: ListRewards200ResponseRewardsInnerValue; /** * * @type {ListRewards200ResponseRewardsInnerRecipient} * @memberof RewardWithoutLink */ 'recipient'?: ListRewards200ResponseRewardsInnerRecipient; /** * Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored. * @type {string} * @memberof RewardWithoutLink */ 'deliver_at'?: string; /** * * @type {Array} * @memberof RewardWithoutLink */ 'custom_fields'?: Array; /** * * @type {RewardWithoutLinkDelivery} * @memberof RewardWithoutLink */ 'delivery'?: RewardWithoutLinkDelivery; } /** * Details on how the reward is delivered to the recipient. * @export * @interface RewardWithoutLinkDelivery */ export interface RewardWithoutLinkDelivery { /** * How to deliver the reward to the recipient.
Delivery Method Description
EMAIL Deliver the reward to the recipient by email
LINK

Deliver the reward to the recipient via a link.

The initial POST /orders response for a link reward includes the link in delivery.link.

The link must then be delivered to the recipient out-of-band.

To obtain a new link for an existing reward, call POST /rewards/{id}/generate_link.

PHONE Deliver the reward to the recipient by SMS
* @type {string} * @memberof RewardWithoutLinkDelivery */ 'method'?: RewardWithoutLinkDeliveryMethodEnum; /** * Current status of the delivery of the reward: * `SCHEDULED` - Reward is scheduled for delivery and will be delivered soon. * `FAILED` - Delivery of reward failed (e.g. email bounced). * `SUCCEEDED` - Reward was successfully delivered (email or text message delivered or reward link active). * `PENDING` - Delivery is pending but not yet scheduled. * @type {string} * @memberof RewardWithoutLinkDelivery */ 'status'?: RewardWithoutLinkDeliveryStatusEnum; } export declare const RewardWithoutLinkDeliveryMethodEnum: { readonly Email: "EMAIL"; readonly Link: "LINK"; readonly Phone: "PHONE"; }; export type RewardWithoutLinkDeliveryMethodEnum = typeof RewardWithoutLinkDeliveryMethodEnum[keyof typeof RewardWithoutLinkDeliveryMethodEnum]; export declare const RewardWithoutLinkDeliveryStatusEnum: { readonly Scheduled: "SCHEDULED"; readonly Failed: "FAILED"; readonly Succeeded: "SUCCEEDED"; readonly Pending: "PENDING"; }; export type RewardWithoutLinkDeliveryStatusEnum = typeof RewardWithoutLinkDeliveryStatusEnum[keyof typeof RewardWithoutLinkDeliveryStatusEnum]; /** * Each organization member is assigned a role that defines the permissions they have within the organization. * @export * @interface Role */ export interface Role { /** * * @type {string} * @memberof Role */ 'id': string; /** * * @type {string} * @memberof Role */ 'title': string; /** * * @type {string} * @memberof Role */ 'description': string; } /** * * @export * @interface SimulateWebhookRequest */ export interface SimulateWebhookRequest { /** * The event to test. See the [List events endpoint reference](/reference/get_webhooks-id-events) for all available events. * @type {string} * @memberof SimulateWebhookRequest */ 'event': string; } /** * An order that contains a single reward. The reward is sent to a single recipient. * @export * @interface SingleRewardOrder */ export interface SingleRewardOrder { /** * Reference for this order, supplied by the customer. When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders. It also allows for retrieving by `external_id` instead of `id` only. * @type {string} * @memberof SingleRewardOrder */ 'external_id'?: string | null; /** * * @type {SingleRewardOrderPayment} * @memberof SingleRewardOrder */ 'payment'?: SingleRewardOrderPayment; /** * * @type {SingleRewardOrderReward} * @memberof SingleRewardOrder */ 'reward': SingleRewardOrderReward; } /** * * @export * @interface SingleRewardOrderPayment */ export interface SingleRewardOrderPayment { /** * Tremendous ID of the funding source that will be used to pay for the order. Use `balance` to use your Tremendous\'s balance. * @type {string} * @memberof SingleRewardOrderPayment */ 'funding_source_id': string; } /** * A single reward, sent to a recipient. A reward is always part of an order. Either `products` or `campaign_id` must be specified. * @export * @interface SingleRewardOrderReward */ export interface SingleRewardOrderReward { /** * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from. * @type {string} * @memberof SingleRewardOrderReward */ 'campaign_id'?: string | null; /** * List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from. Providing a `products` array will override the products made available by the campaign specified using the `campaign_id` property unless the `products` array is empty. It will _not_ override other campaign attributes, like the message and customization of the look and feel. * @type {Array} * @memberof SingleRewardOrderReward */ 'products'?: Array; /** * * @type {ListRewards200ResponseRewardsInnerValue} * @memberof SingleRewardOrderReward */ 'value'?: ListRewards200ResponseRewardsInnerValue; /** * * @type {ListRewards200ResponseRewardsInnerRecipient} * @memberof SingleRewardOrderReward */ 'recipient'?: ListRewards200ResponseRewardsInnerRecipient; /** * Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored. * @type {string} * @memberof SingleRewardOrderReward */ 'deliver_at'?: string; /** * * @type {Array} * @memberof SingleRewardOrderReward */ 'custom_fields'?: Array; /** * Set this to translate the redemption experience for this reward. Pass a 2-letter [ISO-639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the desired language. Defaults to `en`. * @type {string} * @memberof SingleRewardOrderReward */ 'language'?: string; /** * * @type {SingleRewardOrderRewardDelivery} * @memberof SingleRewardOrderReward */ 'delivery'?: SingleRewardOrderRewardDelivery; } /** * Reward custom data for searching, tracking or copy (see [Adding custom fields to orders](https://developers.tremendous.com/docs/using-custom-fields-to-add-custom-data-to-rewards).) * @export * @interface SingleRewardOrderRewardCustomFieldsInner */ export interface SingleRewardOrderRewardCustomFieldsInner { /** * Tremendous ID of the custom field * @type {string} * @memberof SingleRewardOrderRewardCustomFieldsInner */ 'id'?: string; /** * Value of the custom field * @type {string} * @memberof SingleRewardOrderRewardCustomFieldsInner */ 'value'?: string | null; } /** * Details on how the reward is delivered to the recipient. * @export * @interface SingleRewardOrderRewardDelivery */ export interface SingleRewardOrderRewardDelivery { /** * How to deliver the reward to the recipient.
Delivery Method Description
EMAIL Deliver the reward to the recipient by email
LINK

Deliver the reward to the recipient via a link.

The initial POST /orders response for a link reward includes the link in delivery.link.

The link must then be delivered to the recipient out-of-band.

To obtain a new link for an existing reward, call POST /rewards/{id}/generate_link.

PHONE Deliver the reward to the recipient by SMS
* @type {string} * @memberof SingleRewardOrderRewardDelivery */ 'method'?: SingleRewardOrderRewardDeliveryMethodEnum; /** * * @type {SingleRewardOrderRewardDeliveryMeta} * @memberof SingleRewardOrderRewardDelivery */ 'meta'?: SingleRewardOrderRewardDeliveryMeta; } export declare const SingleRewardOrderRewardDeliveryMethodEnum: { readonly Email: "EMAIL"; readonly Link: "LINK"; readonly Phone: "PHONE"; }; export type SingleRewardOrderRewardDeliveryMethodEnum = typeof SingleRewardOrderRewardDeliveryMethodEnum[keyof typeof SingleRewardOrderRewardDeliveryMethodEnum]; /** * Customizable reward delivery metadata, taking precedence over the related campaign settings. * @export * @interface SingleRewardOrderRewardDeliveryMeta */ export interface SingleRewardOrderRewardDeliveryMeta { /** * The \"sender name\" used in the delivery. If it\'s an email reward, \"via Tremendous\" will be appended to the value. Please note that you cannot customize the sender email. * @type {string} * @memberof SingleRewardOrderRewardDeliveryMeta */ 'sender_name'?: string; /** * The subject line used in the delivery. * @type {string} * @memberof SingleRewardOrderRewardDeliveryMeta */ 'subject_line'?: string; /** * The content of the message of the reward, shown in the email / SMS and on the landing page. * @type {string} * @memberof SingleRewardOrderRewardDeliveryMeta */ 'message'?: string; } /** * * @export * @interface SingleRewardOrderWithLink */ export interface SingleRewardOrderWithLink { /** * * @type {SingleRewardOrderWithLinkOrder} * @memberof SingleRewardOrderWithLink */ 'order': SingleRewardOrderWithLinkOrder; } /** * An order wraps around the fulfilment of one or more rewards. * @export * @interface SingleRewardOrderWithLinkOrder */ export interface SingleRewardOrderWithLinkOrder { /** * Tremendous ID of the order * @type {string} * @memberof SingleRewardOrderWithLinkOrder */ 'id': string; /** * Reference for this order, supplied by the customer. When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders. It also allows for retrieving by `external_id` instead of `id` only. * @type {string} * @memberof SingleRewardOrderWithLinkOrder */ 'external_id'?: string | null; /** * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from. * @type {string} * @memberof SingleRewardOrderWithLinkOrder */ 'campaign_id'?: string | null; /** * Date the order was created * @type {string} * @memberof SingleRewardOrderWithLinkOrder */ 'created_at': string; /** * Execution status of a given order
Status Description
CANCELED The order and all of its rewards were canceled.
OPEN The order has been created, but hasn\'t yet been processed.
EXECUTED The order has been executed. Payment has been handled and rewards are being delivered (if applicable).
FAILED The order could not be processed due to an error. E.g. due to insufficient funds in the account.
PENDING APPROVAL The order has been created but needs approval to be executed.
PENDING INTERNAL PAYMENT APPROVAL The order has been created but it is under review and requires approval from our team.
PENDING SETTLEMENT The order has been created but the funds are being held until the settlement window clears.
* @type {string} * @memberof SingleRewardOrderWithLinkOrder */ 'status': SingleRewardOrderWithLinkOrderStatusEnum; /** * Name of the channel in which the order was created * @type {string} * @memberof SingleRewardOrderWithLinkOrder */ 'channel'?: SingleRewardOrderWithLinkOrderChannelEnum; /** * * @type {OrderBasePayment} * @memberof SingleRewardOrderWithLinkOrder */ 'payment'?: OrderBasePayment; /** * The ID for the invoice associated with this order * @type {string} * @memberof SingleRewardOrderWithLinkOrder */ 'invoice_id'?: string; /** * * @type {Array} * @memberof SingleRewardOrderWithLinkOrder */ 'rewards'?: Array; } export declare const SingleRewardOrderWithLinkOrderStatusEnum: { readonly Canceled: "CANCELED"; readonly Open: "OPEN"; readonly Executed: "EXECUTED"; readonly Failed: "FAILED"; readonly PendingApproval: "PENDING APPROVAL"; readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL"; readonly PendingSettlement: "PENDING SETTLEMENT"; }; export type SingleRewardOrderWithLinkOrderStatusEnum = typeof SingleRewardOrderWithLinkOrderStatusEnum[keyof typeof SingleRewardOrderWithLinkOrderStatusEnum]; export declare const SingleRewardOrderWithLinkOrderChannelEnum: { readonly Ui: "UI"; readonly Api: "API"; readonly Embed: "EMBED"; readonly Decipher: "DECIPHER"; readonly Qualtrics: "QUALTRICS"; readonly Typeform: "TYPEFORM"; readonly SurveyMonkey: "SURVEY MONKEY"; readonly Yotpo: "YOTPO"; }; export type SingleRewardOrderWithLinkOrderChannelEnum = typeof SingleRewardOrderWithLinkOrderChannelEnum[keyof typeof SingleRewardOrderWithLinkOrderChannelEnum]; /** * * @export * @interface SingleRewardOrderWithoutLink */ export interface SingleRewardOrderWithoutLink { /** * * @type {SingleRewardOrderWithoutLinkOrder} * @memberof SingleRewardOrderWithoutLink */ 'order': SingleRewardOrderWithoutLinkOrder; } /** * An order wraps around the fulfilment of one or more rewards. * @export * @interface SingleRewardOrderWithoutLinkOrder */ export interface SingleRewardOrderWithoutLinkOrder { /** * Tremendous ID of the order * @type {string} * @memberof SingleRewardOrderWithoutLinkOrder */ 'id': string; /** * Reference for this order, supplied by the customer. When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders. It also allows for retrieving by `external_id` instead of `id` only. * @type {string} * @memberof SingleRewardOrderWithoutLinkOrder */ 'external_id'?: string | null; /** * ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from. * @type {string} * @memberof SingleRewardOrderWithoutLinkOrder */ 'campaign_id'?: string | null; /** * Date the order was created * @type {string} * @memberof SingleRewardOrderWithoutLinkOrder */ 'created_at': string; /** * Execution status of a given order
Status Description
CANCELED The order and all of its rewards were canceled.
OPEN The order has been created, but hasn\'t yet been processed.
EXECUTED The order has been executed. Payment has been handled and rewards are being delivered (if applicable).
FAILED The order could not be processed due to an error. E.g. due to insufficient funds in the account.
PENDING APPROVAL The order has been created but needs approval to be executed.
PENDING INTERNAL PAYMENT APPROVAL The order has been created but it is under review and requires approval from our team.
PENDING SETTLEMENT The order has been created but the funds are being held until the settlement window clears.
* @type {string} * @memberof SingleRewardOrderWithoutLinkOrder */ 'status': SingleRewardOrderWithoutLinkOrderStatusEnum; /** * Name of the channel in which the order was created * @type {string} * @memberof SingleRewardOrderWithoutLinkOrder */ 'channel'?: SingleRewardOrderWithoutLinkOrderChannelEnum; /** * * @type {OrderBasePayment} * @memberof SingleRewardOrderWithoutLinkOrder */ 'payment'?: OrderBasePayment; /** * The ID for the invoice associated with this order * @type {string} * @memberof SingleRewardOrderWithoutLinkOrder */ 'invoice_id'?: string; /** * * @type {Array} * @memberof SingleRewardOrderWithoutLinkOrder */ 'rewards'?: Array; } export declare const SingleRewardOrderWithoutLinkOrderStatusEnum: { readonly Canceled: "CANCELED"; readonly Open: "OPEN"; readonly Executed: "EXECUTED"; readonly Failed: "FAILED"; readonly PendingApproval: "PENDING APPROVAL"; readonly PendingInternalPaymentApproval: "PENDING INTERNAL PAYMENT APPROVAL"; readonly PendingSettlement: "PENDING SETTLEMENT"; }; export type SingleRewardOrderWithoutLinkOrderStatusEnum = typeof SingleRewardOrderWithoutLinkOrderStatusEnum[keyof typeof SingleRewardOrderWithoutLinkOrderStatusEnum]; export declare const SingleRewardOrderWithoutLinkOrderChannelEnum: { readonly Ui: "UI"; readonly Api: "API"; readonly Embed: "EMBED"; readonly Decipher: "DECIPHER"; readonly Qualtrics: "QUALTRICS"; readonly Typeform: "TYPEFORM"; readonly SurveyMonkey: "SURVEY MONKEY"; readonly Yotpo: "YOTPO"; }; export type SingleRewardOrderWithoutLinkOrderChannelEnum = typeof SingleRewardOrderWithoutLinkOrderChannelEnum[keyof typeof SingleRewardOrderWithoutLinkOrderChannelEnum]; /** * * @export * @interface Topup */ export interface Topup { /** * Unique identifier for the topup request. * @type {string} * @memberof Topup */ 'id'?: string; /** * Amount to add to your organization\'s balance, denominated in `currency_code`. * @type {number} * @memberof Topup */ 'amount'?: number; /** * Currency of the topup amount. Always matches the organization\'s currency. * @type {string} * @memberof Topup */ 'currency_code'?: string; /** * Amount of the processing fee for the topup (typically reserved for credit card topups). * @type {number} * @memberof Topup */ 'processing_fee'?: number; /** * ID of the funding_source object used for this topup. * @type {string} * @memberof Topup */ 'funding_source_id'?: string; /** * Status of the topup
Status Description
created The topup is processing (and may be under review).
partially_credited Some funds have been credited to the balance. The remainder will be credited by expected_settlement_at.
fully_credited All funds have been added to the balance.
reversed The topup was credited, but then reversed due to a chargeback or ACH return.
rejected The topup was rejected by an admin.
* @type {string} * @memberof Topup */ 'status'?: string; /** * Timestamp indicating when the topup object was created (when the request was made). * @type {string} * @memberof Topup */ 'created_at'?: string; /** * Timestamp indicating when the topup amount was fully credited to the balance. * @type {string} * @memberof Topup */ 'fully_credited_at'?: string | null; /** * Timestamp indicating when the topup was rejected. * @type {string} * @memberof Topup */ 'rejected_at'?: string | null; /** * Timestamp indicating when the topup was reversed. * @type {string} * @memberof Topup */ 'reversed_at'?: string | null; /** * A sentence explaining why the topup was reversed. * @type {string} * @memberof Topup */ 'reversed_reason'?: string | null; /** * Idempotency key to prevent duplicate requests. * @type {string} * @memberof Topup */ 'idempotency_key'?: string | null; /** * Amount credited to the balance immediately. Equals `amount` for non-ACH topups or ACH debits fully within instant funding limits. Can be 0 if nothing was credited instantly. * @type {number} * @memberof Topup */ 'instant_credit_amount'?: number; /** * Amount that will be available once the settlement period elapses. 0 if nothing is settling. * @type {number} * @memberof Topup */ 'settled_amount'?: number; /** * Timestamp indicating when the pending amount will be credited to the balance. Null if the topup was fully credited immediately. * @type {string} * @memberof Topup */ 'expected_settlement_at'?: string | null; } /** * * @export * @interface TopupCreateRequest */ export interface TopupCreateRequest { /** * The ID of the funding source to top up. * @type {string} * @memberof TopupCreateRequest */ 'funding_source_id': string; /** * Unique key that ensures this request is only processed once. * @type {string} * @memberof TopupCreateRequest */ 'idempotency_key': string; /** * Amount to add to your organization\'s balance, denominated in `currency_code`. * @type {number} * @memberof TopupCreateRequest */ 'amount': number; } /** * With a campaign you can define the look & feel of how rewards are sent out. It also lets you set the available products (different gift cards, charity, etc.) recipients can choose from. * @export * @interface UpdateCampaign */ export interface UpdateCampaign { /** * * @type {string} * @memberof UpdateCampaign */ 'id'?: string; /** * Name of the campaign * @type {string} * @memberof UpdateCampaign */ 'name'?: string; /** * Description of the campaign * @type {string} * @memberof UpdateCampaign */ 'description'?: string | null; /** * List of IDs of products (different gift cards, charity, etc.) that are available in this campaign. * @type {Array} * @memberof UpdateCampaign */ 'products'?: Array; /** * Determines whether fees for premium products are added to the order total (`SENDER`) or deducted from the recipient\'s reward amount (`RECIPIENT`). Campaigns with `RECIPIENT` must include at least one fee-free product. * @type {string} * @memberof UpdateCampaign */ 'fee_charged_to'?: UpdateCampaignFeeChargedToEnum | null; /** * * @type {ListCampaigns200ResponseCampaignsInnerAutoAddProductRule} * @memberof UpdateCampaign */ 'auto_add_product_rule'?: ListCampaigns200ResponseCampaignsInnerAutoAddProductRule | null; /** * * @type {ListCampaigns200ResponseCampaignsInnerWebpageStyle} * @memberof UpdateCampaign */ 'webpage_style'?: ListCampaigns200ResponseCampaignsInnerWebpageStyle; /** * * @type {ListCampaigns200ResponseCampaignsInnerEmailStyle} * @memberof UpdateCampaign */ 'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle; } export declare const UpdateCampaignFeeChargedToEnum: { readonly Sender: "SENDER"; readonly Recipient: "RECIPIENT"; }; export type UpdateCampaignFeeChargedToEnum = typeof UpdateCampaignFeeChargedToEnum[keyof typeof UpdateCampaignFeeChargedToEnum]; /** * With a campaign you can define the look & feel of how rewards are sent out. It also lets you set the available products (different gift cards, charity, etc.) recipients can choose from. * @export * @interface UpdateCampaignRequest */ export interface UpdateCampaignRequest { /** * Name of the campaign * @type {string} * @memberof UpdateCampaignRequest */ 'name'?: string; /** * Description of the campaign * @type {string} * @memberof UpdateCampaignRequest */ 'description'?: string | null; /** * List of IDs of products (different gift cards, charity, etc.) that are available in this campaign. * @type {Array} * @memberof UpdateCampaignRequest */ 'products'?: Array; /** * Determines whether fees for premium products are added to the order total (`SENDER`) or deducted from the recipient\'s reward amount (`RECIPIENT`). Campaigns with `RECIPIENT` must include at least one fee-free product. * @type {string} * @memberof UpdateCampaignRequest */ 'fee_charged_to'?: UpdateCampaignRequestFeeChargedToEnum | null; /** * * @type {ListCampaigns200ResponseCampaignsInnerAutoAddProductRule} * @memberof UpdateCampaignRequest */ 'auto_add_product_rule'?: ListCampaigns200ResponseCampaignsInnerAutoAddProductRule | null; /** * * @type {ListCampaigns200ResponseCampaignsInnerWebpageStyle} * @memberof UpdateCampaignRequest */ 'webpage_style'?: ListCampaigns200ResponseCampaignsInnerWebpageStyle; /** * * @type {ListCampaigns200ResponseCampaignsInnerEmailStyle} * @memberof UpdateCampaignRequest */ 'email_style'?: ListCampaigns200ResponseCampaignsInnerEmailStyle; } export declare const UpdateCampaignRequestFeeChargedToEnum: { readonly Sender: "SENDER"; readonly Recipient: "RECIPIENT"; }; export type UpdateCampaignRequestFeeChargedToEnum = typeof UpdateCampaignRequestFeeChargedToEnum[keyof typeof UpdateCampaignRequestFeeChargedToEnum]; /** * * @export * @interface UpdateFraudRuleList200Response */ export interface UpdateFraudRuleList200Response { /** * A description of the result * @type {string} * @memberof UpdateFraudRuleList200Response */ 'message': string; } /** * * @export * @interface UpdateFraudRuleListRequest */ export interface UpdateFraudRuleListRequest { /** * * `add` - append the list to the same key of the current configuration * `remove` - remove the entries in the list from the same key of the current configuration * @type {string} * @memberof UpdateFraudRuleListRequest */ 'operation': UpdateFraudRuleListRequestOperationEnum; /** * * @type {UpdateFraudRuleListRequestConfig} * @memberof UpdateFraudRuleListRequest */ 'config': UpdateFraudRuleListRequestConfig; } export declare const UpdateFraudRuleListRequestOperationEnum: { readonly Add: "add"; readonly Remove: "remove"; }; export type UpdateFraudRuleListRequestOperationEnum = typeof UpdateFraudRuleListRequestOperationEnum[keyof typeof UpdateFraudRuleListRequestOperationEnum]; /** * The configuration associated with the rule. The properties allowed depend on the type of rule. * @export * @interface UpdateFraudRuleListRequestConfig */ export interface UpdateFraudRuleListRequestConfig { /** * An array of country codes (ISO-3166 alpha-2 character code) * @type {Array} * @memberof UpdateFraudRuleListRequestConfig */ 'countries': Array; /** * The list of IP addresses to flag or allow. Accepts both IPv4 and IPv6 addresses using CIDR notation. * @type {Array} * @memberof UpdateFraudRuleListRequestConfig */ 'ips': Array; /** * The list of emails. * @type {Array} * @memberof UpdateFraudRuleListRequestConfig */ 'emails': Array; /** * The list of domains. Any subdomains will also be matched against each entry in the list. * @type {Array} * @memberof UpdateFraudRuleListRequestConfig */ 'domains'?: Array; } /** * * @export * @interface Webhook */ export interface Webhook { /** * * @type {string} * @memberof Webhook */ 'id'?: string; /** * URL the webhook will make requests to * @type {string} * @memberof Webhook */ 'url': string | null; /** * Private key for the webhook * @type {string} * @memberof Webhook */ 'private_key'?: string; } /** * * @export * @interface WebhookPost */ export interface WebhookPost { /** * URL the webhook will make requests to * @type {string} * @memberof WebhookPost */ 'url': string; } /** * BalanceTransactionsApi - axios parameter creator * @export */ export declare const BalanceTransactionsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Fetch a list of all balance transactions on your account. * @summary List balance transactions * @param {number} [offset] Offsets the returned list by the given number of transactions. The returned transactions are ordered (and offsetted) by their creation date (DESC). * @param {number} [limit] Limits the number of transactions listed. The default value is 10. * @param {string} [createdAtGte] Only return results where the created_at field is greater than or equal to the supplied value. The string needs to be an ISO 8601 datetime. * @param {string} [createdAtLte] Only return results where the created_at field is less than or equal to the supplied value. The string needs to be an ISO 8601 datetime. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listBalanceTransactions: (offset?: number, limit?: number, createdAtGte?: string, createdAtLte?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * BalanceTransactionsApi - functional programming interface * @export */ export declare const BalanceTransactionsApiFp: (configuration?: Configuration) => { /** * Fetch a list of all balance transactions on your account. * @summary List balance transactions * @param {number} [offset] Offsets the returned list by the given number of transactions. The returned transactions are ordered (and offsetted) by their creation date (DESC). * @param {number} [limit] Limits the number of transactions listed. The default value is 10. * @param {string} [createdAtGte] Only return results where the created_at field is greater than or equal to the supplied value. The string needs to be an ISO 8601 datetime. * @param {string} [createdAtLte] Only return results where the created_at field is less than or equal to the supplied value. The string needs to be an ISO 8601 datetime. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listBalanceTransactions(offset?: number, limit?: number, createdAtGte?: string, createdAtLte?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * BalanceTransactionsApi - factory interface * @export */ export declare const BalanceTransactionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Fetch a list of all balance transactions on your account. * @summary List balance transactions * @param {number} [offset] Offsets the returned list by the given number of transactions. The returned transactions are ordered (and offsetted) by their creation date (DESC). * @param {number} [limit] Limits the number of transactions listed. The default value is 10. * @param {string} [createdAtGte] Only return results where the created_at field is greater than or equal to the supplied value. The string needs to be an ISO 8601 datetime. * @param {string} [createdAtLte] Only return results where the created_at field is less than or equal to the supplied value. The string needs to be an ISO 8601 datetime. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listBalanceTransactions(offset?: number, limit?: number, createdAtGte?: string, createdAtLte?: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * BalanceTransactionsApi - object-oriented interface * @export * @class BalanceTransactionsApi * @extends {BaseAPI} */ export declare class BalanceTransactionsApi extends BaseAPI { /** * Fetch a list of all balance transactions on your account. * @summary List balance transactions * @param {number} [offset] Offsets the returned list by the given number of transactions. The returned transactions are ordered (and offsetted) by their creation date (DESC). * @param {number} [limit] Limits the number of transactions listed. The default value is 10. * @param {string} [createdAtGte] Only return results where the created_at field is greater than or equal to the supplied value. The string needs to be an ISO 8601 datetime. * @param {string} [createdAtLte] Only return results where the created_at field is less than or equal to the supplied value. The string needs to be an ISO 8601 datetime. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BalanceTransactionsApi */ listBalanceTransactions(offset?: number, limit?: number, createdAtGte?: string, createdAtLte?: string, options?: RawAxiosRequestConfig): Promise>; } /** * CampaignsApi - axios parameter creator * @export */ export declare const CampaignsApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Create campaign * @param {CreateCampaignRequest} createCampaignRequest Campaign details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCampaign: (createCampaignRequest: CreateCampaignRequest, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a campaign, identified by the given `id` in the URL * @summary Retrieve campaign * @param {string} id ID of the campaign that should be retrieved * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCampaign: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a list of all campaigns created in your account * @summary List campaigns * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCampaigns: (options?: RawAxiosRequestConfig) => Promise; /** * * @summary Update campaign * @param {string} id ID of the campaign that should be updated * @param {UpdateCampaignRequest} updateCampaignRequest Campaign details * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCampaign: (id: string, updateCampaignRequest: UpdateCampaignRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * CampaignsApi - functional programming interface * @export */ export declare const CampaignsApiFp: (configuration?: Configuration) => { /** * * @summary Create campaign * @param {CreateCampaignRequest} createCampaignRequest Campaign details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCampaign(createCampaignRequest: CreateCampaignRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a campaign, identified by the given `id` in the URL * @summary Retrieve campaign * @param {string} id ID of the campaign that should be retrieved * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCampaign(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a list of all campaigns created in your account * @summary List campaigns * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCampaigns(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update campaign * @param {string} id ID of the campaign that should be updated * @param {UpdateCampaignRequest} updateCampaignRequest Campaign details * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCampaign(id: string, updateCampaignRequest: UpdateCampaignRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CampaignsApi - factory interface * @export */ export declare const CampaignsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Create campaign * @param {CreateCampaignRequest} createCampaignRequest Campaign details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCampaign(createCampaignRequest: CreateCampaignRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a campaign, identified by the given `id` in the URL * @summary Retrieve campaign * @param {string} id ID of the campaign that should be retrieved * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCampaign(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a list of all campaigns created in your account * @summary List campaigns * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCampaigns(options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Update campaign * @param {string} id ID of the campaign that should be updated * @param {UpdateCampaignRequest} updateCampaignRequest Campaign details * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCampaign(id: string, updateCampaignRequest: UpdateCampaignRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * CampaignsApi - object-oriented interface * @export * @class CampaignsApi * @extends {BaseAPI} */ export declare class CampaignsApi extends BaseAPI { /** * * @summary Create campaign * @param {CreateCampaignRequest} createCampaignRequest Campaign details * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CampaignsApi */ createCampaign(createCampaignRequest: CreateCampaignRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a campaign, identified by the given `id` in the URL * @summary Retrieve campaign * @param {string} id ID of the campaign that should be retrieved * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CampaignsApi */ getCampaign(id: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a list of all campaigns created in your account * @summary List campaigns * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CampaignsApi */ listCampaigns(options?: RawAxiosRequestConfig): Promise>; /** * * @summary Update campaign * @param {string} id ID of the campaign that should be updated * @param {UpdateCampaignRequest} updateCampaignRequest Campaign details * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CampaignsApi */ updateCampaign(id: string, updateCampaignRequest: UpdateCampaignRequest, options?: RawAxiosRequestConfig): Promise>; } /** * ConnectedOrganizationMembersApi - axios parameter creator * @export */ export declare const ConnectedOrganizationMembersApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a connected organization member. * @summary Create connected organization member * @param {CreateConnectedOrganizationMemberRequest} createConnectedOrganizationMemberRequest Connected organization member to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ createConnectedOrganizationMember: (createConnectedOrganizationMemberRequest: CreateConnectedOrganizationMemberRequest, options?: RawAxiosRequestConfig) => Promise; /** * Create a connected organization member session. * @summary Create connected organization member session * @param {string} id ID of the connected organization member. * @param {CreateConnectedOrganizationMemberSessionRequest} createConnectedOrganizationMemberSessionRequest Connected organization member requiring the session * @param {*} [options] Override http request option. * @throws {RequiredError} */ createConnectedOrganizationMemberSession: (id: string, createConnectedOrganizationMemberSessionRequest: CreateConnectedOrganizationMemberSessionRequest, options?: RawAxiosRequestConfig) => Promise; /** * Removes a connected organization member. If the member has completed registration and has an associated Tremendous member, that membership is also revoked. The connected organization itself is not affected. * @summary Remove a connected organization member * @param {string} id ID of the connected organization member to remove. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteConnectedOrganizationMember: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve the connected organization member, identified by the given `id` in the URL * @summary Retrieve a connected organization member * @param {string} id ID of the connected organization member that should be retrieved. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedOrganizationMember: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a list of connected organization members. * @summary List connected organization members * @param {string} connectedOrganizationId ID of the connected organization. * @param {number} [offset] Offsets the returned list by the given number of connected organizations. * @param {number} [limit] Limits the number of connected organizations listed. The maximum value is 100 and the default is 10. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listConnectedOrganizationMembers: (connectedOrganizationId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise; }; /** * ConnectedOrganizationMembersApi - functional programming interface * @export */ export declare const ConnectedOrganizationMembersApiFp: (configuration?: Configuration) => { /** * Create a connected organization member. * @summary Create connected organization member * @param {CreateConnectedOrganizationMemberRequest} createConnectedOrganizationMemberRequest Connected organization member to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ createConnectedOrganizationMember(createConnectedOrganizationMemberRequest: CreateConnectedOrganizationMemberRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a connected organization member session. * @summary Create connected organization member session * @param {string} id ID of the connected organization member. * @param {CreateConnectedOrganizationMemberSessionRequest} createConnectedOrganizationMemberSessionRequest Connected organization member requiring the session * @param {*} [options] Override http request option. * @throws {RequiredError} */ createConnectedOrganizationMemberSession(id: string, createConnectedOrganizationMemberSessionRequest: CreateConnectedOrganizationMemberSessionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Removes a connected organization member. If the member has completed registration and has an associated Tremendous member, that membership is also revoked. The connected organization itself is not affected. * @summary Remove a connected organization member * @param {string} id ID of the connected organization member to remove. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteConnectedOrganizationMember(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve the connected organization member, identified by the given `id` in the URL * @summary Retrieve a connected organization member * @param {string} id ID of the connected organization member that should be retrieved. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedOrganizationMember(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a list of connected organization members. * @summary List connected organization members * @param {string} connectedOrganizationId ID of the connected organization. * @param {number} [offset] Offsets the returned list by the given number of connected organizations. * @param {number} [limit] Limits the number of connected organizations listed. The maximum value is 100 and the default is 10. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listConnectedOrganizationMembers(connectedOrganizationId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ConnectedOrganizationMembersApi - factory interface * @export */ export declare const ConnectedOrganizationMembersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a connected organization member. * @summary Create connected organization member * @param {CreateConnectedOrganizationMemberRequest} createConnectedOrganizationMemberRequest Connected organization member to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ createConnectedOrganizationMember(createConnectedOrganizationMemberRequest: CreateConnectedOrganizationMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Create a connected organization member session. * @summary Create connected organization member session * @param {string} id ID of the connected organization member. * @param {CreateConnectedOrganizationMemberSessionRequest} createConnectedOrganizationMemberSessionRequest Connected organization member requiring the session * @param {*} [options] Override http request option. * @throws {RequiredError} */ createConnectedOrganizationMemberSession(id: string, createConnectedOrganizationMemberSessionRequest: CreateConnectedOrganizationMemberSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Removes a connected organization member. If the member has completed registration and has an associated Tremendous member, that membership is also revoked. The connected organization itself is not affected. * @summary Remove a connected organization member * @param {string} id ID of the connected organization member to remove. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteConnectedOrganizationMember(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve the connected organization member, identified by the given `id` in the URL * @summary Retrieve a connected organization member * @param {string} id ID of the connected organization member that should be retrieved. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedOrganizationMember(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a list of connected organization members. * @summary List connected organization members * @param {string} connectedOrganizationId ID of the connected organization. * @param {number} [offset] Offsets the returned list by the given number of connected organizations. * @param {number} [limit] Limits the number of connected organizations listed. The maximum value is 100 and the default is 10. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listConnectedOrganizationMembers(connectedOrganizationId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * ConnectedOrganizationMembersApi - object-oriented interface * @export * @class ConnectedOrganizationMembersApi * @extends {BaseAPI} */ export declare class ConnectedOrganizationMembersApi extends BaseAPI { /** * Create a connected organization member. * @summary Create connected organization member * @param {CreateConnectedOrganizationMemberRequest} createConnectedOrganizationMemberRequest Connected organization member to create * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConnectedOrganizationMembersApi */ createConnectedOrganizationMember(createConnectedOrganizationMemberRequest: CreateConnectedOrganizationMemberRequest, options?: RawAxiosRequestConfig): Promise>; /** * Create a connected organization member session. * @summary Create connected organization member session * @param {string} id ID of the connected organization member. * @param {CreateConnectedOrganizationMemberSessionRequest} createConnectedOrganizationMemberSessionRequest Connected organization member requiring the session * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConnectedOrganizationMembersApi */ createConnectedOrganizationMemberSession(id: string, createConnectedOrganizationMemberSessionRequest: CreateConnectedOrganizationMemberSessionRequest, options?: RawAxiosRequestConfig): Promise>; /** * Removes a connected organization member. If the member has completed registration and has an associated Tremendous member, that membership is also revoked. The connected organization itself is not affected. * @summary Remove a connected organization member * @param {string} id ID of the connected organization member to remove. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConnectedOrganizationMembersApi */ deleteConnectedOrganizationMember(id: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve the connected organization member, identified by the given `id` in the URL * @summary Retrieve a connected organization member * @param {string} id ID of the connected organization member that should be retrieved. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConnectedOrganizationMembersApi */ getConnectedOrganizationMember(id: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a list of connected organization members. * @summary List connected organization members * @param {string} connectedOrganizationId ID of the connected organization. * @param {number} [offset] Offsets the returned list by the given number of connected organizations. * @param {number} [limit] Limits the number of connected organizations listed. The maximum value is 100 and the default is 10. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConnectedOrganizationMembersApi */ listConnectedOrganizationMembers(connectedOrganizationId: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise>; } /** * ConnectedOrganizationsApi - axios parameter creator * @export */ export declare const ConnectedOrganizationsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a connected organization. Optionally pass a `kyb` object to forward KYB details you have already collected for the end client. When provided, these values pre-fill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb` field is optional, but any value provided is validated — malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`. The stored KYB details are echoed back as `prefilled_kyb_details` on this create response only. * @summary Create connected organization * @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ createConnectedOrganization: (createConnectedOrganizationRequest: CreateConnectedOrganizationRequest, options?: RawAxiosRequestConfig) => Promise; /** * Deletes a connected organization and revokes the associated OAuth connection. The underlying Tremendous organization is not affected and remains accessible. * @summary Delete a connected organization * @param {string} id ID of the connected organization to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteConnectedOrganization: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve the connected organization, identified by the given `id` in the URL * @summary Retrieve a connected organization * @param {string} id ID of the connected organization that should be retrieved. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedOrganization: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a list of connected organizations. * @summary List connected organizations * @param {number} [offset] Offsets the returned list by the given number of connected organizations. * @param {number} [limit] Limits the number of connected organizations listed. The maximum value is 100 and the default is 10. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listConnectedOrganizations: (offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise; }; /** * ConnectedOrganizationsApi - functional programming interface * @export */ export declare const ConnectedOrganizationsApiFp: (configuration?: Configuration) => { /** * Create a connected organization. Optionally pass a `kyb` object to forward KYB details you have already collected for the end client. When provided, these values pre-fill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb` field is optional, but any value provided is validated — malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`. The stored KYB details are echoed back as `prefilled_kyb_details` on this create response only. * @summary Create connected organization * @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ createConnectedOrganization(createConnectedOrganizationRequest: CreateConnectedOrganizationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes a connected organization and revokes the associated OAuth connection. The underlying Tremendous organization is not affected and remains accessible. * @summary Delete a connected organization * @param {string} id ID of the connected organization to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteConnectedOrganization(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve the connected organization, identified by the given `id` in the URL * @summary Retrieve a connected organization * @param {string} id ID of the connected organization that should be retrieved. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedOrganization(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a list of connected organizations. * @summary List connected organizations * @param {number} [offset] Offsets the returned list by the given number of connected organizations. * @param {number} [limit] Limits the number of connected organizations listed. The maximum value is 100 and the default is 10. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listConnectedOrganizations(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ConnectedOrganizationsApi - factory interface * @export */ export declare const ConnectedOrganizationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a connected organization. Optionally pass a `kyb` object to forward KYB details you have already collected for the end client. When provided, these values pre-fill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb` field is optional, but any value provided is validated — malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`. The stored KYB details are echoed back as `prefilled_kyb_details` on this create response only. * @summary Create connected organization * @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ createConnectedOrganization(createConnectedOrganizationRequest: CreateConnectedOrganizationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes a connected organization and revokes the associated OAuth connection. The underlying Tremendous organization is not affected and remains accessible. * @summary Delete a connected organization * @param {string} id ID of the connected organization to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteConnectedOrganization(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve the connected organization, identified by the given `id` in the URL * @summary Retrieve a connected organization * @param {string} id ID of the connected organization that should be retrieved. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConnectedOrganization(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a list of connected organizations. * @summary List connected organizations * @param {number} [offset] Offsets the returned list by the given number of connected organizations. * @param {number} [limit] Limits the number of connected organizations listed. The maximum value is 100 and the default is 10. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listConnectedOrganizations(offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * ConnectedOrganizationsApi - object-oriented interface * @export * @class ConnectedOrganizationsApi * @extends {BaseAPI} */ export declare class ConnectedOrganizationsApi extends BaseAPI { /** * Create a connected organization. Optionally pass a `kyb` object to forward KYB details you have already collected for the end client. When provided, these values pre-fill the end client\'s onboarding form; the end client still reviews, edits where needed, and submits the form. Every `kyb` field is optional, but any value provided is validated — malformed KYB details (for example an unsupported `country_code` or a malformed `website_url`) return a `400`. The stored KYB details are echoed back as `prefilled_kyb_details` on this create response only. * @summary Create connected organization * @param {CreateConnectedOrganizationRequest} createConnectedOrganizationRequest Connected organization to create * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConnectedOrganizationsApi */ createConnectedOrganization(createConnectedOrganizationRequest: CreateConnectedOrganizationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Deletes a connected organization and revokes the associated OAuth connection. The underlying Tremendous organization is not affected and remains accessible. * @summary Delete a connected organization * @param {string} id ID of the connected organization to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConnectedOrganizationsApi */ deleteConnectedOrganization(id: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve the connected organization, identified by the given `id` in the URL * @summary Retrieve a connected organization * @param {string} id ID of the connected organization that should be retrieved. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConnectedOrganizationsApi */ getConnectedOrganization(id: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a list of connected organizations. * @summary List connected organizations * @param {number} [offset] Offsets the returned list by the given number of connected organizations. * @param {number} [limit] Limits the number of connected organizations listed. The maximum value is 100 and the default is 10. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConnectedOrganizationsApi */ listConnectedOrganizations(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise>; } /** * FieldsApi - axios parameter creator * @export */ export declare const FieldsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a custom field to be associated with rewards. Custom fields can be used for reporting and analytics purposes. * @summary Create field * @param {CreateFieldRequest} createFieldRequest Field details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createField: (createFieldRequest: CreateFieldRequest, options?: RawAxiosRequestConfig) => Promise; /** * For reporting and analytics purposes, custom fields can be associated with rewards generated through the API. Custom fields must be first added by members of your admin team through the Tremendous Dashboard. * @summary List fields * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFields: (options?: RawAxiosRequestConfig) => Promise; }; /** * FieldsApi - functional programming interface * @export */ export declare const FieldsApiFp: (configuration?: Configuration) => { /** * Create a custom field to be associated with rewards. Custom fields can be used for reporting and analytics purposes. * @summary Create field * @param {CreateFieldRequest} createFieldRequest Field details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createField(createFieldRequest: CreateFieldRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * For reporting and analytics purposes, custom fields can be associated with rewards generated through the API. Custom fields must be first added by members of your admin team through the Tremendous Dashboard. * @summary List fields * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFields(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FieldsApi - factory interface * @export */ export declare const FieldsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a custom field to be associated with rewards. Custom fields can be used for reporting and analytics purposes. * @summary Create field * @param {CreateFieldRequest} createFieldRequest Field details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createField(createFieldRequest: CreateFieldRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * For reporting and analytics purposes, custom fields can be associated with rewards generated through the API. Custom fields must be first added by members of your admin team through the Tremendous Dashboard. * @summary List fields * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFields(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * FieldsApi - object-oriented interface * @export * @class FieldsApi * @extends {BaseAPI} */ export declare class FieldsApi extends BaseAPI { /** * Create a custom field to be associated with rewards. Custom fields can be used for reporting and analytics purposes. * @summary Create field * @param {CreateFieldRequest} createFieldRequest Field details * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FieldsApi */ createField(createFieldRequest: CreateFieldRequest, options?: RawAxiosRequestConfig): Promise>; /** * For reporting and analytics purposes, custom fields can be associated with rewards generated through the API. Custom fields must be first added by members of your admin team through the Tremendous Dashboard. * @summary List fields * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FieldsApi */ listFields(options?: RawAxiosRequestConfig): Promise>; } /** * ForexApi - axios parameter creator * @export */ export declare const ForexApiAxiosParamCreator: (configuration?: Configuration) => { /** * Retrieve a list of exchange rates * @summary List exchange rates * @param {string} [base] Base currency code, default is USD. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listForex: (base?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * ForexApi - functional programming interface * @export */ export declare const ForexApiFp: (configuration?: Configuration) => { /** * Retrieve a list of exchange rates * @summary List exchange rates * @param {string} [base] Base currency code, default is USD. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listForex(base?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ForexApi - factory interface * @export */ export declare const ForexApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Retrieve a list of exchange rates * @summary List exchange rates * @param {string} [base] Base currency code, default is USD. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listForex(base?: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * ForexApi - object-oriented interface * @export * @class ForexApi * @extends {BaseAPI} */ export declare class ForexApi extends BaseAPI { /** * Retrieve a list of exchange rates * @summary List exchange rates * @param {string} [base] Base currency code, default is USD. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ForexApi */ listForex(base?: string, options?: RawAxiosRequestConfig): Promise>; } /** * FraudReviewsApi - axios parameter creator * @export */ export declare const FraudReviewsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Completes the fraud review identified by the given `id` in the URL, and blocks the reward. The reward is canceled and the amount refunded. * @summary Block fraud review * @param {string} id The ID of the reward that should be blocked. * @param {*} [options] Override http request option. * @throws {RequiredError} */ blockFraudReview: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve the details of a fraud review, identified by the given `id` in the URL. Returns additional details regarding the fraud review beyond what\'s provided in the List fraud reviews endpoint, including reward details, recipient geolocation, etc. * @summary Retrieve single fraud review * @param {string} id The ID of the reward that should be retrieved. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFraudReview: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a paginated list of all fraud reviews. List can be filtered by status, created or redeemed at dates. * @summary List fraud reviews * @param {number} [offset] Offsets the returned list by the given number of records. The returned fraud reviews are ordered (and offsetted) by their redemption date (DESC). * @param {number} [limit] Limits the number of fraud reviews listed. The default value is 10. * @param {ListFraudReviewsStatusEnum} [status] Filters fraud reviews by status. Can be `flagged`, `blocked` or `released`. * @param {string} [createdAtGte] Return results where the created_at field is >= to the supplied value. Expects an ISO 8601 datetime. * @param {string} [createdAtLte] Return results where the created_at field is <= to the supplied value. Expects an ISO 8601 datetime. * @param {string} [redeemedAtGte] Return results where the redeemed_at field is >= the supplied value. Expects an ISO 8601 datetime. * @param {string} [redeemedAtLte] Return results where the redeemed_at field is <= the supplied value. Expects an ISO 8601 datetime. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFraudReviews: (offset?: number, limit?: number, status?: ListFraudReviewsStatusEnum, createdAtGte?: string, createdAtLte?: string, redeemedAtGte?: string, redeemedAtLte?: string, options?: RawAxiosRequestConfig) => Promise; /** * Completes the fraud review identified by the given `id` in the URL, and releases the associated reward to the recipient. * @summary Release fraud review * @param {string} id The ID of the reward that should be released. * @param {*} [options] Override http request option. * @throws {RequiredError} */ releaseFraudReview: (id: string, options?: RawAxiosRequestConfig) => Promise; }; /** * FraudReviewsApi - functional programming interface * @export */ export declare const FraudReviewsApiFp: (configuration?: Configuration) => { /** * Completes the fraud review identified by the given `id` in the URL, and blocks the reward. The reward is canceled and the amount refunded. * @summary Block fraud review * @param {string} id The ID of the reward that should be blocked. * @param {*} [options] Override http request option. * @throws {RequiredError} */ blockFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve the details of a fraud review, identified by the given `id` in the URL. Returns additional details regarding the fraud review beyond what\'s provided in the List fraud reviews endpoint, including reward details, recipient geolocation, etc. * @summary Retrieve single fraud review * @param {string} id The ID of the reward that should be retrieved. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a paginated list of all fraud reviews. List can be filtered by status, created or redeemed at dates. * @summary List fraud reviews * @param {number} [offset] Offsets the returned list by the given number of records. The returned fraud reviews are ordered (and offsetted) by their redemption date (DESC). * @param {number} [limit] Limits the number of fraud reviews listed. The default value is 10. * @param {ListFraudReviewsStatusEnum} [status] Filters fraud reviews by status. Can be `flagged`, `blocked` or `released`. * @param {string} [createdAtGte] Return results where the created_at field is >= to the supplied value. Expects an ISO 8601 datetime. * @param {string} [createdAtLte] Return results where the created_at field is <= to the supplied value. Expects an ISO 8601 datetime. * @param {string} [redeemedAtGte] Return results where the redeemed_at field is >= the supplied value. Expects an ISO 8601 datetime. * @param {string} [redeemedAtLte] Return results where the redeemed_at field is <= the supplied value. Expects an ISO 8601 datetime. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFraudReviews(offset?: number, limit?: number, status?: ListFraudReviewsStatusEnum, createdAtGte?: string, createdAtLte?: string, redeemedAtGte?: string, redeemedAtLte?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Completes the fraud review identified by the given `id` in the URL, and releases the associated reward to the recipient. * @summary Release fraud review * @param {string} id The ID of the reward that should be released. * @param {*} [options] Override http request option. * @throws {RequiredError} */ releaseFraudReview(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FraudReviewsApi - factory interface * @export */ export declare const FraudReviewsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Completes the fraud review identified by the given `id` in the URL, and blocks the reward. The reward is canceled and the amount refunded. * @summary Block fraud review * @param {string} id The ID of the reward that should be blocked. * @param {*} [options] Override http request option. * @throws {RequiredError} */ blockFraudReview(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve the details of a fraud review, identified by the given `id` in the URL. Returns additional details regarding the fraud review beyond what\'s provided in the List fraud reviews endpoint, including reward details, recipient geolocation, etc. * @summary Retrieve single fraud review * @param {string} id The ID of the reward that should be retrieved. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFraudReview(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a paginated list of all fraud reviews. List can be filtered by status, created or redeemed at dates. * @summary List fraud reviews * @param {number} [offset] Offsets the returned list by the given number of records. The returned fraud reviews are ordered (and offsetted) by their redemption date (DESC). * @param {number} [limit] Limits the number of fraud reviews listed. The default value is 10. * @param {ListFraudReviewsStatusEnum} [status] Filters fraud reviews by status. Can be `flagged`, `blocked` or `released`. * @param {string} [createdAtGte] Return results where the created_at field is >= to the supplied value. Expects an ISO 8601 datetime. * @param {string} [createdAtLte] Return results where the created_at field is <= to the supplied value. Expects an ISO 8601 datetime. * @param {string} [redeemedAtGte] Return results where the redeemed_at field is >= the supplied value. Expects an ISO 8601 datetime. * @param {string} [redeemedAtLte] Return results where the redeemed_at field is <= the supplied value. Expects an ISO 8601 datetime. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFraudReviews(offset?: number, limit?: number, status?: ListFraudReviewsStatusEnum, createdAtGte?: string, createdAtLte?: string, redeemedAtGte?: string, redeemedAtLte?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Completes the fraud review identified by the given `id` in the URL, and releases the associated reward to the recipient. * @summary Release fraud review * @param {string} id The ID of the reward that should be released. * @param {*} [options] Override http request option. * @throws {RequiredError} */ releaseFraudReview(id: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * FraudReviewsApi - object-oriented interface * @export * @class FraudReviewsApi * @extends {BaseAPI} */ export declare class FraudReviewsApi extends BaseAPI { /** * Completes the fraud review identified by the given `id` in the URL, and blocks the reward. The reward is canceled and the amount refunded. * @summary Block fraud review * @param {string} id The ID of the reward that should be blocked. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FraudReviewsApi */ blockFraudReview(id: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve the details of a fraud review, identified by the given `id` in the URL. Returns additional details regarding the fraud review beyond what\'s provided in the List fraud reviews endpoint, including reward details, recipient geolocation, etc. * @summary Retrieve single fraud review * @param {string} id The ID of the reward that should be retrieved. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FraudReviewsApi */ getFraudReview(id: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a paginated list of all fraud reviews. List can be filtered by status, created or redeemed at dates. * @summary List fraud reviews * @param {number} [offset] Offsets the returned list by the given number of records. The returned fraud reviews are ordered (and offsetted) by their redemption date (DESC). * @param {number} [limit] Limits the number of fraud reviews listed. The default value is 10. * @param {ListFraudReviewsStatusEnum} [status] Filters fraud reviews by status. Can be `flagged`, `blocked` or `released`. * @param {string} [createdAtGte] Return results where the created_at field is >= to the supplied value. Expects an ISO 8601 datetime. * @param {string} [createdAtLte] Return results where the created_at field is <= to the supplied value. Expects an ISO 8601 datetime. * @param {string} [redeemedAtGte] Return results where the redeemed_at field is >= the supplied value. Expects an ISO 8601 datetime. * @param {string} [redeemedAtLte] Return results where the redeemed_at field is <= the supplied value. Expects an ISO 8601 datetime. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FraudReviewsApi */ listFraudReviews(offset?: number, limit?: number, status?: ListFraudReviewsStatusEnum, createdAtGte?: string, createdAtLte?: string, redeemedAtGte?: string, redeemedAtLte?: string, options?: RawAxiosRequestConfig): Promise>; /** * Completes the fraud review identified by the given `id` in the URL, and releases the associated reward to the recipient. * @summary Release fraud review * @param {string} id The ID of the reward that should be released. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FraudReviewsApi */ releaseFraudReview(id: string, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const ListFraudReviewsStatusEnum: { readonly Flagged: "flagged"; readonly Blocked: "blocked"; readonly Released: "released"; }; export type ListFraudReviewsStatusEnum = typeof ListFraudReviewsStatusEnum[keyof typeof ListFraudReviewsStatusEnum]; /** * FraudRulesApi - axios parameter creator * @export */ export declare const FraudRulesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Deletes the rule of the type passed in the URL. * @summary Delete fraud rule * @param {DeleteFraudRuleRuleTypeEnum} ruleType The rule type to create or update. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFraudRule: (ruleType: DeleteFraudRuleRuleTypeEnum, options?: RawAxiosRequestConfig) => Promise; /** * Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten. * @summary Configure fraud rule * @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update. * @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body. `review_vpn` also accepts no body for the default behavior. Pass `config.skip_apple_private_relay` only to override whether Apple Private Relay traffic is flagged. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fraudRule: (ruleType: FraudRuleRuleTypeEnum, fraudRuleRequest?: FraudRuleRequest, options?: RawAxiosRequestConfig) => Promise; /** * List active fraud rules associated with the organization tied to your API key. * @summary List fraud rules * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFraudRules: (options?: RawAxiosRequestConfig) => Promise; /** * Use this endpoint to modify a list associated with an already-configured rule. Add and remove operations supported. For example, to append new IPs to the `review_ip` rule, a valid JSON body would be: ```json { \"operation\": \"add\", \"config\": { \"ips\": [\"123.123.123.123\"] } } ``` * @summary Update fraud rule list * @param {UpdateFraudRuleListRuleTypeEnum} ruleType The rule type to create or update. * @param {UpdateFraudRuleListRequest} updateFraudRuleListRequest The lists to add or remove from the current configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateFraudRuleList: (ruleType: UpdateFraudRuleListRuleTypeEnum, updateFraudRuleListRequest: UpdateFraudRuleListRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * FraudRulesApi - functional programming interface * @export */ export declare const FraudRulesApiFp: (configuration?: Configuration) => { /** * Deletes the rule of the type passed in the URL. * @summary Delete fraud rule * @param {DeleteFraudRuleRuleTypeEnum} ruleType The rule type to create or update. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFraudRule(ruleType: DeleteFraudRuleRuleTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten. * @summary Configure fraud rule * @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update. * @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body. `review_vpn` also accepts no body for the default behavior. Pass `config.skip_apple_private_relay` only to override whether Apple Private Relay traffic is flagged. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fraudRule(ruleType: FraudRuleRuleTypeEnum, fraudRuleRequest?: FraudRuleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List active fraud rules associated with the organization tied to your API key. * @summary List fraud rules * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFraudRules(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this endpoint to modify a list associated with an already-configured rule. Add and remove operations supported. For example, to append new IPs to the `review_ip` rule, a valid JSON body would be: ```json { \"operation\": \"add\", \"config\": { \"ips\": [\"123.123.123.123\"] } } ``` * @summary Update fraud rule list * @param {UpdateFraudRuleListRuleTypeEnum} ruleType The rule type to create or update. * @param {UpdateFraudRuleListRequest} updateFraudRuleListRequest The lists to add or remove from the current configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateFraudRuleList(ruleType: UpdateFraudRuleListRuleTypeEnum, updateFraudRuleListRequest: UpdateFraudRuleListRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FraudRulesApi - factory interface * @export */ export declare const FraudRulesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Deletes the rule of the type passed in the URL. * @summary Delete fraud rule * @param {DeleteFraudRuleRuleTypeEnum} ruleType The rule type to create or update. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFraudRule(ruleType: DeleteFraudRuleRuleTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten. * @summary Configure fraud rule * @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update. * @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body. `review_vpn` also accepts no body for the default behavior. Pass `config.skip_apple_private_relay` only to override whether Apple Private Relay traffic is flagged. * @param {*} [options] Override http request option. * @throws {RequiredError} */ fraudRule(ruleType: FraudRuleRuleTypeEnum, fraudRuleRequest?: FraudRuleRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * List active fraud rules associated with the organization tied to your API key. * @summary List fraud rules * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFraudRules(options?: RawAxiosRequestConfig): AxiosPromise; /** * Use this endpoint to modify a list associated with an already-configured rule. Add and remove operations supported. For example, to append new IPs to the `review_ip` rule, a valid JSON body would be: ```json { \"operation\": \"add\", \"config\": { \"ips\": [\"123.123.123.123\"] } } ``` * @summary Update fraud rule list * @param {UpdateFraudRuleListRuleTypeEnum} ruleType The rule type to create or update. * @param {UpdateFraudRuleListRequest} updateFraudRuleListRequest The lists to add or remove from the current configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateFraudRuleList(ruleType: UpdateFraudRuleListRuleTypeEnum, updateFraudRuleListRequest: UpdateFraudRuleListRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * FraudRulesApi - object-oriented interface * @export * @class FraudRulesApi * @extends {BaseAPI} */ export declare class FraudRulesApi extends BaseAPI { /** * Deletes the rule of the type passed in the URL. * @summary Delete fraud rule * @param {DeleteFraudRuleRuleTypeEnum} ruleType The rule type to create or update. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FraudRulesApi */ deleteFraudRule(ruleType: DeleteFraudRuleRuleTypeEnum, options?: RawAxiosRequestConfig): Promise>; /** * Configure a fraud rule of the type passed in the URL. If a rule of the same type already exists, it will be overwritten. * @summary Configure fraud rule * @param {FraudRuleRuleTypeEnum} ruleType The rule type to create or update. * @param {FraudRuleRequest} [fraudRuleRequest] Rules `review_multiple_emails`, `review_tremendous_flaglist`, and `review_previously_blocked_recipients` require no body. `review_vpn` also accepts no body for the default behavior. Pass `config.skip_apple_private_relay` only to override whether Apple Private Relay traffic is flagged. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FraudRulesApi */ fraudRule(ruleType: FraudRuleRuleTypeEnum, fraudRuleRequest?: FraudRuleRequest, options?: RawAxiosRequestConfig): Promise>; /** * List active fraud rules associated with the organization tied to your API key. * @summary List fraud rules * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FraudRulesApi */ listFraudRules(options?: RawAxiosRequestConfig): Promise>; /** * Use this endpoint to modify a list associated with an already-configured rule. Add and remove operations supported. For example, to append new IPs to the `review_ip` rule, a valid JSON body would be: ```json { \"operation\": \"add\", \"config\": { \"ips\": [\"123.123.123.123\"] } } ``` * @summary Update fraud rule list * @param {UpdateFraudRuleListRuleTypeEnum} ruleType The rule type to create or update. * @param {UpdateFraudRuleListRequest} updateFraudRuleListRequest The lists to add or remove from the current configuration * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FraudRulesApi */ updateFraudRuleList(ruleType: UpdateFraudRuleListRuleTypeEnum, updateFraudRuleListRequest: UpdateFraudRuleListRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const DeleteFraudRuleRuleTypeEnum: { readonly ReviewCountry: "review_country"; readonly ReviewIp: "review_ip"; readonly ReviewEmail: "review_email"; readonly ReviewRedeemedRewardsCount: "review_redeemed_rewards_count"; readonly ReviewRedeemedRewardsAmount: "review_redeemed_rewards_amount"; readonly ReviewMultipleEmails: "review_multiple_emails"; readonly ReviewVpn: "review_vpn"; readonly ReviewTremendousFlagList: "review_tremendous_flag_list"; readonly ReviewPreviouslyBlockedRecipients: "review_previously_blocked_recipients"; readonly AllowIp: "allow_ip"; readonly AllowEmail: "allow_email"; }; export type DeleteFraudRuleRuleTypeEnum = typeof DeleteFraudRuleRuleTypeEnum[keyof typeof DeleteFraudRuleRuleTypeEnum]; /** * @export */ export declare const FraudRuleRuleTypeEnum: { readonly ReviewCountry: "review_country"; readonly ReviewIp: "review_ip"; readonly ReviewEmail: "review_email"; readonly ReviewRedeemedRewardsCount: "review_redeemed_rewards_count"; readonly ReviewRedeemedRewardsAmount: "review_redeemed_rewards_amount"; readonly ReviewMultipleEmails: "review_multiple_emails"; readonly ReviewVpn: "review_vpn"; readonly ReviewTremendousFlagList: "review_tremendous_flag_list"; readonly ReviewPreviouslyBlockedRecipients: "review_previously_blocked_recipients"; readonly AllowIp: "allow_ip"; readonly AllowEmail: "allow_email"; }; export type FraudRuleRuleTypeEnum = typeof FraudRuleRuleTypeEnum[keyof typeof FraudRuleRuleTypeEnum]; /** * @export */ export declare const UpdateFraudRuleListRuleTypeEnum: { readonly ReviewCountry: "review_country"; readonly ReviewIp: "review_ip"; readonly ReviewEmail: "review_email"; readonly AllowIp: "allow_ip"; readonly AllowEmail: "allow_email"; }; export type UpdateFraudRuleListRuleTypeEnum = typeof UpdateFraudRuleListRuleTypeEnum[keyof typeof UpdateFraudRuleListRuleTypeEnum]; /** * FundingSourcesApi - axios parameter creator * @export */ export declare const FundingSourcesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Retrieve a funding source, identified by the given `id` in the URL. You can also use the special keyword `BALANCE` (case-insensitive) to retrieve the organization\'s balance funding source. * @summary Retrieve funding source * @param {string} id ID of the funding source that should be retrieved. Can also use \"BALANCE\" (case-insensitive) to retrieve the organization\'s balance funding source. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFundingSource: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a list of all funding sources in your organization\'s account. * @summary List funding sources * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFundingSources: (options?: RawAxiosRequestConfig) => Promise; }; /** * FundingSourcesApi - functional programming interface * @export */ export declare const FundingSourcesApiFp: (configuration?: Configuration) => { /** * Retrieve a funding source, identified by the given `id` in the URL. You can also use the special keyword `BALANCE` (case-insensitive) to retrieve the organization\'s balance funding source. * @summary Retrieve funding source * @param {string} id ID of the funding source that should be retrieved. Can also use \"BALANCE\" (case-insensitive) to retrieve the organization\'s balance funding source. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFundingSource(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a list of all funding sources in your organization\'s account. * @summary List funding sources * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFundingSources(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FundingSourcesApi - factory interface * @export */ export declare const FundingSourcesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Retrieve a funding source, identified by the given `id` in the URL. You can also use the special keyword `BALANCE` (case-insensitive) to retrieve the organization\'s balance funding source. * @summary Retrieve funding source * @param {string} id ID of the funding source that should be retrieved. Can also use \"BALANCE\" (case-insensitive) to retrieve the organization\'s balance funding source. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFundingSource(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a list of all funding sources in your organization\'s account. * @summary List funding sources * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFundingSources(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * FundingSourcesApi - object-oriented interface * @export * @class FundingSourcesApi * @extends {BaseAPI} */ export declare class FundingSourcesApi extends BaseAPI { /** * Retrieve a funding source, identified by the given `id` in the URL. You can also use the special keyword `BALANCE` (case-insensitive) to retrieve the organization\'s balance funding source. * @summary Retrieve funding source * @param {string} id ID of the funding source that should be retrieved. Can also use \"BALANCE\" (case-insensitive) to retrieve the organization\'s balance funding source. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FundingSourcesApi */ getFundingSource(id: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a list of all funding sources in your organization\'s account. * @summary List funding sources * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FundingSourcesApi */ listFundingSources(options?: RawAxiosRequestConfig): Promise>; } /** * InvoicesApi - axios parameter creator * @export */ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creating an invoice is the way for your organization to fund your account\'s balance. 1. Create an invoice 2. Pay the invoice 3. Funds get added to your account\'s balance ## Request body
Property Type Description
po_number
string

Reference to the purchase order number within your organization

amount
number double

Amount of the invoice

currency_code
string

Currency of the invoice. Defaults to the organization's currency if not provided.

currency
string

Deprecated: Use currency_code instead.

memo
string

A note to be included in the invoice. This is for your internal use and will not be visible to the recipient.

* @summary Create invoice * @param {CreateInvoiceRequest} createInvoiceRequest Invoice details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createInvoice: (createInvoiceRequest: CreateInvoiceRequest, options?: RawAxiosRequestConfig) => Promise; /** * Removes an invoice. This has no further consequences but is a rather cosmetic operation. * @summary Delete invoice * @param {string} id ID of the invoice that should be removed * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteInvoices: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Generates a CSV version for an invoice listing the associated rewards and orders * @summary Retrieve invoice as CSV * @param {string} id ID of the Invoice for that the CSV should be generated * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadInvoiceCsv: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Generates a PDF version for an invoice * @summary Retrieve invoice as PDF * @param {string} id ID of the Invoice for that the PDF should be generated * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadInvoicePdf: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve an invoice, identified by the given `id` in the URL > 📘 Deleted Invoices > > This endpoint can be used to retrieve details on deleted invoices > that the list of invoices omits. * @summary Retrieve invoice * @param {string} id ID of the invoice that should be retrieved * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInvoice: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Fetch a list of all invoices on your account. > 🚧 Deleted invoices are omitted > > The response does not include any previously deleted invoices. * @summary List invoices * @param {number} [offset] Offsets the returned list by the given number of invoices. The returned invoices are ordered (and offsetted) by their creation date (DESC). * @param {number} [limit] Limits the number of invoices listed. The maximum and default value is 10. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInvoices: (offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise; }; /** * InvoicesApi - functional programming interface * @export */ export declare const InvoicesApiFp: (configuration?: Configuration) => { /** * Creating an invoice is the way for your organization to fund your account\'s balance. 1. Create an invoice 2. Pay the invoice 3. Funds get added to your account\'s balance ## Request body
Property Type Description
po_number
string

Reference to the purchase order number within your organization

amount
number double

Amount of the invoice

currency_code
string

Currency of the invoice. Defaults to the organization's currency if not provided.

currency
string

Deprecated: Use currency_code instead.

memo
string

A note to be included in the invoice. This is for your internal use and will not be visible to the recipient.

* @summary Create invoice * @param {CreateInvoiceRequest} createInvoiceRequest Invoice details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createInvoice(createInvoiceRequest: CreateInvoiceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Removes an invoice. This has no further consequences but is a rather cosmetic operation. * @summary Delete invoice * @param {string} id ID of the invoice that should be removed * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteInvoices(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Generates a CSV version for an invoice listing the associated rewards and orders * @summary Retrieve invoice as CSV * @param {string} id ID of the Invoice for that the CSV should be generated * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadInvoiceCsv(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Generates a PDF version for an invoice * @summary Retrieve invoice as PDF * @param {string} id ID of the Invoice for that the PDF should be generated * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadInvoicePdf(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve an invoice, identified by the given `id` in the URL > 📘 Deleted Invoices > > This endpoint can be used to retrieve details on deleted invoices > that the list of invoices omits. * @summary Retrieve invoice * @param {string} id ID of the invoice that should be retrieved * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInvoice(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetch a list of all invoices on your account. > 🚧 Deleted invoices are omitted > > The response does not include any previously deleted invoices. * @summary List invoices * @param {number} [offset] Offsets the returned list by the given number of invoices. The returned invoices are ordered (and offsetted) by their creation date (DESC). * @param {number} [limit] Limits the number of invoices listed. The maximum and default value is 10. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInvoices(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * InvoicesApi - factory interface * @export */ export declare const InvoicesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creating an invoice is the way for your organization to fund your account\'s balance. 1. Create an invoice 2. Pay the invoice 3. Funds get added to your account\'s balance ## Request body
Property Type Description
po_number
string

Reference to the purchase order number within your organization

amount
number double

Amount of the invoice

currency_code
string

Currency of the invoice. Defaults to the organization's currency if not provided.

currency
string

Deprecated: Use currency_code instead.

memo
string

A note to be included in the invoice. This is for your internal use and will not be visible to the recipient.

* @summary Create invoice * @param {CreateInvoiceRequest} createInvoiceRequest Invoice details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createInvoice(createInvoiceRequest: CreateInvoiceRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Removes an invoice. This has no further consequences but is a rather cosmetic operation. * @summary Delete invoice * @param {string} id ID of the invoice that should be removed * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteInvoices(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Generates a CSV version for an invoice listing the associated rewards and orders * @summary Retrieve invoice as CSV * @param {string} id ID of the Invoice for that the CSV should be generated * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadInvoiceCsv(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Generates a PDF version for an invoice * @summary Retrieve invoice as PDF * @param {string} id ID of the Invoice for that the PDF should be generated * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadInvoicePdf(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve an invoice, identified by the given `id` in the URL > 📘 Deleted Invoices > > This endpoint can be used to retrieve details on deleted invoices > that the list of invoices omits. * @summary Retrieve invoice * @param {string} id ID of the invoice that should be retrieved * @param {*} [options] Override http request option. * @throws {RequiredError} */ getInvoice(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetch a list of all invoices on your account. > 🚧 Deleted invoices are omitted > > The response does not include any previously deleted invoices. * @summary List invoices * @param {number} [offset] Offsets the returned list by the given number of invoices. The returned invoices are ordered (and offsetted) by their creation date (DESC). * @param {number} [limit] Limits the number of invoices listed. The maximum and default value is 10. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listInvoices(offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * InvoicesApi - object-oriented interface * @export * @class InvoicesApi * @extends {BaseAPI} */ export declare class InvoicesApi extends BaseAPI { /** * Creating an invoice is the way for your organization to fund your account\'s balance. 1. Create an invoice 2. Pay the invoice 3. Funds get added to your account\'s balance ## Request body
Property Type Description
po_number
string

Reference to the purchase order number within your organization

amount
number double

Amount of the invoice

currency_code
string

Currency of the invoice. Defaults to the organization's currency if not provided.

currency
string

Deprecated: Use currency_code instead.

memo
string

A note to be included in the invoice. This is for your internal use and will not be visible to the recipient.

* @summary Create invoice * @param {CreateInvoiceRequest} createInvoiceRequest Invoice details * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InvoicesApi */ createInvoice(createInvoiceRequest: CreateInvoiceRequest, options?: RawAxiosRequestConfig): Promise>; /** * Removes an invoice. This has no further consequences but is a rather cosmetic operation. * @summary Delete invoice * @param {string} id ID of the invoice that should be removed * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InvoicesApi */ deleteInvoices(id: string, options?: RawAxiosRequestConfig): Promise>; /** * Generates a CSV version for an invoice listing the associated rewards and orders * @summary Retrieve invoice as CSV * @param {string} id ID of the Invoice for that the CSV should be generated * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InvoicesApi */ downloadInvoiceCsv(id: string, options?: RawAxiosRequestConfig): Promise>; /** * Generates a PDF version for an invoice * @summary Retrieve invoice as PDF * @param {string} id ID of the Invoice for that the PDF should be generated * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InvoicesApi */ downloadInvoicePdf(id: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve an invoice, identified by the given `id` in the URL > 📘 Deleted Invoices > > This endpoint can be used to retrieve details on deleted invoices > that the list of invoices omits. * @summary Retrieve invoice * @param {string} id ID of the invoice that should be retrieved * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InvoicesApi */ getInvoice(id: string, options?: RawAxiosRequestConfig): Promise>; /** * Fetch a list of all invoices on your account. > 🚧 Deleted invoices are omitted > > The response does not include any previously deleted invoices. * @summary List invoices * @param {number} [offset] Offsets the returned list by the given number of invoices. The returned invoices are ordered (and offsetted) by their creation date (DESC). * @param {number} [limit] Limits the number of invoices listed. The maximum and default value is 10. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof InvoicesApi */ listInvoices(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise>; } /** * MembersApi - axios parameter creator * @export */ export declare const MembersApiAxiosParamCreator: (configuration?: Configuration) => { /** * Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have a role that determine their permissions within the organization. Check the Roles API for the available roles. To create members of a sub-organizations [create an API key for that organization](/reference/post_organizations-id-create-api-key) first, then use the new API key in the create member request. ### Inviting new members After creating a member, an automatic invite is sent to the email address. If the user is not registered yet, that person will then need to sign up for a Tremendous account. > ❗️ Automatic invitations are not available in the sandbox > > You must manually use the returned `invite_url` field in the payload instead. * @summary Create member * @param {CreateMemberRequest} createMemberRequest Member details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createMember: (createMemberRequest: CreateMemberRequest, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Retrieve member * @param {string} id ID of the member to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMember: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * To list members of a sub-organization [create an API key for that organization](/reference/post_organizations-id-create-api-key) first, then use the new API key in the list members request. * @summary List members * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMembers: (options?: RawAxiosRequestConfig) => Promise; }; /** * MembersApi - functional programming interface * @export */ export declare const MembersApiFp: (configuration?: Configuration) => { /** * Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have a role that determine their permissions within the organization. Check the Roles API for the available roles. To create members of a sub-organizations [create an API key for that organization](/reference/post_organizations-id-create-api-key) first, then use the new API key in the create member request. ### Inviting new members After creating a member, an automatic invite is sent to the email address. If the user is not registered yet, that person will then need to sign up for a Tremendous account. > ❗️ Automatic invitations are not available in the sandbox > > You must manually use the returned `invite_url` field in the payload instead. * @summary Create member * @param {CreateMemberRequest} createMemberRequest Member details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createMember(createMemberRequest: CreateMemberRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Retrieve member * @param {string} id ID of the member to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMember(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * To list members of a sub-organization [create an API key for that organization](/reference/post_organizations-id-create-api-key) first, then use the new API key in the list members request. * @summary List members * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMembers(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MembersApi - factory interface * @export */ export declare const MembersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have a role that determine their permissions within the organization. Check the Roles API for the available roles. To create members of a sub-organizations [create an API key for that organization](/reference/post_organizations-id-create-api-key) first, then use the new API key in the create member request. ### Inviting new members After creating a member, an automatic invite is sent to the email address. If the user is not registered yet, that person will then need to sign up for a Tremendous account. > ❗️ Automatic invitations are not available in the sandbox > > You must manually use the returned `invite_url` field in the payload instead. * @summary Create member * @param {CreateMemberRequest} createMemberRequest Member details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createMember(createMemberRequest: CreateMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Retrieve member * @param {string} id ID of the member to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMember(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * To list members of a sub-organization [create an API key for that organization](/reference/post_organizations-id-create-api-key) first, then use the new API key in the list members request. * @summary List members * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMembers(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * MembersApi - object-oriented interface * @export * @class MembersApi * @extends {BaseAPI} */ export declare class MembersApi extends BaseAPI { /** * Each organization has one or more users that can access and manage that organization. These users are called members. Members can take actions via the Tremendous web dashboard directly. These actions include adding funding sources to the organization, creating Campaigns, and more. ### Permissions Members can have a role that determine their permissions within the organization. Check the Roles API for the available roles. To create members of a sub-organizations [create an API key for that organization](/reference/post_organizations-id-create-api-key) first, then use the new API key in the create member request. ### Inviting new members After creating a member, an automatic invite is sent to the email address. If the user is not registered yet, that person will then need to sign up for a Tremendous account. > ❗️ Automatic invitations are not available in the sandbox > > You must manually use the returned `invite_url` field in the payload instead. * @summary Create member * @param {CreateMemberRequest} createMemberRequest Member details * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MembersApi */ createMember(createMemberRequest: CreateMemberRequest, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Retrieve member * @param {string} id ID of the member to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MembersApi */ getMember(id: string, options?: RawAxiosRequestConfig): Promise>; /** * To list members of a sub-organization [create an API key for that organization](/reference/post_organizations-id-create-api-key) first, then use the new API key in the list members request. * @summary List members * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MembersApi */ listMembers(options?: RawAxiosRequestConfig): Promise>; } /** * OrdersApi - axios parameter creator * @export */ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration) => { /** * Approves an order that is pending review, identified by the given `id` in the URL. Approvals is a feature that requires orders to be approved by an organization admin before they are sent out. To enable approvals for your organization, please enable \'Allow approvals via API\' via the organization\'\'s \'Order Approvals\' settings from the Tremendous dashboard. * @summary Approve order * @param {string} id ID of the order that should be approved. In case the order has an `external_id` reference supplied by the customer on creation, it\'s possible to use it instead. * @param {*} [options] Override http request option. * @throws {RequiredError} */ approveOrder: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > Check it out! ## Request body
Property Type Description
external_id
string

Reference for this order, supplied by the customer.

When set, external_id makes order idempotent. All requests that use the same external_id after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a 201 response code. These responses fail to create any further orders.

It also allows for retrieving by external_id instead of id only.

payment
object
Show object properties
Property Type Description
funding_source_id
string

Tremendous ID of the funding source that will be used to pay for the order. Use balance to use your Tremendous's balance.

reward
object

A single reward, sent to a recipient. A reward is always part of an order.

Either products or campaign_id must be specified.

Show object properties
Property Type Description
id
string

Tremendous ID of the reward

order_id
string

Tremendous ID of the order this reward is part of.

created_at
string date-time

Date the reward was created

expires_at
string date-time

Expiration date of the reward. If null, the reward does not expire.

campaign_id
string

ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.

products
array string

List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.

Providing a products array will override the products made available by the campaign specified using the campaign_id property unless the products array is empty. It will not override other campaign attributes, like the message and customization of the look and feel.

value
object
Show object properties
Property Type Description
denomination
number double

Amount of the reward

currency_code
string

Currency of the reward. Defaults to the organization's currency if not provided.

recipient
object

Details of the recipient of the reward

Show object properties
Property Type Description
name
string

Name of the recipient

email
string

Email address of the recipient

phone
string

Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +).

deliver_at
string date

Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.

custom_fields
array
Show array item type
Property Type Description
id
string

Tremendous ID of the custom field

value
string

Value of the custom field

label
string

Label of the custom field

language
string

Set this to translate the redemption experience for this reward. Pass a 2-letter ISO-639-1 code for the desired language. Defaults to en.

delivery
object

Details on how the reward is delivered to the recipient.

Show object properties
Property Type Description
method
string

How to deliver the reward to the recipient.

Delivery Method Description
EMAIL Deliver the reward to the recipient by email
LINK

Deliver the reward to the recipient via a link.

The initial POST /orders response for a link reward includes the link in delivery.link.

The link must then be delivered to the recipient out-of-band.

To obtain a new link for an existing reward, call POST /rewards/{id}/generate_link.

PHONE Deliver the reward to the recipient by SMS
meta
object

Customizable reward delivery metadata, taking precedence over the related campaign settings.

Show object properties
Property Type Description
sender_name
string

The "sender name" used in the delivery. If it's an email reward, "via Tremendous" will be appended to the value. Please note that you cannot customize the sender email.

subject_line
string

The subject line used in the delivery.

message
string

The content of the message of the reward, shown in the email / SMS and on the landing page.

### Funding sources There are different ways to pay for gift cards and rewards on Tremendous. Every payment mechanism is called a \"funding source\". You can retrieve a list of all available funding sources by using the [Funding sources API endpoint](https://developers.tremendous.com/reference/list-funding-sources). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $5,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://developers.tremendous.com/docs/sandbox-environment). The HTTP status code `200` on the response will be used to indicate success. After processing successfully the reward gets queued to be delivered to it\'s recipient (for delivery method `EMAIL` and `PHONE`). Delivery will happen asynchronously, after the response has been sent. ### Idempotence Requests issued with the same `external_id` are idempotent. Submitting an order with an already existing `external_id` will not create a new order. If the payload is the same as a previously issued order, our API will return a `201` response code, along with a representation of the already-existing order in the response body. If the `external_id` used is for an order with different parameters (e.g. amount, recipient), our API will return a `409` response code, indicating a conflicting resource. * @summary Create order * @param {CreateOrderRequest} createOrderRequest Order to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrder: (createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve the order, identified by the given `id` in the URL * @summary Retrieve order * @param {string} id ID of the order that should be retrieved. In case the order has an `external_id` reference supplied by the customer on creation, it\'s possible to use it instead. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrder: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a list of orders * @summary List orders * @param {number} [offset] Offsets the returned list by the given number of orders. The returned orders are ordered (and offsetted) by their creation date (DESC). * @param {string} [campaignId] Only return results with a matching campaign_id. * @param {string} [externalId] Only return results with a matching external_id. * @param {string} [createdAtGte] Only return results where the created_at field is greater than or equal to the supplied value. The string needs to be an ISO 8601 datetime. * @param {string} [createdAtLte] Only return results where the created_at field is less than or equal to the supplied value. The string needs to be an ISO 8601 datetime. * @param {number} [limit] Limits the number of orders listed. The maximum value is 500 and the default is 10. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrders: (offset?: number, campaignId?: string, externalId?: string, createdAtGte?: string, createdAtLte?: string, limit?: number, options?: RawAxiosRequestConfig) => Promise; /** * Rejects an order that is pending review, identified by the given `id` in the URL. Approvals is a feature that requires orders to be approved by an organization admin before they are sent out. To enable approvals for your organization, please enable \'Allow approvals via API\' via the organization\'\'s \'Order Approvals\' settings from the Tremendous dashboard. * @summary Reject order * @param {string} id ID of the order that should be rejected. In case the order has an `external_id` reference supplied by the customer on creation, it\'s possible to use it instead. * @param {*} [options] Override http request option. * @throws {RequiredError} */ rejectOrder: (id: string, options?: RawAxiosRequestConfig) => Promise; }; /** * OrdersApi - functional programming interface * @export */ export declare const OrdersApiFp: (configuration?: Configuration) => { /** * Approves an order that is pending review, identified by the given `id` in the URL. Approvals is a feature that requires orders to be approved by an organization admin before they are sent out. To enable approvals for your organization, please enable \'Allow approvals via API\' via the organization\'\'s \'Order Approvals\' settings from the Tremendous dashboard. * @summary Approve order * @param {string} id ID of the order that should be approved. In case the order has an `external_id` reference supplied by the customer on creation, it\'s possible to use it instead. * @param {*} [options] Override http request option. * @throws {RequiredError} */ approveOrder(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > Check it out! ## Request body
Property Type Description
external_id
string

Reference for this order, supplied by the customer.

When set, external_id makes order idempotent. All requests that use the same external_id after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a 201 response code. These responses fail to create any further orders.

It also allows for retrieving by external_id instead of id only.

payment
object
Show object properties
Property Type Description
funding_source_id
string

Tremendous ID of the funding source that will be used to pay for the order. Use balance to use your Tremendous's balance.

reward
object

A single reward, sent to a recipient. A reward is always part of an order.

Either products or campaign_id must be specified.

Show object properties
Property Type Description
id
string

Tremendous ID of the reward

order_id
string

Tremendous ID of the order this reward is part of.

created_at
string date-time

Date the reward was created

expires_at
string date-time

Expiration date of the reward. If null, the reward does not expire.

campaign_id
string

ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.

products
array string

List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.

Providing a products array will override the products made available by the campaign specified using the campaign_id property unless the products array is empty. It will not override other campaign attributes, like the message and customization of the look and feel.

value
object
Show object properties
Property Type Description
denomination
number double

Amount of the reward

currency_code
string

Currency of the reward. Defaults to the organization's currency if not provided.

recipient
object

Details of the recipient of the reward

Show object properties
Property Type Description
name
string

Name of the recipient

email
string

Email address of the recipient

phone
string

Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +).

deliver_at
string date

Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.

custom_fields
array
Show array item type
Property Type Description
id
string

Tremendous ID of the custom field

value
string

Value of the custom field

label
string

Label of the custom field

language
string

Set this to translate the redemption experience for this reward. Pass a 2-letter ISO-639-1 code for the desired language. Defaults to en.

delivery
object

Details on how the reward is delivered to the recipient.

Show object properties
Property Type Description
method
string

How to deliver the reward to the recipient.

Delivery Method Description
EMAIL Deliver the reward to the recipient by email
LINK

Deliver the reward to the recipient via a link.

The initial POST /orders response for a link reward includes the link in delivery.link.

The link must then be delivered to the recipient out-of-band.

To obtain a new link for an existing reward, call POST /rewards/{id}/generate_link.

PHONE Deliver the reward to the recipient by SMS
meta
object

Customizable reward delivery metadata, taking precedence over the related campaign settings.

Show object properties
Property Type Description
sender_name
string

The "sender name" used in the delivery. If it's an email reward, "via Tremendous" will be appended to the value. Please note that you cannot customize the sender email.

subject_line
string

The subject line used in the delivery.

message
string

The content of the message of the reward, shown in the email / SMS and on the landing page.

### Funding sources There are different ways to pay for gift cards and rewards on Tremendous. Every payment mechanism is called a \"funding source\". You can retrieve a list of all available funding sources by using the [Funding sources API endpoint](https://developers.tremendous.com/reference/list-funding-sources). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $5,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://developers.tremendous.com/docs/sandbox-environment). The HTTP status code `200` on the response will be used to indicate success. After processing successfully the reward gets queued to be delivered to it\'s recipient (for delivery method `EMAIL` and `PHONE`). Delivery will happen asynchronously, after the response has been sent. ### Idempotence Requests issued with the same `external_id` are idempotent. Submitting an order with an already existing `external_id` will not create a new order. If the payload is the same as a previously issued order, our API will return a `201` response code, along with a representation of the already-existing order in the response body. If the `external_id` used is for an order with different parameters (e.g. amount, recipient), our API will return a `409` response code, indicating a conflicting resource. * @summary Create order * @param {CreateOrderRequest} createOrderRequest Order to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve the order, identified by the given `id` in the URL * @summary Retrieve order * @param {string} id ID of the order that should be retrieved. In case the order has an `external_id` reference supplied by the customer on creation, it\'s possible to use it instead. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrder(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a list of orders * @summary List orders * @param {number} [offset] Offsets the returned list by the given number of orders. The returned orders are ordered (and offsetted) by their creation date (DESC). * @param {string} [campaignId] Only return results with a matching campaign_id. * @param {string} [externalId] Only return results with a matching external_id. * @param {string} [createdAtGte] Only return results where the created_at field is greater than or equal to the supplied value. The string needs to be an ISO 8601 datetime. * @param {string} [createdAtLte] Only return results where the created_at field is less than or equal to the supplied value. The string needs to be an ISO 8601 datetime. * @param {number} [limit] Limits the number of orders listed. The maximum value is 500 and the default is 10. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrders(offset?: number, campaignId?: string, externalId?: string, createdAtGte?: string, createdAtLte?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Rejects an order that is pending review, identified by the given `id` in the URL. Approvals is a feature that requires orders to be approved by an organization admin before they are sent out. To enable approvals for your organization, please enable \'Allow approvals via API\' via the organization\'\'s \'Order Approvals\' settings from the Tremendous dashboard. * @summary Reject order * @param {string} id ID of the order that should be rejected. In case the order has an `external_id` reference supplied by the customer on creation, it\'s possible to use it instead. * @param {*} [options] Override http request option. * @throws {RequiredError} */ rejectOrder(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * OrdersApi - factory interface * @export */ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Approves an order that is pending review, identified by the given `id` in the URL. Approvals is a feature that requires orders to be approved by an organization admin before they are sent out. To enable approvals for your organization, please enable \'Allow approvals via API\' via the organization\'\'s \'Order Approvals\' settings from the Tremendous dashboard. * @summary Approve order * @param {string} id ID of the order that should be approved. In case the order has an `external_id` reference supplied by the customer on creation, it\'s possible to use it instead. * @param {*} [options] Override http request option. * @throws {RequiredError} */ approveOrder(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > Check it out! ## Request body
Property Type Description
external_id
string

Reference for this order, supplied by the customer.

When set, external_id makes order idempotent. All requests that use the same external_id after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a 201 response code. These responses fail to create any further orders.

It also allows for retrieving by external_id instead of id only.

payment
object
Show object properties
Property Type Description
funding_source_id
string

Tremendous ID of the funding source that will be used to pay for the order. Use balance to use your Tremendous's balance.

reward
object

A single reward, sent to a recipient. A reward is always part of an order.

Either products or campaign_id must be specified.

Show object properties
Property Type Description
id
string

Tremendous ID of the reward

order_id
string

Tremendous ID of the order this reward is part of.

created_at
string date-time

Date the reward was created

expires_at
string date-time

Expiration date of the reward. If null, the reward does not expire.

campaign_id
string

ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.

products
array string

List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.

Providing a products array will override the products made available by the campaign specified using the campaign_id property unless the products array is empty. It will not override other campaign attributes, like the message and customization of the look and feel.

value
object
Show object properties
Property Type Description
denomination
number double

Amount of the reward

currency_code
string

Currency of the reward. Defaults to the organization's currency if not provided.

recipient
object

Details of the recipient of the reward

Show object properties
Property Type Description
name
string

Name of the recipient

email
string

Email address of the recipient

phone
string

Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +).

deliver_at
string date

Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.

custom_fields
array
Show array item type
Property Type Description
id
string

Tremendous ID of the custom field

value
string

Value of the custom field

label
string

Label of the custom field

language
string

Set this to translate the redemption experience for this reward. Pass a 2-letter ISO-639-1 code for the desired language. Defaults to en.

delivery
object

Details on how the reward is delivered to the recipient.

Show object properties
Property Type Description
method
string

How to deliver the reward to the recipient.

Delivery Method Description
EMAIL Deliver the reward to the recipient by email
LINK

Deliver the reward to the recipient via a link.

The initial POST /orders response for a link reward includes the link in delivery.link.

The link must then be delivered to the recipient out-of-band.

To obtain a new link for an existing reward, call POST /rewards/{id}/generate_link.

PHONE Deliver the reward to the recipient by SMS
meta
object

Customizable reward delivery metadata, taking precedence over the related campaign settings.

Show object properties
Property Type Description
sender_name
string

The "sender name" used in the delivery. If it's an email reward, "via Tremendous" will be appended to the value. Please note that you cannot customize the sender email.

subject_line
string

The subject line used in the delivery.

message
string

The content of the message of the reward, shown in the email / SMS and on the landing page.

### Funding sources There are different ways to pay for gift cards and rewards on Tremendous. Every payment mechanism is called a \"funding source\". You can retrieve a list of all available funding sources by using the [Funding sources API endpoint](https://developers.tremendous.com/reference/list-funding-sources). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $5,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://developers.tremendous.com/docs/sandbox-environment). The HTTP status code `200` on the response will be used to indicate success. After processing successfully the reward gets queued to be delivered to it\'s recipient (for delivery method `EMAIL` and `PHONE`). Delivery will happen asynchronously, after the response has been sent. ### Idempotence Requests issued with the same `external_id` are idempotent. Submitting an order with an already existing `external_id` will not create a new order. If the payload is the same as a previously issued order, our API will return a `201` response code, along with a representation of the already-existing order in the response body. If the `external_id` used is for an order with different parameters (e.g. amount, recipient), our API will return a `409` response code, indicating a conflicting resource. * @summary Create order * @param {CreateOrderRequest} createOrderRequest Order to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve the order, identified by the given `id` in the URL * @summary Retrieve order * @param {string} id ID of the order that should be retrieved. In case the order has an `external_id` reference supplied by the customer on creation, it\'s possible to use it instead. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrder(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a list of orders * @summary List orders * @param {number} [offset] Offsets the returned list by the given number of orders. The returned orders are ordered (and offsetted) by their creation date (DESC). * @param {string} [campaignId] Only return results with a matching campaign_id. * @param {string} [externalId] Only return results with a matching external_id. * @param {string} [createdAtGte] Only return results where the created_at field is greater than or equal to the supplied value. The string needs to be an ISO 8601 datetime. * @param {string} [createdAtLte] Only return results where the created_at field is less than or equal to the supplied value. The string needs to be an ISO 8601 datetime. * @param {number} [limit] Limits the number of orders listed. The maximum value is 500 and the default is 10. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrders(offset?: number, campaignId?: string, externalId?: string, createdAtGte?: string, createdAtLte?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Rejects an order that is pending review, identified by the given `id` in the URL. Approvals is a feature that requires orders to be approved by an organization admin before they are sent out. To enable approvals for your organization, please enable \'Allow approvals via API\' via the organization\'\'s \'Order Approvals\' settings from the Tremendous dashboard. * @summary Reject order * @param {string} id ID of the order that should be rejected. In case the order has an `external_id` reference supplied by the customer on creation, it\'s possible to use it instead. * @param {*} [options] Override http request option. * @throws {RequiredError} */ rejectOrder(id: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * OrdersApi - object-oriented interface * @export * @class OrdersApi * @extends {BaseAPI} */ export declare class OrdersApi extends BaseAPI { /** * Approves an order that is pending review, identified by the given `id` in the URL. Approvals is a feature that requires orders to be approved by an organization admin before they are sent out. To enable approvals for your organization, please enable \'Allow approvals via API\' via the organization\'\'s \'Order Approvals\' settings from the Tremendous dashboard. * @summary Approve order * @param {string} id ID of the order that should be approved. In case the order has an `external_id` reference supplied by the customer on creation, it\'s possible to use it instead. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrdersApi */ approveOrder(id: string, options?: RawAxiosRequestConfig): Promise>; /** * Every time you want to send out a reward through Tremendous you need to create an order for it. > 📘 Getting started with your first order > > Our step-by-step guide walks you through everything you need > to send your first gift card through the Tremendous API: > > Check it out! ## Request body
Property Type Description
external_id
string

Reference for this order, supplied by the customer.

When set, external_id makes order idempotent. All requests that use the same external_id after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a 201 response code. These responses fail to create any further orders.

It also allows for retrieving by external_id instead of id only.

payment
object
Show object properties
Property Type Description
funding_source_id
string

Tremendous ID of the funding source that will be used to pay for the order. Use balance to use your Tremendous's balance.

reward
object

A single reward, sent to a recipient. A reward is always part of an order.

Either products or campaign_id must be specified.

Show object properties
Property Type Description
id
string

Tremendous ID of the reward

order_id
string

Tremendous ID of the order this reward is part of.

created_at
string date-time

Date the reward was created

expires_at
string date-time

Expiration date of the reward. If null, the reward does not expire.

campaign_id
string

ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.

products
array string

List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from.

Providing a products array will override the products made available by the campaign specified using the campaign_id property unless the products array is empty. It will not override other campaign attributes, like the message and customization of the look and feel.

value
object
Show object properties
Property Type Description
denomination
number double

Amount of the reward

currency_code
string

Currency of the reward. Defaults to the organization's currency if not provided.

recipient
object

Details of the recipient of the reward

Show object properties
Property Type Description
name
string

Name of the recipient

email
string

Email address of the recipient

phone
string

Phone number of the recipient. For non-US phone numbers, specify the country code (prefixed with +).

deliver_at
string date

Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.

custom_fields
array
Show array item type
Property Type Description
id
string

Tremendous ID of the custom field

value
string

Value of the custom field

label
string

Label of the custom field

language
string

Set this to translate the redemption experience for this reward. Pass a 2-letter ISO-639-1 code for the desired language. Defaults to en.

delivery
object

Details on how the reward is delivered to the recipient.

Show object properties
Property Type Description
method
string

How to deliver the reward to the recipient.

Delivery Method Description
EMAIL Deliver the reward to the recipient by email
LINK

Deliver the reward to the recipient via a link.

The initial POST /orders response for a link reward includes the link in delivery.link.

The link must then be delivered to the recipient out-of-band.

To obtain a new link for an existing reward, call POST /rewards/{id}/generate_link.

PHONE Deliver the reward to the recipient by SMS
meta
object

Customizable reward delivery metadata, taking precedence over the related campaign settings.

Show object properties
Property Type Description
sender_name
string

The "sender name" used in the delivery. If it's an email reward, "via Tremendous" will be appended to the value. Please note that you cannot customize the sender email.

subject_line
string

The subject line used in the delivery.

message
string

The content of the message of the reward, shown in the email / SMS and on the landing page.

### Funding sources There are different ways to pay for gift cards and rewards on Tremendous. Every payment mechanism is called a \"funding source\". You can retrieve a list of all available funding sources by using the [Funding sources API endpoint](https://developers.tremendous.com/reference/list-funding-sources). The Tremendous API sandbox environment comes with a single funding source that allows you to spend up to $5,000 in *fake money* to test the API. [Learn more about the sandbox environment](https://developers.tremendous.com/docs/sandbox-environment). The HTTP status code `200` on the response will be used to indicate success. After processing successfully the reward gets queued to be delivered to it\'s recipient (for delivery method `EMAIL` and `PHONE`). Delivery will happen asynchronously, after the response has been sent. ### Idempotence Requests issued with the same `external_id` are idempotent. Submitting an order with an already existing `external_id` will not create a new order. If the payload is the same as a previously issued order, our API will return a `201` response code, along with a representation of the already-existing order in the response body. If the `external_id` used is for an order with different parameters (e.g. amount, recipient), our API will return a `409` response code, indicating a conflicting resource. * @summary Create order * @param {CreateOrderRequest} createOrderRequest Order to create * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrdersApi */ createOrder(createOrderRequest: CreateOrderRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve the order, identified by the given `id` in the URL * @summary Retrieve order * @param {string} id ID of the order that should be retrieved. In case the order has an `external_id` reference supplied by the customer on creation, it\'s possible to use it instead. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrdersApi */ getOrder(id: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a list of orders * @summary List orders * @param {number} [offset] Offsets the returned list by the given number of orders. The returned orders are ordered (and offsetted) by their creation date (DESC). * @param {string} [campaignId] Only return results with a matching campaign_id. * @param {string} [externalId] Only return results with a matching external_id. * @param {string} [createdAtGte] Only return results where the created_at field is greater than or equal to the supplied value. The string needs to be an ISO 8601 datetime. * @param {string} [createdAtLte] Only return results where the created_at field is less than or equal to the supplied value. The string needs to be an ISO 8601 datetime. * @param {number} [limit] Limits the number of orders listed. The maximum value is 500 and the default is 10. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrdersApi */ listOrders(offset?: number, campaignId?: string, externalId?: string, createdAtGte?: string, createdAtLte?: string, limit?: number, options?: RawAxiosRequestConfig): Promise>; /** * Rejects an order that is pending review, identified by the given `id` in the URL. Approvals is a feature that requires orders to be approved by an organization admin before they are sent out. To enable approvals for your organization, please enable \'Allow approvals via API\' via the organization\'\'s \'Order Approvals\' settings from the Tremendous dashboard. * @summary Reject order * @param {string} id ID of the order that should be rejected. In case the order has an `external_id` reference supplied by the customer on creation, it\'s possible to use it instead. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrdersApi */ rejectOrder(id: string, options?: RawAxiosRequestConfig): Promise>; } /** * OrganizationsApi - axios parameter creator * @export */ export declare const OrganizationsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a new API key. The API key used to make the request will remain active. Created API keys are generated randomly and returned in the response. **You cannot retrieve them again.** * @summary Create API key * @param {*} [options] Override http request option. * @throws {RequiredError} */ createApiKey: (options?: RawAxiosRequestConfig) => Promise; /** * Organizations are a way to separate different parts of your business within the same Tremendous account. You can assign users in your Tremendous team as members to any organization. Users can be members of multiple organizations at once. API keys belong to a single organization. The API key used in a request determines on behalf of which organization the request is carried out. **Important note:** When creating an organization, you are required to either pass `with_api_key` or `copy_settings[user]` in the request body as `true`. This ensures that your new Organization can either be accessed via the API or the Dashboard. * @summary Create organization * @param {CreateOrganizationRequest} createOrganizationRequest Organization details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrganization: (createOrganizationRequest: CreateOrganizationRequest, options?: RawAxiosRequestConfig) => Promise; /** * * @summary Retrieve organization * @param {string} id ID of the organization to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrganization: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * The returned list only includes the organization to which the API key belongs to, that is used for the request. * @summary List organizations * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrganizations: (options?: RawAxiosRequestConfig) => Promise; }; /** * OrganizationsApi - functional programming interface * @export */ export declare const OrganizationsApiFp: (configuration?: Configuration) => { /** * Creates a new API key. The API key used to make the request will remain active. Created API keys are generated randomly and returned in the response. **You cannot retrieve them again.** * @summary Create API key * @param {*} [options] Override http request option. * @throws {RequiredError} */ createApiKey(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Organizations are a way to separate different parts of your business within the same Tremendous account. You can assign users in your Tremendous team as members to any organization. Users can be members of multiple organizations at once. API keys belong to a single organization. The API key used in a request determines on behalf of which organization the request is carried out. **Important note:** When creating an organization, you are required to either pass `with_api_key` or `copy_settings[user]` in the request body as `true`. This ensures that your new Organization can either be accessed via the API or the Dashboard. * @summary Create organization * @param {CreateOrganizationRequest} createOrganizationRequest Organization details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrganization(createOrganizationRequest: CreateOrganizationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Retrieve organization * @param {string} id ID of the organization to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrganization(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * The returned list only includes the organization to which the API key belongs to, that is used for the request. * @summary List organizations * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrganizations(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * OrganizationsApi - factory interface * @export */ export declare const OrganizationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a new API key. The API key used to make the request will remain active. Created API keys are generated randomly and returned in the response. **You cannot retrieve them again.** * @summary Create API key * @param {*} [options] Override http request option. * @throws {RequiredError} */ createApiKey(options?: RawAxiosRequestConfig): AxiosPromise; /** * Organizations are a way to separate different parts of your business within the same Tremendous account. You can assign users in your Tremendous team as members to any organization. Users can be members of multiple organizations at once. API keys belong to a single organization. The API key used in a request determines on behalf of which organization the request is carried out. **Important note:** When creating an organization, you are required to either pass `with_api_key` or `copy_settings[user]` in the request body as `true`. This ensures that your new Organization can either be accessed via the API or the Dashboard. * @summary Create organization * @param {CreateOrganizationRequest} createOrganizationRequest Organization details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createOrganization(createOrganizationRequest: CreateOrganizationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * * @summary Retrieve organization * @param {string} id ID of the organization to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrganization(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * The returned list only includes the organization to which the API key belongs to, that is used for the request. * @summary List organizations * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrganizations(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * OrganizationsApi - object-oriented interface * @export * @class OrganizationsApi * @extends {BaseAPI} */ export declare class OrganizationsApi extends BaseAPI { /** * Creates a new API key. The API key used to make the request will remain active. Created API keys are generated randomly and returned in the response. **You cannot retrieve them again.** * @summary Create API key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrganizationsApi */ createApiKey(options?: RawAxiosRequestConfig): Promise>; /** * Organizations are a way to separate different parts of your business within the same Tremendous account. You can assign users in your Tremendous team as members to any organization. Users can be members of multiple organizations at once. API keys belong to a single organization. The API key used in a request determines on behalf of which organization the request is carried out. **Important note:** When creating an organization, you are required to either pass `with_api_key` or `copy_settings[user]` in the request body as `true`. This ensures that your new Organization can either be accessed via the API or the Dashboard. * @summary Create organization * @param {CreateOrganizationRequest} createOrganizationRequest Organization details * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrganizationsApi */ createOrganization(createOrganizationRequest: CreateOrganizationRequest, options?: RawAxiosRequestConfig): Promise>; /** * * @summary Retrieve organization * @param {string} id ID of the organization to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrganizationsApi */ getOrganization(id: string, options?: RawAxiosRequestConfig): Promise>; /** * The returned list only includes the organization to which the API key belongs to, that is used for the request. * @summary List organizations * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OrganizationsApi */ listOrganizations(options?: RawAxiosRequestConfig): Promise>; } /** * ProductsApi - axios parameter creator * @export */ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Retrieve a product, identified by the given `id` in the URL * @summary Retrieve product * @param {string} id ID of the product that should be retrieved * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProduct: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a list of available products * @summary List products * @param {string} [country] Comma-separated list of [Alpha-2 country codes](https://www.iban.com/country-codes), used to only retrieve products available in the provided countries * @param {string} [currency] Comma-separated list of [currency codes](https://www.iban.com/currency-codes), used to only retrieve products available in the provided currencies * @param {string} [subcategory] Comma-separated list of [subcategories](https://developers.tremendous.com/reference/obj-schema-products-1), used to only retrieve products with the provided subcategories * @param {*} [options] Override http request option. * @throws {RequiredError} */ listProducts: (country?: string, currency?: string, subcategory?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * ProductsApi - functional programming interface * @export */ export declare const ProductsApiFp: (configuration?: Configuration) => { /** * Retrieve a product, identified by the given `id` in the URL * @summary Retrieve product * @param {string} id ID of the product that should be retrieved * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProduct(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a list of available products * @summary List products * @param {string} [country] Comma-separated list of [Alpha-2 country codes](https://www.iban.com/country-codes), used to only retrieve products available in the provided countries * @param {string} [currency] Comma-separated list of [currency codes](https://www.iban.com/currency-codes), used to only retrieve products available in the provided currencies * @param {string} [subcategory] Comma-separated list of [subcategories](https://developers.tremendous.com/reference/obj-schema-products-1), used to only retrieve products with the provided subcategories * @param {*} [options] Override http request option. * @throws {RequiredError} */ listProducts(country?: string, currency?: string, subcategory?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ProductsApi - factory interface * @export */ export declare const ProductsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Retrieve a product, identified by the given `id` in the URL * @summary Retrieve product * @param {string} id ID of the product that should be retrieved * @param {*} [options] Override http request option. * @throws {RequiredError} */ getProduct(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a list of available products * @summary List products * @param {string} [country] Comma-separated list of [Alpha-2 country codes](https://www.iban.com/country-codes), used to only retrieve products available in the provided countries * @param {string} [currency] Comma-separated list of [currency codes](https://www.iban.com/currency-codes), used to only retrieve products available in the provided currencies * @param {string} [subcategory] Comma-separated list of [subcategories](https://developers.tremendous.com/reference/obj-schema-products-1), used to only retrieve products with the provided subcategories * @param {*} [options] Override http request option. * @throws {RequiredError} */ listProducts(country?: string, currency?: string, subcategory?: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * ProductsApi - object-oriented interface * @export * @class ProductsApi * @extends {BaseAPI} */ export declare class ProductsApi extends BaseAPI { /** * Retrieve a product, identified by the given `id` in the URL * @summary Retrieve product * @param {string} id ID of the product that should be retrieved * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProductsApi */ getProduct(id: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a list of available products * @summary List products * @param {string} [country] Comma-separated list of [Alpha-2 country codes](https://www.iban.com/country-codes), used to only retrieve products available in the provided countries * @param {string} [currency] Comma-separated list of [currency codes](https://www.iban.com/currency-codes), used to only retrieve products available in the provided currencies * @param {string} [subcategory] Comma-separated list of [subcategories](https://developers.tremendous.com/reference/obj-schema-products-1), used to only retrieve products with the provided subcategories * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ProductsApi */ listProducts(country?: string, currency?: string, subcategory?: string, options?: RawAxiosRequestConfig): Promise>; } /** * ReportsApi - axios parameter creator * @export */ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creating a report allows your organization to programmatically retrieve information that\'s available in our dashboard UI. This request creates a new report object with a unique ID, and kicks off an async report generation. To retrieve a completed report, either poll `/api/v2/reports/{id}` or listen for REPORTS webhook event. ## Request body
Property Type Description
report_type
string

Type of report for retrieval.
Report type Description
digital_rewards Report for Tremendous digital reward history

format
string

Format the report will be generated in.
Format Description
csv CSV format for report

filters
object

Filters to apply to the report. Corresponds to the filters provided in the dashboard

Show object properties
Property Type Description
digital_rewards
object

Filters object for a report_type: digital_rewards report

Show object properties
Property Type Description
amount
object

Amount of the rewards returned in the report

Show object properties
Property Type Description
gte
number double

Minimum amount of the rewards that should be returned in the report

lte
number double

Maximum amount of the rewards that should be returned in the report

campaign_id
string

ID of the Tremendous campaign that this report should be limited to

created_at
object

Creation dates of rewards returned in the report

Show object properties
Property Type Description
gte
string date

Minimum date the reward was created

lte
string date

Maximum date the reward was created

delivered_at
string date

Delivery date for gifts that should be returned in the report

delivery_method
string

Delivery method for rewards returned in the report

order_id
string

ID of the Tremendous order that this report should be limited to

order_status
string

Order status for rewards returned in the report

status
array string

Status for rewards returned in the report

## Rate limits Some reports may take a long time to generate and we limit the number of reports that can be simultaneously generated by an organization at a given time. If you exceed the rate limit, you\'ll receive a `429` response. * @summary Create report * @param {CreateReportRequest} createReportRequest Report to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ createReport: (createReportRequest: CreateReportRequest, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve the report, identified by the given `id` in the URL Using the ID that was returned by `POST /api/v2/reports`, retrieves a download link for the report, identified by the given ID in the URL. Returns the report’s current status and, if available, the URL for download. The URL is valid for 7 days. * @summary Retrieve report * @param {string} id ID of the report that should be retrieved. ID is returned from `POST` to /api/v2/reports * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReport: (id: string, options?: RawAxiosRequestConfig) => Promise; }; /** * ReportsApi - functional programming interface * @export */ export declare const ReportsApiFp: (configuration?: Configuration) => { /** * Creating a report allows your organization to programmatically retrieve information that\'s available in our dashboard UI. This request creates a new report object with a unique ID, and kicks off an async report generation. To retrieve a completed report, either poll `/api/v2/reports/{id}` or listen for REPORTS webhook event. ## Request body
Property Type Description
report_type
string

Type of report for retrieval.
Report type Description
digital_rewards Report for Tremendous digital reward history

format
string

Format the report will be generated in.
Format Description
csv CSV format for report

filters
object

Filters to apply to the report. Corresponds to the filters provided in the dashboard

Show object properties
Property Type Description
digital_rewards
object

Filters object for a report_type: digital_rewards report

Show object properties
Property Type Description
amount
object

Amount of the rewards returned in the report

Show object properties
Property Type Description
gte
number double

Minimum amount of the rewards that should be returned in the report

lte
number double

Maximum amount of the rewards that should be returned in the report

campaign_id
string

ID of the Tremendous campaign that this report should be limited to

created_at
object

Creation dates of rewards returned in the report

Show object properties
Property Type Description
gte
string date

Minimum date the reward was created

lte
string date

Maximum date the reward was created

delivered_at
string date

Delivery date for gifts that should be returned in the report

delivery_method
string

Delivery method for rewards returned in the report

order_id
string

ID of the Tremendous order that this report should be limited to

order_status
string

Order status for rewards returned in the report

status
array string

Status for rewards returned in the report

## Rate limits Some reports may take a long time to generate and we limit the number of reports that can be simultaneously generated by an organization at a given time. If you exceed the rate limit, you\'ll receive a `429` response. * @summary Create report * @param {CreateReportRequest} createReportRequest Report to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ createReport(createReportRequest: CreateReportRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve the report, identified by the given `id` in the URL Using the ID that was returned by `POST /api/v2/reports`, retrieves a download link for the report, identified by the given ID in the URL. Returns the report’s current status and, if available, the URL for download. The URL is valid for 7 days. * @summary Retrieve report * @param {string} id ID of the report that should be retrieved. ID is returned from `POST` to /api/v2/reports * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReport(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ReportsApi - factory interface * @export */ export declare const ReportsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creating a report allows your organization to programmatically retrieve information that\'s available in our dashboard UI. This request creates a new report object with a unique ID, and kicks off an async report generation. To retrieve a completed report, either poll `/api/v2/reports/{id}` or listen for REPORTS webhook event. ## Request body
Property Type Description
report_type
string

Type of report for retrieval.
Report type Description
digital_rewards Report for Tremendous digital reward history

format
string

Format the report will be generated in.
Format Description
csv CSV format for report

filters
object

Filters to apply to the report. Corresponds to the filters provided in the dashboard

Show object properties
Property Type Description
digital_rewards
object

Filters object for a report_type: digital_rewards report

Show object properties
Property Type Description
amount
object

Amount of the rewards returned in the report

Show object properties
Property Type Description
gte
number double

Minimum amount of the rewards that should be returned in the report

lte
number double

Maximum amount of the rewards that should be returned in the report

campaign_id
string

ID of the Tremendous campaign that this report should be limited to

created_at
object

Creation dates of rewards returned in the report

Show object properties
Property Type Description
gte
string date

Minimum date the reward was created

lte
string date

Maximum date the reward was created

delivered_at
string date

Delivery date for gifts that should be returned in the report

delivery_method
string

Delivery method for rewards returned in the report

order_id
string

ID of the Tremendous order that this report should be limited to

order_status
string

Order status for rewards returned in the report

status
array string

Status for rewards returned in the report

## Rate limits Some reports may take a long time to generate and we limit the number of reports that can be simultaneously generated by an organization at a given time. If you exceed the rate limit, you\'ll receive a `429` response. * @summary Create report * @param {CreateReportRequest} createReportRequest Report to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ createReport(createReportRequest: CreateReportRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve the report, identified by the given `id` in the URL Using the ID that was returned by `POST /api/v2/reports`, retrieves a download link for the report, identified by the given ID in the URL. Returns the report’s current status and, if available, the URL for download. The URL is valid for 7 days. * @summary Retrieve report * @param {string} id ID of the report that should be retrieved. ID is returned from `POST` to /api/v2/reports * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReport(id: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * ReportsApi - object-oriented interface * @export * @class ReportsApi * @extends {BaseAPI} */ export declare class ReportsApi extends BaseAPI { /** * Creating a report allows your organization to programmatically retrieve information that\'s available in our dashboard UI. This request creates a new report object with a unique ID, and kicks off an async report generation. To retrieve a completed report, either poll `/api/v2/reports/{id}` or listen for REPORTS webhook event. ## Request body
Property Type Description
report_type
string

Type of report for retrieval.
Report type Description
digital_rewards Report for Tremendous digital reward history

format
string

Format the report will be generated in.
Format Description
csv CSV format for report

filters
object

Filters to apply to the report. Corresponds to the filters provided in the dashboard

Show object properties
Property Type Description
digital_rewards
object

Filters object for a report_type: digital_rewards report

Show object properties
Property Type Description
amount
object

Amount of the rewards returned in the report

Show object properties
Property Type Description
gte
number double

Minimum amount of the rewards that should be returned in the report

lte
number double

Maximum amount of the rewards that should be returned in the report

campaign_id
string

ID of the Tremendous campaign that this report should be limited to

created_at
object

Creation dates of rewards returned in the report

Show object properties
Property Type Description
gte
string date

Minimum date the reward was created

lte
string date

Maximum date the reward was created

delivered_at
string date

Delivery date for gifts that should be returned in the report

delivery_method
string

Delivery method for rewards returned in the report

order_id
string

ID of the Tremendous order that this report should be limited to

order_status
string

Order status for rewards returned in the report

status
array string

Status for rewards returned in the report

## Rate limits Some reports may take a long time to generate and we limit the number of reports that can be simultaneously generated by an organization at a given time. If you exceed the rate limit, you\'ll receive a `429` response. * @summary Create report * @param {CreateReportRequest} createReportRequest Report to create * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ createReport(createReportRequest: CreateReportRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve the report, identified by the given `id` in the URL Using the ID that was returned by `POST /api/v2/reports`, retrieves a download link for the report, identified by the given ID in the URL. Returns the report’s current status and, if available, the URL for download. The URL is valid for 7 days. * @summary Retrieve report * @param {string} id ID of the report that should be retrieved. ID is returned from `POST` to /api/v2/reports * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ getReport(id: string, options?: RawAxiosRequestConfig): Promise>; } /** * RewardsApi - axios parameter creator * @export */ export declare const RewardsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Cancels a reward, identified by the given `id` in the URL. Only non-expired rewards with a delivery failure can be canceled. * @summary Cancel reward * @param {string} id ID of the reward that should be canceled * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelReward: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Generate a redemption link for the reward identified by the `id` in the URL * @summary Generate a reward URL * @param {string} id ID of the reward * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateRewardLink: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve the reward, identified by the given `id` in the URL * @summary Retrieve single reward * @param {string} id ID of the reward that should be retrieved * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReward: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a list of all created rewards. You can query for rewards by custom field attributes using the field label and values as query params. [Learn more](https://developers.tremendous.com/docs/using-custom-fields-to-add-custom-data-to-rewards#querying-by-custom-fields) * @summary List rewards * @param {number} [offset] Offsets the returned list by the given number of rewards. The returned rewards are ordered (and offsetted) by their creation date (DESC). * @param {number} [limit] Limits the number of rewards listed. The maximum value is 500 and the default is 100. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listRewards: (offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise; /** * Resends a reward, identified by the given `id` in the URL, to its recipient. Only rewards with a previous delivery failure can be resent. * @summary Resend reward * @param {string} id ID of the reward that should be resent * @param {ResendRewardRequest} [resendRewardRequest] You can update the email or phone number used for the resend. You can only provide one of `updated_email` or `updated_phone`, not both. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resendReward: (id: string, resendRewardRequest?: ResendRewardRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * RewardsApi - functional programming interface * @export */ export declare const RewardsApiFp: (configuration?: Configuration) => { /** * Cancels a reward, identified by the given `id` in the URL. Only non-expired rewards with a delivery failure can be canceled. * @summary Cancel reward * @param {string} id ID of the reward that should be canceled * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelReward(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Generate a redemption link for the reward identified by the `id` in the URL * @summary Generate a reward URL * @param {string} id ID of the reward * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateRewardLink(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve the reward, identified by the given `id` in the URL * @summary Retrieve single reward * @param {string} id ID of the reward that should be retrieved * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReward(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a list of all created rewards. You can query for rewards by custom field attributes using the field label and values as query params. [Learn more](https://developers.tremendous.com/docs/using-custom-fields-to-add-custom-data-to-rewards#querying-by-custom-fields) * @summary List rewards * @param {number} [offset] Offsets the returned list by the given number of rewards. The returned rewards are ordered (and offsetted) by their creation date (DESC). * @param {number} [limit] Limits the number of rewards listed. The maximum value is 500 and the default is 100. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listRewards(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Resends a reward, identified by the given `id` in the URL, to its recipient. Only rewards with a previous delivery failure can be resent. * @summary Resend reward * @param {string} id ID of the reward that should be resent * @param {ResendRewardRequest} [resendRewardRequest] You can update the email or phone number used for the resend. You can only provide one of `updated_email` or `updated_phone`, not both. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resendReward(id: string, resendRewardRequest?: ResendRewardRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * RewardsApi - factory interface * @export */ export declare const RewardsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Cancels a reward, identified by the given `id` in the URL. Only non-expired rewards with a delivery failure can be canceled. * @summary Cancel reward * @param {string} id ID of the reward that should be canceled * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelReward(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Generate a redemption link for the reward identified by the `id` in the URL * @summary Generate a reward URL * @param {string} id ID of the reward * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateRewardLink(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve the reward, identified by the given `id` in the URL * @summary Retrieve single reward * @param {string} id ID of the reward that should be retrieved * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReward(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a list of all created rewards. You can query for rewards by custom field attributes using the field label and values as query params. [Learn more](https://developers.tremendous.com/docs/using-custom-fields-to-add-custom-data-to-rewards#querying-by-custom-fields) * @summary List rewards * @param {number} [offset] Offsets the returned list by the given number of rewards. The returned rewards are ordered (and offsetted) by their creation date (DESC). * @param {number} [limit] Limits the number of rewards listed. The maximum value is 500 and the default is 100. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listRewards(offset?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Resends a reward, identified by the given `id` in the URL, to its recipient. Only rewards with a previous delivery failure can be resent. * @summary Resend reward * @param {string} id ID of the reward that should be resent * @param {ResendRewardRequest} [resendRewardRequest] You can update the email or phone number used for the resend. You can only provide one of `updated_email` or `updated_phone`, not both. * @param {*} [options] Override http request option. * @throws {RequiredError} */ resendReward(id: string, resendRewardRequest?: ResendRewardRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * RewardsApi - object-oriented interface * @export * @class RewardsApi * @extends {BaseAPI} */ export declare class RewardsApi extends BaseAPI { /** * Cancels a reward, identified by the given `id` in the URL. Only non-expired rewards with a delivery failure can be canceled. * @summary Cancel reward * @param {string} id ID of the reward that should be canceled * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RewardsApi */ cancelReward(id: string, options?: RawAxiosRequestConfig): Promise>; /** * Generate a redemption link for the reward identified by the `id` in the URL * @summary Generate a reward URL * @param {string} id ID of the reward * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RewardsApi */ generateRewardLink(id: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve the reward, identified by the given `id` in the URL * @summary Retrieve single reward * @param {string} id ID of the reward that should be retrieved * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RewardsApi */ getReward(id: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a list of all created rewards. You can query for rewards by custom field attributes using the field label and values as query params. [Learn more](https://developers.tremendous.com/docs/using-custom-fields-to-add-custom-data-to-rewards#querying-by-custom-fields) * @summary List rewards * @param {number} [offset] Offsets the returned list by the given number of rewards. The returned rewards are ordered (and offsetted) by their creation date (DESC). * @param {number} [limit] Limits the number of rewards listed. The maximum value is 500 and the default is 100. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RewardsApi */ listRewards(offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise>; /** * Resends a reward, identified by the given `id` in the URL, to its recipient. Only rewards with a previous delivery failure can be resent. * @summary Resend reward * @param {string} id ID of the reward that should be resent * @param {ResendRewardRequest} [resendRewardRequest] You can update the email or phone number used for the resend. You can only provide one of `updated_email` or `updated_phone`, not both. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RewardsApi */ resendReward(id: string, resendRewardRequest?: ResendRewardRequest, options?: RawAxiosRequestConfig): Promise>; } /** * RolesApi - axios parameter creator * @export */ export declare const RolesApiAxiosParamCreator: (configuration?: Configuration) => { /** * List all available roles in the organization. * @summary List roles * @param {*} [options] Override http request option. * @throws {RequiredError} */ listRoles: (options?: RawAxiosRequestConfig) => Promise; }; /** * RolesApi - functional programming interface * @export */ export declare const RolesApiFp: (configuration?: Configuration) => { /** * List all available roles in the organization. * @summary List roles * @param {*} [options] Override http request option. * @throws {RequiredError} */ listRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * RolesApi - factory interface * @export */ export declare const RolesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * List all available roles in the organization. * @summary List roles * @param {*} [options] Override http request option. * @throws {RequiredError} */ listRoles(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * RolesApi - object-oriented interface * @export * @class RolesApi * @extends {BaseAPI} */ export declare class RolesApi extends BaseAPI { /** * List all available roles in the organization. * @summary List roles * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RolesApi */ listRoles(options?: RawAxiosRequestConfig): Promise>; } /** * TopupsApi - axios parameter creator * @export */ export declare const TopupsApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Create a topup * @param {CreateTopupRequest} [createTopupRequest] Parameters required to create a new topup. The `idempotency_key` should be unique for each request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTopup: (createTopupRequest?: CreateTopupRequest, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a topup, identified by the given `id` in the URL. * @summary Retrieve single topup * @param {string} id ID of the topup request that should be retrieved * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTopup: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a list of all topup requests. * @summary List topups * @param {number} [offset] Offsets the returned list by the given number of topups. The returned topups are ordered and offset by their creation date (DESC). * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTopups: (offset?: number, options?: RawAxiosRequestConfig) => Promise; }; /** * TopupsApi - functional programming interface * @export */ export declare const TopupsApiFp: (configuration?: Configuration) => { /** * * @summary Create a topup * @param {CreateTopupRequest} [createTopupRequest] Parameters required to create a new topup. The `idempotency_key` should be unique for each request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTopup(createTopupRequest?: CreateTopupRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a topup, identified by the given `id` in the URL. * @summary Retrieve single topup * @param {string} id ID of the topup request that should be retrieved * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTopup(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a list of all topup requests. * @summary List topups * @param {number} [offset] Offsets the returned list by the given number of topups. The returned topups are ordered and offset by their creation date (DESC). * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTopups(offset?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TopupsApi - factory interface * @export */ export declare const TopupsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Create a topup * @param {CreateTopupRequest} [createTopupRequest] Parameters required to create a new topup. The `idempotency_key` should be unique for each request. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTopup(createTopupRequest?: CreateTopupRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a topup, identified by the given `id` in the URL. * @summary Retrieve single topup * @param {string} id ID of the topup request that should be retrieved * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTopup(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a list of all topup requests. * @summary List topups * @param {number} [offset] Offsets the returned list by the given number of topups. The returned topups are ordered and offset by their creation date (DESC). * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTopups(offset?: number, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * TopupsApi - object-oriented interface * @export * @class TopupsApi * @extends {BaseAPI} */ export declare class TopupsApi extends BaseAPI { /** * * @summary Create a topup * @param {CreateTopupRequest} [createTopupRequest] Parameters required to create a new topup. The `idempotency_key` should be unique for each request. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TopupsApi */ createTopup(createTopupRequest?: CreateTopupRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a topup, identified by the given `id` in the URL. * @summary Retrieve single topup * @param {string} id ID of the topup request that should be retrieved * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TopupsApi */ getTopup(id: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a list of all topup requests. * @summary List topups * @param {number} [offset] Offsets the returned list by the given number of topups. The returned topups are ordered and offset by their creation date (DESC). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TopupsApi */ listTopups(offset?: number, options?: RawAxiosRequestConfig): Promise>; } /** * WebhooksApi - axios parameter creator * @export */ export declare const WebhooksApiAxiosParamCreator: (configuration?: Configuration) => { /** * Tremendous uses webhooks as a notification system for various events that happen in your account. > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) Every organization can define a single webhook endpoint where we send requests to, whenever an event happens. This endpoint allows you to setup that endpoint. The URL of the endpoint can be changed by making a request to this endpoint again with the new URL. ## Request body
Property Type Description
url
string uri

URL the webhook will make requests to

* @summary Create webhook * @param {CreateWebhookRequest} createWebhookRequest Webhook details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebhook: (createWebhookRequest: CreateWebhookRequest, options?: RawAxiosRequestConfig) => Promise; /** * > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) * @summary Delete webhook * @param {string} id ID of the webhook to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhook: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) * @summary Retrieve webhook * @param {string} id ID of the webhook to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhook: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Lists all event types that can be sent to the configured webhook endpoint. > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) * @summary List events * @param {string} id ID of the webhook to list the events for * @param {*} [options] Override http request option. * @throws {RequiredError} */ listWebhookEvents: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Every organization can only have one webhook. This endpoint shows the details about that webhook. > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) * @summary List webhooks * @param {*} [options] Override http request option. * @throws {RequiredError} */ listWebhooks: (options?: RawAxiosRequestConfig) => Promise; /** * Making a request to this endpoint will cause our system to trigger a webhook for the specified event. This can be very useful when testing the setup that processes webhooks on your end. > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) * @summary Test webhook * @param {string} id ID of the webhook to test * @param {SimulateWebhookRequest} simulateWebhookRequest Webhook details * @param {*} [options] Override http request option. * @throws {RequiredError} */ simulateWebhook: (id: string, simulateWebhookRequest: SimulateWebhookRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * WebhooksApi - functional programming interface * @export */ export declare const WebhooksApiFp: (configuration?: Configuration) => { /** * Tremendous uses webhooks as a notification system for various events that happen in your account. > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) Every organization can define a single webhook endpoint where we send requests to, whenever an event happens. This endpoint allows you to setup that endpoint. The URL of the endpoint can be changed by making a request to this endpoint again with the new URL. ## Request body
Property Type Description
url
string uri

URL the webhook will make requests to

* @summary Create webhook * @param {CreateWebhookRequest} createWebhookRequest Webhook details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebhook(createWebhookRequest: CreateWebhookRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) * @summary Delete webhook * @param {string} id ID of the webhook to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhook(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) * @summary Retrieve webhook * @param {string} id ID of the webhook to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhook(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Lists all event types that can be sent to the configured webhook endpoint. > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) * @summary List events * @param {string} id ID of the webhook to list the events for * @param {*} [options] Override http request option. * @throws {RequiredError} */ listWebhookEvents(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Every organization can only have one webhook. This endpoint shows the details about that webhook. > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) * @summary List webhooks * @param {*} [options] Override http request option. * @throws {RequiredError} */ listWebhooks(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Making a request to this endpoint will cause our system to trigger a webhook for the specified event. This can be very useful when testing the setup that processes webhooks on your end. > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) * @summary Test webhook * @param {string} id ID of the webhook to test * @param {SimulateWebhookRequest} simulateWebhookRequest Webhook details * @param {*} [options] Override http request option. * @throws {RequiredError} */ simulateWebhook(id: string, simulateWebhookRequest: SimulateWebhookRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * WebhooksApi - factory interface * @export */ export declare const WebhooksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Tremendous uses webhooks as a notification system for various events that happen in your account. > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) Every organization can define a single webhook endpoint where we send requests to, whenever an event happens. This endpoint allows you to setup that endpoint. The URL of the endpoint can be changed by making a request to this endpoint again with the new URL. ## Request body
Property Type Description
url
string uri

URL the webhook will make requests to

* @summary Create webhook * @param {CreateWebhookRequest} createWebhookRequest Webhook details * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebhook(createWebhookRequest: CreateWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) * @summary Delete webhook * @param {string} id ID of the webhook to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhook(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) * @summary Retrieve webhook * @param {string} id ID of the webhook to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhook(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Lists all event types that can be sent to the configured webhook endpoint. > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) * @summary List events * @param {string} id ID of the webhook to list the events for * @param {*} [options] Override http request option. * @throws {RequiredError} */ listWebhookEvents(id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Every organization can only have one webhook. This endpoint shows the details about that webhook. > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) * @summary List webhooks * @param {*} [options] Override http request option. * @throws {RequiredError} */ listWebhooks(options?: RawAxiosRequestConfig): AxiosPromise; /** * Making a request to this endpoint will cause our system to trigger a webhook for the specified event. This can be very useful when testing the setup that processes webhooks on your end. > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) * @summary Test webhook * @param {string} id ID of the webhook to test * @param {SimulateWebhookRequest} simulateWebhookRequest Webhook details * @param {*} [options] Override http request option. * @throws {RequiredError} */ simulateWebhook(id: string, simulateWebhookRequest: SimulateWebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * WebhooksApi - object-oriented interface * @export * @class WebhooksApi * @extends {BaseAPI} */ export declare class WebhooksApi extends BaseAPI { /** * Tremendous uses webhooks as a notification system for various events that happen in your account. > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) Every organization can define a single webhook endpoint where we send requests to, whenever an event happens. This endpoint allows you to setup that endpoint. The URL of the endpoint can be changed by making a request to this endpoint again with the new URL. ## Request body
Property Type Description
url
string uri

URL the webhook will make requests to

* @summary Create webhook * @param {CreateWebhookRequest} createWebhookRequest Webhook details * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApi */ createWebhook(createWebhookRequest: CreateWebhookRequest, options?: RawAxiosRequestConfig): Promise>; /** * > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) * @summary Delete webhook * @param {string} id ID of the webhook to delete * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApi */ deleteWebhook(id: string, options?: RawAxiosRequestConfig): Promise>; /** * > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) * @summary Retrieve webhook * @param {string} id ID of the webhook to retrieve * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApi */ getWebhook(id: string, options?: RawAxiosRequestConfig): Promise>; /** * Lists all event types that can be sent to the configured webhook endpoint. > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) * @summary List events * @param {string} id ID of the webhook to list the events for * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApi */ listWebhookEvents(id: string, options?: RawAxiosRequestConfig): Promise>; /** * Every organization can only have one webhook. This endpoint shows the details about that webhook. > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) * @summary List webhooks * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApi */ listWebhooks(options?: RawAxiosRequestConfig): Promise>; /** * Making a request to this endpoint will cause our system to trigger a webhook for the specified event. This can be very useful when testing the setup that processes webhooks on your end. > 📘 Learn more about Webhooks > > Our guide explains everything you need to know about the Tremendous webhooks: > [Read it here](/docs/webhooks-1) * @summary Test webhook * @param {string} id ID of the webhook to test * @param {SimulateWebhookRequest} simulateWebhookRequest Webhook details * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApi */ simulateWebhook(id: string, simulateWebhookRequest: SimulateWebhookRequest, options?: RawAxiosRequestConfig): Promise>; }