Class: BigCommerce::ManagementAPI::Endpoint

Inherits:

Object

• Object
• BigCommerce::ManagementAPI::Endpoint

Defined in:

lib/big_commerce/management_api/endpoint.rb

Direct Known Subclasses

Customers, Customers::Addresses, Customers::AttributeValues, Customers::Attributes, Customers::Metafields, Inventories::Items, Segments, Subscribers

Defined Under Namespace

Classes: Response

Constant Summary

HOST =

"api.bigcommerce.com"

PORT =

443

USER_AGENT =

"BigCommerce Management API Client v#{BigCommerce::ManagementAPI::VERSION} (Ruby v#{RUBY_VERSION})"

CONTENT_TYPE =

"Content-Type"

CONTENT_TYPE_JSON =

"application/json"

JSON_CONTENT_TYPES =

[CONTENT_TYPE_JSON, "application/problem+json"].freeze

RESULT_KEY =

"data"

Instance Method Summary

• #initialize(store_hash, auth_token, options = nil) ⇒ Endpoint constructor

  A new instance of Endpoint.

Constructor Details

#initialize(store_hash, auth_token, options = nil) ⇒ Endpoint

Returns a new instance of Endpoint.

Raises:

• (ArgumentError)

# File 'lib/big_commerce/management_api/endpoint.rb', line 146

def initialize(store_hash, auth_token, options = nil)
  raise ArgumentError, "store hash required" if store_hash.to_s.empty?
  raise ArgumentError, "auth token required" if auth_token.to_s.empty?

  @store_hash = store_hash
  @auth_token = auth_token
  @options = options || {}
end