import { ConfigInterface } from './config.interface'; import { CustomFieldInterface, CommonFieldInterface, FieldInterface, OrderInterface, DeclinedReasonInterface, PackageInterface, ProductInterface, AttachmentInterface, AgreementInterface, RetailSubscriptionGroupInterface, ProductActivationInterface, UserInterface, BusinessInterface } from './sales-orders.interface'; import { FieldMaskInterface } from './field-mask.interface'; import { LineItemInterface, DurationInterface } from './workflow.interface'; import { SubscriberInterface } from './notifications.interface'; import { ValidationErrorListInterface } from './validation-error-codes.interface'; import * as e from '../enums'; export interface ActivateProductsRequestInterface { orderId?: string; businessId?: string; customFields?: CustomFieldInterface[]; commonFields?: CommonFieldInterface[]; extraFields?: FieldInterface[]; } export interface ActivateProductsResponseInterface { order?: OrderInterface; } export interface ApproveCancellationRequestInterface { orderId?: string; businessId?: string; } export interface ApproveSalesOrderRequestInterface { orderId?: string; businessId?: string; } export interface ApproveSalesOrderResponseInterface { order?: OrderInterface; } export interface ArchiveReasonRequestInterface { id?: string; } export interface ArchiveSalesOrderRequestInterface { orderId?: string; businessId?: string; } export interface ArchiveSalesOrderResponseInterface { order?: OrderInterface; } export interface CanOrderBeWholesaleBilledRequestInterface { businessId?: string; orderId?: string; } export interface CanOrderBeWholesaleBilledResponseInterface { canOrderBeWholesaleBilled?: boolean; } export interface CancelOrderRequestInterface { orderId?: string; businessId?: string; notes?: string; } export interface ChargeOrderRequestInterface { orderId?: string; businessId?: string; } export interface ChargeOrderResponseInterface { order?: OrderInterface; } export interface CheckSalesOrderExistsRequestInterface { partnerId?: string; businessId?: string; productId?: string; productEditionId?: string; statuses?: e.Status[]; } export interface CheckSalesOrderExistsResponseInterface { exists?: boolean; } export interface ConvertToDraftRequestInterface { orderId?: string; businessId?: string; } export interface GetStatusCountsResponseCountsEntryInterface { key?: number; value?: number; } export interface CreateAndActivateOrderRequestInterface { order?: OrderInterface; useCustomerPrice?: boolean; } export interface CreateAndActivateOrderResponseInterface { orderId?: string; } export interface CreateArchivedOrderRequestInterface { order?: OrderInterface; } export interface CreateArchivedOrderResponseInterface { orderId?: string; } export interface CreateDraftSalesOrderRequestInterface { order?: OrderInterface; useCustomerPrice?: boolean; } export interface CreateDraftSalesOrderResponseInterface { orderId?: string; } export interface CreateForPartnerApprovalRequestInterface { order?: OrderInterface; } export interface CreateForPartnerApprovalResponseInterface { orderId?: string; } export interface CreateInvoiceRequestInterface { orderId?: string; businessId?: string; } export interface CreateInvoiceResponseInterface { invoiceId?: string; } export interface CreateLeasedToAutomationsSalesOrderRequestInterface { order?: OrderInterface; useCustomerPrice?: boolean; } export interface CreateLeasedToAutomationsSalesOrderResponseInterface { orderId?: string; } export interface CreateReasonRequestInterface { reason?: string; partnerId?: string; } export interface CreateReasonResponseInterface { declinedReason?: DeclinedReasonInterface; } export interface CreateSalesOrderRequestInterface { salespersonId?: string; partnerId?: string; businessId?: string; marketId?: string; opportunityIds?: string[]; requestedActivation?: Date; notes?: string; packages?: PackageInterface[]; customFields?: CustomFieldInterface[]; commonFields?: CommonFieldInterface[]; products?: ProductInterface[]; origin?: e.Origin; attachments?: AttachmentInterface[]; extraFields?: FieldInterface[]; lineItems?: LineItemInterface[]; contractDuration?: DurationInterface; customerNotes?: string; quoteId?: string; tags?: string[]; idempotencyKey?: string; useCustomerPrice?: boolean; orderIsSmbPayable?: boolean; enforceContractTerm?: boolean; customerAttachments?: AttachmentInterface[]; } export interface CreateSalesOrderResponseInterface { orderId?: string; } export interface CreateWithPaymentIntentRequestInterface { order?: OrderInterface; } export interface CreateWithPaymentIntentResponseInterface { orderId?: string; } export interface CustomerApproveSalesOrderRequestInterface { orderId?: string; businessId?: string; agreements?: AgreementInterface[]; paymentMethodToken?: string; } export interface CustomerApproveSalesOrderResponseInterface { order?: OrderInterface; } export interface CustomerCreateSalesOrderRequestInterface { order?: OrderInterface; } export interface CustomerCreateSalesOrderResponseInterface { orderId?: string; } export interface CustomerGetConfigurationRequestInterface { orderId?: string; businessId?: string; } export interface ListSalesOrderRequestDateRangeFilterInterface { beginRange?: Date; endRange?: Date; } export interface InitiateOrderExportRequestDateRangeFilterInterface { beginRange?: Date; endRange?: Date; } export interface ListCustomerSalesOrderRequestDateRangeFilterInterface { beginRange?: Date; endRange?: Date; } export interface ListOrdersRequestDateRangeFilterInterface { beginRange?: Date; endRange?: Date; } export interface DeclineCancellationRequestInterface { orderId?: string; businessId?: string; notes?: string; } export interface DeclineSalesOrderRequestInterface { orderId?: string; businessId?: string; declinedReason?: string; declinedReasonIds?: string[]; } export interface DeclineSalesOrderResponseInterface { order?: OrderInterface; } export interface DeleteConfigRequestInterface { partnerId?: string; marketId?: string; } export interface DeleteSalesOrderRequestInterface { orderId?: string; businessId?: string; } export interface DuplicateSalesOrderRequestInterface { orderId?: string; businessId?: string; } export interface DuplicateSalesOrderResponseInterface { orderId?: string; } export interface GetStatusCountsRequestFiltersInterface { marketIds?: string[]; salespersonId?: string; } export interface ListOrdersRequestFiltersInterface { resellerIds?: string[]; activationStatuses?: e.ActivationStatus[]; fulfillmentStatuses?: string[]; appIds?: string[]; created?: ListOrdersRequestDateRangeFilterInterface; searchTerm?: string; excludeChildren?: boolean; excludeAppIds?: boolean; excludeResellerIds?: boolean; } export interface ListCustomerSalesOrderRequestFiltersInterface { statuses?: e.Status[]; created?: ListCustomerSalesOrderRequestDateRangeFilterInterface; requestedActivation?: ListCustomerSalesOrderRequestDateRangeFilterInterface; expiryDate?: ListCustomerSalesOrderRequestDateRangeFilterInterface; businessId?: string; } export interface ListReasonsRequestFiltersInterface { includeArchived?: boolean; } export interface ListTagsRequestFiltersInterface { marketIds?: string[]; } export interface ListSalesOrderRequestFiltersInterface { marketId?: string; salespersonId?: string; created?: ListSalesOrderRequestDateRangeFilterInterface; requestedActivation?: ListSalesOrderRequestDateRangeFilterInterface; statuses?: e.Status[]; businessId?: string; productId?: string; productEditionId?: string; marketIds?: string[]; tags?: string[]; untagged?: boolean; packageId?: string; expiryDate?: ListSalesOrderRequestDateRangeFilterInterface; salespersonIds?: string[]; orderId?: string; orderIds?: string[]; includeArchivedOrders?: boolean; } export interface InitiateOrderExportRequestFiltersInterface { marketIds?: string[]; salespersonIds?: string[]; salesTeamIds?: string[]; created?: InitiateOrderExportRequestDateRangeFilterInterface; requestedActivation?: InitiateOrderExportRequestDateRangeFilterInterface; expiryDate?: InitiateOrderExportRequestDateRangeFilterInterface; statuses?: e.Status[]; tags?: string[]; untagged?: boolean; packageIds?: string[]; businessIds?: string[]; orderId?: string; } export interface FulfillmentStatusInterface { status?: string; dueDate?: Date; assignee?: string; projectId?: string; projectName?: string; } export interface GenerateRetailSubscriptionGroupForOrderRequestInterface { orderId?: string; businessId?: string; retailSubscriptionGroup?: RetailSubscriptionGroupInterface; } export interface GenerateRetailSubscriptionGroupForOrderResponseInterface { retailSubscriptionGroupId?: string; } export interface GetConfigRequestInterface { partnerId?: string; marketId?: string; } export interface GetConfigResponseInterface { config?: ConfigInterface; } export interface GetMultiSalesOrderRequestInterface { orderIds?: string[]; } export interface GetMultiSalesOrderResponseInterface { orders?: OrderInterface[]; } export interface GetReasonRequestInterface { id?: string; } export interface GetReasonResponseInterface { declinedReason?: DeclinedReasonInterface; } export interface GetSalesOrderByIdempotencyKeyRequestInterface { idempotencyKey?: string; } export interface GetSalesOrderRequestInterface { orderId?: string; businessId?: string; projectionFilter?: SalesOrderProjectionFilterInterface; } export interface GetSalesOrderResponseInterface { order?: OrderInterface; } export interface GetSalesOrderWithCalculatedTaxesRequestInterface { orderId?: string; businessId?: string; } export interface GetSalesOrderWithCalculatedTaxesResponseInterface { order?: OrderInterface; } export interface GetStatusCountsRequestInterface { partnerId?: string; filters?: GetStatusCountsRequestFiltersInterface; } export interface GetStatusCountsResponseInterface { counts?: { [key: string]: number; }; } export interface GetSubscribedLocationsRequestInterface { orderId?: string; businessId?: string; } export interface GetSubscribedLocationsResponseInterface { locations?: e.SubscriptionLocation[]; } export interface GetSubscribersRequestInterface { orderId?: string; businessId?: string; } export interface GetSubscribersResponseInterface { subscribers?: SubscriberInterface[]; } export interface GetUsersRequestInterface { orderId?: string; businessId?: string; } export interface GetUsersResponseInterface { users?: { [key: string]: UserInterface; }; } export interface IgnoreAllProductActivationErrorsRequestInterface { orderId?: string; businessId?: string; } export interface IgnoreProductActivationErrorRequestInterface { orderId?: string; businessId?: string; productActivationUniqueId?: string; } export interface InitiateOrderExportRequestInterface { partnerId?: string; filters?: InitiateOrderExportRequestFiltersInterface; sortOption?: InitiateOrderExportRequestSortOptionInterface; tryAgainUrl?: string; selectedDataFormat?: e.InitiateOrderExportRequestDataFormatOption; } export interface InitiateOrderExportResponseInterface { exportId?: string; } export interface LeaseDataInterface { actionType?: string; declinedReason?: string; declinedReasonIds?: string[]; } export interface LeaseSalesOrderToAutomationsRequestInterface { orderId?: string; businessId?: string; customFields?: CustomFieldInterface[]; commonFields?: CommonFieldInterface[]; extraFields?: FieldInterface[]; leaseData?: LeaseDataInterface; } export interface LeaseSalesOrderToAutomationsResponseInterface { order?: OrderInterface; } export interface ValidateLineItemsResponseLineItemErrorsEntryInterface { key?: string; value?: ValidationErrorListInterface; } export interface ListCustomerSalesOrderRequestInterface { partnerId?: string; filters?: ListCustomerSalesOrderRequestFiltersInterface; sortOption?: ListCustomerSalesOrderRequestSortOptionInterface; cursor?: string; pageSize?: number; } export interface ListOrdersRequestInterface { partnerId?: string; cursor?: string; filters?: ListOrdersRequestFiltersInterface; } export interface ListOrdersResponseInterface { orders?: VendorOrderInterface[]; nextCursor?: string; hasMore?: boolean; totalResults?: number; } export interface ListReasonsRequestInterface { partnerId?: string; filters?: ListReasonsRequestFiltersInterface; } export interface ListReasonsResponseInterface { declinedReasons?: DeclinedReasonInterface[]; } export interface ListSalesOrderRequestInterface { partnerId?: string; filters?: ListSalesOrderRequestFiltersInterface; sortOption?: ListSalesOrderRequestSortOptionInterface; cursor?: string; pageSize?: number; } export interface ListSalesOrderResponseInterface { orders?: OrderInterface[]; nextCursor?: string; hasMore?: boolean; totalResults?: number; } export interface ListTagsRequestInterface { partnerId?: string; filters?: ListTagsRequestFiltersInterface; } export interface ListTagsResponseInterface { tags?: string[]; } export interface PreviewOrderActivationsRequestInterface { orderId?: string; businessId?: string; } export interface PreviewOrderActivationsResponseInterface { productActivations?: ProductActivationInterface[]; } export interface PricingInterface { amount?: number; setupFee?: number; currencyCode?: string; frequency?: string; } export interface RequestCancellationRequestInterface { orderId?: string; businessId?: string; notes?: string; } export interface SalesOrderProjectionFilterInterface { includeUserInfoInStatusHistory?: boolean; includeCustomerRecipient?: boolean; } export interface ScheduleActivationRequestInterface { orderId?: string; businessId?: string; customFields?: CustomFieldInterface[]; commonFields?: CommonFieldInterface[]; extraFields?: FieldInterface[]; } export interface SendExistingOrderToCustomerForApprovalRequestInterface { orderId?: string; businessId?: string; userId?: string; offerExpiry?: Date; orderIsSmbPayable?: boolean; } export interface SendForCustomerApprovalRequestInterface { order?: OrderInterface; userId?: string; offerExpiry?: Date; useCustomerPrice?: boolean; } export interface SendForCustomerApprovalResponseInterface { orderId?: string; } export interface ListCustomerSalesOrderRequestSortOptionInterface { direction?: e.ListCustomerSalesOrderRequestSortDirection; field?: e.ListCustomerSalesOrderRequestSortField; } export interface InitiateOrderExportRequestSortOptionInterface { direction?: e.InitiateOrderExportRequestSortDirection; field?: e.InitiateOrderExportRequestSortField; } export interface ListSalesOrderRequestSortOptionInterface { direction?: e.ListSalesOrderRequestSortDirection; field?: e.ListSalesOrderRequestSortField; } export interface SubmitDraftForApprovalRequestInterface { orderId?: string; businessId?: string; userId?: string; customFields?: CustomFieldInterface[]; commonFields?: CommonFieldInterface[]; extraFields?: FieldInterface[]; offerExpiry?: Date; } export interface SubmitDraftForApprovalResponseInterface { orderId?: string; } export interface SubmitDraftRequestInterface { orderId?: string; businessId?: string; customFields?: CustomFieldInterface[]; commonFields?: CommonFieldInterface[]; extraFields?: FieldInterface[]; } export interface SubmitDraftResponseInterface { orderId?: string; } export interface SubscribeRequestInterface { orderId?: string; businessId?: string; location?: e.SubscriptionLocation; } export interface UnsubscribeRequestInterface { orderId?: string; businessId?: string; location?: e.SubscriptionLocation; } export interface UpdateAnswersRequestInterface { orderId?: string; businessId?: string; customFields?: CustomFieldInterface[]; commonFields?: CommonFieldInterface[]; extraFields?: FieldInterface[]; } export interface UpdateAnswersResponseInterface { order?: OrderInterface; } export interface UpdateAttachmentsRequestInterface { orderId?: string; businessId?: string; attachments?: AttachmentInterface[]; } export interface UpdateConfigRequestInterface { config?: ConfigInterface; fieldMask?: FieldMaskInterface; } export interface UpdateContractDurationRequestInterface { orderId?: string; businessId?: string; contractDuration?: DurationInterface; } export interface UpdateCurrentRevenueRequestInterface { orderId?: string; businessId?: string; lineItems?: LineItemInterface[]; } export interface UpdateCustomerAttachmentsRequestInterface { orderId?: string; businessId?: string; attachments?: AttachmentInterface[]; } export interface UpdateCustomerNotesRequestInterface { orderId?: string; businessId?: string; customerNotes?: string; } export interface UpdateCustomerRecipientUserIdRequestInterface { orderId?: string; businessId?: string; customerRecipientUserId?: string; } export interface UpdateEnforceContractTermRequestInterface { orderId?: string; businessId?: string; enforceContractTerm?: boolean; } export interface UpdateLineItemsRequestInterface { orderId?: string; businessId?: string; lineItems?: LineItemInterface[]; } export interface UpdateNotesRequestInterface { orderId?: string; businessId?: string; notes?: string; } export interface UpdatePaymentMethodTokenRequestInterface { orderId?: string; businessId?: string; paymentMethodToken?: string; } export interface UpdateReasonRequestInterface { id?: string; reason?: string; } export interface UpdateReasonResponseInterface { declinedReason?: DeclinedReasonInterface; } export interface UpdateRequestedActivationRequestInterface { orderId?: string; businessId?: string; requestedActivation?: Date; } export interface UpdateRetailSubscriptionGroupForOrderRequestInterface { orderId?: string; businessId?: string; retailSubscriptionGroupId?: string; retailSubscriptionGroup?: RetailSubscriptionGroupInterface; } export interface UpdateSalesOrderMarketRequestInterface { orderId?: string; businessId?: string; marketId?: string; } export interface UpdateSalespersonRequestInterface { orderId?: string; businessId?: string; salespersonId?: string; } export interface UpdateSalespersonResponseInterface { order?: OrderInterface; } export interface UpdateTagsRequestInterface { orderId?: string; businessId?: string; tags?: string[]; } export interface UpdateTagsResponseInterface { order?: OrderInterface; } export interface GetUsersResponseUsersEntryInterface { key?: string; value?: UserInterface; } export interface ValidateLineItemsRequestInterface { businessId?: string; orderId?: string; } export interface ValidateLineItemsResponseInterface { errorCodes?: e.ValidationErrorCodes[]; lineItemErrors?: { [key: string]: ValidationErrorListInterface; }; } export interface VendorOrderInterface { orderId?: string; orderFormSubmissionId?: string; resellerId?: string; resellerName?: string; businessId?: string; appId?: string; appName?: string; business?: BusinessInterface; created?: Date; pricing?: PricingInterface; activationStatus?: e.ActivationStatus; fulfillmentStatus?: FulfillmentStatusInterface; rejectedReason?: string; }