getAltCurrencies
getAltCurrencies: {
parameters: {
query: { locationRef: string; nextPageToken?: string; limit?: number };
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
altCurrencies?: {
createDate: string;
currencyCode: string;
exchangeRate: number;
id: string;
locationRef: string;
provider?: "nbu" | "bcra" | "nbg" | "bcch" | "ecb";
}[];
nextPageToken?: string;
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createAltCurrency
createAltCurrency: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
altCurrency: { currencyCode: string; locationRef: string } & (
| { provider: "nbu"
| "bcra"
| "nbg"
| "bcch"
| "ecb" }
| { exchangeRate: number }
);
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
altCurrency?: {
createDate: string;
currencyCode: string;
exchangeRate: number;
id: string;
locationRef: string;
provider?: "nbu" | "bcra" | "nbg" | "bcch" | "ecb";
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deleteAltCurrency
deleteAltCurrency: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
updateAltCurrency
updateAltCurrency: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
altCurrency: Record<string, never> & (
| { provider: "nbu"
| "bcra"
| "nbg"
| "bcch"
| "ecb" }
| { exchangeRate: number }
);
};
};
};
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getBenefitCategories
getBenefitCategories: {
parameters: {
query: { locationRef: string };
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
categories: {
createDate: string;
id: string;
locationRef: string;
networkRef: string;
title: string;
}[];
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createBenefitCategory
createBenefitCategory: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
category: { locationRef: string; title: string };
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
category?: {
createDate: string;
id: string;
locationRef: string;
networkRef: string;
title: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getBenefitCategory
getBenefitCategory: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { categoryId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
category: {
createDate: string;
id: string;
locationRef: string;
networkRef: string;
title: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
updateBenefitCategory
updateBenefitCategory: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { categoryId: string };
cookie?: undefined;
};
requestBody: {
content: { "application/json": { category: { title: string } } };
};
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
category?: {
createDate: string;
id: string;
locationRef: string;
networkRef: string;
title: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deleteBenefitCategory
deleteBenefitCategory: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { categoryId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getBenefits
getBenefits: {
parameters: {
query?: {
categoryRef?: string;
featured?: boolean;
limit?: number;
locationRef?: string;
nextPageToken?: string;
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
benefits: {
application: {
allowance: "once" | "unlimited";
buttonLabel: "apply" | "buy" | "contact" | "get" | "learnMore";
confirmationEmail: { enabled: boolean; template: string };
enabled: boolean;
};
categoryRef: string;
createDate: string;
description: string;
featured: boolean;
id: string;
locale: string;
locationRef: string;
media: { key: string; url: string }[];
networkRef: string;
subtitle: string;
title: string;
updateDate?: string;
visibility:
| "public"
| "admins"
| "exclusiveMembers"
| "members"
| "networkMembers";
}[];
nextPageToken?: string;
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createBenefit
createBenefit: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
benefit: {
application?: {
allowance?: "once"
| "unlimited";
buttonLabel?: "apply" | "buy" | "contact" | "get" | "learnMore";
confirmationEmail: { enabled?: boolean; template?: string };
enabled?: boolean;
};
categoryRef: string;
description?: string;
featured?: boolean;
locationRef: string;
media?: { key: string }[];
subtitle?: string;
title: string;
visibility?:
| "public"
| "admins"
| "exclusiveMembers"
| "members"
| "networkMembers";
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
application: {
allowance: "once" | "unlimited";
buttonLabel: "apply" | "buy" | "contact" | "get" | "learnMore";
confirmationEmail: { enabled: boolean; template: string };
enabled: boolean;
};
categoryRef: string;
createDate: string;
description: string;
featured: boolean;
id: string;
locale: string;
locationRef: string;
media: { key: string; url: string }[];
networkRef: string;
subtitle: string;
title: string;
updateDate?: string;
visibility:
| "public"
| "admins"
| "exclusiveMembers"
| "members"
| "networkMembers";
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getBenefit
getBenefit: {
parameters: {
query?: undefined;
header?: undefined;
path: { benefitId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
benefit: {
application: {
allowance: "once" | "unlimited";
buttonLabel: "apply" | "buy" | "contact" | "get" | "learnMore";
confirmationEmail: { enabled: boolean; template: string };
enabled: boolean;
};
categoryRef: string;
createDate: string;
description: string;
featured: boolean;
id: string;
locale: string;
locationRef: string;
media: { key: string; url: string }[];
networkRef: string;
subtitle: string;
title: string;
updateDate?: string;
visibility:
| "public"
| "admins"
| "exclusiveMembers"
| "members"
| "networkMembers";
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
updateBenefit
updateBenefit: {
parameters: {
query?: undefined;
header?: undefined;
path: { benefitId: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
benefit: {
application?: {
allowance?: "once"
| "unlimited";
buttonLabel?: "apply" | "buy" | "contact" | "get" | "learnMore";
confirmationEmail: { enabled?: boolean; template?: string };
enabled?: boolean;
};
categoryRef: string;
description?: string;
featured?: boolean;
media?: { key: string }[];
subtitle?: string;
title: string;
visibility?:
| "public"
| "admins"
| "exclusiveMembers"
| "members"
| "networkMembers";
};
};
};
};
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
benefit?: {
application: {
allowance: "once" | "unlimited";
buttonLabel: "apply" | "buy" | "contact" | "get" | "learnMore";
confirmationEmail: { enabled: boolean; template: string };
enabled: boolean;
};
categoryRef: string;
createDate: string;
description: string;
featured: boolean;
id: string;
locale: string;
locationRef: string;
media: { key: string; url: string }[];
networkRef: string;
subtitle: string;
title: string;
updateDate?: string;
visibility:
| "public"
| "admins"
| "exclusiveMembers"
| "members"
| "networkMembers";
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deleteBenefit
deleteBenefit: {
parameters: {
query?: undefined;
header?: undefined;
path: { benefitId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getBenefitApplications
getBenefitApplications: {
parameters: {
query?: {
benefitRef?: string;
categoryRef?: string;
"createDate[gte]"?: string;
"createDate[lte]"?: string;
customerRef?: string;
limit?: number;
locationRef?: string;
nextPageToken?: string;
userRef?: string;
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
applications: {
benefit: {
description?: string;
id: string;
mediaUrl?: string | null;
subtitle?: string;
title: string;
};
comment?: string;
createDate: string;
id: string;
locationRef: string;
membershipRef?: string;
number: number;
user: {
about?: string
| null;
blocked: boolean;
createDate: string;
deleteDate?: string;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
restricted: boolean;
surname?: string | null;
};
}[];
nextPageToken?: string;
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
applyBenefit
applyBenefit: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
application: { benefitId: string; comment?: string };
};
};
};
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
application?: {
benefit: {
description?: string;
id: string;
mediaUrl?: string | null;
subtitle?: string;
title: string;
};
comment?: string;
createDate: string;
id: string;
locationRef: string;
membershipRef?: string;
number: number;
user: {
about?: string
| null;
blocked: boolean;
createDate: string;
deleteDate?: string;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
restricted: boolean;
surname?: string | null;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getBenefitApplication
getBenefitApplication: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { benefitApplicationId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
application: {
benefit: {
description?: string;
id: string;
mediaUrl?: string | null;
subtitle?: string;
title: string;
};
comment?: string;
createDate: string;
id: string;
locationRef: string;
membershipRef?: string;
number: number;
user: {
about?: string
| null;
blocked: boolean;
createDate: string;
deleteDate?: string;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
restricted: boolean;
surname?: string | null;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getInvoices
getInvoices: {
parameters: {
query?: {
companyRef?: string;
"createDate[gte]"?: string;
"createDate[lte]"?: string;
customerRef?: string;
"issueDate[gte]"?: string;
"issueDate[lte]"?: string;
limit?: number;
locationRef?: string;
membershipRef?: string;
nextPageToken?: string;
q?: string;
status?: string;
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
invoices: {
amount?: number;
amountDue: number;
amountPaid: number;
amountRemaining: number;
appliedBalance: number;
autoChargeFailed?: boolean;
autoCreateDate?: string;
baseAmounts: {
amountDue: number;
appliedBalance: number;
currencyCode: string;
postPaymentCreditNotesAmount: number;
prePaymentCreditNotesAmount: number;
subtotalAmount: number;
subtotalExcludingTaxAmount: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
totalAmount: number;
totalExcludingTaxAmount: number;
};
company?: unknown;
companyRef?: string;
createDate: string;
currencyCode: string;
customer: {
id: string;
logo?: { key: string; url: string };
title?: string;
type: "company" | "user";
user?: {
about?: (...) | (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
customerAddress?: {
city: string;
countryCode: string
| null;
line1: string;
line2: string;
postalCode: string;
state: string;
};
customerName?: string;
customerTaxId?: string;
deleteDate?: string;
dueDate?: string;
locationAddress?: {
city: string;
countryCode: string
| null;
line1: string;
line2: string;
postalCode: string;
state: string;
};
locationName?: string;
locationTaxId?: string;
dueDays?: number;
dueType?: "date"
| "days"
| "default";
id?: string;
internalNote?: string;
issueDate?: string;
items?: unknown[];
itemsCount: number;
locationRef: string;
membershipRef?: string;
memo?: string;
netAmount?: number;
number?: string;
paymentMethod?: { cardMask?: string; label?: string; mask?: string };
payments: {
createDate: string;
dispute?: { createDate: ... };
method: {
external?: (...) | (...);
paymentGateway?: (...) | (...);
type: (...) | (...);
};
price: {
money: { currencyCode: ...; grossAmount: ... };
type: "money";
};
refundable: boolean;
refunds?: { money?: ...; type: ... };
status:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
surcharge?: { money: ...; type: ... };
transactionRef: string;
}[];
pdfUrl?: string;
postPaymentCreation: boolean;
postPaymentCreditAmount?: number;
postPaymentCreditNotesAmount: number;
prePaymentCreditAmount?: number;
prePaymentCreditNotesAmount: number;
receiptPdfUrl?: string;
startingBalance?: number;
status: "draft"
| "issued"
| "paid"
| "voided";
subscriptionRef?: string;
subtotalAmount: number;
subtotalExcludingTaxAmount: number;
taxAmount?: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
timezoneId: string;
title: string;
totalAmount: number;
totalExcludingTaxAmount: number;
transaction?: {
amount: number;
createDate: string;
id: string;
paymentMethod?: { label?: ...; type: ... };
refund?: { amount: ...; createDate: ... };
refunds?: (...)[];
status:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
};
user?: unknown;
voidDate?: string;
}[];
nextPageToken?: string;
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createInvoice
createInvoice: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
includeUpcomingItems?: boolean;
invoice: {
companyRef?: string;
dueDate?: string;
dueDays?: number;
dueType?: "date"
| "days"
| "default";
internalNote?: string;
membershipRef?: string;
subscriptionRef?: string;
};
items?: {
companyRef?: string;
description?: string;
discounts?: { couponRef?: (...)
| (...)
| (...) }[];
invoiceRef?: string;
membershipRef?: string;
product?: { optionRef?: string; title?: string };
quantity: number;
subscriptionRef?: string;
tax?: { rate?: number };
type?: "custom";
unitAmount: number;
}[];
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
invoice?: {
amount?: number;
amountDue: number;
amountPaid: number;
amountRemaining: number;
appliedBalance: number;
autoChargeFailed?: boolean;
autoCreateDate?: string;
baseAmounts: {
amountDue: number;
appliedBalance: number;
currencyCode: string;
postPaymentCreditNotesAmount: number;
prePaymentCreditNotesAmount: number;
subtotalAmount: number;
subtotalExcludingTaxAmount: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
totalAmount: number;
totalExcludingTaxAmount: number;
};
company?: unknown;
companyRef?: string;
createDate: string;
currencyCode: string;
customer: {
id: string;
logo?: { key: string; url: string };
title?: string;
type: "company" | "user";
user?: {
about?: (...) | (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
customerAddress?: {
city: string;
countryCode: string
| null;
line1: string;
line2: string;
postalCode: string;
state: string;
};
customerName?: string;
customerTaxId?: string;
deleteDate?: string;
dueDate?: string;
locationAddress?: {
city: string;
countryCode: string
| null;
line1: string;
line2: string;
postalCode: string;
state: string;
};
locationName?: string;
locationTaxId?: string;
dueDays?: number;
dueType?: "date"
| "days"
| "default";
id?: string;
internalNote?: string;
issueDate?: string;
items?: unknown[];
itemsCount: number;
locationRef: string;
membershipRef?: string;
memo?: string;
netAmount?: number;
number?: string;
paymentMethod?: { cardMask?: string; label?: string; mask?: string };
payments: {
createDate: string;
dispute?: { createDate: ... };
method: {
external?: (...) | (...);
paymentGateway?: (...) | (...);
type: (...) | (...);
};
price: {
money: { currencyCode: ...; grossAmount: ... };
type: "money";
};
refundable: boolean;
refunds?: { money?: ...; type: ... };
status:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
surcharge?: { money: ...; type: ... };
transactionRef: string;
}[];
pdfUrl?: string;
postPaymentCreation: boolean;
postPaymentCreditAmount?: number;
postPaymentCreditNotesAmount: number;
prePaymentCreditAmount?: number;
prePaymentCreditNotesAmount: number;
receiptPdfUrl?: string;
startingBalance?: number;
status: "draft"
| "issued"
| "paid"
| "voided";
subscriptionRef?: string;
subtotalAmount: number;
subtotalExcludingTaxAmount: number;
taxAmount?: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
timezoneId: string;
title: string;
totalAmount: number;
totalExcludingTaxAmount: number;
transaction?: {
amount: number;
createDate: string;
id: string;
paymentMethod?: { label?: ...; type: ... };
refund?: { amount: ...; createDate: ... };
refunds?: (...)[];
status:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
};
user?: unknown;
voidDate?: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getInvoice
getInvoice: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { invoiceId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
invoice: {
amount?: number;
amountDue: number;
amountPaid: number;
amountRemaining: number;
appliedBalance: number;
autoChargeFailed?: boolean;
autoCreateDate?: string;
baseAmounts: {
amountDue: number;
appliedBalance: number;
currencyCode: string;
postPaymentCreditNotesAmount: number;
prePaymentCreditNotesAmount: number;
subtotalAmount: number;
subtotalExcludingTaxAmount: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
totalAmount: number;
totalExcludingTaxAmount: number;
};
company?: unknown;
companyRef?: string;
createDate: string;
currencyCode: string;
customer: {
id: string;
logo?: { key: string; url: string };
title?: string;
type: "company" | "user";
user?: {
about?: string | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
};
customerAddress?: {
city: string;
countryCode: string
| null;
line1: string;
line2: string;
postalCode: string;
state: string;
};
customerName?: string;
customerTaxId?: string;
deleteDate?: string;
dueDate?: string;
locationAddress?: {
city: string;
countryCode: string
| null;
line1: string;
line2: string;
postalCode: string;
state: string;
};
locationName?: string;
locationTaxId?: string;
dueDays?: number;
dueType?: "date"
| "days"
| "default";
id?: string;
internalNote?: string;
issueDate?: string;
items?: unknown[];
itemsCount: number;
locationRef: string;
membershipRef?: string;
memo?: string;
netAmount?: number;
number?: string;
paymentMethod?: { cardMask?: string; label?: string; mask?: string };
payments: {
createDate: string;
dispute?: { createDate: string };
method: {
external?: Record<(...), (...)>;
paymentGateway?: {
gateway: ...;
label?: ...;
mask?: ...;
title?: ...;
};
type: "external"
| "paymentGateway";
};
price: {
money: { currencyCode: string; grossAmount: number };
type: "money";
};
refundable: boolean;
refunds?: { money?: (...)
| (...); type: "money" };
status:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
surcharge?: {
money: {
amount: ...;
currencyCode: ...;
percentage?: ...;
rate?: ...;
};
type: "money";
};
transactionRef: string;
}[];
pdfUrl?: string;
postPaymentCreation: boolean;
postPaymentCreditAmount?: number;
postPaymentCreditNotesAmount: number;
prePaymentCreditAmount?: number;
prePaymentCreditNotesAmount: number;
receiptPdfUrl?: string;
startingBalance?: number;
status: "draft"
| "issued"
| "paid"
| "voided";
subscriptionRef?: string;
subtotalAmount: number;
subtotalExcludingTaxAmount: number;
taxAmount?: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
timezoneId: string;
title: string;
totalAmount: number;
totalExcludingTaxAmount: number;
transaction?: {
amount: number;
createDate: string;
id: string;
paymentMethod?: { label?: (...)
| (...); type: string };
refund?: { amount: number; createDate: string };
refunds?: {
amount: ...;
createDate: ...;
currencyCode: ...;
id: ...;
}[];
status: | "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
};
user?: unknown;
voidDate?: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deleteInvoice
deleteInvoice: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { invoiceId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
updateInvoice
updateInvoice: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { invoiceId: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
invoice: {
dueDate?: string;
dueDays?: number;
dueType?: "date"
| "days"
| "default";
internalNote?: string;
};
};
};
};
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
cancelInvoicePayment
cancelInvoicePayment: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { invoiceId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
duplicateInvoice
duplicateInvoice: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { invoiceId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
invoice?: {
amount?: number;
amountDue: number;
amountPaid: number;
amountRemaining: number;
appliedBalance: number;
autoChargeFailed?: boolean;
autoCreateDate?: string;
baseAmounts: {
amountDue: number;
appliedBalance: number;
currencyCode: string;
postPaymentCreditNotesAmount: number;
prePaymentCreditNotesAmount: number;
subtotalAmount: number;
subtotalExcludingTaxAmount: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
totalAmount: number;
totalExcludingTaxAmount: number;
};
company?: unknown;
companyRef?: string;
createDate: string;
currencyCode: string;
customer: {
id: string;
logo?: { key: string; url: string };
title?: string;
type: "company" | "user";
user?: {
about?: (...) | (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
customerAddress?: {
city: string;
countryCode: string
| null;
line1: string;
line2: string;
postalCode: string;
state: string;
};
customerName?: string;
customerTaxId?: string;
deleteDate?: string;
dueDate?: string;
locationAddress?: {
city: string;
countryCode: string
| null;
line1: string;
line2: string;
postalCode: string;
state: string;
};
locationName?: string;
locationTaxId?: string;
dueDays?: number;
dueType?: "date"
| "days"
| "default";
id?: string;
internalNote?: string;
issueDate?: string;
items?: unknown[];
itemsCount: number;
locationRef: string;
membershipRef?: string;
memo?: string;
netAmount?: number;
number?: string;
paymentMethod?: { cardMask?: string; label?: string; mask?: string };
payments: {
createDate: string;
dispute?: { createDate: ... };
method: {
external?: (...) | (...);
paymentGateway?: (...) | (...);
type: (...) | (...);
};
price: {
money: { currencyCode: ...; grossAmount: ... };
type: "money";
};
refundable: boolean;
refunds?: { money?: ...; type: ... };
status:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
surcharge?: { money: ...; type: ... };
transactionRef: string;
}[];
pdfUrl?: string;
postPaymentCreation: boolean;
postPaymentCreditAmount?: number;
postPaymentCreditNotesAmount: number;
prePaymentCreditAmount?: number;
prePaymentCreditNotesAmount: number;
receiptPdfUrl?: string;
startingBalance?: number;
status: "draft"
| "issued"
| "paid"
| "voided";
subscriptionRef?: string;
subtotalAmount: number;
subtotalExcludingTaxAmount: number;
taxAmount?: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
timezoneId: string;
title: string;
totalAmount: number;
totalExcludingTaxAmount: number;
transaction?: {
amount: number;
createDate: string;
id: string;
paymentMethod?: { label?: ...; type: ... };
refund?: { amount: ...; createDate: ... };
refunds?: (...)[];
status:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
};
user?: unknown;
voidDate?: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
issueInvoice
issueInvoice: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { invoiceId: string };
cookie?: undefined;
};
requestBody?: {
content: { "application/json": { skipAutoCharge?: boolean } };
};
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
invoice?: {
amount?: number;
amountDue: number;
amountPaid: number;
amountRemaining: number;
appliedBalance: number;
autoChargeFailed?: boolean;
autoCreateDate?: string;
baseAmounts: {
amountDue: number;
appliedBalance: number;
currencyCode: string;
postPaymentCreditNotesAmount: number;
prePaymentCreditNotesAmount: number;
subtotalAmount: number;
subtotalExcludingTaxAmount: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
totalAmount: number;
totalExcludingTaxAmount: number;
};
company?: unknown;
companyRef?: string;
createDate: string;
currencyCode: string;
customer: {
id: string;
logo?: { key: string; url: string };
title?: string;
type: "company" | "user";
user?: {
about?: (...) | (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
customerAddress?: {
city: string;
countryCode: string
| null;
line1: string;
line2: string;
postalCode: string;
state: string;
};
customerName?: string;
customerTaxId?: string;
deleteDate?: string;
dueDate?: string;
locationAddress?: {
city: string;
countryCode: string
| null;
line1: string;
line2: string;
postalCode: string;
state: string;
};
locationName?: string;
locationTaxId?: string;
dueDays?: number;
dueType?: "date"
| "days"
| "default";
id?: string;
internalNote?: string;
issueDate?: string;
items?: unknown[];
itemsCount: number;
locationRef: string;
membershipRef?: string;
memo?: string;
netAmount?: number;
number?: string;
paymentMethod?: { cardMask?: string; label?: string; mask?: string };
payments: {
createDate: string;
dispute?: { createDate: ... };
method: {
external?: (...) | (...);
paymentGateway?: (...) | (...);
type: (...) | (...);
};
price: {
money: { currencyCode: ...; grossAmount: ... };
type: "money";
};
refundable: boolean;
refunds?: { money?: ...; type: ... };
status:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
surcharge?: { money: ...; type: ... };
transactionRef: string;
}[];
pdfUrl?: string;
postPaymentCreation: boolean;
postPaymentCreditAmount?: number;
postPaymentCreditNotesAmount: number;
prePaymentCreditAmount?: number;
prePaymentCreditNotesAmount: number;
receiptPdfUrl?: string;
startingBalance?: number;
status: "draft"
| "issued"
| "paid"
| "voided";
subscriptionRef?: string;
subtotalAmount: number;
subtotalExcludingTaxAmount: number;
taxAmount?: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
timezoneId: string;
title: string;
totalAmount: number;
totalExcludingTaxAmount: number;
transaction?: {
amount: number;
createDate: string;
id: string;
paymentMethod?: { label?: ...; type: ... };
refund?: { amount: ...; createDate: ... };
refunds?: (...)[];
status:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
};
user?: unknown;
voidDate?: string;
};
invoiceItems?: {
amount: number;
baseAmounts: {
currencyCode: string;
discountedAmount: number;
tax?: { amount: ...; inclusive: ...; rate: ...; taxableAmount: ... };
totalAmount: number;
totalExcludingTaxAmount: number;
unitAmount: number;
unitExcludingTaxAmount: number;
};
booking?: { [key: string]: unknown };
companyRef?: string;
createDate: string;
creditPackage?: { [key: string]: unknown };
currencyCode: string;
deleteDate?: string;
description: string;
discountedAmount: number;
discounts: {
coupon: {
amountOff?: ...;
currencyCode?: ...;
duration?: ...;
durationInMonths?: ...;
id?: ...;
percentOff?: ...;
productTypes?: ...;
type?: ...;
};
promocode?: (...)
| (...);
subscriptionId?: (...) | (...);
}[];
id: string;
invoiceRef?: string;
locationRef: string;
membershipRef?: string;
membershipRefCreatedBy?: string;
netAmount: number;
netUnitAmount: number;
orderItem?: { [key: string]: unknown };
period?: { endDate: string; startDate: string };
plan?: { [key: string]: unknown };
product: {
bookingRef?: string;
eventTicketRef?: string;
optionRef?: string;
orderRef?: string;
title: string;
type:
| "creditPackage"
| "custom"
| "booking"
| "eventTicket"
| "subscription"
| "order";
};
quantity: number;
subscriptionRef?: string;
tax?: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
};
taxAmount?: number;
taxableAmount?: number;
ticket?: { [key: string]: unknown };
totalAmount: number;
totalExcludingTaxAmount: number;
type: string;
unitAmount: number;
unitExcludingTaxAmount: number;
userCreatedBy?: {
id: string;
name?: (...) | (...);
surname?: (...) | (...);
};
}[];
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getInvoiceItems
getInvoiceItems: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { invoiceId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
invoice?: {
amount?: number;
amountDue: number;
amountPaid: number;
amountRemaining: number;
appliedBalance: number;
autoChargeFailed?: boolean;
autoCreateDate?: string;
baseAmounts: {
amountDue: number;
appliedBalance: number;
currencyCode: string;
postPaymentCreditNotesAmount: number;
prePaymentCreditNotesAmount: number;
subtotalAmount: number;
subtotalExcludingTaxAmount: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
totalAmount: number;
totalExcludingTaxAmount: number;
};
company?: unknown;
companyRef?: string;
createDate: string;
currencyCode: string;
customer: {
id: string;
logo?: { key: string; url: string };
title?: string;
type: "company" | "user";
user?: {
about?: (...) | (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
customerAddress?: {
city: string;
countryCode: string
| null;
line1: string;
line2: string;
postalCode: string;
state: string;
};
customerName?: string;
customerTaxId?: string;
deleteDate?: string;
dueDate?: string;
locationAddress?: {
city: string;
countryCode: string
| null;
line1: string;
line2: string;
postalCode: string;
state: string;
};
locationName?: string;
locationTaxId?: string;
dueDays?: number;
dueType?: "date"
| "days"
| "default";
id?: string;
internalNote?: string;
issueDate?: string;
items?: unknown[];
itemsCount: number;
locationRef: string;
membershipRef?: string;
memo?: string;
netAmount?: number;
number?: string;
paymentMethod?: { cardMask?: string; label?: string; mask?: string };
payments: {
createDate: string;
dispute?: { createDate: ... };
method: {
external?: (...) | (...);
paymentGateway?: (...) | (...);
type: (...) | (...);
};
price: {
money: { currencyCode: ...; grossAmount: ... };
type: "money";
};
refundable: boolean;
refunds?: { money?: ...; type: ... };
status:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
surcharge?: { money: ...; type: ... };
transactionRef: string;
}[];
pdfUrl?: string;
postPaymentCreation: boolean;
postPaymentCreditAmount?: number;
postPaymentCreditNotesAmount: number;
prePaymentCreditAmount?: number;
prePaymentCreditNotesAmount: number;
receiptPdfUrl?: string;
startingBalance?: number;
status: "draft"
| "issued"
| "paid"
| "voided";
subscriptionRef?: string;
subtotalAmount: number;
subtotalExcludingTaxAmount: number;
taxAmount?: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
timezoneId: string;
title: string;
totalAmount: number;
totalExcludingTaxAmount: number;
transaction?: {
amount: number;
createDate: string;
id: string;
paymentMethod?: { label?: ...; type: ... };
refund?: { amount: ...; createDate: ... };
refunds?: (...)[];
status:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
};
user?: unknown;
voidDate?: string;
};
invoiceItems?: {
amount: number;
baseAmounts: {
currencyCode: string;
discountedAmount: number;
tax?: { amount: ...; inclusive: ...; rate: ...; taxableAmount: ... };
totalAmount: number;
totalExcludingTaxAmount: number;
unitAmount: number;
unitExcludingTaxAmount: number;
};
booking?: { [key: string]: unknown };
companyRef?: string;
createDate: string;
creditPackage?: { [key: string]: unknown };
currencyCode: string;
deleteDate?: string;
description: string;
discountedAmount: number;
discounts: {
coupon: {
amountOff?: ...;
currencyCode?: ...;
duration?: ...;
durationInMonths?: ...;
id?: ...;
percentOff?: ...;
productTypes?: ...;
type?: ...;
};
promocode?: (...)
| (...);
subscriptionId?: (...) | (...);
}[];
id: string;
invoiceRef?: string;
locationRef: string;
membershipRef?: string;
membershipRefCreatedBy?: string;
netAmount: number;
netUnitAmount: number;
orderItem?: { [key: string]: unknown };
period?: { endDate: string; startDate: string };
plan?: { [key: string]: unknown };
product: {
bookingRef?: string;
eventTicketRef?: string;
optionRef?: string;
orderRef?: string;
title: string;
type:
| "creditPackage"
| "custom"
| "booking"
| "eventTicket"
| "subscription"
| "order";
};
quantity: number;
subscriptionRef?: string;
tax?: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
};
taxAmount?: number;
taxableAmount?: number;
ticket?: { [key: string]: unknown };
totalAmount: number;
totalExcludingTaxAmount: number;
type: string;
unitAmount: number;
unitExcludingTaxAmount: number;
userCreatedBy?: {
id: string;
name?: (...) | (...);
surname?: (...) | (...);
};
}[];
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
payInvoice
payInvoice: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { invoiceId: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
amount?: number;
payment?: {
method: {
external?: Record<string, never>;
paymentGateway?: {
gateway:
| "authorizenet"
| "freedompay"
| "kakaopay"
| "maya"
| "mercadopago"
| "mollie"
| "paypal"
| "paystack"
| "payway"
| "plata"
| "stripe"
| "tap"
| "wayforpay"
| "xendit";
id?: string
| null;
};
type: "external"
| "paymentGateway";
};
};
paymentMethod?: {
id?: string;
type: | "external"
| "authorizenet"
| "freedompay"
| "kakaopay"
| "maya"
| "mercadopago"
| "mollie"
| "paypal"
| "paystack"
| "payway"
| "plata"
| "stripe"
| "tap"
| "wayforpay"
| "xendit";
};
termsConsent?: boolean;
};
};
};
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
invoice?: {
amount?: number;
amountDue: number;
amountPaid: number;
amountRemaining: number;
appliedBalance: number;
autoChargeFailed?: boolean;
autoCreateDate?: string;
baseAmounts: {
amountDue: number;
appliedBalance: number;
currencyCode: string;
postPaymentCreditNotesAmount: number;
prePaymentCreditNotesAmount: number;
subtotalAmount: number;
subtotalExcludingTaxAmount: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
totalAmount: number;
totalExcludingTaxAmount: number;
};
company?: unknown;
companyRef?: string;
createDate: string;
currencyCode: string;
customer: {
id: string;
logo?: { key: string; url: string };
title?: string;
type: "company" | "user";
user?: {
about?: (...) | (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
customerAddress?: {
city: string;
countryCode: string
| null;
line1: string;
line2: string;
postalCode: string;
state: string;
};
customerName?: string;
customerTaxId?: string;
deleteDate?: string;
dueDate?: string;
locationAddress?: {
city: string;
countryCode: string
| null;
line1: string;
line2: string;
postalCode: string;
state: string;
};
locationName?: string;
locationTaxId?: string;
dueDays?: number;
dueType?: "date"
| "days"
| "default";
id?: string;
internalNote?: string;
issueDate?: string;
items?: unknown[];
itemsCount: number;
locationRef: string;
membershipRef?: string;
memo?: string;
netAmount?: number;
number?: string;
paymentMethod?: { cardMask?: string; label?: string; mask?: string };
payments: {
createDate: string;
dispute?: { createDate: ... };
method: {
external?: (...) | (...);
paymentGateway?: (...) | (...);
type: (...) | (...);
};
price: {
money: { currencyCode: ...; grossAmount: ... };
type: "money";
};
refundable: boolean;
refunds?: { money?: ...; type: ... };
status:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
surcharge?: { money: ...; type: ... };
transactionRef: string;
}[];
pdfUrl?: string;
postPaymentCreation: boolean;
postPaymentCreditAmount?: number;
postPaymentCreditNotesAmount: number;
prePaymentCreditAmount?: number;
prePaymentCreditNotesAmount: number;
receiptPdfUrl?: string;
startingBalance?: number;
status: "draft"
| "issued"
| "paid"
| "voided";
subscriptionRef?: string;
subtotalAmount: number;
subtotalExcludingTaxAmount: number;
taxAmount?: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
timezoneId: string;
title: string;
totalAmount: number;
totalExcludingTaxAmount: number;
transaction?: {
amount: number;
createDate: string;
id: string;
paymentMethod?: { label?: ...; type: ... };
refund?: { amount: ...; createDate: ... };
refunds?: (...)[];
status:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
};
user?: unknown;
voidDate?: string;
};
payment?: {
createDate: string;
dispute?: { createDate: string };
method: {
external?: Record<string, never>;
paymentGateway?: {
gateway: string;
label?: (...) | (...);
mask?: (...) | (...);
title?: (...) | (...);
};
type: "external"
| "paymentGateway";
};
price: {
money: { currencyCode: string; grossAmount: number };
type: "money";
};
refundable: boolean;
refunds?: { money?: (...)[]; type: "money" };
status: "canceled" | "failed" | "pending" | "processing" | "succeeded";
surcharge?: {
money: {
amount: number;
currencyCode: string;
percentage?: (...) | (...);
rate?: (...) | (...);
};
type: "money";
};
transactionRef: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
resendInvoice
resendInvoice: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { invoiceId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
voidInvoice
voidInvoice: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { invoiceId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
listInvoiceItems
listInvoiceItems: {
parameters: {
query?: {
"createDate[gte]"?: string;
"createDate[lte]"?: string;
customerRef?: string;
"issueDate[gte]"?: string;
"issueDate[lte]"?: string;
limit?: number;
locationRef?: string;
nextPageToken?: string;
status?: string;
type?: string;
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
invoiceItems: {
amount: number;
baseAmounts: {
currencyCode: string;
discountedAmount: number;
tax?: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
};
totalAmount: number;
totalExcludingTaxAmount: number;
unitAmount: number;
unitExcludingTaxAmount: number;
};
booking?: { [key: string]: unknown };
companyRef?: string;
createDate: string;
creditPackage?: { [key: string]: unknown };
currencyCode: string;
deleteDate?: string;
description: string;
discountedAmount: number;
discounts: {
coupon: {
amountOff?: (...) | (...);
currencyCode?: (...) | (...);
duration?: (...) | (...);
durationInMonths?: (...) | (...);
id?: (...) | (...);
percentOff?: (...) | (...);
productTypes?: (...) | (...);
type?: (...) | (...);
};
promocode?: {
code: ...;
expiration?: ...;
id: ...;
limitByFirstPurchase?: ...;
};
subscriptionId?: string;
}[];
id: string;
invoiceRef?: string;
locationRef: string;
membershipRef?: string;
membershipRefCreatedBy?: string;
netAmount: number;
netUnitAmount: number;
orderItem?: { [key: string]: unknown };
period?: { endDate: string; startDate: string };
plan?: { [key: string]: unknown };
product: {
bookingRef?: string;
eventTicketRef?: string;
optionRef?: string;
orderRef?: string;
title: string;
type:
| "creditPackage"
| "custom"
| "booking"
| "eventTicket"
| "subscription"
| "order";
};
quantity: number;
subscriptionRef?: string;
tax?: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
};
taxAmount?: number;
taxableAmount?: number;
ticket?: { [key: string]: unknown };
totalAmount: number;
totalExcludingTaxAmount: number;
type: string;
unitAmount: number;
unitExcludingTaxAmount: number;
userCreatedBy?: { id: string; name?: string; surname?: string };
}[];
nextPageToken?: string;
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createInvoiceItem
createInvoiceItem: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
invoiceItem: {
companyRef?: string;
description?: string;
discounts?: { couponRef?: string
| null }[];
invoiceRef?: string;
membershipRef?: string;
product?: { optionRef?: string; title?: string };
quantity: number;
subscriptionRef?: string;
tax?: { rate?: number };
type?: "custom";
unitAmount: number;
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
invoiceItem?: {
amount: number;
baseAmounts: {
currencyCode: string;
discountedAmount: number;
tax?: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
};
totalAmount: number;
totalExcludingTaxAmount: number;
unitAmount: number;
unitExcludingTaxAmount: number;
};
booking?: { [key: string]: unknown };
companyRef?: string;
createDate: string;
creditPackage?: { [key: string]: unknown };
currencyCode: string;
deleteDate?: string;
description: string;
discountedAmount: number;
discounts: {
coupon: {
amountOff?: (...) | (...);
currencyCode?: (...) | (...);
duration?: (...) | (...);
durationInMonths?: (...) | (...);
id?: (...) | (...);
percentOff?: (...) | (...);
productTypes?: (...) | (...);
type?: (...) | (...);
};
promocode?: {
code: ...;
expiration?: ...;
id: ...;
limitByFirstPurchase?: ...;
};
subscriptionId?: string;
}[];
id: string;
invoiceRef?: string;
locationRef: string;
membershipRef?: string;
membershipRefCreatedBy?: string;
netAmount: number;
netUnitAmount: number;
orderItem?: { [key: string]: unknown };
period?: { endDate: string; startDate: string };
plan?: { [key: string]: unknown };
product: {
bookingRef?: string;
eventTicketRef?: string;
optionRef?: string;
orderRef?: string;
title: string;
type:
| "creditPackage"
| "custom"
| "booking"
| "eventTicket"
| "subscription"
| "order";
};
quantity: number;
subscriptionRef?: string;
tax?: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
};
taxAmount?: number;
taxableAmount?: number;
ticket?: { [key: string]: unknown };
totalAmount: number;
totalExcludingTaxAmount: number;
type: string;
unitAmount: number;
unitExcludingTaxAmount: number;
userCreatedBy?: { id: string; name?: string; surname?: string };
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getInvoiceItem
getInvoiceItem: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
invoiceItem?: {
amount: number;
baseAmounts: {
currencyCode: string;
discountedAmount: number;
tax?: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
};
totalAmount: number;
totalExcludingTaxAmount: number;
unitAmount: number;
unitExcludingTaxAmount: number;
};
booking?: { [key: string]: unknown };
companyRef?: string;
createDate: string;
creditPackage?: { [key: string]: unknown };
currencyCode: string;
deleteDate?: string;
description: string;
discountedAmount: number;
discounts: {
coupon: {
amountOff?: (...) | (...);
currencyCode?: (...) | (...);
duration?: (...) | (...);
durationInMonths?: (...) | (...);
id?: (...) | (...);
percentOff?: (...) | (...);
productTypes?: (...) | (...);
type?: (...) | (...);
};
promocode?: {
code: ...;
expiration?: ...;
id: ...;
limitByFirstPurchase?: ...;
};
subscriptionId?: string;
}[];
id: string;
invoiceRef?: string;
locationRef: string;
membershipRef?: string;
membershipRefCreatedBy?: string;
netAmount: number;
netUnitAmount: number;
orderItem?: { [key: string]: unknown };
period?: { endDate: string; startDate: string };
plan?: { [key: string]: unknown };
product: {
bookingRef?: string;
eventTicketRef?: string;
optionRef?: string;
orderRef?: string;
title: string;
type:
| "creditPackage"
| "custom"
| "booking"
| "eventTicket"
| "subscription"
| "order";
};
quantity: number;
subscriptionRef?: string;
tax?: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
};
taxAmount?: number;
taxableAmount?: number;
ticket?: { [key: string]: unknown };
totalAmount: number;
totalExcludingTaxAmount: number;
type: string;
unitAmount: number;
unitExcludingTaxAmount: number;
userCreatedBy?: { id: string; name?: string; surname?: string };
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deleteInvoiceItem
deleteInvoiceItem: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
updateInvoiceItem
updateInvoiceItem: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
invoiceItem: {
product?: { title?: string };
quantity?: number;
unitAmount?: number;
};
};
};
};
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getUpcomingInvoiceItems
getUpcomingInvoiceItems: {
parameters: {
query?: { companyRef?: string; membershipRef?: string };
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
invoiceItems?: {
amount: number;
baseAmounts: {
currencyCode: string;
discountedAmount: number;
tax?: { amount: ...; inclusive: ...; rate: ...; taxableAmount: ... };
totalAmount: number;
totalExcludingTaxAmount: number;
unitAmount: number;
unitExcludingTaxAmount: number;
};
booking?: { [key: string]: unknown };
companyRef?: string;
createDate: string;
creditPackage?: { [key: string]: unknown };
currencyCode: string;
deleteDate?: string;
description: string;
discountedAmount: number;
discounts: {
coupon: {
amountOff?: ...;
currencyCode?: ...;
duration?: ...;
durationInMonths?: ...;
id?: ...;
percentOff?: ...;
productTypes?: ...;
type?: ...;
};
promocode?: (...)
| (...);
subscriptionId?: (...) | (...);
}[];
id: string;
invoiceRef?: string;
locationRef: string;
membershipRef?: string;
membershipRefCreatedBy?: string;
netAmount: number;
netUnitAmount: number;
orderItem?: { [key: string]: unknown };
period?: { endDate: string; startDate: string };
plan?: { [key: string]: unknown };
product: {
bookingRef?: string;
eventTicketRef?: string;
optionRef?: string;
orderRef?: string;
title: string;
type:
| "creditPackage"
| "custom"
| "booking"
| "eventTicket"
| "subscription"
| "order";
};
quantity: number;
subscriptionRef?: string;
tax?: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
};
taxAmount?: number;
taxableAmount?: number;
ticket?: { [key: string]: unknown };
totalAmount: number;
totalExcludingTaxAmount: number;
type: string;
unitAmount: number;
unitExcludingTaxAmount: number;
userCreatedBy?: {
id: string;
name?: (...) | (...);
surname?: (...) | (...);
};
}[];
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getUpcomingInvoice
getUpcomingInvoice: {
parameters: {
query?: { subscriptionRef?: string };
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
invoice?: {
amount?: number;
amountDue: number;
amountPaid: number;
amountRemaining: number;
appliedBalance: number;
autoChargeFailed?: boolean;
autoCreateDate?: string;
baseAmounts: {
amountDue: number;
appliedBalance: number;
currencyCode: string;
postPaymentCreditNotesAmount: number;
prePaymentCreditNotesAmount: number;
subtotalAmount: number;
subtotalExcludingTaxAmount: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
totalAmount: number;
totalExcludingTaxAmount: number;
};
company?: unknown;
companyRef?: string;
createDate: string;
currencyCode: string;
customer: {
id: string;
logo?: { key: string; url: string };
title?: string;
type: "company" | "user";
user?: {
about?: (...) | (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
customerAddress?: {
city: string;
countryCode: string
| null;
line1: string;
line2: string;
postalCode: string;
state: string;
};
customerName?: string;
customerTaxId?: string;
deleteDate?: string;
dueDate?: string;
locationAddress?: {
city: string;
countryCode: string
| null;
line1: string;
line2: string;
postalCode: string;
state: string;
};
locationName?: string;
locationTaxId?: string;
dueDays?: number;
dueType?: "date"
| "days"
| "default";
id?: string;
internalNote?: string;
issueDate?: string;
items?: unknown[];
itemsCount: number;
locationRef: string;
membershipRef?: string;
memo?: string;
netAmount?: number;
number?: string;
paymentMethod?: { cardMask?: string; label?: string; mask?: string };
payments: {
createDate: string;
dispute?: { createDate: ... };
method: {
external?: (...) | (...);
paymentGateway?: (...) | (...);
type: (...) | (...);
};
price: {
money: { currencyCode: ...; grossAmount: ... };
type: "money";
};
refundable: boolean;
refunds?: { money?: ...; type: ... };
status:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
surcharge?: { money: ...; type: ... };
transactionRef: string;
}[];
pdfUrl?: string;
postPaymentCreation: boolean;
postPaymentCreditAmount?: number;
postPaymentCreditNotesAmount: number;
prePaymentCreditAmount?: number;
prePaymentCreditNotesAmount: number;
receiptPdfUrl?: string;
startingBalance?: number;
status: "draft"
| "issued"
| "paid"
| "voided";
subscriptionRef?: string;
subtotalAmount: number;
subtotalExcludingTaxAmount: number;
taxAmount?: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
timezoneId: string;
title: string;
totalAmount: number;
totalExcludingTaxAmount: number;
transaction?: {
amount: number;
createDate: string;
id: string;
paymentMethod?: { label?: ...; type: ... };
refund?: { amount: ...; createDate: ... };
refunds?: (...)[];
status:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
};
user?: unknown;
voidDate?: string;
};
invoiceItems?: {
amount: number;
baseAmounts: {
currencyCode: string;
discountedAmount: number;
tax?: { amount: ...; inclusive: ...; rate: ...; taxableAmount: ... };
totalAmount: number;
totalExcludingTaxAmount: number;
unitAmount: number;
unitExcludingTaxAmount: number;
};
booking?: { [key: string]: unknown };
companyRef?: string;
createDate: string;
creditPackage?: { [key: string]: unknown };
currencyCode: string;
deleteDate?: string;
description: string;
discountedAmount: number;
discounts: {
coupon: {
amountOff?: ...;
currencyCode?: ...;
duration?: ...;
durationInMonths?: ...;
id?: ...;
percentOff?: ...;
productTypes?: ...;
type?: ...;
};
promocode?: (...)
| (...);
subscriptionId?: (...) | (...);
}[];
id: string;
invoiceRef?: string;
locationRef: string;
membershipRef?: string;
membershipRefCreatedBy?: string;
netAmount: number;
netUnitAmount: number;
orderItem?: { [key: string]: unknown };
period?: { endDate: string; startDate: string };
plan?: { [key: string]: unknown };
product: {
bookingRef?: string;
eventTicketRef?: string;
optionRef?: string;
orderRef?: string;
title: string;
type:
| "creditPackage"
| "custom"
| "booking"
| "eventTicket"
| "subscription"
| "order";
};
quantity: number;
subscriptionRef?: string;
tax?: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
};
taxAmount?: number;
taxableAmount?: number;
ticket?: { [key: string]: unknown };
totalAmount: number;
totalExcludingTaxAmount: number;
type: string;
unitAmount: number;
unitExcludingTaxAmount: number;
userCreatedBy?: {
id: string;
name?: (...) | (...);
surname?: (...) | (...);
};
}[];
upcomingItems?: {
amount: number;
baseAmounts: {
currencyCode: string;
discountedAmount: number;
tax?: { amount: ...; inclusive: ...; rate: ...; taxableAmount: ... };
totalAmount: number;
totalExcludingTaxAmount: number;
unitAmount: number;
unitExcludingTaxAmount: number;
};
booking?: { [key: string]: unknown };
companyRef?: string;
createDate: string;
creditPackage?: { [key: string]: unknown };
currencyCode: string;
deleteDate?: string;
description: string;
discountedAmount: number;
discounts: {
coupon: {
amountOff?: ...;
currencyCode?: ...;
duration?: ...;
durationInMonths?: ...;
id?: ...;
percentOff?: ...;
productTypes?: ...;
type?: ...;
};
promocode?: (...)
| (...);
subscriptionId?: (...) | (...);
}[];
id: string;
invoiceRef?: string;
locationRef: string;
membershipRef?: string;
membershipRefCreatedBy?: string;
netAmount: number;
netUnitAmount: number;
orderItem?: { [key: string]: unknown };
period?: { endDate: string; startDate: string };
plan?: { [key: string]: unknown };
product: {
bookingRef?: string;
eventTicketRef?: string;
optionRef?: string;
orderRef?: string;
title: string;
type:
| "creditPackage"
| "custom"
| "booking"
| "eventTicket"
| "subscription"
| "order";
};
quantity: number;
subscriptionRef?: string;
tax?: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
};
taxAmount?: number;
taxableAmount?: number;
ticket?: { [key: string]: unknown };
totalAmount: number;
totalExcludingTaxAmount: number;
type: string;
unitAmount: number;
unitExcludingTaxAmount: number;
userCreatedBy?: {
id: string;
name?: (...) | (...);
surname?: (...) | (...);
};
}[];
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getCreditNotes
getCreditNotes: {
parameters: {
query?: {
"createDate[gte]"?: string;
"createDate[lte]"?: string;
invoiceRef?: string;
limit?: number;
locationRef?: string;
nextPageToken?: string;
status?: string;
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
creditNotes: {
baseAmounts: {
currencyCode: string;
grossAmount: number;
postPaymentAmount: number;
prePaymentAmount: number;
subtotalAmount: number;
subtotalAmountExcludingTax: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
totalAmount: number;
totalExcludingTaxAmount: number;
};
createDate: string;
creditAmount?: number;
currencyCode: string;
customer: {
id: string;
logo?: { key: string; url: string };
title?: string;
type: "company" | "user";
user?: {
about?: (...) | (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
effectiveDate?: string;
grossAmount: number;
id: string;
internalNote?: string;
invoiceRef: string;
lines: {
baseAmounts: {
currencyCode: string;
discountedAmount: number;
tax?: (...)
| (...);
totalAmount: number;
totalExcludingTaxAmount: number;
unitAmount?: (...) | (...);
unitExcludingTaxAmount?: (...) | (...);
};
createDate: string;
currencyCode: string;
discountedAmount: number;
discounts?: (...)[];
id: string;
invoiceItemRef: string;
invoiceRef: string;
locationRef: string;
networkRef: string;
quantity?: number;
tax?: { amount: ...; inclusive: ...; rate: ...; taxableAmount: ... };
totalAmount: number;
totalExcludingTaxAmount: number;
unitAmount?: number;
unitExcludingTaxAmount?: number;
updateDate: string;
}[];
locationRef: string;
networkRef: string;
number?: number;
outOfBandAmount?: number;
pdfUrl: string;
postPaymentAmount: number;
prePaymentAmount: number;
reason: | "duplicate"
| "orderChange"
| "productUnsatisfactory"
| "fraudulent"
| "other";
refunds?: {
amount: number;
currencyCode: string;
id: string;
method?: (...)
| (...);
transactionRef: string;
}[];
status: "issued"
| "voided";
subtotalAmount: number;
subtotalAmountExcludingTax: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
title: string;
totalAmount: number;
totalExcludingTaxAmount: number;
type: "prePayment"
| "postPayment"
| "mixed";
updateDate: string;
voidDate?: string;
}[];
nextPageToken?: string;
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
"403": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
"404": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createCreditNote
createCreditNote: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
creditNote: {
creditAmount?: number;
effectiveDate?: string;
internalNote?: string;
invoiceRef: string;
lines: { amount?: number; invoiceItemRef: string; quantity?: number }[];
outOfBandAmount?: number;
refunds?: { amount?: number; id?: string; transactionRef?: string }[];
reason:
| "duplicate"
| "orderChange"
| "productUnsatisfactory"
| "fraudulent"
| "other";
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
creditNote?: {
baseAmounts: {
currencyCode: string;
grossAmount: number;
postPaymentAmount: number;
prePaymentAmount: number;
subtotalAmount: number;
subtotalAmountExcludingTax: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
totalAmount: number;
totalExcludingTaxAmount: number;
};
createDate: string;
creditAmount?: number;
currencyCode: string;
customer: {
id: string;
logo?: { key: string; url: string };
title?: string;
type: "company" | "user";
user?: {
about?: (...) | (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
effectiveDate?: string;
grossAmount: number;
id: string;
internalNote?: string;
invoiceRef: string;
lines: {
baseAmounts: {
currencyCode: string;
discountedAmount: number;
tax?: (...)
| (...);
totalAmount: number;
totalExcludingTaxAmount: number;
unitAmount?: (...) | (...);
unitExcludingTaxAmount?: (...) | (...);
};
createDate: string;
currencyCode: string;
discountedAmount: number;
discounts?: (...)[];
id: string;
invoiceItemRef: string;
invoiceRef: string;
locationRef: string;
networkRef: string;
quantity?: number;
tax?: { amount: ...; inclusive: ...; rate: ...; taxableAmount: ... };
totalAmount: number;
totalExcludingTaxAmount: number;
unitAmount?: number;
unitExcludingTaxAmount?: number;
updateDate: string;
}[];
locationRef: string;
networkRef: string;
number?: number;
outOfBandAmount?: number;
pdfUrl: string;
postPaymentAmount: number;
prePaymentAmount: number;
reason: | "duplicate"
| "orderChange"
| "productUnsatisfactory"
| "fraudulent"
| "other";
refunds?: {
amount: number;
currencyCode: string;
id: string;
method?: (...)
| (...);
transactionRef: string;
}[];
status: "issued"
| "voided";
subtotalAmount: number;
subtotalAmountExcludingTax: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
title: string;
totalAmount: number;
totalExcludingTaxAmount: number;
type: "prePayment"
| "postPayment"
| "mixed";
updateDate: string;
voidDate?: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
"403": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
"404": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getCreditNote
getCreditNote: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
creditNote?: {
baseAmounts: {
currencyCode: string;
grossAmount: number;
postPaymentAmount: number;
prePaymentAmount: number;
subtotalAmount: number;
subtotalAmountExcludingTax: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
totalAmount: number;
totalExcludingTaxAmount: number;
};
createDate: string;
creditAmount?: number;
currencyCode: string;
customer: {
id: string;
logo?: { key: string; url: string };
title?: string;
type: "company" | "user";
user?: {
about?: (...) | (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
effectiveDate?: string;
grossAmount: number;
id: string;
internalNote?: string;
invoiceRef: string;
lines: {
baseAmounts: {
currencyCode: string;
discountedAmount: number;
tax?: (...)
| (...);
totalAmount: number;
totalExcludingTaxAmount: number;
unitAmount?: (...) | (...);
unitExcludingTaxAmount?: (...) | (...);
};
createDate: string;
currencyCode: string;
discountedAmount: number;
discounts?: (...)[];
id: string;
invoiceItemRef: string;
invoiceRef: string;
locationRef: string;
networkRef: string;
quantity?: number;
tax?: { amount: ...; inclusive: ...; rate: ...; taxableAmount: ... };
totalAmount: number;
totalExcludingTaxAmount: number;
unitAmount?: number;
unitExcludingTaxAmount?: number;
updateDate: string;
}[];
locationRef: string;
networkRef: string;
number?: number;
outOfBandAmount?: number;
pdfUrl: string;
postPaymentAmount: number;
prePaymentAmount: number;
reason: | "duplicate"
| "orderChange"
| "productUnsatisfactory"
| "fraudulent"
| "other";
refunds?: {
amount: number;
currencyCode: string;
id: string;
method?: (...)
| (...);
transactionRef: string;
}[];
status: "issued"
| "voided";
subtotalAmount: number;
subtotalAmountExcludingTax: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
title: string;
totalAmount: number;
totalExcludingTaxAmount: number;
type: "prePayment"
| "postPayment"
| "mixed";
updateDate: string;
voidDate?: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
"404": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
updateCreditNote
updateCreditNote: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": { creditNote?: { internalNote?: string } };
};
};
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
"403": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
"404": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
previewCreditNote
previewCreditNote: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
creditNote: {
creditAmount?: number;
effectiveDate?: string;
internalNote?: string;
invoiceRef: string;
lines: { amount?: number; invoiceItemRef: string; quantity?: number }[];
outOfBandAmount?: number;
refunds?: { amount?: number; id?: string; transactionRef?: string }[];
};
};
};
};
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
creditNote?: {
baseAmounts: {
currencyCode: string;
grossAmount: number;
postPaymentAmount: number;
prePaymentAmount: number;
subtotalAmount: number;
subtotalAmountExcludingTax: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
totalAmount: number;
totalExcludingTaxAmount: number;
};
createDate: string;
creditAmount?: number;
currencyCode: string;
customer: {
id: string;
logo?: { key: string; url: string };
title?: string;
type: "company" | "user";
user?: {
about?: (...) | (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
effectiveDate?: string;
grossAmount: number;
id: string;
internalNote?: string;
invoiceRef: string;
lines: {
baseAmounts: {
currencyCode: string;
discountedAmount: number;
tax?: (...)
| (...);
totalAmount: number;
totalExcludingTaxAmount: number;
unitAmount?: (...) | (...);
unitExcludingTaxAmount?: (...) | (...);
};
createDate: string;
currencyCode: string;
discountedAmount: number;
discounts?: (...)[];
id: string;
invoiceItemRef: string;
invoiceRef: string;
locationRef: string;
networkRef: string;
quantity?: number;
tax?: { amount: ...; inclusive: ...; rate: ...; taxableAmount: ... };
totalAmount: number;
totalExcludingTaxAmount: number;
unitAmount?: number;
unitExcludingTaxAmount?: number;
updateDate: string;
}[];
locationRef: string;
networkRef: string;
number?: number;
outOfBandAmount?: number;
pdfUrl: string;
postPaymentAmount: number;
prePaymentAmount: number;
reason: | "duplicate"
| "orderChange"
| "productUnsatisfactory"
| "fraudulent"
| "other";
refunds?: {
amount: number;
currencyCode: string;
id: string;
method?: (...)
| (...);
transactionRef: string;
}[];
status: "issued"
| "voided";
subtotalAmount: number;
subtotalAmountExcludingTax: number;
taxes: {
amount: number;
inclusive: boolean;
rate: number;
taxableAmount: number;
}[];
title: string;
totalAmount: number;
totalExcludingTaxAmount: number;
type: "prePayment"
| "postPayment"
| "mixed";
updateDate: string;
voidDate?: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
"403": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
"404": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getCompanies
getCompanies: {
parameters: {
query: {
locationRef: string;
limit?: number;
nextPageToken?: string;
title?: string;
types?: "member" | "nonmember";
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
companies?: {
billingAddress?: string;
businessAddress?: {
city?: (...) | (...);
countryCode?: (...) | (...);
line1?: (...) | (...);
line2?: (...) | (...);
postalCode?: (...) | (...);
state?: (...) | (...);
};
createDate?: string;
credits?: { expiring?: (...)
| (...); permanent?: (...) | (...) };
dayPasses?: { expiring?: (...) | (...) };
deleteDate?: string;
id?: string;
legalName?: string;
locationRef?: string;
metadata?: Record<string, never>;
notes?: string;
subscriptionRef?: string;
taxId?: string;
title?: string;
}[];
nextPageToken?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createCompany
createCompany: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
company: {
billingAddress?: string;
businessAddress?: {
city?: string;
countryCode?: string;
line1?: string;
line2?: string;
postalCode?: string;
state?: string;
};
legalName?: string;
locationRef: string;
metadata?: Record<string, never>;
notes?: string;
taxId?: string;
title: string;
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
company?: {
billingAddress?: string;
businessAddress?: {
city?: string;
countryCode?: string;
line1?: string;
line2?: string;
postalCode?: string;
state?: string;
};
createDate?: string;
credits?: { expiring?: number; permanent?: number };
dayPasses?: { expiring?: number };
deleteDate?: string;
id?: string;
legalName?: string;
locationRef?: string;
metadata?: Record<string, never>;
notes?: string;
subscriptionRef?: string;
taxId?: string;
title?: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getCompany
getCompany: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
company?: {
billingAddress?: string;
businessAddress?: {
city?: string;
countryCode?: string;
line1?: string;
line2?: string;
postalCode?: string;
state?: string;
};
createDate?: string;
credits?: { expiring?: number; permanent?: number };
dayPasses?: { expiring?: number };
deleteDate?: string;
id?: string;
legalName?: string;
locationRef?: string;
metadata?: Record<string, never>;
notes?: string;
subscriptionRef?: string;
taxId?: string;
title?: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
updateCompany
updateCompany: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
company: {
billingAddress?: string;
businessAddress?: {
city?: string;
countryCode?: string;
line1?: string;
line2?: string;
postalCode?: string;
state?: string;
};
legalName?: string;
metadata?: Record<string, never>;
notes?: string;
taxId?: string;
title?: string;
};
};
};
};
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
company?: {
billingAddress?: string;
businessAddress?: {
city?: string;
countryCode?: string;
line1?: string;
line2?: string;
postalCode?: string;
state?: string;
};
createDate?: string;
credits?: { expiring?: number; permanent?: number };
dayPasses?: { expiring?: number };
deleteDate?: string;
id?: string;
legalName?: string;
locationRef?: string;
metadata?: Record<string, never>;
notes?: string;
subscriptionRef?: string;
taxId?: string;
title?: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getMemberships
getMemberships: {
parameters: {
query: {
companyRef?: string;
locationRef: string;
limit?: number;
nextPageToken?: string;
userEmail?: string;
userRef?: string;
status?: "requested";
types?: "member" | "nonmember";
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
memberships?: {
businessAddress?: {
city?: (...) | (...);
countryCode?: (...) | (...);
line1?: (...) | (...);
line2?: (...) | (...);
postalCode?: (...) | (...);
state?: (...) | (...);
};
companyRef?: string;
companyRole?: "manager"
| "member";
createDate?: string;
credits?: { expiring?: (...) | (...); permanent?: (...) | (...) };
dayPasses?: { expiring?: (...) | (...) };
deleteDate?: string;
id?: string;
invitationDate?: string;
legalName?: string;
locationRef?: string;
metadata?: Record<string, never>;
notes?: string;
role?: "member" | "admin";
status?: "requested" | "approved";
subscriptionRef?: string;
taxId?: string;
type?: "member" | "nonmember";
user?: {
about?: (...) | (...);
email?: (...) | (...);
id?: (...) | (...);
name?: (...) | (...);
phoneNumber?: (...) | (...);
photoUrl?: (...) | (...);
surname?: (...) | (...);
};
userRef?: string;
}[];
nextPageToken?: string;
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createMembership
createMembership: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
membership: {
businessAddress?: {
city?: string;
countryCode?: string;
line1?: string;
line2?: string;
postalCode?: string;
state?: string;
};
companyRef?: string;
companyRole?: "manager"
| "member";
legalName?: string;
taxId?: string;
role: "member" | "admin";
metadata?: Record<string, never>;
notes?: string;
locationRef: string;
type?: "member" | "nonmember";
user: {
email: string;
about?: string;
name: string;
phoneNumber?: string;
surname?: string;
};
};
locale?: string;
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
membership?: {
businessAddress?: {
city?: string;
countryCode?: string;
line1?: string;
line2?: string;
postalCode?: string;
state?: string;
};
companyRef?: string;
companyRole?: "manager"
| "member";
createDate?: string;
credits?: { expiring?: number; permanent?: number };
dayPasses?: { expiring?: number };
deleteDate?: string;
id?: string;
invitationDate?: string;
legalName?: string;
locationRef?: string;
metadata?: Record<string, never>;
notes?: string;
role?: "member" | "admin";
status?: "requested" | "approved";
subscriptionRef?: string;
taxId?: string;
type?: "member" | "nonmember";
user?: {
about?: string;
email?: string;
id?: string;
name?: string;
phoneNumber?: string;
photoUrl?: string;
surname?: string;
};
userRef?: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getMembership
getMembership: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
membership?: {
businessAddress?: {
city?: string;
countryCode?: string;
line1?: string;
line2?: string;
postalCode?: string;
state?: string;
};
companyRef?: string;
companyRole?: "manager"
| "member";
createDate?: string;
credits?: { expiring?: number; permanent?: number };
dayPasses?: { expiring?: number };
deleteDate?: string;
id?: string;
invitationDate?: string;
legalName?: string;
locationRef?: string;
metadata?: Record<string, never>;
notes?: string;
role?: "member" | "admin";
status?: "requested" | "approved";
subscriptionRef?: string;
taxId?: string;
type?: "member" | "nonmember";
user?: {
about?: string;
email?: string;
id?: string;
name?: string;
phoneNumber?: string;
photoUrl?: string;
surname?: string;
};
userRef?: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
updateMembership
updateMembership: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: number };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
membership: {
businessAddress?: {
city?: string;
countryCode?: string;
line1?: string;
line2?: string;
postalCode?: string;
state?: string;
};
legalName?: string;
metadata?: Record<string, never>;
role?: "member" | "admin";
taxId?: string;
};
};
};
};
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
membership?: {
businessAddress?: {
city?: string;
countryCode?: string;
line1?: string;
line2?: string;
postalCode?: string;
state?: string;
};
companyRef?: string;
companyRole?: "manager"
| "member";
createDate?: string;
credits?: { expiring?: number; permanent?: number };
dayPasses?: { expiring?: number };
deleteDate?: string;
id?: string;
invitationDate?: string;
legalName?: string;
locationRef?: string;
metadata?: Record<string, never>;
notes?: string;
role?: "member" | "admin";
status?: "requested" | "approved";
subscriptionRef?: string;
taxId?: string;
type?: "member" | "nonmember";
user?: {
about?: string;
email?: string;
id?: string;
name?: string;
phoneNumber?: string;
photoUrl?: string;
surname?: string;
};
userRef?: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deleteMembership
deleteMembership: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getMembershipsDeleted
getMembershipsDeleted: {
parameters: {
query: {
locationRef: string;
limit?: number;
userEmail?: string;
nextPageToken?: string;
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
memberships?: {
businessAddress?: {
city?: (...) | (...);
countryCode?: (...) | (...);
line1?: (...) | (...);
line2?: (...) | (...);
postalCode?: (...) | (...);
state?: (...) | (...);
};
companyRef?: string;
companyRole?: "manager"
| "member";
createDate?: string;
credits?: { expiring?: (...) | (...); permanent?: (...) | (...) };
dayPasses?: { expiring?: (...) | (...) };
deleteDate?: string;
id?: string;
invitationDate?: string;
legalName?: string;
locationRef?: string;
metadata?: Record<string, never>;
notes?: string;
role?: "member" | "admin";
status?: "requested" | "approved";
subscriptionRef?: string;
taxId?: string;
type?: "member" | "nonmember";
user?: {
about?: (...) | (...);
email?: (...) | (...);
id?: (...) | (...);
name?: (...) | (...);
phoneNumber?: (...) | (...);
photoUrl?: (...) | (...);
surname?: (...) | (...);
};
userRef?: string;
}[];
nextPageToken?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getContracts
getContracts: {
parameters: {
query?: {
"createDate[gte]"?: string;
"createDate[lte]"?: string;
customerRef?: string;
limit?: number;
locationRef?: string;
nextPageToken?: string;
q?: string;
status?: string;
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
contracts: {
action: "subscription" | "invoice" | "none";
actionable: boolean;
createDate: string;
customer: {
company?: {
logo?: (...) | (...);
publicLogoUrl?: (...) | (...);
title: string;
};
id: string;
user?: {
about?: (...)
| (...)
| (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
customerRef: string;
endDate?: string;
expirationDate: string;
id: string;
issueDate?: string;
items?: {
couponRef?: (...)
| (...);
entire?: (...) | (...) | (...);
optionRef?: (...) | (...);
period?: (...) | (...);
planRef?: (...) | (...);
price?: (...) | (...);
productRef?: (...) | (...);
quantity: number;
resourceRef?: (...) | (...);
tierRef?: (...) | (...);
title: string;
type: (...) | (...) | (...);
}[];
locationRef: string;
signatureMethod?: "eSignature"
| "manual";
signedDocument?: { key: string; url: string };
signers: {
declinedDate?: string;
email: string;
id: string;
name: string;
order?: number;
phoneNumber?: string;
signedDate?: string;
status?: string;
surname?: string;
type: "location" | "customer";
}[];
startDate?: string;
status: "draft"
| "issued"
| "signed"
| "declined"
| "terminated";
templateRef: string;
terminationDate?: string;
terminationReason?: string;
timezoneId: string;
title: string;
unsignedDocument?: { key: string; url: string };
}[];
nextPageToken?: string;
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createContract
createContract: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
contract: {
actionable?: boolean;
customerRef: string;
endDate?: string;
expirationDate: string;
items?: {
couponRef?: string;
oneOff?: boolean;
optionRef?: string;
planRef?: string;
price?: number;
productRef?: string;
quantity: number;
resourceRef?: string;
tierRef?: string;
title: string;
type: "plan"
| "resource"
| "oneOff";
}[];
signers: {
email: string;
name: string;
phoneNumber?: string;
surname?: string;
type: "location"
| "customer";
}[];
startDate?: string;
templateRef: string;
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
contract: {
action: "subscription" | "invoice" | "none";
actionable: boolean;
createDate: string;
customer: {
company?: {
logo?: { key: ...; url: ... };
publicLogoUrl?: string;
title: string;
};
id: string;
user?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
};
customerRef: string;
endDate?: string;
expirationDate: string;
id: string;
issueDate?: string;
items?: {
couponRef?: string;
entire?: boolean;
optionRef?: string;
period?: string;
planRef?: string;
price?: number;
productRef?: string;
quantity: number;
resourceRef?: string;
tierRef?: string;
title: string;
type: "plan"
| "resource"
| "oneOff";
}[];
locationRef: string;
signatureMethod?: "eSignature"
| "manual";
signedDocument?: { key: string; url: string };
signers: {
declinedDate?: string;
email: string;
id: string;
name: string;
order?: number;
phoneNumber?: string;
signedDate?: string;
status?: string;
surname?: string;
type: "location" | "customer";
}[];
startDate?: string;
status: "draft"
| "issued"
| "signed"
| "declined"
| "terminated";
templateRef: string;
terminationDate?: string;
terminationReason?: string;
timezoneId: string;
title: string;
unsignedDocument?: { key: string; url: string };
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getContract
getContract: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { contractId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
contract: {
action: "subscription" | "invoice" | "none";
actionable: boolean;
createDate: string;
customer: {
company?: {
logo?: { key: ...; url: ... };
publicLogoUrl?: string;
title: string;
};
id: string;
user?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
};
customerRef: string;
endDate?: string;
expirationDate: string;
id: string;
issueDate?: string;
items?: {
couponRef?: string;
entire?: boolean;
optionRef?: string;
period?: string;
planRef?: string;
price?: number;
productRef?: string;
quantity: number;
resourceRef?: string;
tierRef?: string;
title: string;
type: "plan"
| "resource"
| "oneOff";
}[];
locationRef: string;
signatureMethod?: "eSignature"
| "manual";
signedDocument?: { key: string; url: string };
signers: {
declinedDate?: string;
email: string;
id: string;
name: string;
order?: number;
phoneNumber?: string;
signedDate?: string;
status?: string;
surname?: string;
type: "location" | "customer";
}[];
startDate?: string;
status: "draft"
| "issued"
| "signed"
| "declined"
| "terminated";
templateRef: string;
terminationDate?: string;
terminationReason?: string;
timezoneId: string;
title: string;
unsignedDocument?: { key: string; url: string };
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deleteContract
deleteContract: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { contractId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
updateContract
updateContract: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { contractId: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
contract: {
actionable?: boolean;
expirationDate?: string;
items?: {
couponRef?: string;
oneOff?: boolean;
optionRef?: string;
planRef?: string;
price?: number;
productRef?: string;
quantity: number;
resourceRef?: string;
tierRef?: string;
title: string;
type: "plan"
| "resource"
| "oneOff";
}[];
templateRef?: string;
endDate?: string
| null;
signers?: {
email?: string;
id?: string;
name?: string;
phoneNumber?: string;
surname?: string;
type?: "location" | "customer";
}[];
startDate?: string
| null;
};
};
};
};
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
issueContract
issueContract: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { contractId: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": { signatureMethod: "eSignature"
| "manual" };
};
};
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
contract: {
action: "subscription" | "invoice" | "none";
actionable: boolean;
createDate: string;
customer: {
company?: {
logo?: { key: ...; url: ... };
publicLogoUrl?: string;
title: string;
};
id: string;
user?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
};
customerRef: string;
endDate?: string;
expirationDate: string;
id: string;
issueDate?: string;
items?: {
couponRef?: string;
entire?: boolean;
optionRef?: string;
period?: string;
planRef?: string;
price?: number;
productRef?: string;
quantity: number;
resourceRef?: string;
tierRef?: string;
title: string;
type: "plan"
| "resource"
| "oneOff";
}[];
locationRef: string;
signatureMethod?: "eSignature"
| "manual";
signedDocument?: { key: string; url: string };
signers: {
declinedDate?: string;
email: string;
id: string;
name: string;
order?: number;
phoneNumber?: string;
signedDate?: string;
status?: string;
surname?: string;
type: "location" | "customer";
}[];
startDate?: string;
status: "draft"
| "issued"
| "signed"
| "declined"
| "terminated";
templateRef: string;
terminationDate?: string;
terminationReason?: string;
timezoneId: string;
title: string;
unsignedDocument?: { key: string; url: string };
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
resendContract
resendContract: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { contractId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
declineContract
declineContract: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { contractId: string; signerId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
signContract
signContract: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { contractId: string; signerId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
terminateContract
terminateContract: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { contractId: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
reason: | "productUnsatisfactory"
| "other"
| "forceMajeure"
| "mutualAgreement"
| "policyViolation";
};
};
};
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getTemplates
getTemplates: {
parameters: {
query: { limit?: number; locationRef: string; nextPageToken?: string };
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
nextPageToken?: string;
searchQueryNext?: string;
templates: {
createDate: string;
file: { key: string; url: string };
id: string;
locationRef: string;
media: { key: string; url: string }[];
title: string;
updateDate: string;
}[];
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createTemplate
createTemplate: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
template: {
file: { key: string };
locationRef: string;
title: string;
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
template: {
createDate: string;
file: { key: string; url: string };
id: string;
locationRef: string;
media: { key: string; url: string }[];
title: string;
updateDate: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getTemplate
getTemplate: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { templateId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
template: {
createDate: string;
file: { key: string; url: string };
id: string;
locationRef: string;
media: { key: string; url: string }[];
title: string;
updateDate: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deleteTemplate
deleteTemplate: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { templateId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
updateTemplate
updateTemplate: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { templateId: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
template: { file?: { key: string }; title?: string };
};
};
};
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
duplicateTemplate
duplicateTemplate: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { templateId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
template: {
createDate: string;
file: { key: string; url: string };
id: string;
locationRef: string;
media: { key: string; url: string }[];
title: string;
updateDate: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getCoupons
getCoupons: {
parameters: {
query: {
locationRef: string;
type?:
| "subscriptionItems"
| "creditPackages"
| "desks"
| "equipment"
| "events"
| "products"
| "rooms";
limit?: number;
nextPageToken?: string;
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
coupons?: {
amountOff?: number | null;
createDate?: string;
currencyCode?: string | null;
deleteDate?: string;
duration?: "once" | "forever" | "repeating" | null;
durationInMonths?: number | null;
enabledForCredits?: boolean | null;
id: string;
limitedItems: {
enabled: boolean;
values: { id: ...; title?: ...; type: ... }[];
};
limitedRedemption: { enabled: boolean; usage: number; value: number };
locationRef?: string;
networkRef?: string;
percentOff?: number | null;
productTypes: (
| "roomBookings"
| "eventSpaceBookings"
| "conferenceRoomBookings"
| "meetingRoomBookings"
| "phoneBoothBookings"
| "stationBookings"
| "studioBookings"
| "hotDeskBookings"
| "dedicatedDeskBookings"
| "parkingBookings"
| "equipmentBookings"
| "eventTickets"
| "shopProducts"
| "packages"
| "subscriptionItems"
)[];
type?: | "subscriptionItems"
| "creditPackages"
| "desks"
| "equipment"
| "events"
| "products"
| "rooms";
}[];
nextPageToken?: string;
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createCoupon
createCoupon: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
coupon: {
amountOff?: number;
duration?: "once"
| "forever"
| "repeating";
durationInMonths?: number;
enabledForCredits?: boolean;
limitedItems: {
enabled: boolean;
values: {
id: string;
type:
| "roomBookings"
| "eventSpaceBookings"
| "conferenceRoomBookings"
| "meetingRoomBookings"
| "phoneBoothBookings"
| "stationBookings"
| "studioBookings"
| "hotDeskBookings"
| "dedicatedDeskBookings"
| "parkingBookings"
| "equipmentBookings"
| "eventTickets"
| "shopProducts"
| "packages"
| "subscriptionItems";
}[];
};
limitedRedemption: { enabled: boolean; value: number };
locationRef: string;
percentOff?: number;
productTypes: (
| "roomBookings"
| "eventSpaceBookings"
| "conferenceRoomBookings"
| "meetingRoomBookings"
| "phoneBoothBookings"
| "stationBookings"
| "studioBookings"
| "hotDeskBookings"
| "dedicatedDeskBookings"
| "parkingBookings"
| "equipmentBookings"
| "eventTickets"
| "shopProducts"
| "packages"
| "subscriptionItems"
)[];
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
coupon?: {
amountOff?: number | null;
createDate?: string;
currencyCode?: string | null;
deleteDate?: string;
duration?: "once" | "forever" | "repeating" | null;
durationInMonths?: number | null;
enabledForCredits?: boolean | null;
id: string;
limitedItems: {
enabled: boolean;
values: {
id: string;
title?: (...) | (...);
type:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
};
limitedRedemption: { enabled: boolean; usage: number; value: number };
locationRef?: string;
networkRef?: string;
percentOff?: number | null;
productTypes: (
| "roomBookings"
| "eventSpaceBookings"
| "conferenceRoomBookings"
| "meetingRoomBookings"
| "phoneBoothBookings"
| "stationBookings"
| "studioBookings"
| "hotDeskBookings"
| "dedicatedDeskBookings"
| "parkingBookings"
| "equipmentBookings"
| "eventTickets"
| "shopProducts"
| "packages"
| "subscriptionItems"
)[];
type?: | "subscriptionItems"
| "creditPackages"
| "desks"
| "equipment"
| "events"
| "products"
| "rooms";
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getCoupon
getCoupon: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
coupon?: {
amountOff?: number | null;
createDate?: string;
currencyCode?: string | null;
deleteDate?: string;
duration?: "once" | "forever" | "repeating" | null;
durationInMonths?: number | null;
enabledForCredits?: boolean | null;
id: string;
limitedItems: {
enabled: boolean;
values: {
id: string;
title?: (...) | (...);
type:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
}[];
};
limitedRedemption: { enabled: boolean; usage: number; value: number };
locationRef?: string;
networkRef?: string;
percentOff?: number | null;
productTypes: (
| "roomBookings"
| "eventSpaceBookings"
| "conferenceRoomBookings"
| "meetingRoomBookings"
| "phoneBoothBookings"
| "stationBookings"
| "studioBookings"
| "hotDeskBookings"
| "dedicatedDeskBookings"
| "parkingBookings"
| "equipmentBookings"
| "eventTickets"
| "shopProducts"
| "packages"
| "subscriptionItems"
)[];
type?: | "subscriptionItems"
| "creditPackages"
| "desks"
| "equipment"
| "events"
| "products"
| "rooms";
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deleteCoupon
deleteCoupon: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
updateCoupon
updateCoupon: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
coupon: {
limitedItems: {
values: {
id: string;
type: | "roomBookings"
| "eventSpaceBookings"
| "conferenceRoomBookings"
| "meetingRoomBookings"
| "phoneBoothBookings"
| "stationBookings"
| "studioBookings"
| "hotDeskBookings"
| "dedicatedDeskBookings"
| "parkingBookings"
| "equipmentBookings"
| "eventTickets"
| "shopProducts"
| "packages"
| "subscriptionItems";
}[];
};
};
};
};
};
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getPromocodes: {
parameters: {
query?: { locationRef?: string; couponRef?: string };
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
promocodes?: {
archiveDate?: string;
code: string;
couponRef: string;
createDate: string;
expiration: { date?: string; enabled: boolean };
id: string;
limitByFirstPurchase: boolean;
limitedRedemption: { enabled: boolean; usage: number; value: number };
locationRef: string;
networkRef: string;
}[];
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createPromocode: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
promocode: {
code: string;
couponRef: string;
expiration: { date?: string; enabled: boolean };
limitByFirstPurchase: boolean;
limitedRedemption: { enabled: boolean; value: number };
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
promocode?: {
archiveDate?: string;
code: string;
couponRef: string;
createDate: string;
expiration: { date?: string; enabled: boolean };
id: string;
limitByFirstPurchase: boolean;
limitedRedemption: { enabled: boolean; usage: number; value: number };
locationRef: string;
networkRef: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getPromocode: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
promocode?: {
archiveDate?: string;
code: string;
couponRef: string;
createDate: string;
expiration: { date?: string; enabled: boolean };
id: string;
limitByFirstPurchase: boolean;
limitedRedemption: { enabled: boolean; usage: number; value: number };
locationRef: string;
networkRef: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
archivePromocode: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
promocode?: {
archiveDate?: string;
code: string;
couponRef: string;
createDate: string;
expiration: { date?: string; enabled: boolean };
id: string;
limitByFirstPurchase: boolean;
limitedRedemption: { enabled: boolean; usage: number; value: number };
locationRef: string;
networkRef: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getDiscountRedemptions
getDiscountRedemptions: {
parameters: {
query?: {
couponRef?: string;
promocodeRef?: string;
limit?: number;
nextPageToken?: string;
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
redemptions?: {
coupon: {
amountOff?: number | null;
currencyCode?: string | null;
enabledForCredits?: boolean | null;
id: string;
limitedItems: { enabled: boolean; values: (...)[] };
limitedRedemption: { enabled: boolean; usage: number; value: number };
percentOff?: number | null;
productTypes?: (...)[];
type?:
| "subscriptionItems"
| "creditPackages"
| "desks"
| "equipment"
| "events"
| "products"
| "rooms";
};
createDate: string;
customer: {
id: string;
title?: string
| null;
type: "company" | "user";
user?: { id: ...; name: ...; photoUrl: ...; surname: ... };
};
locationRef: string;
networkRef: string;
product: {
bookingRef?: string
| null;
creditPackageRef?: string | null;
eventTicketRef?: string | null;
optionRef?: string | null;
orderRef?: string | null;
subscriptionItemRef?: string | null;
title?: string | null;
type?:
| "creditPackage"
| "booking"
| "eventTicket"
| "order"
| "subscriptionItem"
| null;
};
promocode?: {
code: string;
expiration: { date?: ...; enabled: ... };
id: string;
limitByFirstPurchase: boolean;
limitedRedemption: { enabled: ...; usage: ...; value: ... };
};
promocodeRef?: string
| null;
}[];
nextPageToken?: string;
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getEventsByOrganization
getEventsByOrganization: {
parameters: {
query: {
locationRef: string;
limit?: number;
nextPageToken?: string;
order?: string;
};
header?: undefined;
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
events?: {
applicationType?: "none" | "purchase";
attendees?: number;
cancelDate?: string;
confirmationEmail: { enabled: boolean; template?: string | null };
createDate: string;
customTax: { enabled: boolean; rate: number };
deleteDate?: string;
description?: string;
endDate: string;
id: string;
imageUrl?: string;
joined?: boolean;
limitedAttendees: { enabled: boolean; limit: number };
locale?: string;
location: { id: string; timezoneId: string; title: string };
locationRef: string;
media: { key?: (...) | (...); url?: (...) | (...) }[];
networkRef: string;
price: {
credits: {
amount: number;
amountDiscounted?: (...) | (...);
enabled: boolean;
};
money: {
amount: number;
amountDiscounted?: (...)
| (...);
enabled: boolean;
};
};
refundThreshold?: | "noRefund"
| "zeroMinutes"
| "fifteenMinutes"
| "thirtyMinutes"
| "oneHour"
| "twoHours"
| "fourHours"
| "sixHours"
| "twelveHours"
| "oneDay"
| "twoDays"
| "oneWeek"
| "twoWeeks"
| "fourWeeks";
showAttendees: boolean;
startDate: string;
ticketAvailability: "soldOut"
| "limited"
| "available";
title: string;
venue?: string | null;
visibility?: "public" | "admins" | "members" | "networkMembers";
}[];
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createEvent
createEvent: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
event: {
applicationType: "none"
| "purchase";
confirmationEmail?: { enabled: boolean; template?: string };
customTax?: { enabled: boolean; rate: number };
description?: string;
endDate: string;
limitedAttendees?: { enabled: boolean; limit?: number };
locationRef: string;
media?: { key?: string; url?: string }[];
price?: {
credits?: { amount: number; enabled: boolean };
money?: { amount: number; enabled: boolean };
};
refundThreshold?: | "noRefund"
| "zeroMinutes"
| "fifteenMinutes"
| "thirtyMinutes"
| "oneHour"
| "twoHours"
| "fourHours"
| "sixHours"
| "twelveHours"
| "oneDay"
| "twoDays"
| "oneWeek"
| "twoWeeks"
| "fourWeeks";
showAttendees?: boolean;
startDate: string;
title: string;
venue?: string;
visibility?: "public"
| "admins"
| "members"
| "networkMembers";
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
event?: {
applicationType?: "none" | "purchase";
attendees?: number;
cancelDate?: string;
confirmationEmail: { enabled: boolean; template?: string | null };
createDate: string;
customTax: { enabled: boolean; rate: number };
deleteDate?: string;
description?: string;
endDate: string;
id: string;
imageUrl?: string;
joined?: boolean;
limitedAttendees: { enabled: boolean; limit: number };
locale?: string;
location: { id: string; timezoneId: string; title: string };
locationRef: string;
media: { key?: string; url?: string }[];
networkRef: string;
price: {
credits: {
amount: number;
amountDiscounted?: number;
enabled: boolean;
};
money: {
amount: number;
amountDiscounted?: number;
enabled: boolean;
};
};
refundThreshold?: | "noRefund"
| "zeroMinutes"
| "fifteenMinutes"
| "thirtyMinutes"
| "oneHour"
| "twoHours"
| "fourHours"
| "sixHours"
| "twelveHours"
| "oneDay"
| "twoDays"
| "oneWeek"
| "twoWeeks"
| "fourWeeks";
showAttendees: boolean;
startDate: string;
ticketAvailability: "soldOut"
| "limited"
| "available";
title: string;
venue?: string | null;
visibility?: "public" | "admins" | "members" | "networkMembers";
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getEvent
getEvent: {
parameters: {
query?: undefined;
header: { "spacebring-network-id": string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
event?: {
applicationType?: "none" | "purchase";
attendees?: number;
cancelDate?: string;
confirmationEmail: { enabled: boolean; template?: string | null };
createDate: string;
customTax: { enabled: boolean; rate: number };
deleteDate?: string;
description?: string;
endDate: string;
id: string;
imageUrl?: string;
joined?: boolean;
limitedAttendees: { enabled: boolean; limit: number };
locale?: string;
location: { id: string; timezoneId: string; title: string };
locationRef: string;
media: { key?: string; url?: string }[];
networkRef: string;
price: {
credits: {
amount: number;
amountDiscounted?: number;
enabled: boolean;
};
money: {
amount: number;
amountDiscounted?: number;
enabled: boolean;
};
};
refundThreshold?: | "noRefund"
| "zeroMinutes"
| "fifteenMinutes"
| "thirtyMinutes"
| "oneHour"
| "twoHours"
| "fourHours"
| "sixHours"
| "twelveHours"
| "oneDay"
| "twoDays"
| "oneWeek"
| "twoWeeks"
| "fourWeeks";
showAttendees: boolean;
startDate: string;
ticketAvailability: "soldOut"
| "limited"
| "available";
title: string;
venue?: string | null;
visibility?: "public" | "admins" | "members" | "networkMembers";
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
updateEvent
updateEvent: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
event: {
applicationType: "none"
| "purchase";
confirmationEmail?: { enabled: boolean; template?: string };
customTax?: { enabled: boolean; rate: number };
description?: string;
endDate: string;
limitedAttendees?: { enabled: boolean; limit?: number };
locationRef: string;
media?: { key?: string; url?: string }[];
price?: {
credits?: { amount: number; enabled: boolean };
money?: { amount: number; enabled: boolean };
};
refundThreshold?: | "noRefund"
| "zeroMinutes"
| "fifteenMinutes"
| "thirtyMinutes"
| "oneHour"
| "twoHours"
| "fourHours"
| "sixHours"
| "twelveHours"
| "oneDay"
| "twoDays"
| "oneWeek"
| "twoWeeks"
| "fourWeeks";
showAttendees?: boolean;
startDate: string;
title: string;
venue?: string;
visibility?: "public"
| "admins"
| "members"
| "networkMembers";
};
};
};
};
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
event?: {
applicationType?: "none" | "purchase";
attendees?: number;
cancelDate?: string;
confirmationEmail: { enabled: boolean; template?: string | null };
createDate: string;
customTax: { enabled: boolean; rate: number };
deleteDate?: string;
description?: string;
endDate: string;
id: string;
imageUrl?: string;
joined?: boolean;
limitedAttendees: { enabled: boolean; limit: number };
locale?: string;
location: { id: string; timezoneId: string; title: string };
locationRef: string;
media: { key?: string; url?: string }[];
networkRef: string;
price: {
credits: {
amount: number;
amountDiscounted?: number;
enabled: boolean;
};
money: {
amount: number;
amountDiscounted?: number;
enabled: boolean;
};
};
refundThreshold?: | "noRefund"
| "zeroMinutes"
| "fifteenMinutes"
| "thirtyMinutes"
| "oneHour"
| "twoHours"
| "fourHours"
| "sixHours"
| "twelveHours"
| "oneDay"
| "twoDays"
| "oneWeek"
| "twoWeeks"
| "fourWeeks";
showAttendees: boolean;
startDate: string;
ticketAvailability: "soldOut"
| "limited"
| "available";
title: string;
venue?: string | null;
visibility?: "public" | "admins" | "members" | "networkMembers";
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deleteEvent
deleteEvent: {
parameters: {
query?: undefined;
header?: undefined;
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
cancelEvent
cancelEvent: {
parameters: {
query?: undefined;
header?: undefined;
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
event?: {
applicationType?: "none" | "purchase";
attendees?: number;
cancelDate?: string;
confirmationEmail: { enabled: boolean; template?: string | null };
createDate: string;
customTax: { enabled: boolean; rate: number };
deleteDate?: string;
description?: string;
endDate: string;
id: string;
imageUrl?: string;
joined?: boolean;
limitedAttendees: { enabled: boolean; limit: number };
locale?: string;
location: { id: string; timezoneId: string; title: string };
locationRef: string;
media: { key?: string; url?: string }[];
networkRef: string;
price: {
credits: {
amount: number;
amountDiscounted?: number;
enabled: boolean;
};
money: {
amount: number;
amountDiscounted?: number;
enabled: boolean;
};
};
refundThreshold?: | "noRefund"
| "zeroMinutes"
| "fifteenMinutes"
| "thirtyMinutes"
| "oneHour"
| "twoHours"
| "fourHours"
| "sixHours"
| "twelveHours"
| "oneDay"
| "twoDays"
| "oneWeek"
| "twoWeeks"
| "fourWeeks";
showAttendees: boolean;
startDate: string;
ticketAvailability: "soldOut"
| "limited"
| "available";
title: string;
venue?: string | null;
visibility?: "public" | "admins" | "members" | "networkMembers";
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
copyEvent
copyEvent: {
parameters: {
query?: undefined;
header?: undefined;
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
event?: {
applicationType?: "none" | "purchase";
attendees?: number;
cancelDate?: string;
confirmationEmail: { enabled: boolean; template?: string | null };
createDate: string;
customTax: { enabled: boolean; rate: number };
deleteDate?: string;
description?: string;
endDate: string;
id: string;
imageUrl?: string;
joined?: boolean;
limitedAttendees: { enabled: boolean; limit: number };
locale?: string;
location: { id: string; timezoneId: string; title: string };
locationRef: string;
media: { key?: string; url?: string }[];
networkRef: string;
price: {
credits: {
amount: number;
amountDiscounted?: number;
enabled: boolean;
};
money: {
amount: number;
amountDiscounted?: number;
enabled: boolean;
};
};
refundThreshold?: | "noRefund"
| "zeroMinutes"
| "fifteenMinutes"
| "thirtyMinutes"
| "oneHour"
| "twoHours"
| "fourHours"
| "sixHours"
| "twelveHours"
| "oneDay"
| "twoDays"
| "oneWeek"
| "twoWeeks"
| "fourWeeks";
showAttendees: boolean;
startDate: string;
ticketAvailability: "soldOut"
| "limited"
| "available";
title: string;
venue?: string | null;
visibility?: "public" | "admins" | "members" | "networkMembers";
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
addEventHosts
addEventHosts: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": { tickets: { membershipRef: string }[] };
};
};
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
tickets?: {
checkInDate?: string;
createDate: string;
deleteDate?: string;
event: {
endDate: string;
id: string;
location: { id: string; timezoneId: string; title: string };
media: { key?: ...; url?: ... }[];
startDate: string;
title: string;
venue?: string;
visibilityType?: "public" | "admins" | "members" | "networkMembers";
};
id: string;
locationRef: string;
membershipRef?: string;
payment?: {
createDate?: (...)
| (...);
discounts: (...)[];
dispute?: (...) | (...);
invoiceItemRef?: (...) | (...);
method: {
credits?: ...;
external?: ...;
invoice?: ...;
paymentGateway?: ...;
type: ...;
};
price: { credits?: ...; money?: ...; type: ... };
refund?: (...) | (...);
refundable: boolean;
refunds?: (...) | (...);
request?: (...) | (...);
status: (...) | (...) | (...) | (...) | (...);
surcharge?: (...) | (...);
transactionRef?: (...) | (...);
type:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
};
quantity: number;
role: "attendee"
| "host";
user: {
about?: string | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
}[];
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getEventTickets
getEventTickets: {
parameters: {
query?: {
customerRef?: string;
eventRef?: string;
includeDeleted?: string;
limit?: number;
locationRef?: string;
nextPageToken?: string;
status?: string;
userRef?: string;
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
tickets?: {
checkInDate?: string;
createDate: string;
deleteDate?: string;
event: {
endDate: string;
id: string;
location: { id: string; timezoneId: string; title: string };
media: { key?: ...; url?: ... }[];
startDate: string;
title: string;
venue?: string;
visibilityType?: "public" | "admins" | "members" | "networkMembers";
};
id: string;
locationRef: string;
membershipRef?: string;
payment?: {
createDate?: (...)
| (...);
discounts: (...)[];
dispute?: (...) | (...);
invoiceItemRef?: (...) | (...);
method: {
credits?: ...;
external?: ...;
invoice?: ...;
paymentGateway?: ...;
type: ...;
};
price: { credits?: ...; money?: ...; type: ... };
refund?: (...) | (...);
refundable: boolean;
refunds?: (...) | (...);
request?: (...) | (...);
status: (...) | (...) | (...) | (...) | (...);
surcharge?: (...) | (...);
transactionRef?: (...) | (...);
type:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
};
quantity: number;
role: "attendee"
| "host";
user: {
about?: string | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
}[];
nextPageToken?: string;
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getEventTicket
getEventTicket: {
parameters: {
query?: undefined;
header?: undefined;
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
ticket?: {
checkInDate?: string;
createDate: string;
deleteDate?: string;
event: {
endDate: string;
id: string;
location: { id: string; timezoneId: string; title: string };
media: { key?: (...) | (...); url?: (...) | (...) }[];
startDate: string;
title: string;
venue?: string;
visibilityType?: "public" | "admins" | "members" | "networkMembers";
};
id: string;
locationRef: string;
membershipRef?: string;
payment?: {
createDate?: string;
discounts: { coupon?: ...; promocode?: ...; subscriptionId?: ... }[];
dispute?: { createDate: ... };
invoiceItemRef?: string;
method: {
credits?: (...) | (...);
external?: (...) | (...);
invoice?: (...) | (...);
paymentGateway?: (...) | (...);
type: (...) | (...) | (...) | (...);
};
price: {
credits?: (...)
| (...);
money?: (...) | (...);
type: (...) | (...);
};
refund?: { credits?: ...; money?: ...; transactionRef?: ... };
refundable: boolean;
refunds?: { credits?: ...; money?: ...; type: ... };
request?: { id: ...; url: ... };
status:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
surcharge?: { money: ...; type: ... };
transactionRef?: string;
type:
| "external"
| "invoice"
| "credits"
| "authorizenet"
| "flow"
| "fondy"
| "freedompay"
| "kakaopay"
| "maya"
| "mercadopago"
| "mollie"
| "paypal"
| "paystack"
| "payway"
| "plata"
| "stripe"
| "tap"
| "wayforpay"
| "xendit";
};
quantity: number;
role: "attendee"
| "host";
user: {
about?: string | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
updateEventTicket
updateEventTicket: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": { ticket: { role: "attendee"
| "host" } };
};
};
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
ticket?: {
checkInDate?: string;
createDate: string;
deleteDate?: string;
event: {
endDate: string;
id: string;
location: { id: string; timezoneId: string; title: string };
media: { key?: (...) | (...); url?: (...) | (...) }[];
startDate: string;
title: string;
venue?: string;
visibilityType?: "public" | "admins" | "members" | "networkMembers";
};
id: string;
locationRef: string;
membershipRef?: string;
payment?: {
createDate?: string;
discounts: { coupon?: ...; promocode?: ...; subscriptionId?: ... }[];
dispute?: { createDate: ... };
invoiceItemRef?: string;
method: {
credits?: (...) | (...);
external?: (...) | (...);
invoice?: (...) | (...);
paymentGateway?: (...) | (...);
type: (...) | (...) | (...) | (...);
};
price: {
credits?: (...)
| (...);
money?: (...) | (...);
type: (...) | (...);
};
refund?: { credits?: ...; money?: ...; transactionRef?: ... };
refundable: boolean;
refunds?: { credits?: ...; money?: ...; type: ... };
request?: { id: ...; url: ... };
status:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
surcharge?: { money: ...; type: ... };
transactionRef?: string;
type:
| "external"
| "invoice"
| "credits"
| "authorizenet"
| "flow"
| "fondy"
| "freedompay"
| "kakaopay"
| "maya"
| "mercadopago"
| "mollie"
| "paypal"
| "paystack"
| "payway"
| "plata"
| "stripe"
| "tap"
| "wayforpay"
| "xendit";
};
quantity: number;
role: "attendee"
| "host";
user: {
about?: string | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deleteEventTicket
deleteEventTicket: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
ticket?: {
checkInDate?: string;
createDate: string;
deleteDate?: string;
event: {
endDate: string;
id: string;
location: { id: string; timezoneId: string; title: string };
media: { key?: (...) | (...); url?: (...) | (...) }[];
startDate: string;
title: string;
venue?: string;
visibilityType?: "public" | "admins" | "members" | "networkMembers";
};
id: string;
locationRef: string;
membershipRef?: string;
payment?: {
createDate?: string;
discounts: { coupon?: ...; promocode?: ...; subscriptionId?: ... }[];
dispute?: { createDate: ... };
invoiceItemRef?: string;
method: {
credits?: (...) | (...);
external?: (...) | (...);
invoice?: (...) | (...);
paymentGateway?: (...) | (...);
type: (...) | (...) | (...) | (...);
};
price: {
credits?: (...)
| (...);
money?: (...) | (...);
type: (...) | (...);
};
refund?: { credits?: ...; money?: ...; transactionRef?: ... };
refundable: boolean;
refunds?: { credits?: ...; money?: ...; type: ... };
request?: { id: ...; url: ... };
status:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
surcharge?: { money: ...; type: ... };
transactionRef?: string;
type:
| "external"
| "invoice"
| "credits"
| "authorizenet"
| "flow"
| "fondy"
| "freedompay"
| "kakaopay"
| "maya"
| "mercadopago"
| "mollie"
| "paypal"
| "paystack"
| "payway"
| "plata"
| "stripe"
| "tap"
| "wayforpay"
| "xendit";
};
quantity: number;
role: "attendee"
| "host";
user: {
about?: string | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
checkInEventTicket
checkInEventTicket: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
ticket?: {
checkInDate?: string;
createDate: string;
deleteDate?: string;
event: {
endDate: string;
id: string;
location: { id: string; timezoneId: string; title: string };
media: { key?: (...) | (...); url?: (...) | (...) }[];
startDate: string;
title: string;
venue?: string;
visibilityType?: "public" | "admins" | "members" | "networkMembers";
};
id: string;
locationRef: string;
membershipRef?: string;
payment?: {
createDate?: string;
discounts: { coupon?: ...; promocode?: ...; subscriptionId?: ... }[];
dispute?: { createDate: ... };
invoiceItemRef?: string;
method: {
credits?: (...) | (...);
external?: (...) | (...);
invoice?: (...) | (...);
paymentGateway?: (...) | (...);
type: (...) | (...) | (...) | (...);
};
price: {
credits?: (...)
| (...);
money?: (...) | (...);
type: (...) | (...);
};
refund?: { credits?: ...; money?: ...; transactionRef?: ... };
refundable: boolean;
refunds?: { credits?: ...; money?: ...; type: ... };
request?: { id: ...; url: ... };
status:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
surcharge?: { money: ...; type: ... };
transactionRef?: string;
type:
| "external"
| "invoice"
| "credits"
| "authorizenet"
| "flow"
| "fondy"
| "freedompay"
| "kakaopay"
| "maya"
| "mercadopago"
| "mollie"
| "paypal"
| "paystack"
| "payway"
| "plata"
| "stripe"
| "tap"
| "wayforpay"
| "xendit";
};
quantity: number;
role: "attendee"
| "host";
user: {
about?: string | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getFeedPosts
getFeedPosts: {
parameters: {
query: { locationRef: string; nextPageToken?: string; limit?: number };
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
nextPageToken?: string;
posts?: {
comments: number;
createDate: string;
deleteDate?: string;
id: string;
liked?: boolean;
likes: number;
locale?: string;
locationRef: string;
media: {
height: number;
id: string;
key: string;
mime: string;
url: string;
width: number;
}[];
membership: {
id: string;
user?: {
about?: ...;
deleteDate?: ...;
email?: ...;
id: ...;
name?: ...;
phoneNumber?: ...;
photoUrl?: ...;
surname?: ...;
};
};
membershipRef: string;
og?: {
description?: (...)
| (...)
| (...);
image?: (...) | (...) | (...);
title?: (...) | (...) | (...);
type?: (...) | (...) | (...);
url: string;
videoUrl?: (...) | (...) | (...);
};
pinned: boolean;
text?: string;
user?: {
about?: (...)
| (...)
| (...);
deleteDate?: (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
}[];
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createFeedPost
createFeedPost: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
post: {
locationRef: string;
media?: { key: string }[];
og?: {
description?: string | null;
image?: string | null;
title?: string | null;
type?: string | null;
url: string;
videoUrl?: string | null;
};
text?: string;
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
post?: {
comments: number;
createDate: string;
deleteDate?: string;
id: string;
liked?: boolean;
likes: number;
locale?: string;
locationRef: string;
media: {
height: number;
id: string;
key: string;
mime: string;
url: string;
width: number;
}[];
membership: {
id: string;
user?: {
about?: (...)
| (...)
| (...);
deleteDate?: (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
membershipRef: string;
og?: {
description?: string
| null;
image?: string | null;
title?: string | null;
type?: string | null;
url: string;
videoUrl?: string | null;
};
pinned: boolean;
text?: string;
user?: {
about?: string
| null;
deleteDate?: string;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getFeedPost
getFeedPost: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
post?: {
comments: number;
createDate: string;
deleteDate?: string;
id: string;
liked?: boolean;
likes: number;
locale?: string;
locationRef: string;
media: {
height: number;
id: string;
key: string;
mime: string;
url: string;
width: number;
}[];
membership: {
id: string;
user?: {
about?: (...)
| (...)
| (...);
deleteDate?: (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
membershipRef: string;
og?: {
description?: string
| null;
image?: string | null;
title?: string | null;
type?: string | null;
url: string;
videoUrl?: string | null;
};
pinned: boolean;
text?: string;
user?: {
about?: string
| null;
deleteDate?: string;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
updateFeedPost
updateFeedPost: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
post: {
media?: { key: string }[];
og?: {
description?: string | null;
image?: string | null;
title?: string | null;
type?: string | null;
url: string;
videoUrl?: string | null;
};
text?: string;
};
};
};
};
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
post?: {
comments: number;
createDate: string;
deleteDate?: string;
id: string;
liked?: boolean;
likes: number;
locale?: string;
locationRef: string;
media: {
height: number;
id: string;
key: string;
mime: string;
url: string;
width: number;
}[];
membership: {
id: string;
user?: {
about?: (...)
| (...)
| (...);
deleteDate?: (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
membershipRef: string;
og?: {
description?: string
| null;
image?: string | null;
title?: string | null;
type?: string | null;
url: string;
videoUrl?: string | null;
};
pinned: boolean;
text?: string;
user?: {
about?: string
| null;
deleteDate?: string;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deleteFeedPost
deleteFeedPost: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getPostComments: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
comments?: {
createDate: string;
id: string;
liked?: boolean;
likes: number;
membership: {
id: string;
user?: {
deleteDate?: ...;
id: ...;
name?: ...;
photoUrl?: ...;
surname?: ...;
};
};
mentions?: { id: ...; value: ... }[];
parentCommentRef?: string;
postRef: string;
text: string;
}[];
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getLikesForPost
getLikesForPost: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
likes?: {
commentRef?: string;
createDate: string;
id: string;
membership: {
id: string;
user?: {
deleteDate?: ...;
id: ...;
name?: ...;
photoUrl?: ...;
surname?: ...;
};
};
postRef: string;
}[];
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createLikeForPost
createLikeForPost: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
like?: {
commentRef?: string;
createDate: string;
id: string;
membership: {
id: string;
user?: {
deleteDate?: (...) | (...);
id: string;
name?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
postRef: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deleteLikeForPost
deleteLikeForPost: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createFeedPostComment: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
comment: {
parentCommentRef?: string;
postRef: string;
text: string;
type: "comment";
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
comment?: {
createDate: string;
id: string;
liked?: boolean;
likes: number;
membership: {
id: string;
user?: {
deleteDate?: (...) | (...);
id: string;
name?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
mentions?: { id: string; value: string }[];
parentCommentRef?: string;
postRef: string;
text: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deletePostComment: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": { headers: { [name: string]: unknown }; content?: undefined };
};
}
createLikeForPostComment: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
like?: {
commentRef?: string;
createDate: string;
id: string;
membership: {
id: string;
user?: {
deleteDate?: (...) | (...);
id: string;
name?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
postRef: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deleteLikeForPostComment: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getFloors
getFloors: {
parameters: {
query: { limit?: number; locationRef: string; nextPageToken?: string };
header?: undefined;
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
floors?: {
createDate: string;
id: string;
locationRef: string;
mappings: { [key: string]: string[] };
plan: { [key: string]: unknown };
title: string;
visibility: "public" | "admins" | "members" | "networkMembers";
}[];
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deleteFloor
deleteFloor: {
parameters: {
query?: undefined;
header?: undefined;
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getGuides
getGuides: {
parameters: {
query: { limit?: number; locationRef: string; nextPageToken?: string };
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
guides: {
attachments: {
key: string;
mime: string;
name: string;
size?: number;
url: string;
}[];
createDate: string;
description?: string;
id: string;
locale?: string;
locationRef: string;
media: {
height?: number;
key: string;
mime?: string;
url: string;
width?: number;
}[];
title: string;
visibility: "public"
| "admins"
| "members"
| "networkMembers";
}[];
nextPageToken?: string;
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
"404": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createGuide
createGuide: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
guide: {
description?: string;
locationRef: string;
title: string;
visibility: "public"
| "admins"
| "members"
| "networkMembers";
attachments?: { key: string }[];
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
guide?: {
attachments: {
key: string;
mime: string;
name: string;
size?: number;
url: string;
}[];
createDate: string;
description?: string;
id: string;
locale?: string;
locationRef: string;
media: {
height?: number;
key: string;
mime?: string;
url: string;
width?: number;
}[];
title: string;
visibility: "public"
| "admins"
| "members"
| "networkMembers";
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
"403": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getGuide
getGuide: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { guideId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
guide: {
attachments: {
key: string;
mime: string;
name: string;
size?: number;
url: string;
}[];
createDate: string;
description?: string;
id: string;
locale?: string;
locationRef: string;
media: {
height?: number;
key: string;
mime?: string;
url: string;
width?: number;
}[];
title: string;
visibility: "public"
| "admins"
| "members"
| "networkMembers";
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
"403": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
"404": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deleteGuide
deleteGuide: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { guideId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
"403": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
"404": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
patchGuide
patchGuide: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { guideId: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
guide: {
description?: string;
title?: string;
visibility?: "public"
| "admins"
| "members"
| "networkMembers";
attachments?: { key: string }[];
};
};
};
};
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
guide?: {
attachments: {
key: string;
mime: string;
name: string;
size?: number;
url: string;
}[];
createDate: string;
description?: string;
id: string;
locale?: string;
locationRef: string;
media: {
height?: number;
key: string;
mime?: string;
url: string;
width?: number;
}[];
title: string;
visibility: "public"
| "admins"
| "members"
| "networkMembers";
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
"403": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
"404": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getLocations
getLocations: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
locations?: {
address?: string;
createDate?: string;
currencyCode?: string;
description?: string;
email?: string;
id?: string;
locale?: "en" | "es" | "ko" | "uk" | "ru";
networkRef?: string;
timezoneId?: string;
title?: string;
}[];
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getLocation
getLocation: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { locationId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
location?: {
address?: string;
createDate?: string;
currencyCode?: string;
description?: string;
email?: string;
id?: string;
locale?: "en" | "es" | "ko" | "uk" | "ru";
networkRef?: string;
timezoneId?: string;
title?: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getNetworks
getNetworks: {
parameters: {
query?: undefined;
header?: undefined;
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": { networks?: { id?: string; title?: string }[] };
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getPackages
getPackages: {
parameters: {
query: { limit?: number; locationRef: string; nextPageToken?: string };
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
nextPageToken?: string;
packages: {
amount: number;
duration?: 30 | 90 | 180 | 365;
grants: {
amount: number;
duration?: 30 | 90 | 180 | 365;
id: string;
type: "credits" | "dayPasses";
}[];
id: string;
locationRef: string;
networkRef: string;
organizationRef: string;
price: number;
priceDiscounted: number;
}[];
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createPackage
createPackage: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
package: {
grants: {
amount: number;
duration?: 30
| 90
| 180
| 365;
type: "credits" | "dayPasses";
}[];
locationRef: string;
price: number;
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
package: {
amount: number;
duration?: 30 | 90 | 180 | 365;
grants: {
amount: number;
duration?: 30 | 90 | 180 | 365;
id: string;
type: "credits" | "dayPasses";
}[];
id: string;
locationRef: string;
networkRef: string;
organizationRef: string;
price: number;
priceDiscounted: number;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deletePackage
deletePackage: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { packageId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
patchPackage
patchPackage: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { packageId: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
package: {
grants?: {
amount: number;
duration?: 30
| 90
| 180
| 365;
type: "credits" | "dayPasses";
}[];
price?: number;
};
};
};
};
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getPlans
getPlans: {
parameters: {
query?: {
entire?: string;
limit?: number;
locationRef?: string;
nextPageToken?: string;
resourceRef?: string;
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
nextPageToken?: string;
plans: {
access?: {
avigilonAltaGroupRef?: number;
brivoGroupRef?: number;
kisiGroupRef?: number;
saltoksAccessGroupRef?: string;
tapkeyGroupRef?: string;
unifiAccessGroupRef?: string;
};
addons: { id: string }[];
commitmentCycles: number;
createDate: string;
credits: number;
customTax: { enabled: boolean; rate: number };
dayPasses: number;
description: string;
discounts: {
creditPackages: number;
desks: number;
equipment: number;
events: number;
rooms: number;
shop: number;
};
exclusiveAccess: { benefitRefs: string[]; resourceRefs: string[] };
grantedDiscounts: {
coupon: {
amountOff?: (...) | (...);
currencyCode?: (...) | (...);
enabledForCredits?: (...) | (...) | (...);
id: string;
limitedItems?: (...) | (...);
limitedRedemption?: (...) | (...);
percentOff?: (...) | (...);
productTypes?: (...) | (...);
};
}[];
id: string;
locale: string;
locationRef: string;
period: | "day"
| "week"
| "month"
| "threeMonths"
| "sixMonths"
| "year";
price: number;
printing?: { ezeepBlueGroupRef: string };
selfSignup: { enabled: boolean; type: "immediate" | "request" };
setupFee: number;
title: string;
}[];
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createPlan
createPlan: {
parameters: {
query?: undefined;
header?: undefined;
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
plan: {
access?: {
avigilonAltaGroupRef?: number;
brivoGroupRef?: number;
kisiGroupRef?: number;
saltoksAccessGroupRef?: string;
tapkeyGroupRef?: string;
unifiAccessGroupRef?: string;
};
addons?: { id: string }[];
commitmentCycles?: number;
credits?: number;
customTax?: { enabled?: boolean; rate?: number };
dayPasses?: number;
description?: string;
discounts?: {
creditPackages?: number;
desks?: number;
equipment?: number;
events?: number;
rooms?: number;
shop?: number;
};
exclusiveAccess?: { benefitRefs?: string[]; resourceRefs: string[] };
grantedDiscounts?: {
coupon: {
amountOff?: number;
currencyCode?: string;
id: string;
percentOff?: number;
productTypes?: (...)[];
};
}[];
locationRef: string;
period: "day"
| "week"
| "month"
| "threeMonths"
| "sixMonths"
| "year";
price: number;
printing?: { ezeepBlueGroupRef?: string };
selfSignup?: { enabled?: boolean; type?: "immediate" | "request" };
setupFee?: number;
title: string;
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
plan?: {
access?: {
avigilonAltaGroupRef?: number;
brivoGroupRef?: number;
kisiGroupRef?: number;
saltoksAccessGroupRef?: string;
tapkeyGroupRef?: string;
unifiAccessGroupRef?: string;
};
addons: { id: string }[];
commitmentCycles: number;
createDate: string;
credits: number;
customTax: { enabled: boolean; rate: number };
dayPasses: number;
description: string;
discounts: {
creditPackages: number;
desks: number;
equipment: number;
events: number;
rooms: number;
shop: number;
};
exclusiveAccess: { benefitRefs: string[]; resourceRefs: string[] };
grantedDiscounts: {
coupon: {
amountOff?: (...) | (...);
currencyCode?: (...) | (...);
enabledForCredits?: (...) | (...) | (...);
id: string;
limitedItems?: (...) | (...);
limitedRedemption?: (...) | (...);
percentOff?: (...) | (...);
productTypes?: (...) | (...);
};
}[];
id: string;
locale: string;
locationRef: string;
period: | "day"
| "week"
| "month"
| "threeMonths"
| "sixMonths"
| "year";
price: number;
printing?: { ezeepBlueGroupRef: string };
selfSignup: { enabled: boolean; type: "immediate" | "request" };
setupFee: number;
title: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getPlan
getPlan: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { planId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
plan: {
access?: {
avigilonAltaGroupRef?: number;
brivoGroupRef?: number;
kisiGroupRef?: number;
saltoksAccessGroupRef?: string;
tapkeyGroupRef?: string;
unifiAccessGroupRef?: string;
};
addons: { id: string }[];
commitmentCycles: number;
createDate: string;
credits: number;
customTax: { enabled: boolean; rate: number };
dayPasses: number;
description: string;
discounts: {
creditPackages: number;
desks: number;
equipment: number;
events: number;
rooms: number;
shop: number;
};
exclusiveAccess: { benefitRefs: string[]; resourceRefs: string[] };
grantedDiscounts: {
coupon: {
amountOff?: number;
currencyCode?: string;
enabledForCredits?: boolean;
id: string;
limitedItems?: { enabled: ...; values: ... };
limitedRedemption?: { enabled: ...; usage: ...; value: ... };
percentOff?: number;
productTypes?: (...)[];
};
}[];
id: string;
locale: string;
locationRef: string;
period: | "day"
| "week"
| "month"
| "threeMonths"
| "sixMonths"
| "year";
price: number;
printing?: { ezeepBlueGroupRef: string };
selfSignup: { enabled: boolean; type: "immediate" | "request" };
setupFee: number;
title: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deletePlan
deletePlan: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { planId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
updatePlan
updatePlan: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { planId: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
plan: {
access?: {
avigilonAltaGroupRef?: number
| null;
brivoGroupRef?: number | null;
kisiGroupRef?: number | null;
saltoksAccessGroupRef?: string | null;
tapkeyGroupRef?: string | null;
unifiAccessGroupRef?: string | null;
};
addons?: { id: string }[];
commitmentCycles?: number;
credits?: number;
customTax?: { enabled: boolean; rate: number };
dayPasses?: number;
description?: string;
discounts?: {
creditPackages: number;
desks: number;
equipment?: number;
events: number;
rooms: number;
shop: number;
};
exclusiveAccess?: { benefitRefs?: string[]; resourceRefs: string[] };
grantedDiscounts?: {
coupon: {
amountOff?: number;
currencyCode?: string;
id: string;
percentOff?: number;
productTypes?: (...)[];
};
}[];
price?: number;
printing?: { ezeepBlueGroupRef?: string
| null };
selfSignup?: { enabled: boolean; type: "immediate" | "request" };
setupFee?: number;
title?: string;
};
};
};
};
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getRegistrations
getRegistrations: {
parameters: {
query?: { limit?: number; nextPageToken?: string };
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
registrations?: {
blacklisted: boolean;
createDate: string;
customers: {
id: string;
membershipType: (...) | (...) | (...);
organizationRef: string;
}[];
id: string;
lastSeenDate?: string;
locationPermissions?: {
admins: boolean;
allLocations: boolean;
analytics: boolean;
benefits: boolean;
billing: boolean;
bookings: boolean;
customers: boolean;
events: boolean;
exclusiveLocations: (...)[];
feed: boolean;
settings: boolean;
shop: boolean;
support: boolean;
};
role?: "member"
| "admin"
| "owner";
termsConsentDate?: string;
user: {
about?: string | null;
deleteDate?: string | null;
email: string;
id: string;
name: string;
phoneNumber?: string | null;
photoUrl: string | null;
surname?: string | null;
};
}[];
nextPageToken?: string;
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getResources
getResources: {
parameters: {
query: {
limit?: number;
locationRef: string;
nextPageToken?: string;
types?: string;
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
nextPageToken?: string;
resources: {
assignments: {
company?: { id: ...; title: ... };
customer?: { id: ...; title?: ...; type: ...; user?: ... };
endDate?: string;
entire: boolean;
id?: string;
membership?: { id: ... };
quantity?: number;
resource?: {
id: ...;
imageUrl?: ...;
locationRef: ...;
title: ...;
type: ...;
};
resourceRef: string;
startDate: string;
subscription: {
endDate?: (...)
| (...);
id?: (...) | (...);
startDate: string;
};
user?: { email?: ...; id: ...; name?: ...; surname?: ... };
}[];
autoRelease?: {
enabled: boolean;
interval: "fifteenMinutes"
| "fiveMinutes"
| "tenMinutes";
};
avigilonAltaGroupRef?: number
| null;
bookingPermission:
| "public"
| "admins"
| "exclusiveMembers"
| "members"
| "networkMembers";
bookingStepMinutes?: number;
brivoGroupRef?: number
| null;
bufferTime:
| "zeroMinutes"
| "fifteenMinutes"
| "thirtyMinutes"
| "fiveMinutes"
| "tenMinutes"
| "sixtyMinutes";
capacity?: number
| null;
checkIn?: {
interval:
| "zeroMinutes"
| "fifteenMinutes"
| "fiveMinutes"
| "tenMinutes";
};
children: { id: string; title: string }[];
confirmationEmail: {
bookingCreatedByAdmin: boolean;
bookingCreatedByMember: boolean;
bookingCreatedByNetworkMember: boolean;
bookingCreatedByPublic: boolean;
template: string;
};
createDate: string;
credits: {
enabled: boolean;
tiers: { flatAmount: number; from: number; unitAmount: number }[];
};
dayPassesEnabled?: boolean;
description: string;
duration: {
max: number;
min: number;
public: { enabled: boolean; max: number; min: number };
};
dynamicPricing: {
deltaAbove: number;
deltaBelow: number;
enabled: boolean;
};
googleCalendar?: { id: string; twoWaySyncEnabled: boolean };
id: string;
imageUrl?: string;
kisiGroupRef?: number | null;
locale: string;
locationRef: string;
media: { key: string; url?: string }[];
money: {
enabled: boolean;
tiers: { flatAmount: number; from: number; unitAmount: number }[];
};
networkRef: string;
parentRef?: string;
plans?: {
enabled: boolean;
tiers: {
addons: ...;
commitmentCycles: ...;
credits: ...;
dayPasses?: ...;
description?: ...;
discounts?: ...;
entire: ...;
grantedDiscounts: ...;
id: ...;
period: ...;
plan: ...;
price: ...;
selfSignup: ...;
selfSignupType?: ...;
setupFee: ...;
title: ...;
}[];
};
preparationMinutes: | "zeroMinutes"
| "fifteenMinutes"
| "thirtyMinutes"
| "fiveMinutes"
| "tenMinutes"
| "sixtyMinutes";
refundThreshold: | "noRefund"
| "zeroMinutes"
| "fifteenMinutes"
| "thirtyMinutes"
| "oneHour"
| "twoHours"
| "fourHours"
| "sixHours"
| "twelveHours"
| "oneDay"
| "twoDays"
| "oneWeek"
| "twoWeeks"
| "fourWeeks";
saltoksAccessGroupRef?: string
| null;
schedule?: {
default: { closedDays: (...)[]; items: (...)[] };
enabled: boolean;
public: { closedDays: (...)[]; enabled: boolean; items: (...)[] };
};
tapkeyGroupRef?: string
| null;
title: string;
type:
| "equipment"
| "dedicatedDesk"
| "hotDesk"
| "office"
| "parkingLot"
| "room"
| "station"
| "conferenceRoom"
| "eventSpace"
| "meetingRoom"
| "phoneBooth"
| "studio";
unifiAccessGroupRef?: string
| null;
visibility:
| "public"
| "admins"
| "exclusiveMembers"
| "members"
| "networkMembers";
}[];
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createResource
createResource: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
resource: {
autoRelease?: {
enabled: boolean;
interval: "fifteenMinutes"
| "fiveMinutes"
| "tenMinutes";
};
avigilonAltaGroupRef?: number
| null;
bookingPermission?:
| "public"
| "admins"
| "exclusiveMembers"
| "members"
| "networkMembers";
bookingStepMinutes?: number;
brivoGroupRef?: number
| null;
bufferTime?:
| "zeroMinutes"
| "fifteenMinutes"
| "thirtyMinutes"
| "fiveMinutes"
| "tenMinutes"
| "sixtyMinutes";
capacity?: number
| null;
checkIn?: {
interval:
| "zeroMinutes"
| "fifteenMinutes"
| "fiveMinutes"
| "tenMinutes";
};
confirmationEmail?: {
bookingCreatedByAdmin: boolean;
bookingCreatedByMember: boolean;
bookingCreatedByNetworkMember: boolean;
bookingCreatedByPublic: boolean;
template: string;
};
credits?: {
enabled: boolean;
price?: number;
tiers: { flatAmount: number; from: number; unitAmount: number }[];
};
dayPassesEnabled?: boolean;
description?: string;
duration?: {
max: number;
min: number;
public: { enabled: boolean; max: number; min: number };
};
dynamicPricing?: {
deltaAbove: number;
deltaBelow: number;
enabled: boolean;
};
googleCalendar?: { id: string; twoWaySyncEnabled: boolean }
| null;
id?: string;
kisiGroupRef?: number | null;
locationRef: string;
media?: { key: string }[];
money?: {
enabled: boolean;
price?: number;
tiers: { flatAmount: number; from: number; unitAmount: number }[];
};
parentRef?: string
| null;
plans?: {
enabled: boolean;
tiers: {
addons?: (...)[];
commitmentCycles: number;
credits: number;
dayPasses?: number;
description?: string;
discounts?: {
creditPackages?: ...;
desks?: ...;
equipment?: ...;
events?: ...;
rooms?: ...;
shop?: ...;
};
entire: boolean;
ezeepBlueGroupRef?: string;
grantedDiscounts?: (...)[];
id: string;
period:
| "day"
| "week"
| "month"
| "threeMonths"
| "sixMonths"
| "year";
price: number;
selfSignup?: { enabled: ...; type: ... };
selfSignupType?: string;
setupFee?: number;
title: string;
}[];
};
preparationMinutes?: | "zeroMinutes"
| "fifteenMinutes"
| "thirtyMinutes"
| "fiveMinutes"
| "tenMinutes"
| "sixtyMinutes";
refundThreshold?: | "noRefund"
| "zeroMinutes"
| "fifteenMinutes"
| "thirtyMinutes"
| "oneHour"
| "twoHours"
| "fourHours"
| "sixHours"
| "twelveHours"
| "oneDay"
| "twoDays"
| "oneWeek"
| "twoWeeks"
| "fourWeeks";
saltoksAccessGroupRef?: string
| null;
schedule?: {
default: {
closedDays: string[];
items: {
days: {
friday: ...;
monday: ...;
saturday: ...;
sunday: ...;
thursday: ...;
tuesday: ...;
wednesday: ...;
};
hours: { from: ...; to: ... };
}[];
};
enabled: boolean;
public: {
closedDays: string[];
enabled: boolean;
items: {
days: {
friday: ...;
monday: ...;
saturday: ...;
sunday: ...;
thursday: ...;
tuesday: ...;
wednesday: ...;
};
hours: { from: ...; to: ... };
}[];
};
};
tapkeyGroupRef?: string
| null;
unifiAccessGroupRef?: string | null;
title: string;
type:
| "equipment"
| "dedicatedDesk"
| "hotDesk"
| "office"
| "parkingLot"
| "room"
| "station"
| "conferenceRoom"
| "eventSpace"
| "meetingRoom"
| "phoneBooth"
| "studio";
visibility?: | "public"
| "admins"
| "exclusiveMembers"
| "members"
| "networkMembers";
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
resource: {
assignments: {
company?: { id: string; title: string };
customer?: {
id: string;
title?: (...) | (...);
type: (...) | (...);
user?: (...) | (...);
};
endDate?: string;
entire: boolean;
id?: string;
membership?: { id: string };
quantity?: number;
resource?: {
id: string;
imageUrl?: (...) | (...);
locationRef: string;
title: string;
type: string;
};
resourceRef: string;
startDate: string;
subscription: { endDate?: string; id?: string; startDate: string };
user?: {
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
}[];
autoRelease?: {
enabled: boolean;
interval: "fifteenMinutes"
| "fiveMinutes"
| "tenMinutes";
};
avigilonAltaGroupRef?: number
| null;
bookingPermission:
| "public"
| "admins"
| "exclusiveMembers"
| "members"
| "networkMembers";
bookingStepMinutes?: number;
brivoGroupRef?: number
| null;
bufferTime:
| "zeroMinutes"
| "fifteenMinutes"
| "thirtyMinutes"
| "fiveMinutes"
| "tenMinutes"
| "sixtyMinutes";
capacity?: number
| null;
checkIn?: {
interval:
| "zeroMinutes"
| "fifteenMinutes"
| "fiveMinutes"
| "tenMinutes";
};
children: { id: string; title: string }[];
confirmationEmail: {
bookingCreatedByAdmin: boolean;
bookingCreatedByMember: boolean;
bookingCreatedByNetworkMember: boolean;
bookingCreatedByPublic: boolean;
template: string;
};
createDate: string;
credits: {
enabled: boolean;
tiers: { flatAmount: number; from: number; unitAmount: number }[];
};
dayPassesEnabled?: boolean;
description: string;
duration: {
max: number;
min: number;
public: { enabled: boolean; max: number; min: number };
};
dynamicPricing: {
deltaAbove: number;
deltaBelow: number;
enabled: boolean;
};
googleCalendar?: { id: string; twoWaySyncEnabled: boolean };
id: string;
imageUrl?: string;
kisiGroupRef?: number | null;
locale: string;
locationRef: string;
media: { key: string; url?: string }[];
money: {
enabled: boolean;
tiers: { flatAmount: number; from: number; unitAmount: number }[];
};
networkRef: string;
parentRef?: string;
plans?: {
enabled: boolean;
tiers: {
addons: (...)[];
commitmentCycles: number;
credits: number;
dayPasses?: (...) | (...);
description?: (...) | (...);
discounts?: (...) | (...);
entire: boolean;
grantedDiscounts: (...)[];
id: string;
period: (...) | (...) | (...) | (...) | (...) | (...);
plan: {
commitmentCycles: ...;
credits: ...;
dayPasses: ...;
discounts?: ...;
grantedDiscounts: ...;
id: ...;
period: ...;
price: ...;
title: ...;
};
price: number;
selfSignup: { enabled: ...; type: ... };
selfSignupType?: (...) | (...);
setupFee: number;
title: string;
}[];
};
preparationMinutes: | "zeroMinutes"
| "fifteenMinutes"
| "thirtyMinutes"
| "fiveMinutes"
| "tenMinutes"
| "sixtyMinutes";
refundThreshold: | "noRefund"
| "zeroMinutes"
| "fifteenMinutes"
| "thirtyMinutes"
| "oneHour"
| "twoHours"
| "fourHours"
| "sixHours"
| "twelveHours"
| "oneDay"
| "twoDays"
| "oneWeek"
| "twoWeeks"
| "fourWeeks";
saltoksAccessGroupRef?: string
| null;
schedule?: {
default: {
closedDays: string[];
items: { days: ...; hours: ... }[];
};
enabled: boolean;
public: {
closedDays: string[];
enabled: boolean;
items: { days: ...; hours: ... }[];
};
};
tapkeyGroupRef?: string
| null;
title: string;
type:
| "equipment"
| "dedicatedDesk"
| "hotDesk"
| "office"
| "parkingLot"
| "room"
| "station"
| "conferenceRoom"
| "eventSpace"
| "meetingRoom"
| "phoneBooth"
| "studio";
unifiAccessGroupRef?: string
| null;
visibility:
| "public"
| "admins"
| "exclusiveMembers"
| "members"
| "networkMembers";
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
"403": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
"404": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getAssignments
getAssignments: {
parameters: {
query?: { locationRef?: string };
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
assignments: {
company?: { id: string; title: string };
customer?: {
id: string;
title?: string;
type: "company" | "user";
user?: { email?: ...; id: ...; name?: ...; surname?: ... };
};
endDate?: string;
entire: boolean;
id?: string;
membership?: { id: string };
quantity?: number;
resource?: {
id: string;
imageUrl?: string;
locationRef: string;
title: string;
type: string;
};
resourceRef: string;
startDate: string;
subscription: { endDate?: string; id?: string; startDate: string };
user?: {
email?: string | null;
id: string;
name?: string | null;
surname?: string | null;
};
}[];
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
"403": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
"404": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getResource
getResource: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { resourceId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
resource: {
assignments: {
company?: { id: string; title: string };
customer?: {
id: string;
title?: (...) | (...);
type: (...) | (...);
user?: (...) | (...);
};
endDate?: string;
entire: boolean;
id?: string;
membership?: { id: string };
quantity?: number;
resource?: {
id: string;
imageUrl?: (...) | (...);
locationRef: string;
title: string;
type: string;
};
resourceRef: string;
startDate: string;
subscription: { endDate?: string; id?: string; startDate: string };
user?: {
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
}[];
autoRelease?: {
enabled: boolean;
interval: "fifteenMinutes"
| "fiveMinutes"
| "tenMinutes";
};
avigilonAltaGroupRef?: number
| null;
bookingPermission:
| "public"
| "admins"
| "exclusiveMembers"
| "members"
| "networkMembers";
bookingStepMinutes?: number;
brivoGroupRef?: number
| null;
bufferTime:
| "zeroMinutes"
| "fifteenMinutes"
| "thirtyMinutes"
| "fiveMinutes"
| "tenMinutes"
| "sixtyMinutes";
capacity?: number
| null;
checkIn?: {
interval:
| "zeroMinutes"
| "fifteenMinutes"
| "fiveMinutes"
| "tenMinutes";
};
children: { id: string; title: string }[];
confirmationEmail: {
bookingCreatedByAdmin: boolean;
bookingCreatedByMember: boolean;
bookingCreatedByNetworkMember: boolean;
bookingCreatedByPublic: boolean;
template: string;
};
createDate: string;
credits: {
enabled: boolean;
tiers: { flatAmount: number; from: number; unitAmount: number }[];
};
dayPassesEnabled?: boolean;
description: string;
duration: {
max: number;
min: number;
public: { enabled: boolean; max: number; min: number };
};
dynamicPricing: {
deltaAbove: number;
deltaBelow: number;
enabled: boolean;
};
googleCalendar?: { id: string; twoWaySyncEnabled: boolean };
id: string;
imageUrl?: string;
kisiGroupRef?: number | null;
locale: string;
locationRef: string;
media: { key: string; url?: string }[];
money: {
enabled: boolean;
tiers: { flatAmount: number; from: number; unitAmount: number }[];
};
networkRef: string;
parentRef?: string;
plans?: {
enabled: boolean;
tiers: {
addons: (...)[];
commitmentCycles: number;
credits: number;
dayPasses?: (...) | (...);
description?: (...) | (...);
discounts?: (...) | (...);
entire: boolean;
grantedDiscounts: (...)[];
id: string;
period: (...) | (...) | (...) | (...) | (...) | (...);
plan: {
commitmentCycles: ...;
credits: ...;
dayPasses: ...;
discounts?: ...;
grantedDiscounts: ...;
id: ...;
period: ...;
price: ...;
title: ...;
};
price: number;
selfSignup: { enabled: ...; type: ... };
selfSignupType?: (...) | (...);
setupFee: number;
title: string;
}[];
};
preparationMinutes: | "zeroMinutes"
| "fifteenMinutes"
| "thirtyMinutes"
| "fiveMinutes"
| "tenMinutes"
| "sixtyMinutes";
refundThreshold: | "noRefund"
| "zeroMinutes"
| "fifteenMinutes"
| "thirtyMinutes"
| "oneHour"
| "twoHours"
| "fourHours"
| "sixHours"
| "twelveHours"
| "oneDay"
| "twoDays"
| "oneWeek"
| "twoWeeks"
| "fourWeeks";
saltoksAccessGroupRef?: string
| null;
schedule?: {
default: {
closedDays: string[];
items: { days: ...; hours: ... }[];
};
enabled: boolean;
public: {
closedDays: string[];
enabled: boolean;
items: { days: ...; hours: ... }[];
};
};
tapkeyGroupRef?: string
| null;
title: string;
type:
| "equipment"
| "dedicatedDesk"
| "hotDesk"
| "office"
| "parkingLot"
| "room"
| "station"
| "conferenceRoom"
| "eventSpace"
| "meetingRoom"
| "phoneBooth"
| "studio";
unifiAccessGroupRef?: string
| null;
visibility:
| "public"
| "admins"
| "exclusiveMembers"
| "members"
| "networkMembers";
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
patchResource
patchResource: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { resourceId: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
resource: {
autoRelease?: {
enabled: boolean;
interval: "fifteenMinutes"
| "fiveMinutes"
| "tenMinutes";
};
avigilonAltaGroupRef?: number
| null;
bookingPermission?:
| "public"
| "admins"
| "exclusiveMembers"
| "members"
| "networkMembers";
bookingStepMinutes?: number;
brivoGroupRef?: number
| null;
bufferTime?:
| "zeroMinutes"
| "fifteenMinutes"
| "thirtyMinutes"
| "fiveMinutes"
| "tenMinutes"
| "sixtyMinutes";
capacity?: number
| null;
checkIn?: {
interval:
| "zeroMinutes"
| "fifteenMinutes"
| "fiveMinutes"
| "tenMinutes";
};
confirmationEmail?: {
bookingCreatedByAdmin: boolean;
bookingCreatedByMember: boolean;
bookingCreatedByNetworkMember: boolean;
bookingCreatedByPublic: boolean;
template: string;
};
credits?: {
enabled: boolean;
price?: number;
tiers: { flatAmount: number; from: number; unitAmount: number }[];
};
dayPassesEnabled?: boolean;
description?: string;
duration?: {
max: number;
min: number;
public: { enabled: boolean; max: number; min: number };
};
dynamicPricing?: {
deltaAbove: number;
deltaBelow: number;
enabled: boolean;
};
googleCalendar?: { id: string; twoWaySyncEnabled: boolean }
| null;
kisiGroupRef?: number | null;
media?: { key: string }[];
money?: {
enabled: boolean;
price?: number;
tiers: { flatAmount: number; from: number; unitAmount: number }[];
};
parentRef?: string
| null;
plans?: {
enabled: boolean;
tiers: {
addons?: (...)[];
commitmentCycles: number;
credits: number;
dayPasses?: number;
description?: string;
discounts?: {
creditPackages?: ...;
desks?: ...;
equipment?: ...;
events?: ...;
rooms?: ...;
shop?: ...;
};
entire: boolean;
ezeepBlueGroupRef?: string;
grantedDiscounts?: (...)[];
id: string;
period:
| "day"
| "week"
| "month"
| "threeMonths"
| "sixMonths"
| "year";
price: number;
selfSignup?: { enabled: ...; type: ... };
selfSignupType?: string;
setupFee?: number;
title: string;
}[];
};
preparationMinutes?: | "zeroMinutes"
| "fifteenMinutes"
| "thirtyMinutes"
| "fiveMinutes"
| "tenMinutes"
| "sixtyMinutes";
refundThreshold?: | "noRefund"
| "zeroMinutes"
| "fifteenMinutes"
| "thirtyMinutes"
| "oneHour"
| "twoHours"
| "fourHours"
| "sixHours"
| "twelveHours"
| "oneDay"
| "twoDays"
| "oneWeek"
| "twoWeeks"
| "fourWeeks";
saltoksAccessGroupRef?: string
| null;
schedule?: {
default: {
closedDays: string[];
items: {
days: {
friday: ...;
monday: ...;
saturday: ...;
sunday: ...;
thursday: ...;
tuesday: ...;
wednesday: ...;
};
hours: { from: ...; to: ... };
}[];
};
enabled: boolean;
public: {
closedDays: string[];
enabled: boolean;
items: {
days: {
friday: ...;
monday: ...;
saturday: ...;
sunday: ...;
thursday: ...;
tuesday: ...;
wednesday: ...;
};
hours: { from: ...; to: ... };
}[];
};
};
tapkeyGroupRef?: string
| null;
unifiAccessGroupRef?: string | null;
title?: string;
type?:
| "equipment"
| "dedicatedDesk"
| "hotDesk"
| "office"
| "parkingLot"
| "room"
| "station"
| "conferenceRoom"
| "eventSpace"
| "meetingRoom"
| "phoneBooth"
| "studio";
visibility?: | "public"
| "admins"
| "exclusiveMembers"
| "members"
| "networkMembers";
};
};
};
};
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getBookings
getBookings: {
parameters: {
query?: {
"endDate[gt]"?: string;
"endDate[gte]"?: string;
"endDate[lt]"?: string;
"endDate[lte]"?: string;
"startDate[gt]"?: string;
"startDate[gte]"?: string;
"startDate[lt]"?: string;
"startDate[lte]"?: string;
customerRef?: string;
endDate?: string;
includeDeleted?: string;
limit?: number;
locationRef?: string;
membershipRefOwner?: string;
nextPageToken?: string;
order?: string;
resourceRef?: string;
singleBookings?: string;
startDate?: string;
status?: string;
type?: string;
types?: string;
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
bookings: {
attendees: {
membershipRef?: string;
user?: {
about?: ...;
company?: ...;
email?: ...;
id: ...;
name?: ...;
phoneNumber?: ...;
photoUrl?: ...;
surname?: ...;
};
}[];
createDate: string;
deleteDate?: string;
endDate: string;
entire?: boolean;
id: string;
membershipRefOwner?: string;
memo?: string;
payment?: {
createDate?: string;
discounts?: (...)[];
dispute?: { createDate?: ... };
method: {
credits?: (...) | (...);
dayPasses?: (...) | (...);
external?: (...) | (...);
invoice?: (...) | (...);
paymentGateway?: (...) | (...);
type: (...) | (...) | (...) | (...) | (...);
};
price?: { credits?: ...; dayPasses?: ...; money?: ...; type: ... };
refundable?: boolean;
refunds?: { credits?: ...; dayPasses?: ...; money?: ...; type: ... };
request?: { id: ...; url: ... };
scheduleDate?: string;
status?:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
surcharge?: { money: ...; type: ... };
transactionRef?: string;
type?: string;
};
payments?: {
createDate?: (...)
| (...);
discounts?: (...) | (...);
dispute?: (...) | (...);
method: {
credits?: ...;
dayPasses?: ...;
external?: ...;
invoice?: ...;
paymentGateway?: ...;
type: ...;
};
price?: (...)
| (...);
refundable?: (...) | (...) | (...);
refunds?: (...) | (...);
request?: (...) | (...);
scheduleDate?: (...) | (...);
status?: (...) | (...) | (...) | (...) | (...) | (...);
surcharge?: (...) | (...);
transactionRef?: (...) | (...);
type?: (...) | (...);
}[];
resourceRef: string;
seats?: number;
startDate: string;
title?: string;
updateDate?: string;
userOwner?: {
about?: string
| null;
company?: { title: ... } | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
}[];
nextPageToken?: string;
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createBooking
createBooking: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
booking: {
endDate: string;
entire?: boolean;
membershipRefOwner?: string;
memo?: string;
resourceRef: string;
seats?: number;
startDate: string;
title?: string;
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
booking: {
attendees: {
membershipRef?: string;
user?: {
about?: (...) | (...) | (...);
company?: (...) | (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
}[];
createDate: string;
deleteDate?: string;
endDate: string;
entire?: boolean;
id: string;
membershipRefOwner?: string;
memo?: string;
payment?: {
createDate?: string;
discounts?: { coupon: ...; promocode?: ...; subscriptionId?: ... }[];
dispute?: { createDate?: (...) | (...) };
method: {
credits?: { customer: ... };
dayPasses?: { customer: ... };
external?: { customer: ... };
invoice?: {
customer: ...;
invoiceItemRef?: ...;
subscriptionRef?: ...;
};
paymentGateway?: {
customer: ...;
gateway?: ...;
label?: ...;
mask?: ...;
title?: ...;
};
type: | "external"
| "paymentGateway"
| "invoice"
| "credits"
| "dayPasses";
};
price?: {
credits?: (...)
| (...);
dayPasses?: (...) | (...);
money?: (...) | (...);
type: (...) | (...) | (...);
};
refundable?: boolean;
refunds?: {
credits?: (...)
| (...);
dayPasses?: (...) | (...);
money?: (...) | (...);
type: (...) | (...) | (...);
};
request?: { id: string; url: string };
scheduleDate?: string;
status?:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
surcharge?: {
money: {
amount?: ...;
currencyCode?: ...;
percentage?: ...;
rate?: ...;
};
type: "money";
};
transactionRef?: string;
type?: string;
};
payments?: {
createDate?: string;
discounts?: (...)[];
dispute?: { createDate?: ... };
method: {
credits?: (...) | (...);
dayPasses?: (...) | (...);
external?: (...) | (...);
invoice?: (...) | (...);
paymentGateway?: (...) | (...);
type: (...) | (...) | (...) | (...) | (...);
};
price?: { credits?: ...; dayPasses?: ...; money?: ...; type: ... };
refundable?: boolean;
refunds?: { credits?: ...; dayPasses?: ...; money?: ...; type: ... };
request?: { id: ...; url: ... };
scheduleDate?: string;
status?:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
surcharge?: { money: ...; type: ... };
transactionRef?: string;
type?: string;
}[];
resourceRef: string;
seats?: number;
startDate: string;
title?: string;
updateDate?: string;
userOwner?: {
about?: string
| null;
company?: { title: string } | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getBooking
getBooking: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { bookingId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
booking: {
attendees: {
membershipRef?: string;
user?: {
about?: (...) | (...) | (...);
company?: (...) | (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
}[];
createDate: string;
deleteDate?: string;
endDate: string;
entire?: boolean;
id: string;
membershipRefOwner?: string;
memo?: string;
payment?: {
createDate?: string;
discounts?: { coupon: ...; promocode?: ...; subscriptionId?: ... }[];
dispute?: { createDate?: (...) | (...) };
method: {
credits?: { customer: ... };
dayPasses?: { customer: ... };
external?: { customer: ... };
invoice?: {
customer: ...;
invoiceItemRef?: ...;
subscriptionRef?: ...;
};
paymentGateway?: {
customer: ...;
gateway?: ...;
label?: ...;
mask?: ...;
title?: ...;
};
type: | "external"
| "paymentGateway"
| "invoice"
| "credits"
| "dayPasses";
};
price?: {
credits?: (...)
| (...);
dayPasses?: (...) | (...);
money?: (...) | (...);
type: (...) | (...) | (...);
};
refundable?: boolean;
refunds?: {
credits?: (...)
| (...);
dayPasses?: (...) | (...);
money?: (...) | (...);
type: (...) | (...) | (...);
};
request?: { id: string; url: string };
scheduleDate?: string;
status?:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
surcharge?: {
money: {
amount?: ...;
currencyCode?: ...;
percentage?: ...;
rate?: ...;
};
type: "money";
};
transactionRef?: string;
type?: string;
};
payments?: {
createDate?: string;
discounts?: (...)[];
dispute?: { createDate?: ... };
method: {
credits?: (...) | (...);
dayPasses?: (...) | (...);
external?: (...) | (...);
invoice?: (...) | (...);
paymentGateway?: (...) | (...);
type: (...) | (...) | (...) | (...) | (...);
};
price?: { credits?: ...; dayPasses?: ...; money?: ...; type: ... };
refundable?: boolean;
refunds?: { credits?: ...; dayPasses?: ...; money?: ...; type: ... };
request?: { id: ...; url: ... };
scheduleDate?: string;
status?:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
surcharge?: { money: ...; type: ... };
transactionRef?: string;
type?: string;
}[];
resourceRef: string;
seats?: number;
startDate: string;
title?: string;
updateDate?: string;
userOwner?: {
about?: string
| null;
company?: { title: string } | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deleteBooking
deleteBooking: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { bookingId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
patchBooking
patchBooking: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { bookingId: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
booking: {
attendees?: { user: { id: string } }[];
endDate?: string;
entire?: boolean;
memo?: string;
resourceRef?: string;
seats?: number;
sendUpdates?: "none" | "all";
startDate?: string;
title?: string;
};
updateRepeatingScope?: "singleOccurrence"
| "thisAndNext";
};
};
};
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
booking: {
attendees: {
membershipRef?: string;
user?: {
about?: (...) | (...) | (...);
company?: (...) | (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
}[];
createDate: string;
deleteDate?: string;
endDate: string;
entire?: boolean;
id: string;
membershipRefOwner?: string;
memo?: string;
payment?: {
createDate?: string;
discounts?: { coupon: ...; promocode?: ...; subscriptionId?: ... }[];
dispute?: { createDate?: (...) | (...) };
method: {
credits?: { customer: ... };
dayPasses?: { customer: ... };
external?: { customer: ... };
invoice?: {
customer: ...;
invoiceItemRef?: ...;
subscriptionRef?: ...;
};
paymentGateway?: {
customer: ...;
gateway?: ...;
label?: ...;
mask?: ...;
title?: ...;
};
type: | "external"
| "paymentGateway"
| "invoice"
| "credits"
| "dayPasses";
};
price?: {
credits?: (...)
| (...);
dayPasses?: (...) | (...);
money?: (...) | (...);
type: (...) | (...) | (...);
};
refundable?: boolean;
refunds?: {
credits?: (...)
| (...);
dayPasses?: (...) | (...);
money?: (...) | (...);
type: (...) | (...) | (...);
};
request?: { id: string; url: string };
scheduleDate?: string;
status?:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
surcharge?: {
money: {
amount?: ...;
currencyCode?: ...;
percentage?: ...;
rate?: ...;
};
type: "money";
};
transactionRef?: string;
type?: string;
};
payments?: {
createDate?: string;
discounts?: (...)[];
dispute?: { createDate?: ... };
method: {
credits?: (...) | (...);
dayPasses?: (...) | (...);
external?: (...) | (...);
invoice?: (...) | (...);
paymentGateway?: (...) | (...);
type: (...) | (...) | (...) | (...) | (...);
};
price?: { credits?: ...; dayPasses?: ...; money?: ...; type: ... };
refundable?: boolean;
refunds?: { credits?: ...; dayPasses?: ...; money?: ...; type: ... };
request?: { id: ...; url: ... };
scheduleDate?: string;
status?:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
surcharge?: { money: ...; type: ... };
transactionRef?: string;
type?: string;
}[];
resourceRef: string;
seats?: number;
startDate: string;
title?: string;
updateDate?: string;
userOwner?: {
about?: string
| null;
company?: { title: string } | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getShopCategories
getShopCategories: {
parameters: {
query: { locationRef: string };
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
categories: {
createDate: string;
id: string;
locationRef: string;
networkRef: string;
title: string;
}[];
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createShopCategory
createShopCategory: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
category: { locationRef: string; title: string };
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
category?: {
createDate: string;
id: string;
locationRef: string;
networkRef: string;
title: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getShopCategory
getShopCategory: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { categoryId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
category: {
createDate: string;
id: string;
locationRef: string;
networkRef: string;
title: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
updateShopCategory
updateShopCategory: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { categoryId: string };
cookie?: undefined;
};
requestBody: {
content: { "application/json": { category: { title: string } } };
};
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
category?: {
createDate: string;
id: string;
locationRef: string;
networkRef: string;
title: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deleteShopCategory
deleteShopCategory: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { categoryId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getProducts
getProducts: {
parameters: {
query?: {
categoryRef?: string;
id?: string;
limit?: number;
locationRef?: string;
nextPageToken?: string;
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
nextPageToken?: string;
products: {
categoryRef: string;
createDate: string;
description: string;
featured: boolean;
id: string;
imageUrl: string | null;
locale: string;
locationRef: string;
media: { key: string; url?: string }[];
networkRef: string;
options: {
available: boolean;
createDate: string;
customTax: { enabled: boolean; rate: number };
description: string;
id: string;
price: {
credits: { amount: ...; amountDiscounted?: ...; enabled: ... };
money: {
amount: ...;
amountDiscounted?: ...;
currencyCode: ...;
enabled: ...;
};
};
stock: { enabled: boolean; quantity: number };
title: string;
}[];
order: { enabled: boolean };
refundPolicy: "noRefund" | "statusNew";
title: string;
updateDate?: string;
visibility: "public" | "admins" | "members" | "networkMembers";
}[];
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createProduct
createProduct: {
parameters: {
query?: undefined;
header?: undefined;
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
product: {
categoryRef: string;
description?: string;
featured?: boolean;
locationRef: string;
media?: { key: string }[];
options: {
available?: boolean;
customTax?: { enabled?: boolean; rate?: number };
description?: string;
price: {
credits: { amount?: number; enabled?: boolean };
money: { amount?: number; enabled?: boolean };
};
stock?: { enabled?: boolean; quantity?: number };
title: string;
id?: string;
}[];
order?: { enabled?: boolean };
refundPolicy?: "noRefund" | "statusNew";
title: string;
visibility?: "public" | "admins" | "members" | "networkMembers";
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
product?: {
categoryRef: string;
createDate: string;
description: string;
featured: boolean;
id: string;
imageUrl: string | null;
locale: string;
locationRef: string;
media: { key: string; url?: string }[];
networkRef: string;
options: {
available: boolean;
createDate: string;
customTax: { enabled: boolean; rate: number };
description: string;
id: string;
price: {
credits: { amount: ...; amountDiscounted?: ...; enabled: ... };
money: {
amount: ...;
amountDiscounted?: ...;
currencyCode: ...;
enabled: ...;
};
};
stock: { enabled: boolean; quantity: number };
title: string;
}[];
order: { enabled: boolean };
refundPolicy: "noRefund" | "statusNew";
title: string;
updateDate?: string;
visibility: "public" | "admins" | "members" | "networkMembers";
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getProduct
getProduct: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { productId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
product: {
categoryRef: string;
createDate: string;
description: string;
featured: boolean;
id: string;
imageUrl: string | null;
locale: string;
locationRef: string;
media: { key: string; url?: string }[];
networkRef: string;
options: {
available: boolean;
createDate: string;
customTax: { enabled: boolean; rate: number };
description: string;
id: string;
price: {
credits: {
amount: number;
amountDiscounted?: (...) | (...);
enabled: boolean;
};
money: {
amount: number;
amountDiscounted?: (...)
| (...);
currencyCode: string;
enabled: boolean;
};
};
stock: { enabled: boolean; quantity: number };
title: string;
}[];
order: { enabled: boolean };
refundPolicy: "noRefund" | "statusNew";
title: string;
updateDate?: string;
visibility: "public" | "admins" | "members" | "networkMembers";
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
updateProduct
updateProduct: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { productId: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
product: {
categoryRef: string;
description?: string;
featured?: boolean;
media?: { key: string }[];
options: {
available?: boolean;
customTax?: { enabled?: boolean; rate?: number };
description?: string;
price: {
credits: { amount?: number; enabled?: boolean };
money: { amount?: number; enabled?: boolean };
};
stock?: { enabled?: boolean; quantity?: number };
title: string;
id?: string;
}[];
order?: { enabled?: boolean };
refundPolicy?: "noRefund" | "statusNew";
title: string;
visibility?: "public" | "admins" | "members" | "networkMembers";
};
};
};
};
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
product?: {
categoryRef: string;
createDate: string;
description: string;
featured: boolean;
id: string;
imageUrl: string | null;
locale: string;
locationRef: string;
media: { key: string; url?: string }[];
networkRef: string;
options: {
available: boolean;
createDate: string;
customTax: { enabled: boolean; rate: number };
description: string;
id: string;
price: {
credits: { amount: ...; amountDiscounted?: ...; enabled: ... };
money: {
amount: ...;
amountDiscounted?: ...;
currencyCode: ...;
enabled: ...;
};
};
stock: { enabled: boolean; quantity: number };
title: string;
}[];
order: { enabled: boolean };
refundPolicy: "noRefund" | "statusNew";
title: string;
updateDate?: string;
visibility: "public" | "admins" | "members" | "networkMembers";
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deleteProduct
deleteProduct: {
parameters: {
query?: undefined;
header?: undefined;
path: { productId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getOrders
getOrders: {
parameters: {
query?: {
categoryRef?: string;
"createDate[gte]"?: string;
"createDate[lte]"?: string;
customerRef?: string;
limit?: number;
locationRef?: string;
nextPageToken?: string;
productRef?: string;
status?: string;
userRef?: string;
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
nextPageToken?: string;
orders: {
comment?: string;
createDate: string;
deleteDate?: string;
id: string;
items: {
altCurrencyPriceDetails?: { money: ...; type: ... };
id: string;
priceDetails?: { credits?: ...; money?: ...; type: ... };
product: {
description: string;
id: string;
media: (...)[];
option?: (...) | (...);
title: string;
};
quantity: number;
}[];
locationRef: string;
membershipRef?: string
| null;
membershipRefDeletedBy?: string;
number: number;
payment?: {
createDate?: string;
discounts: { coupon: ...; promocode?: ...; subscriptionId?: ... }[];
dispute?: { createDate: ... };
method: {
credits?: (...) | (...);
invoice?: (...) | (...);
paymentGateway?: (...) | (...);
type: (...) | (...) | (...);
};
price: {
credits?: (...)
| (...);
money?: (...) | (...);
type: (...) | (...);
};
refund?: { credits?: ...; money?: ...; transactionRef?: ... };
refundable: boolean;
refunds?: { credits?: ...; money?: ...; type?: ... };
request?: { id: ...; url: ... };
status?: string;
surcharge?: { money: ...; type: ... };
transactionRef?: string;
type?: string;
};
status: "canceled"
| "new"
| "inProgress"
| "completed";
user: {
about?: string | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userDeletedBy?: {
id: string;
name?: string
| null;
surname?: string | null;
};
}[];
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getOrder
getOrder: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { orderId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
order: {
comment?: string;
createDate: string;
deleteDate?: string;
id: string;
items: {
altCurrencyPriceDetails?: {
money: { currencyCode: ...; tax?: ...; unitAmount: ... };
type: "money";
};
id: string;
priceDetails?: {
credits?: (...)
| (...);
money?: (...) | (...);
type: (...) | (...);
};
product: {
description: string;
id: string;
media: { key: ...; url: ... }[];
option?: { id: ...; title: ... };
title: string;
};
quantity: number;
}[];
locationRef: string;
membershipRef?: string
| null;
membershipRefDeletedBy?: string;
number: number;
payment?: {
createDate?: string;
discounts: {
coupon: {
amountOff?: ...;
currencyCode?: ...;
id?: ...;
percentOff?: ...;
productTypes?: ...;
type?: ...;
};
promocode?: (...)
| (...);
subscriptionId?: (...) | (...);
}[];
dispute?: { createDate: string };
method: {
credits?: { customer: ... };
invoice?: { customer: ...; invoiceRef?: ...; subscriptionRef?: ... };
paymentGateway?: {
customer: ...;
label?: ...;
location?: ...;
mask?: ...;
title?: ...;
type?: ...;
};
type: "paymentGateway"
| "invoice"
| "credits";
};
price: {
credits?: { expiringAmount: ...; permanentAmount: ... };
money?: { currencyCode: ...; grossAmount: ... };
type: "money" | "credits";
};
refund?: {
credits?: (...)
| (...);
money?: (...) | (...);
transactionRef?: (...) | (...);
};
refundable: boolean;
refunds?: {
credits?: (...)
| (...);
money?: (...) | (...);
type?: (...) | (...) | (...);
};
request?: { id: string; url: string };
status?: string;
surcharge?: {
money: {
amount: ...;
currencyCode: ...;
percentage: ...;
rate: ...;
};
type: "money";
};
transactionRef?: string;
type?: string;
};
status: "canceled"
| "new"
| "inProgress"
| "completed";
user: {
about?: string | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userDeletedBy?: {
id: string;
name?: string
| null;
surname?: string | null;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getSubscriptions
getSubscriptions: {
parameters: {
query?: {
"createDate[gte]"?: string;
"createDate[lte]"?: string;
customerRef?: string;
limit?: number;
locationRef?: string;
nextPageToken?: string;
order?: string;
planRef?: string;
status?: string;
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
nextPageToken?: string;
searchQueryNext?: string;
subscriptions: {
addPendingItemsToInvoice: boolean;
advanceInvoicing: { days: number; type: "days" | "default" };
assignments: {
entire?: boolean;
id: string;
quantity?: number;
resource: {
coverUrl?: (...) | (...);
id: string;
title: string;
type: string;
};
title: string;
}[];
billingCycleAnchor: "day"
| "any";
company?: {
createDate: string;
id: string;
locationRef: string;
logo?: { key: ...; url: ... };
metadata?: { [key: ...]: ... };
notes?: string | null;
publicLogoUrl?: string;
title: string;
};
companyRef?: string;
contract?: { id: string; url: string };
createDate: string;
credits: number;
currentInterval?: {
endDate: string;
futureIntervalItemsCreated?: boolean;
startDate: string;
};
customer: {
id: string;
logo?: { key: string; url: string };
publicLogoUrl?: string;
title?: string;
type: "company" | "user";
user?: {
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
customerRef: string;
dayPasses: number;
deleteDate?: string;
discounts?: {
creditPackages: number;
desks: number;
equipment: number;
events: number;
rooms: number;
shop: number;
};
endDate?: string;
id: string;
items: {
autoUpdateFromProduct: boolean;
avigilonAltaGroupRef?: number
| null;
brivoGroupRef?: number | null;
commitmentCycles?: number;
commitmentEndDate?: string;
couponRef?: string;
createDate: string;
credits: number;
customEnd: boolean;
customStart: boolean;
customTax: { enabled: boolean; rate: number };
dayPasses: number;
discounts?: {
creditPackages: ...;
desks: ...;
equipment: ...;
events: ...;
rooms: ...;
shop: ...;
};
endDate?: string;
endFixed: boolean;
entire?: boolean;
exclusiveAccess?: { benefitRefs: ...; resourceRefs: ... };
ezeepBlueGroupRef?: string | null;
grantedDiscounts: { coupon: ... }[];
id: string;
kisiGroupRef?: number | null;
optionRef?: string;
plan?: { id: ...; resourceRef?: ...; title: ... };
planRef?: string;
price: number;
productRef?: string;
quantity: number;
resource?: {
id: ...;
coverUrl?: ...;
imageUrl?: ...;
title: ...;
type: ...;
};
resourceRef?: string
| null;
saltoksAccessGroupRef?: string | null;
setupFee: number;
startDate?: string;
startFixed: boolean;
tapkeyGroupRef?: string | null;
tier?: { id: ...; title: ... };
tierRef?: string;
title?: string | null;
type: "oneOff" | "recurring";
unifiAccessGroupRef?: string | null;
}[];
locationRef: string;
membershipRef?: string;
networkRef: string;
nextInterval?: { endDate?: string; startDate: string };
pausePaymentCollection?: {
behavior: "draft" | "void";
createDate: string;
resumesAt?: string;
};
payment?: { request?: { id: ...; url: ... }; status: string };
payWithInvoice: {
creditPackages: boolean;
desks: boolean;
equipment?: boolean;
events: boolean;
parking?: boolean;
rooms: boolean;
shop: boolean;
};
period: | "day"
| "week"
| "month"
| "threeMonths"
| "sixMonths"
| "year";
price: number;
purchaseDate?: string;
startDate: string;
startFixed: boolean;
status: | "canceled"
| "active"
| "scheduled"
| "incomplete"
| "incompleteExpired";
subscriptionType: "company"
| "user";
timezoneId: string;
user?: {
about?: string | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userCreator?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userRef?: string;
}[];
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createSubscription
createSubscription: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
issueFirstInvoice?: "manual"
| "auto";
subscription: {
addPendingItemsToInvoice?: boolean;
advanceInvoicing?: { days?: number; type: "days" | "default" };
billingCycleAnchor?: "day" | "any";
endDate?: string | null;
items?: {
autoUpdateFromProduct?: boolean;
avigilonAltaGroupRef?: number | null;
brivoGroupRef?: number | null;
commitmentCycles?: number;
couponRef?: string | null;
createDate?: string;
credits?: number;
customEnd?: boolean;
customStart?: boolean;
customTax?: { enabled?: ...; rate?: ... };
dayPasses?: number;
discounts?: {
creditPackages?: ...;
desks?: ...;
equipment?: ...;
events?: ...;
rooms?: ...;
shop?: ...;
};
endDate?: string;
entire?: boolean;
exclusiveAccess?: { benefitRefs?: ...; resourceRefs?: ... };
ezeepBlueGroupRef?: string | null;
grantedDiscounts?: (...)[];
kisiGroupRef?: number | null;
plan?: { id: ...; title?: ... };
planRef?: string;
price?: number;
productRef?: string;
quantity?: number;
resourceRef?: string | null;
saltoksAccessGroupRef?: string | null;
setupFee?: number;
startDate?: string;
tapkeyGroupRef?: string | null;
tier?: { id: ...; title?: ... };
tierRef?: string;
title?: string;
type?: "oneOff" | "recurring";
unifiAccessGroupRef?: string | null;
}[];
period: "day"
| "week"
| "month"
| "threeMonths"
| "sixMonths"
| "year";
startDate: string;
} & ({ companyRef: string } | { membershipRef: string });
};
};
};
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
subscription?: {
addPendingItemsToInvoice: boolean;
advanceInvoicing: { days: number; type: "days" | "default" };
assignments: {
entire?: boolean;
id: string;
quantity?: number;
resource: {
coverUrl?: (...) | (...);
id: string;
title: string;
type: string;
};
title: string;
}[];
billingCycleAnchor: "day"
| "any";
company?: {
createDate: string;
id: string;
locationRef: string;
logo?: { key: ...; url: ... };
metadata?: { [key: ...]: ... };
notes?: string | null;
publicLogoUrl?: string;
title: string;
};
companyRef?: string;
contract?: { id: string; url: string };
createDate: string;
credits: number;
currentInterval?: {
endDate: string;
futureIntervalItemsCreated?: boolean;
startDate: string;
};
customer: {
id: string;
logo?: { key: string; url: string };
publicLogoUrl?: string;
title?: string;
type: "company" | "user";
user?: {
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
customerRef: string;
dayPasses: number;
deleteDate?: string;
discounts?: {
creditPackages: number;
desks: number;
equipment: number;
events: number;
rooms: number;
shop: number;
};
endDate?: string;
id: string;
items: {
autoUpdateFromProduct: boolean;
avigilonAltaGroupRef?: number
| null;
brivoGroupRef?: number | null;
commitmentCycles?: number;
commitmentEndDate?: string;
couponRef?: string;
createDate: string;
credits: number;
customEnd: boolean;
customStart: boolean;
customTax: { enabled: boolean; rate: number };
dayPasses: number;
discounts?: {
creditPackages: ...;
desks: ...;
equipment: ...;
events: ...;
rooms: ...;
shop: ...;
};
endDate?: string;
endFixed: boolean;
entire?: boolean;
exclusiveAccess?: { benefitRefs: ...; resourceRefs: ... };
ezeepBlueGroupRef?: string | null;
grantedDiscounts: { coupon: ... }[];
id: string;
kisiGroupRef?: number | null;
optionRef?: string;
plan?: { id: ...; resourceRef?: ...; title: ... };
planRef?: string;
price: number;
productRef?: string;
quantity: number;
resource?: {
id: ...;
coverUrl?: ...;
imageUrl?: ...;
title: ...;
type: ...;
};
resourceRef?: string
| null;
saltoksAccessGroupRef?: string | null;
setupFee: number;
startDate?: string;
startFixed: boolean;
tapkeyGroupRef?: string | null;
tier?: { id: ...; title: ... };
tierRef?: string;
title?: string | null;
type: "oneOff" | "recurring";
unifiAccessGroupRef?: string | null;
}[];
locationRef: string;
membershipRef?: string;
networkRef: string;
nextInterval?: { endDate?: string; startDate: string };
pausePaymentCollection?: {
behavior: "draft" | "void";
createDate: string;
resumesAt?: string;
};
payment?: { request?: { id: ...; url: ... }; status: string };
payWithInvoice: {
creditPackages: boolean;
desks: boolean;
equipment?: boolean;
events: boolean;
parking?: boolean;
rooms: boolean;
shop: boolean;
};
period: | "day"
| "week"
| "month"
| "threeMonths"
| "sixMonths"
| "year";
price: number;
purchaseDate?: string;
startDate: string;
startFixed: boolean;
status: | "canceled"
| "active"
| "scheduled"
| "incomplete"
| "incompleteExpired";
subscriptionType: "company"
| "user";
timezoneId: string;
user?: {
about?: string | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userCreator?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userRef?: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getSubscription
getSubscription: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { subscriptionId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
subscription: {
addPendingItemsToInvoice: boolean;
advanceInvoicing: { days: number; type: "days" | "default" };
assignments: {
entire?: boolean;
id: string;
quantity?: number;
resource: {
coverUrl?: string;
id: string;
title: string;
type: string;
};
title: string;
}[];
billingCycleAnchor: "day"
| "any";
company?: {
createDate: string;
id: string;
locationRef: string;
logo?: { key: string; url: string };
metadata?: { [key: string]: unknown };
notes?: string | null;
publicLogoUrl?: string;
title: string;
};
companyRef?: string;
contract?: { id: string; url: string };
createDate: string;
credits: number;
currentInterval?: {
endDate: string;
futureIntervalItemsCreated?: boolean;
startDate: string;
};
customer: {
id: string;
logo?: { key: string; url: string };
publicLogoUrl?: string;
title?: string;
type: "company" | "user";
user?: {
email?: string | null;
id: string;
name?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
};
customerRef: string;
dayPasses: number;
deleteDate?: string;
discounts?: {
creditPackages: number;
desks: number;
equipment: number;
events: number;
rooms: number;
shop: number;
};
endDate?: string;
id: string;
items: {
autoUpdateFromProduct: boolean;
avigilonAltaGroupRef?: number
| null;
brivoGroupRef?: number | null;
commitmentCycles?: number;
commitmentEndDate?: string;
couponRef?: string;
createDate: string;
credits: number;
customEnd: boolean;
customStart: boolean;
customTax: { enabled: boolean; rate: number };
dayPasses: number;
discounts?: {
creditPackages: number;
desks: number;
equipment: number;
events: number;
rooms: number;
shop: number;
};
endDate?: string;
endFixed: boolean;
entire?: boolean;
exclusiveAccess?: { benefitRefs: (...)[]; resourceRefs: (...)[] };
ezeepBlueGroupRef?: string | null;
grantedDiscounts: {
coupon: {
amountOff?: ...;
currencyCode?: ...;
enabledForCredits?: ...;
id: ...;
limitedItems?: ...;
limitedRedemption?: ...;
percentOff?: ...;
productTypes?: ...;
};
}[];
id: string;
kisiGroupRef?: number
| null;
optionRef?: string;
plan?: { id: string; resourceRef?: (...) | (...); title: string };
planRef?: string;
price: number;
productRef?: string;
quantity: number;
resource?: {
id: string;
coverUrl?: (...) | (...);
imageUrl?: (...) | (...);
title: string;
type: string;
};
resourceRef?: string
| null;
saltoksAccessGroupRef?: string | null;
setupFee: number;
startDate?: string;
startFixed: boolean;
tapkeyGroupRef?: string | null;
tier?: { id: string; title: string };
tierRef?: string;
title?: string | null;
type: "oneOff" | "recurring";
unifiAccessGroupRef?: string | null;
}[];
locationRef: string;
membershipRef?: string;
networkRef: string;
nextInterval?: { endDate?: string; startDate: string };
pausePaymentCollection?: {
behavior: "draft" | "void";
createDate: string;
resumesAt?: string;
};
payment?: { request?: { id: string; url: string }; status: string };
payWithInvoice: {
creditPackages: boolean;
desks: boolean;
equipment?: boolean;
events: boolean;
parking?: boolean;
rooms: boolean;
shop: boolean;
};
period: | "day"
| "week"
| "month"
| "threeMonths"
| "sixMonths"
| "year";
price: number;
purchaseDate?: string;
startDate: string;
startFixed: boolean;
status: | "canceled"
| "active"
| "scheduled"
| "incomplete"
| "incompleteExpired";
subscriptionType: "company"
| "user";
timezoneId: string;
user?: {
about?: string | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userCreator?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userRef?: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deleteSubscription
deleteSubscription: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { subscriptionId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
updateSubscription
updateSubscription: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { subscriptionId: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
subscription: {
addPendingItemsToInvoice?: boolean;
advanceInvoicing?: { days?: number; type: "days"
| "default" };
endDate?: string | null;
items?: {
autoUpdateFromProduct?: boolean;
avigilonAltaGroupRef?: number | null;
brivoGroupRef?: number | null;
commitmentCycles?: number;
couponRef?: string | null;
createDate?: string;
credits?: number;
customEnd?: boolean;
customStart?: boolean;
customTax?: { enabled?: (...) | (...) | (...); rate?: (...) | (...) };
dayPasses?: number;
discounts?: {
creditPackages?: (...) | (...);
desks?: (...) | (...);
equipment?: (...) | (...);
events?: (...) | (...);
rooms?: (...) | (...);
shop?: (...) | (...);
};
endDate?: string;
entire?: boolean;
exclusiveAccess?: {
benefitRefs?: (...)
| (...);
resourceRefs?: (...) | (...);
};
ezeepBlueGroupRef?: string
| null;
grantedDiscounts?: { coupon: ... }[];
kisiGroupRef?: number | null;
plan?: { id: string; title?: (...) | (...) };
planRef?: string;
price?: number;
productRef?: string;
quantity?: number;
resourceRef?: string | null;
saltoksAccessGroupRef?: string | null;
setupFee?: number;
startDate?: string;
tapkeyGroupRef?: string | null;
tier?: { id: string; title?: (...) | (...) };
tierRef?: string;
title?: string;
type?: "oneOff" | "recurring";
unifiAccessGroupRef?: string | null;
id?: string;
}[];
pausePaymentCollection?: | {
behavior: "draft"
| "void";
resumesAt?: string;
}
| null;
payWithInvoice?: {
creditPackages?: boolean;
desks?: boolean;
equipment?: boolean;
events?: boolean;
parking?: boolean;
rooms?: boolean;
shop?: boolean;
};
startDate?: string;
};
};
};
};
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createSubscriptionItem
createSubscriptionItem: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { subscriptionId: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
item: {
autoUpdateFromProduct?: boolean;
avigilonAltaGroupRef?: number
| null;
brivoGroupRef?: number | null;
commitmentCycles?: number;
couponRef?: string | null;
createDate?: string;
credits?: number;
customEnd?: boolean;
customStart?: boolean;
customTax?: { enabled?: boolean; rate?: number };
dayPasses?: number;
discounts?: {
creditPackages?: number;
desks?: number;
equipment?: number;
events?: number;
rooms?: number;
shop?: number;
};
endDate?: string;
entire?: boolean;
exclusiveAccess?: { benefitRefs?: string[]; resourceRefs?: string[] };
ezeepBlueGroupRef?: string | null;
grantedDiscounts?: {
coupon: {
amountOff?: number;
currencyCode?: string;
id: string;
percentOff?: number;
productTypes?: (...)[];
};
}[];
kisiGroupRef?: number
| null;
plan?: { id: string; title?: string };
planRef?: string;
price?: number;
productRef?: string;
quantity?: number;
resourceRef?: string | null;
saltoksAccessGroupRef?: string | null;
setupFee?: number;
startDate?: string;
tapkeyGroupRef?: string | null;
tier?: { id: string; title?: string };
tierRef?: string;
title?: string;
type?: "oneOff" | "recurring";
unifiAccessGroupRef?: string | null;
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
subscription?: {
addPendingItemsToInvoice: boolean;
advanceInvoicing: { days: number; type: "days" | "default" };
assignments: {
entire?: boolean;
id: string;
quantity?: number;
resource: {
coverUrl?: (...) | (...);
id: string;
title: string;
type: string;
};
title: string;
}[];
billingCycleAnchor: "day"
| "any";
company?: {
createDate: string;
id: string;
locationRef: string;
logo?: { key: ...; url: ... };
metadata?: { [key: ...]: ... };
notes?: string | null;
publicLogoUrl?: string;
title: string;
};
companyRef?: string;
contract?: { id: string; url: string };
createDate: string;
credits: number;
currentInterval?: {
endDate: string;
futureIntervalItemsCreated?: boolean;
startDate: string;
};
customer: {
id: string;
logo?: { key: string; url: string };
publicLogoUrl?: string;
title?: string;
type: "company" | "user";
user?: {
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
customerRef: string;
dayPasses: number;
deleteDate?: string;
discounts?: {
creditPackages: number;
desks: number;
equipment: number;
events: number;
rooms: number;
shop: number;
};
endDate?: string;
id: string;
items: {
autoUpdateFromProduct: boolean;
avigilonAltaGroupRef?: number
| null;
brivoGroupRef?: number | null;
commitmentCycles?: number;
commitmentEndDate?: string;
couponRef?: string;
createDate: string;
credits: number;
customEnd: boolean;
customStart: boolean;
customTax: { enabled: boolean; rate: number };
dayPasses: number;
discounts?: {
creditPackages: ...;
desks: ...;
equipment: ...;
events: ...;
rooms: ...;
shop: ...;
};
endDate?: string;
endFixed: boolean;
entire?: boolean;
exclusiveAccess?: { benefitRefs: ...; resourceRefs: ... };
ezeepBlueGroupRef?: string | null;
grantedDiscounts: { coupon: ... }[];
id: string;
kisiGroupRef?: number | null;
optionRef?: string;
plan?: { id: ...; resourceRef?: ...; title: ... };
planRef?: string;
price: number;
productRef?: string;
quantity: number;
resource?: {
id: ...;
coverUrl?: ...;
imageUrl?: ...;
title: ...;
type: ...;
};
resourceRef?: string
| null;
saltoksAccessGroupRef?: string | null;
setupFee: number;
startDate?: string;
startFixed: boolean;
tapkeyGroupRef?: string | null;
tier?: { id: ...; title: ... };
tierRef?: string;
title?: string | null;
type: "oneOff" | "recurring";
unifiAccessGroupRef?: string | null;
}[];
locationRef: string;
membershipRef?: string;
networkRef: string;
nextInterval?: { endDate?: string; startDate: string };
pausePaymentCollection?: {
behavior: "draft" | "void";
createDate: string;
resumesAt?: string;
};
payment?: { request?: { id: ...; url: ... }; status: string };
payWithInvoice: {
creditPackages: boolean;
desks: boolean;
equipment?: boolean;
events: boolean;
parking?: boolean;
rooms: boolean;
shop: boolean;
};
period: | "day"
| "week"
| "month"
| "threeMonths"
| "sixMonths"
| "year";
price: number;
purchaseDate?: string;
startDate: string;
startFixed: boolean;
status: | "canceled"
| "active"
| "scheduled"
| "incomplete"
| "incompleteExpired";
subscriptionType: "company"
| "user";
timezoneId: string;
user?: {
about?: string | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userCreator?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userRef?: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deleteSubscriptionItem
deleteSubscriptionItem: {
parameters: {
query?: undefined;
header?: undefined;
path: { subscriptionId: string; itemId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
updateSubscriptionItem
updateSubscriptionItem: {
parameters: {
query?: undefined;
header?: undefined;
path: { subscriptionId: string; itemId: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
item: {
autoUpdateFromProduct?: boolean;
avigilonAltaGroupRef?: number
| null;
brivoGroupRef?: number | null;
commitmentCycles?: number;
couponRef?: string | null;
createDate?: string;
credits?: number;
customEnd?: boolean;
customStart?: boolean;
customTax?: { enabled?: boolean; rate?: number };
dayPasses?: number;
discounts?: {
creditPackages?: number;
desks?: number;
equipment?: number;
events?: number;
rooms?: number;
shop?: number;
};
endDate?: string;
entire?: boolean;
exclusiveAccess?: { benefitRefs?: string[]; resourceRefs?: string[] };
ezeepBlueGroupRef?: string | null;
grantedDiscounts?: {
coupon: {
amountOff?: number;
currencyCode?: string;
id: string;
percentOff?: number;
productTypes?: (...)[];
};
}[];
kisiGroupRef?: number
| null;
plan?: { id: string; title?: string };
planRef?: string;
price?: number;
productRef?: string;
quantity?: number;
resourceRef?: string | null;
saltoksAccessGroupRef?: string | null;
setupFee?: number;
startDate?: string;
tapkeyGroupRef?: string | null;
tier?: { id: string; title?: string };
tierRef?: string;
title?: string;
type?: "oneOff" | "recurring";
unifiAccessGroupRef?: string | null;
};
};
};
};
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getSupportTickets
getSupportTickets: {
parameters: {
query: {
locationRef: string;
limit?: number;
membershipRefRequester?: string;
nextPageToken?: string;
order?: string;
userRefAssignee?: string;
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
nextPageToken?: string;
searchQueryNext?: string;
tickets?: {
createDate: string;
description: string;
id: string;
locationRef: string;
membershipAssignee?: {
id: string;
roleType: string;
type: string;
user?: (...) | (...);
};
membershipRefAssignee?: string;
membershipRefRequester?: string;
membershipRequester?: {
id: string;
roleType: string;
type: string;
user?: (...)
| (...);
};
number: number;
status: "new"
| "inProgress"
| "closed"
| "solved";
statusUpdateDate?: string;
type:
| "other"
| "access"
| "accountAndBilling"
| "bookings"
| "cleaning"
| "discriminationAndHarassment"
| "internet"
| "mailAndPackages"
| "noiseAndAcoustics"
| "offensiveOrObjectionableContent"
| "printing"
| "repairAndMaintenance"
| "temperatureAndVentilation"
| "websiteAndApp";
updateDate: string;
userAssignee?: | {
blocked?: (...)
| (...)
| (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl: (...) | (...);
surname?: (...) | (...) | (...);
}
| null;
userRefAssignee?: string;
userRequester?: | {
blocked?: (...)
| (...)
| (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl: (...) | (...);
surname?: (...) | (...) | (...);
}
| null;
}[];
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createSupportTicket
createSupportTicket: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
ticket: {
locationRef: string;
text: string;
type: | "other"
| "access"
| "accountAndBilling"
| "bookings"
| "cleaning"
| "discriminationAndHarassment"
| "internet"
| "mailAndPackages"
| "noiseAndAcoustics"
| "offensiveOrObjectionableContent"
| "printing"
| "repairAndMaintenance"
| "temperatureAndVentilation"
| "websiteAndApp";
userRefRequester?: string;
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
activities?: {
createDate: string;
data?: {
attachments?: (...) | (...);
membershipAssignee?: (...) | (...);
previousAttributes?: (...) | (...);
status?: (...) | (...) | (...) | (...) | (...);
text?: (...) | (...);
userAssignee?: (...) | (...);
userRefAssignee?: (...) | (...);
};
id: string;
lemAI?: { name: string; photoUrl: string };
membership?: {
id: string;
roleType: string;
type: string;
user?: (...) | (...);
};
ticketRef: string;
type: | "assigneeUpdated"
| "comment"
| "statusUpdated"
| "ticketCreated";
}[];
ticket?: {
createDate: string;
description: string;
id: string;
locationRef: string;
membershipAssignee?: {
id: string;
roleType: string;
type: string;
user?: {
blocked?: ...;
email?: ...;
id: ...;
name?: ...;
phoneNumber?: ...;
photoUrl: ...;
surname?: ...;
};
};
membershipRefAssignee?: string;
membershipRefRequester?: string;
membershipRequester?: {
id: string;
roleType: string;
type: string;
user?: {
blocked?: ...;
email?: ...;
id: ...;
name?: ...;
phoneNumber?: ...;
photoUrl: ...;
surname?: ...;
};
};
number: number;
status: "new"
| "inProgress"
| "closed"
| "solved";
statusUpdateDate?: string;
type:
| "other"
| "access"
| "accountAndBilling"
| "bookings"
| "cleaning"
| "discriminationAndHarassment"
| "internet"
| "mailAndPackages"
| "noiseAndAcoustics"
| "offensiveOrObjectionableContent"
| "printing"
| "repairAndMaintenance"
| "temperatureAndVentilation"
| "websiteAndApp";
updateDate: string;
userAssignee?: | {
blocked?: boolean;
email?: string
| null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl: string | null;
surname?: string | null;
}
| null;
userRefAssignee?: string;
userRequester?: | {
blocked?: boolean;
email?: string
| null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl: string | null;
surname?: string | null;
}
| null;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getSupportTicket
getSupportTicket: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
activities?: {
createDate: string;
data?: {
attachments?: (...) | (...);
membershipAssignee?: (...) | (...);
previousAttributes?: (...) | (...);
status?: (...) | (...) | (...) | (...) | (...);
text?: (...) | (...);
userAssignee?: (...) | (...);
userRefAssignee?: (...) | (...);
};
id: string;
lemAI?: { name: string; photoUrl: string };
membership?: {
id: string;
roleType: string;
type: string;
user?: (...) | (...);
};
ticketRef: string;
type: | "assigneeUpdated"
| "comment"
| "statusUpdated"
| "ticketCreated";
}[];
ticket?: {
createDate: string;
description: string;
id: string;
locationRef: string;
membershipAssignee?: {
id: string;
roleType: string;
type: string;
user?: {
blocked?: ...;
email?: ...;
id: ...;
name?: ...;
phoneNumber?: ...;
photoUrl: ...;
surname?: ...;
};
};
membershipRefAssignee?: string;
membershipRefRequester?: string;
membershipRequester?: {
id: string;
roleType: string;
type: string;
user?: {
blocked?: ...;
email?: ...;
id: ...;
name?: ...;
phoneNumber?: ...;
photoUrl: ...;
surname?: ...;
};
};
number: number;
status: "new"
| "inProgress"
| "closed"
| "solved";
statusUpdateDate?: string;
type:
| "other"
| "access"
| "accountAndBilling"
| "bookings"
| "cleaning"
| "discriminationAndHarassment"
| "internet"
| "mailAndPackages"
| "noiseAndAcoustics"
| "offensiveOrObjectionableContent"
| "printing"
| "repairAndMaintenance"
| "temperatureAndVentilation"
| "websiteAndApp";
updateDate: string;
userAssignee?: | {
blocked?: boolean;
email?: string
| null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl: string | null;
surname?: string | null;
}
| null;
userRefAssignee?: string;
userRequester?: | {
blocked?: boolean;
email?: string
| null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl: string | null;
surname?: string | null;
}
| null;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
updateSupportTicketAssignee
updateSupportTicketAssignee: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
ticket: {
membershipRefAssignee?: string
| null;
userRefAssignee?: string | null;
};
};
};
};
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
activity?: {
createDate: string;
data?: {
attachments?: (...)[];
membershipAssignee?: {
id: ...;
roleType: ...;
type: ...;
user?: ...;
};
previousAttributes?: {
membershipAssignee?: ...;
status?: ...;
userAssignee?: ...;
userRefAssignee?: ...;
};
status?: "new"
| "inProgress"
| "closed"
| "solved";
text?: string;
userAssignee?: {
blocked?: ...;
email?: ...;
id: ...;
name?: ...;
phoneNumber?: ...;
photoUrl: ...;
surname?: ...;
};
userRefAssignee?: string;
};
id: string;
lemAI?: { name: string; photoUrl: string };
membership?: {
id: string;
roleType: string;
type: string;
user?: {
blocked?: ...;
email?: ...;
id: ...;
name?: ...;
phoneNumber?: ...;
photoUrl: ...;
surname?: ...;
};
};
ticketRef: string;
type: | "assigneeUpdated"
| "comment"
| "statusUpdated"
| "ticketCreated";
};
ticket?: {
createDate: string;
description: string;
id: string;
locationRef: string;
membershipAssignee?: {
id: string;
roleType: string;
type: string;
user?: {
blocked?: ...;
email?: ...;
id: ...;
name?: ...;
phoneNumber?: ...;
photoUrl: ...;
surname?: ...;
};
};
membershipRefAssignee?: string;
membershipRefRequester?: string;
membershipRequester?: {
id: string;
roleType: string;
type: string;
user?: {
blocked?: ...;
email?: ...;
id: ...;
name?: ...;
phoneNumber?: ...;
photoUrl: ...;
surname?: ...;
};
};
number: number;
status: "new"
| "inProgress"
| "closed"
| "solved";
statusUpdateDate?: string;
type:
| "other"
| "access"
| "accountAndBilling"
| "bookings"
| "cleaning"
| "discriminationAndHarassment"
| "internet"
| "mailAndPackages"
| "noiseAndAcoustics"
| "offensiveOrObjectionableContent"
| "printing"
| "repairAndMaintenance"
| "temperatureAndVentilation"
| "websiteAndApp";
updateDate: string;
userAssignee?: | {
blocked?: boolean;
email?: string
| null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl: string | null;
surname?: string | null;
}
| null;
userRefAssignee?: string;
userRequester?: | {
blocked?: boolean;
email?: string
| null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl: string | null;
surname?: string | null;
}
| null;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
updateSupportTicketStatus
updateSupportTicketStatus: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
ticket: { status: "new"
| "inProgress"
| "closed"
| "solved" };
};
};
};
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
activity?: {
createDate: string;
data?: {
attachments?: (...)[];
membershipAssignee?: {
id: ...;
roleType: ...;
type: ...;
user?: ...;
};
previousAttributes?: {
membershipAssignee?: ...;
status?: ...;
userAssignee?: ...;
userRefAssignee?: ...;
};
status?: "new"
| "inProgress"
| "closed"
| "solved";
text?: string;
userAssignee?: {
blocked?: ...;
email?: ...;
id: ...;
name?: ...;
phoneNumber?: ...;
photoUrl: ...;
surname?: ...;
};
userRefAssignee?: string;
};
id: string;
lemAI?: { name: string; photoUrl: string };
membership?: {
id: string;
roleType: string;
type: string;
user?: {
blocked?: ...;
email?: ...;
id: ...;
name?: ...;
phoneNumber?: ...;
photoUrl: ...;
surname?: ...;
};
};
ticketRef: string;
type: | "assigneeUpdated"
| "comment"
| "statusUpdated"
| "ticketCreated";
};
ticket?: {
createDate: string;
description: string;
id: string;
locationRef: string;
membershipAssignee?: {
id: string;
roleType: string;
type: string;
user?: {
blocked?: ...;
email?: ...;
id: ...;
name?: ...;
phoneNumber?: ...;
photoUrl: ...;
surname?: ...;
};
};
membershipRefAssignee?: string;
membershipRefRequester?: string;
membershipRequester?: {
id: string;
roleType: string;
type: string;
user?: {
blocked?: ...;
email?: ...;
id: ...;
name?: ...;
phoneNumber?: ...;
photoUrl: ...;
surname?: ...;
};
};
number: number;
status: "new"
| "inProgress"
| "closed"
| "solved";
statusUpdateDate?: string;
type:
| "other"
| "access"
| "accountAndBilling"
| "bookings"
| "cleaning"
| "discriminationAndHarassment"
| "internet"
| "mailAndPackages"
| "noiseAndAcoustics"
| "offensiveOrObjectionableContent"
| "printing"
| "repairAndMaintenance"
| "temperatureAndVentilation"
| "websiteAndApp";
updateDate: string;
userAssignee?: | {
blocked?: boolean;
email?: string
| null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl: string | null;
surname?: string | null;
}
| null;
userRefAssignee?: string;
userRequester?: | {
blocked?: boolean;
email?: string
| null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl: string | null;
surname?: string | null;
}
| null;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
updateSupportTicketType
updateSupportTicketType: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
ticket: {
type: | "other"
| "access"
| "accountAndBilling"
| "bookings"
| "cleaning"
| "discriminationAndHarassment"
| "internet"
| "mailAndPackages"
| "noiseAndAcoustics"
| "offensiveOrObjectionableContent"
| "printing"
| "repairAndMaintenance"
| "temperatureAndVentilation"
| "websiteAndApp";
};
};
};
};
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createSupportTicketComment: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
activity: {
attachments?: { key: string }[];
text?: string;
ticketRef: string;
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
activity?: {
createDate: string;
data?: {
attachments?: (...)[];
membershipAssignee?: {
id: ...;
roleType: ...;
type: ...;
user?: ...;
};
previousAttributes?: {
membershipAssignee?: ...;
status?: ...;
userAssignee?: ...;
userRefAssignee?: ...;
};
status?: "new"
| "inProgress"
| "closed"
| "solved";
text?: string;
userAssignee?: {
blocked?: ...;
email?: ...;
id: ...;
name?: ...;
phoneNumber?: ...;
photoUrl: ...;
surname?: ...;
};
userRefAssignee?: string;
};
id: string;
lemAI?: { name: string; photoUrl: string };
membership?: {
id: string;
roleType: string;
type: string;
user?: {
blocked?: ...;
email?: ...;
id: ...;
name?: ...;
phoneNumber?: ...;
photoUrl: ...;
surname?: ...;
};
};
ticketRef: string;
type: | "assigneeUpdated"
| "comment"
| "statusUpdated"
| "ticketCreated";
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deleteSupportTicketComment: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getScheduledCreditsTransactions
getScheduledCreditsTransactions: {
parameters: {
query?: {
customerRef?: string;
limit?: number;
nextPageToken?: string;
subscriptionRef?: string;
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
nextPageToken?: string;
scheduledTransactions: {
amount: number;
booking?: { id: string; resource: { id: string; title: string } };
company?: {
createDate: string;
id: string;
locationRef: string;
logo?: { key: ...; url: ... };
metadata?: { [key: ...]: ... };
notes?: string;
publicLogoUrl?: string;
subscriptionRef: string | null;
title: string;
};
companyRef?: string;
createDate: string;
customer: {
id: string;
logo?: { key: string; url: string };
title?: string;
type: "company" | "user";
user?: {
about?: (...) | (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
discounts?: {
coupon: {
amountOff?: ...;
currencyCode?: ...;
id: ...;
percentOff?: ...;
productTypes?: ...;
type: ...;
};
promocode?: (...)
| (...);
subscriptionId?: (...) | (...);
}[];
id: string;
locationRef: string;
membershipRef?: string;
membershipRefCreator?: string;
networkRef: string;
product?: { bookingRef?: string; title: string; type: "booking" };
resolveDate?: string;
scheduleDate: string;
status: string;
timezoneId: string;
type: "booking";
user?: {
about?: string | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userCreatedBy?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userCreator?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userOwner?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userRefCreator?: string;
userRefOwner?: string;
}[];
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getCreditsTransactions
getCreditsTransactions: {
parameters: {
query?: {
companyRef?: string;
"createDate[gte]"?: string;
"createDate[lte]"?: string;
customerRef?: string;
limit?: number;
locationRef?: string;
membershipRef?: string;
nextPageToken?: string;
status?: string;
type?: string;
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
nextPageToken?: string;
searchQueryNext?: string;
transactions: {
amount: number;
amounts: {
amount: number;
expirationDate?: string;
subscriptionRef?: string;
type: "expiring" | "permanent";
}[];
booking?: {
endDate?: string;
id: string;
resource: { id: string; title: string };
startDate?: string;
};
company?: {
createDate: string;
id: string;
locationRef: string;
logo?: { key: ...; url: ... };
metadata?: { [key: ...]: ... };
notes?: string;
publicLogoUrl?: string;
subscriptionRef: string | null;
title: string;
};
companyRef?: string;
createDate: string;
customer: {
id: string;
logo?: { key: string; url: string };
title?: string;
type: "company" | "user";
user?: {
about?: (...) | (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
description?: string;
discounts?: {
coupon: {
amountOff?: ...;
currencyCode?: ...;
id: ...;
percentOff?: ...;
productTypes?: ...;
type: ...;
};
promocode?: (...)
| (...);
subscriptionId?: (...) | (...);
}[];
expiringAmount?: number;
id: string;
locationRef: string;
membershipRef?: string;
membershipRefCreator?: string;
networkRef: string;
order?: {
id: string;
items: { id: ...; product: ...; quantity: ... }[];
};
permanentAmount?: number;
product?: {
bookingRef?: string;
eventTicketRef?: string;
orderRef?: string;
title?: string;
type?: "booking"
| "eventTicket"
| "order";
};
refund?: { amount: number; createDate: string };
status: string;
ticket?: {
createDate?: string;
event?: { endDate?: ...; id: ...; startDate?: ...; title: ... };
id: string;
quantity: number;
};
type: | "booking"
| "eventTicket"
| "order"
| "adminAllocation"
| "adminCharge"
| "expiration"
| "purchaseAllocation"
| "refund"
| "subscriptionAllocation"
| "subscriptionExpiration";
userCreatedBy?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userCreator?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userOwner?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userRefCreator?: string;
userRefOwner?: string;
}[];
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createCreditsTransaction
createCreditsTransaction: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
transaction: {
amount: number;
companyRef?: string;
customerRef?: string;
description?: string;
expirationDate?: string;
locationRef: string;
membershipRef?: string;
type: | "adminAllocation"
| "adminCharge"
| "chargeExpiringCredits"
| "chargePermanentCredits"
| "transferExpiringCredits"
| "transferPermanentCredits";
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
transaction: {
amount: number;
amounts: {
amount: number;
expirationDate?: string;
subscriptionRef?: string;
type: "expiring" | "permanent";
}[];
booking?: {
endDate?: string;
id: string;
resource: { id: string; title: string };
startDate?: string;
};
company?: {
createDate: string;
id: string;
locationRef: string;
logo?: { key: string; url: string };
metadata?: { [key: string]: unknown };
notes?: string;
publicLogoUrl?: string;
subscriptionRef: string | null;
title: string;
};
companyRef?: string;
createDate: string;
customer: {
id: string;
logo?: { key: string; url: string };
title?: string;
type: "company" | "user";
user?: {
about?: string | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
};
description?: string;
discounts?: {
coupon: {
amountOff?: (...)
| (...);
currencyCode?: (...) | (...);
id: string;
percentOff?: (...) | (...);
productTypes?: (...) | (...);
type: string;
};
promocode?: {
code: ...;
expiration?: ...;
id: ...;
limitByFirstPurchase?: ...;
};
subscriptionId?: string;
}[];
expiringAmount?: number;
id: string;
locationRef: string;
membershipRef?: string;
membershipRefCreator?: string;
networkRef: string;
order?: {
id: string;
items: {
id: string;
product: { id: ...; option?: ...; title: ... };
quantity: number;
}[];
};
permanentAmount?: number;
product?: {
bookingRef?: string;
eventTicketRef?: string;
orderRef?: string;
title?: string;
type?: "booking"
| "eventTicket"
| "order";
};
refund?: { amount: number; createDate: string };
status: string;
ticket?: {
createDate?: string;
event?: {
endDate?: (...) | (...);
id: string;
startDate?: (...) | (...);
title: string;
};
id: string;
quantity: number;
};
type: | "booking"
| "eventTicket"
| "order"
| "adminAllocation"
| "adminCharge"
| "expiration"
| "purchaseAllocation"
| "refund"
| "subscriptionAllocation"
| "subscriptionExpiration";
userCreatedBy?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userCreator?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userOwner?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userRefCreator?: string;
userRefOwner?: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getCreditsTransaction
getCreditsTransaction: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
transaction?: {
amount: number;
amounts: {
amount: number;
expirationDate?: string;
subscriptionRef?: string;
type: "expiring" | "permanent";
}[];
booking?: {
endDate?: string;
id: string;
resource: { id: string; title: string };
startDate?: string;
};
company?: {
createDate: string;
id: string;
locationRef: string;
logo?: { key: ...; url: ... };
metadata?: { [key: ...]: ... };
notes?: string;
publicLogoUrl?: string;
subscriptionRef: string | null;
title: string;
};
companyRef?: string;
createDate: string;
customer: {
id: string;
logo?: { key: string; url: string };
title?: string;
type: "company" | "user";
user?: {
about?: (...) | (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
description?: string;
discounts?: {
coupon: {
amountOff?: ...;
currencyCode?: ...;
id: ...;
percentOff?: ...;
productTypes?: ...;
type: ...;
};
promocode?: (...)
| (...);
subscriptionId?: (...) | (...);
}[];
expiringAmount?: number;
id: string;
locationRef: string;
membershipRef?: string;
membershipRefCreator?: string;
networkRef: string;
order?: {
id: string;
items: { id: ...; product: ...; quantity: ... }[];
};
permanentAmount?: number;
product?: {
bookingRef?: string;
eventTicketRef?: string;
orderRef?: string;
title?: string;
type?: "booking"
| "eventTicket"
| "order";
};
refund?: { amount: number; createDate: string };
status: string;
ticket?: {
createDate?: string;
event?: { endDate?: ...; id: ...; startDate?: ...; title: ... };
id: string;
quantity: number;
};
type: | "booking"
| "eventTicket"
| "order"
| "adminAllocation"
| "adminCharge"
| "expiration"
| "purchaseAllocation"
| "refund"
| "subscriptionAllocation"
| "subscriptionExpiration";
userCreatedBy?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userCreator?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userOwner?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userRefCreator?: string;
userRefOwner?: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getScheduledDayPassesTransactions
getScheduledDayPassesTransactions: {
parameters: {
query?: {
customerRef?: string;
limit?: number;
nextPageToken?: string;
subscriptionRef?: string;
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
nextPageToken?: string;
scheduledTransactions: {
amount: number;
booking?: { id: string; resource: { id: string; title: string } };
company?: {
createDate: string;
id: string;
locationRef: string;
logo?: { key: ...; url: ... };
metadata?: { [key: ...]: ... };
notes?: string;
publicLogoUrl?: string;
subscriptionRef: string | null;
title: string;
};
companyRef?: string;
createDate: string;
customer: {
id: string;
logo?: { key: string; url: string };
title?: string;
type: "company" | "user";
user?: {
about?: (...) | (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
id: string;
locationRef: string;
membershipRef?: string;
membershipRefCreator?: string;
networkRef: string;
product?: { bookingRef?: string; title: string; type: "booking" };
resolveDate?: string;
scheduleDate: string;
status: string;
timezoneId: string;
type: "booking";
user?: {
about?: string | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userCreatedBy?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userCreator?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userOwner?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userRefCreator?: string;
userRefOwner?: string;
}[];
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getDayPassesTransactions
getDayPassesTransactions: {
parameters: {
query?: {
companyRef?: string;
"createDate[gte]"?: string;
"createDate[lte]"?: string;
customerRef?: string;
limit?: number;
locationRef?: string;
membershipRef?: string;
nextPageToken?: string;
type?: string;
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
nextPageToken?: string;
searchQueryNext?: string;
transactions: {
amount: number;
amounts: {
amount: number;
expirationDate?: string;
subscriptionRef?: string;
type: "expiring" | "permanent";
}[];
booking?: { id: string; resource: { id: string; title: string } };
company?: {
createDate: string;
id: string;
locationRef: string;
logo?: { key: ...; url: ... };
metadata?: { [key: ...]: ... };
notes?: string;
publicLogoUrl?: string;
subscriptionRef: string | null;
title: string;
};
companyRef?: string;
createDate: string;
customer: {
id: string;
logo?: { key: string; url: string };
title?: string;
type: "company" | "user";
user?: {
about?: (...) | (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
description?: string;
id: string;
locationRef: string;
membershipRef?: string;
membershipRefCreator?: string;
networkRef: string;
product?: { bookingRef?: string; title: string; type: "booking" };
refund?: { amount: number; createDate: string };
status: string;
type:
| "booking"
| "adminAllocation"
| "adminCharge"
| "expiration"
| "purchaseAllocation"
| "refund"
| "subscriptionAllocation"
| "subscriptionExpiration";
user?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userCreatedBy?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userCreator?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userOwner?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userRefCreator?: string;
userRefOwner?: string;
}[];
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createDayPassesTransaction
createDayPassesTransaction: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
transaction: {
amount: number;
companyRef?: string;
customerRef?: string;
description?: string;
expirationDate?: string;
locationRef: string;
membershipRef?: string;
type: | "adminAllocation"
| "adminCharge"
| "chargeExpiringDayPasses"
| "chargePermanentDayPasses"
| "transferExpiringDayPasses"
| "transferPermanentDayPasses";
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
transaction: {
amount: number;
amounts: {
amount: number;
expirationDate?: string;
subscriptionRef?: string;
type: "expiring" | "permanent";
}[];
booking?: { id: string; resource: { id: string; title: string } };
company?: {
createDate: string;
id: string;
locationRef: string;
logo?: { key: string; url: string };
metadata?: { [key: string]: unknown };
notes?: string;
publicLogoUrl?: string;
subscriptionRef: string | null;
title: string;
};
companyRef?: string;
createDate: string;
customer: {
id: string;
logo?: { key: string; url: string };
title?: string;
type: "company" | "user";
user?: {
about?: string | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
};
description?: string;
id: string;
locationRef: string;
membershipRef?: string;
membershipRefCreator?: string;
networkRef: string;
product?: { bookingRef?: string; title: string; type: "booking" };
refund?: { amount: number; createDate: string };
status: string;
type:
| "booking"
| "adminAllocation"
| "adminCharge"
| "expiration"
| "purchaseAllocation"
| "refund"
| "subscriptionAllocation"
| "subscriptionExpiration";
user?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userCreatedBy?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userCreator?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userOwner?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userRefCreator?: string;
userRefOwner?: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getDayPassesTransaction
getDayPassesTransaction: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
transaction?: {
amount: number;
amounts: {
amount: number;
expirationDate?: string;
subscriptionRef?: string;
type: "expiring" | "permanent";
}[];
booking?: { id: string; resource: { id: string; title: string } };
company?: {
createDate: string;
id: string;
locationRef: string;
logo?: { key: ...; url: ... };
metadata?: { [key: ...]: ... };
notes?: string;
publicLogoUrl?: string;
subscriptionRef: string | null;
title: string;
};
companyRef?: string;
createDate: string;
customer: {
id: string;
logo?: { key: string; url: string };
title?: string;
type: "company" | "user";
user?: {
about?: (...) | (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
description?: string;
id: string;
locationRef: string;
membershipRef?: string;
membershipRefCreator?: string;
networkRef: string;
product?: { bookingRef?: string; title: string; type: "booking" };
refund?: { amount: number; createDate: string };
status: string;
type:
| "booking"
| "adminAllocation"
| "adminCharge"
| "expiration"
| "purchaseAllocation"
| "refund"
| "subscriptionAllocation"
| "subscriptionExpiration";
user?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userCreatedBy?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userCreator?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userOwner?: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userRefCreator?: string;
userRefOwner?: string;
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getMoneyTransactions
getMoneyTransactions: {
parameters: {
query: {
locationRef: string;
limit?: number;
status?: "canceled" | "failed" | "pending" | "processing" | "succeeded";
type?:
| "creditPackage"
| "booking"
| "eventTicket"
| "subscription"
| "order"
| "invoice";
createDate?: { lte?: string; gte?: string };
nextPageToken?: string;
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
transactions?: {
amount?: number;
booking?: {
id?: (...) | (...);
resource?: (...) | (...);
price?: (...) | (...);
};
company?: {
billingAddress?: (...)
| (...);
businessAddress?: (...) | (...);
createDate?: (...) | (...);
credits?: (...) | (...);
dayPasses?: (...) | (...);
deleteDate?: (...) | (...);
id?: (...) | (...);
legalName?: (...) | (...);
locationRef?: (...) | (...);
metadata?: (...) | (...);
notes?: (...) | (...);
subscriptionRef?: (...) | (...);
taxId?: (...) | (...);
title?: (...) | (...);
};
createDate?: string;
creditPackage?: { amount?: (...)
| (...); price?: (...) | (...) };
currencyCode?: string;
id?: string;
invoice?: { id?: (...) | (...); title?: (...) | (...) };
locationRef?: string;
membershipRef?: string;
order?: {
id?: (...) | (...);
option?: (...) | (...);
price?: (...) | (...);
product?: (...) | (...);
};
paymentMethod?: {
label?: (...)
| (...);
type?:
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...);
};
plan?: { id?: (...)
| (...); title?: (...) | (...) };
refund?: { amount?: (...) | (...); createDate?: (...) | (...) };
status?:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
ticket?: {
createDate?: (...)
| (...);
id?: (...) | (...);
event?: (...) | (...);
price?: (...) | (...);
};
type?: string;
user?: {
about?: (...)
| (...);
email?: (...) | (...);
id?: (...) | (...);
name?: (...) | (...);
phoneNumber?: (...) | (...);
photoUrl?: (...) | (...);
surname?: (...) | (...);
};
}[];
nextPageToken?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getMoneyTransaction
getMoneyTransaction: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
transaction?: {
amount?: number;
booking?: {
id?: string;
resource?: { id?: ...; title?: ... };
price?: { netAmount?: ...; taxAmount?: ... };
};
company?: {
billingAddress?: string;
businessAddress?: {
city?: ...;
countryCode?: ...;
line1?: ...;
line2?: ...;
postalCode?: ...;
state?: ...;
};
createDate?: string;
credits?: { expiring?: ...; permanent?: ... };
dayPasses?: { expiring?: ... };
deleteDate?: string;
id?: string;
legalName?: string;
locationRef?: string;
metadata?: Record<(...), (...)>;
notes?: string;
subscriptionRef?: string;
taxId?: string;
title?: string;
};
createDate?: string;
creditPackage?: {
amount?: number;
price?: { netAmount?: ...; taxAmount?: ... };
};
currencyCode?: string;
id?: string;
invoice?: { id?: string; title?: string };
locationRef?: string;
membershipRef?: string;
order?: {
id?: string;
option?: { id?: ...; name?: ... };
price?: { netAmount?: ...; taxAmount?: ... };
product?: { id?: ...; title?: ... };
};
paymentMethod?: {
label?: string;
type?: | "external"
| "flow"
| "fondy"
| "freedompay"
| "kakaopay"
| "mercadopago"
| "paypal"
| "paystack"
| "plata"
| "stripe"
| "tap"
| "wayforpay";
};
plan?: { id?: string; title?: string };
refund?: { amount?: number; createDate?: string };
status?:
| "canceled"
| "failed"
| "pending"
| "processing"
| "succeeded";
ticket?: {
createDate?: string;
id?: string;
event?: { endDate?: ...; id?: ...; startDate?: ...; title?: ... };
price?: { netAmount?: ...; taxAmount?: ... };
};
type?: string;
user?: {
about?: string;
email?: string;
id?: string;
name?: string;
phoneNumber?: string;
photoUrl?: string;
surname?: string;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getCreditsBalance
getCreditsBalance: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
balances?: {
allocation?: number;
amount?: number;
crossLocationUsage?: number;
expirationDate?: string;
subscriptionRef?: string;
}[];
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getDayPassesBalance
getDayPassesBalance: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
balances?: {
allocation?: number;
amount?: number;
crossLocationUsage?: number;
expirationDate?: string;
subscriptionRef?: string;
}[];
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getContacts: {
parameters: {
query: {
limit?: number;
nextPageToken?: string;
locationRef: string;
createDate?: { lte?: string; gte?: string };
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
contacts?: {
createDate: string;
date: string;
id: string;
locationRef: string;
userRefVisitor: string;
visitor: {
email: string;
name: string;
phoneNumber?: string;
surname?: string;
};
}[];
nextPageToken?: string;
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createContact: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
contact: {
locationRef: string;
visitor: {
email: string;
name: string;
phoneNumber?: string;
surname?: string;
};
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
contact?: {
createDate: string;
date: string;
id: string;
locationRef: string;
userRefVisitor: string;
visitor: {
email: string;
name: string;
phoneNumber?: string;
surname?: string;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getContact: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { contactId: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
contact?: {
createDate: string;
date: string;
id: string;
locationRef: string;
userRefVisitor: string;
visitor: {
email: string;
name: string;
phoneNumber?: string;
surname?: string;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getRequests
getRequests: {
parameters: {
query: {
locationRef: string;
nextPageToken?: string;
limit?: number;
createDate?: { lte?: string; gte?: string };
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
nextPageToken?: string;
requests?: {
createDate: string;
id: string;
locationRef: string;
membershipRefHost: string;
userHost?: {
id: string;
name?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
userRefHost: string;
userRefVisitor: string;
visitor: {
email: string;
name: string;
phoneNumber?: string;
surname?: string;
};
}[];
searchQueryNext?: string;
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createRequest
createRequest: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
request: {
locationRef: string;
userRefHost: string;
visitor: {
email: string;
name: string;
phoneNumber?: string;
surname?: string;
};
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
request?: {
createDate: string;
id: string;
locationRef: string;
membershipRefHost: string;
userHost?: {
id: string;
name?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userRefHost: string;
userRefVisitor: string;
visitor: {
email: string;
name: string;
phoneNumber?: string;
surname?: string;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getRequest
getRequest: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
request?: {
createDate: string;
id: string;
locationRef: string;
membershipRefHost: string;
userHost?: {
id: string;
name?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userRefHost: string;
userRefVisitor: string;
visitor: {
email: string;
name: string;
phoneNumber?: string;
surname?: string;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
approveRequest
approveRequest: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
visit?: {
checkInDate?: string;
checkInRef?: string;
checkOutDate?: string;
code: string;
comment?: string;
createDate: string;
customer: {
company?: { id: string; title: string };
id: string;
user: {
about?: string | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
};
date: string;
deleteDate?: string;
id: string;
location: {
address?: string;
id: string;
timezoneId: string;
title: string;
};
locationRef: string;
membershipRefHost: string;
userHost: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userRefHost: string;
userRefVisitor: string;
visitor: {
email: string;
name: string;
phoneNumber?: string;
surname?: string;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
rejectRequest
rejectRequest: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getVisits
getVisits: {
parameters: {
query: {
locationRef: string;
userRefHost?: string;
createDate?: { lte?: string; gte?: string };
date?: { lte?: string; gte?: string };
limit?: number;
nextPageToken?: string;
};
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
nextPageToken?: string;
searchQueryNext?: string;
visits?: {
checkInDate?: string;
checkInRef?: string;
checkOutDate?: string;
code: string;
comment?: string;
createDate: string;
customer: {
company?: { id: ...; title: ... };
id: string;
user: {
about?: (...) | (...) | (...);
email?: (...) | (...) | (...);
id: string;
name?: (...) | (...) | (...);
phoneNumber?: (...) | (...) | (...);
photoUrl?: (...) | (...) | (...);
surname?: (...) | (...) | (...);
};
};
date: string;
deleteDate?: string;
id: string;
location: {
address?: string;
id: string;
timezoneId: string;
title: string;
};
locationRef: string;
membershipRefHost: string;
userHost: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userRefHost: string;
userRefVisitor: string;
visitor: {
email: string;
name: string;
phoneNumber?: string;
surname?: string;
};
}[];
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
createVisit
createVisit: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: {
"application/json": {
visit: {
comment?: string;
date: string;
locationRef: string;
visitor: {
email: string;
name: string;
phoneNumber?: string;
surname?: string;
};
};
};
};
};
responses: {
"201": {
headers: { [name: string]: unknown };
content: {
"application/json": {
visit?: {
checkInDate?: string;
checkInRef?: string;
checkOutDate?: string;
code: string;
comment?: string;
createDate: string;
customer: {
company?: { id: string; title: string };
id: string;
user: {
about?: string | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
};
date: string;
deleteDate?: string;
id: string;
location: {
address?: string;
id: string;
timezoneId: string;
title: string;
};
locationRef: string;
membershipRefHost: string;
userHost: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userRefHost: string;
userRefVisitor: string;
visitor: {
email: string;
name: string;
phoneNumber?: string;
surname?: string;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
getVisit
getVisit: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
visit?: {
checkInDate?: string;
checkInRef?: string;
checkOutDate?: string;
code: string;
comment?: string;
createDate: string;
customer: {
company?: { id: string; title: string };
id: string;
user: {
about?: string | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
};
date: string;
deleteDate?: string;
id: string;
location: {
address?: string;
id: string;
timezoneId: string;
title: string;
};
locationRef: string;
membershipRefHost: string;
userHost: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userRefHost: string;
userRefVisitor: string;
visitor: {
email: string;
name: string;
phoneNumber?: string;
surname?: string;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
updateVisit
updateVisit: {
parameters: {
query?: undefined;
header?: undefined;
path: { id: string };
cookie?: undefined;
};
requestBody: {
content: {
"application/json": { visit: { comment?: string; date: string } };
};
};
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
visit?: {
checkInDate?: string;
checkInRef?: string;
checkOutDate?: string;
code: string;
comment?: string;
createDate: string;
customer: {
company?: { id: string; title: string };
id: string;
user: {
about?: string | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
};
date: string;
deleteDate?: string;
id: string;
location: {
address?: string;
id: string;
timezoneId: string;
title: string;
};
locationRef: string;
membershipRefHost: string;
userHost: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userRefHost: string;
userRefVisitor: string;
visitor: {
email: string;
name: string;
phoneNumber?: string;
surname?: string;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
deleteVisit
deleteVisit: {
parameters: {
query?: undefined;
header?: undefined;
path: { id: string };
cookie?: undefined;
};
requestBody?: undefined;
responses: {
"204": { headers: { [name: string]: unknown }; content?: undefined };
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
checkInVisit
checkInVisit: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: { "application/json": { code: string; locationRef: string } };
};
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
visit?: {
checkInDate?: string;
checkInRef?: string;
checkOutDate?: string;
code: string;
comment?: string;
createDate: string;
customer: {
company?: { id: string; title: string };
id: string;
user: {
about?: string | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
};
date: string;
deleteDate?: string;
id: string;
location: {
address?: string;
id: string;
timezoneId: string;
title: string;
};
locationRef: string;
membershipRefHost: string;
userHost: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userRefHost: string;
userRefVisitor: string;
visitor: {
email: string;
name: string;
phoneNumber?: string;
surname?: string;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}
checkOutVisit
checkOutVisit: {
parameters: {
query?: undefined;
header?: { "spacebring-network-id"?: string };
path?: undefined;
cookie?: undefined;
};
requestBody: {
content: { "application/json": { code: string; locationRef: string } };
};
responses: {
"200": {
headers: { [name: string]: unknown };
content: {
"application/json": {
visit?: {
checkInDate?: string;
checkInRef?: string;
checkOutDate?: string;
code: string;
comment?: string;
createDate: string;
customer: {
company?: { id: string; title: string };
id: string;
user: {
about?: string | null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
};
date: string;
deleteDate?: string;
id: string;
location: {
address?: string;
id: string;
timezoneId: string;
title: string;
};
locationRef: string;
membershipRefHost: string;
userHost: {
about?: string
| null;
email?: string | null;
id: string;
name?: string | null;
phoneNumber?: string | null;
photoUrl?: string | null;
surname?: string | null;
};
userRefHost: string;
userRefVisitor: string;
visitor: {
email: string;
name: string;
phoneNumber?: string;
surname?: string;
};
};
};
};
};
"400": {
headers: { [name: string]: unknown };
content: { "application/json": { message?: string; type?: string } };
};
};
}