BucketSDK
Example
To run the example project, clone the repo, and run pod install from the Example directory first.
Requirements
You will need to be registered with Bucket & have obtained a Retailer Account. You will need to have received a clientId & clientSecret in order to access Bucket's API.
Installation
BucketSDK is available through CocoaPods. To install it, simply add the following line to your Podfile:
pod 'BucketSDK'Usage
Using the BucketSDK, you will be able to use either Swift or Objective-C to access some of the functions that you will need.
Swift Usage
// Check your app's status of being in release or debug. This will make it easier for you as the developer to always make sure you are hitting the Sandbox API rather than the Production API. We suggest doing this in the App Delegate launch options.
#if RELEASE
Bucket.shared.environment = .Production
#endif
// Okay now that you set the environment, you should be able to log in with a Retailer:
Bucket.Retailer.logInWith(password: "password", username: "username") { (success, error) in
if success {
// Yay - we successfully logged in!
} else if let error = error {
print(error.localizedDescription)
}
}
// Now before using the Bucket.shared.bucketAmount(for: entireChangeAmountWithBills), you will need to set your bill denomination:
Bucket.shared.fetchBillDenominations(.usd) { (success, error) in
if success {
} else if error != nil {
}
}
// Another function you will use will be to calculate how much we are bucketing based on the dollar bills and change given. Notice that we deal with the currency as an integer:
let bucketAmount = Bucket.shared.bucketAmount(for: 7899)
// Now that we have our bucket amount, we can go and create a transaction with that amount, and send it through the Bucket API:
let transaction = Bucket.Transaction(amount: bucketAmount, clientTransactionId: "CKFYGGHPUIGH")
transaction.create { (success, error) in
if success {
// Yay we created the transaction!
} else if let error = error {
print(error.localizedDescription)
}
}
// You will need to close the interval for the start-to-end of day.
// Close an interval:
Bucket.shared.close(interval: "20180422")
// OR use the callback:
Bucket.shared.close(interval: "20180422") { (success, error) in
if success {
// Success!!
}
else if !error.isNil {
print(error!.localizedDescription)
}
}Obj-C Usage
// Check your app's status of being in release or debug. This will make it easier for you as the developer to always make sure you are hitting the Sandbox API rather than the Production API. We suggest doing this in the App Delegate launch options.
#if RELEASE
[Bucket.shared setEnvironment: DeploymentEnvironmentProduction];
#endif
// Okay now that you set the environment, you should be able to log in with a Retailer:
[Retailer logInWithPassword:@"password" username:@"username" :^(BOOL success, NSError * _Nullable error) {
if (success) {
// Yay - it was a success!!
} else if (error != NULL) {
NSLog(@"%@", error.localizedDescription);
}
}];
// Before using the function bucketAmountFor, you will need to set your bill denominations:
[[Bucket shared] fetchBillDenominations:BillDenominationUsd completion:^(BOOL success, NSError * _Nullable error) {
if (success) {
long bucketAmount = [[Bucket shared] bucketAmountFor:863];
NSLog(@"Success!!!: %li", bucketAmount);
} else if (error != NULL) {
}
}];
// Another function you will use will be to calculate how much we are bucketing based on the dollar bills and change given. Notice that we deal with the currency as an integer:
long bucketAmount = [[Bucket shared] bucketAmountFor:7999];
// Now that we have our bucket amount, we can go and create a transaction with that amount, and send it through the Bucket API:
Transaction *t = [[Transaction alloc] initWithAmount:bucketAmount clientTransactionId:@"ZDFRPHGYKOUG"];
[t create:^(BOOL success, NSError * _Nullable error) {
if (success) {
// You successfully created the transaction!
} else if (error != NULL) {
NSLog(@"%@", error.localizedDescription);
}
}];
// You will need to close the interval for the start-to-end of day.
// No completion:
[Bucket.shared closeWithInterval:@"20180423" : NULL];
// With completion:
[Bucket.shared closeWithInterval:@"20180423" :^(BOOL success, NSError * _Nullable error) {
if (success) {
// Success!!!!
} else if (error != NULL) {
NSLog(@"%@",error.localizedDescription);
}
}];Author
Ryan, [email protected]
License
BucketSDK is available under the MIT license. See the LICENSE file for more info.