@embark-black-book/api-contract 0.1.0 → 0.3.0

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.
package/README.md CHANGED
@@ -2,6 +2,17 @@
2
2
 
3
3
  Generated TypeScript contract types and endpoint client methods for Embark Black Book APIs.
4
4
 
5
+ ## Base URL Requirement
6
+
7
+ `baseUrl` must already be the API root. The client appends endpoint paths directly to this value.
8
+
9
+ - Use: `http://localhost:1337/api`
10
+ - Do not use: `http://localhost:1337`
11
+
12
+ ```ts
13
+ const baseUrl = "http://localhost:1337/api";
14
+ ```
15
+
5
16
  ## Import Types
6
17
 
7
18
  ```ts
@@ -0,0 +1,24 @@
1
+ import type {
2
+ AuthLocalResponse,
3
+ AuthLogoutResponse,
4
+ GeneratedApiClient,
5
+ } from "./generated/api-client";
6
+ import type { ParsedApiResponse } from "./api-response-helpers";
7
+
8
+ export type AuthLocalRequestOptions = Parameters<
9
+ GeneratedApiClient["createAuthLocal"]
10
+ >[0];
11
+
12
+ export type AuthLogoutRequestOptions = Parameters<
13
+ GeneratedApiClient["createAuthLogout"]
14
+ >[0];
15
+
16
+ export declare function authLocalJson(
17
+ options: AuthLocalRequestOptions,
18
+ client?: GeneratedApiClient
19
+ ): Promise<ParsedApiResponse<AuthLocalResponse>>;
20
+
21
+ export declare function authLogoutJson(
22
+ options: AuthLogoutRequestOptions,
23
+ client?: GeneratedApiClient
24
+ ): Promise<ParsedApiResponse<AuthLogoutResponse>>;
@@ -0,0 +1,24 @@
1
+ "use strict";
2
+
3
+ const { apiClient } = require("./generated/api-client");
4
+ const {
5
+ parseApiResponse,
6
+ requireApiResponseOk,
7
+ } = require("./api-response-helpers");
8
+
9
+ async function authLocalJson(options, client) {
10
+ const resolvedClient = client || apiClient;
11
+ const response = await resolvedClient.createAuthLocal(options);
12
+ return requireApiResponseOk(response);
13
+ }
14
+
15
+ async function authLogoutJson(options, client) {
16
+ const resolvedClient = client || apiClient;
17
+ const response = await resolvedClient.createAuthLogout(options);
18
+ return parseApiResponse(response);
19
+ }
20
+
21
+ module.exports = {
22
+ authLocalJson,
23
+ authLogoutJson,
24
+ };
@@ -42,6 +42,10 @@ export interface ApiParameters {
42
42
  locale?: string | string[];
43
43
  }
44
44
 
45
+ export type AuthLocalRequest = { identifier: string; password: string; };
46
+ export type AuthLocalResponse = { jwt: string; refreshToken?: string; user: { id: number; documentId: string; username: string; email: string; provider: string; confirmed: boolean; blocked: boolean; role?: number | { id: unknown; name: unknown; description: unknown; type: unknown; createdAt: unknown; updatedAt: unknown; }; createdAt: string; updatedAt: string; publishedAt: string; }; };
47
+ export type AuthLogoutResponse = null;
48
+
45
49
  export type ApiClientDefinition = { name: string; group: string; method: string; pathTemplate: string; pathParams: string[]; hasBody: boolean; queryParams: string[] };
46
50
 
47
51
  export type ApiClientHookRequestContext = {
@@ -219,7 +223,7 @@ export interface GeneratedApiClient {
219
223
  fetchImpl?: typeof fetch;
220
224
  pathParams?: Record<string, string | number>;
221
225
  query?: Record<string, unknown>;
222
- body?: unknown;
226
+ body?: AuthLocalRequest;
223
227
  }): Promise<Response>;
224
228
  createAuthLocalRegister(options: {
225
229
  baseUrl: string;
@@ -427,6 +431,16 @@ export interface GeneratedApiClient {
427
431
  pathParams?: Record<string, string | number>;
428
432
  query?: ApiParameters;
429
433
  body?: unknown;
434
+ }): Promise<Response>;
435
+ createCreditCardDefaultPercentage(options: {
436
+ baseUrl: string;
437
+ token?: string;
438
+ headers?: Record<string, string>;
439
+ signal?: AbortSignal;
440
+ fetchImpl?: typeof fetch;
441
+ pathParams?: Record<string, string | number>;
442
+ query?: ApiParameters;
443
+ body?: unknown;
430
444
  }): Promise<Response>;
431
445
  createDestinationEpic(options: {
432
446
  baseUrl: string;
@@ -1335,6 +1349,17 @@ export interface GeneratedApiClient {
1335
1349
  "id": string | number;
1336
1350
  };
1337
1351
  query?: ApiParameters;
1352
+ }): Promise<Response>;
1353
+ deleteAuthSessionBySessionId(options: {
1354
+ baseUrl: string;
1355
+ token?: string;
1356
+ headers?: Record<string, string>;
1357
+ signal?: AbortSignal;
1358
+ fetchImpl?: typeof fetch;
1359
+ pathParams: {
1360
+ "sessionId": string | number;
1361
+ };
1362
+ query?: Record<string, unknown>;
1338
1363
  }): Promise<Response>;
1339
1364
  deleteBlackbookGuideline(options: {
1340
1365
  baseUrl: string;
@@ -1507,6 +1532,26 @@ export interface GeneratedApiClient {
1507
1532
  "id": string | number;
1508
1533
  };
1509
1534
  query?: ApiParameters;
1535
+ }): Promise<Response>;
1536
+ deleteCreditCardDefaultPercentageById(options: {
1537
+ baseUrl: string;
1538
+ token?: string;
1539
+ headers?: Record<string, string>;
1540
+ signal?: AbortSignal;
1541
+ fetchImpl?: typeof fetch;
1542
+ pathParams: {
1543
+ "id": string | number;
1544
+ };
1545
+ query?: ApiParameters;
1546
+ }): Promise<Response>;
1547
+ deleteCreditCardMerchantToolSideNote(options: {
1548
+ baseUrl: string;
1549
+ token?: string;
1550
+ headers?: Record<string, string>;
1551
+ signal?: AbortSignal;
1552
+ fetchImpl?: typeof fetch;
1553
+ pathParams?: Record<string, string | number>;
1554
+ query?: ApiParameters;
1510
1555
  }): Promise<Response>;
1511
1556
  deleteDefaultDirectorySearch(options: {
1512
1557
  baseUrl: string;
@@ -2642,6 +2687,15 @@ export interface GeneratedApiClient {
2642
2687
  fetchImpl?: typeof fetch;
2643
2688
  pathParams?: Record<string, string | number>;
2644
2689
  query?: ApiParameters;
2690
+ }): Promise<Response>;
2691
+ getAuthSessions(options: {
2692
+ baseUrl: string;
2693
+ token?: string;
2694
+ headers?: Record<string, string>;
2695
+ signal?: AbortSignal;
2696
+ fetchImpl?: typeof fetch;
2697
+ pathParams?: Record<string, string | number>;
2698
+ query?: Record<string, unknown>;
2645
2699
  }): Promise<Response>;
2646
2700
  getBlackbookGuidelines(options: {
2647
2701
  baseUrl: string;
@@ -2700,6 +2754,17 @@ export interface GeneratedApiClient {
2700
2754
  fetchImpl?: typeof fetch;
2701
2755
  pathParams?: Record<string, string | number>;
2702
2756
  query?: ApiParameters;
2757
+ }): Promise<Response>;
2758
+ getCompaniesCompanyPacSearchByQuery(options: {
2759
+ baseUrl: string;
2760
+ token?: string;
2761
+ headers?: Record<string, string>;
2762
+ signal?: AbortSignal;
2763
+ fetchImpl?: typeof fetch;
2764
+ pathParams: {
2765
+ "query": string | number;
2766
+ };
2767
+ query?: Record<string, unknown>;
2703
2768
  }): Promise<Response>;
2704
2769
  getCompaniesGroundPartnerById(options: {
2705
2770
  baseUrl: string;
@@ -3001,7 +3066,7 @@ export interface GeneratedApiClient {
3001
3066
  pathParams?: Record<string, string | number>;
3002
3067
  query?: ApiParameters;
3003
3068
  }): Promise<Response>;
3004
- getConnect(.*)(options: {
3069
+ getConnect(options: {
3005
3070
  baseUrl: string;
3006
3071
  token?: string;
3007
3072
  headers?: Record<string, string>;
@@ -3089,6 +3154,35 @@ export interface GeneratedApiClient {
3089
3154
  fetchImpl?: typeof fetch;
3090
3155
  pathParams?: Record<string, string | number>;
3091
3156
  query?: ApiParameters;
3157
+ }): Promise<Response>;
3158
+ getCreditCardDefaultPercentageById(options: {
3159
+ baseUrl: string;
3160
+ token?: string;
3161
+ headers?: Record<string, string>;
3162
+ signal?: AbortSignal;
3163
+ fetchImpl?: typeof fetch;
3164
+ pathParams: {
3165
+ "id": string | number;
3166
+ };
3167
+ query?: ApiParameters;
3168
+ }): Promise<Response>;
3169
+ getCreditCardDefaultPercentages(options: {
3170
+ baseUrl: string;
3171
+ token?: string;
3172
+ headers?: Record<string, string>;
3173
+ signal?: AbortSignal;
3174
+ fetchImpl?: typeof fetch;
3175
+ pathParams?: Record<string, string | number>;
3176
+ query?: ApiParameters;
3177
+ }): Promise<Response>;
3178
+ getCreditCardMerchantToolSideNote(options: {
3179
+ baseUrl: string;
3180
+ token?: string;
3181
+ headers?: Record<string, string>;
3182
+ signal?: AbortSignal;
3183
+ fetchImpl?: typeof fetch;
3184
+ pathParams?: Record<string, string | number>;
3185
+ query?: ApiParameters;
3092
3186
  }): Promise<Response>;
3093
3187
  getDefaultDirectorySearch(options: {
3094
3188
  baseUrl: string;
@@ -3119,7 +3213,7 @@ export interface GeneratedApiClient {
3119
3213
  pathParams?: Record<string, string | number>;
3120
3214
  query?: ApiParameters;
3121
3215
  }): Promise<Response>;
3122
- getDestinationEpicsListAllLevelByIncludeInactive?(options: {
3216
+ getDestinationEpicsListAllLevelByIncludeInactive(options: {
3123
3217
  baseUrl: string;
3124
3218
  token?: string;
3125
3219
  headers?: Record<string, string>;
@@ -4692,6 +4786,15 @@ export interface GeneratedApiClient {
4692
4786
  fetchImpl?: typeof fetch;
4693
4787
  pathParams?: Record<string, string | number>;
4694
4788
  query?: ApiParameters;
4789
+ }): Promise<Response>;
4790
+ getUploadFilesPage(options: {
4791
+ baseUrl: string;
4792
+ token?: string;
4793
+ headers?: Record<string, string>;
4794
+ signal?: AbortSignal;
4795
+ fetchImpl?: typeof fetch;
4796
+ pathParams?: Record<string, string | number>;
4797
+ query?: ApiParameters;
4695
4798
  }): Promise<Response>;
4696
4799
  getUsefulLinkById(options: {
4697
4800
  baseUrl: string;
@@ -5042,6 +5145,16 @@ export interface GeneratedApiClient {
5042
5145
  pathParams?: Record<string, string | number>;
5043
5146
  query?: ApiParameters;
5044
5147
  body?: unknown;
5148
+ }): Promise<Response>;
5149
+ putCreditCardMerchantToolSideNote(options: {
5150
+ baseUrl: string;
5151
+ token?: string;
5152
+ headers?: Record<string, string>;
5153
+ signal?: AbortSignal;
5154
+ fetchImpl?: typeof fetch;
5155
+ pathParams?: Record<string, string | number>;
5156
+ query?: ApiParameters;
5157
+ body?: unknown;
5045
5158
  }): Promise<Response>;
5046
5159
  putDefaultDirectorySearch(options: {
5047
5160
  baseUrl: string;
@@ -5426,6 +5539,18 @@ export interface GeneratedApiClient {
5426
5539
  };
5427
5540
  query?: ApiParameters;
5428
5541
  body?: unknown;
5542
+ }): Promise<Response>;
5543
+ updateCreditCardDefaultPercentageById(options: {
5544
+ baseUrl: string;
5545
+ token?: string;
5546
+ headers?: Record<string, string>;
5547
+ signal?: AbortSignal;
5548
+ fetchImpl?: typeof fetch;
5549
+ pathParams: {
5550
+ "id": string | number;
5551
+ };
5552
+ query?: ApiParameters;
5553
+ body?: unknown;
5429
5554
  }): Promise<Response>;
5430
5555
  updateDestinationEpicById(options: {
5431
5556
  baseUrl: string;
@@ -6293,7 +6418,7 @@ export interface GeneratedApiClient {
6293
6418
  }): Promise<Response>;
6294
6419
  }
6295
6420
 
6296
- export type ApiClientGroupName = "accordion" | "accordionCategory" | "accordionItem" | "address" | "addressType" | "album" | "albumEmbeddedVideoItem" | "albumItem" | "albumPdfItem" | "aliasedDestination" | "announcement" | "answerOption" | "auth" | "authorizationType" | "blackbookGuideline" | "calendarItem" | "chartbrewReport" | "company" | "companyAlternateName" | "companyGdsId" | "companyHistory" | "companyQuestionAnswer" | "companyRelationship" | "companyStatuse" | "companySubType" | "companyType" | "companyTypeQuestionXref" | "companyVerification" | "connect" | "contentTypeBuilder" | "country" | "countrysubdivision" | "defaultDirectorySearch" | "destinationEpic" | "destinationLink" | "destinationMajor" | "destinationMinor" | "email" | "emailAddress" | "emailAddressType" | "eventSpace" | "eventSpaceLayout" | "eventType" | "externalEmailTemplate" | "footerContent" | "footerLegalMenu" | "footerMenu" | "gdsType" | "geographySearchItem" | "hawkSearchErrorLog" | "hawkSearchReindice" | "helpPage" | "heroImage" | "homePageButton" | "i18n" | "ingredient" | "landingPage" | "landingPageLink" | "landingPageVideo" | "language" | "layoutType" | "loyaltyProgram" | "loyaltyProgramCompany" | "loyaltyProgramContact" | "loyaltyProgramLink" | "loyaltyProgramVideo" | "mediaCategory" | "menuItem" | "meta" | "muxFolder" | "muxVideo" | "navigation" | "newsArticle" | "newsArticleGroup" | "newsArticleGroupCategory" | "newsArticleGroupCategoryTopic" | "newsArticleLink" | "people" | "peopleAtCompany" | "phoneNumber" | "phoneNumberType" | "policy" | "prefixe" | "primaryContactType" | "productRoadmap" | "pronoun" | "publicationNote" | "question" | "questionType" | "releaseNote" | "rss" | "rssFeed" | "savedFavoriteList" | "savedFavoriteListCompany" | "schemaVisualizer" | "shortcut" | "socialMedia" | "socialMediaType" | "special" | "sponsorship" | "sponsorshipAlsoInterestedIn" | "sponsorshipLocation" | "sponsorshipStatuse" | "suffixe" | "tag" | "trainingCourse" | "trainingLink" | "trainingModule" | "trainingVideoItem" | "upload" | "usefulLink" | "user" | "userAcceptedPolicy" | "usersPermission" | "vrLink";
6421
+ export type ApiClientGroupName = "accordion" | "accordionCategory" | "accordionItem" | "address" | "addressType" | "album" | "albumEmbeddedVideoItem" | "albumItem" | "albumPdfItem" | "aliasedDestination" | "announcement" | "answerOption" | "auth" | "authorizationType" | "blackbookGuideline" | "calendarItem" | "chartbrewReport" | "company" | "companyAlternateName" | "companyGdsId" | "companyHistory" | "companyQuestionAnswer" | "companyRelationship" | "companyStatuse" | "companySubType" | "companyType" | "companyTypeQuestionXref" | "companyVerification" | "connect" | "contentTypeBuilder" | "country" | "countrysubdivision" | "creditCardDefaultPercentage" | "creditCardMerchantToolSideNote" | "defaultDirectorySearch" | "destinationEpic" | "destinationLink" | "destinationMajor" | "destinationMinor" | "email" | "emailAddress" | "emailAddressType" | "eventSpace" | "eventSpaceLayout" | "eventType" | "externalEmailTemplate" | "footerContent" | "footerLegalMenu" | "footerMenu" | "gdsType" | "geographySearchItem" | "hawkSearchErrorLog" | "hawkSearchReindice" | "helpPage" | "heroImage" | "homePageButton" | "i18n" | "ingredient" | "landingPage" | "landingPageLink" | "landingPageVideo" | "language" | "layoutType" | "loyaltyProgram" | "loyaltyProgramCompany" | "loyaltyProgramContact" | "loyaltyProgramLink" | "loyaltyProgramVideo" | "mediaCategory" | "menuItem" | "meta" | "muxFolder" | "muxVideo" | "navigation" | "newsArticle" | "newsArticleGroup" | "newsArticleGroupCategory" | "newsArticleGroupCategoryTopic" | "newsArticleLink" | "people" | "peopleAtCompany" | "phoneNumber" | "phoneNumberType" | "policy" | "prefixe" | "primaryContactType" | "productRoadmap" | "pronoun" | "publicationNote" | "question" | "questionType" | "releaseNote" | "rss" | "rssFeed" | "savedFavoriteList" | "savedFavoriteListCompany" | "schemaVisualizer" | "shortcut" | "socialMedia" | "socialMediaType" | "special" | "sponsorship" | "sponsorshipAlsoInterestedIn" | "sponsorshipLocation" | "sponsorshipStatuse" | "suffixe" | "tag" | "trainingCourse" | "trainingLink" | "trainingModule" | "trainingVideoItem" | "upload" | "usefulLink" | "user" | "userAcceptedPolicy" | "usersPermission" | "vrLink";
6297
6422
 
6298
6423
  export interface GeneratedApiClientGroups {
6299
6424
  accordion: Pick<GeneratedApiClient,
@@ -6402,8 +6527,10 @@ export interface GeneratedApiClientGroups {
6402
6527
  "createAuthRefresh" |
6403
6528
  "createAuthResetPassword" |
6404
6529
  "createAuthSendEmailConfirmation" |
6530
+ "deleteAuthSessionBySessionId" |
6405
6531
  "getAuthCallbackByProvider" |
6406
6532
  "getAuthEmailConfirmation" |
6533
+ "getAuthSessions" |
6407
6534
  never
6408
6535
  >;
6409
6536
  authorizationType: Pick<GeneratedApiClient,
@@ -6441,6 +6568,7 @@ export interface GeneratedApiClientGroups {
6441
6568
  "createCompany" |
6442
6569
  "deleteCompanyById" |
6443
6570
  "getCompanies" |
6571
+ "getCompaniesCompanyPacSearchByQuery" |
6444
6572
  "getCompaniesGroundPartnerById" |
6445
6573
  "getCompaniesSecurityById" |
6446
6574
  "getCompaniesTransientCommissionByEpic" |
@@ -6537,7 +6665,7 @@ export interface GeneratedApiClientGroups {
6537
6665
  never
6538
6666
  >;
6539
6667
  connect: Pick<GeneratedApiClient,
6540
- "getConnect(.*)" |
6668
+ "getConnect" |
6541
6669
  never
6542
6670
  >;
6543
6671
  contentTypeBuilder: Pick<GeneratedApiClient,
@@ -6563,6 +6691,20 @@ export interface GeneratedApiClientGroups {
6563
6691
  "updateCountrysubdivisionById" |
6564
6692
  never
6565
6693
  >;
6694
+ creditCardDefaultPercentage: Pick<GeneratedApiClient,
6695
+ "createCreditCardDefaultPercentage" |
6696
+ "deleteCreditCardDefaultPercentageById" |
6697
+ "getCreditCardDefaultPercentageById" |
6698
+ "getCreditCardDefaultPercentages" |
6699
+ "updateCreditCardDefaultPercentageById" |
6700
+ never
6701
+ >;
6702
+ creditCardMerchantToolSideNote: Pick<GeneratedApiClient,
6703
+ "deleteCreditCardMerchantToolSideNote" |
6704
+ "getCreditCardMerchantToolSideNote" |
6705
+ "putCreditCardMerchantToolSideNote" |
6706
+ never
6707
+ >;
6566
6708
  defaultDirectorySearch: Pick<GeneratedApiClient,
6567
6709
  "deleteDefaultDirectorySearch" |
6568
6710
  "getDefaultDirectorySearch" |
@@ -6574,7 +6716,7 @@ export interface GeneratedApiClientGroups {
6574
6716
  "deleteDestinationEpicById" |
6575
6717
  "getDestinationEpicById" |
6576
6718
  "getDestinationEpics" |
6577
- "getDestinationEpicsListAllLevelByIncludeInactive?" |
6719
+ "getDestinationEpicsListAllLevelByIncludeInactive" |
6578
6720
  "getDestinationEpicsSearchByValueAndIncludeInactive" |
6579
6721
  "updateDestinationEpicById" |
6580
6722
  never
@@ -7188,6 +7330,7 @@ export interface GeneratedApiClientGroups {
7188
7330
  "deleteUploadFileById" |
7189
7331
  "getUploadFileById" |
7190
7332
  "getUploadFiles" |
7333
+ "getUploadFilesPage" |
7191
7334
  never
7192
7335
  >;
7193
7336
  usefulLink: Pick<GeneratedApiClient,
@@ -406,6 +406,18 @@ const endpointDefinitions = [
406
406
  "populate"
407
407
  ]
408
408
  },
409
+ {
410
+ "name": "createCreditCardDefaultPercentage",
411
+ "group": "creditCardDefaultPercentage",
412
+ "method": "POST",
413
+ "pathTemplate": "/credit-card-default-percentages",
414
+ "pathParams": [],
415
+ "hasBody": true,
416
+ "queryParams": [
417
+ "fields",
418
+ "populate"
419
+ ]
420
+ },
409
421
  {
410
422
  "name": "createDestinationEpic",
411
423
  "group": "destinationEpic",
@@ -1503,6 +1515,17 @@ const endpointDefinitions = [
1503
1515
  "filters"
1504
1516
  ]
1505
1517
  },
1518
+ {
1519
+ "name": "deleteAuthSessionBySessionId",
1520
+ "group": "auth",
1521
+ "method": "DELETE",
1522
+ "pathTemplate": "/auth/sessions/{sessionId}",
1523
+ "pathParams": [
1524
+ "sessionId"
1525
+ ],
1526
+ "hasBody": false,
1527
+ "queryParams": []
1528
+ },
1506
1529
  {
1507
1530
  "name": "deleteBlackbookGuideline",
1508
1531
  "group": "blackbookGuideline",
@@ -1737,6 +1760,33 @@ const endpointDefinitions = [
1737
1760
  "filters"
1738
1761
  ]
1739
1762
  },
1763
+ {
1764
+ "name": "deleteCreditCardDefaultPercentageById",
1765
+ "group": "creditCardDefaultPercentage",
1766
+ "method": "DELETE",
1767
+ "pathTemplate": "/credit-card-default-percentages/{id}",
1768
+ "pathParams": [
1769
+ "id"
1770
+ ],
1771
+ "hasBody": false,
1772
+ "queryParams": [
1773
+ "fields",
1774
+ "populate",
1775
+ "filters"
1776
+ ]
1777
+ },
1778
+ {
1779
+ "name": "deleteCreditCardMerchantToolSideNote",
1780
+ "group": "creditCardMerchantToolSideNote",
1781
+ "method": "DELETE",
1782
+ "pathTemplate": "/credit-card-merchant-tool-side-note",
1783
+ "pathParams": [],
1784
+ "hasBody": false,
1785
+ "queryParams": [
1786
+ "fields",
1787
+ "populate"
1788
+ ]
1789
+ },
1740
1790
  {
1741
1791
  "name": "deleteDefaultDirectorySearch",
1742
1792
  "group": "defaultDirectorySearch",
@@ -3322,6 +3372,15 @@ const endpointDefinitions = [
3322
3372
  "populate"
3323
3373
  ]
3324
3374
  },
3375
+ {
3376
+ "name": "getAuthSessions",
3377
+ "group": "auth",
3378
+ "method": "GET",
3379
+ "pathTemplate": "/auth/sessions",
3380
+ "pathParams": [],
3381
+ "hasBody": false,
3382
+ "queryParams": []
3383
+ },
3325
3384
  {
3326
3385
  "name": "getBlackbookGuidelines",
3327
3386
  "group": "blackbookGuideline",
@@ -3415,6 +3474,17 @@ const endpointDefinitions = [
3415
3474
  "populate"
3416
3475
  ]
3417
3476
  },
3477
+ {
3478
+ "name": "getCompaniesCompanyPacSearchByQuery",
3479
+ "group": "company",
3480
+ "method": "GET",
3481
+ "pathTemplate": "/companies/company-pac-search/{query}",
3482
+ "pathParams": [
3483
+ "query"
3484
+ ],
3485
+ "hasBody": false,
3486
+ "queryParams": []
3487
+ },
3418
3488
  {
3419
3489
  "name": "getCompaniesGroundPartnerById",
3420
3490
  "group": "company",
@@ -3833,7 +3903,7 @@ const endpointDefinitions = [
3833
3903
  ]
3834
3904
  },
3835
3905
  {
3836
- "name": "getConnect(.*)",
3906
+ "name": "getConnect",
3837
3907
  "group": "connect",
3838
3908
  "method": "GET",
3839
3909
  "pathTemplate": "/connect/(.*)",
@@ -3947,6 +4017,51 @@ const endpointDefinitions = [
3947
4017
  "populate"
3948
4018
  ]
3949
4019
  },
4020
+ {
4021
+ "name": "getCreditCardDefaultPercentageById",
4022
+ "group": "creditCardDefaultPercentage",
4023
+ "method": "GET",
4024
+ "pathTemplate": "/credit-card-default-percentages/{id}",
4025
+ "pathParams": [
4026
+ "id"
4027
+ ],
4028
+ "hasBody": false,
4029
+ "queryParams": [
4030
+ "fields",
4031
+ "populate",
4032
+ "filters",
4033
+ "sort"
4034
+ ]
4035
+ },
4036
+ {
4037
+ "name": "getCreditCardDefaultPercentages",
4038
+ "group": "creditCardDefaultPercentage",
4039
+ "method": "GET",
4040
+ "pathTemplate": "/credit-card-default-percentages",
4041
+ "pathParams": [],
4042
+ "hasBody": false,
4043
+ "queryParams": [
4044
+ "fields",
4045
+ "filters",
4046
+ "_q",
4047
+ "pagination",
4048
+ "sort",
4049
+ "populate"
4050
+ ]
4051
+ },
4052
+ {
4053
+ "name": "getCreditCardMerchantToolSideNote",
4054
+ "group": "creditCardMerchantToolSideNote",
4055
+ "method": "GET",
4056
+ "pathTemplate": "/credit-card-merchant-tool-side-note",
4057
+ "pathParams": [],
4058
+ "hasBody": false,
4059
+ "queryParams": [
4060
+ "fields",
4061
+ "populate",
4062
+ "filters"
4063
+ ]
4064
+ },
3950
4065
  {
3951
4066
  "name": "getDefaultDirectorySearch",
3952
4067
  "group": "defaultDirectorySearch",
@@ -3993,7 +4108,7 @@ const endpointDefinitions = [
3993
4108
  ]
3994
4109
  },
3995
4110
  {
3996
- "name": "getDestinationEpicsListAllLevelByIncludeInactive?",
4111
+ "name": "getDestinationEpicsListAllLevelByIncludeInactive",
3997
4112
  "group": "destinationEpic",
3998
4113
  "method": "GET",
3999
4114
  "pathTemplate": "/destination-epics/list-all-levels/{includeInactive?}",
@@ -6375,6 +6490,21 @@ const endpointDefinitions = [
6375
6490
  "filters"
6376
6491
  ]
6377
6492
  },
6493
+ {
6494
+ "name": "getUploadFilesPage",
6495
+ "group": "upload",
6496
+ "method": "GET",
6497
+ "pathTemplate": "/upload/files/page",
6498
+ "pathParams": [],
6499
+ "hasBody": false,
6500
+ "queryParams": [
6501
+ "fields",
6502
+ "populate",
6503
+ "sort",
6504
+ "pagination",
6505
+ "filters"
6506
+ ]
6507
+ },
6378
6508
  {
6379
6509
  "name": "getUsefulLinkById",
6380
6510
  "group": "usefulLink",
@@ -6779,6 +6909,18 @@ const endpointDefinitions = [
6779
6909
  "populate"
6780
6910
  ]
6781
6911
  },
6912
+ {
6913
+ "name": "putCreditCardMerchantToolSideNote",
6914
+ "group": "creditCardMerchantToolSideNote",
6915
+ "method": "PUT",
6916
+ "pathTemplate": "/credit-card-merchant-tool-side-note",
6917
+ "pathParams": [],
6918
+ "hasBody": true,
6919
+ "queryParams": [
6920
+ "fields",
6921
+ "populate"
6922
+ ]
6923
+ },
6782
6924
  {
6783
6925
  "name": "putDefaultDirectorySearch",
6784
6926
  "group": "defaultDirectorySearch",
@@ -7229,6 +7371,20 @@ const endpointDefinitions = [
7229
7371
  "populate"
7230
7372
  ]
7231
7373
  },
7374
+ {
7375
+ "name": "updateCreditCardDefaultPercentageById",
7376
+ "group": "creditCardDefaultPercentage",
7377
+ "method": "PUT",
7378
+ "pathTemplate": "/credit-card-default-percentages/{id}",
7379
+ "pathParams": [
7380
+ "id"
7381
+ ],
7382
+ "hasBody": true,
7383
+ "queryParams": [
7384
+ "fields",
7385
+ "populate"
7386
+ ]
7387
+ },
7232
7388
  {
7233
7389
  "name": "updateDestinationEpicById",
7234
7390
  "group": "destinationEpic",
@@ -397,6 +397,19 @@ export interface ApiCountrysubdivision extends ApiBaseEntity {
397
397
  publishedAt: string;
398
398
  }
399
399
 
400
+ export interface ApiCreditCardDefaultPercentage extends ApiBaseEntity {
401
+ Name?: string;
402
+ Rank?: number;
403
+ Fee?: number;
404
+ publishedAt: string;
405
+ }
406
+
407
+ export interface ApiCreditCardMerchantToolSideNote extends ApiBaseEntity {
408
+ Notes?: string;
409
+ CalculatorNotes?: string;
410
+ publishedAt: string;
411
+ }
412
+
400
413
  export interface ApiDefaultDirectorySearch extends ApiBaseEntity {
401
414
  SearchText?: string;
402
415
  publishedAt: string;
@@ -663,7 +676,7 @@ export interface ApiIngredient extends ApiBaseEntity {
663
676
 
664
677
  export interface ApiLandingPage extends ApiBaseEntity {
665
678
  Title?: string;
666
- Key?: "home" | "loyalty-programs" | "destinations" | "interests" | "travel-products" | "calendar" | "specials" | "commissions" | "financial" | "company-resources" | "training";
679
+ Key?: "home" | "loyalty-programs" | "destinations" | "interests" | "travel-products" | "calendar" | "specials" | "commissions" | "financial" | "company-resources" | "training" | "credit-card-merchant-tool";
667
680
  IsActive: boolean | null;
668
681
  Notes?: string;
669
682
  publishedAt: string;
@@ -1203,6 +1216,27 @@ export interface ApiTrainingVideoItem extends ApiBaseEntity {
1203
1216
  Course?: ApiTrainingCourse;
1204
1217
  }
1205
1218
 
1219
+ export interface ApiUpload extends ApiBaseEntity {
1220
+ name: string;
1221
+ alternativeText?: string | null;
1222
+ caption?: string | null;
1223
+ width?: number;
1224
+ height?: number;
1225
+ formats?: Record<string, unknown>;
1226
+ hash: string;
1227
+ ext?: string;
1228
+ mime: string;
1229
+ size: number;
1230
+ url: string;
1231
+ previewUrl?: string | null;
1232
+ folder?: number;
1233
+ folderPath: string;
1234
+ provider: string;
1235
+ provider_metadata?: Record<string, unknown> | null;
1236
+ createdBy?: number;
1237
+ updatedBy?: number;
1238
+ }
1239
+
1206
1240
  export interface ApiUsefulLink extends ApiBaseEntity {
1207
1241
  URL?: string;
1208
1242
  DisplayText?: string;
@@ -1228,4 +1262,4 @@ export interface ApiVrLink extends ApiBaseEntity {
1228
1262
  MediaCategory?: ApiMediaCategory;
1229
1263
  }
1230
1264
 
1231
- export type ApiEntity = ApiMedia | ApiUsersPermissionsRole | ApiUsersPermissionsUser | ApiAccordion | ApiAccordionCategory | ApiAccordionItem | ApiAddress | ApiAddressType | ApiAlbum | ApiAlbumEmbeddedVideoItem | ApiAlbumItem | ApiAlbumPdfItem | ApiAliasedDestination | ApiAnnouncement | ApiAnswerOption | ApiAuthorizationType | ApiBlackbookGuideline | ApiCalendarItem | ApiChartbrewReport | ApiCompany | ApiCompanyAlternateName | ApiCompanyGdsId | ApiCompanyHistory | ApiCompanyQuestionAnswer | ApiCompanyRelationship | ApiCompanyStatuse | ApiCompanySubType | ApiCompanyType | ApiCompanyTypeQuestionXref | ApiCompanyVerification | ApiContentTypeBuilder | ApiCountry | ApiCountrysubdivision | ApiDefaultDirectorySearch | ApiDestinationEpic | ApiDestinationLink | ApiDestinationMajor | ApiDestinationMinor | ApiEmailAddress | ApiEmailAddressType | ApiEventSpace | ApiEventSpaceLayout | ApiEventType | ApiExternalEmailTemplate | ApiFooterContent | ApiFooterLegalMenu | ApiFooterMenu | ApiGdsType | ApiGeographySearchItem | ApiHawkSearchErrorLog | ApiHawkSearchReindice | ApiHelpPage | ApiHeroImage | ApiHomePageButton | ApiIngredient | ApiLandingPage | ApiLandingPageLink | ApiLandingPageVideo | ApiLanguage | ApiLayoutType | ApiLoyaltyProgram | ApiLoyaltyProgramCompany | ApiLoyaltyProgramContact | ApiLoyaltyProgramLink | ApiLoyaltyProgramVideo | ApiMediaCategory | ApiMenuItem | ApiMuxFolder | ApiMuxVideo | ApiNavigation | ApiNewsArticle | ApiNewsArticleGroup | ApiNewsArticleGroupCategory | ApiNewsArticleGroupCategoryTopic | ApiNewsArticleLink | ApiPeople | ApiPeopleAtCompany | ApiPhoneNumber | ApiPhoneNumberType | ApiPolicy | ApiPrefixe | ApiPrimaryContactType | ApiProductRoadmap | ApiPronoun | ApiPublicationNote | ApiQuestion | ApiQuestionType | ApiReleaseNote | ApiRssFeed | ApiSavedFavoriteList | ApiSavedFavoriteListCompany | ApiShortcut | ApiSocialMedia | ApiSocialMediaType | ApiSpecial | ApiSponsorship | ApiSponsorshipAlsoInterestedIn | ApiSponsorshipLocation | ApiSponsorshipStatuse | ApiSuffixe | ApiTag | ApiTrainingCourse | ApiTrainingLink | ApiTrainingModule | ApiTrainingVideoItem | ApiUsefulLink | ApiUserAcceptedPolicy | ApiVrLink;
1265
+ export type ApiEntity = ApiMedia | ApiUsersPermissionsRole | ApiUsersPermissionsUser | ApiAccordion | ApiAccordionCategory | ApiAccordionItem | ApiAddress | ApiAddressType | ApiAlbum | ApiAlbumEmbeddedVideoItem | ApiAlbumItem | ApiAlbumPdfItem | ApiAliasedDestination | ApiAnnouncement | ApiAnswerOption | ApiAuthorizationType | ApiBlackbookGuideline | ApiCalendarItem | ApiChartbrewReport | ApiCompany | ApiCompanyAlternateName | ApiCompanyGdsId | ApiCompanyHistory | ApiCompanyQuestionAnswer | ApiCompanyRelationship | ApiCompanyStatuse | ApiCompanySubType | ApiCompanyType | ApiCompanyTypeQuestionXref | ApiCompanyVerification | ApiContentTypeBuilder | ApiCountry | ApiCountrysubdivision | ApiCreditCardDefaultPercentage | ApiCreditCardMerchantToolSideNote | ApiDefaultDirectorySearch | ApiDestinationEpic | ApiDestinationLink | ApiDestinationMajor | ApiDestinationMinor | ApiEmailAddress | ApiEmailAddressType | ApiEventSpace | ApiEventSpaceLayout | ApiEventType | ApiExternalEmailTemplate | ApiFooterContent | ApiFooterLegalMenu | ApiFooterMenu | ApiGdsType | ApiGeographySearchItem | ApiHawkSearchErrorLog | ApiHawkSearchReindice | ApiHelpPage | ApiHeroImage | ApiHomePageButton | ApiIngredient | ApiLandingPage | ApiLandingPageLink | ApiLandingPageVideo | ApiLanguage | ApiLayoutType | ApiLoyaltyProgram | ApiLoyaltyProgramCompany | ApiLoyaltyProgramContact | ApiLoyaltyProgramLink | ApiLoyaltyProgramVideo | ApiMediaCategory | ApiMenuItem | ApiMuxFolder | ApiMuxVideo | ApiNavigation | ApiNewsArticle | ApiNewsArticleGroup | ApiNewsArticleGroupCategory | ApiNewsArticleGroupCategoryTopic | ApiNewsArticleLink | ApiPeople | ApiPeopleAtCompany | ApiPhoneNumber | ApiPhoneNumberType | ApiPolicy | ApiPrefixe | ApiPrimaryContactType | ApiProductRoadmap | ApiPronoun | ApiPublicationNote | ApiQuestion | ApiQuestionType | ApiReleaseNote | ApiRssFeed | ApiSavedFavoriteList | ApiSavedFavoriteListCompany | ApiShortcut | ApiSocialMedia | ApiSocialMediaType | ApiSpecial | ApiSponsorship | ApiSponsorshipAlsoInterestedIn | ApiSponsorshipLocation | ApiSponsorshipStatuse | ApiSuffixe | ApiTag | ApiTrainingCourse | ApiTrainingLink | ApiTrainingModule | ApiTrainingVideoItem | ApiUpload | ApiUsefulLink | ApiUserAcceptedPolicy | ApiVrLink;
package/dist/index.d.ts CHANGED
@@ -1,3 +1,4 @@
1
1
  export * from './generated/api-types';
2
2
  export * from './generated/api-client';
3
3
  export * from './api-response-helpers';
4
+ export * from './auth-helpers';
package/dist/index.js CHANGED
@@ -2,8 +2,10 @@
2
2
 
3
3
  const apiClient = require("./generated/api-client");
4
4
  const responseHelpers = require("./api-response-helpers");
5
+ const authHelpers = require("./auth-helpers");
5
6
 
6
7
  module.exports = {
7
8
  ...apiClient,
8
9
  ...responseHelpers,
10
+ ...authHelpers,
9
11
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@embark-black-book/api-contract",
3
- "version": "0.1.0",
3
+ "version": "0.3.0",
4
4
  "description": "Type contract package generated from Blackbook by Embark Strapi OpenAPI",
5
5
  "license": "UNLICENSED",
6
6
  "exports": {