Liking cljdoc? Tell your friends :D

happygapi.walletobjects.giftcardobject

Google Wallet API: giftcardobject. API for issuers to save and manage Google Wallet Objects. See: https://developers.google.com/pay/passesapi/reference/rest/v1/giftcardobject

Google Wallet API: giftcardobject.
API for issuers to save and manage Google Wallet Objects.
See: https://developers.google.com/pay/passesapi/reference/rest/v1/giftcardobject
raw docstring

addmessage$clj

(addmessage$ auth parameters body)

https://developers.google.com/pay/passesapi/reference/rest/v1/giftcardobject/addmessage

Required parameters: resourceId

Optional parameters: none

Body:

{:message {:body string, :messageType string, :header string, :id string, :kind string, :displayInterval TimeInterval, :localizedHeader LocalizedString, :localizedBody LocalizedString}}

Adds a message to the gift card object referenced by the given object ID.

https://developers.google.com/pay/passesapi/reference/rest/v1/giftcardobject/addmessage

Required parameters: resourceId

Optional parameters: none

Body: 

{:message {:body string,
           :messageType string,
           :header string,
           :id string,
           :kind string,
           :displayInterval TimeInterval,
           :localizedHeader LocalizedString,
           :localizedBody LocalizedString}}

Adds a message to the gift card object referenced by the given object ID.
sourceraw docstring

get$clj

(get$ auth parameters)

https://developers.google.com/pay/passesapi/reference/rest/v1/giftcardobject/get

Required parameters: resourceId

Optional parameters: none

Returns the gift card object with the given object ID.

https://developers.google.com/pay/passesapi/reference/rest/v1/giftcardobject/get

Required parameters: resourceId

Optional parameters: none

Returns the gift card object with the given object ID.
sourceraw docstring

insert$clj

(insert$ auth parameters body)

https://developers.google.com/pay/passesapi/reference/rest/v1/giftcardobject/insert

Required parameters: none

Optional parameters: none

Body:

{:cardNumber string, :hasUsers boolean, :smartTapRedemptionValue string, :rotatingBarcode {:totpDetails RotatingBarcodeTotpDetails, :initialRotatingBarcodeValues RotatingBarcodeValues, :showCodeText LocalizedString, :type string, :valuePattern string, :alternateText string, :renderEncoding string}, :textModulesData [{:id string, :localizedBody LocalizedString, :localizedHeader LocalizedString, :body string, :header string}], :barcode {:alternateText string, :showCodeText LocalizedString, :type string, :renderEncoding string, :value string, :kind string}, :hasLinkedDevice boolean, :groupingInfo {:groupingId string, :sortIndex integer}, :state string, :classReference {:wordMark Image, :reviewStatus string, :wideProgramLogo Image, :textModulesData [TextModuleData], :issuerName string, :securityAnimation SecurityAnimation, :multipleDevicesAndHoldersAllowedStatus string, :localizedEventNumberLabel LocalizedString, :pinLabel string, :merchantName string, :localizedMerchantName LocalizedString, :homepageUri Uri, :callbackOptions CallbackOptions, :linksModuleData LinksModuleData, :imageModulesData [ImageModuleData], :locations [LatLongPoint], :allowMultipleUsersPerObject boolean, :hexBackgroundColor string, :messages [Message], :localizedIssuerName LocalizedString, :redemptionIssuers [string], :review Review, :programLogo Image, :id string, :kind string, :localizedPinLabel LocalizedString, :classTemplateInfo ClassTemplateInfo, :enableSmartTap boolean, :cardNumberLabel string, :version string, :viewUnlockRequirement string, :infoModuleData InfoModuleData, :heroImage Image, :allowBarcodeRedemption boolean, :eventNumberLabel string, :countryCode string, :localizedCardNumberLabel LocalizedString}, :disableExpirationNotification boolean, :pin string, :eventNumber string, :linksModuleData {:uris [Uri]}, :imageModulesData [{:mainImage Image, :id string}], :validTimeInterval {:start DateTime, :kind string, :end DateTime}, :locations [{:latitude number, :kind string, :longitude number}], :balance {:kind string, :currencyCode string, :micros string}, :messages [{:body string, :messageType string, :header string, :id string, :kind string, :displayInterval TimeInterval, :localizedHeader LocalizedString, :localizedBody LocalizedString}], :id string, :kind string, :classId string, :passConstraints {:nfcConstraint [string], :screenshotEligibility string}, :appLinkData {:iosAppLinkInfo AppLinkDataAppLinkInfo, :webAppLinkInfo AppLinkDataAppLinkInfo, :androidAppLinkInfo AppLinkDataAppLinkInfo}, :version string, :infoModuleData {:labelValueRows [LabelValueRow], :showLastUpdateTime boolean}, :balanceUpdateTime {:date string}, :heroImage {:contentDescription LocalizedString, :kind string, :sourceUri ImageUri}}

Inserts an gift card object with the given ID and properties.

https://developers.google.com/pay/passesapi/reference/rest/v1/giftcardobject/insert

Required parameters: none

Optional parameters: none

Body: 

{:cardNumber string,
 :hasUsers boolean,
 :smartTapRedemptionValue string,
 :rotatingBarcode {:totpDetails RotatingBarcodeTotpDetails,
                   :initialRotatingBarcodeValues RotatingBarcodeValues,
                   :showCodeText LocalizedString,
                   :type string,
                   :valuePattern string,
                   :alternateText string,
                   :renderEncoding string},
 :textModulesData [{:id string,
                    :localizedBody LocalizedString,
                    :localizedHeader LocalizedString,
                    :body string,
                    :header string}],
 :barcode {:alternateText string,
           :showCodeText LocalizedString,
           :type string,
           :renderEncoding string,
           :value string,
           :kind string},
 :hasLinkedDevice boolean,
 :groupingInfo {:groupingId string, :sortIndex integer},
 :state string,
 :classReference {:wordMark Image,
                  :reviewStatus string,
                  :wideProgramLogo Image,
                  :textModulesData [TextModuleData],
                  :issuerName string,
                  :securityAnimation SecurityAnimation,
                  :multipleDevicesAndHoldersAllowedStatus string,
                  :localizedEventNumberLabel LocalizedString,
                  :pinLabel string,
                  :merchantName string,
                  :localizedMerchantName LocalizedString,
                  :homepageUri Uri,
                  :callbackOptions CallbackOptions,
                  :linksModuleData LinksModuleData,
                  :imageModulesData [ImageModuleData],
                  :locations [LatLongPoint],
                  :allowMultipleUsersPerObject boolean,
                  :hexBackgroundColor string,
                  :messages [Message],
                  :localizedIssuerName LocalizedString,
                  :redemptionIssuers [string],
                  :review Review,
                  :programLogo Image,
                  :id string,
                  :kind string,
                  :localizedPinLabel LocalizedString,
                  :classTemplateInfo ClassTemplateInfo,
                  :enableSmartTap boolean,
                  :cardNumberLabel string,
                  :version string,
                  :viewUnlockRequirement string,
                  :infoModuleData InfoModuleData,
                  :heroImage Image,
                  :allowBarcodeRedemption boolean,
                  :eventNumberLabel string,
                  :countryCode string,
                  :localizedCardNumberLabel LocalizedString},
 :disableExpirationNotification boolean,
 :pin string,
 :eventNumber string,
 :linksModuleData {:uris [Uri]},
 :imageModulesData [{:mainImage Image, :id string}],
 :validTimeInterval {:start DateTime, :kind string, :end DateTime},
 :locations [{:latitude number, :kind string, :longitude number}],
 :balance {:kind string, :currencyCode string, :micros string},
 :messages [{:body string,
             :messageType string,
             :header string,
             :id string,
             :kind string,
             :displayInterval TimeInterval,
             :localizedHeader LocalizedString,
             :localizedBody LocalizedString}],
 :id string,
 :kind string,
 :classId string,
 :passConstraints {:nfcConstraint [string],
                   :screenshotEligibility string},
 :appLinkData {:iosAppLinkInfo AppLinkDataAppLinkInfo,
               :webAppLinkInfo AppLinkDataAppLinkInfo,
               :androidAppLinkInfo AppLinkDataAppLinkInfo},
 :version string,
 :infoModuleData {:labelValueRows [LabelValueRow],
                  :showLastUpdateTime boolean},
 :balanceUpdateTime {:date string},
 :heroImage {:contentDescription LocalizedString,
             :kind string,
             :sourceUri ImageUri}}

Inserts an gift card object with the given ID and properties.
sourceraw docstring

list$clj

(list$ auth parameters)

https://developers.google.com/pay/passesapi/reference/rest/v1/giftcardobject/list

Required parameters: none

Optional parameters: maxResults, token, classId

Returns a list of all gift card objects for a given issuer ID.

https://developers.google.com/pay/passesapi/reference/rest/v1/giftcardobject/list

Required parameters: none

Optional parameters: maxResults, token, classId

Returns a list of all gift card objects for a given issuer ID.
sourceraw docstring

patch$clj

(patch$ auth parameters body)

https://developers.google.com/pay/passesapi/reference/rest/v1/giftcardobject/patch

Required parameters: resourceId

Optional parameters: none

Body:

{:cardNumber string, :hasUsers boolean, :smartTapRedemptionValue string, :rotatingBarcode {:totpDetails RotatingBarcodeTotpDetails, :initialRotatingBarcodeValues RotatingBarcodeValues, :showCodeText LocalizedString, :type string, :valuePattern string, :alternateText string, :renderEncoding string}, :textModulesData [{:id string, :localizedBody LocalizedString, :localizedHeader LocalizedString, :body string, :header string}], :barcode {:alternateText string, :showCodeText LocalizedString, :type string, :renderEncoding string, :value string, :kind string}, :hasLinkedDevice boolean, :groupingInfo {:groupingId string, :sortIndex integer}, :state string, :classReference {:wordMark Image, :reviewStatus string, :wideProgramLogo Image, :textModulesData [TextModuleData], :issuerName string, :securityAnimation SecurityAnimation, :multipleDevicesAndHoldersAllowedStatus string, :localizedEventNumberLabel LocalizedString, :pinLabel string, :merchantName string, :localizedMerchantName LocalizedString, :homepageUri Uri, :callbackOptions CallbackOptions, :linksModuleData LinksModuleData, :imageModulesData [ImageModuleData], :locations [LatLongPoint], :allowMultipleUsersPerObject boolean, :hexBackgroundColor string, :messages [Message], :localizedIssuerName LocalizedString, :redemptionIssuers [string], :review Review, :programLogo Image, :id string, :kind string, :localizedPinLabel LocalizedString, :classTemplateInfo ClassTemplateInfo, :enableSmartTap boolean, :cardNumberLabel string, :version string, :viewUnlockRequirement string, :infoModuleData InfoModuleData, :heroImage Image, :allowBarcodeRedemption boolean, :eventNumberLabel string, :countryCode string, :localizedCardNumberLabel LocalizedString}, :disableExpirationNotification boolean, :pin string, :eventNumber string, :linksModuleData {:uris [Uri]}, :imageModulesData [{:mainImage Image, :id string}], :validTimeInterval {:start DateTime, :kind string, :end DateTime}, :locations [{:latitude number, :kind string, :longitude number}], :balance {:kind string, :currencyCode string, :micros string}, :messages [{:body string, :messageType string, :header string, :id string, :kind string, :displayInterval TimeInterval, :localizedHeader LocalizedString, :localizedBody LocalizedString}], :id string, :kind string, :classId string, :passConstraints {:nfcConstraint [string], :screenshotEligibility string}, :appLinkData {:iosAppLinkInfo AppLinkDataAppLinkInfo, :webAppLinkInfo AppLinkDataAppLinkInfo, :androidAppLinkInfo AppLinkDataAppLinkInfo}, :version string, :infoModuleData {:labelValueRows [LabelValueRow], :showLastUpdateTime boolean}, :balanceUpdateTime {:date string}, :heroImage {:contentDescription LocalizedString, :kind string, :sourceUri ImageUri}}

Updates the gift card object referenced by the given object ID. This method supports patch semantics.

https://developers.google.com/pay/passesapi/reference/rest/v1/giftcardobject/patch

Required parameters: resourceId

Optional parameters: none

Body: 

{:cardNumber string,
 :hasUsers boolean,
 :smartTapRedemptionValue string,
 :rotatingBarcode {:totpDetails RotatingBarcodeTotpDetails,
                   :initialRotatingBarcodeValues RotatingBarcodeValues,
                   :showCodeText LocalizedString,
                   :type string,
                   :valuePattern string,
                   :alternateText string,
                   :renderEncoding string},
 :textModulesData [{:id string,
                    :localizedBody LocalizedString,
                    :localizedHeader LocalizedString,
                    :body string,
                    :header string}],
 :barcode {:alternateText string,
           :showCodeText LocalizedString,
           :type string,
           :renderEncoding string,
           :value string,
           :kind string},
 :hasLinkedDevice boolean,
 :groupingInfo {:groupingId string, :sortIndex integer},
 :state string,
 :classReference {:wordMark Image,
                  :reviewStatus string,
                  :wideProgramLogo Image,
                  :textModulesData [TextModuleData],
                  :issuerName string,
                  :securityAnimation SecurityAnimation,
                  :multipleDevicesAndHoldersAllowedStatus string,
                  :localizedEventNumberLabel LocalizedString,
                  :pinLabel string,
                  :merchantName string,
                  :localizedMerchantName LocalizedString,
                  :homepageUri Uri,
                  :callbackOptions CallbackOptions,
                  :linksModuleData LinksModuleData,
                  :imageModulesData [ImageModuleData],
                  :locations [LatLongPoint],
                  :allowMultipleUsersPerObject boolean,
                  :hexBackgroundColor string,
                  :messages [Message],
                  :localizedIssuerName LocalizedString,
                  :redemptionIssuers [string],
                  :review Review,
                  :programLogo Image,
                  :id string,
                  :kind string,
                  :localizedPinLabel LocalizedString,
                  :classTemplateInfo ClassTemplateInfo,
                  :enableSmartTap boolean,
                  :cardNumberLabel string,
                  :version string,
                  :viewUnlockRequirement string,
                  :infoModuleData InfoModuleData,
                  :heroImage Image,
                  :allowBarcodeRedemption boolean,
                  :eventNumberLabel string,
                  :countryCode string,
                  :localizedCardNumberLabel LocalizedString},
 :disableExpirationNotification boolean,
 :pin string,
 :eventNumber string,
 :linksModuleData {:uris [Uri]},
 :imageModulesData [{:mainImage Image, :id string}],
 :validTimeInterval {:start DateTime, :kind string, :end DateTime},
 :locations [{:latitude number, :kind string, :longitude number}],
 :balance {:kind string, :currencyCode string, :micros string},
 :messages [{:body string,
             :messageType string,
             :header string,
             :id string,
             :kind string,
             :displayInterval TimeInterval,
             :localizedHeader LocalizedString,
             :localizedBody LocalizedString}],
 :id string,
 :kind string,
 :classId string,
 :passConstraints {:nfcConstraint [string],
                   :screenshotEligibility string},
 :appLinkData {:iosAppLinkInfo AppLinkDataAppLinkInfo,
               :webAppLinkInfo AppLinkDataAppLinkInfo,
               :androidAppLinkInfo AppLinkDataAppLinkInfo},
 :version string,
 :infoModuleData {:labelValueRows [LabelValueRow],
                  :showLastUpdateTime boolean},
 :balanceUpdateTime {:date string},
 :heroImage {:contentDescription LocalizedString,
             :kind string,
             :sourceUri ImageUri}}

Updates the gift card object referenced by the given object ID. This method supports patch semantics.
sourceraw docstring

update$clj

(update$ auth parameters body)

https://developers.google.com/pay/passesapi/reference/rest/v1/giftcardobject/update

Required parameters: resourceId

Optional parameters: none

Body:

{:cardNumber string, :hasUsers boolean, :smartTapRedemptionValue string, :rotatingBarcode {:totpDetails RotatingBarcodeTotpDetails, :initialRotatingBarcodeValues RotatingBarcodeValues, :showCodeText LocalizedString, :type string, :valuePattern string, :alternateText string, :renderEncoding string}, :textModulesData [{:id string, :localizedBody LocalizedString, :localizedHeader LocalizedString, :body string, :header string}], :barcode {:alternateText string, :showCodeText LocalizedString, :type string, :renderEncoding string, :value string, :kind string}, :hasLinkedDevice boolean, :groupingInfo {:groupingId string, :sortIndex integer}, :state string, :classReference {:wordMark Image, :reviewStatus string, :wideProgramLogo Image, :textModulesData [TextModuleData], :issuerName string, :securityAnimation SecurityAnimation, :multipleDevicesAndHoldersAllowedStatus string, :localizedEventNumberLabel LocalizedString, :pinLabel string, :merchantName string, :localizedMerchantName LocalizedString, :homepageUri Uri, :callbackOptions CallbackOptions, :linksModuleData LinksModuleData, :imageModulesData [ImageModuleData], :locations [LatLongPoint], :allowMultipleUsersPerObject boolean, :hexBackgroundColor string, :messages [Message], :localizedIssuerName LocalizedString, :redemptionIssuers [string], :review Review, :programLogo Image, :id string, :kind string, :localizedPinLabel LocalizedString, :classTemplateInfo ClassTemplateInfo, :enableSmartTap boolean, :cardNumberLabel string, :version string, :viewUnlockRequirement string, :infoModuleData InfoModuleData, :heroImage Image, :allowBarcodeRedemption boolean, :eventNumberLabel string, :countryCode string, :localizedCardNumberLabel LocalizedString}, :disableExpirationNotification boolean, :pin string, :eventNumber string, :linksModuleData {:uris [Uri]}, :imageModulesData [{:mainImage Image, :id string}], :validTimeInterval {:start DateTime, :kind string, :end DateTime}, :locations [{:latitude number, :kind string, :longitude number}], :balance {:kind string, :currencyCode string, :micros string}, :messages [{:body string, :messageType string, :header string, :id string, :kind string, :displayInterval TimeInterval, :localizedHeader LocalizedString, :localizedBody LocalizedString}], :id string, :kind string, :classId string, :passConstraints {:nfcConstraint [string], :screenshotEligibility string}, :appLinkData {:iosAppLinkInfo AppLinkDataAppLinkInfo, :webAppLinkInfo AppLinkDataAppLinkInfo, :androidAppLinkInfo AppLinkDataAppLinkInfo}, :version string, :infoModuleData {:labelValueRows [LabelValueRow], :showLastUpdateTime boolean}, :balanceUpdateTime {:date string}, :heroImage {:contentDescription LocalizedString, :kind string, :sourceUri ImageUri}}

Updates the gift card object referenced by the given object ID.

https://developers.google.com/pay/passesapi/reference/rest/v1/giftcardobject/update

Required parameters: resourceId

Optional parameters: none

Body: 

{:cardNumber string,
 :hasUsers boolean,
 :smartTapRedemptionValue string,
 :rotatingBarcode {:totpDetails RotatingBarcodeTotpDetails,
                   :initialRotatingBarcodeValues RotatingBarcodeValues,
                   :showCodeText LocalizedString,
                   :type string,
                   :valuePattern string,
                   :alternateText string,
                   :renderEncoding string},
 :textModulesData [{:id string,
                    :localizedBody LocalizedString,
                    :localizedHeader LocalizedString,
                    :body string,
                    :header string}],
 :barcode {:alternateText string,
           :showCodeText LocalizedString,
           :type string,
           :renderEncoding string,
           :value string,
           :kind string},
 :hasLinkedDevice boolean,
 :groupingInfo {:groupingId string, :sortIndex integer},
 :state string,
 :classReference {:wordMark Image,
                  :reviewStatus string,
                  :wideProgramLogo Image,
                  :textModulesData [TextModuleData],
                  :issuerName string,
                  :securityAnimation SecurityAnimation,
                  :multipleDevicesAndHoldersAllowedStatus string,
                  :localizedEventNumberLabel LocalizedString,
                  :pinLabel string,
                  :merchantName string,
                  :localizedMerchantName LocalizedString,
                  :homepageUri Uri,
                  :callbackOptions CallbackOptions,
                  :linksModuleData LinksModuleData,
                  :imageModulesData [ImageModuleData],
                  :locations [LatLongPoint],
                  :allowMultipleUsersPerObject boolean,
                  :hexBackgroundColor string,
                  :messages [Message],
                  :localizedIssuerName LocalizedString,
                  :redemptionIssuers [string],
                  :review Review,
                  :programLogo Image,
                  :id string,
                  :kind string,
                  :localizedPinLabel LocalizedString,
                  :classTemplateInfo ClassTemplateInfo,
                  :enableSmartTap boolean,
                  :cardNumberLabel string,
                  :version string,
                  :viewUnlockRequirement string,
                  :infoModuleData InfoModuleData,
                  :heroImage Image,
                  :allowBarcodeRedemption boolean,
                  :eventNumberLabel string,
                  :countryCode string,
                  :localizedCardNumberLabel LocalizedString},
 :disableExpirationNotification boolean,
 :pin string,
 :eventNumber string,
 :linksModuleData {:uris [Uri]},
 :imageModulesData [{:mainImage Image, :id string}],
 :validTimeInterval {:start DateTime, :kind string, :end DateTime},
 :locations [{:latitude number, :kind string, :longitude number}],
 :balance {:kind string, :currencyCode string, :micros string},
 :messages [{:body string,
             :messageType string,
             :header string,
             :id string,
             :kind string,
             :displayInterval TimeInterval,
             :localizedHeader LocalizedString,
             :localizedBody LocalizedString}],
 :id string,
 :kind string,
 :classId string,
 :passConstraints {:nfcConstraint [string],
                   :screenshotEligibility string},
 :appLinkData {:iosAppLinkInfo AppLinkDataAppLinkInfo,
               :webAppLinkInfo AppLinkDataAppLinkInfo,
               :androidAppLinkInfo AppLinkDataAppLinkInfo},
 :version string,
 :infoModuleData {:labelValueRows [LabelValueRow],
                  :showLastUpdateTime boolean},
 :balanceUpdateTime {:date string},
 :heroImage {:contentDescription LocalizedString,
             :kind string,
             :sourceUri ImageUri}}

Updates the gift card object referenced by the given object ID.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close