betsy 0.2.0

data/lib/betsy/model.rb

@@ -0,0 +1,73 @@
+module Betsy
+  module Model
+    module ClassMethods
+      BASE_ETSY_API_URL = "https://openapi.etsy.com"
+
+      def attribute(name)
+        define_method name do
+          @result[name.to_s]
+        end
+      end
+
+      def make_request(request_type, endpoint, options = {})
+        check_token_expiration(options[:etsy_account]) if options[:etsy_account]
+        headers = access_credentials(options[:etsy_account])
+        options.delete(:etsy_account)
+        response = Faraday.method(request_type).call("#{BASE_ETSY_API_URL}#{endpoint}", options, headers)
+        handle_response(response)
+      end
+
+      def check_token_expiration(etsy_account)
+        if etsy_account.last_token_refresh + etsy_account.expires_in <= DateTime.now
+          options = {
+            grant_type: "refresh_token",
+            refresh_token: etsy_account.refresh_token,
+            client_id: Betsy.api_key
+          }
+          response = JSON.parse(Faraday.post("https://api.etsy.com/v3/public/oauth/token", options).body)
+          etsy_account.access_token = response["access_token"]
+          etsy_account.expires_in = response["expires_in"]
+          etsy_account.refresh_token = response["refresh_token"]
+          etsy_account.last_token_refresh = DateTime.now
+          etsy_account.save
+        end
+      end
+
+      def access_credentials(etsy_account)
+        header = {x_api_key: Betsy.api_key}
+        header[:Authorization] = "Bearer #{etsy_account.access_token}" if etsy_account.present?
+        header
+      end
+
+      def handle_response(response)
+        if response.status == 200
+          return nil if response.body.empty?
+          response = JSON.parse(response.body)
+          build_objects(response)
+        else
+          Betsy::Error.new(JSON.parse(response.body).merge!("status" => response.status))
+        end
+      end
+
+      def build_objects(response)
+        if response["count"].nil?
+          objects = new(response)
+        else
+          objects = []
+          response["results"].each do |data|
+            objects.append(new(data))
+          end
+          objects
+        end
+      end
+    end
+
+    def initialize(data = nil)
+      @result = data
+    end
+
+    def self.included(other)
+      other.extend(ClassMethods)
+    end
+  end
+end

data/lib/betsy/other.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Betsy
+  class Other
+    include Betsy::Model
+
+    attribute :application_id
+
+    def self.ping
+      make_request(:get, "/v3/application/openapi-ping")
+    end
+  end
+end

data/lib/betsy/payment.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Betsy
+  class Payment
+    include Betsy::Model
+
+    attribute :payment_id
+    attribute :buyer_user_id
+    attribute :shop_id
+    attribute :receipt_id
+    attribute :amount_gross
+    attribute :amount_fees
+    attribute :amount_net
+    attribute :posted_gross
+    attribute :posted_fees
+    attribute :posted_net
+    attribute :adjusted_gross
+    attribute :adjusted_fees
+    attribute :adjusted_net
+    attribute :currency
+    attribute :shop_currency
+    attribute :buyer_currency
+    attribute :shipping_user_id
+    attribute :shipping_address_id
+    attribute :billing_address_id
+    attribute :status
+    attribute :shipped_timestamp
+    attribute :create_timestamp
+    attribute :update_timestamp
+    attribute :payment_adjustments
+
+    def self.get_payment_account_ledger_entry_payments(shop_id, options = {})
+      make_request(:get, "/v3/application/shops/#{shop_id}/payment-account/ledger-entries/payments", options)
+    end
+
+    def self.get_shop_payment_by_receipt_id(shop_id, receipt_id, options = {})
+      make_request(:get, "/v3/application/shops/#{shop_id}/receipts/#{receipt_id}/payments", options)
+    end
+
+    def self.get_payments(shop_id, options = {})
+      make_request(:get, "/v3/application/shops/#{shop_id}/payments", options)
+    end
+  end
+end

data/lib/betsy/review.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Betsy
+  class Review
+    include Betsy::Model
+
+    attribute :shop_id
+    attribute :listing_id
+    attribute :transaction_id
+    attribute :buyer_user_id
+    attribute :rating
+    attribute :review
+    attribute :language
+    attribute :image_url_fullxfull
+    attribute :create_timestamp
+    attribute :update_timestamp
+
+    def self.get_reviews_by_shop(shop_id, options = {})
+      make_request(:get, "/v3/application/shops/#{shop_id}/reviews", options)
+    end
+  end
+end

data/lib/betsy/seller_taxonomy.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Betsy
+  class SellerTaxonomy
+    include Betsy::Model
+
+    # taxonomy nodes
+    attribute :id
+    attribute :level
+    attribute :parent_id
+    attribute :children
+    attribute :full_path_taxonomy_ids
+
+    # taxonomy nodes properties
+    attribute :property_id
+    attribute :display_name
+    attribute :scales
+    attribute :is_required
+    attribute :supports_attributes
+    attribute :supports_variations
+    attribute :is_multivalued
+    attribute :possible_values
+    attribute :selected_values
+
+    # both nodes and node properties
+    attribute :name
+
+    def self.get_seller_taxonomy_nodes
+      make_request(:get, "/v3/application/seller-taxonomy/nodes")
+    end
+
+    def self.get_properties_by_taxonomy_id(taxonomy_id)
+      make_request(:get, "/v3/application/seller-taxonomy/nodes/#{taxonomy_id}/properties")
+    end
+  end
+end

data/lib/betsy/shop.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Betsy
+  class Shop
+    include Betsy::Model
+
+    attribute :shop_id
+    attribute :user_id
+    attribute :shop_name
+    attribute :create_date
+    attribute :title
+    attribute :announcement
+    attribute :currency_code
+    attribute :is_vacation
+    attribute :vacation_message
+    attribute :sale_message
+    attribute :digital_sale_message
+    attribute :update_date
+    attribute :listing_active_count
+    attribute :digital_listing_count
+    attribute :login_name
+    attribute :accepts_custom_requests
+    attribute :policy_welcome
+    attribute :policy_payment
+    attribute :policy_shipping
+    attribute :policy_refunds
+    attribute :policy_additional
+    attribute :policy_seller_info
+    attribute :policy_update_date
+    attribute :policy_has_private_receipt_info
+    attribute :has_unstructured_policies
+    attribute :policy_privacy
+    attribute :vacation_autoreply
+    attribute :url
+    attribute :image_url_760x100
+    attribute :num_favorers
+    attribute :languages
+    attribute :icon_url_fullxfull
+    attribute :is_using_structured_policies
+    attribute :has_onboarded_structured_policies
+    attribute :include_dispute_form_link
+    attribute :is_direct_checkout_onboarded
+    attribute :is_calculated_eligible
+    attribute :is_opted_in_to_buyer_promise
+    attribute :is_shop_us_based
+    attribute :transaction_sold_count
+    attribute :shipping_from_country_iso
+    attribute :shop_location_country_iso
+    attribute :review_count
+    attribute :review_average
+
+    def self.get_shop(shop_id)
+      make_request(:get, "/v3/application/shops/#{shop_id}")
+    end
+
+    def self.update_shop(shop_id, options = {})
+      make_request(:put, "/v3/application/shops/#{shop_id}", options)
+    end
+
+    def self.get_shop_by_owner_user_id(user_id)
+      make_request(:get, "/v3/application/users/#{user_id}/shops")
+    end
+
+    def self.find_shops(shop_name, options = {})
+      options[:shop_name] = shop_name
+      make_request(:get, "/v3/application/shops", options)
+    end
+  end
+end

data/lib/betsy/shop_listing.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+module Betsy
+  class ShopListing
+    include Betsy::Model
+
+    # listing
+    attribute :listing_id
+    attribute :user_id
+    attribute :shop_id
+    attribute :title
+    attribute :description
+    attribute :state
+    attribute :creation_timestamp
+    attribute :ending_timestamp
+    attribute :original_creation_timestamp
+    attribute :last_modified_timestamp
+    attribute :state_timestamp
+    attribute :quantity
+    attribute :shop_section_id
+    attribute :featured_rank
+    attribute :url
+    attribute :num_favorers
+    attribute :non_taxable
+    attribute :is_customizable
+    attribute :is_personalizable
+    attribute :personalization_is_required
+    attribute :personalization_char_count_max
+    attribute :personalization_instructions
+    attribute :listing_type
+    attribute :tags
+    attribute :materials
+    attribute :shipping_profile_id
+    attribute :processing_min
+    attribute :processing_max
+    attribute :who_made
+    attribute :when_made
+    attribute :is_supply
+    attribute :item_weight
+    attribute :item_weight_unit
+    attribute :item_length
+    attribute :item_width
+    attribute :item_height
+    attribute :item_dimensions_unit
+    attribute :is_private
+    attribute :recipient
+    attribute :occasion
+    attribute :style
+    attribute :file_data
+    attribute :has_variations
+    attribute :should_auto_renew
+    attribute :language
+    attribute :price
+    attribute :taxonomy_id
+
+    # listing properties
+    attribute :property_id
+    attribute :property_name
+    attribute :scale_id
+    attribute :scale_name
+    attribute :value_ids
+    attribute :values
+
+    def self.create_draft_listing(shop_id, options = {})
+      make_request(:post, "/v3/application/shops/#{shop_id}/listings", options)
+    end
+
+    def self.get_listings_by_shop(shop_id, options = {})
+      make_request(:get, "/v3/application/shops/#{shop_id}/listings", options)
+    end
+
+    def self.delete_listing(listing_id, options = {})
+      make_request(:delete, "/v3/application/listings/#{listing_id}", options)
+    end
+
+    def self.get_listing(listing_id, options = {})
+      make_request(:get, "/v3/application/listings/#{listing_id}", options)
+    end
+
+    def self.find_all_listings_active(options = {})
+      make_request(:get, "/v3/application/listings/active", options)
+    end
+
+    def self.find_all_active_listings_by_shop(shop_id, options = {})
+      make_request(:get, "/v3/application/shops/#{shop_id}/listings/active", options)
+    end
+
+    def self.get_listings_by_listing_ids(options = {})
+      make_request(:get, "/v3/application/listings/batch", options)
+    end
+
+    def self.get_featured_listings_by_shop(shop_id, options = {})
+      make_request(:get, "/v3/application/shops/#{shop_id}/listings/featured", options)
+    end
+
+    def self.delete_listing_property(shop_id, listing_id, property_id, options = {})
+      make_request(:delete, "/v3/application/shops/#{shop_id}/listings/#{listing_id}/properties/#{property_id}", options)
+    end
+
+    def self.update_listing_property(shop_id, listing_id, property_id, options = {})
+      make_request(:put, "/v3/application/shops/#{shop_id}/listings/#{listing_id}/properties/#{property_id}", options)
+    end
+
+    # STILL IN DEVELOPMENT AS OF 8/28/2021
+    def self.get_listing_property
+    end
+
+    def self.get_listing_properties(shop_id, listing_id)
+      make_request(:get, "/v3/application/shops/#{shop_id}/listings/#{listing_id}/properties")
+    end
+
+    def self.update_listing(shop_id, listing_id, options = {})
+      make_request(:put, "/v3/application/shops/#{shop_id}/listings/#{listing_id}", options)
+    end
+
+    def self.get_listings_by_shop_receipt(shop_id, receipt_id, options = {})
+      make_request(:get, "/v3/application/shops/#{shop_id}/receipts/#{receipt_id}/listings", options)
+    end
+
+    def self.get_listings_by_shop_section_id(shop_id, options = {})
+      make_request(:get, "/v3/application/shops/#{shop_id}/shop-sections/listings", options)
+    end
+  end
+end

data/lib/betsy/shop_listing_file.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Betsy
+  class ShopListingFile
+    include Betsy::Model
+
+    attribute :listing_file_id
+    attribute :listing_id
+    attribute :rank
+    attribute :filename
+    attribute :filesize
+    attribute :size_bytes
+    attribute :filetype
+    attribute :create_timestamp
+
+    def self.delete_listing_file(shop_id, listing_id, listing_file_id, options = {})
+      make_request(:delete, "/v3/application/shops/#{shop_id}/listings/#{listing_id}/files/#{listing_file_id}", options)
+    end
+
+    def self.get_listing_file(shop_id, listing_id, listing_file_id, options = {})
+      make_request(:get, "/v3/application/shops/#{shop_id}/listings/#{listing_id}/files/#{listing_file_id}", options)
+    end
+
+    def self.get_all_listing_files(shop_id, listing_id, options = {})
+      make_request(:get, "/v3/application/shops/#{shop_id}/listings/#{listing_id}/files", options)
+    end
+
+    def self.upload_listing_file(shop_id, listing_id, options = {})
+      make_request(:post, "/v3/application/shops/#{shop_id}/listings/#{listing_id}/files", options)
+    end
+  end
+end

data/lib/betsy/shop_listing_image.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Betsy
+  class ShopListingImage
+    include Betsy::Model
+
+    attribute :listing_id
+    attribute :listing_image_id
+    attribute :hex_code
+    attribute :red
+    attribute :green
+    attribute :blue
+    attribute :hue
+    attribute :saturation
+    attribute :brightness
+    attribute :is_black_and_white
+    attribute :creation_tsz
+    attribute :rank
+    attribute :url_75x75
+    attribute :url_170x135
+    attribute :url_570xN
+    attribute :url_fullxfull
+    attribute :full_height
+    attribute :full_width
+
+    def self.delete_listing_image(shop_id, listing_id, listing_image_id, options = {})
+      make_request(:delete, "/v3/application/shops/#{shop_id}/listings/#{listing_id}/images/#{listing_image_id}", options)
+    end
+
+    def self.get_listing_image(shop_id, listing_id, listing_image_id)
+      make_request(:get, "/v3/application/shops/#{shop_id}/listings/#{listing_id}/images/#{listing_image_id}")
+    end
+
+    def self.get_listing_images(shop_id, listing_id)
+      make_request(:get, "/v3/application/shops/#{shop_id}/listings/#{listing_id}/images")
+    end
+
+    def self.upload_listing_image(shop_id, listing_id, options = {})
+      make_request(:post, "/v3/application/shops/#{shop_id}/listings/#{listing_id}/images", options)
+    end
+  end
+end

data/lib/betsy/shop_listing_inventory.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Betsy
+  class ShopListingInventory
+    include Betsy::Model
+
+    attribute :products
+    attribute :price_on_property
+    attribute :quantity_on_property
+    attribute :sku_on_property
+    attribute :listing
+
+    def self.get_listing_inventory(listing_id, options = {})
+      make_request(:get, "/v3/application/listings/#{listing_id}/inventory", options)
+    end
+
+    def self.update_listing_inventory(listing_id, options = {})
+      make_request(:put, "/v3/application/listings/#{listing_id}/inventory", options)
+    end
+  end
+end

data/lib/betsy/shop_listing_offering.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Betsy
+  class ShopListingOffering
+    include Betsy::Model
+
+    attribute :offering_id
+    attribute :quantity
+    attribute :is_enabled
+    attribute :is_deleted
+    attribute :price
+
+    def self.get_listing_offering(listing_id, product_id, product_offering_id)
+      make_request(:get, "/v3/application/listings/#{listing_id}/products/#{product_id}/offerings/#{product_offering_id}")
+    end
+  end
+end

data/lib/betsy/shop_listing_product.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Betsy
+  class ShopListingProduct
+    include Betsy::Model
+
+    attribute :product_id
+    attribute :sku
+    attribute :is_deleted
+    attribute :offerings
+    attribute :property_values
+
+    def self.get_listing_product(listing_id, product_id, options = {})
+      make_request(:get, "/v3/application/listings/#{listing_id}/inventory/products/#{product_id}", options)
+    end
+  end
+end

data/lib/betsy/shop_listing_translation.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Betsy
+  class ShopListingTranslation
+    include Betsy::Model
+
+    attribute :listing_id
+    attribute :language
+    attribute :title
+    attribute :description
+    attribute :tags
+
+    def self.create_listing_translation(shop_id, listing_id, language, options = {})
+      make_request(:post, "/v3/application/shops/#{shop_id}/listings/#{listing_id}/translations/#{language}", options)
+    end
+
+    def self.get_listing_translation(shop_id, listing_id, language)
+      make_request(:get, "/v3/application/shops/#{shop_id}/listings/#{listing_id}/translations/#{language}")
+    end
+
+    def self.update_listing_translation(shop_id, listing_id, language, options = {})
+      make_request(:put, "/v3/application/shops/#{shop_id}/listings/#{listing_id}/translations/#{language}", options)
+    end
+  end
+end

data/lib/betsy/shop_listing_variation_image.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Betsy
+  class ShopListingVariationImage
+    include Betsy::Model
+
+    attribute :property_id
+    attribute :value_id
+    attribute :image_id
+
+    def self.get_listing_variation_images(shop_id, listing_id)
+      make_request(:get, "/v3/application/shops/#{shop_id}/listings/#{listing_id}/variation-images")
+    end
+
+    def self.update_variation_images(shop_id, listing_id, options = {})
+      make_request(:post, "/v3/application/shops/#{shop_id}/listings/#{listing_id}/variation-images", options)
+    end
+  end
+end

data/lib/betsy/shop_production_partner.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Betsy
+  class ShopProductionPartner
+    include Betsy::Model
+
+    attribute :production_partner_id
+    attribute :partner_name
+    attribute :location
+
+    def self.get_shop_production_partners(shop_id, options = {})
+      make_request(:get, "/v3/application/shops/#{shop_id}/production-partners", options)
+    end
+  end
+end

data/lib/betsy/shop_receipt.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Betsy
+  class ShopReceipt
+    include Betsy::Model
+
+    attribute :receipt_id
+    attribute :receipt_type
+    attribute :seller_user_id
+    attribute :seller_email
+    attribute :buyer_user_id
+    attribute :buyer_email
+    attribute :name
+    attribute :first_line
+    attribute :second_line
+    attribute :city
+    attribute :state
+    attribute :zip
+    attribute :formatted_address
+    attribute :country_iso
+    attribute :payment_method
+    attribute :payment_email
+    attribute :message_from_seller
+    attribute :message_from_buyer
+    attribute :message_from_payment
+    attribute :is_paid
+    attribute :is_shipped
+    attribute :create_timestamp
+    attribute :update_timestamp
+    attribute :gift_message
+    attribute :grandtotal
+    attribute :subtotal
+    attribute :total_price
+    attribute :total_shipping_cost
+    attribute :total_tax_cost
+    attribute :total_vat_cost
+    attribute :discount_amt
+    attribute :gift_wrap_price
+    attribute :shipments
+    attribute :transactions
+
+    def self.get_shop_receipt(shop_id, receipt_id, options = {})
+      make_request(:get, "/v3/application/shops/#{shop_id}/receipts/#{receipt_id}", options)
+    end
+
+    def self.get_shop_receipts(shop_id, options = {})
+      make_request(:get, "/v3/application/shops/#{shop_id}/receipts", options)
+    end
+
+    def self.create_receipt_shipment(shop_id, receipt_id, options = {})
+      make_request(:post, "/v3/application/shops/#{shop_id}/receipts/#{receipt_id}/tracking", options)
+    end
+  end
+end

data/lib/betsy/shop_receipt_transaction.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Betsy
+  class ShopReceiptTransaction
+    include Betsy::Model
+
+    attribute :transaction_id
+    attribute :title
+    attribute :description
+    attribute :seller_user_id
+    attribute :buyer_user_id
+    attribute :create_timestamp
+    attribute :paid_timestamp
+    attribute :shipped_timestamp
+    attribute :quantity
+    attribute :listing_image_id
+    attribute :receipt_id
+    attribute :is_digital
+    attribute :file_data
+    attribute :listing_id
+    attribute :transaction_type
+    attribute :product_id
+    attribute :price
+    attribute :shipping_cost
+    attribute :variations
+
+    def self.get_shop_receipt_transactions_by_listing(shop_id, listing_id, options = {})
+      make_request(:get, "/v3/application/shops/#{shop_id}/listings/#{listing_id}/transactions", options)
+    end
+
+    def self.get_shop_receipt_transactions_by_receipt(shop_id, receipt_id, options = {})
+      make_request(:get, "/v3/application/shops/#{shop_id}/receipts/#{receipt_id}/transactions", options)
+    end
+
+    def self.get_shop_receipt_transaction(shop_id, transaction_id, options = {})
+      make_request(:get, "/v3/application/shops/#{shop_id}/transactions/#{transaction_id}", options)
+    end
+
+    def self.get_shop_receipt_transactions_by_shop(shop_id, options = {})
+      make_request(:get, "/v3/application/shops/#{shop_id}/transactions", options)
+    end
+  end
+end