Class: Square::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/square/client.rb

Overview

square client class.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(timeout: 60, max_retries: 0, retry_interval: 1, backoff_factor: 2, retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524], retry_methods: %i[get put], environment: 'production', custom_url: 'https://connect.squareup.com', square_version: '2021-09-15', access_token: 'TODO: Replace', additional_headers: {}, config: nil) ⇒ Client

Returns a new instance of Client.



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/square/client.rb', line 212

def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
               backoff_factor: 2,
               retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
               retry_methods: %i[get put], environment: 'production',
               custom_url: 'https://connect.squareup.com',
               square_version: '2021-09-15', access_token: 'TODO: Replace',
               additional_headers: {}, config: nil)
  @config = if config.nil?
              Configuration.new(timeout: timeout, max_retries: max_retries,
                                retry_interval: retry_interval,
                                backoff_factor: backoff_factor,
                                retry_statuses: retry_statuses,
                                retry_methods: retry_methods,
                                environment: environment,
                                custom_url: custom_url,
                                square_version: square_version,
                                access_token: access_token,
                                additional_headers: additional_headers)
            else
              config
            end
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



4
5
6
 
# File 'lib/square/client.rb', line 4

def config
  @config
end

Instance Method Details

#apple_pay ⇒ ApplePayApi

Access to apple_pay controller.

Returns:



34
35
36
 
# File 'lib/square/client.rb', line 34

def apple_pay
  @apple_pay ||= ApplePayApi.new config
end

#bank_accounts ⇒ BankAccountsApi

Access to bank_accounts controller.

Returns:



40
41
42
 
# File 'lib/square/client.rb', line 40

def bank_accounts
  @bank_accounts ||= BankAccountsApi.new config
end

#bookings ⇒ BookingsApi

Access to bookings controller.

Returns:



46
47
48
 
# File 'lib/square/client.rb', line 46

def bookings
  @bookings ||= BookingsApi.new config
end

#cards ⇒ CardsApi

Access to cards controller.

Returns:

  • (CardsApi) —

    Returns the controller instance.



52
53
54
 
# File 'lib/square/client.rb', line 52

def cards
  @cards ||= CardsApi.new config
end

#cash_drawers ⇒ CashDrawersApi

Access to cash_drawers controller.

Returns:



58
59
60
 
# File 'lib/square/client.rb', line 58

def cash_drawers
  @cash_drawers ||= CashDrawersApi.new config
end

#catalog ⇒ CatalogApi

Access to catalog controller.

Returns:

  • (CatalogApi) —

    Returns the controller instance.



64
65
66
 
# File 'lib/square/client.rb', line 64

def catalog
  @catalog ||= CatalogApi.new config
end

#checkout ⇒ CheckoutApi

Access to checkout controller.

Returns:



142
143
144
 
# File 'lib/square/client.rb', line 142

def checkout
  @checkout ||= CheckoutApi.new config
end

#customer_groups ⇒ CustomerGroupsApi

Access to customer_groups controller.

Returns:



76
77
78
 
# File 'lib/square/client.rb', line 76

def customer_groups
  @customer_groups ||= CustomerGroupsApi.new config
end

#customer_segments ⇒ CustomerSegmentsApi

Access to customer_segments controller.

Returns:



82
83
84
 
# File 'lib/square/client.rb', line 82

def customer_segments
  @customer_segments ||= CustomerSegmentsApi.new config
end

#customers ⇒ CustomersApi

Access to customers controller.

Returns:



70
71
72
 
# File 'lib/square/client.rb', line 70

def customers
  @customers ||= CustomersApi.new config
end

#devices ⇒ DevicesApi

Access to devices controller.

Returns:

  • (DevicesApi) —

    Returns the controller instance.



88
89
90
 
# File 'lib/square/client.rb', line 88

def devices
  @devices ||= DevicesApi.new config
end

#disputes ⇒ DisputesApi

Access to disputes controller.

Returns:



94
95
96
 
# File 'lib/square/client.rb', line 94

def disputes
  @disputes ||= DisputesApi.new config
end

#employees ⇒ EmployeesApi

Access to employees controller.

Returns:



100
101
102
 
# File 'lib/square/client.rb', line 100

def employees
  @employees ||= EmployeesApi.new config
end

#gift_card_activities ⇒ GiftCardActivitiesApi

Access to gift_card_activities controller.

Returns:



112
113
114
 
# File 'lib/square/client.rb', line 112

def gift_card_activities
  @gift_card_activities ||= GiftCardActivitiesApi.new config
end

#gift_cards ⇒ GiftCardsApi

Access to gift_cards controller.

Returns:



106
107
108
 
# File 'lib/square/client.rb', line 106

def gift_cards
  @gift_cards ||= GiftCardsApi.new config
end

#inventory ⇒ InventoryApi

Access to inventory controller.

Returns:



118
119
120
 
# File 'lib/square/client.rb', line 118

def inventory
  @inventory ||= InventoryApi.new config
end

#invoices ⇒ InvoicesApi

Access to invoices controller.

Returns:



124
125
126
 
# File 'lib/square/client.rb', line 124

def invoices
  @invoices ||= InvoicesApi.new config
end

#labor ⇒ LaborApi

Access to labor controller.

Returns:

  • (LaborApi) —

    Returns the controller instance.



130
131
132
 
# File 'lib/square/client.rb', line 130

def labor
  @labor ||= LaborApi.new config
end

#locations ⇒ LocationsApi

Access to locations controller.

Returns:



136
137
138
 
# File 'lib/square/client.rb', line 136

def locations
  @locations ||= LocationsApi.new config
end

#loyalty ⇒ LoyaltyApi

Access to loyalty controller.

Returns:

  • (LoyaltyApi) —

    Returns the controller instance.



154
155
156
 
# File 'lib/square/client.rb', line 154

def loyalty
  @loyalty ||= LoyaltyApi.new config
end

#merchants ⇒ MerchantsApi

Access to merchants controller.

Returns:



160
161
162
 
# File 'lib/square/client.rb', line 160

def merchants
  @merchants ||= MerchantsApi.new config
end

#mobile_authorization ⇒ MobileAuthorizationApi

Access to mobile_authorization controller.

Returns:



16
17
18
 
# File 'lib/square/client.rb', line 16

def mobile_authorization
  @mobile_authorization ||= MobileAuthorizationApi.new config
end

#o_auth ⇒ OAuthApi

Access to o_auth controller.

Returns:

  • (OAuthApi) —

    Returns the controller instance.



22
23
24
 
# File 'lib/square/client.rb', line 22

def o_auth
  @o_auth ||= OAuthApi.new config
end

#orders ⇒ OrdersApi

Access to orders controller.

Returns:

  • (OrdersApi) —

    Returns the controller instance.



166
167
168
 
# File 'lib/square/client.rb', line 166

def orders
  @orders ||= OrdersApi.new config
end

#payments ⇒ PaymentsApi

Access to payments controller.

Returns:



172
173
174
 
# File 'lib/square/client.rb', line 172

def payments
  @payments ||= PaymentsApi.new config
end

#refunds ⇒ RefundsApi

Access to refunds controller.

Returns:

  • (RefundsApi) —

    Returns the controller instance.



178
179
180
 
# File 'lib/square/client.rb', line 178

def refunds
  @refunds ||= RefundsApi.new config
end

#sdk_version ⇒ Object 



6
7
8
 
# File 'lib/square/client.rb', line 6

def sdk_version
  '14.1.0.20210915'
end

#sites ⇒ SitesApi

Access to sites controller.

Returns:

  • (SitesApi) —

    Returns the controller instance.



184
185
186
 
# File 'lib/square/client.rb', line 184

def sites
  @sites ||= SitesApi.new config
end

#snippets ⇒ SnippetsApi

Access to snippets controller.

Returns:



190
191
192
 
# File 'lib/square/client.rb', line 190

def snippets
  @snippets ||= SnippetsApi.new config
end

#square_version ⇒ Object 



10
11
12
 
# File 'lib/square/client.rb', line 10

def square_version
  config.square_version
end

#subscriptions ⇒ SubscriptionsApi

Access to subscriptions controller.

Returns:



196
197
198
 
# File 'lib/square/client.rb', line 196

def subscriptions
  @subscriptions ||= SubscriptionsApi.new config
end

#team ⇒ TeamApi

Access to team controller.

Returns:

  • (TeamApi) —

    Returns the controller instance.



202
203
204
 
# File 'lib/square/client.rb', line 202

def team
  @team ||= TeamApi.new config
end

#terminal ⇒ TerminalApi

Access to terminal controller.

Returns:



208
209
210
 
# File 'lib/square/client.rb', line 208

def terminal
  @terminal ||= TerminalApi.new config
end

#transactions ⇒ TransactionsApi

Access to transactions controller.

Returns:



148
149
150
 
# File 'lib/square/client.rb', line 148

def transactions
  @transactions ||= TransactionsApi.new config
end

#v1_transactions ⇒ V1TransactionsApi

Access to v1_transactions controller.

Returns:



28
29
30
 
# File 'lib/square/client.rb', line 28

def v1_transactions
  @v1_transactions ||= V1TransactionsApi.new config
end