@ember-home/unbound-ts-client 0.0.18 → 0.0.19

package/dist/index.d.ts

@@ -490,6 +490,17 @@ declare const ContactListingType: {
     readonly Owner: "OWNER";
 };
 type ContactListingType = typeof ContactListingType[keyof typeof ContactListingType];
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+declare const ContactSortBy: {
+    readonly LastFirstCompany: "last_first_company";
+    readonly FirstLastCompany: "first_last_company";
+    readonly CompanyLastFirst: "company_last_first";
+};
+type ContactSortBy = typeof ContactSortBy[keyof typeof ContactSortBy];
 /**
  *
  * @export
@@ -629,7 +640,7 @@ interface Contacts {
      * @type {string}
      * @memberof Contacts
      */
-    'local'?: string;
+    'locale'?: string;
     /**
      *
      * @type {string}
@@ -804,7 +815,7 @@ interface ContactsCreate {
      * @type {string}
      * @memberof ContactsCreate
      */
-    'local'?: string;
+    'locale'?: string;
     /**
      *
      * @type {string}
@@ -979,7 +990,7 @@ interface ContactsGet {
      * @type {string}
      * @memberof ContactsGet
      */
-    'local'?: string;
+    'locale'?: string;
     /**
      *
      * @type {string}
@@ -1154,7 +1165,7 @@ interface ContactsUpdate {
      * @type {string}
      * @memberof ContactsUpdate
      */
-    'local'?: string;
+    'locale'?: string;
     /**
      *
      * @type {string}
@@ -1647,6 +1658,16 @@ interface PaginatedResponseContacts {
      */
     'total'?: number;
 }
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+declare const PaginationDirection: {
+    readonly Forward: "forward";
+    readonly Backward: "backward";
+};
+type PaginationDirection = typeof PaginationDirection[keyof typeof PaginationDirection];
 /**
  *
  * @export
@@ -1789,6 +1810,16 @@ interface ReservationsList {
      */
     'totalPrice': number;
 }
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+declare const SortOrder: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+type SortOrder = typeof SortOrder[keyof typeof SortOrder];
 /**
  *
  * @export
@@ -2016,12 +2047,15 @@ declare const ContactsApiAxiosParamCreator: (configuration?: Configuration) => {
      *
      * @summary Contacts List
      * @param {string} [searchString]
-     * @param {string | null} [after] Cursor for keyset paging
+     * @param {string | null} [cursor] Cursor for keyset paging
      * @param {number} [limit]
+     * @param {PaginationDirection} [pageDir] Direction of paging
+     * @param {ContactSortBy} [sortBy] Sort key
+     * @param {SortOrder} [sortOrder] Sort order asc/desc
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    contactsList: (searchString?: string, after?: string | null, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    contactsList: (searchString?: string, cursor?: string | null, limit?: number, pageDir?: PaginationDirection, sortBy?: ContactSortBy, sortOrder?: SortOrder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Removes an association between a contact and a listing.
      * @summary Delete Contact Listing
@@ -2155,12 +2189,15 @@ declare const ContactsApiFp: (configuration?: Configuration) => {
      *
      * @summary Contacts List
      * @param {string} [searchString]
-     * @param {string | null} [after] Cursor for keyset paging
+     * @param {string | null} [cursor] Cursor for keyset paging
      * @param {number} [limit]
+     * @param {PaginationDirection} [pageDir] Direction of paging
+     * @param {ContactSortBy} [sortBy] Sort key
+     * @param {SortOrder} [sortOrder] Sort order asc/desc
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    contactsList(searchString?: string, after?: string | null, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedResponseContacts>>;
+    contactsList(searchString?: string, cursor?: string | null, limit?: number, pageDir?: PaginationDirection, sortBy?: ContactSortBy, sortOrder?: SortOrder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedResponseContacts>>;
     /**
      * Removes an association between a contact and a listing.
      * @summary Delete Contact Listing
@@ -2294,12 +2331,15 @@ declare const ContactsApiFactory: (configuration?: Configuration, basePath?: str
      *
      * @summary Contacts List
      * @param {string} [searchString]
-     * @param {string | null} [after] Cursor for keyset paging
+     * @param {string | null} [cursor] Cursor for keyset paging
      * @param {number} [limit]
+     * @param {PaginationDirection} [pageDir] Direction of paging
+     * @param {ContactSortBy} [sortBy] Sort key
+     * @param {SortOrder} [sortOrder] Sort order asc/desc
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    contactsList(searchString?: string, after?: string | null, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedResponseContacts>;
+    contactsList(searchString?: string, cursor?: string | null, limit?: number, pageDir?: PaginationDirection, sortBy?: ContactSortBy, sortOrder?: SortOrder, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedResponseContacts>;
     /**
      * Removes an association between a contact and a listing.
      * @summary Delete Contact Listing
@@ -2442,13 +2482,16 @@ declare class ContactsApi extends BaseAPI {
      *
      * @summary Contacts List
      * @param {string} [searchString]
-     * @param {string | null} [after] Cursor for keyset paging
+     * @param {string | null} [cursor] Cursor for keyset paging
      * @param {number} [limit]
+     * @param {PaginationDirection} [pageDir] Direction of paging
+     * @param {ContactSortBy} [sortBy] Sort key
+     * @param {SortOrder} [sortOrder] Sort order asc/desc
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ContactsApi
      */
-    contactsList(searchString?: string, after?: string | null, limit?: number, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<PaginatedResponseContacts, any>>;
+    contactsList(searchString?: string, cursor?: string | null, limit?: number, pageDir?: PaginationDirection, sortBy?: ContactSortBy, sortOrder?: SortOrder, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<PaginatedResponseContacts, any>>;
     /**
      * Removes an association between a contact and a listing.
      * @summary Delete Contact Listing
@@ -2742,10 +2785,11 @@ declare const ListingsApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
      * List all listings
      * @summary Listings List
+     * @param {string} [contactId]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listingsList: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    listingsList: (contactId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * ListingsApi - functional programming interface
@@ -2755,10 +2799,11 @@ declare const ListingsApiFp: (configuration?: Configuration) => {
     /**
      * List all listings
      * @summary Listings List
+     * @param {string} [contactId]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listingsList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListResponseListingsList>>;
+    listingsList(contactId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListResponseListingsList>>;
 };
 /**
  * ListingsApi - factory interface
@@ -2768,10 +2813,11 @@ declare const ListingsApiFactory: (configuration?: Configuration, basePath?: str
     /**
      * List all listings
      * @summary Listings List
+     * @param {string} [contactId]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listingsList(options?: RawAxiosRequestConfig): AxiosPromise<ListResponseListingsList>;
+    listingsList(contactId?: string, options?: RawAxiosRequestConfig): AxiosPromise<ListResponseListingsList>;
 };
 /**
  * ListingsApi - object-oriented interface
@@ -2783,11 +2829,12 @@ declare class ListingsApi extends BaseAPI {
     /**
      * List all listings
      * @summary Listings List
+     * @param {string} [contactId]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ListingsApi
      */
-    listingsList(options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ListResponseListingsList, any>>;
+    listingsList(contactId?: string, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ListResponseListingsList, any>>;
 }
 /**
  * PhonesApi - axios parameter creator
@@ -3013,12 +3060,15 @@ declare const UnboundApiAxiosParamCreator: (configuration?: Configuration) => {
      *
      * @summary Contacts List
      * @param {string} [searchString]
-     * @param {string | null} [after] Cursor for keyset paging
+     * @param {string | null} [cursor] Cursor for keyset paging
      * @param {number} [limit]
+     * @param {PaginationDirection} [pageDir] Direction of paging
+     * @param {ContactSortBy} [sortBy] Sort key
+     * @param {SortOrder} [sortOrder] Sort order asc/desc
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    contactsList: (searchString?: string, after?: string | null, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    contactsList: (searchString?: string, cursor?: string | null, limit?: number, pageDir?: PaginationDirection, sortBy?: ContactSortBy, sortOrder?: SortOrder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Removes an association between a contact and a listing.
      * @summary Delete Contact Listing
@@ -3076,10 +3126,11 @@ declare const UnboundApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
      * List all listings
      * @summary Listings List
+     * @param {string} [contactId]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listingsList: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    listingsList: (contactId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Phones Create
@@ -3183,12 +3234,15 @@ declare const UnboundApiFp: (configuration?: Configuration) => {
      *
      * @summary Contacts List
      * @param {string} [searchString]
-     * @param {string | null} [after] Cursor for keyset paging
+     * @param {string | null} [cursor] Cursor for keyset paging
      * @param {number} [limit]
+     * @param {PaginationDirection} [pageDir] Direction of paging
+     * @param {ContactSortBy} [sortBy] Sort key
+     * @param {SortOrder} [sortOrder] Sort order asc/desc
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    contactsList(searchString?: string, after?: string | null, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedResponseContacts>>;
+    contactsList(searchString?: string, cursor?: string | null, limit?: number, pageDir?: PaginationDirection, sortBy?: ContactSortBy, sortOrder?: SortOrder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedResponseContacts>>;
     /**
      * Removes an association between a contact and a listing.
      * @summary Delete Contact Listing
@@ -3246,10 +3300,11 @@ declare const UnboundApiFp: (configuration?: Configuration) => {
     /**
      * List all listings
      * @summary Listings List
+     * @param {string} [contactId]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listingsList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListResponseListingsList>>;
+    listingsList(contactId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListResponseListingsList>>;
     /**
      *
      * @summary Phones Create
@@ -3353,12 +3408,15 @@ declare const UnboundApiFactory: (configuration?: Configuration, basePath?: stri
      *
      * @summary Contacts List
      * @param {string} [searchString]
-     * @param {string | null} [after] Cursor for keyset paging
+     * @param {string | null} [cursor] Cursor for keyset paging
      * @param {number} [limit]
+     * @param {PaginationDirection} [pageDir] Direction of paging
+     * @param {ContactSortBy} [sortBy] Sort key
+     * @param {SortOrder} [sortOrder] Sort order asc/desc
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    contactsList(searchString?: string, after?: string | null, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedResponseContacts>;
+    contactsList(searchString?: string, cursor?: string | null, limit?: number, pageDir?: PaginationDirection, sortBy?: ContactSortBy, sortOrder?: SortOrder, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedResponseContacts>;
     /**
      * Removes an association between a contact and a listing.
      * @summary Delete Contact Listing
@@ -3416,10 +3474,11 @@ declare const UnboundApiFactory: (configuration?: Configuration, basePath?: stri
     /**
      * List all listings
      * @summary Listings List
+     * @param {string} [contactId]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listingsList(options?: RawAxiosRequestConfig): AxiosPromise<ListResponseListingsList>;
+    listingsList(contactId?: string, options?: RawAxiosRequestConfig): AxiosPromise<ListResponseListingsList>;
     /**
      *
      * @summary Phones Create
@@ -3532,13 +3591,16 @@ declare class UnboundApi extends BaseAPI {
      *
      * @summary Contacts List
      * @param {string} [searchString]
-     * @param {string | null} [after] Cursor for keyset paging
+     * @param {string | null} [cursor] Cursor for keyset paging
      * @param {number} [limit]
+     * @param {PaginationDirection} [pageDir] Direction of paging
+     * @param {ContactSortBy} [sortBy] Sort key
+     * @param {SortOrder} [sortOrder] Sort order asc/desc
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof UnboundApi
      */
-    contactsList(searchString?: string, after?: string | null, limit?: number, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<PaginatedResponseContacts, any>>;
+    contactsList(searchString?: string, cursor?: string | null, limit?: number, pageDir?: PaginationDirection, sortBy?: ContactSortBy, sortOrder?: SortOrder, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<PaginatedResponseContacts, any>>;
     /**
      * Removes an association between a contact and a listing.
      * @summary Delete Contact Listing
@@ -3602,11 +3664,12 @@ declare class UnboundApi extends BaseAPI {
     /**
      * List all listings
      * @summary Listings List
+     * @param {string} [contactId]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof UnboundApi
      */
-    listingsList(options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ListResponseListingsList, any>>;
+    listingsList(contactId?: string, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ListResponseListingsList, any>>;
     /**
      *
      * @summary Phones Create
@@ -3646,4 +3709,4 @@ declare class UnboundApi extends BaseAPI {
     webhook(hostawayWebhook: HostawayWebhook, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<any, any>>;
 }
 
-export { type APIValidationError, type APIValidationErrorLocInner, type AddressApi, type AddressCreate, type AddressItemApi, type AddressUpdate, AddressesApi, AddressesApiAxiosParamCreator, AddressesApiFactory, AddressesApiFp, type AddressesCreate, type AddressesUpdate, Configuration, type ConfigurationParameters, type ContactCreate, ContactListingType, type ContactTypeDataApi, type ContactUpdate, type Contacts, ContactsApi, ContactsApiAxiosParamCreator, ContactsApiFactory, ContactsApiFp, type ContactsCreate, type ContactsGet, type ContactsUpdate, type CreateContactListing, type DeleteContactListing, type EmailApi, type EmailCreate, EmailsApi, EmailsApiAxiosParamCreator, EmailsApiFactory, EmailsApiFp, type EmailsCreate, type GuestDataApi, type HTTPValidationError, HostawayApi, HostawayApiAxiosParamCreator, HostawayApiFactory, HostawayApiFp, type HostawayWebhook, InquiriesApi, InquiriesApiAxiosParamCreator, InquiriesApiFactory, InquiriesApiFp, type LeadDataApi, type ListResponseInquiriesList, type ListResponseListingsList, type ListResponseReservationsList, ListingsApi, ListingsApiAxiosParamCreator, ListingsApiFactory, ListingsApiFp, type ListingsList, type OwnerDataApi, type PaginatedResponseContacts, type PhoneApi, type PhoneCreate, PhonesApi, PhonesApiAxiosParamCreator, PhonesApiFactory, PhonesApiFp, type PhonesCreate, ReservationsApi, ReservationsApiAxiosParamCreator, ReservationsApiFactory, ReservationsApiFp, type ReservationsList, UnboundApi, UnboundApiAxiosParamCreator, UnboundApiFactory, UnboundApiFp, type UpdateContactListing };
+export { type APIValidationError, type APIValidationErrorLocInner, type AddressApi, type AddressCreate, type AddressItemApi, type AddressUpdate, AddressesApi, AddressesApiAxiosParamCreator, AddressesApiFactory, AddressesApiFp, type AddressesCreate, type AddressesUpdate, Configuration, type ConfigurationParameters, type ContactCreate, ContactListingType, ContactSortBy, type ContactTypeDataApi, type ContactUpdate, type Contacts, ContactsApi, ContactsApiAxiosParamCreator, ContactsApiFactory, ContactsApiFp, type ContactsCreate, type ContactsGet, type ContactsUpdate, type CreateContactListing, type DeleteContactListing, type EmailApi, type EmailCreate, EmailsApi, EmailsApiAxiosParamCreator, EmailsApiFactory, EmailsApiFp, type EmailsCreate, type GuestDataApi, type HTTPValidationError, HostawayApi, HostawayApiAxiosParamCreator, HostawayApiFactory, HostawayApiFp, type HostawayWebhook, InquiriesApi, InquiriesApiAxiosParamCreator, InquiriesApiFactory, InquiriesApiFp, type LeadDataApi, type ListResponseInquiriesList, type ListResponseListingsList, type ListResponseReservationsList, ListingsApi, ListingsApiAxiosParamCreator, ListingsApiFactory, ListingsApiFp, type ListingsList, type OwnerDataApi, type PaginatedResponseContacts, PaginationDirection, type PhoneApi, type PhoneCreate, PhonesApi, PhonesApiAxiosParamCreator, PhonesApiFactory, PhonesApiFp, type PhonesCreate, ReservationsApi, ReservationsApiAxiosParamCreator, ReservationsApiFactory, ReservationsApiFp, type ReservationsList, SortOrder, UnboundApi, UnboundApiAxiosParamCreator, UnboundApiFactory, UnboundApiFp, type UpdateContactListing };