abowire
Version:
This is the official **Abowire Javascript SDK**, which makes it easy to connect to the Abowire **GraphQL API** and includes all the required dependencies you need.
362 lines (361 loc) • 19.1 kB
TypeScript
import { InviteMemberInput, ListMemberInvitesQueryVariables, ListMembersQueryVariables } from '../../gen/graphql';
import { AbowireGraphQLClient } from '../../graphql/graphql-client';
export declare class MemberApi {
private graphQL;
constructor(graphQL: AbowireGraphQLClient);
invite(input: InviteMemberInput): Promise<{
__typename?: "MemberInvite" | undefined;
email: string;
role: import("../../gen/graphql").MemberRole;
}>;
remove(id: string): Promise<{
__typename?: "Member" | undefined;
name: string;
role: import("../../gen/graphql").MemberRole;
}>;
list(input?: Partial<ListMembersQueryVariables>): Promise<{
__typename?: "MemberList" | undefined;
count: number;
total: number;
cursor?: string | null | undefined;
items: {
__typename?: "Member" | undefined;
id: string;
name: string;
role: import("../../gen/graphql").MemberRole;
email?: string | null | undefined;
account: {
__typename?: "Account" | undefined;
id: string;
name: string;
isProduction?: boolean | null | undefined;
metadata?: any;
createdAt?: any;
updatedAt?: any;
billing?: {
__typename?: "Billing" | undefined;
companyName?: string | null | undefined;
address: string;
address2?: string | null | undefined;
street?: string | null | undefined;
streetNumber?: string | null | undefined;
postalCode: string;
city: string;
countryCode: string;
invoiceFormat?: import("../../gen/graphql").InvoiceFormat | null | undefined;
metadata?: any;
taxIds?: {
__typename?: "TaxId" | undefined;
type: import("../../gen/graphql").TaxIdType;
countryCode?: string | null | undefined;
value: string;
}[] | null | undefined;
contactPerson?: {
__typename?: "Person" | undefined;
firstName: string;
lastName: string;
email: string;
phoneNumber?: string | null | undefined;
} | null | undefined;
} | null | undefined;
settings: {
__typename?: "AccountSettings" | undefined;
domain: {
__typename?: "AccountDomainSettings" | undefined;
name: string;
config?: {
__typename?: "AccountDomainConfigSettings" | undefined;
hostname: string;
isVerified: boolean;
verificationRecord: {
__typename?: "AccountDomainConfigVerificationSettings" | undefined;
name: string;
value: string;
};
} | null | undefined;
};
analytics?: {
__typename?: "AccountAnalyticsSettings" | undefined;
dashboardId?: string | null | undefined;
isAvailableInGlobalDashboard?: boolean | null | undefined;
} | null | undefined;
theme?: {
__typename?: "AccountThemeSettings" | undefined;
light?: {
__typename?: "AccountTheme" | undefined;
logoUrl?: string | null | undefined;
} | null | undefined;
dark?: {
__typename?: "AccountTheme" | undefined;
logoUrl?: string | null | undefined;
} | null | undefined;
} | null | undefined;
billing: {
__typename?: "AccountBillingSettings" | undefined;
taxSchemes?: string[] | null | undefined;
logoUrl?: string | null | undefined;
footerText?: string | null | undefined;
customTaxRate?: {
__typename?: "CustomTaxRate" | undefined;
description: string;
rate: number;
code: string;
} | null | undefined;
numberingFormat?: {
__typename?: "AccountBillingSettingsNumberingFormat" | undefined;
invoice?: string | null | undefined;
creditNote?: string | null | undefined;
} | null | undefined;
invoiceFormat?: {
__typename?: "AccountBillingSettingsInvoiceFormat" | undefined;
default: import("../../gen/graphql").InvoiceFormat;
rules?: {
__typename?: "AccountBillingSettingsInvoiceFormatCountryRule" | undefined;
countryCode: string;
format: import("../../gen/graphql").InvoiceFormat;
}[] | null | undefined;
} | null | undefined;
};
payments?: {
__typename?: "AccountPaymentSettings" | undefined;
paymentMethods?: {
__typename?: "AccountPaymentMethodSettings" | undefined;
type: import("../../gen/graphql").PaymentMethodType;
providerName: import("../../gen/graphql").PaymentProviderName;
isActive: boolean;
}[] | null | undefined;
providers?: {
__typename?: "PaymentProvider" | undefined;
name: import("../../gen/graphql").PaymentProviderName;
config?: any;
}[] | null | undefined;
} | null | undefined;
metadata?: {
__typename?: "AccountMetadataSettings" | undefined;
customer?: {
__typename?: "AccountMetadataField" | undefined;
name: string;
type: string;
description: string;
label?: string | null | undefined;
required: boolean;
format?: string | null | undefined;
default?: string | null | undefined;
isPersonalInformation?: boolean | null | undefined;
displayInInvoices?: boolean | null | undefined;
displayInCheckoutStep?: string | null | undefined;
options?: {
__typename?: "AccountMetadataOptionField" | undefined;
label: string;
value: string;
}[] | null | undefined;
}[] | null | undefined;
invoice?: {
__typename?: "AccountMetadataField" | undefined;
name: string;
type: string;
description: string;
label?: string | null | undefined;
required: boolean;
format?: string | null | undefined;
default?: string | null | undefined;
isPersonalInformation?: boolean | null | undefined;
displayInInvoices?: boolean | null | undefined;
displayInCheckoutStep?: string | null | undefined;
options?: {
__typename?: "AccountMetadataOptionField" | undefined;
label: string;
value: string;
}[] | null | undefined;
}[] | null | undefined;
creditNote?: {
__typename?: "AccountMetadataField" | undefined;
name: string;
type: string;
description: string;
label?: string | null | undefined;
required: boolean;
format?: string | null | undefined;
default?: string | null | undefined;
isPersonalInformation?: boolean | null | undefined;
displayInInvoices?: boolean | null | undefined;
displayInCheckoutStep?: string | null | undefined;
options?: {
__typename?: "AccountMetadataOptionField" | undefined;
label: string;
value: string;
}[] | null | undefined;
}[] | null | undefined;
licenseUser?: {
__typename?: "AccountMetadataField" | undefined;
name: string;
type: string;
description: string;
label?: string | null | undefined;
required: boolean;
format?: string | null | undefined;
default?: string | null | undefined;
isPersonalInformation?: boolean | null | undefined;
displayInInvoices?: boolean | null | undefined;
displayInCheckoutStep?: string | null | undefined;
options?: {
__typename?: "AccountMetadataOptionField" | undefined;
label: string;
value: string;
}[] | null | undefined;
}[] | null | undefined;
license?: {
__typename?: "AccountMetadataField" | undefined;
name: string;
type: string;
description: string;
label?: string | null | undefined;
required: boolean;
format?: string | null | undefined;
default?: string | null | undefined;
isPersonalInformation?: boolean | null | undefined;
displayInInvoices?: boolean | null | undefined;
displayInCheckoutStep?: string | null | undefined;
options?: {
__typename?: "AccountMetadataOptionField" | undefined;
label: string;
value: string;
}[] | null | undefined;
}[] | null | undefined;
product?: {
__typename?: "AccountMetadataField" | undefined;
name: string;
type: string;
description: string;
label?: string | null | undefined;
required: boolean;
format?: string | null | undefined;
default?: string | null | undefined;
isPersonalInformation?: boolean | null | undefined;
displayInInvoices?: boolean | null | undefined;
displayInCheckoutStep?: string | null | undefined;
options?: {
__typename?: "AccountMetadataOptionField" | undefined;
label: string;
value: string;
}[] | null | undefined;
}[] | null | undefined;
subscription?: {
__typename?: "AccountMetadataField" | undefined;
name: string;
type: string;
description: string;
label?: string | null | undefined;
required: boolean;
format?: string | null | undefined;
default?: string | null | undefined;
isPersonalInformation?: boolean | null | undefined;
displayInInvoices?: boolean | null | undefined;
displayInCheckoutStep?: string | null | undefined;
options?: {
__typename?: "AccountMetadataOptionField" | undefined;
label: string;
value: string;
}[] | null | undefined;
}[] | null | undefined;
transaction?: {
__typename?: "AccountMetadataField" | undefined;
name: string;
type: string;
description: string;
label?: string | null | undefined;
required: boolean;
format?: string | null | undefined;
default?: string | null | undefined;
isPersonalInformation?: boolean | null | undefined;
displayInInvoices?: boolean | null | undefined;
displayInCheckoutStep?: string | null | undefined;
options?: {
__typename?: "AccountMetadataOptionField" | undefined;
label: string;
value: string;
}[] | null | undefined;
}[] | null | undefined;
billingProfile?: {
__typename?: "AccountMetadataField" | undefined;
name: string;
type: string;
description: string;
label?: string | null | undefined;
required: boolean;
format?: string | null | undefined;
default?: string | null | undefined;
isPersonalInformation?: boolean | null | undefined;
displayInInvoices?: boolean | null | undefined;
displayInCheckoutStep?: string | null | undefined;
options?: {
__typename?: "AccountMetadataOptionField" | undefined;
label: string;
value: string;
}[] | null | undefined;
}[] | null | undefined;
person?: {
__typename?: "AccountMetadataField" | undefined;
name: string;
type: string;
description: string;
label?: string | null | undefined;
required: boolean;
format?: string | null | undefined;
default?: string | null | undefined;
isPersonalInformation?: boolean | null | undefined;
displayInInvoices?: boolean | null | undefined;
displayInCheckoutStep?: string | null | undefined;
options?: {
__typename?: "AccountMetadataOptionField" | undefined;
label: string;
value: string;
}[] | null | undefined;
}[] | null | undefined;
} | null | undefined;
capabilities?: {
__typename?: "ProductCapabilitySettings" | undefined;
name: string;
type: string;
description: string;
}[] | null | undefined;
};
capabilities: {
__typename?: "AccountCapabilities" | undefined;
canManageLicenses?: boolean | null | undefined;
canBill?: boolean | null | undefined;
canCreateApps?: boolean | null | undefined;
hasCustomerPortal?: boolean | null | undefined;
hasCheckout?: boolean | null | undefined;
canCreateCustomDomains?: boolean | null | undefined;
canInviteMembers?: boolean | null | undefined;
canCustomizeFields?: boolean | null | undefined;
hasCancellationNotice?: boolean | null | undefined;
hasAnalytics?: boolean | null | undefined;
hasIntegrations?: boolean | null | undefined;
};
};
customer?: {
__typename?: "Customer" | undefined;
id: string;
name: string;
} | null | undefined;
}[];
}>;
listInvites(input?: Partial<ListMemberInvitesQueryVariables>): Promise<{
__typename?: "MemberInviteList" | undefined;
count: number;
total: number;
cursor?: string | null | undefined;
items: {
__typename?: "MemberInvite" | undefined;
email: string;
role: import("../../gen/graphql").MemberRole;
customer?: {
__typename?: "Customer" | undefined;
id: string;
name: string;
} | null | undefined;
}[];
}>;
}