@parra/parra-js-sdk 0.3.119 → 0.3.121

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1432,6 +1432,15 @@ export interface UpdateChannelRequestBody {
1432
1432
  apns?: UpdateApnsChannelRequestBody;
1433
1433
  inbox?: UpdateInboxChannelRequestBody;
1434
1434
  }
1435
+ export interface SubdomainAvailabilityRequestBody {
1436
+ subdomain: string;
1437
+ }
1438
+ export interface SubdomainAvailabilityResponse {
1439
+ subdomain?: string | null;
1440
+ available: boolean;
1441
+ valid: boolean;
1442
+ message?: string | null;
1443
+ }
1435
1444
  export interface TenantUserInfo {
1436
1445
  roles: Array<string>;
1437
1446
  user: TenantUser;
@@ -1570,6 +1579,7 @@ export interface TenantMetrics {
1570
1579
  }
1571
1580
  export interface CreateTenantRequestBody {
1572
1581
  name: string;
1582
+ subdomain?: string | null;
1573
1583
  is_test: boolean;
1574
1584
  parent_tenant_id?: string | null;
1575
1585
  }
@@ -1579,6 +1589,7 @@ export interface Tenant {
1579
1589
  updated_at: string;
1580
1590
  deleted_at?: string | null;
1581
1591
  name: string;
1592
+ subdomain?: string | null;
1582
1593
  is_test: boolean;
1583
1594
  parent_tenant_id?: string | null;
1584
1595
  onboarding?: TenantOnboarding | null;
@@ -1841,6 +1852,7 @@ export interface TenantUserCollectionResponse {
1841
1852
  }
1842
1853
  export interface UpdateTenantRequestBody {
1843
1854
  name?: string;
1855
+ subdomain?: string | null;
1844
1856
  onboarding_skipped?: boolean;
1845
1857
  onboarding_goal?: string | null;
1846
1858
  application_onboarding_skipped?: boolean;
@@ -1877,29 +1889,32 @@ export interface UserCollectionResponse {
1877
1889
  total_count: number;
1878
1890
  data: Array<UserResponse>;
1879
1891
  }
1892
+ type Options = {
1893
+ signal?: AbortSignal | null;
1894
+ };
1880
1895
  declare class ParraAPI {
1881
1896
  private http;
1882
1897
  private options;
1883
1898
  constructor(http: HTTPClient, options: {
1884
1899
  baseUrl: string;
1885
1900
  });
1886
- checkAuthorization: (body: CheckAuthorizationRequestBody) => Promise<CheckAuthorization>;
1887
- getUserInfo: () => Promise<UserInfoResponse>;
1888
- getParraAuthToken: () => Promise<AuthToken>;
1889
- uploadImageAssetForTenantById: (tenant_id: string, body: UploadImageWithGroupRequestBody) => Promise<ImageAsset>;
1890
- uploadAvatarForUser: (body: UploadImageRequestBody) => Promise<ImageAssetStub>;
1891
- uploadAvatarForTenantUser: (tenant_id: string, body: UploadImageRequestBody) => Promise<ImageAssetStub>;
1892
- uploadIconForTenantApplication: (tenant_id: string, application_id: string, body: UploadImageRequestBody) => Promise<ImageAsset>;
1893
- uploadHeaderForTenantRelease: (tenant_id: string, release_id: string, body: UploadImageRequestBody) => Promise<ImageAsset>;
1894
- uploadAttachmentForTicketById: (tenant_id: string, ticket_id: string, body: UploadImageRequestBody) => Promise<ImageAsset>;
1895
- uploadLogoForTenantById: (tenant_id: string, body: UploadImageRequestBody) => Promise<ImageAsset>;
1896
- createCheckoutSession: (body: CreateCheckoutSessionRequestBody) => Promise<CheckoutSession>;
1897
- getPlansForTenantById: (tenant_id: string) => Promise<TenantPlansResponse>;
1898
- createBillingPortalSession: (tenant_id: string) => Promise<BillingPortalSession>;
1899
- createSubscriberForAudienceById: (audience_id: string, body: CreateSubscriberRequestBody) => Promise<Response>;
1900
- getFormById: (feedback_form_id: string) => Promise<FeedbackFormDataStub>;
1901
- submitFormById: (feedback_form_id: string, body?: SubmitFeedbackFormResponseBody) => Promise<Response>;
1902
- createQuestion: (body: CreateQuestionRequestBody) => Promise<Question>;
1901
+ checkAuthorization: (body: CheckAuthorizationRequestBody, options?: Options) => Promise<CheckAuthorization>;
1902
+ getUserInfo: (options?: Options) => Promise<UserInfoResponse>;
1903
+ getParraAuthToken: (options?: Options) => Promise<AuthToken>;
1904
+ uploadImageAssetForTenantById: (tenant_id: string, body: UploadImageWithGroupRequestBody, options?: Options) => Promise<ImageAsset>;
1905
+ uploadAvatarForUser: (body: UploadImageRequestBody, options?: Options) => Promise<ImageAssetStub>;
1906
+ uploadAvatarForTenantUser: (tenant_id: string, body: UploadImageRequestBody, options?: Options) => Promise<ImageAssetStub>;
1907
+ uploadIconForTenantApplication: (tenant_id: string, application_id: string, body: UploadImageRequestBody, options?: Options) => Promise<ImageAsset>;
1908
+ uploadHeaderForTenantRelease: (tenant_id: string, release_id: string, body: UploadImageRequestBody, options?: Options) => Promise<ImageAsset>;
1909
+ uploadAttachmentForTicketById: (tenant_id: string, ticket_id: string, body: UploadImageRequestBody, options?: Options) => Promise<ImageAsset>;
1910
+ uploadLogoForTenantById: (tenant_id: string, body: UploadImageRequestBody, options?: Options) => Promise<ImageAsset>;
1911
+ createCheckoutSession: (body: CreateCheckoutSessionRequestBody, options?: Options) => Promise<CheckoutSession>;
1912
+ getPlansForTenantById: (tenant_id: string, options?: Options) => Promise<TenantPlansResponse>;
1913
+ createBillingPortalSession: (tenant_id: string, options?: Options) => Promise<BillingPortalSession>;
1914
+ createSubscriberForAudienceById: (audience_id: string, body: CreateSubscriberRequestBody, options?: Options) => Promise<Response>;
1915
+ getFormById: (feedback_form_id: string, options?: Options) => Promise<FeedbackFormDataStub>;
1916
+ submitFormById: (feedback_form_id: string, body?: SubmitFeedbackFormResponseBody, options?: Options) => Promise<Response>;
1917
+ createQuestion: (body: CreateQuestionRequestBody, options?: Options) => Promise<Question>;
1903
1918
  paginateQuestions: (query?: {
1904
1919
  $select?: string;
1905
1920
  $top?: number;
@@ -1908,12 +1923,12 @@ declare class ParraAPI {
1908
1923
  $filter?: string;
1909
1924
  $expand?: string;
1910
1925
  $search?: string;
1911
- }) => Promise<QuestionCollectionResponse>;
1926
+ }, options?: Options) => Promise<QuestionCollectionResponse>;
1912
1927
  getQuestionById: (question_id: string, query?: {
1913
1928
  campaign_id?: string;
1914
- }) => Promise<Question>;
1915
- updateQuestionById: (question_id: string, body: UpdateQuestionRequestBody) => Promise<Question>;
1916
- deleteQuestionById: (question_id: string) => Promise<Response>;
1929
+ }, options?: Options) => Promise<Question>;
1930
+ updateQuestionById: (question_id: string, body: UpdateQuestionRequestBody, options?: Options) => Promise<Question>;
1931
+ deleteQuestionById: (question_id: string, options?: Options) => Promise<Response>;
1917
1932
  paginateAnswersForQuestionById: (question_id: string, query?: {
1918
1933
  $select?: string;
1919
1934
  $top?: number;
@@ -1922,12 +1937,12 @@ declare class ParraAPI {
1922
1937
  $filter?: string;
1923
1938
  $expand?: string;
1924
1939
  $search?: string;
1925
- }) => Promise<AnswerCollectionResponse>;
1926
- answerQuestionById: (question_id: string, body: AnswerQuestionBody) => Promise<Response>;
1927
- bulkAnswerQuestions: (body?: BulkAnswersQuestionBody) => Promise<Response>;
1940
+ }, options?: Options) => Promise<AnswerCollectionResponse>;
1941
+ answerQuestionById: (question_id: string, body: AnswerQuestionBody, options?: Options) => Promise<Response>;
1942
+ bulkAnswerQuestions: (body?: BulkAnswersQuestionBody, options?: Options) => Promise<Response>;
1928
1943
  getCardsForTenantById: (tenant_id: string, query?: {
1929
1944
  app_area_id?: string;
1930
- }) => Promise<CardsResponse>;
1945
+ }, options?: Options) => Promise<CardsResponse>;
1931
1946
  paginateFeedbackFormsForTenantById: (tenant_id: string, query?: {
1932
1947
  $select?: string;
1933
1948
  $top?: number;
@@ -1936,13 +1951,13 @@ declare class ParraAPI {
1936
1951
  $filter?: string;
1937
1952
  $expand?: string;
1938
1953
  $search?: string;
1939
- }) => Promise<FeedbackFormCollectionResponse>;
1940
- createFeedbackFormForTenantById: (tenant_id: string, body?: CreateFeedbackFormRequestBody) => Promise<FeedbackFormResponse>;
1954
+ }, options?: Options) => Promise<FeedbackFormCollectionResponse>;
1955
+ createFeedbackFormForTenantById: (tenant_id: string, body?: CreateFeedbackFormRequestBody, options?: Options) => Promise<FeedbackFormResponse>;
1941
1956
  getFeedbackFormForTenantById: (tenant_id: string, feedback_form_id: string, query?: {
1942
1957
  include?: string;
1943
- }) => Promise<FeedbackFormResponse>;
1944
- updateFeedbackFormForTenantById: (tenant_id: string, feedback_form_id: string, body: UpdateFeedbackFormRequestBody) => Promise<FeedbackFormResponse>;
1945
- deleteFeedbackFormForTenantById: (tenant_id: string, feedback_form_id: string) => Promise<Response>;
1958
+ }, options?: Options) => Promise<FeedbackFormResponse>;
1959
+ updateFeedbackFormForTenantById: (tenant_id: string, feedback_form_id: string, body: UpdateFeedbackFormRequestBody, options?: Options) => Promise<FeedbackFormResponse>;
1960
+ deleteFeedbackFormForTenantById: (tenant_id: string, feedback_form_id: string, options?: Options) => Promise<Response>;
1946
1961
  paginateFeedbackFormResponsesForTenantById: (tenant_id: string, feedback_form_id: string, query?: {
1947
1962
  $select?: string;
1948
1963
  $top?: number;
@@ -1951,8 +1966,8 @@ declare class ParraAPI {
1951
1966
  $filter?: string;
1952
1967
  $expand?: string;
1953
1968
  $search?: string;
1954
- }) => Promise<FeedbackFormSubmissionCollectionResponse>;
1955
- createAnalyticEventTypeForTenantById: (tenant_id: string, body: CreateAnalyticEventTypeRequestBody) => Promise<AnalyticEventType>;
1969
+ }, options?: Options) => Promise<FeedbackFormSubmissionCollectionResponse>;
1970
+ createAnalyticEventTypeForTenantById: (tenant_id: string, body: CreateAnalyticEventTypeRequestBody, options?: Options) => Promise<AnalyticEventType>;
1956
1971
  paginateAnalyticEventTypesForTenantById: (tenant_id: string, query?: {
1957
1972
  $select?: string;
1958
1973
  $top?: number;
@@ -1961,13 +1976,13 @@ declare class ParraAPI {
1961
1976
  $filter?: string;
1962
1977
  $expand?: string;
1963
1978
  $search?: string;
1964
- }) => Promise<AnalyticEventTypeCollectionResponse>;
1965
- createAppArea: (tenant_id: string, body?: CreateAppAreaRequestBody) => Promise<AppArea>;
1966
- listAppAreas: (tenant_id: string) => Promise<Array<AppArea>>;
1967
- getAppAreaById: (tenant_id: string, app_area_id: string) => Promise<AppArea>;
1968
- updateAppAreaById: (tenant_id: string, app_area_id: string, body: UpdateAppAreaRequestBody) => Promise<AppArea>;
1969
- deleteAppAreaById: (tenant_id: string, app_area_id: string) => Promise<Response>;
1970
- createCampaign: (tenant_id: string, body?: CreateCampaignRequestBody) => Promise<Campaign>;
1979
+ }, options?: Options) => Promise<AnalyticEventTypeCollectionResponse>;
1980
+ createAppArea: (tenant_id: string, body?: CreateAppAreaRequestBody, options?: Options) => Promise<AppArea>;
1981
+ listAppAreas: (tenant_id: string, options?: Options) => Promise<Array<AppArea>>;
1982
+ getAppAreaById: (tenant_id: string, app_area_id: string, options?: Options) => Promise<AppArea>;
1983
+ updateAppAreaById: (tenant_id: string, app_area_id: string, body: UpdateAppAreaRequestBody, options?: Options) => Promise<AppArea>;
1984
+ deleteAppAreaById: (tenant_id: string, app_area_id: string, options?: Options) => Promise<Response>;
1985
+ createCampaign: (tenant_id: string, body?: CreateCampaignRequestBody, options?: Options) => Promise<Campaign>;
1971
1986
  paginateCampaignsForTenantById: (tenant_id: string, query?: {
1972
1987
  $select?: string;
1973
1988
  $top?: number;
@@ -1976,14 +1991,14 @@ declare class ParraAPI {
1976
1991
  $filter?: string;
1977
1992
  $expand?: string;
1978
1993
  $search?: string;
1979
- }) => Promise<CampaignCollectionResponse>;
1994
+ }, options?: Options) => Promise<CampaignCollectionResponse>;
1980
1995
  getCampaignById: (tenant_id: string, campaign_id: string, query?: {
1981
1996
  include?: string;
1982
- }) => Promise<Campaign>;
1983
- updateCampaignById: (tenant_id: string, campaign_id: string, body?: UpdateCampaignRequestBody) => Promise<Campaign>;
1984
- deleteCampaignById: (tenant_id: string, campaign_id: string) => Promise<Response>;
1985
- closeCampaignById: (tenant_id: string, campaign_id: string) => Promise<Campaign>;
1986
- publishCampaignById: (tenant_id: string, campaign_id: string, body?: UpdateCampaignRequestBody) => Promise<Campaign>;
1997
+ }, options?: Options) => Promise<Campaign>;
1998
+ updateCampaignById: (tenant_id: string, campaign_id: string, body?: UpdateCampaignRequestBody, options?: Options) => Promise<Campaign>;
1999
+ deleteCampaignById: (tenant_id: string, campaign_id: string, options?: Options) => Promise<Response>;
2000
+ closeCampaignById: (tenant_id: string, campaign_id: string, options?: Options) => Promise<Campaign>;
2001
+ publishCampaignById: (tenant_id: string, campaign_id: string, body?: UpdateCampaignRequestBody, options?: Options) => Promise<Campaign>;
1987
2002
  paginateTemplatesForTenantById: (tenant_id: string, query?: {
1988
2003
  $select?: string;
1989
2004
  $top?: number;
@@ -1992,8 +2007,8 @@ declare class ParraAPI {
1992
2007
  $filter?: string;
1993
2008
  $expand?: string;
1994
2009
  $search?: string;
1995
- }) => Promise<TemplateCollectionResponse>;
1996
- cloneTemplateForTenantById: (tenant_id: string, template_id: string) => Promise<Template>;
2010
+ }, options?: Options) => Promise<TemplateCollectionResponse>;
2011
+ cloneTemplateForTenantById: (tenant_id: string, template_id: string, options?: Options) => Promise<Template>;
1997
2012
  paginateTemplateTags: (query?: {
1998
2013
  $select?: string;
1999
2014
  $top?: number;
@@ -2002,10 +2017,10 @@ declare class ParraAPI {
2002
2017
  $filter?: string;
2003
2018
  $expand?: string;
2004
2019
  $search?: string;
2005
- }) => Promise<TemplateTagCollectionResponse>;
2006
- createBoardForTenantById: (tenant_id: string, body?: CreateBoardRequestBody) => Promise<Board>;
2007
- listBoardsForTenantById: (tenant_id: string) => Promise<Array<Board>>;
2008
- createTicketForBoard: (tenant_id: string, board_id: string, body: CreateTicketRequestBody) => Promise<Ticket>;
2020
+ }, options?: Options) => Promise<TemplateTagCollectionResponse>;
2021
+ createBoardForTenantById: (tenant_id: string, body?: CreateBoardRequestBody, options?: Options) => Promise<Board>;
2022
+ listBoardsForTenantById: (tenant_id: string, options?: Options) => Promise<Array<Board>>;
2023
+ createTicketForBoard: (tenant_id: string, board_id: string, body: CreateTicketRequestBody, options?: Options) => Promise<Ticket>;
2009
2024
  paginateTicketsForBoard: (tenant_id: string, board_id: string, query?: {
2010
2025
  $select?: string;
2011
2026
  $top?: number;
@@ -2014,8 +2029,8 @@ declare class ParraAPI {
2014
2029
  $filter?: string;
2015
2030
  $expand?: string;
2016
2031
  $search?: string;
2017
- }) => Promise<TicketCollectionResponse>;
2018
- createUserNoteForBoard: (tenant_id: string, board_id: string, body: CreateUserNoteRequestBody) => Promise<UserNote>;
2032
+ }, options?: Options) => Promise<TicketCollectionResponse>;
2033
+ createUserNoteForBoard: (tenant_id: string, board_id: string, body: CreateUserNoteRequestBody, options?: Options) => Promise<UserNote>;
2019
2034
  paginateUserNotesForBoard: (tenant_id: string, board_id: string, query?: {
2020
2035
  $select?: string;
2021
2036
  $top?: number;
@@ -2024,21 +2039,21 @@ declare class ParraAPI {
2024
2039
  $filter?: string;
2025
2040
  $expand?: string;
2026
2041
  $search?: string;
2027
- }) => Promise<UserNoteCollectionResponse>;
2028
- generateUserNoteMetricsForBoard: (tenant_id: string, board_id: string) => Promise<UserNoteMetrics>;
2029
- deleteUserNoteById: (tenant_id: string, user_note_id: string) => Promise<Response>;
2030
- linkUserNoteToTicket: (tenant_id: string, user_note_id: string, body: LinkUserNoteRequestBody) => Promise<Response>;
2031
- bulkUpdateTickets: (tenant_id: string, body?: BulkUpdateTicketsRequestBody) => Promise<Response>;
2032
- getTicketById: (tenant_id: string, ticket_id: string) => Promise<Ticket>;
2033
- updateTicketById: (tenant_id: string, ticket_id: string, body?: UpdateTicketRequestBody) => Promise<Ticket>;
2034
- deleteTicketById: (tenant_id: string, ticket_id: string) => Promise<Response>;
2035
- deleteAttachmentForTicketById: (tenant_id: string, ticket_id: string, ticket_attachment_id: string) => Promise<Response>;
2036
- updateReleaseForTicketById: (tenant_id: string, ticket_id: string, body: UpdateReleaseForTicketRequestBody) => Promise<Ticket>;
2037
- removeReleaseFromTicketById: (tenant_id: string, ticket_id: string) => Promise<Response>;
2038
- voteForTicketById: (tenant_id: string, ticket_id: string) => Promise<UserTicket>;
2039
- removeVoteForTicketById: (tenant_id: string, ticket_id: string) => Promise<UserTicket>;
2040
- generateNextReleaseVersionInfoForTenantById: (tenant_id: string, body: ReleaseVersionInfoRequestBody) => Promise<ReleaseVersionInfo>;
2041
- createReleaseForTenantById: (tenant_id: string, body: CreateReleaseRequestBody) => Promise<Release>;
2042
+ }, options?: Options) => Promise<UserNoteCollectionResponse>;
2043
+ generateUserNoteMetricsForBoard: (tenant_id: string, board_id: string, options?: Options) => Promise<UserNoteMetrics>;
2044
+ deleteUserNoteById: (tenant_id: string, user_note_id: string, options?: Options) => Promise<Response>;
2045
+ linkUserNoteToTicket: (tenant_id: string, user_note_id: string, body: LinkUserNoteRequestBody, options?: Options) => Promise<Response>;
2046
+ bulkUpdateTickets: (tenant_id: string, body?: BulkUpdateTicketsRequestBody, options?: Options) => Promise<Response>;
2047
+ getTicketById: (tenant_id: string, ticket_id: string, options?: Options) => Promise<Ticket>;
2048
+ updateTicketById: (tenant_id: string, ticket_id: string, body?: UpdateTicketRequestBody, options?: Options) => Promise<Ticket>;
2049
+ deleteTicketById: (tenant_id: string, ticket_id: string, options?: Options) => Promise<Response>;
2050
+ deleteAttachmentForTicketById: (tenant_id: string, ticket_id: string, ticket_attachment_id: string, options?: Options) => Promise<Response>;
2051
+ updateReleaseForTicketById: (tenant_id: string, ticket_id: string, body: UpdateReleaseForTicketRequestBody, options?: Options) => Promise<Ticket>;
2052
+ removeReleaseFromTicketById: (tenant_id: string, ticket_id: string, options?: Options) => Promise<Response>;
2053
+ voteForTicketById: (tenant_id: string, ticket_id: string, options?: Options) => Promise<UserTicket>;
2054
+ removeVoteForTicketById: (tenant_id: string, ticket_id: string, options?: Options) => Promise<UserTicket>;
2055
+ generateNextReleaseVersionInfoForTenantById: (tenant_id: string, body: ReleaseVersionInfoRequestBody, options?: Options) => Promise<ReleaseVersionInfo>;
2056
+ createReleaseForTenantById: (tenant_id: string, body: CreateReleaseRequestBody, options?: Options) => Promise<Release>;
2042
2057
  paginateReleasesForTenantById: (tenant_id: string, query?: {
2043
2058
  $select?: string;
2044
2059
  $top?: number;
@@ -2047,41 +2062,41 @@ declare class ParraAPI {
2047
2062
  $filter?: string;
2048
2063
  $expand?: string;
2049
2064
  $search?: string;
2050
- }) => Promise<ReleaseCollectionResponse>;
2051
- getReleaseForTenantById: (tenant_id: string, release_id: string) => Promise<Release>;
2052
- updateReleaseForTenantById: (tenant_id: string, release_id: string, body?: UpdateReleaseRequestBody) => Promise<Release>;
2053
- deleteReleaseForTenantById: (tenant_id: string, release_id: string) => Promise<Response>;
2054
- cutReleaseForTenantById: (tenant_id: string, release_id: string) => Promise<Release>;
2055
- createReleaseItemForReleaseById: (tenant_id: string, release_id: string, body: CreateReleaseItemRequestBody) => Promise<ReleaseItem>;
2065
+ }, options?: Options) => Promise<ReleaseCollectionResponse>;
2066
+ getReleaseForTenantById: (tenant_id: string, release_id: string, options?: Options) => Promise<Release>;
2067
+ updateReleaseForTenantById: (tenant_id: string, release_id: string, body?: UpdateReleaseRequestBody, options?: Options) => Promise<Release>;
2068
+ deleteReleaseForTenantById: (tenant_id: string, release_id: string, options?: Options) => Promise<Response>;
2069
+ cutReleaseForTenantById: (tenant_id: string, release_id: string, options?: Options) => Promise<Release>;
2070
+ createReleaseItemForReleaseById: (tenant_id: string, release_id: string, body: CreateReleaseItemRequestBody, options?: Options) => Promise<ReleaseItem>;
2056
2071
  getAppInfoForTenantApplication: (tenant_id: string, application_id: string, query?: {
2057
2072
  version_token?: string;
2058
- }) => Promise<AppInfo>;
2073
+ }, options?: Options) => Promise<AppInfo>;
2059
2074
  paginateTicketsForApplication: (tenant_id: string, application_id: string, query?: {
2060
2075
  limit?: number;
2061
2076
  offset?: number;
2062
2077
  filter?: string;
2063
- }) => Promise<UserTicketCollectionResponse>;
2064
- getRoadmapForTenantApplication: (tenant_id: string, application_id: string) => Promise<AppRoadmapConfiguration>;
2078
+ }, options?: Options) => Promise<UserTicketCollectionResponse>;
2079
+ getRoadmapForTenantApplication: (tenant_id: string, application_id: string, options?: Options) => Promise<AppRoadmapConfiguration>;
2065
2080
  paginateReleasesForTenantApplication: (tenant_id: string, application_id: string, query?: {
2066
2081
  limit?: number;
2067
2082
  offset?: number;
2068
- }) => Promise<AppReleaseCollectionResponse>;
2069
- getReleaseForTenantApplication: (tenant_id: string, application_id: string, release_id: string) => Promise<AppRelease>;
2070
- createVersionForTenantApplication: (tenant_id: string, application_id: string, body?: CreateAppVersionRequestBody) => Promise<AppVersion>;
2071
- listVersionsForTenantApplication: (tenant_id: string, application_id: string) => Promise<Array<AppVersion>>;
2072
- getTenantApplicationVersionById: (tenant_id: string, application_id: string, app_version_id: string) => Promise<AppVersion>;
2073
- updateTenantApplicationVersionById: (tenant_id: string, application_id: string, app_version_id: string, body: UpdateAppVersionRequestBody) => Promise<AppVersion>;
2074
- deleteTenantApplicationVersionById: (tenant_id: string, application_id: string, app_version_id: string) => Promise<Response>;
2075
- updateApnsConfigurationForTenantApplication: (tenant_id: string, application_id: string, body: UpdateApnsConfigurationRequestBody) => Promise<ApnsConfiguration>;
2076
- getApnsConfigurationForTenantApplication: (tenant_id: string, application_id: string) => Promise<ApnsConfiguration>;
2083
+ }, options?: Options) => Promise<AppReleaseCollectionResponse>;
2084
+ getReleaseForTenantApplication: (tenant_id: string, application_id: string, release_id: string, options?: Options) => Promise<AppRelease>;
2085
+ createVersionForTenantApplication: (tenant_id: string, application_id: string, body?: CreateAppVersionRequestBody, options?: Options) => Promise<AppVersion>;
2086
+ listVersionsForTenantApplication: (tenant_id: string, application_id: string, options?: Options) => Promise<Array<AppVersion>>;
2087
+ getTenantApplicationVersionById: (tenant_id: string, application_id: string, app_version_id: string, options?: Options) => Promise<AppVersion>;
2088
+ updateTenantApplicationVersionById: (tenant_id: string, application_id: string, app_version_id: string, body: UpdateAppVersionRequestBody, options?: Options) => Promise<AppVersion>;
2089
+ deleteTenantApplicationVersionById: (tenant_id: string, application_id: string, app_version_id: string, options?: Options) => Promise<Response>;
2090
+ updateApnsConfigurationForTenantApplication: (tenant_id: string, application_id: string, body: UpdateApnsConfigurationRequestBody, options?: Options) => Promise<ApnsConfiguration>;
2091
+ getApnsConfigurationForTenantApplication: (tenant_id: string, application_id: string, options?: Options) => Promise<ApnsConfiguration>;
2077
2092
  getInboxItemsForTenantUser: (tenant_id: string, query?: {
2078
2093
  limit?: number;
2079
2094
  offset?: number;
2080
2095
  segment?: string;
2081
2096
  archived?: boolean;
2082
- }) => Promise<InboxItemCollectionResponse>;
2083
- readInboxItemsForTenantUser: (tenant_id: string, body: ReadInboxItemsRequestBody) => Promise<Response>;
2084
- createNotificationTemplate: (tenant_id: string, body?: CreateNotificationTemplateRequestBody) => Promise<NotificationTemplate>;
2097
+ }, options?: Options) => Promise<InboxItemCollectionResponse>;
2098
+ readInboxItemsForTenantUser: (tenant_id: string, body: ReadInboxItemsRequestBody, options?: Options) => Promise<Response>;
2099
+ createNotificationTemplate: (tenant_id: string, body?: CreateNotificationTemplateRequestBody, options?: Options) => Promise<NotificationTemplate>;
2085
2100
  paginateNotificationTemplatesForTenantById: (tenant_id: string, query?: {
2086
2101
  $select?: string;
2087
2102
  $top?: number;
@@ -2090,23 +2105,24 @@ declare class ParraAPI {
2090
2105
  $filter?: string;
2091
2106
  $expand?: string;
2092
2107
  $search?: string;
2093
- }) => Promise<NotificationTemplateCollectionResponse>;
2108
+ }, options?: Options) => Promise<NotificationTemplateCollectionResponse>;
2094
2109
  getNotificationTemplateById: (tenant_id: string, notification_template_id: string, query?: {
2095
2110
  include?: string;
2096
- }) => Promise<NotificationTemplate>;
2097
- updateNotificationTemplateById: (tenant_id: string, notification_template_id: string, body: UpdateNotificationTemplateRequestBody) => Promise<NotificationTemplate>;
2098
- deleteNotificationTemplateById: (tenant_id: string, notification_template_id: string) => Promise<Response>;
2099
- createChannelForNotificationTemplate: (tenant_id: string, notification_template_id: string, body: CreateChannelRequestBody) => Promise<Channel>;
2100
- updateChannelForNotificationTemplate: (tenant_id: string, notification_template_id: string, channel_id: string, body: UpdateChannelRequestBody) => Promise<Channel>;
2101
- deleteChannelForNotificationTemplate: (tenant_id: string, notification_template_id: string, channel_id: string) => Promise<Response>;
2102
- loginUserForTenant: (tenant_id: string) => Promise<TenantUserInfo>;
2103
- getTenantUserInfo: (tenant_id: string) => Promise<TenantUserInfo>;
2104
- logoutUserForTenant: (tenant_id: string) => Promise<Response>;
2105
- getClientForTenantApplication: (tenant_id: string, application_id: string) => Promise<Client>;
2106
- createClientForTenantApplication: (tenant_id: string, application_id: string) => Promise<Client>;
2107
- updateClientForTenantApplication: (tenant_id: string, application_id: string, body?: UpdateClientRequestBody) => Promise<Client>;
2108
- deleteClientForTenantApplication: (tenant_id: string, application_id: string) => Promise<Response>;
2109
- createApplicationForTenantById: (tenant_id: string, body: CreateApplicationRequestBody) => Promise<Application>;
2111
+ }, options?: Options) => Promise<NotificationTemplate>;
2112
+ updateNotificationTemplateById: (tenant_id: string, notification_template_id: string, body: UpdateNotificationTemplateRequestBody, options?: Options) => Promise<NotificationTemplate>;
2113
+ deleteNotificationTemplateById: (tenant_id: string, notification_template_id: string, options?: Options) => Promise<Response>;
2114
+ createChannelForNotificationTemplate: (tenant_id: string, notification_template_id: string, body: CreateChannelRequestBody, options?: Options) => Promise<Channel>;
2115
+ updateChannelForNotificationTemplate: (tenant_id: string, notification_template_id: string, channel_id: string, body: UpdateChannelRequestBody, options?: Options) => Promise<Channel>;
2116
+ deleteChannelForNotificationTemplate: (tenant_id: string, notification_template_id: string, channel_id: string, options?: Options) => Promise<Response>;
2117
+ checkSubdomainAvailability: (body: SubdomainAvailabilityRequestBody, options?: Options) => Promise<SubdomainAvailabilityResponse>;
2118
+ loginUserForTenant: (tenant_id: string, options?: Options) => Promise<TenantUserInfo>;
2119
+ getTenantUserInfo: (tenant_id: string, options?: Options) => Promise<TenantUserInfo>;
2120
+ logoutUserForTenant: (tenant_id: string, options?: Options) => Promise<Response>;
2121
+ getClientForTenantApplication: (tenant_id: string, application_id: string, options?: Options) => Promise<Client>;
2122
+ createClientForTenantApplication: (tenant_id: string, application_id: string, options?: Options) => Promise<Client>;
2123
+ updateClientForTenantApplication: (tenant_id: string, application_id: string, body?: UpdateClientRequestBody, options?: Options) => Promise<Client>;
2124
+ deleteClientForTenantApplication: (tenant_id: string, application_id: string, options?: Options) => Promise<Response>;
2125
+ createApplicationForTenantById: (tenant_id: string, body: CreateApplicationRequestBody, options?: Options) => Promise<Application>;
2110
2126
  paginateApplicationsForTenantById: (tenant_id: string, query?: {
2111
2127
  $select?: string;
2112
2128
  $top?: number;
@@ -2115,40 +2131,40 @@ declare class ParraAPI {
2115
2131
  $filter?: string;
2116
2132
  $expand?: string;
2117
2133
  $search?: string;
2118
- }) => Promise<ApplicationCollectionResponse>;
2119
- getApplicationByIdForTenantById: (tenant_id: string, application_id: string) => Promise<Application>;
2120
- updateApplicationByIdForTenantById: (tenant_id: string, application_id: string, body?: UpdateApplicationRequestBody) => Promise<Application>;
2121
- deleteApplicationByIdForTenantById: (tenant_id: string, application_id: string) => Promise<Response>;
2122
- getTenantForApiKeyById: (api_key_id: string) => Promise<Tenant>;
2123
- acceptInvitationByCode: (invitation_code: string) => Promise<TenantInvitation>;
2124
- deleteApiKeyForTenantById: (tenant_id: string, api_key_id: string) => Promise<Response>;
2125
- createApiKeyForTenantById: (tenant_id: string, body: CreateApiKeyRequestBody) => Promise<ApiKeyWithSecretResponse>;
2126
- getApiKeysForTenantById: (tenant_id: string) => Promise<ApiKeyCollectionResponse>;
2134
+ }, options?: Options) => Promise<ApplicationCollectionResponse>;
2135
+ getApplicationByIdForTenantById: (tenant_id: string, application_id: string, options?: Options) => Promise<Application>;
2136
+ updateApplicationByIdForTenantById: (tenant_id: string, application_id: string, body?: UpdateApplicationRequestBody, options?: Options) => Promise<Application>;
2137
+ deleteApplicationByIdForTenantById: (tenant_id: string, application_id: string, options?: Options) => Promise<Response>;
2138
+ getTenantForApiKeyById: (api_key_id: string, options?: Options) => Promise<Tenant>;
2139
+ acceptInvitationByCode: (invitation_code: string, options?: Options) => Promise<TenantInvitation>;
2140
+ deleteApiKeyForTenantById: (tenant_id: string, api_key_id: string, options?: Options) => Promise<Response>;
2141
+ createApiKeyForTenantById: (tenant_id: string, body: CreateApiKeyRequestBody, options?: Options) => Promise<ApiKeyWithSecretResponse>;
2142
+ getApiKeysForTenantById: (tenant_id: string, options?: Options) => Promise<ApiKeyCollectionResponse>;
2127
2143
  listConnectedAppsForTenantById: (tenant_id: string, query?: {
2128
2144
  include?: string;
2129
- }) => Promise<Array<TenantConnectedApp>>;
2130
- updateConnectedAppConnectionById: (tenant_id: string, connected_app_connection_id: string, body?: UpdateConnectedAppConnectionRequestBody) => Promise<ConnectedAppConnection>;
2131
- deleteConnectedAppConnectionById: (tenant_id: string, connected_app_connection_id: string) => Promise<ConnectedAppConnection>;
2132
- createConnectionForConnectedApp: (tenant_id: string, connected_app_id: string, body?: CreateConnectedAppConnectionRequestBody) => Promise<ConnectedAppConnection>;
2145
+ }, options?: Options) => Promise<Array<TenantConnectedApp>>;
2146
+ updateConnectedAppConnectionById: (tenant_id: string, connected_app_connection_id: string, body?: UpdateConnectedAppConnectionRequestBody, options?: Options) => Promise<ConnectedAppConnection>;
2147
+ deleteConnectedAppConnectionById: (tenant_id: string, connected_app_connection_id: string, options?: Options) => Promise<ConnectedAppConnection>;
2148
+ createConnectionForConnectedApp: (tenant_id: string, connected_app_id: string, body?: CreateConnectedAppConnectionRequestBody, options?: Options) => Promise<ConnectedAppConnection>;
2133
2149
  listIntegrationsForTenantById: (tenant_id: string, query?: {
2134
2150
  include?: string;
2135
2151
  collection: string;
2136
2152
  resource_id?: string;
2137
- }) => Promise<Array<TenantIntegration>>;
2138
- updateIntegrationConnectionById: (tenant_id: string, integration_connection_id: string, body?: UpdateIntegrationConnectionRequestBody) => Promise<IntegrationConnection>;
2139
- deleteIntegrationConnectionById: (tenant_id: string, integration_connection_id: string) => Promise<IntegrationConnection>;
2140
- updateDataForIntegrationConnectionById: (tenant_id: string, integration_connection_id: string, body?: UpdateIntegrationConnectionDataRequestBody) => Promise<IntegrationConnection>;
2141
- createConnectionForIntegration: (tenant_id: string, integration_id: string, body?: CreateIntegrationConnectionRequestBody) => Promise<IntegrationConnection>;
2142
- getInvitationsForTenantById: (tenant_id: string) => Promise<Array<TenantInvitation>>;
2143
- createInvitationForTenantById: (tenant_id: string, body: TenantInvitationRequestBody) => Promise<TenantInvitation>;
2144
- getTeamMembersForTenantById: (tenant_id: string) => Promise<Array<TeamMember>>;
2145
- deleteTeamMemberForTenantById: (tenant_id: string, team_member_id: string) => Promise<Response>;
2153
+ }, options?: Options) => Promise<Array<TenantIntegration>>;
2154
+ updateIntegrationConnectionById: (tenant_id: string, integration_connection_id: string, body?: UpdateIntegrationConnectionRequestBody, options?: Options) => Promise<IntegrationConnection>;
2155
+ deleteIntegrationConnectionById: (tenant_id: string, integration_connection_id: string, options?: Options) => Promise<IntegrationConnection>;
2156
+ updateDataForIntegrationConnectionById: (tenant_id: string, integration_connection_id: string, body?: UpdateIntegrationConnectionDataRequestBody, options?: Options) => Promise<IntegrationConnection>;
2157
+ createConnectionForIntegration: (tenant_id: string, integration_id: string, body?: CreateIntegrationConnectionRequestBody, options?: Options) => Promise<IntegrationConnection>;
2158
+ getInvitationsForTenantById: (tenant_id: string, options?: Options) => Promise<Array<TenantInvitation>>;
2159
+ createInvitationForTenantById: (tenant_id: string, body: TenantInvitationRequestBody, options?: Options) => Promise<TenantInvitation>;
2160
+ getTeamMembersForTenantById: (tenant_id: string, options?: Options) => Promise<Array<TeamMember>>;
2161
+ deleteTeamMemberForTenantById: (tenant_id: string, team_member_id: string, options?: Options) => Promise<Response>;
2146
2162
  getUserForTenantById: (tenant_id: string, user_id: string, query?: {
2147
2163
  include?: string;
2148
- }) => Promise<TenantUser>;
2149
- updateUserForTenantById: (tenant_id: string, user_id: string, body?: UpdateTenantUserRequestBody) => Promise<TenantUser>;
2150
- deleteUserForTenantById: (tenant_id: string, user_id: string) => Promise<Response>;
2151
- createUserForTenantById: (tenant_id: string, body?: CreateTenantUserRequestBody) => Promise<TenantUser>;
2164
+ }, options?: Options) => Promise<TenantUser>;
2165
+ updateUserForTenantById: (tenant_id: string, user_id: string, body?: UpdateTenantUserRequestBody, options?: Options) => Promise<TenantUser>;
2166
+ deleteUserForTenantById: (tenant_id: string, user_id: string, options?: Options) => Promise<Response>;
2167
+ createUserForTenantById: (tenant_id: string, body?: CreateTenantUserRequestBody, options?: Options) => Promise<TenantUser>;
2152
2168
  paginateTenantUsersForTenantById: (tenant_id: string, query?: {
2153
2169
  $select?: string;
2154
2170
  $top?: number;
@@ -2157,19 +2173,19 @@ declare class ParraAPI {
2157
2173
  $filter?: string;
2158
2174
  $expand?: string;
2159
2175
  $search?: string;
2160
- }) => Promise<TenantUserCollectionResponse>;
2176
+ }, options?: Options) => Promise<TenantUserCollectionResponse>;
2161
2177
  getTenantById: (tenant_id: string, query?: {
2162
2178
  include?: string;
2163
- }) => Promise<Tenant>;
2164
- updateTenantById: (tenant_id: string, body?: UpdateTenantRequestBody) => Promise<Tenant>;
2165
- deleteTenantById: (tenant_id: string) => Promise<Response>;
2166
- createTenant: (body: CreateTenantRequestBody) => Promise<Tenant>;
2167
- createTenantForUserById: (user_id: string, body: CreateTenantForUserRequestBody) => Promise<Tenant>;
2168
- getTenantsForUserById: (user_id: string) => Promise<Array<Tenant>>;
2169
- getUserById: (user_id: string) => Promise<UserResponse>;
2170
- updateUserById: (user_id: string, body: UpdateUserRequestBody) => Promise<UserResponse>;
2171
- deleteUserById: (user_id: string) => Promise<Response>;
2172
- createUser: (body: CreateUserRequestBody) => Promise<UserResponse>;
2179
+ }, options?: Options) => Promise<Tenant>;
2180
+ updateTenantById: (tenant_id: string, body?: UpdateTenantRequestBody, options?: Options) => Promise<Tenant>;
2181
+ deleteTenantById: (tenant_id: string, options?: Options) => Promise<Response>;
2182
+ createTenant: (body: CreateTenantRequestBody, options?: Options) => Promise<Tenant>;
2183
+ createTenantForUserById: (user_id: string, body: CreateTenantForUserRequestBody, options?: Options) => Promise<Tenant>;
2184
+ getTenantsForUserById: (user_id: string, options?: Options) => Promise<Array<Tenant>>;
2185
+ getUserById: (user_id: string, options?: Options) => Promise<UserResponse>;
2186
+ updateUserById: (user_id: string, body: UpdateUserRequestBody, options?: Options) => Promise<UserResponse>;
2187
+ deleteUserById: (user_id: string, options?: Options) => Promise<Response>;
2188
+ createUser: (body: CreateUserRequestBody, options?: Options) => Promise<UserResponse>;
2173
2189
  listUsers: (query?: {
2174
2190
  $select?: string;
2175
2191
  $top?: number;
@@ -2178,6 +2194,6 @@ declare class ParraAPI {
2178
2194
  $filter?: string;
2179
2195
  $expand?: string;
2180
2196
  $search?: string;
2181
- }) => Promise<UserCollectionResponse>;
2197
+ }, options?: Options) => Promise<UserCollectionResponse>;
2182
2198
  }
2183
2199
  export default ParraAPI;