tf-checkout-react-native 1.0.26 → 1.0.28

package/README.md

@@ -142,7 +142,7 @@ const YourComponent: FC () => {
 
 ````ts
 {
-  EVENT_ID: string,
+  EVENT_ID?: string | number,
   CLIENT?: string,
   ENV?: 'PROD' | 'DEV' | 'STAG',
   CLIENT_ID?: string,
@@ -594,7 +594,6 @@ const sessionHandleRef = useRef<SessionHandleType>(null)
 
 <Tickets 
   ref={sessionHandleRef}
-  eventId={EVENT_ID} 
   onAddToCartSuccess={handleOnAddToCartSuccess} />
 ```
 
@@ -908,7 +907,11 @@ const sessionHandleRef = useRef<SessionHandleType>(null)
 
     // fetchCountries
   onFetchCountriesError?: (error: IError) => void
-  onFetchCountriesSuccess?: () => void
+  onFetchCountriesSuccess?: (data: {
+    code: string
+    id: string
+    name: string
+  }[]) => void
 
   // fetchState
   onFetchStatesError?: (error: IError) => void
@@ -1120,7 +1123,6 @@ const sessionHandleRef = useRef<SessionHandleType>(null)
 
 <Checkout
   ref={sessionHandleRef}
-  eventId={EVENT_ID}
   hash={hash}
   total={total}
   onPaymentSuccess={handleOnPaymentSuccess}
@@ -1136,7 +1138,6 @@ const sessionHandleRef = useRef<SessionHandleType>(null)
 ```js
 {
   ref?: SessionHandleType
-  eventId: number
   hash: string
   total: string
 
@@ -1190,7 +1191,6 @@ const sessionHandleRef = useRef<SessionHandleType>(null)
 ```
 | Property | Description |
 |----------|-------------|
-| eventId | Same as used in the `Tickets` component. |
 | hash | retrieved from the `onCheckoutSuccess` callback in the `BillingInfo`component. |
 | total | retrieved from the `onCheckoutSuccess` callback in the `BillingInfo` component. |
 | onPaymentSuccess | will handle the success in the payment process. Will return the `hash`. |
@@ -1201,7 +1201,7 @@ const sessionHandleRef = useRef<SessionHandleType>(null)
 
 ### styles
 
-```js
+```ts
 {
   rootStyle?: ViewStyle
   title?: StyleProp<TextStyle>
@@ -1252,7 +1252,7 @@ import { PurchaseConfirmation, SessionHandleType } from 'tf-checkout-react-nativ
 
 Add it to the render function.
 
-```js
+```ts
 const sessionHandleRef = useRef<SessionHandleType>(null)
 
 <PurchaseConfirmation
@@ -1308,67 +1308,231 @@ import { MyOrders, SessionHandleType } from 'tf-checkout-react-native'
 
 ### Props
 
-```tsx
+```ts
 {
   ref={SessionHandleType}
   onSelectOrder: (order: {
     order: {
-    header: {
-      isReferralDisabled: boolean
-      shareLink: string
-      total: string
-      salesReferred: string
-    },
-    items: [
-      {
-        name: string
+      header: {
         currency: string
-        price: string
-        discount: string
-        quantity: string
+        date: string
+        eventEndDate: string
+        eventId: string
+        eventName: string
+        eventSalesEndDate: string
+        eventSalesStartDate: string
+        eventStartDate: string
+        eventUrl: string
+        hideVenueUntil: string | null
+        id: string
+        image: string
+        isReferralDisabled: boolean
+        isVenueHidden: boolean
+        salesReferred: string
+        shareLink: string
+        timeZone: string
         total: string
+        venue: {
+          city: string
+          country: string
+          googlePlaceId?: string
+          latitude?: string
+          longitude?: string
+          name?: string
+          postalCode?: string
+          state: string
+          street?: string
+          streetNumber?: string
+        }
       },
-      {...}
-    ],
-    tickets: [
-      {
-        hash: string
-        ticketType: string
-        holderName?: string
-        holderEmail?: string
-        holderPhone?: string
-        status: string
-        pdfLink?: string
-        qrData?: string
-        isSellable?: boolean
-        description?: string
-        descriptionPlain?: string
-      },
-      {...}
-    ]
-  }
+      items: [
+        {
+          name: string
+          currency: string
+          price: string
+          discount: string
+          quantity: string
+          total: string
+        },
+        {...}
+      ],
+      tickets: [
+        {
+          hash: string
+          ticketType: string
+          holderName?: string
+          holderEmail?: string
+          holderPhone?: string
+          status: string
+          pdfLink?: string
+          qrData?: string
+          isSellable?: boolean
+          description?: string
+          descriptionPlain?: string
+        },
+        {...}
+      ]
+    }
   }) => void
 
-  onFetchMyOrdersSuccess?: () => void
+  onFetchMyOrdersSuccess?: (data: IMyOrdersData) => void
   onFetchMyOrdersError?: (error: IError) => void
 
-  onFetchOrderDetailsSuccess?: () => void
+  onFetchOrderDetailsSuccess?: (data: IMyOrderDetailsData) => void
   onFetchOrderDetailsError?: (error: IError) => void
 
   onLoadingChange?: (isLoading: boolean) => void
 
-  styles?: IMyOrdersStyles
+  styles?: {
+    orderListItem?: IOrderListItemStyles
+    safeArea?: StyleProp<ViewStyle>
+    listContainer?: StyleProp<ViewStyle>
+    eventsContainer?: StyleProp<ViewStyle>
+    eventsTitle?: StyleProp<TextStyle>
+    refreshControlColor?: ColorValue
+    eventsDropdown?: IDropdownStyles
+    rootContainer?: StyleProp<ViewStyle>
+    eventsSelectionContainer?: StyleProp<ViewStyle>
+    clearEventSelectionIcon?: StyleProp<ImageStyle>
+    timeFilters?: {
+      container?: StyleProp<ViewStyle>
+      dropdown?: IDropdownStyles
+      selectionContainer?: StyleProp<ViewStyle>
+      clearSelectionIcon?: StyleProp<ImageStyle>
+    }
+  }
   config?: {
     isEventsDropdownHidden?: boolean
     areActivityIndicatorsEnabled?: boolean
     areAlertsEnabled?: boolean
+    isTimeFilterDropdownHidden?: boolean
   }
   texts?: {
     selectEventPlaceholder?: string
+    selectTimeFilterPlaceholder?: string
     title?: string
+    timeFilters?: {
+      upcoming?: string
+      ongoingAndUpcoming?: string
+      ongoing?: string
+      past?: string
+    }
   }
 }
 ```
+IMyOrdersData
+```ts
+{
+  events: {
+    event_name: string
+    url_name: string
+  }[]
+  orders: {
+    amount: string
+    currency: string
+    date: string
+    eventEndDate: string
+    eventId: string
+    eventName: string
+    eventSalesEndDate: string
+    eventSalesStartDate: string | null
+    eventStartDate: string
+    eventUrl: string
+    hideVenue: boolean
+    hideVenueUntil: string | null
+    id: string
+    image: string
+    timezone: string
+    venueCity: string
+    venueCountry: string
+    venueGooglePlaceId?: string
+    venueLatitude?: string
+    venueLongitude?: string
+    venueName?: string
+    venuePostalCode?: string
+    venueState: string
+    venueStreet?: string
+    venueStreetNumber?: string
+  }[]
+  //Those mark with ? are only included if the venue is not hidden
+  filter?: string
+  brandFilter?: string
+  subBrands?: boolean
+  pagination: {
+    page: number
+    limit: number
+    totalCount: number
+    totalPages: number
+  }
+}
+```
+IMyOrderDetailsData
+```ts
+{
+  header: {
+    currency: string
+    date: string
+    eventEndDate: string
+    eventId: string
+    eventName: string
+    eventSalesEndDate: string
+    eventSalesStartDate: string
+    eventStartDate: string
+    eventUrl: string
+    hideVenueUntil: string | null
+    id: string
+    image: string
+    isReferralDisabled: boolean
+    isVenueHidden: boolean
+    salesReferred: string
+    shareLink: string
+    timeZone: string
+    total: string
+    venue: {
+      city: string
+      country: string
+      googlePlaceId?: string
+      latitude?: string
+      longitude?: string
+      name?: string
+      postalCode?: string
+      state: string
+      street?: string
+      streetNumber?: string
+    }
+    //Those mark with ? are only included if the venue is not hidden
+  }
+  items?: {
+    currency: string
+    discount: string
+    hash: string
+    isActive: boolean
+    name: string
+    price: string
+    quantity: string
+    total: string
+  }[]
+  tickets: {
+    currency: string
+    description: string
+    descriptionPlain?: string
+    eventName: string
+    hash: string
+    holderEmail?: string
+    holderName: string
+    holderPhone?: string
+    isOnSale: boolean
+    isSellable: boolean
+    isTable: boolean
+    pdfLink: string
+    qrData: string
+    resaleFeeAmount: number
+    status: string
+    ticketType: string
+    ticketTypeHash: string
+  }[]
+}
+```
 
 ### styles
 ```js
@@ -1854,6 +2018,8 @@ Exposes the following functions:
 
 `refreshAccessToken` : Refreshes expired access token.
 
+`getAccountTickets`: Fetches the tickets purchased for the user that logged in.
+
 ```js
 {
   // Fetches the tickets from the event set in the config function. It receives a promoCode parameter to apply to the tickets.
@@ -1919,68 +2085,84 @@ Exposes the following functions:
       extraData?: any
     }
     eventData?: {
-      passwordProtected: boolean
-      passwordAuthenticated: boolean
-      name: string
-      description?: string
-      slug: string
-      redirectUrl?: string
-      facebookEvent?: string
-      title: string
-      relatedProducts: []
+      affirmAllowed: boolean
+      alwaysShowWaitingList?: any
+      backgroundImage: string
+      backgroundVideo?: string
+      brandCheckoutPixels?: string
+      brandConversionPixels?: string
+      brandGoogleAnalyticsKey?: string
+      brandPagePixels?: string
+      checkoutPixels?: string
+      conversionPixels?: string
       country: string
+      currency: {
+        currency: string
+        decimal_places: number
+        symbol: string
+      }
       date: string
-      startDate: string
+      description?: string
+      descriptions: any
+      enableWaitingList: boolean
       endDate: string
-      timezone: string
+      eventType: any
+      facebookEvent?: string
+      faq: []
+      feeMode: string
+      feesIncluded?: any
       formattedDate: string
-      venueCountry: string
-      venueCity?: string
-      venueState?: string
-      hideVenueUntil?: string
+      fullTitleReplacement?: any
+      hideTopInfluencers: boolean
       hideVenue?: boolean
-      venueName?: string
-      venueGooglePlaceId?: string
-      venueLatitude?: string
-      venueLongitude?: string
-      venuePostalCode?: string
-      venueStreet?: string
-      venueStreetNumber?: string
-      eventType: any
-      productImage: string
+      hideVenueUntil?: string
       imageUrl: string
       imageUrlHd: string
-      backgroundImage: string
-      backgroundVideo?: string
-      twitterImage?: string
+      imageURLs: any
+      isTimeSlotEvent: boolean
+      l10nLanguages: []
+      minimumAge?: any
+      name: string
       ogImage?: string
-      tags: []
+      pagePixels?: string
+      passwordAuthenticated: boolean
+      passwordProtected: boolean
       preregEnabled: boolean
-      presalesStarted: boolean
+      preregistered: []
       presalesEnded: boolean
-      salesStart?: string
+      presalesStarted: boolean
+      productImage: string
+      redirectUrl?: string
+      referrals: []
+      referralsEnabled: boolean
+      relatedProducts: []
       salesEnd: string
-      salesStarted: boolean
       salesEnded: boolean
-      feeMode: string
-      feesIncluded?: any
-      minimumAge?: any
-      enableWaitingList: boolean
-      alwaysShowWaitingList?: any
-      titleReplacementImage?: any
+      salesStart?: string
+      salesStarted: boolean
+      slug: string
+      startDate: string
+      subHeading?: any
+      tableMapEnabled: boolean
+      tags: []
+      ticketsSold: number
+      timezone: string
+      title: string
       titleReplacementHeight?: any
+      titleReplacementImage?: any
       titleReplacementImageSvg?: any
-      fullTitleReplacement?: any
-      affirmAllowed: boolean
-      subHeading?: any
-      isTimeSlotEvent: boolean
-      preregistered: []
-      referralsEnabled: boolean
-      referrals: []
-      faq: []
-      l10nLanguages: []
-      imageURLs: any
-      descriptions: any
+      twitterImage?: string
+      venueCity?: string
+      venueCountry: string
+      venueGooglePlaceId?: string
+      venueLatitude?: string
+      venueLongitude?: string
+      venueName?: string
+      venuePostalCode?: string
+      venueState?: string
+      venueStreet?: string
+      venueStreetNumber?: string
+      waitingListMaxQuantity: number
     }
   }>
 
@@ -2019,10 +2201,90 @@ Exposes the following functions:
       status: number
     }>
     refreshAccessToken(refreshToken?: string): Promise<IFetchAccessTokenResponse>
+
+    getAccountTickets({
+      page: number
+      limit?: number
+      filter?: string
+      from?: MyOrderRequestFromType
+    }): Promise<
+      data?: {
+        attributes: {
+          page: number
+          limit: number
+          total_count: number
+          total_pages: number
+          filter?: any
+          brand_filter: string
+          sub_brands: boolean
+          purchased_events: {
+            url_name: string
+            event_name: string
+          }[]
+          tickets: {
+            id: string
+            orderId: string
+            hash: string
+            qrData: string
+            ticketType: string
+            ticketTypeHash: string
+            description?: any
+            descriptionPlain?: any
+            currency: string
+            price: string
+            retainAmountOnSale: number
+            status: string
+            holderName: string
+            holderEmail?: any
+            holderPhone?: any
+            isTable: boolean
+            isSellable: boolean
+            isOnSale: boolean
+            createdAt: Date
+            pdfLink: string
+            eventId: string
+            eventName: string
+            eventUrl: string
+            eventTimezone: string
+            eventStartDate: Date
+            eventEndDate: Date
+            eventSalesStartDate?: any
+            eventSalesEndDate: Date
+            eventImage: string
+            eventBackgroundImage: string
+            eventIsOnlineEvent: boolean
+            venueCountry: string
+            venueCity: string
+            venueState: string
+            hideVenueUntil?: any
+            hideVenue: boolean
+            venueName?: string //Optional
+            venueGooglePlaceId?: string //Optional
+            venueLatitude?: string //Optional
+            venueLongitude?: string //Optional
+            venuePostalCode?: string //Optional
+            venueStreet?: string //Optional
+            venueStreetNumber?: string //Optional
+          }[]
+        }
+        relationships: any[]
+        type: string
+      },  
+      error?: IError>
   }>
 }
 ```
 
+## MyOrderRequestFromType
+```
+MyOrderRequestFromType =
+  | 'upcoming_events'
+  | 'ongoing_and_upcoming_events'
+  | 'ongoing_events'
+  | 'past_events'
+  | ''
+```
+
 Import the component from the library
 
 ```js
@@ -2198,9 +2460,11 @@ Exposes the following functions:
        message: string
        extraData?: any
      }
-    countriesData?: {
-      [key: number | string]: string
-    }
+    countriesData?:  {
+      code: string
+      id: string
+      name: string
+    }[]
   }>
 
   // Fetches the states list.
@@ -2292,8 +2556,8 @@ Exposes the following functions:
 
 
 ```ts
-// Get event conditions for the current event.
-getEventConditions(eventId: string): Promise<any>
+// Get event conditions for the Event Id set on the setConfig.
+getEventConditions(): Promise<any>
 
 // Get purchase order details for the current event.
 getPurchaseOrderDetails(orderId: string): Promise<{
@@ -2457,6 +2721,7 @@ Exposes the following functions:
 
 `refreshAccessToken` Refreshes access token.
 
+`getAccountTickets`: Fetches the tickets purchased for the user that logged in.
 
 ```ts
 refreshAccessToken(refreshToken?: string): Promise<IFetchAccessTokenResponse>
@@ -2477,6 +2742,15 @@ getMyOrders(page: number, filter: string): Promise<{
       eventUrl: string
       image: string
     }[]
+    filter?: string
+    brandFilter?: string
+    subBrands?: boolean
+    pagination: {
+      page: number
+      limit: number
+      totalCount: number
+      totalPages: number
+    }
   }
 
   myOrdersError?: {
@@ -2484,6 +2758,76 @@ getMyOrders(page: number, filter: string): Promise<{
     message: string
     extraData?: any
   }
+
+  getAccountTickets({
+      page: number
+      limit?: number
+      filter?: string
+      from?: MyOrderRequestFromType
+    }): Promise<
+      data?: {
+        attributes: {
+          page: number
+          limit: number
+          total_count: number
+          total_pages: number
+          filter?: any
+          brand_filter: string
+          sub_brands: boolean
+          purchased_events: {
+            url_name: string
+            event_name: string
+          }[]
+          tickets: {
+            id: string
+            orderId: string
+            hash: string
+            qrData: string
+            ticketType: string
+            ticketTypeHash: string
+            description?: any
+            descriptionPlain?: any
+            currency: string
+            price: string
+            retainAmountOnSale: number
+            status: string
+            holderName: string
+            holderEmail?: any
+            holderPhone?: any
+            isTable: boolean
+            isSellable: boolean
+            isOnSale: boolean
+            createdAt: Date
+            pdfLink: string
+            eventId: string
+            eventName: string
+            eventUrl: string
+            eventTimezone: string
+            eventStartDate: Date
+            eventEndDate: Date
+            eventSalesStartDate?: any
+            eventSalesEndDate: Date
+            eventImage: string
+            eventBackgroundImage: string
+            eventIsOnlineEvent: boolean
+            venueCountry: string
+            venueCity: string
+            venueState: string
+            hideVenueUntil?: any
+            hideVenue: boolean
+            venueName?: string //Optional
+            venueGooglePlaceId?: string //Optional
+            venueLatitude?: string //Optional
+            venueLongitude?: string //Optional
+            venuePostalCode?: string //Optional
+            venueStreet?: string //Optional
+            venueStreetNumber?: string //Optional
+          }[]
+        }
+        relationships: any[]
+        type: string
+      },  
+      error?: IError>
 }>
 
 
@@ -2529,6 +2873,17 @@ getOrderDetails(orderId: string): Promise<{
   }
 }>
 ```
+
+## MyOrderRequestFromType
+```
+MyOrderRequestFromType =
+  | 'upcoming_events'
+  | 'ongoing_and_upcoming_events'
+  | 'ongoing_events'
+  | 'past_events'
+  | ''
+```
+
 ---
 ## OrderDetailsCore
 Allows to re-sale the tickets or to remove them from the re-sale system.
@@ -2693,6 +3048,27 @@ Wrap your component with the Core component.
 
 # Changelog
 
+## Version 1.0.28
+- Add `getAccountTickets` request in `MyOrdersCore` and `TicketsCore`, it will allow get Tickets from the logged-in user.
+- Add filter to `getMyOrders` request in `MyOrdersCore` component, to filter by time frame by passing the following string:
+
+```ts
+'upcoming_events' | 'ongoing_and_upcoming_events' | 'ongoing_events' | 'past_events'
+```
+
+- Add more data to the `getMyOrders` success response.
+- Add more data to the `getOrderDetails` success response.
+- Add `ticketsSold` prop to Event's object in fetchEvent success data.
+
+## Version 1.0.27
+- Make `EVENT_ID` optional in the `setConfig` function. An error will be returned when `EVENT_ID` is not set and trying to make a request that requires it.
+
+- Remove `eventId` prop from `Checkout UI` component in favor of use the one on the Config.
+
+- Add missing pagination data in `onFetchMyOrdersSuccess` response.
+
+- Add missing success data in `onFetchOrderDetailsSuccess` response.
+
 ## Version 1.0.26
 - Add the possibility to remove all of the following Billing/Street Address fields from free tickets:
   - Billing Street Address
@@ -2703,7 +3079,7 @@ Wrap your component with the Core component.
 
 - Update `addToCart` success response to include: 
 ```  
- isTicketFree?: boolean
+isTicketFree?: boolean
 isPhoneHidden?: boolean
   ```