@tennac-booking/sdk 1.0.81 → 1.0.82
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/.openapi-generator/FILES +246 -134
- package/README.md +325 -123
- package/api.ts +17109 -6137
- package/base.ts +4 -4
- package/common.ts +3 -3
- package/configuration.ts +3 -3
- package/dist/api.d.ts +11466 -3726
- package/dist/api.js +7819 -2859
- package/dist/base.d.ts +3 -3
- package/dist/base.js +4 -4
- package/dist/common.d.ts +3 -3
- package/dist/common.js +3 -3
- package/dist/configuration.d.ts +3 -3
- package/dist/configuration.js +3 -3
- package/dist/esm/api.d.ts +11466 -3726
- package/dist/esm/api.js +7724 -2760
- package/dist/esm/base.d.ts +3 -3
- package/dist/esm/base.js +4 -4
- package/dist/esm/common.d.ts +3 -3
- package/dist/esm/common.js +3 -3
- package/dist/esm/configuration.d.ts +3 -3
- package/dist/esm/configuration.js +3 -3
- package/dist/esm/index.d.ts +3 -3
- package/dist/esm/index.js +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +3 -3
- package/docs/{DeleteSlotsByClubInRange200Response.md → AddClubMember201Response.md} +6 -4
- package/docs/AddClubMemberRequest.md +7 -3
- package/docs/AddOrganizationRequest.md +22 -0
- package/docs/AddPaymentMethodRequestBody.md +20 -0
- package/docs/BookingAnalyticsResponse.md +34 -0
- package/docs/BookingDetailResponse.md +46 -0
- package/docs/BookingHistoryPopulated.md +34 -0
- package/docs/BookingInfo.md +50 -0
- package/docs/BookingPaymentStatusResponse.md +24 -0
- package/docs/BookingPaymentStatusResponseBooking.md +27 -0
- package/docs/BookingPaymentStatusResponseSummary.md +29 -0
- package/docs/BookingPopulated.md +46 -0
- package/docs/BookingResponse.md +4 -4
- package/docs/BookingResponseOnsitePaymentsInner.md +22 -0
- package/docs/BookingStatus.md +11 -1
- package/docs/BookingSummary.md +44 -0
- package/docs/{GetAllSportsRequest.md → BookingSummaryClubAddress.md} +3 -5
- package/docs/BookingsApi.md +138 -0
- package/docs/{ManagerSportsApi.md → BookingsManagerApi.md} +30 -34
- package/docs/BookingsStaffApi.md +323 -0
- package/docs/{UserBookingsApi.md → BookingsUserApi.md} +18 -26
- package/docs/CancelBookingResponse.md +1 -1
- package/docs/CaptureResult.md +30 -0
- package/docs/ChangePasswordResponse.md +1 -1
- package/docs/CheckInPlayersRequest.md +20 -0
- package/docs/CheckInPlayersResponse.md +22 -0
- package/docs/CheckedInPlayer.md +34 -0
- package/docs/{AdminClubsApi.md → ClubAnalyticsApi.md} +27 -34
- package/docs/ClubAnalyticsStaffApi.md +690 -0
- package/docs/ClubMemberResponse.md +24 -0
- package/docs/ClubMemberResponseUser.md +27 -0
- package/docs/ClubPlayerBookingItem.md +36 -0
- package/docs/ClubPlayerBookingsResponse.md +22 -0
- package/docs/ClubPlayerDetailResponse.md +46 -0
- package/docs/{RestoreSubscriptionPlanForClub200Response.md → ClubPlayerDetailResponseSportsLevelsInner.md} +7 -5
- package/docs/ClubPlayerResponse.md +36 -0
- package/docs/ClubPlayerStatisticsResponse.md +42 -0
- package/docs/ClubPlayerStatisticsResponseBookingAmountEvolutionThisMonthInner.md +22 -0
- package/docs/ClubPlayerStatisticsResponseFavoriteClub.md +23 -0
- package/docs/ClubPlayerStatisticsResponseMostPlayedClub.md +25 -0
- package/docs/ClubPlayerStatisticsResponseMostPlayedPartnersInner.md +26 -0
- package/docs/ClubPlayerSubscriptionSummary.md +28 -0
- package/docs/ClubResponse.md +26 -22
- package/docs/ClubResponseCreatedAt.md +19 -0
- package/docs/ClubResponseLocation.md +29 -0
- package/docs/ClubResponseLocationCoordinates.md +22 -0
- package/docs/ClubResponseUpdatedAt.md +19 -0
- package/docs/ClubRoleResponse.md +11 -9
- package/docs/ClubRolesManagerApi.md +177 -0
- package/docs/ClubRolesStaffApi.md +154 -0
- package/docs/ClubSettingsManagerApi.md +221 -0
- package/docs/ClubSettingsResponse.md +41 -0
- package/docs/ClubSubscriptions.md +26 -0
- package/docs/ClubSummary.md +28 -0
- package/docs/{GetNumberOfClubUsers200Response.md → ClubUserCountResponse.md} +4 -4
- package/docs/ClubsApi.md +614 -0
- package/docs/ClubsManagerApi.md +950 -0
- package/docs/ClubsStaffApi.md +329 -0
- package/docs/ConfirmPaymentMethodRequestBody.md +20 -0
- package/docs/ConfirmPaymentMethodResponse.md +22 -0
- package/docs/CourtInfo.md +28 -0
- package/docs/CourtResponse.md +20 -16
- package/docs/CourtStatus.md +2 -5
- package/docs/CreateBookingRequest.md +3 -3
- package/docs/CreateClubRequest.md +0 -18
- package/docs/{ConfirmPaymentMethodSetupRequestBody.md → CreateClubRoleRequest.md} +7 -5
- package/docs/CreateClubSettingsRequest.md +15 -9
- package/docs/CreateCourtForClub201Response.md +20 -0
- package/docs/CreateCourtRequest.md +10 -12
- package/docs/CreateEventRequest.md +56 -0
- package/docs/CreatePlan201Response.md +22 -0
- package/docs/CreateSportForClub201Response.md +20 -0
- package/docs/CreateSportForClubRequest.md +26 -0
- package/docs/CreateSportRequest.md +6 -6
- package/docs/CreateSubscriptionPlanRequest.md +12 -4
- package/docs/CreateSubscriptionPlanRequestDiscount.md +32 -0
- package/docs/CreatorChargeResult.md +26 -0
- package/docs/DailyTurnoverResponse.md +24 -0
- package/docs/{StaffSportsApi.md → DefaultApi.md} +18 -18
- package/docs/{DeleteSlotsResponse.md → DeleteClubRoleResponse.md} +4 -4
- package/docs/DeleteClubSettingsResponse.md +20 -0
- package/docs/{DeleteSport200Response.md → DeleteCourtResponse.md} +4 -4
- package/docs/{GenerateSlotsResponse.md → DeleteEventResponse.md} +4 -4
- package/docs/{DeleteClubRole200Response.md → DeleteSportResponse.md} +4 -4
- package/docs/DeleteSubscriptionPlanResponse.md +20 -0
- package/docs/{StripeStatus.md → DiscountType.md} +5 -7
- package/docs/EventResponse.md +66 -0
- package/docs/EventResponseCourtsInner.md +18 -0
- package/docs/EventsApi.md +238 -0
- package/docs/EventsListResponse.md +20 -0
- package/docs/{ManagerClubsApi.md → EventsManagerApi.md} +79 -75
- package/docs/{StaffProfileApi.md → EventsStaffApi.md} +14 -13
- package/docs/{AddClubMemberResponse.md → FavoriteClubMutationResponse.md} +6 -6
- package/docs/{GetClubSettingsRequest.md → FavoriteClubRequestBody.md} +3 -3
- package/docs/{BlockSlotResponse.md → FavoriteClubsResponse.md} +5 -7
- package/docs/FavoritePlayerMutationResponse.md +22 -0
- package/docs/FavoritePlayerRequestBody.md +20 -0
- package/docs/FavoritePlayersResponse.md +20 -0
- package/docs/Gender.md +12 -0
- package/docs/GenderPercentageResponse.md +26 -0
- package/docs/GetActualities200Response.md +20 -0
- package/docs/GetAvailableSlotsBySports200Response.md +20 -0
- package/docs/{ClubMembersResponse.md → GetClubMembers200Response.md} +6 -6
- package/docs/GetClubRoles200Response.md +20 -0
- package/docs/GetClubUsersById200Response.md +20 -0
- package/docs/GetClubsWithVerificationDomains200ResponseInner.md +26 -0
- package/docs/GetCourtsByClubAndSportById200Response.md +26 -0
- package/docs/GetInfillPercentagePerPeriod200Response.md +24 -0
- package/docs/{SlotsResponse.md → GetSlotsByClubById200Response.md} +6 -6
- package/docs/GoogleAuthRequestBody.md +20 -0
- package/docs/GoogleAuthResponse.md +30 -0
- package/docs/GoogleAuthResponseUser.md +26 -0
- package/docs/{Court.md → ICourtData.md} +18 -6
- package/docs/ILevelBySports.md +22 -0
- package/docs/IUserAttributes.md +82 -0
- package/docs/IUserAttributesOrganizationsInner.md +28 -0
- package/docs/IUserLocation.md +44 -0
- package/docs/InvoiceInfo.md +24 -0
- package/docs/JoinEventRequest.md +22 -0
- package/docs/{ApiErrorResponse.md → JoinEventResponse.md} +6 -6
- package/docs/LastSixMonthsTurnoverItem.md +22 -0
- package/docs/{ActiveClub.md → LevelBySportEntry.md} +7 -7
- package/docs/LoginResponse.md +2 -0
- package/docs/ManagerCancelBookingRequest.md +20 -0
- package/docs/ManagerCancelBookingResponse.md +1 -1
- package/docs/MonthlyBreakdown.md +24 -0
- package/docs/MonthlyTurnoverResponse.md +29 -0
- package/docs/NoShowFeeResponse.md +30 -0
- package/docs/OffPeakRule.md +26 -0
- package/docs/PartialClubResponse.md +51 -0
- package/docs/PasswordResetRequestBody.md +20 -0
- package/docs/PaymentByPlayerInfo.md +22 -0
- package/docs/PaymentMethod.md +2 -1
- package/docs/PaymentMethodSetupResponse.md +24 -0
- package/docs/PickIUserLocationExcludeKeyofIUserLocationType.md +43 -0
- package/docs/PlanInterval.md +14 -0
- package/docs/PlayerCategoriesResponse.md +20 -0
- package/docs/PlayerCategory.md +26 -0
- package/docs/PlayerCategoryId.md +16 -0
- package/docs/PlayerListResponse.md +26 -0
- package/docs/PlayerPaymentInfo.md +36 -0
- package/docs/PlayerSummary.md +42 -0
- package/docs/ProfilePictureResponse.md +20 -0
- package/docs/{ActiveClubListResponse.md → ProfilePictureUpdateRequestBody.md} +5 -5
- package/docs/PublicSubscriptionPlanResponse.md +30 -0
- package/docs/PublicUserProfileResponse.md +44 -0
- package/docs/PublishEventResponse.md +20 -0
- package/docs/QuickReservationClubSummary.md +28 -0
- package/docs/QuickReservationClubSummaryLocation.md +31 -0
- package/docs/QuickReservationResponse.md +22 -0
- package/docs/QuickReservationSlotSummary.md +42 -0
- package/docs/RefreshTokenResponse.md +6 -2
- package/docs/RegisterRequestBody.md +6 -0
- package/docs/RegisterRequestBodyLocation.md +44 -0
- package/docs/RequestPasswordReset200Response.md +20 -0
- package/docs/{GoogleSignInResponse.md → ResetPasswordRequest.md} +5 -7
- package/docs/SetupPaymentMethodRequestBody.md +1 -3
- package/docs/SetupPaymentMethodResponse.md +3 -3
- package/docs/SlotInfo.md +26 -0
- package/docs/SportAnalyticsResponse.md +24 -0
- package/docs/SportInfo.md +22 -0
- package/docs/SportKey.md +14 -0
- package/docs/SportLevel.md +22 -0
- package/docs/SportResponse.md +14 -8
- package/docs/SportWithLevels.md +30 -0
- package/docs/SportsManagerApi.md +180 -0
- package/docs/SportsStaffApi.md +55 -0
- package/docs/StaffUserProfileResponse.md +86 -0
- package/docs/StripeStripeDeletedProduct.md +25 -0
- package/docs/StripeStripePrice.md +63 -0
- package/docs/StripeStripePriceBillingScheme.md +10 -0
- package/docs/StripeStripePriceCurrencyOptions.md +28 -0
- package/docs/StripeStripePriceCurrencyOptionsCustomUnitAmount.md +24 -0
- package/docs/StripeStripePriceCurrencyOptionsTaxBehavior.md +12 -0
- package/docs/StripeStripePriceCurrencyOptionsTier.md +28 -0
- package/docs/StripeStripePriceCustomUnitAmount.md +24 -0
- package/docs/StripeStripePriceProduct.md +59 -0
- package/docs/StripeStripePriceRecurring.md +28 -0
- package/docs/StripeStripePriceRecurringInterval.md +14 -0
- package/docs/StripeStripePriceRecurringUsageType.md +10 -0
- package/docs/StripeStripePriceTaxBehavior.md +12 -0
- package/docs/StripeStripePriceTier.md +28 -0
- package/docs/StripeStripePriceTiersMode.md +10 -0
- package/docs/StripeStripePriceTransformQuantity.md +22 -0
- package/docs/StripeStripePriceTransformQuantityRound.md +10 -0
- package/docs/StripeStripePriceType.md +10 -0
- package/docs/StripeStripeProduct.md +59 -0
- package/docs/StripeStripeProductDefaultPrice.md +63 -0
- package/docs/StripeStripeProductMarketingFeature.md +20 -0
- package/docs/StripeStripeProductPackageDimensions.md +26 -0
- package/docs/StripeStripeProductTaxCode.md +27 -0
- package/docs/StripeStripeProductType.md +10 -0
- package/docs/StripeStripeResponseStripeStripePrice.md +64 -0
- package/docs/StripeStripeResponseStripeStripePriceAllOfLastResponse.md +30 -0
- package/docs/StripeStripeTaxCode.md +27 -0
- package/docs/{DeleteClubSettingsRequest.md → SubscribeRequestBody.md} +5 -3
- package/docs/SubscriberPrice.md +22 -0
- package/docs/SubscriptionMutationResponse.md +20 -0
- package/docs/SubscriptionPlanResponse.md +16 -14
- package/docs/SubscriptionsManagerApi.md +171 -0
- package/docs/{StaffClubsApi.md → SubscriptionsPublicApi.md} +16 -15
- package/docs/{UserClubsApi.md → SubscriptionsStaffApi.md} +13 -12
- package/docs/SubscriptionsUserApi.md +222 -0
- package/docs/SurfaceType.md +12 -0
- package/docs/Team.md +22 -0
- package/docs/UpdateActuality200Response.md +20 -0
- package/docs/UpdateClubRequest.md +14 -20
- package/docs/UpdateClubRequestLocation.md +29 -0
- package/docs/UpdateClubRequestLocationCoordinates.md +22 -0
- package/docs/UpdateClubRoleRequest.md +22 -0
- package/docs/UpdateClubSettingsRequest.md +14 -10
- package/docs/UpdateCustomerRequestBody.md +3 -7
- package/docs/UpdateCustomerResponse.md +1 -3
- package/docs/UpdateEventRequest.md +54 -0
- package/docs/{ClubListResponse.md → UpdateLevelBySportsRequestBody.md} +5 -7
- package/docs/UpdatePlanRequest.md +22 -0
- package/docs/UpdateSportRequest.md +7 -3
- package/docs/UpdateSubscriptionPlanForClub200Response.md +20 -0
- package/docs/UpdateUserRequestBody.md +8 -2
- package/docs/UpdateUserRequestBodyLevelBySportsInner.md +22 -0
- package/docs/UserClubSubscription.md +42 -0
- package/docs/UserInfo.md +28 -0
- package/docs/UserLocationSummary.md +44 -0
- package/docs/UserProfileResponse.md +94 -0
- package/docs/UserRolesResponse.md +20 -0
- package/docs/{GetActiveClubs200Response.md → UserSubscriptionsResponse.md} +5 -5
- package/docs/UsersApi.md +1963 -0
- package/docs/VerifyEmailRequest.md +20 -0
- package/docs/YearlyTurnoverResponse.md +26 -0
- package/index.ts +3 -3
- package/package.json +5 -4
- package/docs/AdminClubSlotsApi.md +0 -62
- package/docs/Booking.md +0 -32
- package/docs/CancelBookingResponseBooking.md +0 -30
- package/docs/Club.md +0 -46
- package/docs/ClubInfoResponse.md +0 -46
- package/docs/ClubMember.md +0 -34
- package/docs/ClubRole.md +0 -30
- package/docs/ClubRolesResponse.md +0 -22
- package/docs/ClubSettings.md +0 -34
- package/docs/ClubsResponse.md +0 -22
- package/docs/ConfirmPaymentMethodSetupResponse.md +0 -22
- package/docs/CourtsResponse.md +0 -22
- package/docs/CreateClubRoleRequestBody.md +0 -24
- package/docs/CreatePriceRequest.md +0 -26
- package/docs/GetClubInfos200Response.md +0 -30
- package/docs/GetCourtsByClubAndSport200Response.md +0 -26
- package/docs/GetLastSixMonthsTurnover200ResponseInner.md +0 -24
- package/docs/GetUserRolesResponse.md +0 -20
- package/docs/GetUserRolesResponseRolesInner.md +0 -26
- package/docs/GetUserSubscriptionsResponse.md +0 -22
- package/docs/GoogleSignInRequestBody.md +0 -20
- package/docs/InitiateSubscriptionSessionRequestBody.md +0 -26
- package/docs/InitiateSubscriptionSessionResponse.md +0 -22
- package/docs/ManagerCancelBookingResponseBooking.md +0 -30
- package/docs/ManagerClubCourtsApi.md +0 -118
- package/docs/ManagerClubRolesApi.md +0 -268
- package/docs/ManagerClubSlotsApi.md +0 -125
- package/docs/ManagerClubSubscriptionsApi.md +0 -408
- package/docs/PriceResponse.md +0 -32
- package/docs/Slot.md +0 -24
- package/docs/SlotException.md +0 -26
- package/docs/SlotResponse.md +0 -34
- package/docs/Sport.md +0 -24
- package/docs/SportsResponse.md +0 -22
- package/docs/StaffClubAnalyticsApi.md +0 -111
- package/docs/StaffClubBookingsApi.md +0 -59
- package/docs/StaffClubSettingsApi.md +0 -62
- package/docs/SubscribeToClubRequestBody.md +0 -22
- package/docs/SubscriptionPlan.md +0 -36
- package/docs/SubscriptionResponse.md +0 -36
- package/docs/UpdateClubRoleRequestBody.md +0 -24
- package/docs/UpdateCustomerRequestBodyAddress.md +0 -30
- package/docs/UpdateCustomerResponseCustomer.md +0 -28
- package/docs/UpdateSubscriptionPlanRequest.md +0 -24
- package/docs/UpdateSubscriptionPlanResponse.md +0 -22
- package/docs/User.md +0 -40
- package/docs/UserApi.md +0 -119
- package/docs/UserAuthenticationApi.md +0 -226
- package/docs/UserClubCourtsApi.md +0 -64
- package/docs/UserClubSlotsApi.md +0 -181
- package/docs/UserClubSportsApi.md +0 -60
- package/docs/UserPaymentApi.md +0 -121
- package/docs/UserProfileApi.md +0 -224
- package/docs/UserResponse.md +0 -38
- package/docs/UserSubscriptionsApi.md +0 -222
- package/docs/UsersResponse.md +0 -22
|
@@ -0,0 +1,180 @@
|
|
|
1
|
+
# SportsManagerApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**createSport**](#createsport) | **POST** /api/sports | |
|
|
8
|
+
|[**deleteSport**](#deletesport) | **DELETE** /api/sports/{id} | |
|
|
9
|
+
|[**updateSport**](#updatesport) | **PUT** /api/sports/{id} | |
|
|
10
|
+
|
|
11
|
+
# **createSport**
|
|
12
|
+
> SportResponse createSport(createSportRequest)
|
|
13
|
+
|
|
14
|
+
Crée un sport (global) avec createdBy = clubId de l\'utilisateur
|
|
15
|
+
|
|
16
|
+
### Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import {
|
|
20
|
+
SportsManagerApi,
|
|
21
|
+
Configuration,
|
|
22
|
+
CreateSportRequest
|
|
23
|
+
} from '@tennac-booking/sdk';
|
|
24
|
+
|
|
25
|
+
const configuration = new Configuration();
|
|
26
|
+
const apiInstance = new SportsManagerApi(configuration);
|
|
27
|
+
|
|
28
|
+
let createSportRequest: CreateSportRequest; //
|
|
29
|
+
|
|
30
|
+
const { status, data } = await apiInstance.createSport(
|
|
31
|
+
createSportRequest
|
|
32
|
+
);
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Parameters
|
|
36
|
+
|
|
37
|
+
|Name | Type | Description | Notes|
|
|
38
|
+
|------------- | ------------- | ------------- | -------------|
|
|
39
|
+
| **createSportRequest** | **CreateSportRequest**| | |
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
### Return type
|
|
43
|
+
|
|
44
|
+
**SportResponse**
|
|
45
|
+
|
|
46
|
+
### Authorization
|
|
47
|
+
|
|
48
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
49
|
+
|
|
50
|
+
### HTTP request headers
|
|
51
|
+
|
|
52
|
+
- **Content-Type**: application/json
|
|
53
|
+
- **Accept**: application/json
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
### HTTP response details
|
|
57
|
+
| Status code | Description | Response headers |
|
|
58
|
+
|-------------|-------------|------------------|
|
|
59
|
+
|**201** | Sport créé | - |
|
|
60
|
+
|**400** | Bad Request | - |
|
|
61
|
+
|**401** | Unauthorized | - |
|
|
62
|
+
|**409** | Conflict | - |
|
|
63
|
+
|**500** | Server Error | - |
|
|
64
|
+
|
|
65
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
66
|
+
|
|
67
|
+
# **deleteSport**
|
|
68
|
+
> DeleteSportResponse deleteSport()
|
|
69
|
+
|
|
70
|
+
Supprime un sport (interdit si vérifié)
|
|
71
|
+
|
|
72
|
+
### Example
|
|
73
|
+
|
|
74
|
+
```typescript
|
|
75
|
+
import {
|
|
76
|
+
SportsManagerApi,
|
|
77
|
+
Configuration
|
|
78
|
+
} from '@tennac-booking/sdk';
|
|
79
|
+
|
|
80
|
+
const configuration = new Configuration();
|
|
81
|
+
const apiInstance = new SportsManagerApi(configuration);
|
|
82
|
+
|
|
83
|
+
let id: string; // (default to undefined)
|
|
84
|
+
|
|
85
|
+
const { status, data } = await apiInstance.deleteSport(
|
|
86
|
+
id
|
|
87
|
+
);
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### Parameters
|
|
91
|
+
|
|
92
|
+
|Name | Type | Description | Notes|
|
|
93
|
+
|------------- | ------------- | ------------- | -------------|
|
|
94
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
### Return type
|
|
98
|
+
|
|
99
|
+
**DeleteSportResponse**
|
|
100
|
+
|
|
101
|
+
### Authorization
|
|
102
|
+
|
|
103
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
104
|
+
|
|
105
|
+
### HTTP request headers
|
|
106
|
+
|
|
107
|
+
- **Content-Type**: Not defined
|
|
108
|
+
- **Accept**: application/json
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
### HTTP response details
|
|
112
|
+
| Status code | Description | Response headers |
|
|
113
|
+
|-------------|-------------|------------------|
|
|
114
|
+
|**200** | Sport supprimé | - |
|
|
115
|
+
|**401** | Unauthorized | - |
|
|
116
|
+
|**403** | Forbidden - Sport vérifié non supprimable | - |
|
|
117
|
+
|**404** | Sport non trouvé | - |
|
|
118
|
+
|**500** | Server Error | - |
|
|
119
|
+
|
|
120
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
121
|
+
|
|
122
|
+
# **updateSport**
|
|
123
|
+
> SportResponse updateSport(updateSportRequest)
|
|
124
|
+
|
|
125
|
+
Met à jour un sport (interdit si vérifié)
|
|
126
|
+
|
|
127
|
+
### Example
|
|
128
|
+
|
|
129
|
+
```typescript
|
|
130
|
+
import {
|
|
131
|
+
SportsManagerApi,
|
|
132
|
+
Configuration,
|
|
133
|
+
UpdateSportRequest
|
|
134
|
+
} from '@tennac-booking/sdk';
|
|
135
|
+
|
|
136
|
+
const configuration = new Configuration();
|
|
137
|
+
const apiInstance = new SportsManagerApi(configuration);
|
|
138
|
+
|
|
139
|
+
let id: string; // (default to undefined)
|
|
140
|
+
let updateSportRequest: UpdateSportRequest; //
|
|
141
|
+
|
|
142
|
+
const { status, data } = await apiInstance.updateSport(
|
|
143
|
+
id,
|
|
144
|
+
updateSportRequest
|
|
145
|
+
);
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### Parameters
|
|
149
|
+
|
|
150
|
+
|Name | Type | Description | Notes|
|
|
151
|
+
|------------- | ------------- | ------------- | -------------|
|
|
152
|
+
| **updateSportRequest** | **UpdateSportRequest**| | |
|
|
153
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
### Return type
|
|
157
|
+
|
|
158
|
+
**SportResponse**
|
|
159
|
+
|
|
160
|
+
### Authorization
|
|
161
|
+
|
|
162
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
163
|
+
|
|
164
|
+
### HTTP request headers
|
|
165
|
+
|
|
166
|
+
- **Content-Type**: application/json
|
|
167
|
+
- **Accept**: application/json
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
### HTTP response details
|
|
171
|
+
| Status code | Description | Response headers |
|
|
172
|
+
|-------------|-------------|------------------|
|
|
173
|
+
|**200** | Sport mis à jour | - |
|
|
174
|
+
|**401** | Unauthorized | - |
|
|
175
|
+
|**403** | Forbidden - Sport vérifié non modifiable | - |
|
|
176
|
+
|**404** | Sport non trouvé | - |
|
|
177
|
+
|**500** | Server Error | - |
|
|
178
|
+
|
|
179
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
180
|
+
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# SportsStaffApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getAllSports**](#getallsports) | **GET** /api/sports | |
|
|
8
|
+
|
|
9
|
+
# **getAllSports**
|
|
10
|
+
> Array<SportResponse> getAllSports()
|
|
11
|
+
|
|
12
|
+
Récupère la liste des sports (vérifiés + créés par le club de l\'utilisateur)
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
SportsStaffApi,
|
|
19
|
+
Configuration
|
|
20
|
+
} from '@tennac-booking/sdk';
|
|
21
|
+
|
|
22
|
+
const configuration = new Configuration();
|
|
23
|
+
const apiInstance = new SportsStaffApi(configuration);
|
|
24
|
+
|
|
25
|
+
const { status, data } = await apiInstance.getAllSports();
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Parameters
|
|
29
|
+
This endpoint does not have any parameters.
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
### Return type
|
|
33
|
+
|
|
34
|
+
**Array<SportResponse>**
|
|
35
|
+
|
|
36
|
+
### Authorization
|
|
37
|
+
|
|
38
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
39
|
+
|
|
40
|
+
### HTTP request headers
|
|
41
|
+
|
|
42
|
+
- **Content-Type**: Not defined
|
|
43
|
+
- **Accept**: staff
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### HTTP response details
|
|
47
|
+
| Status code | Description | Response headers |
|
|
48
|
+
|-------------|-------------|------------------|
|
|
49
|
+
|**200** | Liste des sports | - |
|
|
50
|
+
|**400** | Bad Request | - |
|
|
51
|
+
|**401** | Unauthorized | - |
|
|
52
|
+
|**500** | Server Error | - |
|
|
53
|
+
|
|
54
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
55
|
+
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
# StaffUserProfileResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**username** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**googleId** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**firstName** | **string** | | [default to undefined]
|
|
11
|
+
**lastName** | **string** | | [default to undefined]
|
|
12
|
+
**email** | **string** | | [default to undefined]
|
|
13
|
+
**gender** | [**Gender**](Gender.md) | | [optional] [default to undefined]
|
|
14
|
+
**location** | [**IUserLocation**](IUserLocation.md) | | [optional] [default to undefined]
|
|
15
|
+
**isAccountVerified** | **boolean** | | [default to undefined]
|
|
16
|
+
**isCreditCardRegistered** | **boolean** | | [optional] [default to undefined]
|
|
17
|
+
**levelBySports** | [**Array<ILevelBySports>**](ILevelBySports.md) | | [optional] [default to undefined]
|
|
18
|
+
**stripeCustomerId** | **string** | | [optional] [default to undefined]
|
|
19
|
+
**phone** | **string** | | [optional] [default to undefined]
|
|
20
|
+
**password** | **string** | | [optional] [default to undefined]
|
|
21
|
+
**profilePicture** | **string** | | [optional] [default to undefined]
|
|
22
|
+
**resetPasswordToken** | **string** | | [optional] [default to undefined]
|
|
23
|
+
**resetPasswordExpires** | **string** | | [optional] [default to undefined]
|
|
24
|
+
**emailVerificationToken** | **string** | | [optional] [default to undefined]
|
|
25
|
+
**emailVerificationExpires** | **string** | | [optional] [default to undefined]
|
|
26
|
+
**organizations** | [**Array<IUserAttributesOrganizationsInner>**](IUserAttributesOrganizationsInner.md) | | [optional] [default to undefined]
|
|
27
|
+
**isAdmin** | **boolean** | | [default to undefined]
|
|
28
|
+
**createdAt** | **string** | | [default to undefined]
|
|
29
|
+
**updatedAt** | **string** | | [default to undefined]
|
|
30
|
+
**isLevelCertified** | **boolean** | | [optional] [default to undefined]
|
|
31
|
+
**paymentMethods** | **Array<string>** | | [optional] [default to undefined]
|
|
32
|
+
**defaultPaymentMethodId** | **string** | | [optional] [default to undefined]
|
|
33
|
+
**paymentMethodSetupCompleted** | **boolean** | | [default to undefined]
|
|
34
|
+
**setupIntentId** | **string** | | [optional] [default to undefined]
|
|
35
|
+
**favoriteClubs** | **Array<string>** | | [optional] [default to undefined]
|
|
36
|
+
**description** | **string** | | [optional] [default to undefined]
|
|
37
|
+
**isProfileVisible** | **boolean** | | [default to undefined]
|
|
38
|
+
**favoritePlayers** | **Array<string>** | | [optional] [default to undefined]
|
|
39
|
+
**sports** | **{ [key: string]: any; }** | Construct a type with a set of properties K of type T | [optional] [default to undefined]
|
|
40
|
+
**isSubscribedToMyClub** | **boolean** | | [optional] [default to undefined]
|
|
41
|
+
**creditOnMyClub** | **number** | | [optional] [default to undefined]
|
|
42
|
+
|
|
43
|
+
## Example
|
|
44
|
+
|
|
45
|
+
```typescript
|
|
46
|
+
import { StaffUserProfileResponse } from '@tennac-booking/sdk';
|
|
47
|
+
|
|
48
|
+
const instance: StaffUserProfileResponse = {
|
|
49
|
+
username,
|
|
50
|
+
googleId,
|
|
51
|
+
firstName,
|
|
52
|
+
lastName,
|
|
53
|
+
email,
|
|
54
|
+
gender,
|
|
55
|
+
location,
|
|
56
|
+
isAccountVerified,
|
|
57
|
+
isCreditCardRegistered,
|
|
58
|
+
levelBySports,
|
|
59
|
+
stripeCustomerId,
|
|
60
|
+
phone,
|
|
61
|
+
password,
|
|
62
|
+
profilePicture,
|
|
63
|
+
resetPasswordToken,
|
|
64
|
+
resetPasswordExpires,
|
|
65
|
+
emailVerificationToken,
|
|
66
|
+
emailVerificationExpires,
|
|
67
|
+
organizations,
|
|
68
|
+
isAdmin,
|
|
69
|
+
createdAt,
|
|
70
|
+
updatedAt,
|
|
71
|
+
isLevelCertified,
|
|
72
|
+
paymentMethods,
|
|
73
|
+
defaultPaymentMethodId,
|
|
74
|
+
paymentMethodSetupCompleted,
|
|
75
|
+
setupIntentId,
|
|
76
|
+
favoriteClubs,
|
|
77
|
+
description,
|
|
78
|
+
isProfileVisible,
|
|
79
|
+
favoritePlayers,
|
|
80
|
+
sports,
|
|
81
|
+
isSubscribedToMyClub,
|
|
82
|
+
creditOnMyClub,
|
|
83
|
+
};
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# StripeStripeDeletedProduct
|
|
2
|
+
|
|
3
|
+
The DeletedProduct object.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Unique identifier for the object. | [default to undefined]
|
|
10
|
+
**object** | **string** | String representing the object\'s type. Objects of the same type share the same value. | [default to undefined]
|
|
11
|
+
**deleted** | **boolean** | Always true for a deleted object | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { StripeStripeDeletedProduct } from '@tennac-booking/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: StripeStripeDeletedProduct = {
|
|
19
|
+
id,
|
|
20
|
+
object,
|
|
21
|
+
deleted,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# StripeStripePrice
|
|
2
|
+
|
|
3
|
+
Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme. For example, you might have a single \"gold\" product that has prices for $10/month, $100/year, and €9 once. Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview).
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Unique identifier for the object. | [default to undefined]
|
|
10
|
+
**object** | **string** | String representing the object\'s type. Objects of the same type share the same value. | [default to undefined]
|
|
11
|
+
**active** | **boolean** | Whether the price can be used for new purchases. | [default to undefined]
|
|
12
|
+
**billing_scheme** | [**StripeStripePriceBillingScheme**](StripeStripePriceBillingScheme.md) | | [default to undefined]
|
|
13
|
+
**created** | **number** | Time at which the object was created. Measured in seconds since the Unix epoch. | [default to undefined]
|
|
14
|
+
**currency** | **string** | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). | [default to undefined]
|
|
15
|
+
**currency_options** | [**{ [key: string]: StripeStripePriceCurrencyOptions; }**](StripeStripePriceCurrencyOptions.md) | Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). | [optional] [default to undefined]
|
|
16
|
+
**custom_unit_amount** | [**StripeStripePriceCustomUnitAmount**](StripeStripePriceCustomUnitAmount.md) | When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. | [default to undefined]
|
|
17
|
+
**deleted** | **any** | Always true for a deleted object | [optional] [default to undefined]
|
|
18
|
+
**livemode** | **boolean** | Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. | [default to undefined]
|
|
19
|
+
**lookup_key** | **string** | A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. | [default to undefined]
|
|
20
|
+
**metadata** | **{ [key: string]: string; }** | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. | [default to undefined]
|
|
21
|
+
**nickname** | **string** | A brief description of the price, hidden from customers. | [default to undefined]
|
|
22
|
+
**product** | [**StripeStripePriceProduct**](StripeStripePriceProduct.md) | | [default to undefined]
|
|
23
|
+
**recurring** | [**StripeStripePriceRecurring**](StripeStripePriceRecurring.md) | The recurring components of a price such as `interval` and `usage_type`. | [default to undefined]
|
|
24
|
+
**tax_behavior** | [**StripeStripePriceTaxBehavior**](StripeStripePriceTaxBehavior.md) | Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. | [default to undefined]
|
|
25
|
+
**tiers** | [**Array<StripeStripePriceTier>**](StripeStripePriceTier.md) | Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. | [optional] [default to undefined]
|
|
26
|
+
**tiers_mode** | [**StripeStripePriceTiersMode**](StripeStripePriceTiersMode.md) | Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows. | [default to undefined]
|
|
27
|
+
**transform_quantity** | [**StripeStripePriceTransformQuantity**](StripeStripePriceTransformQuantity.md) | Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. | [default to undefined]
|
|
28
|
+
**type** | [**StripeStripePriceType**](StripeStripePriceType.md) | | [default to undefined]
|
|
29
|
+
**unit_amount** | **number** | The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. | [default to undefined]
|
|
30
|
+
**unit_amount_decimal** | **string** | The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. | [default to undefined]
|
|
31
|
+
|
|
32
|
+
## Example
|
|
33
|
+
|
|
34
|
+
```typescript
|
|
35
|
+
import { StripeStripePrice } from '@tennac-booking/sdk';
|
|
36
|
+
|
|
37
|
+
const instance: StripeStripePrice = {
|
|
38
|
+
id,
|
|
39
|
+
object,
|
|
40
|
+
active,
|
|
41
|
+
billing_scheme,
|
|
42
|
+
created,
|
|
43
|
+
currency,
|
|
44
|
+
currency_options,
|
|
45
|
+
custom_unit_amount,
|
|
46
|
+
deleted,
|
|
47
|
+
livemode,
|
|
48
|
+
lookup_key,
|
|
49
|
+
metadata,
|
|
50
|
+
nickname,
|
|
51
|
+
product,
|
|
52
|
+
recurring,
|
|
53
|
+
tax_behavior,
|
|
54
|
+
tiers,
|
|
55
|
+
tiers_mode,
|
|
56
|
+
transform_quantity,
|
|
57
|
+
type,
|
|
58
|
+
unit_amount,
|
|
59
|
+
unit_amount_decimal,
|
|
60
|
+
};
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# StripeStripePriceBillingScheme
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `PerUnit` (value: `'per_unit'`)
|
|
7
|
+
|
|
8
|
+
* `Tiered` (value: `'tiered'`)
|
|
9
|
+
|
|
10
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# StripeStripePriceCurrencyOptions
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**custom_unit_amount** | [**StripeStripePriceCurrencyOptionsCustomUnitAmount**](StripeStripePriceCurrencyOptionsCustomUnitAmount.md) | When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. | [default to undefined]
|
|
9
|
+
**tax_behavior** | [**StripeStripePriceCurrencyOptionsTaxBehavior**](StripeStripePriceCurrencyOptionsTaxBehavior.md) | Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. | [default to undefined]
|
|
10
|
+
**tiers** | [**Array<StripeStripePriceCurrencyOptionsTier>**](StripeStripePriceCurrencyOptionsTier.md) | Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. | [optional] [default to undefined]
|
|
11
|
+
**unit_amount** | **number** | The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. | [default to undefined]
|
|
12
|
+
**unit_amount_decimal** | **string** | The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { StripeStripePriceCurrencyOptions } from '@tennac-booking/sdk';
|
|
18
|
+
|
|
19
|
+
const instance: StripeStripePriceCurrencyOptions = {
|
|
20
|
+
custom_unit_amount,
|
|
21
|
+
tax_behavior,
|
|
22
|
+
tiers,
|
|
23
|
+
unit_amount,
|
|
24
|
+
unit_amount_decimal,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# StripeStripePriceCurrencyOptionsCustomUnitAmount
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**maximum** | **number** | The maximum unit amount the customer can specify for this item. | [default to undefined]
|
|
9
|
+
**minimum** | **number** | The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount. | [default to undefined]
|
|
10
|
+
**preset** | **number** | The starting unit amount which can be updated by the customer. | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { StripeStripePriceCurrencyOptionsCustomUnitAmount } from '@tennac-booking/sdk';
|
|
16
|
+
|
|
17
|
+
const instance: StripeStripePriceCurrencyOptionsCustomUnitAmount = {
|
|
18
|
+
maximum,
|
|
19
|
+
minimum,
|
|
20
|
+
preset,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# StripeStripePriceCurrencyOptionsTaxBehavior
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Exclusive` (value: `'exclusive'`)
|
|
7
|
+
|
|
8
|
+
* `Inclusive` (value: `'inclusive'`)
|
|
9
|
+
|
|
10
|
+
* `Unspecified` (value: `'unspecified'`)
|
|
11
|
+
|
|
12
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# StripeStripePriceCurrencyOptionsTier
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**flat_amount** | **number** | Price for the entire tier. | [default to undefined]
|
|
9
|
+
**flat_amount_decimal** | **string** | Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. | [default to undefined]
|
|
10
|
+
**unit_amount** | **number** | Per unit price for units relevant to the tier. | [default to undefined]
|
|
11
|
+
**unit_amount_decimal** | **string** | Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. | [default to undefined]
|
|
12
|
+
**up_to** | **number** | Up to and including to this quantity will be contained in the tier. | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { StripeStripePriceCurrencyOptionsTier } from '@tennac-booking/sdk';
|
|
18
|
+
|
|
19
|
+
const instance: StripeStripePriceCurrencyOptionsTier = {
|
|
20
|
+
flat_amount,
|
|
21
|
+
flat_amount_decimal,
|
|
22
|
+
unit_amount,
|
|
23
|
+
unit_amount_decimal,
|
|
24
|
+
up_to,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# StripeStripePriceCustomUnitAmount
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**maximum** | **number** | The maximum unit amount the customer can specify for this item. | [default to undefined]
|
|
9
|
+
**minimum** | **number** | The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount. | [default to undefined]
|
|
10
|
+
**preset** | **number** | The starting unit amount which can be updated by the customer. | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { StripeStripePriceCustomUnitAmount } from '@tennac-booking/sdk';
|
|
16
|
+
|
|
17
|
+
const instance: StripeStripePriceCustomUnitAmount = {
|
|
18
|
+
maximum,
|
|
19
|
+
minimum,
|
|
20
|
+
preset,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# StripeStripePriceProduct
|
|
2
|
+
|
|
3
|
+
The ID of the product this price is associated with.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Unique identifier for the object. | [default to undefined]
|
|
10
|
+
**object** | **string** | String representing the object\'s type. Objects of the same type share the same value. | [default to undefined]
|
|
11
|
+
**active** | **boolean** | Whether the product is currently available for purchase. | [default to undefined]
|
|
12
|
+
**created** | **number** | Time at which the object was created. Measured in seconds since the Unix epoch. | [default to undefined]
|
|
13
|
+
**default_price** | [**StripeStripeProductDefaultPrice**](StripeStripeProductDefaultPrice.md) | | [optional] [default to undefined]
|
|
14
|
+
**deleted** | **boolean** | Always true for a deleted object | [default to undefined]
|
|
15
|
+
**description** | **string** | The product\'s description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. | [default to undefined]
|
|
16
|
+
**images** | **Array<string>** | A list of up to 8 URLs of images for this product, meant to be displayable to the customer. | [default to undefined]
|
|
17
|
+
**livemode** | **boolean** | Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. | [default to undefined]
|
|
18
|
+
**marketing_features** | [**Array<StripeStripeProductMarketingFeature>**](StripeStripeProductMarketingFeature.md) | A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table). | [default to undefined]
|
|
19
|
+
**metadata** | **{ [key: string]: string; }** | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. | [default to undefined]
|
|
20
|
+
**name** | **string** | The product\'s name, meant to be displayable to the customer. | [default to undefined]
|
|
21
|
+
**package_dimensions** | [**StripeStripeProductPackageDimensions**](StripeStripeProductPackageDimensions.md) | The dimensions of this product for shipping purposes. | [default to undefined]
|
|
22
|
+
**shippable** | **boolean** | Whether this product is shipped (i.e., physical goods). | [default to undefined]
|
|
23
|
+
**statement_descriptor** | **string** | Extra information about a product which will appear on your customer\'s credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments. | [optional] [default to undefined]
|
|
24
|
+
**tax_code** | [**StripeStripeProductTaxCode**](StripeStripeProductTaxCode.md) | | [default to undefined]
|
|
25
|
+
**type** | [**StripeStripeProductType**](StripeStripeProductType.md) | | [default to undefined]
|
|
26
|
+
**unit_label** | **string** | A label that represents units of this product. When set, this will be included in customers\' receipts, invoices, Checkout, and the customer portal. | [optional] [default to undefined]
|
|
27
|
+
**updated** | **number** | Time at which the object was last updated. Measured in seconds since the Unix epoch. | [default to undefined]
|
|
28
|
+
**url** | **string** | A URL of a publicly-accessible webpage for this product. | [default to undefined]
|
|
29
|
+
|
|
30
|
+
## Example
|
|
31
|
+
|
|
32
|
+
```typescript
|
|
33
|
+
import { StripeStripePriceProduct } from '@tennac-booking/sdk';
|
|
34
|
+
|
|
35
|
+
const instance: StripeStripePriceProduct = {
|
|
36
|
+
id,
|
|
37
|
+
object,
|
|
38
|
+
active,
|
|
39
|
+
created,
|
|
40
|
+
default_price,
|
|
41
|
+
deleted,
|
|
42
|
+
description,
|
|
43
|
+
images,
|
|
44
|
+
livemode,
|
|
45
|
+
marketing_features,
|
|
46
|
+
metadata,
|
|
47
|
+
name,
|
|
48
|
+
package_dimensions,
|
|
49
|
+
shippable,
|
|
50
|
+
statement_descriptor,
|
|
51
|
+
tax_code,
|
|
52
|
+
type,
|
|
53
|
+
unit_label,
|
|
54
|
+
updated,
|
|
55
|
+
url,
|
|
56
|
+
};
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# StripeStripePriceRecurring
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**interval** | [**StripeStripePriceRecurringInterval**](StripeStripePriceRecurringInterval.md) | | [default to undefined]
|
|
9
|
+
**interval_count** | **number** | The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. | [default to undefined]
|
|
10
|
+
**meter** | **string** | The meter tracking the usage of a metered price | [default to undefined]
|
|
11
|
+
**trial_period_days** | **number** | Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). | [default to undefined]
|
|
12
|
+
**usage_type** | [**StripeStripePriceRecurringUsageType**](StripeStripePriceRecurringUsageType.md) | | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { StripeStripePriceRecurring } from '@tennac-booking/sdk';
|
|
18
|
+
|
|
19
|
+
const instance: StripeStripePriceRecurring = {
|
|
20
|
+
interval,
|
|
21
|
+
interval_count,
|
|
22
|
+
meter,
|
|
23
|
+
trial_period_days,
|
|
24
|
+
usage_type,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# StripeStripePriceRecurringInterval
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Day` (value: `'day'`)
|
|
7
|
+
|
|
8
|
+
* `Month` (value: `'month'`)
|
|
9
|
+
|
|
10
|
+
* `Week` (value: `'week'`)
|
|
11
|
+
|
|
12
|
+
* `Year` (value: `'year'`)
|
|
13
|
+
|
|
14
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# StripeStripePriceRecurringUsageType
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Licensed` (value: `'licensed'`)
|
|
7
|
+
|
|
8
|
+
* `Metered` (value: `'metered'`)
|
|
9
|
+
|
|
10
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|