@jokoor/sdk
Version:
Jokoor SMS API SDK for JavaScript/TypeScript
2,627 lines • 636 kB
TypeScript
/**
* Jokoor API
* SMS and Campaign Management Platform API
*
* The version of the OpenAPI document: 1.0
* Contact: support@jokoor.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 type { RequestArgs } from './base';
import { BaseAPI } from './base';
/**
*
* @export
* @interface AuthInvitation
*/
export interface AuthInvitation {
/**
*
* @type {string}
* @memberof AuthInvitation
*/
'app'?: string;
/**
*
* @type {string}
* @memberof AuthInvitation
*/
'created_at'?: string;
/**
*
* @type {string}
* @memberof AuthInvitation
*/
'email'?: string;
/**
*
* @type {string}
* @memberof AuthInvitation
*/
'expires_at'?: string;
/**
*
* @type {string}
* @memberof AuthInvitation
*/
'id'?: string;
/**
*
* @type {string}
* @memberof AuthInvitation
*/
'invited_by'?: string;
/**
*
* @type {string}
* @memberof AuthInvitation
*/
'inviter_name'?: string;
/**
* Joined fields
* @type {AuthOrganization}
* @memberof AuthInvitation
*/
'organization'?: AuthOrganization;
/**
*
* @type {string}
* @memberof AuthInvitation
*/
'organization_id'?: string;
/**
*
* @type {string}
* @memberof AuthInvitation
*/
'personal_message'?: string;
/**
*
* @type {string}
* @memberof AuthInvitation
*/
'role'?: string;
/**
*
* @type {string}
* @memberof AuthInvitation
*/
'status'?: string;
/**
*
* @type {string}
* @memberof AuthInvitation
*/
'token'?: string;
/**
*
* @type {string}
* @memberof AuthInvitation
*/
'updated_at'?: string;
}
/**
*
* @export
* @interface AuthInvitationRegisterRequest
*/
export interface AuthInvitationRegisterRequest {
/**
*
* @type {string}
* @memberof AuthInvitationRegisterRequest
*/
'first_name': string;
/**
*
* @type {string}
* @memberof AuthInvitationRegisterRequest
*/
'last_name': string;
/**
*
* @type {string}
* @memberof AuthInvitationRegisterRequest
*/
'password': string;
/**
*
* @type {string}
* @memberof AuthInvitationRegisterRequest
*/
'token': string;
}
/**
*
* @export
* @interface AuthInvitationRequest
*/
export interface AuthInvitationRequest {
/**
*
* @type {string}
* @memberof AuthInvitationRequest
*/
'app'?: string;
/**
*
* @type {string}
* @memberof AuthInvitationRequest
*/
'email': string;
/**
*
* @type {string}
* @memberof AuthInvitationRequest
*/
'personal_message'?: string;
/**
*
* @type {string}
* @memberof AuthInvitationRequest
*/
'role': string;
}
/**
*
* @export
* @interface AuthOrganization
*/
export interface AuthOrganization {
/**
*
* @type {string}
* @memberof AuthOrganization
*/
'created_at'?: string;
/**
*
* @type {string}
* @memberof AuthOrganization
*/
'description'?: string;
/**
*
* @type {string}
* @memberof AuthOrganization
*/
'id'?: string;
/**
*
* @type {boolean}
* @memberof AuthOrganization
*/
'is_platform'?: boolean;
/**
*
* @type {string}
* @memberof AuthOrganization
*/
'logo_url'?: string;
/**
*
* @type {string}
* @memberof AuthOrganization
*/
'name'?: string;
/**
* Onboarding status from organization_onboarding table
* @type {string}
* @memberof AuthOrganization
*/
'onboarding_status'?: string;
/**
* User\'s role in this org, for API response
* @type {string}
* @memberof AuthOrganization
*/
'role'?: string;
/**
* Corresponds to JSONB in DB
* @type {object}
* @memberof AuthOrganization
*/
'settings'?: object;
/**
*
* @type {string}
* @memberof AuthOrganization
*/
'status'?: string;
/**
*
* @type {string}
* @memberof AuthOrganization
*/
'updated_at'?: string;
/**
*
* @type {string}
* @memberof AuthOrganization
*/
'website_url'?: string;
}
/**
*
* @export
* @interface AuthOrganizationCreateRequest
*/
export interface AuthOrganizationCreateRequest {
/**
*
* @type {string}
* @memberof AuthOrganizationCreateRequest
*/
'description'?: string;
/**
*
* @type {string}
* @memberof AuthOrganizationCreateRequest
*/
'logo_url'?: string;
/**
*
* @type {string}
* @memberof AuthOrganizationCreateRequest
*/
'name': string;
/**
*
* @type {string}
* @memberof AuthOrganizationCreateRequest
*/
'website_url'?: string;
}
/**
*
* @export
* @interface AuthOrganizationUpdateRequest
*/
export interface AuthOrganizationUpdateRequest {
/**
*
* @type {string}
* @memberof AuthOrganizationUpdateRequest
*/
'description'?: string;
/**
*
* @type {string}
* @memberof AuthOrganizationUpdateRequest
*/
'logo_url'?: string;
/**
*
* @type {string}
* @memberof AuthOrganizationUpdateRequest
*/
'name'?: string;
/**
*
* @type {object}
* @memberof AuthOrganizationUpdateRequest
*/
'settings'?: object;
/**
*
* @type {string}
* @memberof AuthOrganizationUpdateRequest
*/
'status'?: string;
/**
*
* @type {string}
* @memberof AuthOrganizationUpdateRequest
*/
'website_url'?: string;
}
/**
*
* @export
* @interface AuthUploadcareImageRequest
*/
export interface AuthUploadcareImageRequest {
/**
*
* @type {number}
* @memberof AuthUploadcareImageRequest
*/
'height'?: number;
/**
*
* @type {string}
* @memberof AuthUploadcareImageRequest
*/
'mimeType'?: string;
/**
*
* @type {string}
* @memberof AuthUploadcareImageRequest
*/
'name'?: string;
/**
*
* @type {number}
* @memberof AuthUploadcareImageRequest
*/
'size'?: number;
/**
*
* @type {string}
* @memberof AuthUploadcareImageRequest
*/
'url': string;
/**
*
* @type {string}
* @memberof AuthUploadcareImageRequest
*/
'uuid': string;
/**
*
* @type {number}
* @memberof AuthUploadcareImageRequest
*/
'width'?: number;
}
/**
*
* @export
* @interface BillingPlanInfo
*/
export interface BillingPlanInfo {
/**
*
* @type {number}
* @memberof BillingPlanInfo
*/
'credits'?: number;
/**
*
* @type {string}
* @memberof BillingPlanInfo
*/
'id'?: string;
/**
*
* @type {string}
* @memberof BillingPlanInfo
*/
'name'?: string;
/**
*
* @type {number}
* @memberof BillingPlanInfo
*/
'price'?: number;
}
/**
*
* @export
* @interface BillingPlanSwitchPreview
*/
export interface BillingPlanSwitchPreview {
/**
* Positive = charge, Negative = credit
* @type {number}
* @memberof BillingPlanSwitchPreview
*/
'amount_to_charge'?: number;
/**
*
* @type {number}
* @memberof BillingPlanSwitchPreview
*/
'balance_after'?: number;
/**
* SMS credits to be added
* @type {number}
* @memberof BillingPlanSwitchPreview
*/
'credit_difference'?: number;
/**
*
* @type {number}
* @memberof BillingPlanSwitchPreview
*/
'current_balance'?: number;
/**
*
* @type {BillingPlanInfo}
* @memberof BillingPlanSwitchPreview
*/
'current_plan'?: BillingPlanInfo;
/**
*
* @type {boolean}
* @memberof BillingPlanSwitchPreview
*/
'is_upgrade'?: boolean;
/**
*
* @type {BillingPlanInfo}
* @memberof BillingPlanSwitchPreview
*/
'new_plan'?: BillingPlanInfo;
/**
*
* @type {number}
* @memberof BillingPlanSwitchPreview
*/
'new_plan_charge'?: number;
/**
*
* @type {number}
* @memberof BillingPlanSwitchPreview
*/
'remaining_days'?: number;
/**
*
* @type {number}
* @memberof BillingPlanSwitchPreview
*/
'total_days'?: number;
/**
*
* @type {number}
* @memberof BillingPlanSwitchPreview
*/
'unused_credit'?: number;
}
/**
*
* @export
* @interface PayProductsIdStatsGet200Response
*/
export interface PayProductsIdStatsGet200Response {
/**
*
* @type {PaymentProductSalesStats}
* @memberof PayProductsIdStatsGet200Response
*/
'data'?: PaymentProductSalesStats;
/**
*
* @type {string}
* @memberof PayProductsIdStatsGet200Response
*/
'error'?: string;
}
/**
*
* @export
* @interface PayProductsIdStatsGet400Response
*/
export interface PayProductsIdStatsGet400Response {
/**
*
* @type {object}
* @memberof PayProductsIdStatsGet400Response
*/
'data'?: object;
/**
*
* @type {string}
* @memberof PayProductsIdStatsGet400Response
*/
'error'?: string;
}
/**
*
* @export
* @interface PayProductsIdTransactionsGet200Response
*/
export interface PayProductsIdTransactionsGet200Response {
/**
*
* @type {V1TransactionListResponseDoc}
* @memberof PayProductsIdTransactionsGet200Response
*/
'data'?: V1TransactionListResponseDoc;
/**
*
* @type {string}
* @memberof PayProductsIdTransactionsGet200Response
*/
'error'?: string;
}
/**
*
* @export
* @interface PayTransactionsIdItemsGet200Response
*/
export interface PayTransactionsIdItemsGet200Response {
/**
*
* @type {Array<PaymentTransactionItem>}
* @memberof PayTransactionsIdItemsGet200Response
*/
'data'?: Array<PaymentTransactionItem>;
/**
*
* @type {string}
* @memberof PayTransactionsIdItemsGet200Response
*/
'error'?: string;
}
/**
*
* @export
* @interface PaymentAddress
*/
export interface PaymentAddress {
/**
*
* @type {string}
* @memberof PaymentAddress
*/
'city'?: string;
/**
*
* @type {string}
* @memberof PaymentAddress
*/
'country'?: string;
/**
*
* @type {string}
* @memberof PaymentAddress
*/
'location'?: string;
}
/**
*
* @export
* @interface PaymentBankDetails
*/
export interface PaymentBankDetails {
/**
*
* @type {string}
* @memberof PaymentBankDetails
*/
'account_holder_name'?: string;
/**
*
* @type {string}
* @memberof PaymentBankDetails
*/
'account_number'?: string;
/**
*
* @type {string}
* @memberof PaymentBankDetails
*/
'bank_name'?: string;
}
/**
*
* @export
* @interface PaymentBusinessDetails
*/
export interface PaymentBusinessDetails {
/**
*
* @type {string}
* @memberof PaymentBusinessDetails
*/
'industry'?: string;
/**
*
* @type {string}
* @memberof PaymentBusinessDetails
*/
'product_description'?: string;
/**
*
* @type {string}
* @memberof PaymentBusinessDetails
*/
'website'?: string;
}
/**
*
* @export
* @interface PaymentCustomField
*/
export interface PaymentCustomField {
/**
*
* @type {string}
* @memberof PaymentCustomField
*/
'label': string;
/**
*
* @type {string}
* @memberof PaymentCustomField
*/
'name': string;
/**
*
* @type {Array<string>}
* @memberof PaymentCustomField
*/
'options'?: Array<string>;
/**
*
* @type {string}
* @memberof PaymentCustomField
*/
'placeholder'?: string;
/**
*
* @type {boolean}
* @memberof PaymentCustomField
*/
'required'?: boolean;
/**
*
* @type {string}
* @memberof PaymentCustomField
*/
'type': PaymentCustomFieldTypeEnum;
/**
*
* @type {PaymentCustomFieldValidation}
* @memberof PaymentCustomField
*/
'validation'?: PaymentCustomFieldValidation;
}
export declare const PaymentCustomFieldTypeEnum: {
readonly Text: "text";
readonly Email: "email";
readonly Phone: "phone";
readonly Number: "number";
readonly Date: "date";
readonly Select: "select";
readonly Checkbox: "checkbox";
};
export type PaymentCustomFieldTypeEnum = typeof PaymentCustomFieldTypeEnum[keyof typeof PaymentCustomFieldTypeEnum];
/**
*
* @export
* @interface PaymentCustomFieldValidation
*/
export interface PaymentCustomFieldValidation {
/**
* For number type
* @type {number}
* @memberof PaymentCustomFieldValidation
*/
'max'?: number;
/**
*
* @type {number}
* @memberof PaymentCustomFieldValidation
*/
'max_length'?: number;
/**
* For number type
* @type {number}
* @memberof PaymentCustomFieldValidation
*/
'min'?: number;
/**
*
* @type {number}
* @memberof PaymentCustomFieldValidation
*/
'min_length'?: number;
/**
* Regex pattern
* @type {string}
* @memberof PaymentCustomFieldValidation
*/
'pattern'?: string;
}
/**
*
* @export
* @interface PaymentFailurePost200Response
*/
export interface PaymentFailurePost200Response {
/**
*
* @type {{ [key: string]: any; }}
* @memberof PaymentFailurePost200Response
*/
'data'?: {
[key: string]: any;
};
/**
*
* @type {string}
* @memberof PaymentFailurePost200Response
*/
'error'?: string;
}
/**
*
* @export
* @interface PaymentOnboardingData
*/
export interface PaymentOnboardingData {
/**
*
* @type {PaymentAddress}
* @memberof PaymentOnboardingData
*/
'address'?: PaymentAddress;
/**
*
* @type {PaymentBankDetails}
* @memberof PaymentOnboardingData
*/
'bank_details'?: PaymentBankDetails;
/**
*
* @type {PaymentBusinessDetails}
* @memberof PaymentOnboardingData
*/
'business_details'?: PaymentBusinessDetails;
/**
*
* @type {string}
* @memberof PaymentOnboardingData
*/
'business_registration_filename'?: string;
/**
*
* @type {string}
* @memberof PaymentOnboardingData
*/
'business_registration_id'?: string;
/**
*
* @type {string}
* @memberof PaymentOnboardingData
*/
'business_structure'?: string;
/**
*
* @type {string}
* @memberof PaymentOnboardingData
*/
'business_type'?: string;
/**
*
* @type {string}
* @memberof PaymentOnboardingData
*/
'government_id'?: string;
/**
*
* @type {string}
* @memberof PaymentOnboardingData
*/
'government_id_filename'?: string;
/**
*
* @type {string}
* @memberof PaymentOnboardingData
*/
'incorporation_certificate_filename'?: string;
/**
*
* @type {string}
* @memberof PaymentOnboardingData
*/
'incorporation_certificate_id'?: string;
/**
*
* @type {string}
* @memberof PaymentOnboardingData
*/
'proof_of_address_filename'?: string;
/**
*
* @type {string}
* @memberof PaymentOnboardingData
*/
'proof_of_address_id'?: string;
/**
*
* @type {PaymentRepresentative}
* @memberof PaymentOnboardingData
*/
'representative'?: PaymentRepresentative;
/**
* Legacy filename field
* @type {string}
* @memberof PaymentOnboardingData
*/
'tin_certificate'?: string;
/**
*
* @type {string}
* @memberof PaymentOnboardingData
*/
'tin_certificate_id'?: string;
}
/**
*
* @export
* @interface PaymentOnboardingStatusResponse
*/
export interface PaymentOnboardingStatusResponse {
/**
*
* @type {Array<string>}
* @memberof PaymentOnboardingStatusResponse
*/
'completed_steps'?: Array<string>;
/**
*
* @type {string}
* @memberof PaymentOnboardingStatusResponse
*/
'current_step'?: string;
/**
*
* @type {PaymentOnboardingData}
* @memberof PaymentOnboardingStatusResponse
*/
'data'?: PaymentOnboardingData;
/**
*
* @type {string}
* @memberof PaymentOnboardingStatusResponse
*/
'rejection_reason'?: string;
/**
*
* @type {string}
* @memberof PaymentOnboardingStatusResponse
*/
'reviewed_at'?: string;
/**
*
* @type {StatusOnboardingStatus}
* @memberof PaymentOnboardingStatusResponse
*/
'status'?: StatusOnboardingStatus;
/**
*
* @type {string}
* @memberof PaymentOnboardingStatusResponse
*/
'submitted_at'?: string;
}
/**
*
* @export
* @interface PaymentProductSalesStats
*/
export interface PaymentProductSalesStats {
/**
*
* @type {number}
* @memberof PaymentProductSalesStats
*/
'total_quantity'?: number;
/**
*
* @type {number}
* @memberof PaymentProductSalesStats
*/
'total_revenue'?: number;
/**
*
* @type {number}
* @memberof PaymentProductSalesStats
*/
'transaction_count'?: number;
}
/**
*
* @export
* @interface PaymentRepresentative
*/
export interface PaymentRepresentative {
/**
*
* @type {string}
* @memberof PaymentRepresentative
*/
'address'?: string;
/**
*
* @type {string}
* @memberof PaymentRepresentative
*/
'date_of_birth'?: string;
/**
*
* @type {string}
* @memberof PaymentRepresentative
*/
'first_name'?: string;
/**
*
* @type {string}
* @memberof PaymentRepresentative
*/
'last_name'?: string;
/**
*
* @type {number}
* @memberof PaymentRepresentative
*/
'ownership_percentage'?: number;
}
/**
*
* @export
* @interface PaymentTransactionItem
*/
export interface PaymentTransactionItem {
/**
*
* @type {string}
* @memberof PaymentTransactionItem
*/
'created_at'?: string;
/**
*
* @type {string}
* @memberof PaymentTransactionItem
*/
'description'?: string;
/**
*
* @type {string}
* @memberof PaymentTransactionItem
*/
'id'?: string;
/**
*
* @type {string}
* @memberof PaymentTransactionItem
*/
'name'?: string;
/**
*
* @type {string}
* @memberof PaymentTransactionItem
*/
'product_id'?: string;
/**
*
* @type {number}
* @memberof PaymentTransactionItem
*/
'quantity'?: number;
/**
*
* @type {number}
* @memberof PaymentTransactionItem
*/
'total'?: number;
/**
*
* @type {string}
* @memberof PaymentTransactionItem
*/
'transaction_id'?: string;
/**
*
* @type {number}
* @memberof PaymentTransactionItem
*/
'unit_price'?: number;
}
/**
*
* @export
* @interface PaymentTransactionStatusStats
*/
export interface PaymentTransactionStatusStats {
/**
*
* @type {number}
* @memberof PaymentTransactionStatusStats
*/
'cancelled_count'?: number;
/**
* Amounts by status (only for completed and refunded transactions)
* @type {number}
* @memberof PaymentTransactionStatusStats
*/
'completed_amount'?: number;
/**
*
* @type {number}
* @memberof PaymentTransactionStatusStats
*/
'completed_count'?: number;
/**
*
* @type {number}
* @memberof PaymentTransactionStatusStats
*/
'expired_count'?: number;
/**
*
* @type {number}
* @memberof PaymentTransactionStatusStats
*/
'failed_count'?: number;
/**
*
* @type {number}
* @memberof PaymentTransactionStatusStats
*/
'partially_refunded_amount'?: number;
/**
*
* @type {number}
* @memberof PaymentTransactionStatusStats
*/
'partially_refunded_count'?: number;
/**
* Count by status
* @type {number}
* @memberof PaymentTransactionStatusStats
*/
'pending_count'?: number;
/**
*
* @type {number}
* @memberof PaymentTransactionStatusStats
*/
'processing_count'?: number;
/**
*
* @type {number}
* @memberof PaymentTransactionStatusStats
*/
'refunded_amount'?: number;
/**
*
* @type {number}
* @memberof PaymentTransactionStatusStats
*/
'refunded_count'?: number;
/**
* Overall totals
* @type {number}
* @memberof PaymentTransactionStatusStats
*/
'total_count'?: number;
/**
*
* @type {number}
* @memberof PaymentTransactionStatusStats
*/
'total_fees'?: number;
/**
*
* @type {number}
* @memberof PaymentTransactionStatusStats
*/
'total_gross_amount'?: number;
/**
*
* @type {number}
* @memberof PaymentTransactionStatusStats
*/
'total_net_amount'?: number;
/**
*
* @type {number}
* @memberof PaymentTransactionStatusStats
*/
'total_refund_amount'?: number;
}
/**
*
* @export
* @interface ResponseResponse
*/
export interface ResponseResponse {
/**
*
* @type {object}
* @memberof ResponseResponse
*/
'data'?: object;
/**
*
* @type {string}
* @memberof ResponseResponse
*/
'error'?: string;
}
/**
*
* @export
* @interface SmsCreateSenderIDRequest
*/
export interface SmsCreateSenderIDRequest {
/**
*
* @type {string}
* @memberof SmsCreateSenderIDRequest
*/
'business_location': string;
/**
*
* @type {string}
* @memberof SmsCreateSenderIDRequest
*/
'business_name': string;
/**
*
* @type {string}
* @memberof SmsCreateSenderIDRequest
*/
'business_registration_number'?: string;
/**
*
* @type {string}
* @memberof SmsCreateSenderIDRequest
*/
'contact_email': string;
/**
*
* @type {string}
* @memberof SmsCreateSenderIDRequest
*/
'contact_person': string;
/**
*
* @type {string}
* @memberof SmsCreateSenderIDRequest
*/
'contact_phone': string;
/**
*
* @type {string}
* @memberof SmsCreateSenderIDRequest
*/
'country_code'?: string;
/**
*
* @type {string}
* @memberof SmsCreateSenderIDRequest
*/
'description': string;
/**
*
* @type {string}
* @memberof SmsCreateSenderIDRequest
*/
'sender_id': string;
}
/**
*
* @export
* @interface SmsDailySegmentBreakdown
*/
export interface SmsDailySegmentBreakdown {
/**
*
* @type {number}
* @memberof SmsDailySegmentBreakdown
*/
'campaign_message_segments'?: number;
/**
*
* @type {number}
* @memberof SmsDailySegmentBreakdown
*/
'campaign_messages'?: number;
/**
*
* @type {number}
* @memberof SmsDailySegmentBreakdown
*/
'credits'?: number;
/**
*
* @type {string}
* @memberof SmsDailySegmentBreakdown
*/
'date'?: string;
/**
*
* @type {number}
* @memberof SmsDailySegmentBreakdown
*/
'messages'?: number;
/**
*
* @type {number}
* @memberof SmsDailySegmentBreakdown
*/
'segments'?: number;
/**
*
* @type {number}
* @memberof SmsDailySegmentBreakdown
*/
'single_message_segments'?: number;
/**
*
* @type {number}
* @memberof SmsDailySegmentBreakdown
*/
'single_messages'?: number;
}
/**
*
* @export
* @interface SmsMonthlyDataset
*/
export interface SmsMonthlyDataset {
/**
*
* @type {Array<number>}
* @memberof SmsMonthlyDataset
*/
'data'?: Array<number>;
/**
*
* @type {string}
* @memberof SmsMonthlyDataset
*/
'label'?: string;
}
/**
*
* @export
* @interface SmsMonthlySegmentBreakdown
*/
export interface SmsMonthlySegmentBreakdown {
/**
*
* @type {number}
* @memberof SmsMonthlySegmentBreakdown
*/
'average_segments_per_message'?: number;
/**
*
* @type {number}
* @memberof SmsMonthlySegmentBreakdown
*/
'campaign_message_segments'?: number;
/**
*
* @type {number}
* @memberof SmsMonthlySegmentBreakdown
*/
'campaign_messages'?: number;
/**
*
* @type {number}
* @memberof SmsMonthlySegmentBreakdown
*/
'credits'?: number;
/**
*
* @type {number}
* @memberof SmsMonthlySegmentBreakdown
*/
'messages'?: number;
/**
* \"2024-01\"
* @type {string}
* @memberof SmsMonthlySegmentBreakdown
*/
'month'?: string;
/**
*
* @type {number}
* @memberof SmsMonthlySegmentBreakdown
*/
'segments'?: number;
/**
*
* @type {number}
* @memberof SmsMonthlySegmentBreakdown
*/
'single_message_segments'?: number;
/**
*
* @type {number}
* @memberof SmsMonthlySegmentBreakdown
*/
'single_messages'?: number;
}
/**
*
* @export
* @interface SmsMonthlyStats
*/
export interface SmsMonthlyStats {
/**
*
* @type {Array<SmsMonthlyDataset>}
* @memberof SmsMonthlyStats
*/
'datasets'?: Array<SmsMonthlyDataset>;
/**
*
* @type {Array<string>}
* @memberof SmsMonthlyStats
*/
'labels'?: Array<string>;
}
/**
*
* @export
* @interface SmsOrganizationBalance
*/
export interface SmsOrganizationBalance {
/**
*
* @type {number}
* @memberof SmsOrganizationBalance
*/
'account_balance'?: number;
/**
*
* @type {string}
* @memberof SmsOrganizationBalance
*/
'created_at'?: string;
/**
*
* @type {string}
* @memberof SmsOrganizationBalance
*/
'id'?: string;
/**
*
* @type {string}
* @memberof SmsOrganizationBalance
*/
'last_deduction_at'?: string;
/**
*
* @type {string}
* @memberof SmsOrganizationBalance
*/
'last_topup_at'?: string;
/**
*
* @type {string}
* @memberof SmsOrganizationBalance
*/
'organization_id'?: string;
/**
*
* @type {number}
* @memberof SmsOrganizationBalance
*/
'sms_credits'?: number;
/**
*
* @type {string}
* @memberof SmsOrganizationBalance
*/
'updated_at'?: string;
}
/**
*
* @export
* @interface SmsRecentActivity
*/
export interface SmsRecentActivity {
/**
*
* @type {string}
* @memberof SmsRecentActivity
*/
'date'?: string;
/**
*
* @type {string}
* @memberof SmsRecentActivity
*/
'description'?: string;
/**
*
* @type {string}
* @memberof SmsRecentActivity
*/
'status'?: string;
/**
*
* @type {string}
* @memberof SmsRecentActivity
*/
'title'?: string;
/**
*
* @type {string}
* @memberof SmsRecentActivity
*/
'type'?: string;
}
/**
*
* @export
* @interface SmsSMSCampaign
*/
export interface SmsSMSCampaign {
/**
*
* @type {string}
* @memberof SmsSMSCampaign
*/
'completed_at'?: string;
/**
*
* @type {Array<SmsSMSContactGroup>}
* @memberof SmsSMSCampaign
*/
'contact_groups'?: Array<SmsSMSContactGroup>;
/**
*
* @type {Array<SmsSMSContact>}
* @memberof SmsSMSCampaign
*/
'contacts'?: Array<SmsSMSContact>;
/**
*
* @type {string}
* @memberof SmsSMSCampaign
*/
'created_at'?: string;
/**
*
* @type {string}
* @memberof SmsSMSCampaign
*/
'created_by'?: string;
/**
*
* @type {SmsSMSCampaignDetails}
* @memberof SmsSMSCampaign
*/
'details'?: SmsSMSCampaignDetails;
/**
*
* @type {string}
* @memberof SmsSMSCampaign
*/
'id'?: string;
/**
* Related data (populated by joins)
* @type {SmsSMSTemplate}
* @memberof SmsSMSCampaign
*/
'message_template'?: SmsSMSTemplate;
/**
*
* @type {string}
* @memberof SmsSMSCampaign
*/
'message_template_id'?: string;
/**
*
* @type {Array<SmsSMSCampaignMessage>}
* @memberof SmsSMSCampaign
*/
'messages'?: Array<SmsSMSCampaignMessage>;
/**
*
* @type {{ [key: string]: string; }}
* @memberof SmsSMSCampaign
*/
'metadata'?: {
[key: string]: string;
};
/**
*
* @type {string}
* @memberof SmsSMSCampaign
*/
'name'?: string;
/**
*
* @type {string}
* @memberof SmsSMSCampaign
*/
'organization_id'?: string;
/**
*
* @type {string}
* @memberof SmsSMSCampaign
*/
'scheduled_at'?: string;
/**
*
* @type {SmsSMSSenderID}
* @memberof SmsSMSCampaign
*/
'sender_id_config'?: SmsSMSSenderID;
/**
*
* @type {string}
* @memberof SmsSMSCampaign
*/
'sender_id_config_id'?: string;
/**
*
* @type {string}
* @memberof SmsSMSCampaign
*/
'started_at'?: string;
/**
*
* @type {string}
* @memberof SmsSMSCampaign
*/
'status'?: string;
/**
*
* @type {string}
* @memberof SmsSMSCampaign
*/
'updated_at'?: string;
}
/**
*
* @export
* @interface SmsSMSCampaignDetails
*/
export interface SmsSMSCampaignDetails {
/**
* Additional computed statistics
* @type {number}
* @memberof SmsSMSCampaignDetails
*/
'delivery_rate'?: number;
/**
* (failed / total) * 100
* @type {number}
* @memberof SmsSMSCampaignDetails
*/
'failure_rate'?: number;
/**
* (pending / total) * 100
* @type {number}
* @memberof SmsSMSCampaignDetails
*/
'pending_rate'?: number;
/**
* Breakdown by status
* @type {{ [key: string]: number; }}
* @memberof SmsSMSCampaignDetails
*/
'status_breakdown'?: {
[key: string]: number;
};
/**
*
* @type {number}
* @memberof SmsSMSCampaignDetails
*/
'total_failed_messages'?: number;
/**
* Campaign statistics
* @type {number}
* @memberof SmsSMSCampaignDetails
*/
'total_message_count'?: number;
/**
*
* @type {number}
* @memberof SmsSMSCampaignDetails
*/
'total_pending_messages'?: number;
/**
* Total SMS segments consumed
* @type {number}
* @memberof SmsSMSCampaignDetails
*/
'total_segments_used'?: number;
/**
*
* @type {number}
* @memberof SmsSMSCampaignDetails
*/
'total_sent_messages'?: number;
}
/**
*
* @export
* @interface SmsSMSCampaignMessage
*/
export interface SmsSMSCampaignMessage {
/**
*
* @type {SmsSMSCampaign}
* @memberof SmsSMSCampaignMessage
*/
'campaign'?: SmsSMSCampaign;
/**
*
* @type {string}
* @memberof SmsSMSCampaignMessage
*/
'campaign_id'?: string;
/**
* Related data (populated by joins)
* @type {SmsSMSContact}
* @memberof SmsSMSCampaignMessage
*/
'contact'?: SmsSMSContact;
/**
*
* @type {string}
* @memberof SmsSMSCampaignMessage
*/
'contact_id'?: string;
/**
*
* @type {string}
* @memberof SmsSMSCampaignMessage
*/
'created_at'?: string;
/**
*
* @type {string}
* @memberof SmsSMSCampaignMessage
*/
'error_message'?: string;
/**
*
* @type {string}
* @memberof SmsSMSCampaignMessage
*/
'failed_at'?: string;
/**
*
* @type {string}
* @memberof SmsSMSCampaignMessage
*/
'id'?: string;
/**
*
* @type {string}
* @memberof SmsSMSCampaignMessage
*/
'message_content'?: string;
/**
*
* @type {string}
* @memberof SmsSMSCampaignMessage
*/
'phone_number'?: string;
/**
* ID from SMS provider
* @type {string}
* @memberof SmsSMSCampaignMessage
*/
'provider_msg_id'?: string;
/**
* Number of SMS segments used
* @type {number}
* @memberof SmsSMSCampaignMessage
*/
'segments'?: number;
/**
*
* @type {string}
* @memberof SmsSMSCampaignMessage
*/
'sent_at'?: string;
/**
* pending, sent, failed
* @type {string}
* @memberof SmsSMSCampaignMessage
*/
'status'?: string;
/**
*
* @type {string}
* @memberof SmsSMSCampaignMessage
*/
'updated_at'?: string;
}
/**
*
* @export
* @interface SmsSMSContact
*/
export interface SmsSMSContact {
/**
*
* @type {string}
* @memberof SmsSMSContact
*/
'created_at'?: string;
/**
*
* @type {string}
* @memberof SmsSMSContact
*/
'email'?: string;
/**
*
* @type {string}
* @memberof SmsSMSContact
*/
'first_name'?: string;
/**
*
* @type {string}
* @memberof SmsSMSContact
*/
'id'?: string;
/**
*
* @type {boolean}
* @memberof SmsSMSContact
*/
'is_subscribed'?: boolean;
/**
*
* @type {string}
* @memberof SmsSMSContact
*/
'last_name'?: string;
/**
*
* @type {{ [key: string]: string; }}
* @memberof SmsSMSContact
*/
'metadata'?: {
[key: string]: string;
};
/**
*
* @type {string}
* @memberof SmsSMSContact
*/
'organization_id'?: string;
/**
*
* @type {string}
* @memberof SmsSMSContact
*/
'phone_number'?: string;
/**
*
* @type {string}
* @memberof SmsSMSContact
*/
'updated_at'?: string;
}
/**
*
* @export
* @interface SmsSMSContactGroup
*/
export interface SmsSMSContactGroup {
/**
*
* @type {number}
* @memberof SmsSMSContactGroup
*/
'contact_count'?: number;
/**
* Related data (populated by joins)
* @type {Array<SmsSMSContact>}
* @memberof SmsSMSContactGroup
*/
'contacts'?: Array<SmsSMSContact>;
/**
*
* @type {string}
* @memberof SmsSMSContactGroup
*/
'created_at'?: string;
/**
*
* @type {string}
* @memberof SmsSMSContactGroup
*/
'description'?: string;
/**
*
* @type {string}
* @memberof SmsSMSContactGroup
*/
'id'?: string;
/**
*
* @type {string}
* @memberof SmsSMSContactGroup
*/
'name'?: string;
/**
*
* @type {string}
* @memberof SmsSMSContactGroup
*/
'organization_id'?: string;
/**
*
* @type {string}
* @memberof SmsSMSContactGroup
*/
'updated_at'?: string;
}
/**
*
* @export
* @interface SmsSMSDashboardData
*/
export interface SmsSMSDashboardData {
/**
*
* @type {SmsMonthlyStats}
* @memberof SmsSMSDashboardData
*/
'monthly_stats'?: SmsMonthlyStats;
/**
*
* @type {Array<SmsRecentActivity>}
* @memberof SmsSMSDashboardData
*/
'recent_activities'?: Array<SmsRecentActivity>;
/**
*
* @type {SmsStats}
* @memberof SmsSMSDashboardData
*/
'stats'?: SmsStats;
}
/**
*
* @export
* @interface SmsSMSSenderID
*/
export interface SmsSMSSenderID {
/**
*
* @type {string}
* @memberof SmsSMSSenderID
*/
'approval_notes'?: string;
/**
*
* @type {string}
* @memberof SmsSMSSenderID
*/
'approved_at'?: string;
/**
*
* @type {string}
* @memberof SmsSMSSenderID
*/
'approved_by'?: string;
/**
*
* @type {string}
* @memberof SmsSMSSenderID
*/
'business_location'?: string;
/**
*
* @type {string}
* @memberof SmsSMSSenderID
*/
'business_name'?: string;
/**
*
* @type {string}
* @memberof SmsSMSSenderID
*/
'business_registration_number'?: string;
/**
*
* @type {string}
* @memberof SmsSMSSenderID
*/
'contact_email'?: string;
/**
*
* @type {string}
* @memberof SmsSMSSenderID
*/
'contact_person'?: string;
/**
*
* @type {string}
* @memberof SmsSMSSenderID
*/
'contact_phone'?: string;
/**
*
* @type {string}
* @memberof SmsSMSSenderID
*/
'country_code'?: string;
/**
*
* @type {string}
* @memberof SmsSMSSenderID
*/
'created_at'?: string;
/**
*
* @type {string}
* @memberof SmsSMSSenderID
*/
'description'?: string;
/**
*
* @type {string}
* @memberof SmsSMSSenderID
*/
'id'?: string;
/**
*
* @type {boolean}
* @memberof SmsSMSSenderID
*/
'is_default'?: boolean;
/**
*
* @type {string}
* @memberof SmsSMSSenderID
*/
'organization_id'?: string;
/**
* Additional fields for platform view
* @type {string}
* @memberof SmsSMSSenderID
*/
'organization_name'?: string;
/**
*
* @type {string}
* @memberof SmsSMSSenderID
*/
'rejected_reason'?: string;
/**
*
* @type {string}
* @memberof SmsSMSSenderID
*/
'sender_id'?: string;
/**
* processing, approved, rejected
* @type {string}
* @memberof SmsSMSSenderID
*/
'status'?: string;
/**
*
* @type {string}
* @memberof SmsSMSSenderID
*/
'updated_at'?: string;
/**
*
* @type {number}
* @memberof SmsSMSSenderID
*/
'version'?: number;
}
/**
*
* @export
* @interface SmsSMSTemplate
*/
export interface SmsSMSTemplate {
/**
*
* @type {string}
* @memberof SmsSMSTemplate
*/
'body'?: string;
/**
*
* @type {string}
* @memberof SmsSMSTemplate
*/
'created_at'?: string;
/**
*
* @type {string}
* @memberof SmsSMSTemplate
*/
'created_by'?: string;
/**
*
* @type {string}
* @memberof SmsSMSTemplate
*/
'id'?: string;
/**
*
* @type {string}
* @memberof SmsSMSTemplate
*/
'name'?: string;
/**
*
* @type {string}
* @memberof SmsSMSTemplate
*/
'organization_id'?: string;
/**
*
* @type {string}
* @memberof SmsSMSTemplate
*/
'updated_at'?: string;
/**
*
* @type {Array<string>}
* @memberof SmsSMSTemplate
*/
'variables'?: Array<string>;
}
/**
*
* @export
* @interface SmsSegmentAnalytics
*/
export interface SmsSegmentAnalytics {
/**
*
* @type {number}
* @memberof SmsSegmentAnalytics
*/
'average_segments_per_message'?: number;
/**
*
* @type {number}
* @memberof SmsSegmentAnalytics
*/
'campaign_message_segments'?: number;
/**
*
* @type {number}
* @memberof SmsSegmentAnalytics
*/
'campaign_messages'?: number;
/**
*
* @type {Array<SmsDailySegmentBreakdown>}
* @memberof SmsSegmentAnalytics
*/
'daily_breakdown'?: Array<SmsDailySegmentBreakdown>;
/**
*
* @type {string}
* @memberof SmsSegmentAnalytics
*/
'end_date'?: string;
/**
*
* @type {Array<SmsMonthlySegmentBreakdown>}
* @memberof SmsSegmentAnalytics
*/
'monthly_breakdown'?: Array<SmsMonthlySegmentBreakdown>;
/**
*
* @type {string}
* @memberof SmsSegmentAnalytics
*/
'organization_id'?: string;
/**
* \"daily\", \"monthly\", \"yearly\"
* @type {string}
* @memberof SmsSegmentAnalytics
*/
'period'?: string;
/**
*
* @type {number}
* @memberof SmsSegmentAnalytics
*/
'single_message_segments'?: number;
/**
*
* @type {number}
* @memberof SmsSegmentAnalytics
*/
'single_messages'?: number;
/**
*
* @type {string}
* @memberof SmsSegmentAnalytics
*/
'start_date'?: string;
/**
*
* @type {number}
* @memberof SmsSegmentAnalytics
*/
'total_charges'?: number;
/**
*
* @type {number}
* @memberof SmsSegmentAnalytics
*/
'total_credits'?: number;
/**
*
* @type {number}
* @memberof SmsSegmentAnalytics
*/
'total_messages'?: number;
/**
*
* @type {number}
* @memberof SmsSegmentAnalytics
*/
'total_segments'?: number;
}
/**
*
* @export
* @interface SmsStats
*/
export interface SmsStats {
/**
*
* @type {number}
* @memberof SmsStats
*/
'credits_balance'?: number;
/**
*
* @type {number}
* @memberof SmsStats
*/
'delivery_rate'?: number;
/**
*
* @type {number}
* @memberof SmsStats
*/
'failed_sms'?: number;
/**
*
* @type {number}
* @memberof SmsStats
*/
'successful_sms'?: number;
/**
*
* @type {number}
* @memberof SmsStats
*/
'total_sms'?: number;
}
/**
*
* @export
* @interface SmsUpdateCampaignRequest
*/
export interface SmsUpdateCampaignRequest {
/**
*
* @type {Array<string>}
* @memberof SmsUpdateCampaignRequest
*/
'contact_group_ids'?: Array<string>;
/**
*
* @type {Array<string>}
* @memberof SmsUpdateCampaignRequest
*/
'contact_ids'?: Array<string>;
/**
* For campaigns without templates
* @type {string}
* @memberof SmsUpdateCampaignRequest
*/
'message_body'?: string;
/**
*
* @type {string}
* @memberof SmsUpdateCampaignRequest
*/
'message_template_id'?: string;
/**
*
* @type {string}
* @memberof SmsUpdateCampaignRequest
*/
'name'?: string;
/**
*
* @type {string}
* @memberof SmsUpdateCampaignRequest
*/
'scheduled_at'?: string;
/**
*
* @type {string}
* @memberof SmsUpdateCampaignRequest
*/
'sender_id_config_id'?: string;
}
/**
*
* @export
* @interface SmsUpdateSenderIDRequest
*/
export interface SmsUpdateSenderIDRequest {
/**
*
* @type {string}
* @memberof SmsUpdateSenderIDRequest
*/
'business_location'?: string;
/**
*
* @type {string}
* @memberof SmsUpdateSenderIDRequest
*/
'business_name'?: string;
/**
*
* @type {string}
* @memberof SmsUpdateSenderIDRequest
*/
'business_registration_number'?: string;
/**
*
* @type {string}
* @memberof SmsUpdateSenderIDRequest
*/
'contact_email'?: string;
/**
*
* @type {string}
* @memberof SmsUpdateSenderIDRequest
*/
'contact_person'?: string;
/**
*
* @type {string}
* @memberof SmsUpdateSenderIDRequest
*/
'contact_phone'?: string;
/**
*
* @type {string}
* @memberof SmsUpdateSenderIDRequest
*/
'description'?: string;
}
/**
*
* @export
* @interface SmsUsageTracking
*/
export interface SmsUsageTracking {
/**
*
* @type {number}
* @memberof SmsUsageTracking
*/
'campaign_message_segments'?: number;
/**
*
* @type {number}
* @memberof SmsUsageTracking
*/
'campaign_messages_sent'?: number;
/**
*
* @type {string}
* @memberof SmsUsageTracking
*/
'created_at'?: string;
/**
*
* @type {number}
* @memberof SmsUsageTracking
*/
'credits_used'?: number;
/**
*
* @type {string}
* @memberof SmsUsageTracking
*/
'date'?: string;
/**
*
* @type {string}
* @memberof SmsUsageTracking
*/
'id'?: string;
/**
*
* @type {number}
* @memberof SmsUsageTracking
*/
'messages_failed'?: number;
/**
*
* @type {number}
* @memberof SmsUsageTracking
*/
'messages_sent'?: number;
/**
*
* @type {string}
* @memberof SmsUsageTracking
*/
'organization_id'?: string;
/**
*
* @type {number}
* @memberof SmsUsageTracking
*/
'pay_as_you_go_charges'?: number;
/**
*
* @type {number}
* @memberof SmsUsageTracking
*/
'segments_used'?: number;
/**
*
* @type {number}
* @memberof SmsUsageTracking
*/
'single_message_segments'?: number;
/**
*
* @type {number}
* @memberof SmsUsageTracking
*/
'single_messages_sent'?: number;
/**
*
* @type {number}
* @memberof SmsUsageTracking
*/
'unique_recipients'?: number;
/**
*
* @type {string}
* @memberof SmsUsageTracking
*/
'updated_at'?: string;
}
/**
*
* @export
* @enum {string}
*/
export declare const StatusOnboardingStatus: {
readonly OnboardingNotStarted: "not_started";
readonly OnboardingInProgress: "in_progress";
readonly OnboardingSubmitted: "submitted";
readonly OnboardingApproved: "approved";
readonly OnboardingRejected: "rejected";
};
export type StatusOnboardingStatus = typeof StatusOnboardingStatus[keyof typeof StatusOnboardingStatus];
/**
*
* @export
* @interface V1APIKeyListResponseDoc
*/
export interface V1APIKeyListResponseDoc {
/**
*
* @type {number}
* @memberof V1APIKeyListResponseDoc
*/
'count'?: number;
/**
*
* @type {Array<V1APIKeyResponse>}
* @memberof V1APIKeyListResponseDoc
*/
'items'?: Array<V1APIKeyResponse>;
/**
*
* @type {number}
* @memberof V1APIKeyListResponseDoc
*/
'limit'?: number;
/**
*
* @type {number}
* @memberof V1APIKeyListResponseDoc
*/
'offset'?: number;
}
/**
*
* @export
* @interface V1APIKeyResponse
*/
export interface V1APIKeyResponse {
/**
*
* @type {string}
* @memberof V1APIKeyResponse
*/
'created_at'?: string;
/**
*
* @type {string}
* @memberof V1APIKeyResponse
*/
'description'?: string;
/**
*
* @type {string}
* @memberof V1APIKeyResponse
*/
'id'?: string;
/**
*
* @type {boolean}
* @memberof V1APIKeyResponse
*/
'is_active'?: boolean;
/**
* Only returned on creation
* @type {string}
* @memberof V1APIKeyResponse
*/
'key'?: string;
/**
*
* @type {string}
* @memberof V1APIKeyResponse
*/
'key_prefix'?: string;
/**
*
* @type {string}
* @memberof V1APIKeyResponse
*/
'last_used_at'?: string;
/**
*
* @type {string}
* @memberof V1APIKeyResponse
*/
'mode'?: string;
/**
*
* @type {Array<string>}
* @memberof V1APIKeyResponse
*/
'scopes'?: Array<string>;
/**
*
* @type {string}
* @memberof V1APIKeyResponse
*/
'type'?: string;
}
/**
*
* @export
* @interface V1AddContactsParams
*/
export interface V1AddContactsParams {
/**
*
* @type {Array<string>}
* @memberof V1AddContactsParams
*/
'contact_ids': Array<string>;
}
/**
*
* @export
* @interface V1ApiKeysGet200Response
*/
export interface V1ApiKeysGet200Response {
/**
*
* @type {V1APIKeyListResponseDoc}
* @memberof V1ApiKeysGet200Response
*/
'data'?: V1APIKeyListResponseDoc;
/**
*
* @type {string}
* @memberof V1ApiKeysGet200Response
*/
'error'?: string;
}
/**
*
* @export
* @interface V1ApiKeysPost200Response
*/
export interface V1ApiKeysPost200Response {
/**
*
* @type {V1APIKeyResponse}
* @memberof V1ApiKeysPost200Response
*/
'data'?: V1APIKeyResponse;
/**
*
* @type {string}
* @memberof V1ApiKeysPost200Response
*/
'error'?: string;
}
/**
*
* @export
* @interface V1ApproveSenderIDRequest
*/
export interface V1ApproveSenderIDRequest {
/**
*
* @type {string}
* @memberof V1ApproveSenderIDRequest
*/
'approval_notes'?: string;
}
/**
*
* @export
* @interface V1AuthPaymentModeGet200Response
*/
export interface V1AuthPaymentModeGet200Response {
/**
*
* @type {V1PaymentModeResponse}
* @memberof V1AuthPaymentModeGet200Response
*/
'data'?: V1PaymentModeResponse;
/**
*
* @type {string}
* @memberof V1AuthPaymentModeGet200Response
*/
'error'?: string;
}
/**
*
* @export
* @interface V1CampaignActionResponse
*/
export interface V1CampaignActionResponse {
/**
*
* @type {string}
* @memberof V1CampaignActionResponse
*/
'message'?: string;
/**
*
* @type {string}
* @memberof V1CampaignActionResponse
*/
'status'?: string;
}
/**
*
* @export
* @interface V1CampaignMessagesResponse
*/
export interface V1CampaignMessagesResponse {
/**
*
* @type {number}
* @memberof V1CampaignMessagesResponse
*/
'limit'?: number;
/**
*
* @type {Array<SmsSMSCampaignMessage>}
* @memberof V1CampaignMessagesResponse
*/
'messages'?: Array<SmsSMSCampaignMessage>;
/*